xref: /aosp_15_r20/external/webrtc/modules/video_coding/utility/framerate_controller_deprecated.h (revision d9f758449e529ab9291ac668be2861e7a55c2422)
1 /*
2  *  Copyright (c) 2018 The WebRTC project authors. All Rights Reserved.
3  *
4  *  Use of this source code is governed by a BSD-style license
5  *  that can be found in the LICENSE file in the root of the source
6  *  tree. An additional intellectual property rights grant can be found
7  *  in the file PATENTS.  All contributing project authors may
8  *  be found in the AUTHORS file in the root of the source tree.
9  */
10 
11 #ifndef MODULES_VIDEO_CODING_UTILITY_FRAMERATE_CONTROLLER_DEPRECATED_H_
12 #define MODULES_VIDEO_CODING_UTILITY_FRAMERATE_CONTROLLER_DEPRECATED_H_
13 
14 #include <stdint.h>
15 
16 #include "absl/types/optional.h"
17 #include "rtc_base/rate_statistics.h"
18 
19 namespace webrtc {
20 
21 // Please use webrtc::FramerateController instead.
22 class FramerateControllerDeprecated {
23  public:
24   explicit FramerateControllerDeprecated(float target_framerate_fps);
25 
26   void SetTargetRate(float target_framerate_fps);
27   float GetTargetRate();
28 
29   // Advices user to drop next frame in order to reach target framerate.
30   bool DropFrame(uint32_t timestamp_ms) const;
31 
32   void AddFrame(uint32_t timestamp_ms);
33 
34   void Reset();
35 
36  private:
37   absl::optional<float> Rate(uint32_t timestamp_ms) const;
38 
39   absl::optional<float> target_framerate_fps_;
40   absl::optional<uint32_t> last_timestamp_ms_;
41   uint32_t min_frame_interval_ms_;
42   RateStatistics framerate_estimator_;
43 };
44 
45 }  // namespace webrtc
46 
47 #endif  // MODULES_VIDEO_CODING_UTILITY_FRAMERATE_CONTROLLER_DEPRECATED_H_
48