aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.RemoteDesktop/ScreenCaptureEngine.cs
blob: 4efb1817dff7b08b18e856ba393ef75cd8425b6e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
using System;
using System.Collections.Generic;
using System.Linq;
using System.Textpre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Tango.Core;
using Tango.RemoteDesktop.Utils;

namespace Tango.RemoteDesktop
{
    /// <summary>
    /// Represents a generic screen capture engine.
    /// The <see cref="TFrame"/> type will be the type of difference object delivered by the engine.
    /// </summary>
    /// <typeparam name="TFrame">The type of the frame.</typeparam>
    /// <seealso cref="Tango.RemoteDesktop.IScreenCaptureEngine{TFrame}" />
    public class ScreenCaptureEngine<TFrame> : ExtendedObject, IScreenCaptureEngine<TFrame> where TFrame : class, IFrame
    {
        private Thread _captureThread;
        private Bitmap _previousBitmap;
        private bool _isDisposed;

        /// <summary>
        /// Occurs when a new screen frame is available.
        /// </summary>
        public event EventHandler<ScreenCaptureFrameReceivedEventArgs<TFrame>> FrameReceived;

        /// <summary>
        /// Gets or sets the screen capture method.
        /// </summary>
        public ICaptureMethod CaptureMethod { get; set; }

        /// <summary>
        /// Gets or sets the screen capture region.
        /// </summary>
        public CaptureRegion CaptureRegion { get; set; }

        /// <summary>
        /// Gets a value indicating whether this instance is currently capturing.
        /// </summary>
        public bool IsStarted { get; private set; }

        /// <summary>
        /// Gets or sets the frame rate per second.
        /// Default is 10.
        /// </summary>
        public int FrameRate { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether to include the cursor when capturing.
        /// </summary>
        public bool CaptureCursor { get; set; }

        /// <summary>
        /// Gets or sets the bitmap comparer.
        /// </summary>
        public IBitmapComparer<TFrame> Comparer { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether to enable image comparison.
        /// </summary>
        public bool EnableComparer { get; set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="ScreenCaptureEngine{TFrame}"/> class using the specified <see cref="IBitmapComparer{TFrame}"/>.
        /// </summary>
        /// <param name="comparer">The comparer.</param>
        public ScreenCaptureEngine(IBitmapComparer<TFrame> comparer)
        {
            FrameRate = 10;
            CaptureMethod = new CaptureMethods.GdiScreenCapture();
            CaptureRegion = new CaptureRegion(System.Windows.Forms.Screen.PrimaryScreen.Bounds);
            Comparer = comparer;
            CaptureCursor = true;

            if (Comparer != null)
            {
                EnableComparer = true;
            }
        }

        /// <summary>
        /// Start capturing.
        /// </summary>
        /// <exception cref="ObjectDisposedException">Screen capture engine cannot be started after disposed.</exception>
        public void Start()
        {
            if (_isDisposed)
            {
                throw new ObjectDisposedException("Screen capture engine cannot be started after disposed.");
            }

            if (!IsStarted)
            {
                IsStarted = true;

                _captureThread = new Thread(CaptureThreadMethod);
                _captureThread.IsBackground = true;
                _captureThread.Name = "Screen Capture Thread";
                _captureThread.Start();
            }
        }

        /// <summary>
        /// Stop capturing.
        /// </summary>
        public void Stop()
        {
            if (IsStarted)
            {
                IsStarted = false;
            }
        }

        /// <summary>
        /// Releases unmanaged and - optionally - managed resources.
        /// </summary>
        public void Dispose()
        {
            if (!_isDisposed)
            {
                _isDisposed = true;
                Stop();
                CaptureMethod?.Dispose();
            }
        }

        private void CaptureThreadMethod()
        {
            Stopwatch watch = new Stopwatch();

            LogManager.Log($"Screen capture engine started with the following definitions:\nCapture Region: {CaptureRegion}\nCapture Method: {CaptureMethod.GetType().Name}\nFrame Rate: {FrameRate}\nComparer Enabled: {EnableComparer}");

            while (IsStarted)
            {
                watch.Restart();

                try
                {
                    var bitmap = CaptureMethod.GetDesktopBitmap(CaptureRegion);

                    if (CaptureCursor)
                    {
                        using (Graphics g = Graphics.FromImage(bitmap))
                        {
                            CursorUtils.ApplyCursor(g, bitmap, CaptureRegion.Left, CaptureRegion.Top);
                        }
                    }

                    if (EnableComparer && Comparer != null)
                    {
                        if (_previousBitmap == null)
                        {
                            _previousBitmap = bitmap.Clone() as Bitmap;
                            OnFrameReceived(bitmap, null, 0);
                        }
                        else
                        {
                            try
                            {
                                BitmapComparerResult<TFrame> result = Comparer.CreateDifference(_previousBitmap, bitmap);
                                _previousBitmap.Dispose();
                                _previousBitmap = bitmap.Clone() as Bitmap;
                                OnFrameReceived(bitmap, result.Frame, result.DifferenceCount);
                            }
                            catch (MaxDifferencesReachedException)
                            {
                                _previousBitmap.Dispose();
                                _previousBitmap = bitmap.Clone() as Bitmap;
                                OnFrameReceived(bitmap, null, (uint)(bitmap.Width * bitmap.Height));
                            }
                        }
                    }
                    else
                    {
                        OnFrameReceived(bitmap, null, 0);
                    }
                }
                catch (Exception ex)
                {
                    Debug.WriteLine($"Error in screen capture engine: {ex.Message}");
                    _previousBitmap = null;
                }

                int delay = Math.Max(5, (1000 / FrameRate) - (int)watch.ElapsedMilliseconds);
                Thread.Sleep(delay);
            }

            _previousBitmap = null;

            LogManager.Log("Screen capture engine stopped.");
        }

        private void OnFrameReceived(Bitmap currentBitmap, TFrame diffFrame, uint differenceCount)
        {
            if (!IsStarted) return;

            FrameReceived?.Invoke(this, new ScreenCaptureFrameReceivedEventArgs<TFrame>()
            {
                Frame = new ScreenCaptureFrame<TFrame>(currentBitmap, diffFrame)
                {
                    DifferenceCount = differenceCount
                }
            });
        }
    }
}