blob: 1d685bb4eb34b10105403f2880dd86f058bdf3ab [file] [log] [blame]
* 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.
#include <memory>
#include "webrtc/modules/desktop_capture/desktop_capture_options.h"
#include "webrtc/modules/desktop_capture/desktop_capturer.h"
#include "webrtc/modules/desktop_capture/mouse_cursor_monitor.h"
#include "webrtc/rtc_base/constructormagic.h"
namespace webrtc {
template <bool use_desktop_relative_cursor_position>
class DesktopAndCursorComposerTest;
// A wrapper for DesktopCapturer that also captures mouse using specified
// MouseCursorMonitor and renders it on the generated streams.
class DesktopAndCursorComposer : public DesktopCapturer,
public DesktopCapturer::Callback,
public MouseCursorMonitor::Callback {
// Creates a new blender that captures mouse cursor using |mouse_monitor| and
// renders it into the frames generated by |desktop_capturer|. If
// |mouse_monitor| is NULL the frames are passed unmodified. Takes ownership
// of both arguments.
// Deprecated: use the constructor below.
DesktopAndCursorComposer(DesktopCapturer* desktop_capturer,
MouseCursorMonitor* mouse_monitor);
// Creates a new blender that captures mouse cursor using
// MouseCursorMonitor::Create(options) and renders it into the frames
// generated by |desktop_capturer|.
DesktopAndCursorComposer(std::unique_ptr<DesktopCapturer> desktop_capturer,
const DesktopCaptureOptions& options);
~DesktopAndCursorComposer() override;
// DesktopCapturer interface.
void Start(DesktopCapturer::Callback* callback) override;
void SetSharedMemoryFactory(
std::unique_ptr<SharedMemoryFactory> shared_memory_factory) override;
void CaptureFrame() override;
void SetExcludedWindow(WindowId window) override;
// Allows test cases to use a fake MouseCursorMonitor implementation.
friend class DesktopAndCursorComposerTest<true>;
friend class DesktopAndCursorComposerTest<false>;
// Constructor to delegate both deprecated and new constructors and allows
// test cases to use a fake MouseCursorMonitor implementation.
DesktopAndCursorComposer(DesktopCapturer* desktop_capturer,
MouseCursorMonitor* mouse_monitor,
bool use_desktop_relative_cursor_position);
// DesktopCapturer::Callback interface.
void OnCaptureResult(DesktopCapturer::Result result,
std::unique_ptr<DesktopFrame> frame) override;
// MouseCursorMonitor::Callback interface.
void OnMouseCursor(MouseCursor* cursor) override;
void OnMouseCursorPosition(MouseCursorMonitor::CursorState state,
const DesktopVector& position) override;
void OnMouseCursorPosition(const DesktopVector& position) override;
const std::unique_ptr<DesktopCapturer> desktop_capturer_;
const std::unique_ptr<MouseCursorMonitor> mouse_monitor_;
// This is a temporary flag to decide how to use the |mouse_monitor_|.
// If it's true, DesktopAndCursorComposer will use the absolute position from
// MouseCursorMonitor but ignore the MouseCursorMonitor::CursorState.
// Otherwise MouseCursorMonitor::CursorState is respected. This flag is false
// when the deprecated constructor is used, and true when the new one is used.
// This flag will be removed together with the deprecated constructor.
const bool use_desktop_relative_cursor_position_;
DesktopCapturer::Callback* callback_;
std::unique_ptr<MouseCursor> cursor_;
// This field is irrelevant if |use_desktop_relative_cursor_position_| is
// true.
MouseCursorMonitor::CursorState cursor_state_;
DesktopVector cursor_position_;
} // namespace webrtc