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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
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
                }
            });
        }
    }
}