niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 1 | /* |
stefan@webrtc.org | 07b45a5 | 2012-02-02 08:37:48 +0000 | [diff] [blame] | 2 | * Copyright (c) 2012 The WebRTC project authors. All Rights Reserved. |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 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 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 11 | #ifndef VIDEO_VIDEO_STREAM_ENCODER_H_ |
| 12 | #define VIDEO_VIDEO_STREAM_ENCODER_H_ |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 13 | |
Yuwei Huang | d9f99c1 | 2017-10-24 15:40:52 -0700 | [diff] [blame] | 14 | #include <atomic> |
sprang | c5d62e2 | 2017-04-02 23:53:04 -0700 | [diff] [blame] | 15 | #include <map> |
kwiberg | 27f982b | 2016-03-01 11:52:33 -0800 | [diff] [blame] | 16 | #include <memory> |
perkj | 376b192 | 2016-05-02 11:35:24 -0700 | [diff] [blame] | 17 | #include <string> |
mflodman@webrtc.org | 02270cd | 2015-02-06 13:10:19 +0000 | [diff] [blame] | 18 | #include <vector> |
mflodman@webrtc.org | d6ec386 | 2012-10-25 11:30:29 +0000 | [diff] [blame] | 19 | |
philipel | d9cc8c0 | 2019-09-16 14:53:40 +0200 | [diff] [blame] | 20 | #include "api/units/data_rate.h" |
Jiawei Ou | 4206a0a | 2018-07-20 15:49:43 -0700 | [diff] [blame] | 21 | #include "api/video/video_bitrate_allocator.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 22 | #include "api/video/video_rotation.h" |
Niels Möller | c6ce9c5 | 2018-05-11 11:15:30 +0200 | [diff] [blame] | 23 | #include "api/video/video_sink_interface.h" |
Niels Möller | 0327c2d | 2018-05-21 14:09:31 +0200 | [diff] [blame] | 24 | #include "api/video/video_stream_encoder_interface.h" |
Niels Möller | 213618e | 2018-07-24 09:29:58 +0200 | [diff] [blame] | 25 | #include "api/video/video_stream_encoder_observer.h" |
| 26 | #include "api/video/video_stream_encoder_settings.h" |
Erik Språng | 6a7baa7 | 2019-02-26 18:31:00 +0100 | [diff] [blame] | 27 | #include "api/video_codecs/video_codec.h" |
Niels Möller | 0327c2d | 2018-05-21 14:09:31 +0200 | [diff] [blame] | 28 | #include "api/video_codecs/video_encoder.h" |
Niels Möller | 6bb5ab9 | 2019-01-11 11:11:10 +0100 | [diff] [blame] | 29 | #include "modules/video_coding/utility/frame_dropper.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 30 | #include "modules/video_coding/utility/quality_scaler.h" |
philipel | da5aa4d | 2019-04-26 13:37:37 +0200 | [diff] [blame] | 31 | #include "rtc_base/critical_section.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 32 | #include "rtc_base/event.h" |
Åsa Persson | f3d828e | 2019-05-06 12:22:49 +0200 | [diff] [blame] | 33 | #include "rtc_base/experiments/balanced_degradation_settings.h" |
Åsa Persson | 139f4dc | 2019-08-02 09:29:58 +0200 | [diff] [blame] | 34 | #include "rtc_base/experiments/quality_scaler_settings.h" |
Erik Språng | 7ca375c | 2019-02-06 16:20:17 +0100 | [diff] [blame] | 35 | #include "rtc_base/experiments/rate_control_settings.h" |
philipel | d9cc8c0 | 2019-09-16 14:53:40 +0200 | [diff] [blame] | 36 | #include "rtc_base/numerics/exp_filter.h" |
Erik Språng | 6a7baa7 | 2019-02-26 18:31:00 +0100 | [diff] [blame] | 37 | #include "rtc_base/race_checker.h" |
Niels Möller | 6bb5ab9 | 2019-01-11 11:11:10 +0100 | [diff] [blame] | 38 | #include "rtc_base/rate_statistics.h" |
Sebastian Jansson | b55015e | 2019-04-09 13:44:04 +0200 | [diff] [blame] | 39 | #include "rtc_base/synchronization/sequence_checker.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 40 | #include "rtc_base/task_queue.h" |
Niels Möller | fe407b7 | 2019-09-10 10:48:48 +0200 | [diff] [blame] | 41 | #include "system_wrappers/include/clock.h" |
Erik Språng | 7ca375c | 2019-02-06 16:20:17 +0100 | [diff] [blame] | 42 | #include "video/encoder_bitrate_adjuster.h" |
Ilya Nikolaevskiy | 2ebf523 | 2019-05-13 16:13:36 +0200 | [diff] [blame] | 43 | #include "video/frame_encode_metadata_writer.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 44 | #include "video/overuse_frame_detector.h" |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 45 | |
| 46 | namespace webrtc { |
mflodman@webrtc.org | 84d1783 | 2011-12-01 17:02:23 +0000 | [diff] [blame] | 47 | |
Sebastian Jansson | 652dc91 | 2018-04-19 17:09:15 +0200 | [diff] [blame] | 48 | // VideoStreamEncoder represent a video encoder that accepts raw video frames as |
| 49 | // input and produces an encoded bit stream. |
| 50 | // Usage: |
| 51 | // Instantiate. |
| 52 | // Call SetSink. |
| 53 | // Call SetSource. |
| 54 | // Call ConfigureEncoder with the codec settings. |
| 55 | // Call Stop() when done. |
| 56 | class VideoStreamEncoder : public VideoStreamEncoderInterface, |
| 57 | private EncodedImageCallback, |
| 58 | // Protected only to provide access to tests. |
| 59 | protected AdaptationObserverInterface { |
| 60 | public: |
Sebastian Jansson | 572c60f | 2019-03-04 18:30:41 +0100 | [diff] [blame] | 61 | VideoStreamEncoder(Clock* clock, |
| 62 | uint32_t number_of_cores, |
Niels Möller | 213618e | 2018-07-24 09:29:58 +0200 | [diff] [blame] | 63 | VideoStreamEncoderObserver* encoder_stats_observer, |
| 64 | const VideoStreamEncoderSettings& settings, |
Sebastian Jansson | 74682c1 | 2019-03-01 11:50:20 +0100 | [diff] [blame] | 65 | std::unique_ptr<OveruseFrameDetector> overuse_detector, |
| 66 | TaskQueueFactory* task_queue_factory); |
Stefan Holmer | dbdb3a0 | 2018-07-17 16:03:46 +0200 | [diff] [blame] | 67 | ~VideoStreamEncoder() override; |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 68 | |
Sebastian Jansson | 652dc91 | 2018-04-19 17:09:15 +0200 | [diff] [blame] | 69 | void SetSource(rtc::VideoSourceInterface<VideoFrame>* source, |
Taylor Brandstetter | 49fcc10 | 2018-05-16 14:20:41 -0700 | [diff] [blame] | 70 | const DegradationPreference& degradation_preference) override; |
perkj | 803d97f | 2016-11-01 11:45:46 -0700 | [diff] [blame] | 71 | |
Sebastian Jansson | 652dc91 | 2018-04-19 17:09:15 +0200 | [diff] [blame] | 72 | void SetSink(EncoderSink* sink, bool rotation_applied) override; |
mflodman@webrtc.org | 02270cd | 2015-02-06 13:10:19 +0000 | [diff] [blame] | 73 | |
perkj | 26091b1 | 2016-09-01 01:17:40 -0700 | [diff] [blame] | 74 | // TODO(perkj): Can we remove VideoCodec.startBitrate ? |
Sebastian Jansson | 652dc91 | 2018-04-19 17:09:15 +0200 | [diff] [blame] | 75 | void SetStartBitrate(int start_bitrate_bps) override; |
mflodman@webrtc.org | 9ec883e | 2012-03-05 17:12:41 +0000 | [diff] [blame] | 76 | |
Niels Möller | 0327c2d | 2018-05-21 14:09:31 +0200 | [diff] [blame] | 77 | void SetBitrateAllocationObserver( |
Sebastian Jansson | 652dc91 | 2018-04-19 17:09:15 +0200 | [diff] [blame] | 78 | VideoBitrateAllocationObserver* bitrate_observer) override; |
sprang | 1a646ee | 2016-12-01 06:34:11 -0800 | [diff] [blame] | 79 | |
Elad Alon | 8f01c4e | 2019-06-28 15:19:43 +0200 | [diff] [blame] | 80 | void SetFecControllerOverride( |
| 81 | FecControllerOverride* fec_controller_override) override; |
| 82 | |
Per | 512ecb3 | 2016-09-23 15:52:06 +0200 | [diff] [blame] | 83 | void ConfigureEncoder(VideoEncoderConfig config, |
Niels Möller | f133856 | 2018-04-26 09:51:47 +0200 | [diff] [blame] | 84 | size_t max_data_payload_length) override; |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 85 | |
perkj | 26091b1 | 2016-09-01 01:17:40 -0700 | [diff] [blame] | 86 | // Permanently stop encoding. After this method has returned, it is |
| 87 | // guaranteed that no encoded frames will be delivered to the sink. |
Sebastian Jansson | 652dc91 | 2018-04-19 17:09:15 +0200 | [diff] [blame] | 88 | void Stop() override; |
perkj | 26091b1 | 2016-09-01 01:17:40 -0700 | [diff] [blame] | 89 | |
Sebastian Jansson | 652dc91 | 2018-04-19 17:09:15 +0200 | [diff] [blame] | 90 | void SendKeyFrame() override; |
mflodman@webrtc.org | d6ec386 | 2012-10-25 11:30:29 +0000 | [diff] [blame] | 91 | |
Elad Alon | b6ef99b | 2019-04-10 16:37:07 +0200 | [diff] [blame] | 92 | void OnLossNotification( |
| 93 | const VideoEncoder::LossNotification& loss_notification) override; |
| 94 | |
Erik Språng | 610c763 | 2019-03-06 15:37:33 +0100 | [diff] [blame] | 95 | void OnBitrateUpdated(DataRate target_bitrate, |
Florent Castelli | a8336d3 | 2019-09-09 13:36:55 +0200 | [diff] [blame] | 96 | DataRate stable_target_bitrate, |
Erik Språng | 610c763 | 2019-03-06 15:37:33 +0100 | [diff] [blame] | 97 | DataRate target_headroom, |
stefan@webrtc.org | edeea91 | 2014-12-08 19:46:23 +0000 | [diff] [blame] | 98 | uint8_t fraction_lost, |
Sebastian Jansson | 652dc91 | 2018-04-19 17:09:15 +0200 | [diff] [blame] | 99 | int64_t round_trip_time_ms) override; |
pwestin@webrtc.org | 49888ce | 2012-04-27 05:25:53 +0000 | [diff] [blame] | 100 | |
perkj | 803d97f | 2016-11-01 11:45:46 -0700 | [diff] [blame] | 101 | protected: |
kthelgason | 876222f | 2016-11-29 01:44:11 -0800 | [diff] [blame] | 102 | // Used for testing. For example the |ScalingObserverInterface| methods must |
| 103 | // be called on |encoder_queue_|. |
perkj | 803d97f | 2016-11-01 11:45:46 -0700 | [diff] [blame] | 104 | rtc::TaskQueue* encoder_queue() { return &encoder_queue_; } |
| 105 | |
Niels Möller | d692ef9 | 2017-10-04 15:28:55 +0200 | [diff] [blame] | 106 | // AdaptationObserverInterface implementation. |
perkj | 803d97f | 2016-11-01 11:45:46 -0700 | [diff] [blame] | 107 | // These methods are protected for easier testing. |
sprang | b1ca073 | 2017-02-01 08:38:12 -0800 | [diff] [blame] | 108 | void AdaptUp(AdaptReason reason) override; |
Åsa Persson | f5e5d25 | 2019-08-16 17:24:59 +0200 | [diff] [blame] | 109 | bool AdaptDown(AdaptReason reason) override; |
perkj | 803d97f | 2016-11-01 11:45:46 -0700 | [diff] [blame] | 110 | |
mflodman@webrtc.org | 84d1783 | 2011-12-01 17:02:23 +0000 | [diff] [blame] | 111 | private: |
perkj | a49cbd3 | 2016-09-16 07:53:41 -0700 | [diff] [blame] | 112 | class VideoSourceProxy; |
perkj | 26091b1 | 2016-09-01 01:17:40 -0700 | [diff] [blame] | 113 | |
kthelgason | 93f16d7 | 2017-01-16 06:15:23 -0800 | [diff] [blame] | 114 | class VideoFrameInfo { |
| 115 | public: |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 116 | VideoFrameInfo(int width, int height, bool is_texture) |
| 117 | : width(width), height(height), is_texture(is_texture) {} |
perkj | fa10b55 | 2016-10-02 23:45:26 -0700 | [diff] [blame] | 118 | int width; |
| 119 | int height; |
perkj | fa10b55 | 2016-10-02 23:45:26 -0700 | [diff] [blame] | 120 | bool is_texture; |
kthelgason | 93f16d7 | 2017-01-16 06:15:23 -0800 | [diff] [blame] | 121 | int pixel_count() const { return width * height; } |
perkj | fa10b55 | 2016-10-02 23:45:26 -0700 | [diff] [blame] | 122 | }; |
| 123 | |
Evan Shrubsole | 7c079f6 | 2019-09-26 09:55:03 +0200 | [diff] [blame^] | 124 | struct EncoderRateSettings { |
Erik Språng | 4c6ca30 | 2019-04-08 15:14:01 +0200 | [diff] [blame] | 125 | EncoderRateSettings(); |
| 126 | EncoderRateSettings(const VideoBitrateAllocation& bitrate, |
| 127 | double framerate_fps, |
| 128 | DataRate bandwidth_allocation, |
Florent Castelli | a8336d3 | 2019-09-09 13:36:55 +0200 | [diff] [blame] | 129 | DataRate encoder_target, |
| 130 | DataRate stable_encoder_target); |
Erik Språng | 4c6ca30 | 2019-04-08 15:14:01 +0200 | [diff] [blame] | 131 | bool operator==(const EncoderRateSettings& rhs) const; |
| 132 | bool operator!=(const EncoderRateSettings& rhs) const; |
| 133 | |
Evan Shrubsole | 7c079f6 | 2019-09-26 09:55:03 +0200 | [diff] [blame^] | 134 | VideoEncoder::RateControlParameters rate_control; |
Erik Språng | 4c6ca30 | 2019-04-08 15:14:01 +0200 | [diff] [blame] | 135 | // This is the scalar target bitrate before the VideoBitrateAllocator, i.e. |
| 136 | // the |target_bitrate| argument of the OnBitrateUpdated() method. This is |
| 137 | // needed because the bitrate allocator may truncate the total bitrate and a |
| 138 | // later call to the same allocator instance, e.g. |
| 139 | // |using last_encoder_rate_setings_->bitrate.get_sum_bps()|, may trick it |
| 140 | // into thinking the available bitrate has decreased since the last call. |
| 141 | DataRate encoder_target; |
Florent Castelli | a8336d3 | 2019-09-09 13:36:55 +0200 | [diff] [blame] | 142 | DataRate stable_encoder_target; |
Erik Språng | 4c6ca30 | 2019-04-08 15:14:01 +0200 | [diff] [blame] | 143 | }; |
| 144 | |
Niels Möller | a8b1508 | 2018-02-07 13:42:09 +0100 | [diff] [blame] | 145 | void ReconfigureEncoder() RTC_RUN_ON(&encoder_queue_); |
perkj | 26091b1 | 2016-09-01 01:17:40 -0700 | [diff] [blame] | 146 | |
Erik Språng | 7ca375c | 2019-02-06 16:20:17 +0100 | [diff] [blame] | 147 | void ConfigureQualityScaler(const VideoEncoder::EncoderInfo& encoder_info); |
kthelgason | 2bc6864 | 2017-02-07 07:02:22 -0800 | [diff] [blame] | 148 | |
perkj | a49cbd3 | 2016-09-16 07:53:41 -0700 | [diff] [blame] | 149 | // Implements VideoSinkInterface. |
| 150 | void OnFrame(const VideoFrame& video_frame) override; |
Ilya Nikolaevskiy | d79314f | 2017-10-23 10:45:37 +0200 | [diff] [blame] | 151 | void OnDiscardedFrame() override; |
perkj | a49cbd3 | 2016-09-16 07:53:41 -0700 | [diff] [blame] | 152 | |
Sebastian Jansson | a317705 | 2018-04-10 13:05:49 +0200 | [diff] [blame] | 153 | void MaybeEncodeVideoFrame(const VideoFrame& frame, |
| 154 | int64_t time_when_posted_in_ms); |
| 155 | |
perkj | d52063f | 2016-09-07 06:32:18 -0700 | [diff] [blame] | 156 | void EncodeVideoFrame(const VideoFrame& frame, |
| 157 | int64_t time_when_posted_in_ms); |
Sebastian Jansson | a317705 | 2018-04-10 13:05:49 +0200 | [diff] [blame] | 158 | // Indicates wether frame should be dropped because the pixel count is too |
| 159 | // large for the current bitrate configuration. |
| 160 | bool DropDueToSize(uint32_t pixel_count) const RTC_RUN_ON(&encoder_queue_); |
perkj | 26091b1 | 2016-09-01 01:17:40 -0700 | [diff] [blame] | 161 | |
| 162 | // Implements EncodedImageCallback. |
| 163 | EncodedImageCallback::Result OnEncodedImage( |
| 164 | const EncodedImage& encoded_image, |
| 165 | const CodecSpecificInfo* codec_specific_info, |
| 166 | const RTPFragmentationHeader* fragmentation) override; |
| 167 | |
Ilya Nikolaevskiy | d79314f | 2017-10-23 10:45:37 +0200 | [diff] [blame] | 168 | void OnDroppedFrame(EncodedImageCallback::DropReason reason) override; |
kthelgason | 876222f | 2016-11-29 01:44:11 -0800 | [diff] [blame] | 169 | |
perkj | 26091b1 | 2016-09-01 01:17:40 -0700 | [diff] [blame] | 170 | bool EncoderPaused() const; |
| 171 | void TraceFrameDropStart(); |
| 172 | void TraceFrameDropEnd(); |
| 173 | |
Erik Språng | 4c6ca30 | 2019-04-08 15:14:01 +0200 | [diff] [blame] | 174 | // Returns a copy of |rate_settings| with the |bitrate| field updated using |
| 175 | // the current VideoBitrateAllocator, and notifies any listeners of the new |
| 176 | // allocation. |
| 177 | EncoderRateSettings UpdateBitrateAllocationAndNotifyObserver( |
| 178 | const EncoderRateSettings& rate_settings) RTC_RUN_ON(&encoder_queue_); |
| 179 | |
Niels Möller | 6bb5ab9 | 2019-01-11 11:11:10 +0100 | [diff] [blame] | 180 | uint32_t GetInputFramerateFps() RTC_RUN_ON(&encoder_queue_); |
Erik Språng | 4c6ca30 | 2019-04-08 15:14:01 +0200 | [diff] [blame] | 181 | void SetEncoderRates(const EncoderRateSettings& rate_settings) |
| 182 | RTC_RUN_ON(&encoder_queue_); |
Niels Möller | 6bb5ab9 | 2019-01-11 11:11:10 +0100 | [diff] [blame] | 183 | |
asapersson | 09f0561 | 2017-05-15 23:40:18 -0700 | [diff] [blame] | 184 | // Class holding adaptation information. |
| 185 | class AdaptCounter final { |
| 186 | public: |
| 187 | AdaptCounter(); |
| 188 | ~AdaptCounter(); |
| 189 | |
| 190 | // Get number of adaptation downscales for |reason|. |
Niels Möller | 213618e | 2018-07-24 09:29:58 +0200 | [diff] [blame] | 191 | VideoStreamEncoderObserver::AdaptationSteps Counts(int reason) const; |
asapersson | 09f0561 | 2017-05-15 23:40:18 -0700 | [diff] [blame] | 192 | |
| 193 | std::string ToString() const; |
| 194 | |
asapersson | f7e294d | 2017-06-13 23:25:22 -0700 | [diff] [blame] | 195 | void IncrementFramerate(int reason); |
| 196 | void IncrementResolution(int reason); |
| 197 | void DecrementFramerate(int reason); |
| 198 | void DecrementResolution(int reason); |
| 199 | void DecrementFramerate(int reason, int cur_fps); |
asapersson | 09f0561 | 2017-05-15 23:40:18 -0700 | [diff] [blame] | 200 | |
| 201 | // Gets the total number of downgrades (for all adapt reasons). |
| 202 | int FramerateCount() const; |
| 203 | int ResolutionCount() const; |
asapersson | 09f0561 | 2017-05-15 23:40:18 -0700 | [diff] [blame] | 204 | |
| 205 | // Gets the total number of downgrades for |reason|. |
| 206 | int FramerateCount(int reason) const; |
| 207 | int ResolutionCount(int reason) const; |
| 208 | int TotalCount(int reason) const; |
| 209 | |
| 210 | private: |
| 211 | std::string ToString(const std::vector<int>& counters) const; |
| 212 | int Count(const std::vector<int>& counters) const; |
asapersson | f7e294d | 2017-06-13 23:25:22 -0700 | [diff] [blame] | 213 | void MoveCount(std::vector<int>* counters, int from_reason); |
asapersson | 09f0561 | 2017-05-15 23:40:18 -0700 | [diff] [blame] | 214 | |
| 215 | // Degradation counters holding number of framerate/resolution reductions |
| 216 | // per adapt reason. |
| 217 | std::vector<int> fps_counters_; |
| 218 | std::vector<int> resolution_counters_; |
| 219 | }; |
| 220 | |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 221 | AdaptCounter& GetAdaptCounter() RTC_RUN_ON(&encoder_queue_); |
| 222 | const AdaptCounter& GetConstAdaptCounter() RTC_RUN_ON(&encoder_queue_); |
| 223 | void UpdateAdaptationStats(AdaptReason reason) RTC_RUN_ON(&encoder_queue_); |
Niels Möller | 213618e | 2018-07-24 09:29:58 +0200 | [diff] [blame] | 224 | VideoStreamEncoderObserver::AdaptationSteps GetActiveCounts( |
| 225 | AdaptReason reason) RTC_RUN_ON(&encoder_queue_); |
Erik Språng | 7ca375c | 2019-02-06 16:20:17 +0100 | [diff] [blame] | 226 | void RunPostEncode(EncodedImage encoded_image, |
Niels Möller | 6bb5ab9 | 2019-01-11 11:11:10 +0100 | [diff] [blame] | 227 | int64_t time_sent_us, |
Erik Språng | 7ca375c | 2019-02-06 16:20:17 +0100 | [diff] [blame] | 228 | int temporal_index); |
Erik Språng | d7329ca | 2019-02-21 21:19:53 +0100 | [diff] [blame] | 229 | bool HasInternalSource() const RTC_RUN_ON(&encoder_queue_); |
Erik Språng | 6a7baa7 | 2019-02-26 18:31:00 +0100 | [diff] [blame] | 230 | void ReleaseEncoder() RTC_RUN_ON(&encoder_queue_); |
sprang | c5d62e2 | 2017-04-02 23:53:04 -0700 | [diff] [blame] | 231 | |
perkj | 26091b1 | 2016-09-01 01:17:40 -0700 | [diff] [blame] | 232 | rtc::Event shutdown_event_; |
stefan@webrtc.org | bfacda6 | 2013-03-27 16:36:01 +0000 | [diff] [blame] | 233 | |
pbos@webrtc.org | b238d12 | 2013-04-09 13:41:51 +0000 | [diff] [blame] | 234 | const uint32_t number_of_cores_; |
Kári Tristan Helgason | 639602a | 2018-08-02 10:51:40 +0200 | [diff] [blame] | 235 | // Counts how many frames we've dropped in the initial framedrop phase. |
| 236 | int initial_framedrop_; |
| 237 | const bool initial_framedrop_on_bwe_enabled_; |
| 238 | bool has_seen_first_significant_bwe_change_ = false; |
perkj | a49cbd3 | 2016-09-16 07:53:41 -0700 | [diff] [blame] | 239 | |
Åsa Persson | a945aee | 2018-04-24 16:53:25 +0200 | [diff] [blame] | 240 | const bool quality_scaling_experiment_enabled_; |
| 241 | |
perkj | a49cbd3 | 2016-09-16 07:53:41 -0700 | [diff] [blame] | 242 | const std::unique_ptr<VideoSourceProxy> source_proxy_; |
Per | 512ecb3 | 2016-09-23 15:52:06 +0200 | [diff] [blame] | 243 | EncoderSink* sink_; |
Niels Möller | 213618e | 2018-07-24 09:29:58 +0200 | [diff] [blame] | 244 | const VideoStreamEncoderSettings settings_; |
Erik Språng | 7ca375c | 2019-02-06 16:20:17 +0100 | [diff] [blame] | 245 | const RateControlSettings rate_control_settings_; |
Åsa Persson | 139f4dc | 2019-08-02 09:29:58 +0200 | [diff] [blame] | 246 | const QualityScalerSettings quality_scaler_settings_; |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 247 | |
Niels Möller | a8b1508 | 2018-02-07 13:42:09 +0100 | [diff] [blame] | 248 | const std::unique_ptr<OveruseFrameDetector> overuse_detector_ |
| 249 | RTC_PT_GUARDED_BY(&encoder_queue_); |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 250 | std::unique_ptr<QualityScaler> quality_scaler_ RTC_GUARDED_BY(&encoder_queue_) |
Niels Möller | a8b1508 | 2018-02-07 13:42:09 +0100 | [diff] [blame] | 251 | RTC_PT_GUARDED_BY(&encoder_queue_); |
pwestin@webrtc.org | 49888ce | 2012-04-27 05:25:53 +0000 | [diff] [blame] | 252 | |
Niels Möller | 213618e | 2018-07-24 09:29:58 +0200 | [diff] [blame] | 253 | VideoStreamEncoderObserver* const encoder_stats_observer_; |
perkj | a49cbd3 | 2016-09-16 07:53:41 -0700 | [diff] [blame] | 254 | // |thread_checker_| checks that public methods that are related to lifetime |
mflodman | cc3d442 | 2017-08-03 08:27:51 -0700 | [diff] [blame] | 255 | // of VideoStreamEncoder are called on the same thread. |
perkj | a49cbd3 | 2016-09-16 07:53:41 -0700 | [diff] [blame] | 256 | rtc::ThreadChecker thread_checker_; |
mflodman@webrtc.org | 84d1783 | 2011-12-01 17:02:23 +0000 | [diff] [blame] | 257 | |
Niels Möller | 1e06289 | 2018-02-07 10:18:32 +0100 | [diff] [blame] | 258 | VideoEncoderConfig encoder_config_ RTC_GUARDED_BY(&encoder_queue_); |
Niels Möller | 4db138e | 2018-04-19 09:04:13 +0200 | [diff] [blame] | 259 | std::unique_ptr<VideoEncoder> encoder_ RTC_GUARDED_BY(&encoder_queue_) |
| 260 | RTC_PT_GUARDED_BY(&encoder_queue_); |
Erik Språng | 6a7baa7 | 2019-02-26 18:31:00 +0100 | [diff] [blame] | 261 | bool encoder_initialized_; |
Erik Språng | 08127a9 | 2016-11-16 16:41:30 +0100 | [diff] [blame] | 262 | std::unique_ptr<VideoBitrateAllocator> rate_allocator_ |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 263 | RTC_GUARDED_BY(&encoder_queue_) RTC_PT_GUARDED_BY(&encoder_queue_); |
sprang | fda496a | 2017-06-15 04:21:07 -0700 | [diff] [blame] | 264 | // The maximum frame rate of the current codec configuration, as determined |
| 265 | // at the last ReconfigureEncoder() call. |
Niels Möller | 1e06289 | 2018-02-07 10:18:32 +0100 | [diff] [blame] | 266 | int max_framerate_ RTC_GUARDED_BY(&encoder_queue_); |
mflodman@webrtc.org | 84d1783 | 2011-12-01 17:02:23 +0000 | [diff] [blame] | 267 | |
perkj | fa10b55 | 2016-10-02 23:45:26 -0700 | [diff] [blame] | 268 | // Set when ConfigureEncoder has been called in order to lazy reconfigure the |
| 269 | // encoder on the next frame. |
Niels Möller | 1e06289 | 2018-02-07 10:18:32 +0100 | [diff] [blame] | 270 | bool pending_encoder_reconfiguration_ RTC_GUARDED_BY(&encoder_queue_); |
Mirta Dvornicic | 1ec2a16 | 2018-12-10 09:47:34 +0000 | [diff] [blame] | 271 | // Set when configuration must create a new encoder object, e.g., |
| 272 | // because of a codec change. |
| 273 | bool pending_encoder_creation_ RTC_GUARDED_BY(&encoder_queue_); |
Sergey Silkin | 5ee6967 | 2019-07-02 14:18:34 +0200 | [diff] [blame] | 274 | |
Danil Chapovalov | b9b146c | 2018-06-15 12:28:07 +0200 | [diff] [blame] | 275 | absl::optional<VideoFrameInfo> last_frame_info_ |
Niels Möller | 1e06289 | 2018-02-07 10:18:32 +0100 | [diff] [blame] | 276 | RTC_GUARDED_BY(&encoder_queue_); |
| 277 | int crop_width_ RTC_GUARDED_BY(&encoder_queue_); |
| 278 | int crop_height_ RTC_GUARDED_BY(&encoder_queue_); |
| 279 | uint32_t encoder_start_bitrate_bps_ RTC_GUARDED_BY(&encoder_queue_); |
Åsa Persson | 139f4dc | 2019-08-02 09:29:58 +0200 | [diff] [blame] | 280 | int set_start_bitrate_bps_ RTC_GUARDED_BY(&encoder_queue_); |
| 281 | int64_t set_start_bitrate_time_ms_ RTC_GUARDED_BY(&encoder_queue_); |
| 282 | bool has_seen_first_bwe_drop_ RTC_GUARDED_BY(&encoder_queue_); |
Niels Möller | 1e06289 | 2018-02-07 10:18:32 +0100 | [diff] [blame] | 283 | size_t max_data_payload_length_ RTC_GUARDED_BY(&encoder_queue_); |
Erik Språng | 4c6ca30 | 2019-04-08 15:14:01 +0200 | [diff] [blame] | 284 | absl::optional<EncoderRateSettings> last_encoder_rate_settings_ |
| 285 | RTC_GUARDED_BY(&encoder_queue_); |
Niels Möller | 1e06289 | 2018-02-07 10:18:32 +0100 | [diff] [blame] | 286 | bool encoder_paused_and_dropped_frame_ RTC_GUARDED_BY(&encoder_queue_); |
Sergey Silkin | 5ee6967 | 2019-07-02 14:18:34 +0200 | [diff] [blame] | 287 | |
| 288 | // Set to true if at least one frame was sent to encoder since last encoder |
| 289 | // initialization. |
| 290 | bool was_encode_called_since_last_initialization_ |
| 291 | RTC_GUARDED_BY(&encoder_queue_); |
| 292 | |
philipel | e8ed830 | 2019-07-03 11:53:48 +0200 | [diff] [blame] | 293 | bool encoder_failed_ RTC_GUARDED_BY(&encoder_queue_); |
perkj | 26091b1 | 2016-09-01 01:17:40 -0700 | [diff] [blame] | 294 | Clock* const clock_; |
asapersson | 09f0561 | 2017-05-15 23:40:18 -0700 | [diff] [blame] | 295 | // Counters used for deciding if the video resolution or framerate is |
| 296 | // currently restricted, and if so, why, on a per degradation preference |
| 297 | // basis. |
sprang | c5d62e2 | 2017-04-02 23:53:04 -0700 | [diff] [blame] | 298 | // TODO(sprang): Replace this with a state holding a relative overuse measure |
| 299 | // instead, that can be translated into suitable down-scale or fps limit. |
Taylor Brandstetter | 49fcc10 | 2018-05-16 14:20:41 -0700 | [diff] [blame] | 300 | std::map<const DegradationPreference, AdaptCounter> adapt_counters_ |
Niels Möller | 1e06289 | 2018-02-07 10:18:32 +0100 | [diff] [blame] | 301 | RTC_GUARDED_BY(&encoder_queue_); |
Taylor Brandstetter | 49fcc10 | 2018-05-16 14:20:41 -0700 | [diff] [blame] | 302 | // Set depending on degradation preferences. |
| 303 | DegradationPreference degradation_preference_ RTC_GUARDED_BY(&encoder_queue_); |
perkj | 803d97f | 2016-11-01 11:45:46 -0700 | [diff] [blame] | 304 | |
Åsa Persson | 1231419 | 2019-06-20 15:45:07 +0200 | [diff] [blame] | 305 | const BalancedDegradationSettings balanced_settings_; |
Åsa Persson | f3d828e | 2019-05-06 12:22:49 +0200 | [diff] [blame] | 306 | |
sprang | 84a3759 | 2017-02-10 07:04:27 -0800 | [diff] [blame] | 307 | struct AdaptationRequest { |
| 308 | // The pixel count produced by the source at the time of the adaptation. |
| 309 | int input_pixel_count_; |
sprang | c5d62e2 | 2017-04-02 23:53:04 -0700 | [diff] [blame] | 310 | // Framerate received from the source at the time of the adaptation. |
| 311 | int framerate_fps_; |
sprang | 84a3759 | 2017-02-10 07:04:27 -0800 | [diff] [blame] | 312 | // Indicates if request was to adapt up or down. |
| 313 | enum class Mode { kAdaptUp, kAdaptDown } mode_; |
| 314 | }; |
| 315 | // Stores a snapshot of the last adaptation request triggered by an AdaptUp |
| 316 | // or AdaptDown signal. |
Danil Chapovalov | b9b146c | 2018-06-15 12:28:07 +0200 | [diff] [blame] | 317 | absl::optional<AdaptationRequest> last_adaptation_request_ |
Niels Möller | 1e06289 | 2018-02-07 10:18:32 +0100 | [diff] [blame] | 318 | RTC_GUARDED_BY(&encoder_queue_); |
perkj | 803d97f | 2016-11-01 11:45:46 -0700 | [diff] [blame] | 319 | |
| 320 | rtc::RaceChecker incoming_frame_race_checker_ |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 321 | RTC_GUARDED_BY(incoming_frame_race_checker_); |
Yuwei Huang | d9f99c1 | 2017-10-24 15:40:52 -0700 | [diff] [blame] | 322 | std::atomic<int> posted_frames_waiting_for_encode_; |
perkj | 26091b1 | 2016-09-01 01:17:40 -0700 | [diff] [blame] | 323 | // Used to make sure incoming time stamp is increasing for every frame. |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 324 | int64_t last_captured_timestamp_ RTC_GUARDED_BY(incoming_frame_race_checker_); |
perkj | 26091b1 | 2016-09-01 01:17:40 -0700 | [diff] [blame] | 325 | // Delta used for translating between NTP and internal timestamps. |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 326 | const int64_t delta_ntp_internal_ms_ |
| 327 | RTC_GUARDED_BY(incoming_frame_race_checker_); |
perkj | 26091b1 | 2016-09-01 01:17:40 -0700 | [diff] [blame] | 328 | |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 329 | int64_t last_frame_log_ms_ RTC_GUARDED_BY(incoming_frame_race_checker_); |
Niels Möller | 1e06289 | 2018-02-07 10:18:32 +0100 | [diff] [blame] | 330 | int captured_frame_count_ RTC_GUARDED_BY(&encoder_queue_); |
| 331 | int dropped_frame_count_ RTC_GUARDED_BY(&encoder_queue_); |
Danil Chapovalov | b9b146c | 2018-06-15 12:28:07 +0200 | [diff] [blame] | 332 | absl::optional<VideoFrame> pending_frame_ RTC_GUARDED_BY(&encoder_queue_); |
Sebastian Jansson | a317705 | 2018-04-10 13:05:49 +0200 | [diff] [blame] | 333 | int64_t pending_frame_post_time_us_ RTC_GUARDED_BY(&encoder_queue_); |
asapersson | 6ffb67d | 2016-09-12 00:10:45 -0700 | [diff] [blame] | 334 | |
Ilya Nikolaevskiy | 71aee3a | 2019-02-18 13:01:26 +0100 | [diff] [blame] | 335 | VideoFrame::UpdateRect accumulated_update_rect_ |
| 336 | RTC_GUARDED_BY(&encoder_queue_); |
| 337 | |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 338 | VideoBitrateAllocationObserver* bitrate_observer_ |
Niels Möller | 1e06289 | 2018-02-07 10:18:32 +0100 | [diff] [blame] | 339 | RTC_GUARDED_BY(&encoder_queue_); |
Elad Alon | 8f01c4e | 2019-06-28 15:19:43 +0200 | [diff] [blame] | 340 | FecControllerOverride* fec_controller_override_ |
| 341 | RTC_GUARDED_BY(&encoder_queue_); |
Danil Chapovalov | b9b146c | 2018-06-15 12:28:07 +0200 | [diff] [blame] | 342 | absl::optional<int64_t> last_parameters_update_ms_ |
Niels Möller | 1e06289 | 2018-02-07 10:18:32 +0100 | [diff] [blame] | 343 | RTC_GUARDED_BY(&encoder_queue_); |
Åsa Persson | c29cb2c | 2019-03-25 12:06:59 +0100 | [diff] [blame] | 344 | absl::optional<int64_t> last_encode_info_ms_ RTC_GUARDED_BY(&encoder_queue_); |
sprang | 1a646ee | 2016-12-01 06:34:11 -0800 | [diff] [blame] | 345 | |
Erik Språng | e2fd86a | 2018-10-24 11:32:39 +0200 | [diff] [blame] | 346 | VideoEncoder::EncoderInfo encoder_info_ RTC_GUARDED_BY(&encoder_queue_); |
Sergey Silkin | 6456e35 | 2019-07-08 17:56:40 +0200 | [diff] [blame] | 347 | absl::optional<VideoEncoder::ResolutionBitrateLimits> encoder_bitrate_limits_ |
| 348 | RTC_GUARDED_BY(&encoder_queue_); |
Erik Språng | d7329ca | 2019-02-21 21:19:53 +0100 | [diff] [blame] | 349 | VideoEncoderFactory::CodecInfo codec_info_ RTC_GUARDED_BY(&encoder_queue_); |
Erik Språng | 6a7baa7 | 2019-02-26 18:31:00 +0100 | [diff] [blame] | 350 | VideoCodec send_codec_ RTC_GUARDED_BY(&encoder_queue_); |
Niels Möller | 6bb5ab9 | 2019-01-11 11:11:10 +0100 | [diff] [blame] | 351 | |
Erik Språng | 6a7baa7 | 2019-02-26 18:31:00 +0100 | [diff] [blame] | 352 | FrameDropper frame_dropper_ RTC_GUARDED_BY(&encoder_queue_); |
Niels Möller | 6bb5ab9 | 2019-01-11 11:11:10 +0100 | [diff] [blame] | 353 | // If frame dropper is not force disabled, frame dropping might still be |
| 354 | // disabled if VideoEncoder::GetEncoderInfo() indicates that the encoder has a |
| 355 | // trusted rate controller. This is determined on a per-frame basis, as the |
| 356 | // encoder behavior might dynamically change. |
| 357 | bool force_disable_frame_dropper_ RTC_GUARDED_BY(&encoder_queue_); |
| 358 | RateStatistics input_framerate_ RTC_GUARDED_BY(&encoder_queue_); |
| 359 | // Incremented on worker thread whenever |frame_dropper_| determines that a |
| 360 | // frame should be dropped. Decremented on whichever thread runs |
| 361 | // OnEncodedImage(), which is only called by one thread but not necessarily |
| 362 | // the worker thread. |
| 363 | std::atomic<int> pending_frame_drops_; |
Erik Språng | e2fd86a | 2018-10-24 11:32:39 +0200 | [diff] [blame] | 364 | |
Erik Språng | 7ca375c | 2019-02-06 16:20:17 +0100 | [diff] [blame] | 365 | std::unique_ptr<EncoderBitrateAdjuster> bitrate_adjuster_ |
| 366 | RTC_GUARDED_BY(&encoder_queue_); |
| 367 | |
Erik Språng | d7329ca | 2019-02-21 21:19:53 +0100 | [diff] [blame] | 368 | // TODO(sprang): Change actually support keyframe per simulcast stream, or |
| 369 | // turn this into a simple bool |pending_keyframe_request_|. |
Niels Möller | 87e2d78 | 2019-03-07 10:18:23 +0100 | [diff] [blame] | 370 | std::vector<VideoFrameType> next_frame_types_ RTC_GUARDED_BY(&encoder_queue_); |
Erik Språng | d7329ca | 2019-02-21 21:19:53 +0100 | [diff] [blame] | 371 | |
Ilya Nikolaevskiy | 2ebf523 | 2019-05-13 16:13:36 +0200 | [diff] [blame] | 372 | FrameEncodeMetadataWriter frame_encode_metadata_writer_; |
Erik Språng | 6a7baa7 | 2019-02-26 18:31:00 +0100 | [diff] [blame] | 373 | |
| 374 | // Experiment groups parsed from field trials for realtime video ([0]) and |
| 375 | // screenshare ([1]). 0 means no group specified. Positive values are |
| 376 | // experiment group numbers incremented by 1. |
| 377 | const std::array<uint8_t, 2> experiment_groups_; |
| 378 | |
philipel | da5aa4d | 2019-04-26 13:37:37 +0200 | [diff] [blame] | 379 | // TODO(philipel): Remove this lock and run on |encoder_queue_| instead. |
| 380 | rtc::CriticalSection encoded_image_lock_; |
| 381 | |
| 382 | int64_t next_frame_id_ RTC_GUARDED_BY(encoded_image_lock_); |
| 383 | |
| 384 | // This array is used as a map from simulcast id to an encoder's buffer |
| 385 | // state. For every buffer of the encoder we keep track of the last frame id |
| 386 | // that updated that buffer. |
| 387 | std::array<std::array<int64_t, kMaxEncoderBuffers>, kMaxSimulcastStreams> |
| 388 | encoder_buffer_state_ RTC_GUARDED_BY(encoded_image_lock_); |
| 389 | |
perkj | 26091b1 | 2016-09-01 01:17:40 -0700 | [diff] [blame] | 390 | // All public methods are proxied to |encoder_queue_|. It must must be |
| 391 | // destroyed first to make sure no tasks are run that use other members. |
| 392 | rtc::TaskQueue encoder_queue_; |
perkj | a49cbd3 | 2016-09-16 07:53:41 -0700 | [diff] [blame] | 393 | |
philipel | d9cc8c0 | 2019-09-16 14:53:40 +0200 | [diff] [blame] | 394 | struct EncoderSwitchExperiment { |
| 395 | struct Thresholds { |
| 396 | absl::optional<DataRate> bitrate; |
| 397 | absl::optional<int> pixel_count; |
| 398 | }; |
| 399 | |
| 400 | // Codec --> switching thresholds |
| 401 | std::map<VideoCodecType, Thresholds> codec_thresholds; |
| 402 | |
| 403 | // To smooth out the target bitrate so that we don't trigger a switch |
| 404 | // too easily. |
| 405 | rtc::ExpFilter bitrate_filter{1.0}; |
| 406 | |
| 407 | // Codec/implementation to switch to |
| 408 | std::string to_codec; |
| 409 | absl::optional<std::string> to_param; |
| 410 | absl::optional<std::string> to_value; |
| 411 | |
| 412 | // Thresholds for the currently used codecs. |
| 413 | Thresholds current_thresholds; |
| 414 | |
| 415 | // Updates the |bitrate_filter|, so not const. |
| 416 | bool IsBitrateBelowThreshold(const DataRate& target_bitrate); |
| 417 | bool IsPixelCountBelowThreshold(int pixel_count) const; |
| 418 | void SetCodec(VideoCodecType codec); |
| 419 | }; |
| 420 | |
| 421 | EncoderSwitchExperiment ParseEncoderSwitchFieldTrial() const; |
| 422 | |
| 423 | EncoderSwitchExperiment encoder_switch_experiment_ |
| 424 | RTC_GUARDED_BY(&encoder_queue_); |
| 425 | |
| 426 | // An encoder switch is only requested once, this variable is used to keep |
| 427 | // track of whether a request has been made or not. |
| 428 | bool encoder_switch_requested_ RTC_GUARDED_BY(&encoder_queue_); |
| 429 | |
mflodman | cc3d442 | 2017-08-03 08:27:51 -0700 | [diff] [blame] | 430 | RTC_DISALLOW_COPY_AND_ASSIGN(VideoStreamEncoder); |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 431 | }; |
mflodman@webrtc.org | 84d1783 | 2011-12-01 17:02:23 +0000 | [diff] [blame] | 432 | |
| 433 | } // namespace webrtc |
| 434 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 435 | #endif // VIDEO_VIDEO_STREAM_ENCODER_H_ |