blob: 5b9529423813ed4419003bf2d4cc9bf294c5ed5a (
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
|
// Copyright (c) 2011 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef REMOTING_HOST_CAPTURER_H_
#define REMOTING_HOST_CAPTURER_H_
#include "base/basictypes.h"
#include "base/callback_old.h"
#include "remoting/base/capture_data.h"
#include "remoting/base/types.h"
namespace remoting {
// A class to perform the task of capturing the image of a window.
// The capture action is asynchronous to allow maximum throughput.
//
// The full capture process is as follows:
//
// (1) InvalidateRects
// This is an optional step where regions of the screen are marked as
// invalid. Some platforms (Windows, for now) won't use this and will
// instead calculate the diff-regions later (in step (2). Other
// platforms (Mac) will use this to mark all the changed regions of the
// screen. Some limited rect-merging (e.g., to eliminate exact
// duplicates) may be done here.
//
// (2) CaptureInvalidRects
// This is where the bits for the invalid rects are packaged up and sent
// to the encoder.
// A screen capture is performed if needed. For example, Windows requires
// a capture to calculate the diff from the previous screen, whereas the
// Mac version does not.
//
// Implementation has to ensure the following guarantees:
// 1. Double buffering
// Since data can be read while another capture action is happening.
class Capturer {
public:
// CaptureCompletedCallback is called when the capturer has completed.
typedef Callback1<scoped_refptr<CaptureData> >::Type CaptureCompletedCallback;
virtual ~Capturer() {};
// Create platform-specific capturer.
static Capturer* Create();
// Called when the screen configuration is changed.
virtual void ScreenConfigurationChanged() = 0;
// Return the pixel format of the screen.
virtual media::VideoFrame::Format pixel_format() const = 0;
// Clear out the list of invalid rects.
virtual void ClearInvalidRects() = 0;
// Invalidate the specified screen rects.
virtual void InvalidateRects(const InvalidRects& inval_rects) = 0;
// Invalidate the entire screen, of a given size.
virtual void InvalidateScreen(const gfx::Size& size) = 0;
// Invalidate the entire screen, using the size of the most recently
// captured screen.
virtual void InvalidateFullScreen() = 0;
// Capture the screen data associated with each of the accumulated
// rects in |inval_rects|.
// This routine will first call CalculateInvalidRects to update the
// list of |inval_rects|.
// When the capture is complete, |callback| is called.
//
// If |inval_rects_| is empty, then this does nothing except
// call the |callback| routine.
//
// It is OK to call this method while another thread is reading
// data of the last capture.
// There can be at most one concurrent read going on when this
// method is called.
virtual void CaptureInvalidRects(CaptureCompletedCallback* callback) = 0;
// Get the size of the most recently captured screen.
virtual const gfx::Size& size_most_recent() const = 0;
};
} // namespace remoting
#endif // REMOTING_HOST_CAPTURER_H_
|
