6138f0f89d
This reverts commit 0adc4953512ee0a57cf7f3c0591b024c2316554a. It broke FYI bots TBR=sergeyu@chromium.org Review URL: https://webrtc-codereview.appspot.com/27649004 git-svn-id: http://webrtc.googlecode.com/svn/trunk@7364 4adac7df-926f-26a2-2b94-8c16560cd09d
105 lines
3.7 KiB
C++
105 lines
3.7 KiB
C++
/*
|
|
* Copyright (c) 2013 The WebRTC project authors. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license
|
|
* that can be found in the LICENSE file in the root of the source
|
|
* tree. An additional intellectual property rights grant can be found
|
|
* in the file PATENTS. All contributing project authors may
|
|
* be found in the AUTHORS file in the root of the source tree.
|
|
*/
|
|
|
|
#ifndef WEBRTC_MODULES_DESKTOP_CAPTURE_SCREEN_CAPTURER_H_
|
|
#define WEBRTC_MODULES_DESKTOP_CAPTURE_SCREEN_CAPTURER_H_
|
|
|
|
#include <vector>
|
|
|
|
#include "webrtc/modules/desktop_capture/desktop_capture_types.h"
|
|
#include "webrtc/modules/desktop_capture/desktop_capturer.h"
|
|
#include "webrtc/system_wrappers/interface/scoped_ptr.h"
|
|
#include "webrtc/typedefs.h"
|
|
|
|
namespace webrtc {
|
|
|
|
class DesktopCaptureOptions;
|
|
struct MouseCursorShape;
|
|
|
|
// Class used to capture video frames asynchronously.
|
|
//
|
|
// The full capture sequence is as follows:
|
|
//
|
|
// (1) Start
|
|
// This is when pre-capture steps are executed, such as flagging the
|
|
// display to prevent it from sleeping during a session.
|
|
//
|
|
// (2) CaptureFrame
|
|
// 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 ScreenCapturer : public DesktopCapturer {
|
|
public:
|
|
// Use a struct to represent a screen although it has only an id for now,
|
|
// because we may want to add more fields (e.g. description) in the future.
|
|
struct Screen {
|
|
ScreenId id;
|
|
};
|
|
typedef std::vector<Screen> ScreenList;
|
|
|
|
// Provides callbacks used by the capturer to pass captured video frames and
|
|
// mouse cursor shapes to the processing pipeline.
|
|
//
|
|
// TODO(sergeyu): Move cursor shape capturing to a separate class because it's
|
|
// unrelated.
|
|
class MouseShapeObserver {
|
|
public:
|
|
// Called when the cursor shape has changed. Must take ownership of
|
|
// |cursor_shape|.
|
|
virtual void OnCursorShapeChanged(MouseCursorShape* cursor_shape) = 0;
|
|
|
|
protected:
|
|
virtual ~MouseShapeObserver() {}
|
|
};
|
|
|
|
virtual ~ScreenCapturer() {}
|
|
|
|
// Creates platform-specific capturer.
|
|
//
|
|
// TODO(sergeyu): Remove all Create() methods except the first one.
|
|
// crbug.com/172183
|
|
static ScreenCapturer* Create(const DesktopCaptureOptions& options);
|
|
static ScreenCapturer* Create();
|
|
|
|
#if defined(WEBRTC_LINUX)
|
|
// Creates platform-specific capturer and instructs it whether it should use
|
|
// X DAMAGE support.
|
|
static ScreenCapturer* CreateWithXDamage(bool use_x_damage);
|
|
#elif defined(WEBRTC_WIN)
|
|
// Creates Windows-specific capturer and instructs it whether or not to
|
|
// disable desktop compositing.
|
|
static ScreenCapturer* CreateWithDisableAero(bool disable_aero);
|
|
#endif // defined(WEBRTC_WIN)
|
|
|
|
// Called at the beginning of a capturing session. |mouse_shape_observer| must
|
|
// remain valid until the capturer is destroyed.
|
|
virtual void SetMouseShapeObserver(
|
|
MouseShapeObserver* mouse_shape_observer) = 0;
|
|
|
|
// Get the list of screens (not containing kFullDesktopScreenId). Returns
|
|
// false in case of a failure.
|
|
virtual bool GetScreenList(ScreenList* screens) = 0;
|
|
|
|
// Select the screen to be captured. Returns false in case of a failure (e.g.
|
|
// if there is no screen with the specified id). If this is never called, the
|
|
// full desktop is captured.
|
|
virtual bool SelectScreen(ScreenId id) = 0;
|
|
};
|
|
|
|
} // namespace webrtc
|
|
|
|
#endif // WEBRTC_MODULES_DESKTOP_CAPTURE_SCREEN_CAPTURER_H_
|