Worked on the OCR to improve the usage, it would now be possible to add a processor which scans all captures.

This commit is contained in:
Robin Krom 2020-02-20 22:59:09 +01:00
parent a4e4ae86cc
commit b49b01c9be
5 changed files with 215 additions and 74 deletions

View file

@ -317,6 +317,9 @@ namespace Greenshot {
private readonly Timer _doubleClickTimer = new Timer(); private readonly Timer _doubleClickTimer = new Timer();
public MainForm(CopyDataTransport dataTransport) { public MainForm(CopyDataTransport dataTransport) {
var uiContext = TaskScheduler.FromCurrentSynchronizationContext();
SimpleServiceProvider.Current.AddService(uiContext);
DpiChanged += (e,o) => ApplyDpiScaling(); DpiChanged += (e,o) => ApplyDpiScaling();
// The most important form is this // The most important form is this

View file

@ -1,20 +1,20 @@
/* /*
* Greenshot - a free and open source screenshot tool * Greenshot - a free and open source screenshot tool
* Copyright (C) 2007-2020 Thomas Braun, Jens Klingen, Robin Krom * Copyright (C) 2007-2020 Thomas Braun, Jens Klingen, Robin Krom
* *
* For more information see: http://getgreenshot.org/ * For more information see: http://getgreenshot.org/
* The Greenshot project is hosted on GitHub https://github.com/greenshot/greenshot * The Greenshot project is hosted on GitHub https://github.com/greenshot/greenshot
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 1 of the License, or * the Free Software Foundation, either version 1 of the License, or
* (at your option) any later version. * (at your option) any later version.
* *
* This program is distributed in the hope that it will be useful, * This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details. * GNU General Public License for more details.
* *
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
@ -82,7 +82,7 @@ namespace GreenshotPlugin.Core {
public void ClearDestinations() { public void ClearDestinations() {
CaptureDestinations.Clear(); CaptureDestinations.Clear();
} }
public void RemoveDestination(IDestination destination) { public void RemoveDestination(IDestination destination) {
if (CaptureDestinations.Contains(destination)) { if (CaptureDestinations.Contains(destination)) {
@ -109,7 +109,7 @@ namespace GreenshotPlugin.Core {
DateTime = DateTime.Now; DateTime = DateTime.Now;
} }
} }
/// <summary> /// <summary>
/// This class is used to pass an instance of the "Capture" around /// This class is used to pass an instance of the "Capture" around
/// Having the Bitmap, eventually the Windows Title and cursor all together. /// Having the Bitmap, eventually the Windows Title and cursor all together.
@ -158,8 +158,8 @@ namespace GreenshotPlugin.Core {
} }
} }
} }
public void NullImage() { public void NullImage() {
_image = null; _image = null;
} }
@ -175,6 +175,11 @@ namespace GreenshotPlugin.Core {
} }
} }
/// <summary>
/// The information which OCR brings
/// </summary>
public OcrInformation OcrInformation { get; set; }
/// <summary> /// <summary>
/// Set if the cursor is visible /// Set if the cursor is visible
/// </summary> /// </summary>
@ -197,8 +202,8 @@ namespace GreenshotPlugin.Core {
get {return _location;} get {return _location;}
set {_location = value;} set {_location = value;}
} }
private CaptureDetails _captureDetails; private CaptureDetails _captureDetails;
/// <summary> /// <summary>
/// Get/set the CaptureDetails /// Get/set the CaptureDetails
/// </summary> /// </summary>
@ -206,8 +211,8 @@ namespace GreenshotPlugin.Core {
get {return _captureDetails;} get {return _captureDetails;}
set {_captureDetails = (CaptureDetails)value;} set {_captureDetails = (CaptureDetails)value;}
} }
/// <summary> /// <summary>
/// Default Constructor /// Default Constructor
/// </summary> /// </summary>
public Capture() { public Capture() {
@ -270,8 +275,8 @@ namespace GreenshotPlugin.Core {
// Move all the elements // Move all the elements
// TODO: Enable when the elements are usable again. // TODO: Enable when the elements are usable again.
// MoveElements(-cropRectangle.Location.X, -cropRectangle.Location.Y); // MoveElements(-cropRectangle.Location.X, -cropRectangle.Location.Y);
// Remove invisible elements // Remove invisible elements
var newElements = new List<ICaptureElement>(); var newElements = new List<ICaptureElement>();
foreach(var captureElement in _elements) { foreach(var captureElement in _elements) {
if (captureElement.Bounds.IntersectsWith(cropRectangle)) { if (captureElement.Bounds.IntersectsWith(cropRectangle)) {
@ -282,8 +287,8 @@ namespace GreenshotPlugin.Core {
return true; return true;
} }
/// <summary> /// <summary>
/// Apply a translate to the mouse location. /// Apply a translate to the mouse location.
/// e.g. needed for crop /// e.g. needed for crop
/// </summary> /// </summary>
@ -312,8 +317,8 @@ namespace GreenshotPlugin.Core {
// MoveElements(childElement.Children, x, y); // MoveElements(childElement.Children, x, y);
// } // }
//} //}
///// <summary> ///// <summary>
///// Add a new element to the capture ///// Add a new element to the capture
///// </summary> ///// </summary>
///// <param name="element">CaptureElement</param> ///// <param name="element">CaptureElement</param>
@ -328,8 +333,8 @@ namespace GreenshotPlugin.Core {
// elements.Add(element); // elements.Add(element);
// } // }
//} //}
///// <summary> ///// <summary>
///// Returns a list of rectangles which represent object that are on the capture ///// Returns a list of rectangles which represent object that are on the capture
///// </summary> ///// </summary>
//public List<ICaptureElement> Elements { //public List<ICaptureElement> Elements {
@ -340,10 +345,10 @@ namespace GreenshotPlugin.Core {
// elements = value; // elements = value;
// } // }
//} //}
} }
/// <summary> /// <summary>
/// A class representing an element in the capture /// A class representing an element in the capture
/// </summary> /// </summary>
public class CaptureElement : ICaptureElement { public class CaptureElement : ICaptureElement {
@ -378,7 +383,7 @@ namespace GreenshotPlugin.Core {
return obj is CaptureElement other && Bounds.Equals(other.Bounds); return obj is CaptureElement other && Bounds.Equals(other.Bounds);
} }
public override int GetHashCode() { public override int GetHashCode() {
// TODO: Fix this, this is not right... // TODO: Fix this, this is not right...
return Bounds.GetHashCode(); return Bounds.GetHashCode();
@ -387,7 +392,7 @@ namespace GreenshotPlugin.Core {
/// <summary> /// <summary>
/// The Window Capture code /// The Window Capture code
/// </summary> /// </summary>
public class WindowCapture { public static class WindowCapture {
private static readonly ILog Log = LogManager.GetLogger(typeof(WindowCapture)); private static readonly ILog Log = LogManager.GetLogger(typeof(WindowCapture));
private static readonly CoreConfiguration Configuration = IniConfig.GetIniSection<CoreConfiguration>(); private static readonly CoreConfiguration Configuration = IniConfig.GetIniSection<CoreConfiguration>();
@ -400,10 +405,7 @@ namespace GreenshotPlugin.Core {
[return: MarshalAs(UnmanagedType.Bool)] [return: MarshalAs(UnmanagedType.Bool)]
private static extern bool DeleteObject(IntPtr hObject); private static extern bool DeleteObject(IntPtr hObject);
private WindowCapture() { /// <summary>
}
/// <summary>
/// Get the bounds of all screens combined. /// Get the bounds of all screens combined.
/// </summary> /// </summary>
/// <returns>A Rectangle of the bounds of the entire display area.</returns> /// <returns>A Rectangle of the bounds of the entire display area.</returns>
@ -419,7 +421,7 @@ namespace GreenshotPlugin.Core {
} }
return new Rectangle(left, top, (right + Math.Abs(left)), (bottom + Math.Abs(top))); return new Rectangle(left, top, (right + Math.Abs(left)), (bottom + Math.Abs(top)));
} }
/// <summary> /// <summary>
/// Retrieves the cursor location safely, accounting for DPI settings in Vista/Windows 7. This implementation /// Retrieves the cursor location safely, accounting for DPI settings in Vista/Windows 7. This implementation
/// can conveniently be used when the cursor location is needed to deal with a fullscreen bitmap. /// can conveniently be used when the cursor location is needed to deal with a fullscreen bitmap.
@ -430,7 +432,7 @@ namespace GreenshotPlugin.Core {
public static Point GetCursorLocationRelativeToScreenBounds() { public static Point GetCursorLocationRelativeToScreenBounds() {
return GetLocationRelativeToScreenBounds(User32.GetCursorLocation()); return GetLocationRelativeToScreenBounds(User32.GetCursorLocation());
} }
/// <summary> /// <summary>
/// Converts locationRelativeToScreenOrigin to be relative to top left corner of all screen bounds, which might /// Converts locationRelativeToScreenOrigin to be relative to top left corner of all screen bounds, which might
/// be different in multiscreen setups. This implementation /// be different in multiscreen setups. This implementation
@ -467,11 +469,11 @@ namespace GreenshotPlugin.Core {
var y = cursorLocation.Y - iconInfo.yHotspot - capture.ScreenBounds.Y; var y = cursorLocation.Y - iconInfo.yHotspot - capture.ScreenBounds.Y;
// Set the location // Set the location
capture.CursorLocation = new Point(x, y); capture.CursorLocation = new Point(x, y);
using (Icon icon = Icon.FromHandle(safeIcon.DangerousGetHandle())) { using (Icon icon = Icon.FromHandle(safeIcon.DangerousGetHandle())) {
capture.Cursor = icon; capture.Cursor = icon;
} }
if (iconInfo.hbmMask != IntPtr.Zero) { if (iconInfo.hbmMask != IntPtr.Zero) {
DeleteObject(iconInfo.hbmMask); DeleteObject(iconInfo.hbmMask);
} }
@ -494,7 +496,7 @@ namespace GreenshotPlugin.Core {
} }
return CaptureRectangle(capture, capture.ScreenBounds); return CaptureRectangle(capture, capture.ScreenBounds);
} }
/// <summary> /// <summary>
/// Helper method to create an exception that might explain what is wrong while capturing /// Helper method to create an exception that might explain what is wrong while capturing
/// </summary> /// </summary>

View file

@ -1,20 +1,20 @@
/* /*
* Greenshot - a free and open source screenshot tool * Greenshot - a free and open source screenshot tool
* Copyright (C) 2007-2020 Thomas Braun, Jens Klingen, Robin Krom * Copyright (C) 2007-2020 Thomas Braun, Jens Klingen, Robin Krom
* *
* For more information see: http://getgreenshot.org/ * For more information see: http://getgreenshot.org/
* The Greenshot project is hosted on GitHub https://github.com/greenshot/greenshot * The Greenshot project is hosted on GitHub https://github.com/greenshot/greenshot
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 1 of the License, or * the Free Software Foundation, either version 1 of the License, or
* (at your option) any later version. * (at your option) any later version.
* *
* This program is distributed in the hope that it will be useful, * This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details. * GNU General Public License for more details.
* *
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
@ -42,38 +42,38 @@ namespace GreenshotPlugin.Interfaces {
get; get;
set; set;
} }
DateTime DateTime { DateTime DateTime {
get; get;
set; set;
} }
List<IDestination> CaptureDestinations { List<IDestination> CaptureDestinations {
get; get;
set; set;
} }
Dictionary<string, string> MetaData { Dictionary<string, string> MetaData {
get; get;
} }
/// <summary> /// <summary>
/// Helper method to prevent complex code which needs to check every key /// Helper method to prevent complex code which needs to check every key
/// </summary> /// </summary>
/// <param name="key">The key for the meta-data</param> /// <param name="key">The key for the meta-data</param>
/// <param name="value">The value for the meta-data</param> /// <param name="value">The value for the meta-data</param>
void AddMetaData(string key, string value); void AddMetaData(string key, string value);
void ClearDestinations(); void ClearDestinations();
void RemoveDestination(IDestination captureDestination); void RemoveDestination(IDestination captureDestination);
void AddDestination(IDestination captureDestination); void AddDestination(IDestination captureDestination);
bool HasDestination(string designation); bool HasDestination(string designation);
CaptureMode CaptureMode { CaptureMode CaptureMode {
get; get;
set; set;
} }
float DpiX { float DpiX {
get; get;
set; set;
@ -98,7 +98,7 @@ namespace GreenshotPlugin.Interfaces {
set; set;
} }
} }
/// <summary> /// <summary>
/// The interface to the Capture object, so Plugins can use it. /// The interface to the Capture object, so Plugins can use it.
/// </summary> /// </summary>
@ -116,33 +116,33 @@ namespace GreenshotPlugin.Interfaces {
} }
void NullImage(); void NullImage();
Rectangle ScreenBounds { Rectangle ScreenBounds {
get; get;
set; set;
} }
Icon Cursor { Icon Cursor {
get; get;
set; set;
} }
// Boolean to specify if the cursor is available // Boolean to specify if the cursor is available
bool CursorVisible { bool CursorVisible {
get; get;
set; set;
} }
Point CursorLocation { Point CursorLocation {
get; get;
set; set;
} }
Point Location { Point Location {
get; get;
set; set;
} }
/// <summary> /// <summary>
/// Crops the capture to the specified rectangle (with Bitmap coordinates!) /// Crops the capture to the specified rectangle (with Bitmap coordinates!)
/// </summary> /// </summary>
@ -156,6 +156,11 @@ namespace GreenshotPlugin.Interfaces {
/// <param name="y">y coordinates to move the mouse</param> /// <param name="y">y coordinates to move the mouse</param>
void MoveMouseLocation(int x, int y); void MoveMouseLocation(int x, int y);
/// <summary>
/// Store the OCR information for this capture
/// </summary>
OcrInformation OcrInformation { get; set; }
// / TODO: Enable when the elements are usable again. // / TODO: Enable when the elements are usable again.
///// <summary> ///// <summary>
///// Apply a translate to the elements e.g. needed for crop ///// Apply a translate to the elements e.g. needed for crop
@ -163,7 +168,7 @@ namespace GreenshotPlugin.Interfaces {
///// <param name="x">x coordinates to move the elements</param> ///// <param name="x">x coordinates to move the elements</param>
///// <param name="y">y coordinates to move the elements</param> ///// <param name="y">y coordinates to move the elements</param>
//void MoveElements(int x, int y); //void MoveElements(int x, int y);
///// <summary> ///// <summary>
///// Add a new element to the capture ///// Add a new element to the capture
///// </summary> ///// </summary>

View file

@ -25,15 +25,103 @@ using System.Threading.Tasks;
namespace GreenshotPlugin.Interfaces namespace GreenshotPlugin.Interfaces
{ {
/// <summary>
/// This interface describes something that can do OCR of a bitmap
/// </summary>
public interface IOcrProvider public interface IOcrProvider
{ {
/// <summary>
/// Start the actual OCR
/// </summary>
/// <param name="image">Image</param>
/// <returns>OcrInformation</returns>
Task<OcrInformation> DoOcrAsync(Image image);
/// <summary>
/// Start the actual OCR
/// </summary>
/// <param name="surface">ISurface</param>
/// <returns>OcrInformation</returns>
Task<OcrInformation> DoOcrAsync(ISurface surface); Task<OcrInformation> DoOcrAsync(ISurface surface);
} }
/// <summary>
/// Contains the information about a word
/// </summary>
public class Word
{
/// <summary>
/// The actual text for the word
/// </summary>
public string Text { get; set; }
/// <summary>
/// The location of the word
/// </summary>
public Rectangle Location { get; set; }
}
/// <summary>
/// Describes a line of words
/// </summary>
public class Line
{
private Rectangle? _calculatedBounds;
/// <summary>
/// Constructor will preallocate the number of words
/// </summary>
/// <param name="wordCount">int</param>
public Line(int wordCount)
{
Words = new Word[wordCount];
for (int i = 0; i < wordCount; i++)
{
Words[i] = new Word();
}
}
/// <summary>
/// An array with words
/// </summary>
public Word[] Words { get; }
/// <summary>
/// Calculate the bounds of the words
/// </summary>
/// <returns>Rectangle</returns>
private Rectangle CalculateBounds()
{
if (Words.Length == 0)
{
return Rectangle.Empty;
}
var result = Words[0].Location;
for (var index = 0; index < Words.Length; index++)
{
result = Rectangle.Union(result, Words[index].Location);
}
return result;
}
/// <summary>
/// Return the calculated bounds for the whole line
/// </summary>
public Rectangle CalculatedBounds
{
get { return _calculatedBounds ??= CalculateBounds(); }
}
}
/// <summary>
/// Contains all the information on the OCR result
/// </summary>
public class OcrInformation public class OcrInformation
{ {
public string Text { get; set; } public string Text { get; set; }
public IList<(string word, Rectangle location)> Words { get; } = new List<(string, Rectangle)>(); public IList<Line> Lines { get; } = new List<Line>();
} }
} }

View file

@ -27,6 +27,7 @@ using Windows.Graphics.Imaging;
using Windows.Media.Ocr; using Windows.Media.Ocr;
using GreenshotPlugin.Core; using GreenshotPlugin.Core;
using System.Text; using System.Text;
using Windows.Storage.Streams;
using GreenshotPlugin.Interfaces; using GreenshotPlugin.Interfaces;
using GreenshotPlugin.Interfaces.Plugin; using GreenshotPlugin.Interfaces.Plugin;
@ -52,6 +53,8 @@ namespace GreenshotWin10Plugin
/// </summary> /// </summary>
public Win10OcrDestination() public Win10OcrDestination()
{ {
// Set this as IOcrProvider
SimpleServiceProvider.Current.AddService<IOcrProvider>(this);
var languages = OcrEngine.AvailableRecognizerLanguages; var languages = OcrEngine.AvailableRecognizerLanguages;
foreach (var language in languages) foreach (var language in languages)
{ {
@ -59,25 +62,58 @@ namespace GreenshotWin10Plugin
} }
} }
/// <summary>
/// Scan the surface bitmap for text, and get the OcrResult
/// </summary>
/// <param name="surface">ISurface</param>
/// <returns>OcrResult sync</returns>
public Task<OcrInformation> DoOcrAsync(ISurface surface)
{
using var imageStream = new MemoryStream();
ImageOutput.SaveToStream(surface, imageStream, new SurfaceOutputSettings());
imageStream.Position = 0;
var randomAccessStream = imageStream.AsRandomAccessStream();
return DoOcrAsync(randomAccessStream);
}
/// <summary>
/// Scan the Image for text, and get the OcrResult
/// </summary>
/// <param name="image">Image</param>
/// <returns>OcrResult sync</returns>
public async Task<OcrInformation> DoOcrAsync(Image image)
{
OcrInformation result;
using (var imageStream = new MemoryStream())
{
ImageOutput.SaveToStream(image, null, imageStream, new SurfaceOutputSettings());
imageStream.Position = 0;
var randomAccessStream = imageStream.AsRandomAccessStream();
result = await DoOcrAsync(randomAccessStream);
}
return result;
}
/// <summary> /// <summary>
/// Scan the surface bitmap for text, and get the OcrResult /// Scan the surface bitmap for text, and get the OcrResult
/// </summary> /// </summary>
/// <param name="surface">ISurface</param> /// <param name="randomAccessStream">IRandomAccessStream</param>
/// <returns>OcrResult</returns> /// <returns>OcrResult sync</returns>
public async Task<OcrInformation> DoOcrAsync(ISurface surface) public async Task<OcrInformation> DoOcrAsync(IRandomAccessStream randomAccessStream)
{ {
var ocrEngine = OcrEngine.TryCreateFromUserProfileLanguages(); var ocrEngine = OcrEngine.TryCreateFromUserProfileLanguages();
using var imageStream = new MemoryStream(); if (ocrEngine is null)
ImageOutput.SaveToStream(surface, imageStream, new SurfaceOutputSettings()); {
imageStream.Position = 0; return null;
}
var decoder = await BitmapDecoder.CreateAsync(imageStream.AsRandomAccessStream()); var decoder = await BitmapDecoder.CreateAsync(randomAccessStream);
var softwareBitmap = await decoder.GetSoftwareBitmapAsync(); var softwareBitmap = await decoder.GetSoftwareBitmapAsync();
var ocrResult = await ocrEngine.RecognizeAsync(softwareBitmap); var ocrResult = await ocrEngine.RecognizeAsync(softwareBitmap);
var result = new OcrInformation(); var result = new OcrInformation();
// Build the text from the lines, otherwise it's just everything concated together // Build the text from the lines, otherwise it's just everything concatenated together
var text = new StringBuilder(); var text = new StringBuilder();
foreach (var line in ocrResult.Lines) foreach (var line in ocrResult.Lines)
{ {
@ -85,16 +121,23 @@ namespace GreenshotWin10Plugin
} }
result.Text = text.ToString(); result.Text = text.ToString();
foreach (var line in ocrResult.Lines) foreach (var ocrLine in ocrResult.Lines)
{ {
foreach (var word in line.Words) var line = new Line(ocrLine.Words.Count);
{ result.Lines.Add(line);
var rectangle = new Rectangle((int)word.BoundingRect.X, (int)word.BoundingRect.Y, (int)word.BoundingRect.Width, (int)word.BoundingRect.Height);
result.Words.Add((word.Text, rectangle)); for (var index = 0; index < ocrLine.Words.Count; index++)
} {
} var ocrWord = ocrLine.Words[index];
return result; var location = new Rectangle((int) ocrWord.BoundingRect.X, (int) ocrWord.BoundingRect.Y,
(int) ocrWord.BoundingRect.Width, (int) ocrWord.BoundingRect.Height);
var word = line.Words[index];
word.Text = ocrWord.Text;
word.Location = location;
}
}
return result;
} }
/// <summary> /// <summary>