webrtc/video/frame_decode_scheduler.h
Evan Shrubsole c5a91449d6 Clean up FrameDecodeScheduler
* Migrate callback to one-time absl::AnyInvocable.
* Clean tests to use MockFunction.
* Use main thread instead of helper function in unittests.
* Fix some spelling mistakes.

Bug: None
Change-Id: I6145f5f5e2748dfa5278898cfdfd762c1840ff8d
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/274170
Reviewed-by: Ilya Nikolaevskiy <ilnik@webrtc.org>
Commit-Queue: Evan Shrubsole <eshr@webrtc.org>
Cr-Commit-Position: refs/heads/main@{#38016}
2022-09-06 08:24:48 +00:00

52 lines
1.7 KiB
C++

/*
* Copyright (c) 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 VIDEO_FRAME_DECODE_SCHEDULER_H_
#define VIDEO_FRAME_DECODE_SCHEDULER_H_
#include <stdint.h>
#include "absl/functional/any_invocable.h"
#include "absl/types/optional.h"
#include "api/units/timestamp.h"
#include "video/frame_decode_timing.h"
namespace webrtc {
class FrameDecodeScheduler {
public:
// Invoked when a frame with `rtp_timestamp` is ready for decoding.
using FrameReleaseCallback =
absl::AnyInvocable<void(uint32_t rtp_timestamp,
Timestamp render_time) &&>;
virtual ~FrameDecodeScheduler() = default;
// Returns the rtp timestamp of the next frame scheduled for release, or
// `nullopt` if no frame is currently scheduled.
virtual absl::optional<uint32_t> ScheduledRtpTimestamp() = 0;
// Schedules a frame for release based on `schedule`. When released,
// `callback` will be invoked with the `rtp` timestamp of the frame and the
// `render_time`
virtual void ScheduleFrame(uint32_t rtp,
FrameDecodeTiming::FrameSchedule schedule,
FrameReleaseCallback callback) = 0;
// Cancels all scheduled frames.
virtual void CancelOutstanding() = 0;
// Stop() Must be called before destruction.
virtual void Stop() = 0;
};
} // namespace webrtc
#endif // VIDEO_FRAME_DECODE_SCHEDULER_H_