6ff7713a70
Earlier, we were relying on CRD to periodically do frame captures.
This is however not needed since Wayland captures are event based
and once the compositor has send the event/frame to us, we can just
handover the frame to a registered callback. This ensures that we
have a single frame clock that (i.e. one present in the compositor).
Without this change, there is a chance that CRD capture clock is run
out of sync with the compositor's clock and cause unnecessary frame
delays.
See the following ideal scenario, for example, where '+' indicates
when a frame is sent by the compositor and when CRD tries to capture
it. This assumes that the same clock cycle for both CRD and the
compositor, each cycle length is enclosed within | .... |).
Compositor Frame Ready | +... | | +... |
CRD Frame Capture | .+.. | | .+.. |
In this case, when both the clocks are in sync, CRD is able to
capture frame right after it is generated by the compositor. But if
they are completely out of sync, then CRD can always see a stale
frame (delayed by one cycle and it can cause users to feel stutter).
Compositor Frame Ready | .+.. | | .+.. |
CRD Frame Capture | +... | | +... |
This stutter can become worse if the compositor is delayed in
generating the frames for some reason (e.g. load on the system).
Bug: chromium:1291247
Change-Id: I7c10c724fbbd87dc523d474e7ece8e8aa146fd7b
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/291080
Reviewed-by: Alexander Cooper <alcooper@chromium.org>
Commit-Queue: Salman Malik <salmanmalik@chromium.org>
Cr-Commit-Position: refs/heads/main@{#39218}
100 lines
3.8 KiB
C++
100 lines
3.8 KiB
C++
/*
|
|
* Copyright 2022 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 MODULES_DESKTOP_CAPTURE_LINUX_WAYLAND_SHARED_SCREENCAST_STREAM_H_
|
|
#define MODULES_DESKTOP_CAPTURE_LINUX_WAYLAND_SHARED_SCREENCAST_STREAM_H_
|
|
|
|
#include <memory>
|
|
|
|
#include "absl/types/optional.h"
|
|
#include "api/ref_counted_base.h"
|
|
#include "api/scoped_refptr.h"
|
|
#include "modules/desktop_capture/desktop_capturer.h"
|
|
#include "modules/desktop_capture/mouse_cursor.h"
|
|
#include "modules/desktop_capture/screen_capture_frame_queue.h"
|
|
#include "modules/desktop_capture/shared_desktop_frame.h"
|
|
#include "rtc_base/system/rtc_export.h"
|
|
|
|
namespace webrtc {
|
|
|
|
class SharedScreenCastStreamPrivate;
|
|
|
|
class RTC_EXPORT SharedScreenCastStream
|
|
: public rtc::RefCountedNonVirtual<SharedScreenCastStream> {
|
|
public:
|
|
class Observer {
|
|
public:
|
|
virtual void OnCursorPositionChanged() = 0;
|
|
virtual void OnCursorShapeChanged() = 0;
|
|
virtual void OnDesktopFrameChanged() = 0;
|
|
virtual void OnFailedToProcessBuffer() = 0;
|
|
virtual void OnStreamConfigured() = 0;
|
|
virtual void OnFrameRateChanged(uint32_t frame_rate) = 0;
|
|
|
|
protected:
|
|
Observer() = default;
|
|
virtual ~Observer() = default;
|
|
};
|
|
|
|
static rtc::scoped_refptr<SharedScreenCastStream> CreateDefault();
|
|
|
|
bool StartScreenCastStream(uint32_t stream_node_id);
|
|
bool StartScreenCastStream(uint32_t stream_node_id,
|
|
int fd,
|
|
uint32_t width = 0,
|
|
uint32_t height = 0,
|
|
bool is_cursor_embedded = false,
|
|
DesktopCapturer::Callback* callback = nullptr);
|
|
void UpdateScreenCastStreamResolution(uint32_t width, uint32_t height);
|
|
void UpdateScreenCastStreamFrameRate(uint32_t frame_rate);
|
|
void SetUseDamageRegion(bool use_damage_region);
|
|
void SetObserver(SharedScreenCastStream::Observer* observer);
|
|
void StopScreenCastStream();
|
|
|
|
// Below functions return the most recent information we get from a
|
|
// PipeWire buffer on each Process() callback. This assumes that we
|
|
// managed to successfuly connect to a PipeWire stream provided by the
|
|
// compositor (based on stream parameters). The cursor data are obtained
|
|
// from spa_meta_cursor stream metadata and therefore the cursor is not
|
|
// part of actual screen/window frame.
|
|
|
|
// Returns the most recent screen/window frame we obtained from PipeWire
|
|
// buffer. Will return an empty frame in case we didn't manage to get a frame
|
|
// from PipeWire buffer.
|
|
std::unique_ptr<SharedDesktopFrame> CaptureFrame();
|
|
|
|
// Returns the most recent mouse cursor image. Will return an nullptr cursor
|
|
// in case we didn't manage to get a cursor from PipeWire buffer. NOTE: the
|
|
// cursor image might not be updated on every cursor location change, but
|
|
// actually only when its shape changes.
|
|
std::unique_ptr<MouseCursor> CaptureCursor();
|
|
|
|
// Returns the most recent mouse cursor position. Will not return a value in
|
|
// case we didn't manage to get it from PipeWire buffer.
|
|
absl::optional<DesktopVector> CaptureCursorPosition();
|
|
|
|
~SharedScreenCastStream();
|
|
|
|
protected:
|
|
SharedScreenCastStream();
|
|
|
|
private:
|
|
friend class SharedScreenCastStreamPrivate;
|
|
|
|
SharedScreenCastStream(const SharedScreenCastStream&) = delete;
|
|
SharedScreenCastStream& operator=(const SharedScreenCastStream&) = delete;
|
|
|
|
std::unique_ptr<SharedScreenCastStreamPrivate> private_;
|
|
};
|
|
|
|
} // namespace webrtc
|
|
|
|
#endif // MODULES_DESKTOP_CAPTURE_LINUX_WAYLAND_SHARED_SCREENCAST_STREAM_H_
|