niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 1 | /* |
pwestin@webrtc.org | 52fd98d | 2012-02-13 09:03:53 +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 MODULES_VIDEO_CODING_GENERIC_ENCODER_H_ |
| 12 | #define MODULES_VIDEO_CODING_GENERIC_ENCODER_H_ |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 13 | |
philipel | 9d3ab61 | 2015-12-21 04:12:39 -0800 | [diff] [blame] | 14 | #include <stdio.h> |
Ilya Nikolaevskiy | d79314f | 2017-10-23 10:45:37 +0200 | [diff] [blame] | 15 | #include <list> |
philipel | 9d3ab61 | 2015-12-21 04:12:39 -0800 | [diff] [blame] | 16 | #include <vector> |
| 17 | |
Erik Språng | d96b275 | 2018-12-13 11:23:27 +0100 | [diff] [blame] | 18 | #include "api/units/data_rate.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 19 | #include "modules/video_coding/include/video_codec_interface.h" |
| 20 | #include "modules/video_coding/include/video_coding_defines.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 21 | #include "rtc_base/criticalsection.h" |
| 22 | #include "rtc_base/race_checker.h" |
sprang@webrtc.org | 4070935 | 2013-11-26 11:41:59 +0000 | [diff] [blame] | 23 | |
andresp@webrtc.org | 1df9dc3 | 2014-01-09 08:01:57 +0000 | [diff] [blame] | 24 | namespace webrtc { |
sprang@webrtc.org | 4070935 | 2013-11-26 11:41:59 +0000 | [diff] [blame] | 25 | |
Niels Möller | 6613f8e | 2019-01-10 10:30:21 +0100 | [diff] [blame] | 26 | namespace media_optimization { |
| 27 | class MediaOptimization; |
| 28 | } // namespace media_optimization |
| 29 | |
| 30 | struct EncoderParameters { |
| 31 | EncoderParameters() : total_bitrate(DataRate::Zero()), input_frame_rate(0) {} |
| 32 | EncoderParameters(DataRate total_bitrate, |
| 33 | const VideoBitrateAllocation& allocation, |
| 34 | uint32_t framerate) |
| 35 | : total_bitrate(total_bitrate), |
| 36 | target_bitrate(allocation), |
| 37 | input_frame_rate(framerate) {} |
| 38 | |
| 39 | // Total bitrate allocated for this encoder. |
| 40 | DataRate total_bitrate; |
| 41 | // The bitrate allocation, across spatial and/or temporal layers. Note that |
| 42 | // the sum of these might be less than |total_bitrate| if the allocator has |
| 43 | // capped the bitrate for some configuration. |
| 44 | VideoBitrateAllocation target_bitrate; |
| 45 | // The input frame rate to the encoder in fps, measured in the video sender. |
| 46 | uint32_t input_frame_rate; |
| 47 | }; |
| 48 | |
philipel | 9d3ab61 | 2015-12-21 04:12:39 -0800 | [diff] [blame] | 49 | class VCMEncodedFrameCallback : public EncodedImageCallback { |
| 50 | public: |
Niels Möller | 6613f8e | 2019-01-10 10:30:21 +0100 | [diff] [blame] | 51 | VCMEncodedFrameCallback(EncodedImageCallback* post_encode_callback, |
| 52 | media_optimization::MediaOptimization* media_opt); |
Stefan Holmer | dbdb3a0 | 2018-07-17 16:03:46 +0200 | [diff] [blame] | 53 | ~VCMEncodedFrameCallback() override; |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 54 | |
sprang | 3911c26 | 2016-04-15 01:24:14 -0700 | [diff] [blame] | 55 | // Implements EncodedImageCallback. |
Sergey Ulanov | 525df3f | 2016-08-02 17:46:41 -0700 | [diff] [blame] | 56 | EncodedImageCallback::Result OnEncodedImage( |
| 57 | const EncodedImage& encoded_image, |
| 58 | const CodecSpecificInfo* codec_specific_info, |
| 59 | const RTPFragmentationHeader* fragmentation) override; |
ilnik | 04f4d12 | 2017-06-19 07:18:55 -0700 | [diff] [blame] | 60 | |
sprang | 3911c26 | 2016-04-15 01:24:14 -0700 | [diff] [blame] | 61 | void SetInternalSource(bool internal_source) { |
| 62 | internal_source_ = internal_source; |
| 63 | } |
guoweis@webrtc.org | 54d072e | 2015-03-17 21:54:50 +0000 | [diff] [blame] | 64 | |
ilnik | 04f4d12 | 2017-06-19 07:18:55 -0700 | [diff] [blame] | 65 | // Timing frames configuration methods. These 4 should be called before |
| 66 | // |OnEncodedImage| at least once. |
| 67 | void OnTargetBitrateChanged(size_t bitrate_bytes_per_sec, |
| 68 | size_t simulcast_svc_idx); |
| 69 | |
| 70 | void OnFrameRateChanged(size_t framerate); |
| 71 | |
Ilya Nikolaevskiy | 76f2a85 | 2017-11-16 14:33:53 +0100 | [diff] [blame] | 72 | void OnEncodeStarted(uint32_t rtp_timestamps, |
| 73 | int64_t capture_time_ms, |
| 74 | size_t simulcast_svc_idx); |
ilnik | 04f4d12 | 2017-06-19 07:18:55 -0700 | [diff] [blame] | 75 | |
| 76 | void SetTimingFramesThresholds( |
| 77 | const VideoCodec::TimingFrameTriggerThresholds& thresholds) { |
| 78 | rtc::CritScope crit(&timing_params_lock_); |
| 79 | timing_frames_thresholds_ = thresholds; |
| 80 | } |
| 81 | |
Ilya Nikolaevskiy | d79314f | 2017-10-23 10:45:37 +0200 | [diff] [blame] | 82 | // Clears all data stored by OnEncodeStarted(). |
| 83 | void Reset() { |
| 84 | rtc::CritScope crit(&timing_params_lock_); |
| 85 | timing_frames_info_.clear(); |
| 86 | last_timing_frame_time_ms_ = -1; |
Ilya Nikolaevskiy | b9fb78f | 2017-11-14 14:13:47 +0100 | [diff] [blame] | 87 | reordered_frames_logged_messages_ = 0; |
| 88 | stalled_encoder_logged_messages_ = 0; |
Ilya Nikolaevskiy | d79314f | 2017-10-23 10:45:37 +0200 | [diff] [blame] | 89 | } |
| 90 | |
philipel | 9d3ab61 | 2015-12-21 04:12:39 -0800 | [diff] [blame] | 91 | private: |
Ilya Nikolaevskiy | 764aeb7 | 2018-04-03 10:01:52 +0200 | [diff] [blame] | 92 | // For non-internal-source encoders, returns encode started time and fixes |
| 93 | // capture timestamp for the frame, if corrupted by the encoder. |
Danil Chapovalov | 0040b66 | 2018-06-18 10:48:16 +0200 | [diff] [blame] | 94 | absl::optional<int64_t> ExtractEncodeStartTime(size_t simulcast_svc_idx, |
| 95 | EncodedImage* encoded_image) |
Ilya Nikolaevskiy | 764aeb7 | 2018-04-03 10:01:52 +0200 | [diff] [blame] | 96 | RTC_EXCLUSIVE_LOCKS_REQUIRED(timing_params_lock_); |
| 97 | |
| 98 | void FillTimingInfo(size_t simulcast_svc_idx, EncodedImage* encoded_image); |
| 99 | |
ilnik | 04f4d12 | 2017-06-19 07:18:55 -0700 | [diff] [blame] | 100 | rtc::CriticalSection timing_params_lock_; |
sprang | 3911c26 | 2016-04-15 01:24:14 -0700 | [diff] [blame] | 101 | bool internal_source_; |
perkj | 376b192 | 2016-05-02 11:35:24 -0700 | [diff] [blame] | 102 | EncodedImageCallback* const post_encode_callback_; |
Niels Möller | 6613f8e | 2019-01-10 10:30:21 +0100 | [diff] [blame] | 103 | media_optimization::MediaOptimization* const media_opt_; |
ilnik | 04f4d12 | 2017-06-19 07:18:55 -0700 | [diff] [blame] | 104 | |
Ilya Nikolaevskiy | d79314f | 2017-10-23 10:45:37 +0200 | [diff] [blame] | 105 | struct EncodeStartTimeRecord { |
Ilya Nikolaevskiy | 76f2a85 | 2017-11-16 14:33:53 +0100 | [diff] [blame] | 106 | EncodeStartTimeRecord(uint32_t timestamp, |
| 107 | int64_t capture_time, |
| 108 | int64_t encode_start_time) |
| 109 | : rtp_timestamp(timestamp), |
| 110 | capture_time_ms(capture_time), |
Ilya Nikolaevskiy | d79314f | 2017-10-23 10:45:37 +0200 | [diff] [blame] | 111 | encode_start_time_ms(encode_start_time) {} |
Ilya Nikolaevskiy | 76f2a85 | 2017-11-16 14:33:53 +0100 | [diff] [blame] | 112 | uint32_t rtp_timestamp; |
Ilya Nikolaevskiy | d79314f | 2017-10-23 10:45:37 +0200 | [diff] [blame] | 113 | int64_t capture_time_ms; |
| 114 | int64_t encode_start_time_ms; |
| 115 | }; |
ilnik | 04f4d12 | 2017-06-19 07:18:55 -0700 | [diff] [blame] | 116 | struct TimingFramesLayerInfo { |
Stefan Holmer | dbdb3a0 | 2018-07-17 16:03:46 +0200 | [diff] [blame] | 117 | TimingFramesLayerInfo(); |
| 118 | ~TimingFramesLayerInfo(); |
ilnik | 04f4d12 | 2017-06-19 07:18:55 -0700 | [diff] [blame] | 119 | size_t target_bitrate_bytes_per_sec = 0; |
Ilya Nikolaevskiy | d79314f | 2017-10-23 10:45:37 +0200 | [diff] [blame] | 120 | std::list<EncodeStartTimeRecord> encode_start_list; |
ilnik | 04f4d12 | 2017-06-19 07:18:55 -0700 | [diff] [blame] | 121 | }; |
| 122 | // Separate instance for each simulcast stream or spatial layer. |
| 123 | std::vector<TimingFramesLayerInfo> timing_frames_info_ |
danilchap | 56359be | 2017-09-07 07:53:45 -0700 | [diff] [blame] | 124 | RTC_GUARDED_BY(timing_params_lock_); |
| 125 | size_t framerate_ RTC_GUARDED_BY(timing_params_lock_); |
| 126 | int64_t last_timing_frame_time_ms_ RTC_GUARDED_BY(timing_params_lock_); |
ilnik | 04f4d12 | 2017-06-19 07:18:55 -0700 | [diff] [blame] | 127 | VideoCodec::TimingFrameTriggerThresholds timing_frames_thresholds_ |
danilchap | 56359be | 2017-09-07 07:53:45 -0700 | [diff] [blame] | 128 | RTC_GUARDED_BY(timing_params_lock_); |
Ilya Nikolaevskiy | 76f2a85 | 2017-11-16 14:33:53 +0100 | [diff] [blame] | 129 | size_t incorrect_capture_time_logged_messages_ |
| 130 | RTC_GUARDED_BY(timing_params_lock_); |
Ilya Nikolaevskiy | b9fb78f | 2017-11-14 14:13:47 +0100 | [diff] [blame] | 131 | size_t reordered_frames_logged_messages_ RTC_GUARDED_BY(timing_params_lock_); |
| 132 | size_t stalled_encoder_logged_messages_ RTC_GUARDED_BY(timing_params_lock_); |
ilnik | 6d5b4d6 | 2017-08-30 03:32:14 -0700 | [diff] [blame] | 133 | |
| 134 | // Experiment groups parsed from field trials for realtime video ([0]) and |
| 135 | // screenshare ([1]). 0 means no group specified. Positive values are |
| 136 | // experiment group numbers incremented by 1. |
| 137 | uint8_t experiment_groups_[2]; |
sprang | 3911c26 | 2016-04-15 01:24:14 -0700 | [diff] [blame] | 138 | }; |
sprang@webrtc.org | 4070935 | 2013-11-26 11:41:59 +0000 | [diff] [blame] | 139 | |
philipel | 9d3ab61 | 2015-12-21 04:12:39 -0800 | [diff] [blame] | 140 | class VCMGenericEncoder { |
| 141 | friend class VCMCodecDataBase; |
Peter Boström | 69ccb33 | 2015-10-29 16:30:23 +0100 | [diff] [blame] | 142 | |
philipel | 9d3ab61 | 2015-12-21 04:12:39 -0800 | [diff] [blame] | 143 | public: |
| 144 | VCMGenericEncoder(VideoEncoder* encoder, |
philipel | 9d3ab61 | 2015-12-21 04:12:39 -0800 | [diff] [blame] | 145 | VCMEncodedFrameCallback* encoded_frame_callback, |
sprang | 3911c26 | 2016-04-15 01:24:14 -0700 | [diff] [blame] | 146 | bool internal_source); |
philipel | 9d3ab61 | 2015-12-21 04:12:39 -0800 | [diff] [blame] | 147 | ~VCMGenericEncoder(); |
philipel | 9d3ab61 | 2015-12-21 04:12:39 -0800 | [diff] [blame] | 148 | int32_t Release(); |
philipel | 9d3ab61 | 2015-12-21 04:12:39 -0800 | [diff] [blame] | 149 | int32_t InitEncode(const VideoCodec* settings, |
sprang | 3911c26 | 2016-04-15 01:24:14 -0700 | [diff] [blame] | 150 | int32_t number_of_cores, |
| 151 | size_t max_payload_size); |
| 152 | int32_t Encode(const VideoFrame& frame, |
| 153 | const CodecSpecificInfo* codec_specific, |
| 154 | const std::vector<FrameType>& frame_types); |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 155 | |
Niels Möller | 6613f8e | 2019-01-10 10:30:21 +0100 | [diff] [blame] | 156 | void SetEncoderParameters(const EncoderParameters& params); |
| 157 | EncoderParameters GetEncoderParameters() const; |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 158 | |
philipel | 9d3ab61 | 2015-12-21 04:12:39 -0800 | [diff] [blame] | 159 | int32_t RequestFrame(const std::vector<FrameType>& frame_types); |
philipel | 9d3ab61 | 2015-12-21 04:12:39 -0800 | [diff] [blame] | 160 | bool InternalSource() const; |
Erik Språng | d3438aa | 2018-11-08 16:56:43 +0100 | [diff] [blame] | 161 | VideoEncoder::EncoderInfo GetEncoderInfo() const; |
philipel | 9d3ab61 | 2015-12-21 04:12:39 -0800 | [diff] [blame] | 162 | |
| 163 | private: |
Peter Boström | 02bafc6 | 2016-07-01 12:45:15 +0200 | [diff] [blame] | 164 | rtc::RaceChecker race_checker_; |
| 165 | |
danilchap | 56359be | 2017-09-07 07:53:45 -0700 | [diff] [blame] | 166 | VideoEncoder* const encoder_ RTC_GUARDED_BY(race_checker_); |
philipel | 9d3ab61 | 2015-12-21 04:12:39 -0800 | [diff] [blame] | 167 | VCMEncodedFrameCallback* const vcm_encoded_frame_callback_; |
| 168 | const bool internal_source_; |
pbos | 5ad935c | 2016-01-25 03:52:44 -0800 | [diff] [blame] | 169 | rtc::CriticalSection params_lock_; |
Niels Möller | 6613f8e | 2019-01-10 10:30:21 +0100 | [diff] [blame] | 170 | EncoderParameters encoder_params_ RTC_GUARDED_BY(params_lock_); |
Ilya Nikolaevskiy | e0da9ea | 2017-11-08 14:39:02 +0100 | [diff] [blame] | 171 | size_t streams_or_svc_num_ RTC_GUARDED_BY(race_checker_); |
| 172 | VideoCodecType codec_type_ RTC_GUARDED_BY(race_checker_); |
sprang | 3911c26 | 2016-04-15 01:24:14 -0700 | [diff] [blame] | 173 | }; |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 174 | |
pbos@webrtc.org | d900e8b | 2013-07-03 15:12:26 +0000 | [diff] [blame] | 175 | } // namespace webrtc |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 176 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 177 | #endif // MODULES_VIDEO_CODING_GENERIC_ENCODER_H_ |