blob: 58aac2f88b0dd6e4054f7e40ffc14694618fa59b [file] [log] [blame]
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001/*
2 * Copyright (c) 2014 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
Mirko Bonadei95adedb2018-11-19 09:52:37 +010012#ifdef RTC_ENABLE_VP9
13
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020014#include "modules/video_coding/codecs/vp9/vp9_impl.h"
marpan@webrtc.org5b883172014-11-01 06:10:48 +000015
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +020016#include <algorithm>
Sergey Silkind45b3452018-05-31 16:00:24 +020017#include <limits>
marpan@webrtc.org5b883172014-11-01 06:10:48 +000018#include <vector>
19
marpan@webrtc.org5b883172014-11-01 06:10:48 +000020#include "vpx/vp8cx.h"
21#include "vpx/vp8dx.h"
Yves Gerey665174f2018-06-19 15:03:05 +020022#include "vpx/vpx_decoder.h"
23#include "vpx/vpx_encoder.h"
marpan@webrtc.org5b883172014-11-01 06:10:48 +000024
Karl Wiberg918f50c2018-07-05 11:40:33 +020025#include "absl/memory/memory.h"
Emircan Uysaler800787f2018-07-16 10:01:49 -070026#include "api/video/color_space.h"
Emircan Uysaler0823eec2018-07-13 17:10:00 -070027#include "api/video/i010_buffer.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020028#include "common_video/include/video_frame_buffer.h"
29#include "common_video/libyuv/include/webrtc_libyuv.h"
Sergey Silkind902d582018-05-18 17:31:19 +020030#include "modules/rtp_rtcp/include/rtp_rtcp_defines.h"
Sergey Silkin86684962018-03-28 19:32:37 +020031#include "modules/video_coding/codecs/vp9/svc_rate_allocator.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020032#include "rtc_base/checks.h"
Erik Språng4b4266f2019-01-23 12:48:13 +010033#include "rtc_base/experiments/rate_control_settings.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020034#include "rtc_base/keep_ref_until_done.h"
35#include "rtc_base/logging.h"
Steve Anton10542f22019-01-11 09:11:00 -080036#include "rtc_base/time_utils.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020037#include "rtc_base/trace_event.h"
Sergey Silkin390f3582018-10-01 17:13:50 +020038#include "system_wrappers/include/field_trial.h"
marpan@webrtc.org5b883172014-11-01 06:10:48 +000039
40namespace webrtc {
41
Sergey Silkind902d582018-05-18 17:31:19 +020042namespace {
Sergey Silkin390f3582018-10-01 17:13:50 +020043// Maps from gof_idx to encoder internal reference frame buffer index. These
44// maps work for 1,2 and 3 temporal layers with GOF length of 1,2 and 4 frames.
45uint8_t kRefBufIdx[4] = {0, 0, 0, 1};
46uint8_t kUpdBufIdx[4] = {0, 0, 1, 0};
47
Sergey Silkinb674cd12018-10-09 10:59:06 +020048int kMaxNumTiles4kVideo = 8;
49
Ilya Nikolaevskiy61170682019-03-06 16:04:32 +010050// Maximum allowed PID difference for differnet per-layer frame-rate case.
Ilya Nikolaevskiy3a656d12019-02-14 14:44:22 +010051const int kMaxAllowedPidDIff = 30;
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +010052
Erik Språng7a3fe892019-04-15 12:22:55 +020053constexpr double kLowRateFactor = 1.0;
54constexpr double kHighRateFactor = 2.0;
55
56// These settings correspond to the settings in vpx_codec_enc_cfg.
Erik Språngeb180f82019-05-23 13:55:24 +020057struct Vp9RateSettings {
Erik Språng7a3fe892019-04-15 12:22:55 +020058 uint32_t rc_undershoot_pct;
59 uint32_t rc_overshoot_pct;
60 uint32_t rc_buf_sz;
61 uint32_t rc_buf_optimal_sz;
62 uint32_t rc_dropframe_thresh;
63};
64
Marco6e89b252015-07-07 14:40:38 -070065// Only positive speeds, range for real-time coding currently is: 5 - 8.
66// Lower means slower/better quality, higher means fastest/lower quality.
67int GetCpuSpeed(int width, int height) {
Alex Glaznevfecb7c32016-03-31 14:23:27 -070068#if defined(WEBRTC_ARCH_ARM) || defined(WEBRTC_ARCH_ARM64) || defined(ANDROID)
Marco002f0d02015-12-17 09:49:31 -080069 return 8;
70#else
Marco6e89b252015-07-07 14:40:38 -070071 // For smaller resolutions, use lower speed setting (get some coding gain at
72 // the cost of increased encoding complexity).
73 if (width * height <= 352 * 288)
74 return 5;
75 else
76 return 7;
Marco002f0d02015-12-17 09:49:31 -080077#endif
Marco6e89b252015-07-07 14:40:38 -070078}
Emircan Uysaler715cc232018-07-23 17:50:43 -070079// Helper class for extracting VP9 colorspace.
80ColorSpace ExtractVP9ColorSpace(vpx_color_space_t space_t,
81 vpx_color_range_t range_t,
82 unsigned int bit_depth) {
Johannes Kronb47ccc32018-12-07 11:12:44 +010083 ColorSpace::PrimaryID primaries = ColorSpace::PrimaryID::kUnspecified;
84 ColorSpace::TransferID transfer = ColorSpace::TransferID::kUnspecified;
85 ColorSpace::MatrixID matrix = ColorSpace::MatrixID::kUnspecified;
Emircan Uysaler715cc232018-07-23 17:50:43 -070086 switch (space_t) {
87 case VPX_CS_BT_601:
88 case VPX_CS_SMPTE_170:
89 primaries = ColorSpace::PrimaryID::kSMPTE170M;
90 transfer = ColorSpace::TransferID::kSMPTE170M;
91 matrix = ColorSpace::MatrixID::kSMPTE170M;
92 break;
93 case VPX_CS_SMPTE_240:
94 primaries = ColorSpace::PrimaryID::kSMPTE240M;
95 transfer = ColorSpace::TransferID::kSMPTE240M;
96 matrix = ColorSpace::MatrixID::kSMPTE240M;
97 break;
98 case VPX_CS_BT_709:
99 primaries = ColorSpace::PrimaryID::kBT709;
100 transfer = ColorSpace::TransferID::kBT709;
101 matrix = ColorSpace::MatrixID::kBT709;
102 break;
103 case VPX_CS_BT_2020:
104 primaries = ColorSpace::PrimaryID::kBT2020;
105 switch (bit_depth) {
106 case 8:
107 transfer = ColorSpace::TransferID::kBT709;
108 break;
109 case 10:
110 transfer = ColorSpace::TransferID::kBT2020_10;
111 break;
112 default:
113 RTC_NOTREACHED();
114 break;
115 }
116 matrix = ColorSpace::MatrixID::kBT2020_NCL;
117 break;
118 case VPX_CS_SRGB:
119 primaries = ColorSpace::PrimaryID::kBT709;
120 transfer = ColorSpace::TransferID::kIEC61966_2_1;
121 matrix = ColorSpace::MatrixID::kBT709;
122 break;
123 default:
124 break;
125 }
126
127 ColorSpace::RangeID range = ColorSpace::RangeID::kInvalid;
128 switch (range_t) {
129 case VPX_CR_STUDIO_RANGE:
130 range = ColorSpace::RangeID::kLimited;
131 break;
132 case VPX_CR_FULL_RANGE:
133 range = ColorSpace::RangeID::kFull;
134 break;
135 default:
136 break;
137 }
138 return ColorSpace(primaries, transfer, matrix, range);
139}
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100140
141bool MoreLayersEnabled(const VideoBitrateAllocation& first,
142 const VideoBitrateAllocation& second) {
143 for (size_t sl_idx = 0; sl_idx < kMaxSpatialLayers; ++sl_idx) {
144 if (first.GetSpatialLayerSum(sl_idx) > 0 &&
145 second.GetSpatialLayerSum(sl_idx) == 0) {
146 return true;
147 }
148 }
149 return false;
150}
151
Erik Språng7a3fe892019-04-15 12:22:55 +0200152uint32_t Interpolate(uint32_t low,
153 uint32_t high,
154 double bandwidth_headroom_factor) {
155 RTC_DCHECK_GE(bandwidth_headroom_factor, kLowRateFactor);
156 RTC_DCHECK_LE(bandwidth_headroom_factor, kHighRateFactor);
157
158 // |factor| is between 0.0 and 1.0.
159 const double factor = bandwidth_headroom_factor - kLowRateFactor;
160
161 return static_cast<uint32_t>(((1.0 - factor) * low) + (factor * high) + 0.5);
162}
163
Erik Språngeb180f82019-05-23 13:55:24 +0200164Vp9RateSettings GetRateSettings(double bandwidth_headroom_factor) {
165 static const Vp9RateSettings low_settings{100u, 0u, 100u, 33u, 40u};
166 static const Vp9RateSettings high_settings{50u, 50u, 1000u, 700u, 5u};
Erik Språng7a3fe892019-04-15 12:22:55 +0200167
168 if (bandwidth_headroom_factor <= kLowRateFactor) {
169 return low_settings;
170 } else if (bandwidth_headroom_factor >= kHighRateFactor) {
171 return high_settings;
172 }
173
Erik Språngeb180f82019-05-23 13:55:24 +0200174 Vp9RateSettings settings;
Erik Språng7a3fe892019-04-15 12:22:55 +0200175 settings.rc_undershoot_pct =
176 Interpolate(low_settings.rc_undershoot_pct,
177 high_settings.rc_undershoot_pct, bandwidth_headroom_factor);
178 settings.rc_overshoot_pct =
179 Interpolate(low_settings.rc_overshoot_pct, high_settings.rc_overshoot_pct,
180 bandwidth_headroom_factor);
181 settings.rc_buf_sz =
182 Interpolate(low_settings.rc_buf_sz, high_settings.rc_buf_sz,
183 bandwidth_headroom_factor);
184 settings.rc_buf_optimal_sz =
185 Interpolate(low_settings.rc_buf_optimal_sz,
186 high_settings.rc_buf_optimal_sz, bandwidth_headroom_factor);
187 settings.rc_dropframe_thresh =
188 Interpolate(low_settings.rc_dropframe_thresh,
189 high_settings.rc_dropframe_thresh, bandwidth_headroom_factor);
190 return settings;
191}
192
193void UpdateRateSettings(vpx_codec_enc_cfg_t* config,
Erik Språngeb180f82019-05-23 13:55:24 +0200194 const Vp9RateSettings& new_settings) {
Erik Språng7a3fe892019-04-15 12:22:55 +0200195 config->rc_undershoot_pct = new_settings.rc_undershoot_pct;
196 config->rc_overshoot_pct = new_settings.rc_overshoot_pct;
197 config->rc_buf_sz = new_settings.rc_buf_sz;
198 config->rc_buf_optimal_sz = new_settings.rc_buf_optimal_sz;
199 config->rc_dropframe_thresh = new_settings.rc_dropframe_thresh;
200}
201
Emircan Uysaler715cc232018-07-23 17:50:43 -0700202} // namespace
Marco6e89b252015-07-07 14:40:38 -0700203
asaperssona9455ab2015-07-31 06:10:09 -0700204void VP9EncoderImpl::EncoderOutputCodedPacketCallback(vpx_codec_cx_pkt* pkt,
205 void* user_data) {
philipelcce46fc2015-12-21 03:04:49 -0800206 VP9EncoderImpl* enc = static_cast<VP9EncoderImpl*>(user_data);
asaperssona9455ab2015-07-31 06:10:09 -0700207 enc->GetEncodedLayerFrame(pkt);
208}
209
Emircan Uysaler98badbc2018-06-28 10:59:02 -0700210VP9EncoderImpl::VP9EncoderImpl(const cricket::VideoCodec& codec)
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000211 : encoded_image_(),
sprang3958ed82017-08-17 08:12:10 -0700212 encoded_complete_callback_(nullptr),
Emircan Uysaler98badbc2018-06-28 10:59:02 -0700213 profile_(
214 ParseSdpForVP9Profile(codec.params).value_or(VP9Profile::kProfile0)),
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000215 inited_(false),
216 timestamp_(0),
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000217 cpu_speed_(3),
218 rc_max_intra_target_(0),
sprang3958ed82017-08-17 08:12:10 -0700219 encoder_(nullptr),
220 config_(nullptr),
221 raw_(nullptr),
222 input_image_(nullptr),
Sergey Silkinbd0954e2018-05-03 14:14:09 +0200223 force_key_frame_(true),
Sergey Silkin6a8f30e2018-04-26 11:03:49 +0200224 pics_since_key_(0),
asaperssona9455ab2015-07-31 06:10:09 -0700225 num_temporal_layers_(0),
philipelcfc319b2015-11-10 07:17:23 -0800226 num_spatial_layers_(0),
Sergey Silkin390f3582018-10-01 17:13:50 +0200227 num_active_spatial_layers_(0),
Erik Språngd3438aa2018-11-08 16:56:43 +0100228 layer_deactivation_requires_key_frame_(
229 field_trial::IsEnabled("WebRTC-Vp9IssueKeyFrameOnLayerDeactivation")),
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +0200230 is_svc_(false),
Sergey Silkin6a8f30e2018-04-26 11:03:49 +0200231 inter_layer_pred_(InterLayerPredMode::kOn),
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100232 external_ref_control_(false), // Set in InitEncode because of tests.
Erik Språng4b4266f2019-01-23 12:48:13 +0100233 trusted_rate_controller_(RateControlSettings::ParseFromFieldTrials()
234 .LibvpxVp9TrustedRateController()),
Erik Språng7a3fe892019-04-15 12:22:55 +0200235 dynamic_rate_settings_(
236 RateControlSettings::ParseFromFieldTrials().Vp9DynamicRateSettings()),
Sergey Silkin88ce4ef2018-11-23 13:59:24 +0100237 full_superframe_drop_(true),
238 first_frame_in_picture_(true),
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100239 ss_info_needed_(false),
Ilya Nikolaevskiy61170682019-03-06 16:04:32 +0100240 is_flexible_mode_(false),
241 variable_framerate_experiment_(ParseVariableFramerateConfig(
242 "WebRTC-VP9VariableFramerateScreenshare")),
243 variable_framerate_controller_(
244 variable_framerate_experiment_.framerate_limit),
245 num_steady_state_frames_(0) {
philipeld1d03592019-03-01 13:53:55 +0100246 codec_ = {};
johannkoenig8225c402017-01-26 13:23:44 -0800247 memset(&svc_params_, 0, sizeof(vpx_svc_extra_cfg_t));
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000248}
249
250VP9EncoderImpl::~VP9EncoderImpl() {
251 Release();
252}
253
Elad Alon8f01c4e2019-06-28 15:19:43 +0200254void VP9EncoderImpl::SetFecControllerOverride(
255 FecControllerOverride* fec_controller_override) {
256 // Ignored.
257}
258
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000259int VP9EncoderImpl::Release() {
Sergey Silkin3e871ea2018-03-02 13:11:04 +0100260 int ret_val = WEBRTC_VIDEO_CODEC_OK;
261
Niels Möllerdd1cc982019-02-07 18:52:50 +0100262 encoded_image_.Allocate(0);
sprang3958ed82017-08-17 08:12:10 -0700263 if (encoder_ != nullptr) {
Sergey Silkin90399692018-03-02 14:44:10 +0100264 if (inited_) {
265 if (vpx_codec_destroy(encoder_)) {
266 ret_val = WEBRTC_VIDEO_CODEC_MEMORY;
267 }
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000268 }
269 delete encoder_;
sprang3958ed82017-08-17 08:12:10 -0700270 encoder_ = nullptr;
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000271 }
sprang3958ed82017-08-17 08:12:10 -0700272 if (config_ != nullptr) {
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000273 delete config_;
sprang3958ed82017-08-17 08:12:10 -0700274 config_ = nullptr;
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000275 }
sprang3958ed82017-08-17 08:12:10 -0700276 if (raw_ != nullptr) {
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000277 vpx_img_free(raw_);
sprang3958ed82017-08-17 08:12:10 -0700278 raw_ = nullptr;
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000279 }
280 inited_ = false;
Sergey Silkin3e871ea2018-03-02 13:11:04 +0100281 return ret_val;
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000282}
283
sprangce4aef12015-11-02 07:23:20 -0800284bool VP9EncoderImpl::ExplicitlyConfiguredSpatialLayers() const {
285 // We check target_bitrate_bps of the 0th layer to see if the spatial layers
286 // (i.e. bitrates) were explicitly configured.
Sergey Silkinbeba1b22018-09-11 11:40:25 +0200287 return codec_.spatialLayers[0].targetBitrate > 0;
sprangce4aef12015-11-02 07:23:20 -0800288}
289
Erik Språng566124a2018-04-23 12:32:22 +0200290bool VP9EncoderImpl::SetSvcRates(
291 const VideoBitrateAllocation& bitrate_allocation) {
Sergey Silkin86684962018-03-28 19:32:37 +0200292 config_->rc_target_bitrate = bitrate_allocation.get_sum_kbps();
Sergey Silkin86684962018-03-28 19:32:37 +0200293
sprangce4aef12015-11-02 07:23:20 -0800294 if (ExplicitlyConfiguredSpatialLayers()) {
Sergey Silkine7ce8882018-10-03 18:04:57 +0200295 const bool layer_activation_requires_key_frame =
296 inter_layer_pred_ == InterLayerPredMode::kOff ||
297 inter_layer_pred_ == InterLayerPredMode::kOnKeyPic;
298
Sergey Silkin86684962018-03-28 19:32:37 +0200299 for (size_t sl_idx = 0; sl_idx < num_spatial_layers_; ++sl_idx) {
Sergey Silkine7ce8882018-10-03 18:04:57 +0200300 const bool was_layer_active = (config_->ss_target_bitrate[sl_idx] > 0);
Sergey Silkin86684962018-03-28 19:32:37 +0200301 config_->ss_target_bitrate[sl_idx] =
302 bitrate_allocation.GetSpatialLayerSum(sl_idx) / 1000;
303
304 for (size_t tl_idx = 0; tl_idx < num_temporal_layers_; ++tl_idx) {
305 config_->layer_target_bitrate[sl_idx * num_temporal_layers_ + tl_idx] =
306 bitrate_allocation.GetTemporalLayerSum(sl_idx, tl_idx) / 1000;
307 }
Sergey Silkinbd0954e2018-05-03 14:14:09 +0200308
Sergey Silkine7ce8882018-10-03 18:04:57 +0200309 const bool is_active_layer = (config_->ss_target_bitrate[sl_idx] > 0);
310 if (!was_layer_active && is_active_layer &&
311 layer_activation_requires_key_frame) {
312 force_key_frame_ = true;
313 } else if (was_layer_active && !is_active_layer &&
314 layer_deactivation_requires_key_frame_) {
315 force_key_frame_ = true;
Sergey Silkinbd0954e2018-05-03 14:14:09 +0200316 }
Sergey Silkin96f2c972018-09-05 21:07:17 +0200317
Sergey Silkine7ce8882018-10-03 18:04:57 +0200318 if (!was_layer_active) {
Sergey Silkin96f2c972018-09-05 21:07:17 +0200319 // Reset frame rate controller if layer is resumed after pause.
320 framerate_controller_[sl_idx].Reset();
321 }
322
323 framerate_controller_[sl_idx].SetTargetRate(
Ilya Nikolaevskiy5c18a5f2019-05-24 11:51:31 +0200324 codec_.spatialLayers[sl_idx].maxFramerate);
sprangce4aef12015-11-02 07:23:20 -0800325 }
326 } else {
327 float rate_ratio[VPX_MAX_LAYERS] = {0};
328 float total = 0;
Sergey Silkin908689d2018-08-20 09:28:45 +0200329 for (int i = 0; i < num_spatial_layers_; ++i) {
johannkoenig8225c402017-01-26 13:23:44 -0800330 if (svc_params_.scaling_factor_num[i] <= 0 ||
331 svc_params_.scaling_factor_den[i] <= 0) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100332 RTC_LOG(LS_ERROR) << "Scaling factors not specified!";
sprangce4aef12015-11-02 07:23:20 -0800333 return false;
334 }
Yves Gerey665174f2018-06-19 15:03:05 +0200335 rate_ratio[i] = static_cast<float>(svc_params_.scaling_factor_num[i]) /
336 svc_params_.scaling_factor_den[i];
sprangce4aef12015-11-02 07:23:20 -0800337 total += rate_ratio[i];
338 }
339
Sergey Silkin908689d2018-08-20 09:28:45 +0200340 for (int i = 0; i < num_spatial_layers_; ++i) {
Rasmus Brandt58cd3852018-06-26 13:41:16 +0200341 RTC_CHECK_GT(total, 0);
sprangce4aef12015-11-02 07:23:20 -0800342 config_->ss_target_bitrate[i] = static_cast<unsigned int>(
343 config_->rc_target_bitrate * rate_ratio[i] / total);
344 if (num_temporal_layers_ == 1) {
345 config_->layer_target_bitrate[i] = config_->ss_target_bitrate[i];
346 } else if (num_temporal_layers_ == 2) {
347 config_->layer_target_bitrate[i * num_temporal_layers_] =
348 config_->ss_target_bitrate[i] * 2 / 3;
349 config_->layer_target_bitrate[i * num_temporal_layers_ + 1] =
350 config_->ss_target_bitrate[i];
351 } else if (num_temporal_layers_ == 3) {
352 config_->layer_target_bitrate[i * num_temporal_layers_] =
353 config_->ss_target_bitrate[i] / 2;
354 config_->layer_target_bitrate[i * num_temporal_layers_ + 1] =
355 config_->layer_target_bitrate[i * num_temporal_layers_] +
356 (config_->ss_target_bitrate[i] / 4);
357 config_->layer_target_bitrate[i * num_temporal_layers_ + 2] =
358 config_->ss_target_bitrate[i];
359 } else {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100360 RTC_LOG(LS_ERROR) << "Unsupported number of temporal layers: "
361 << num_temporal_layers_;
sprangce4aef12015-11-02 07:23:20 -0800362 return false;
363 }
Sergey Silkin96f2c972018-09-05 21:07:17 +0200364
365 framerate_controller_[i].SetTargetRate(codec_.maxFramerate);
asaperssona9455ab2015-07-31 06:10:09 -0700366 }
367 }
Sergey Silkin908689d2018-08-20 09:28:45 +0200368
369 num_active_spatial_layers_ = 0;
370 for (int i = 0; i < num_spatial_layers_; ++i) {
371 if (config_->ss_target_bitrate[i] > 0) {
372 ++num_active_spatial_layers_;
373 }
374 }
375 RTC_DCHECK_GT(num_active_spatial_layers_, 0);
376
asaperssona9455ab2015-07-31 06:10:09 -0700377 return true;
378}
379
Erik Språng16cb8f52019-04-12 13:59:09 +0200380void VP9EncoderImpl::SetRates(const RateControlParameters& parameters) {
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000381 if (!inited_) {
Erik Språng16cb8f52019-04-12 13:59:09 +0200382 RTC_LOG(LS_WARNING) << "SetRates() calll while uninitialzied.";
383 return;
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000384 }
385 if (encoder_->err) {
Erik Språng16cb8f52019-04-12 13:59:09 +0200386 RTC_LOG(LS_WARNING) << "Encoder in error state: " << encoder_->err;
387 return;
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000388 }
Erik Språng16cb8f52019-04-12 13:59:09 +0200389 if (parameters.framerate_fps < 1.0) {
390 RTC_LOG(LS_WARNING) << "Unsupported framerate: "
391 << parameters.framerate_fps;
392 return;
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000393 }
394 // Update bit rate
Erik Språng08127a92016-11-16 16:41:30 +0100395 if (codec_.maxBitrate > 0 &&
Erik Språng16cb8f52019-04-12 13:59:09 +0200396 parameters.bitrate.get_sum_kbps() > codec_.maxBitrate) {
397 RTC_LOG(LS_WARNING) << "Target bitrate exceeds maximum: "
398 << parameters.bitrate.get_sum_kbps() << " vs "
399 << codec_.maxBitrate;
400 return;
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000401 }
Erik Språng08127a92016-11-16 16:41:30 +0100402
Erik Språng16cb8f52019-04-12 13:59:09 +0200403 codec_.maxFramerate = static_cast<uint32_t>(parameters.framerate_fps + 0.5);
Erik Språng7a3fe892019-04-15 12:22:55 +0200404 requested_rate_settings_ = parameters;
asaperssona9455ab2015-07-31 06:10:09 -0700405
Erik Språng16cb8f52019-04-12 13:59:09 +0200406 return;
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000407}
408
Elad Alon370f93a2019-06-11 14:57:57 +0200409// TODO(eladalon): s/inst/codec_settings/g.
Elad Alon11dfff02019-06-10 19:10:29 +0200410int VP9EncoderImpl::InitEncode(const VideoCodec* inst,
Elad Alon370f93a2019-06-11 14:57:57 +0200411 const Settings& settings) {
sprang3958ed82017-08-17 08:12:10 -0700412 if (inst == nullptr) {
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000413 return WEBRTC_VIDEO_CODEC_ERR_PARAMETER;
414 }
415 if (inst->maxFramerate < 1) {
416 return WEBRTC_VIDEO_CODEC_ERR_PARAMETER;
417 }
418 // Allow zero to represent an unspecified maxBitRate
419 if (inst->maxBitrate > 0 && inst->startBitrate > inst->maxBitrate) {
420 return WEBRTC_VIDEO_CODEC_ERR_PARAMETER;
421 }
422 if (inst->width < 1 || inst->height < 1) {
423 return WEBRTC_VIDEO_CODEC_ERR_PARAMETER;
424 }
Elad Alon370f93a2019-06-11 14:57:57 +0200425 if (settings.number_of_cores < 1) {
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000426 return WEBRTC_VIDEO_CODEC_ERR_PARAMETER;
427 }
hta257dc392016-10-25 09:05:06 -0700428 if (inst->VP9().numberOfTemporalLayers > 3) {
asaperssona9455ab2015-07-31 06:10:09 -0700429 return WEBRTC_VIDEO_CODEC_ERR_PARAMETER;
430 }
ilnik2a8c2f52017-02-15 02:23:28 -0800431 // libvpx probably does not support more than 3 spatial layers.
432 if (inst->VP9().numberOfSpatialLayers > 3) {
asaperssona9455ab2015-07-31 06:10:09 -0700433 return WEBRTC_VIDEO_CODEC_ERR_PARAMETER;
434 }
philipelcfc319b2015-11-10 07:17:23 -0800435
asapersson86956de2016-01-26 01:05:20 -0800436 int ret_val = Release();
437 if (ret_val < 0) {
438 return ret_val;
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000439 }
sprang3958ed82017-08-17 08:12:10 -0700440 if (encoder_ == nullptr) {
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000441 encoder_ = new vpx_codec_ctx_t;
442 }
sprang3958ed82017-08-17 08:12:10 -0700443 if (config_ == nullptr) {
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000444 config_ = new vpx_codec_enc_cfg_t;
445 }
446 timestamp_ = 0;
447 if (&codec_ != inst) {
448 codec_ = *inst;
449 }
asaperssona9455ab2015-07-31 06:10:09 -0700450
Sergey Silkinb0bd03b2018-09-28 14:56:39 +0200451 force_key_frame_ = true;
452 pics_since_key_ = 0;
453
hta257dc392016-10-25 09:05:06 -0700454 num_spatial_layers_ = inst->VP9().numberOfSpatialLayers;
Niels Möller65fb4042018-04-25 14:46:06 +0200455 RTC_DCHECK_GT(num_spatial_layers_, 0);
hta257dc392016-10-25 09:05:06 -0700456 num_temporal_layers_ = inst->VP9().numberOfTemporalLayers;
Sergey Silkin96f2c972018-09-05 21:07:17 +0200457 if (num_temporal_layers_ == 0) {
asaperssona9455ab2015-07-31 06:10:09 -0700458 num_temporal_layers_ = 1;
Sergey Silkin042661b2018-09-10 10:39:35 +0000459 }
Sergey Silkinae9e1882018-09-05 21:07:17 +0200460
Sergey Silkin96f2c972018-09-05 21:07:17 +0200461 framerate_controller_ = std::vector<FramerateController>(
462 num_spatial_layers_, FramerateController(codec_.maxFramerate));
463
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +0200464 is_svc_ = (num_spatial_layers_ > 1 || num_temporal_layers_ > 1);
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +0200465
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000466 encoded_image_._completeFrame = true;
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000467 // Populate encoder configuration with default values.
468 if (vpx_codec_enc_config_default(vpx_codec_vp9_cx(), config_, 0)) {
469 return WEBRTC_VIDEO_CODEC_ERROR;
470 }
Emircan Uysaler0823eec2018-07-13 17:10:00 -0700471
472 vpx_img_fmt img_fmt = VPX_IMG_FMT_NONE;
473 unsigned int bits_for_storage = 8;
474 switch (profile_) {
475 case VP9Profile::kProfile0:
476 img_fmt = VPX_IMG_FMT_I420;
477 bits_for_storage = 8;
478 config_->g_bit_depth = VPX_BITS_8;
479 config_->g_profile = 0;
480 config_->g_input_bit_depth = 8;
481 break;
482 case VP9Profile::kProfile2:
483 img_fmt = VPX_IMG_FMT_I42016;
484 bits_for_storage = 16;
485 config_->g_bit_depth = VPX_BITS_10;
486 config_->g_profile = 2;
487 config_->g_input_bit_depth = 10;
488 break;
489 }
490
491 // Creating a wrapper to the image - setting image data to nullptr. Actual
492 // pointer will be set in encode. Setting align to 1, as it is meaningless
493 // (actual memory is not allocated).
494 raw_ =
495 vpx_img_wrap(nullptr, img_fmt, codec_.width, codec_.height, 1, nullptr);
496 raw_->bit_depth = bits_for_storage;
497
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000498 config_->g_w = codec_.width;
499 config_->g_h = codec_.height;
500 config_->rc_target_bitrate = inst->startBitrate; // in kbit/s
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +0200501 config_->g_error_resilient = is_svc_ ? VPX_ERROR_RESILIENT_DEFAULT : 0;
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000502 // Setting the time base of the codec.
503 config_->g_timebase.num = 1;
504 config_->g_timebase.den = 90000;
505 config_->g_lag_in_frames = 0; // 0- no frame lagging
506 config_->g_threads = 1;
507 // Rate control settings.
hta257dc392016-10-25 09:05:06 -0700508 config_->rc_dropframe_thresh = inst->VP9().frameDroppingOn ? 30 : 0;
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000509 config_->rc_end_usage = VPX_CBR;
510 config_->g_pass = VPX_RC_ONE_PASS;
Ilya Nikolaevskiy3a656d12019-02-14 14:44:22 +0100511 config_->rc_min_quantizer =
512 codec_.mode == VideoCodecMode::kScreensharing ? 8 : 2;
marpan@webrtc.orgdc8a9da2015-01-27 23:08:24 +0000513 config_->rc_max_quantizer = 52;
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000514 config_->rc_undershoot_pct = 50;
515 config_->rc_overshoot_pct = 50;
516 config_->rc_buf_initial_sz = 500;
517 config_->rc_buf_optimal_sz = 600;
518 config_->rc_buf_sz = 1000;
519 // Set the maximum target size of any key-frame.
520 rc_max_intra_target_ = MaxIntraTarget(config_->rc_buf_optimal_sz);
Ilya Nikolaevskiy2ec0c652019-01-18 11:56:48 +0100521 // Key-frame interval is enforced manually by this wrapper.
522 config_->kf_mode = VPX_KF_DISABLED;
523 // TODO(webm:1592): work-around for libvpx issue, as it can still
524 // put some key-frames at will even in VPX_KF_DISABLED kf_mode.
525 config_->kf_max_dist = inst->VP9().keyFrameInterval;
526 config_->kf_min_dist = config_->kf_max_dist;
hta257dc392016-10-25 09:05:06 -0700527 config_->rc_resize_allowed = inst->VP9().automaticResizeOn ? 1 : 0;
marpan@webrtc.org38d11b82015-01-26 15:21:36 +0000528 // Determine number of threads based on the image size and #cores.
philipelcce46fc2015-12-21 03:04:49 -0800529 config_->g_threads =
Elad Alon370f93a2019-06-11 14:57:57 +0200530 NumberOfThreads(config_->g_w, config_->g_h, settings.number_of_cores);
asaperssona9455ab2015-07-31 06:10:09 -0700531
Marco6e89b252015-07-07 14:40:38 -0700532 cpu_speed_ = GetCpuSpeed(config_->g_w, config_->g_h);
asaperssona9455ab2015-07-31 06:10:09 -0700533
hta257dc392016-10-25 09:05:06 -0700534 is_flexible_mode_ = inst->VP9().flexibleMode;
Sergey Silkinbe71a1e2018-05-17 16:46:43 +0200535
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100536 inter_layer_pred_ = inst->VP9().interLayerPred;
537
Ilya Nikolaevskiy5c18a5f2019-05-24 11:51:31 +0200538 if (num_spatial_layers_ > 1 &&
539 codec_.mode == VideoCodecMode::kScreensharing && !is_flexible_mode_) {
540 RTC_LOG(LS_ERROR) << "Flexible mode is required for screenshare with "
541 "several spatial layers";
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100542 return WEBRTC_VIDEO_CODEC_ERR_PARAMETER;
543 }
544
545 // External reference control is required for different frame rate on spatial
546 // layers because libvpx generates rtp incompatible references in this case.
547 external_ref_control_ = field_trial::IsEnabled("WebRTC-Vp9ExternalRefCtrl") ||
Ilya Nikolaevskiy5c18a5f2019-05-24 11:51:31 +0200548 (num_spatial_layers_ > 1 &&
549 codec_.mode == VideoCodecMode::kScreensharing) ||
Ilya Nikolaevskiy2ec0c652019-01-18 11:56:48 +0100550 inter_layer_pred_ == InterLayerPredMode::kOn;
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100551
Sergey Silkinbe71a1e2018-05-17 16:46:43 +0200552 if (num_temporal_layers_ == 1) {
asaperssona9455ab2015-07-31 06:10:09 -0700553 gof_.SetGofInfoVP9(kTemporalStructureMode1);
554 config_->temporal_layering_mode = VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING;
555 config_->ts_number_layers = 1;
556 config_->ts_rate_decimator[0] = 1;
557 config_->ts_periodicity = 1;
558 config_->ts_layer_id[0] = 0;
559 } else if (num_temporal_layers_ == 2) {
560 gof_.SetGofInfoVP9(kTemporalStructureMode2);
561 config_->temporal_layering_mode = VP9E_TEMPORAL_LAYERING_MODE_0101;
562 config_->ts_number_layers = 2;
563 config_->ts_rate_decimator[0] = 2;
564 config_->ts_rate_decimator[1] = 1;
565 config_->ts_periodicity = 2;
566 config_->ts_layer_id[0] = 0;
567 config_->ts_layer_id[1] = 1;
568 } else if (num_temporal_layers_ == 3) {
569 gof_.SetGofInfoVP9(kTemporalStructureMode3);
570 config_->temporal_layering_mode = VP9E_TEMPORAL_LAYERING_MODE_0212;
571 config_->ts_number_layers = 3;
572 config_->ts_rate_decimator[0] = 4;
573 config_->ts_rate_decimator[1] = 2;
574 config_->ts_rate_decimator[2] = 1;
575 config_->ts_periodicity = 4;
576 config_->ts_layer_id[0] = 0;
577 config_->ts_layer_id[1] = 2;
578 config_->ts_layer_id[2] = 1;
579 config_->ts_layer_id[3] = 2;
580 } else {
581 return WEBRTC_VIDEO_CODEC_ERR_PARAMETER;
582 }
583
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100584 if (external_ref_control_) {
585 config_->temporal_layering_mode = VP9E_TEMPORAL_LAYERING_MODE_BYPASS;
Ilya Nikolaevskiy5c18a5f2019-05-24 11:51:31 +0200586 if (num_temporal_layers_ > 1 && num_spatial_layers_ > 1 &&
587 codec_.mode == VideoCodecMode::kScreensharing) {
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100588 // External reference control for several temporal layers with different
589 // frame rates on spatial layers is not implemented yet.
590 return WEBRTC_VIDEO_CODEC_ERR_PARAMETER;
591 }
592 }
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +0200593 ref_buf_.clear();
594
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000595 return InitAndSetControlSettings(inst);
596}
597
marpan@webrtc.org38d11b82015-01-26 15:21:36 +0000598int VP9EncoderImpl::NumberOfThreads(int width,
599 int height,
600 int number_of_cores) {
601 // Keep the number of encoder threads equal to the possible number of column
602 // tiles, which is (1, 2, 4, 8). See comments below for VP9E_SET_TILE_COLUMNS.
603 if (width * height >= 1280 * 720 && number_of_cores > 4) {
604 return 4;
jianj23173a32017-07-12 16:11:09 -0700605 } else if (width * height >= 640 * 360 && number_of_cores > 2) {
marpan@webrtc.org38d11b82015-01-26 15:21:36 +0000606 return 2;
607 } else {
Yves Gerey665174f2018-06-19 15:03:05 +0200608// Use 2 threads for low res on ARM.
Jerome Jiang831af372017-12-05 10:44:35 -0800609#if defined(WEBRTC_ARCH_ARM) || defined(WEBRTC_ARCH_ARM64) || \
610 defined(WEBRTC_ANDROID)
611 if (width * height >= 320 * 180 && number_of_cores > 2) {
612 return 2;
613 }
614#endif
marpan@webrtc.org38d11b82015-01-26 15:21:36 +0000615 // 1 thread less than VGA.
616 return 1;
617 }
618}
619
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000620int VP9EncoderImpl::InitAndSetControlSettings(const VideoCodec* inst) {
Åsa Perssonff24c042015-12-04 10:58:08 +0100621 // Set QP-min/max per spatial and temporal layer.
622 int tot_num_layers = num_spatial_layers_ * num_temporal_layers_;
623 for (int i = 0; i < tot_num_layers; ++i) {
johannkoenig8225c402017-01-26 13:23:44 -0800624 svc_params_.max_quantizers[i] = config_->rc_max_quantizer;
625 svc_params_.min_quantizers[i] = config_->rc_min_quantizer;
Åsa Perssonff24c042015-12-04 10:58:08 +0100626 }
asaperssona9455ab2015-07-31 06:10:09 -0700627 config_->ss_number_layers = num_spatial_layers_;
sprangce4aef12015-11-02 07:23:20 -0800628 if (ExplicitlyConfiguredSpatialLayers()) {
629 for (int i = 0; i < num_spatial_layers_; ++i) {
630 const auto& layer = codec_.spatialLayers[i];
Rasmus Brandt58cd3852018-06-26 13:41:16 +0200631 RTC_CHECK_GT(layer.width, 0);
Sergey Silkin13e74342018-03-02 12:28:00 +0100632 const int scale_factor = codec_.width / layer.width;
633 RTC_DCHECK_GT(scale_factor, 0);
634
635 // Ensure scaler factor is integer.
636 if (scale_factor * layer.width != codec_.width) {
637 return WEBRTC_VIDEO_CODEC_ERR_PARAMETER;
638 }
639
640 // Ensure scale factor is the same in both dimensions.
641 if (scale_factor * layer.height != codec_.height) {
642 return WEBRTC_VIDEO_CODEC_ERR_PARAMETER;
643 }
644
645 // Ensure scale factor is power of two.
646 const bool is_pow_of_two = (scale_factor & (scale_factor - 1)) == 0;
647 if (!is_pow_of_two) {
648 return WEBRTC_VIDEO_CODEC_ERR_PARAMETER;
649 }
650
651 svc_params_.scaling_factor_num[i] = 1;
652 svc_params_.scaling_factor_den[i] = scale_factor;
Sergey Silkin96f2c972018-09-05 21:07:17 +0200653
654 RTC_DCHECK_GT(codec_.spatialLayers[i].maxFramerate, 0);
655 RTC_DCHECK_LE(codec_.spatialLayers[i].maxFramerate, codec_.maxFramerate);
656 if (i > 0) {
657 // Frame rate of high spatial layer is supposed to be equal or higher
658 // than frame rate of low spatial layer.
659 RTC_DCHECK_GE(codec_.spatialLayers[i].maxFramerate,
660 codec_.spatialLayers[i - 1].maxFramerate);
661 }
sprangce4aef12015-11-02 07:23:20 -0800662 }
663 } else {
664 int scaling_factor_num = 256;
665 for (int i = num_spatial_layers_ - 1; i >= 0; --i) {
sprangce4aef12015-11-02 07:23:20 -0800666 // 1:2 scaling in each dimension.
johannkoenig8225c402017-01-26 13:23:44 -0800667 svc_params_.scaling_factor_num[i] = scaling_factor_num;
668 svc_params_.scaling_factor_den[i] = 256;
sprangce4aef12015-11-02 07:23:20 -0800669 }
asaperssona9455ab2015-07-31 06:10:09 -0700670 }
671
Sergey Silkin86684962018-03-28 19:32:37 +0200672 SvcRateAllocator init_allocator(codec_);
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100673 current_bitrate_allocation_ = init_allocator.GetAllocation(
Sergey Silkin86684962018-03-28 19:32:37 +0200674 inst->startBitrate * 1000, inst->maxFramerate);
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100675 if (!SetSvcRates(current_bitrate_allocation_)) {
asaperssona9455ab2015-07-31 06:10:09 -0700676 return WEBRTC_VIDEO_CODEC_ERR_PARAMETER;
677 }
678
Emircan Uysaler0823eec2018-07-13 17:10:00 -0700679 const vpx_codec_err_t rv = vpx_codec_enc_init(
680 encoder_, vpx_codec_vp9_cx(), config_,
681 config_->g_bit_depth == VPX_BITS_8 ? 0 : VPX_CODEC_USE_HIGHBITDEPTH);
682 if (rv != VPX_CODEC_OK) {
683 RTC_LOG(LS_ERROR) << "Init error: " << vpx_codec_err_to_string(rv);
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000684 return WEBRTC_VIDEO_CODEC_UNINITIALIZED;
685 }
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000686 vpx_codec_control(encoder_, VP8E_SET_CPUUSED, cpu_speed_);
687 vpx_codec_control(encoder_, VP8E_SET_MAX_INTRA_BITRATE_PCT,
688 rc_max_intra_target_);
689 vpx_codec_control(encoder_, VP9E_SET_AQ_MODE,
hta257dc392016-10-25 09:05:06 -0700690 inst->VP9().adaptiveQpMode ? 3 : 0);
asaperssona9455ab2015-07-31 06:10:09 -0700691
jianj822e5932017-07-12 16:09:58 -0700692 vpx_codec_control(encoder_, VP9E_SET_FRAME_PARALLEL_DECODING, 0);
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100693 vpx_codec_control(encoder_, VP9E_SET_SVC_GF_TEMPORAL_REF, 0);
Sergey Silkin6a8f30e2018-04-26 11:03:49 +0200694
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +0200695 if (is_svc_) {
696 vpx_codec_control(encoder_, VP9E_SET_SVC, 1);
697 vpx_codec_control(encoder_, VP9E_SET_SVC_PARAMETERS, &svc_params_);
asaperssona9455ab2015-07-31 06:10:09 -0700698 }
Sergey Silkin6a8f30e2018-04-26 11:03:49 +0200699
700 if (num_spatial_layers_ > 1) {
701 switch (inter_layer_pred_) {
702 case InterLayerPredMode::kOn:
703 vpx_codec_control(encoder_, VP9E_SET_SVC_INTER_LAYER_PRED, 0);
704 break;
705 case InterLayerPredMode::kOff:
706 vpx_codec_control(encoder_, VP9E_SET_SVC_INTER_LAYER_PRED, 1);
707 break;
708 case InterLayerPredMode::kOnKeyPic:
709 vpx_codec_control(encoder_, VP9E_SET_SVC_INTER_LAYER_PRED, 2);
710 break;
711 default:
712 RTC_NOTREACHED();
713 }
Sergey Silkinbe71a1e2018-05-17 16:46:43 +0200714
Ilya Nikolaevskiy039a7142019-05-24 16:50:00 +0200715 memset(&svc_drop_frame_, 0, sizeof(svc_drop_frame_));
716 dropping_only_base_layer_ = inter_layer_pred_ == InterLayerPredMode::kOn &&
717 codec_.mode == VideoCodecMode::kScreensharing &&
718 num_spatial_layers_ > 1;
719 if (dropping_only_base_layer_) {
720 // Screenshare dropping mode: only the base spatial layer
721 // can be dropped and it doesn't affect other spatial layers.
722 // This mode is preferable because base layer has low bitrate targets
723 // and more likely to drop frames. It shouldn't reduce framerate on other
724 // layers.
725 svc_drop_frame_.framedrop_mode = LAYER_DROP;
726 svc_drop_frame_.max_consec_drop = 5;
727 svc_drop_frame_.framedrop_thresh[0] = config_->rc_dropframe_thresh;
728 for (size_t i = 1; i < num_spatial_layers_; ++i) {
729 svc_drop_frame_.framedrop_thresh[i] = 0;
730 }
731 } else {
732 // Configure encoder to drop entire superframe whenever it needs to drop
733 // a layer. This mode is preferred over per-layer dropping which causes
734 // quality flickering and is not compatible with RTP non-flexible mode.
735 svc_drop_frame_.framedrop_mode =
736 full_superframe_drop_ ? FULL_SUPERFRAME_DROP : CONSTRAINED_LAYER_DROP;
737 svc_drop_frame_.max_consec_drop = std::numeric_limits<int>::max();
738 for (size_t i = 0; i < num_spatial_layers_; ++i) {
739 svc_drop_frame_.framedrop_thresh[i] = config_->rc_dropframe_thresh;
740 }
Sergey Silkinbe71a1e2018-05-17 16:46:43 +0200741 }
Ilya Nikolaevskiy039a7142019-05-24 16:50:00 +0200742 vpx_codec_control(encoder_, VP9E_SET_SVC_FRAME_DROP_LAYER,
743 &svc_drop_frame_);
Sergey Silkin6a8f30e2018-04-26 11:03:49 +0200744 }
745
asaperssona9455ab2015-07-31 06:10:09 -0700746 // Register callback for getting each spatial layer.
747 vpx_codec_priv_output_cx_pkt_cb_pair_t cbp = {
philipelcce46fc2015-12-21 03:04:49 -0800748 VP9EncoderImpl::EncoderOutputCodedPacketCallback,
749 reinterpret_cast<void*>(this)};
750 vpx_codec_control(encoder_, VP9E_REGISTER_CX_CALLBACK,
751 reinterpret_cast<void*>(&cbp));
asaperssona9455ab2015-07-31 06:10:09 -0700752
marpan@webrtc.org38d11b82015-01-26 15:21:36 +0000753 // Control function to set the number of column tiles in encoding a frame, in
754 // log2 unit: e.g., 0 = 1 tile column, 1 = 2 tile columns, 2 = 4 tile columns.
755 // The number tile columns will be capped by the encoder based on image size
756 // (minimum width of tile column is 256 pixels, maximum is 4096).
757 vpx_codec_control(encoder_, VP9E_SET_TILE_COLUMNS, (config_->g_threads >> 1));
jianjcb5d1152017-03-28 23:56:08 -0700758
759 // Turn on row-based multithreading.
760 vpx_codec_control(encoder_, VP9E_SET_ROW_MT, 1);
jianj6bf57e32017-06-05 13:43:49 -0700761
Alex Glaznevfecb7c32016-03-31 14:23:27 -0700762#if !defined(WEBRTC_ARCH_ARM) && !defined(WEBRTC_ARCH_ARM64) && \
Yves Gerey665174f2018-06-19 15:03:05 +0200763 !defined(ANDROID)
jianj6bf57e32017-06-05 13:43:49 -0700764 // Do not enable the denoiser on ARM since optimization is pending.
765 // Denoiser is on by default on other platforms.
marpan@webrtc.org16a87b92015-03-05 22:19:00 +0000766 vpx_codec_control(encoder_, VP9E_SET_NOISE_SENSITIVITY,
hta257dc392016-10-25 09:05:06 -0700767 inst->VP9().denoisingOn ? 1 : 0);
marpan@webrtc.org16a87b92015-03-05 22:19:00 +0000768#endif
jianj6bf57e32017-06-05 13:43:49 -0700769
Niels Möllere3cf3d02018-06-13 11:52:16 +0200770 if (codec_.mode == VideoCodecMode::kScreensharing) {
ivica242d6382015-09-04 06:13:23 -0700771 // Adjust internal parameters to screen content.
772 vpx_codec_control(encoder_, VP9E_SET_TUNE_CONTENT, 1);
ivica242d6382015-09-04 06:13:23 -0700773 }
Marco2520e722015-09-16 14:05:00 -0700774 // Enable encoder skip of static/low content blocks.
775 vpx_codec_control(encoder_, VP8E_SET_STATIC_THRESHOLD, 1);
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000776 inited_ = true;
777 return WEBRTC_VIDEO_CODEC_OK;
778}
779
780uint32_t VP9EncoderImpl::MaxIntraTarget(uint32_t optimal_buffer_size) {
781 // Set max to the optimal buffer level (normalized by target BR),
782 // and scaled by a scale_par.
783 // Max target size = scale_par * optimal_buffer_size * targetBR[Kbps].
784 // This value is presented in percentage of perFrameBw:
785 // perFrameBw = targetBR[Kbps] * 1000 / framerate.
786 // The target in % is as follows:
787 float scale_par = 0.5;
788 uint32_t target_pct =
789 optimal_buffer_size * scale_par * codec_.maxFramerate / 10;
790 // Don't go below 3 times the per frame bandwidth.
791 const uint32_t min_intra_size = 300;
philipelcce46fc2015-12-21 03:04:49 -0800792 return (target_pct < min_intra_size) ? min_intra_size : target_pct;
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000793}
794
Miguel Casas-Sanchez47650702015-05-29 17:21:40 -0700795int VP9EncoderImpl::Encode(const VideoFrame& input_image,
Niels Möller87e2d782019-03-07 10:18:23 +0100796 const std::vector<VideoFrameType>* frame_types) {
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000797 if (!inited_) {
798 return WEBRTC_VIDEO_CODEC_UNINITIALIZED;
799 }
sprang3958ed82017-08-17 08:12:10 -0700800 if (encoded_complete_callback_ == nullptr) {
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000801 return WEBRTC_VIDEO_CODEC_UNINITIALIZED;
802 }
Erik Språngbfa5d5d2019-02-04 16:40:19 +0100803 if (num_active_spatial_layers_ == 0) {
804 // All spatial layers are disabled, return without encoding anything.
805 return WEBRTC_VIDEO_CODEC_OK;
806 }
Sergey Silkinbd0954e2018-05-03 14:14:09 +0200807
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000808 // We only support one stream at the moment.
Sergey Silkinbd0954e2018-05-03 14:14:09 +0200809 if (frame_types && !frame_types->empty()) {
Niels Möller8f7ce222019-03-21 15:43:58 +0100810 if ((*frame_types)[0] == VideoFrameType::kVideoFrameKey) {
Sergey Silkinbd0954e2018-05-03 14:14:09 +0200811 force_key_frame_ = true;
812 }
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000813 }
Sergey Silkind902d582018-05-18 17:31:19 +0200814
Ilya Nikolaevskiy2ec0c652019-01-18 11:56:48 +0100815 if (pics_since_key_ + 1 ==
816 static_cast<size_t>(codec_.VP9()->keyFrameInterval)) {
817 force_key_frame_ = true;
818 }
819
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100820 vpx_svc_layer_id_t layer_id = {0};
821 if (!force_key_frame_) {
Patrik Höglundd4d254f2018-11-29 15:09:31 +0000822 const size_t gof_idx = (pics_since_key_ + 1) % gof_.num_frames_in_gof;
823 layer_id.temporal_layer_id = gof_.temporal_idx[gof_idx];
Sergey Silkin96f2c972018-09-05 21:07:17 +0200824
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100825 if (VideoCodecMode::kScreensharing == codec_.mode) {
826 const uint32_t frame_timestamp_ms =
827 1000 * input_image.timestamp() / kVideoPayloadTypeFrequency;
Sergey Silkin96f2c972018-09-05 21:07:17 +0200828
Ilya Nikolaevskiy61170682019-03-06 16:04:32 +0100829 // To ensure that several rate-limiters with different limits don't
830 // interfere, they must be queried in order of increasing limit.
831
832 bool use_steady_state_limiter =
833 variable_framerate_experiment_.enabled &&
834 input_image.update_rect().IsEmpty() &&
835 num_steady_state_frames_ >=
836 variable_framerate_experiment_.frames_before_steady_state;
837
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100838 for (uint8_t sl_idx = 0; sl_idx < num_active_spatial_layers_; ++sl_idx) {
Ilya Nikolaevskiy61170682019-03-06 16:04:32 +0100839 const float layer_fps =
840 framerate_controller_[layer_id.spatial_layer_id].GetTargetRate();
841 // Use steady state rate-limiter at the correct place.
842 if (use_steady_state_limiter &&
843 layer_fps > variable_framerate_experiment_.framerate_limit - 1e-9) {
844 if (variable_framerate_controller_.DropFrame(frame_timestamp_ms)) {
845 layer_id.spatial_layer_id = num_active_spatial_layers_;
846 }
847 // Break always: if rate limiter triggered frame drop, no need to
848 // continue; otherwise, the rate is less than the next limiters.
849 break;
850 }
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100851 if (framerate_controller_[sl_idx].DropFrame(frame_timestamp_ms)) {
852 ++layer_id.spatial_layer_id;
853 } else {
854 break;
855 }
Sergey Silkin96f2c972018-09-05 21:07:17 +0200856 }
Ilya Nikolaevskiy61170682019-03-06 16:04:32 +0100857
858 if (use_steady_state_limiter &&
859 layer_id.spatial_layer_id < num_active_spatial_layers_) {
860 variable_framerate_controller_.AddFrame(frame_timestamp_ms);
861 }
Sergey Silkin96f2c972018-09-05 21:07:17 +0200862 }
Patrik Höglundd4d254f2018-11-29 15:09:31 +0000863
864 RTC_DCHECK_LE(layer_id.spatial_layer_id, num_active_spatial_layers_);
865 if (layer_id.spatial_layer_id >= num_active_spatial_layers_) {
866 // Drop entire picture.
867 return WEBRTC_VIDEO_CODEC_OK;
868 }
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100869 }
Patrik Höglundd4d254f2018-11-29 15:09:31 +0000870
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100871 for (int sl_idx = 0; sl_idx < num_active_spatial_layers_; ++sl_idx) {
872 layer_id.temporal_layer_id_per_spatial[sl_idx] = layer_id.temporal_layer_id;
873 }
874
875 vpx_codec_control(encoder_, VP9E_SET_SVC_LAYER_ID, &layer_id);
876
Erik Språng7a3fe892019-04-15 12:22:55 +0200877 if (requested_rate_settings_) {
878 if (dynamic_rate_settings_) {
879 // Tweak rate control settings based on available network headroom.
880 UpdateRateSettings(
881 config_,
882 GetRateSettings(
883 requested_rate_settings_->bandwidth_allocation.bps<double>() /
884 requested_rate_settings_->bitrate.get_sum_bps()));
885 }
886
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100887 bool more_layers_requested = MoreLayersEnabled(
Erik Språng7a3fe892019-04-15 12:22:55 +0200888 requested_rate_settings_->bitrate, current_bitrate_allocation_);
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100889 bool less_layers_requested = MoreLayersEnabled(
Erik Språng7a3fe892019-04-15 12:22:55 +0200890 current_bitrate_allocation_, requested_rate_settings_->bitrate);
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100891 // In SVC can enable new layers only if all lower layers are encoded and at
892 // the base temporal layer.
893 // This will delay rate allocation change until the next frame on the base
894 // spatial layer.
895 // In KSVC or simulcast modes KF will be generated for a new layer, so can
896 // update allocation any time.
897 bool can_upswitch =
898 inter_layer_pred_ != InterLayerPredMode::kOn ||
899 (layer_id.spatial_layer_id == 0 && layer_id.temporal_layer_id == 0);
900 if (!more_layers_requested || can_upswitch) {
Erik Språng7a3fe892019-04-15 12:22:55 +0200901 current_bitrate_allocation_ = requested_rate_settings_->bitrate;
902 requested_rate_settings_ = absl::nullopt;
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100903 if (!SetSvcRates(current_bitrate_allocation_)) {
904 return WEBRTC_VIDEO_CODEC_ERR_PARAMETER;
905 }
906 if (less_layers_requested || more_layers_requested) {
907 ss_info_needed_ = true;
908 }
Ilya Nikolaevskiy039a7142019-05-24 16:50:00 +0200909 if (more_layers_requested && !force_key_frame_) {
910 // Prohibit drop of all layers for the next frame, so newly enabled
911 // layer would have a valid spatial reference.
912 for (size_t i = 0; i < num_spatial_layers_; ++i) {
913 svc_drop_frame_.framedrop_thresh[i] = 0;
914 }
915 }
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100916 }
917 }
918
Ilya Nikolaevskiy039a7142019-05-24 16:50:00 +0200919 if (num_spatial_layers_ > 1) {
920 // Update frame dropping settings as they may change on per-frame basis.
921 vpx_codec_control(encoder_, VP9E_SET_SVC_FRAME_DROP_LAYER,
922 &svc_drop_frame_);
923 }
924
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100925 if (vpx_codec_enc_config_set(encoder_, config_)) {
926 return WEBRTC_VIDEO_CODEC_ERROR;
Sergey Silkind902d582018-05-18 17:31:19 +0200927 }
928
kwiberg352444f2016-11-28 15:58:53 -0800929 RTC_DCHECK_EQ(input_image.width(), raw_->d_w);
930 RTC_DCHECK_EQ(input_image.height(), raw_->d_h);
asaperssona9455ab2015-07-31 06:10:09 -0700931
932 // Set input image for use in the callback.
933 // This was necessary since you need some information from input_image.
934 // You can save only the necessary information (such as timestamp) instead of
935 // doing this.
936 input_image_ = &input_image;
937
Emircan Uysaler0823eec2018-07-13 17:10:00 -0700938 // Keep reference to buffer until encode completes.
939 rtc::scoped_refptr<I420BufferInterface> i420_buffer;
Ilya Nikolaevskiya8507e32019-05-03 11:39:26 +0200940 const I010BufferInterface* i010_buffer;
941 rtc::scoped_refptr<const I010BufferInterface> i010_copy;
Emircan Uysaler0823eec2018-07-13 17:10:00 -0700942 switch (profile_) {
943 case VP9Profile::kProfile0: {
944 i420_buffer = input_image.video_frame_buffer()->ToI420();
945 // Image in vpx_image_t format.
946 // Input image is const. VPX's raw image is not defined as const.
947 raw_->planes[VPX_PLANE_Y] = const_cast<uint8_t*>(i420_buffer->DataY());
948 raw_->planes[VPX_PLANE_U] = const_cast<uint8_t*>(i420_buffer->DataU());
949 raw_->planes[VPX_PLANE_V] = const_cast<uint8_t*>(i420_buffer->DataV());
950 raw_->stride[VPX_PLANE_Y] = i420_buffer->StrideY();
951 raw_->stride[VPX_PLANE_U] = i420_buffer->StrideU();
952 raw_->stride[VPX_PLANE_V] = i420_buffer->StrideV();
953 break;
954 }
955 case VP9Profile::kProfile2: {
956 // We can inject kI010 frames directly for encode. All other formats
957 // should be converted to it.
958 switch (input_image.video_frame_buffer()->type()) {
959 case VideoFrameBuffer::Type::kI010: {
960 i010_buffer = input_image.video_frame_buffer()->GetI010();
961 break;
962 }
963 default: {
Ilya Nikolaevskiya8507e32019-05-03 11:39:26 +0200964 i010_copy =
Emircan Uysaler0823eec2018-07-13 17:10:00 -0700965 I010Buffer::Copy(*input_image.video_frame_buffer()->ToI420());
Ilya Nikolaevskiya8507e32019-05-03 11:39:26 +0200966 i010_buffer = i010_copy.get();
Emircan Uysaler0823eec2018-07-13 17:10:00 -0700967 }
968 }
969 raw_->planes[VPX_PLANE_Y] = const_cast<uint8_t*>(
970 reinterpret_cast<const uint8_t*>(i010_buffer->DataY()));
971 raw_->planes[VPX_PLANE_U] = const_cast<uint8_t*>(
972 reinterpret_cast<const uint8_t*>(i010_buffer->DataU()));
973 raw_->planes[VPX_PLANE_V] = const_cast<uint8_t*>(
974 reinterpret_cast<const uint8_t*>(i010_buffer->DataV()));
975 raw_->stride[VPX_PLANE_Y] = i010_buffer->StrideY() * 2;
976 raw_->stride[VPX_PLANE_U] = i010_buffer->StrideU() * 2;
977 raw_->stride[VPX_PLANE_V] = i010_buffer->StrideV() * 2;
978 break;
979 }
980 }
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000981
philipelcfc319b2015-11-10 07:17:23 -0800982 vpx_enc_frame_flags_t flags = 0;
Sergey Silkinbd0954e2018-05-03 14:14:09 +0200983 if (force_key_frame_) {
marpan@webrtc.org5b883172014-11-01 06:10:48 +0000984 flags = VPX_EFLAG_FORCE_KF;
985 }
philipelcfc319b2015-11-10 07:17:23 -0800986
Sergey Silkin390f3582018-10-01 17:13:50 +0200987 if (external_ref_control_) {
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100988 vpx_svc_ref_frame_config_t ref_config =
989 SetReferences(force_key_frame_, layer_id.spatial_layer_id);
Sergey Silkina85995a2018-10-02 10:28:10 +0200990
991 if (VideoCodecMode::kScreensharing == codec_.mode) {
992 for (uint8_t sl_idx = 0; sl_idx < num_active_spatial_layers_; ++sl_idx) {
993 ref_config.duration[sl_idx] = static_cast<int64_t>(
Ilya Nikolaevskiy5c18a5f2019-05-24 11:51:31 +0200994 90000 / (std::min(static_cast<float>(codec_.maxFramerate),
995 framerate_controller_[sl_idx].GetTargetRate())));
Sergey Silkina85995a2018-10-02 10:28:10 +0200996 }
997 }
998
Sergey Silkin390f3582018-10-01 17:13:50 +0200999 vpx_codec_control(encoder_, VP9E_SET_SVC_REF_FRAME_CONFIG, &ref_config);
1000 }
1001
Sergey Silkin88ce4ef2018-11-23 13:59:24 +01001002 first_frame_in_picture_ = true;
1003
Sergey Silkin96f2c972018-09-05 21:07:17 +02001004 // TODO(ssilkin): Frame duration should be specified per spatial layer
1005 // since their frame rate can be different. For now calculate frame duration
1006 // based on target frame rate of the highest spatial layer, which frame rate
1007 // is supposed to be equal or higher than frame rate of low spatial layers.
1008 // Also, timestamp should represent actual time passed since previous frame
1009 // (not 'expected' time). Then rate controller can drain buffer more
1010 // accurately.
1011 RTC_DCHECK_GE(framerate_controller_.size(), num_active_spatial_layers_);
Sergey Silkinf87bb462018-09-17 09:37:37 +02001012 float target_framerate_fps =
1013 (codec_.mode == VideoCodecMode::kScreensharing)
Ilya Nikolaevskiy5c18a5f2019-05-24 11:51:31 +02001014 ? std::min(static_cast<float>(codec_.maxFramerate),
1015 framerate_controller_[num_active_spatial_layers_ - 1]
1016 .GetTargetRate())
Sergey Silkinf87bb462018-09-17 09:37:37 +02001017 : codec_.maxFramerate;
1018 uint32_t duration = static_cast<uint32_t>(90000 / target_framerate_fps);
Emircan Uysaler0823eec2018-07-13 17:10:00 -07001019 const vpx_codec_err_t rv = vpx_codec_encode(encoder_, raw_, timestamp_,
1020 duration, flags, VPX_DL_REALTIME);
1021 if (rv != VPX_CODEC_OK) {
1022 RTC_LOG(LS_ERROR) << "Encoding error: " << vpx_codec_err_to_string(rv)
1023 << "\n"
1024 << "Details: " << vpx_codec_error(encoder_) << "\n"
1025 << vpx_codec_error_detail(encoder_);
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001026 return WEBRTC_VIDEO_CODEC_ERROR;
1027 }
1028 timestamp_ += duration;
asaperssona9455ab2015-07-31 06:10:09 -07001029
Sergey Silkin88ce4ef2018-11-23 13:59:24 +01001030 if (!full_superframe_drop_) {
1031 const bool end_of_picture = true;
1032 DeliverBufferedFrame(end_of_picture);
1033 }
Sergey Silkin2a1f1832018-04-04 11:45:41 +02001034
asaperssona9455ab2015-07-31 06:10:09 -07001035 return WEBRTC_VIDEO_CODEC_OK;
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001036}
1037
1038void VP9EncoderImpl::PopulateCodecSpecific(CodecSpecificInfo* codec_specific,
Niels Möllerd3b8c632018-08-27 15:33:42 +02001039 absl::optional<int>* spatial_idx,
philipelcce46fc2015-12-21 03:04:49 -08001040 const vpx_codec_cx_pkt& pkt,
Sergey Silkin88ce4ef2018-11-23 13:59:24 +01001041 uint32_t timestamp) {
sprang3958ed82017-08-17 08:12:10 -07001042 RTC_CHECK(codec_specific != nullptr);
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001043 codec_specific->codecType = kVideoCodecVP9;
philipelcce46fc2015-12-21 03:04:49 -08001044 CodecSpecificInfoVP9* vp9_info = &(codec_specific->codecSpecific.VP9);
Sergey Silkin07f80cc2018-04-09 13:11:59 +02001045
Sergey Silkin88ce4ef2018-11-23 13:59:24 +01001046 vp9_info->first_frame_in_picture = first_frame_in_picture_;
Sergey Silkin738b7e92018-08-23 16:37:27 +02001047 vp9_info->flexible_mode = is_flexible_mode_;
asaperssona9455ab2015-07-31 06:10:09 -07001048
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +01001049 if (pkt.data.frame.flags & VPX_FRAME_IS_KEY) {
1050 pics_since_key_ = 0;
1051 } else if (first_frame_in_picture_) {
1052 ++pics_since_key_;
1053 }
1054
asaperssona9455ab2015-07-31 06:10:09 -07001055 vpx_svc_layer_id_t layer_id = {0};
1056 vpx_codec_control(encoder_, VP9E_GET_SVC_LAYER_ID, &layer_id);
1057
Ilya Nikolaevskiy2ec0c652019-01-18 11:56:48 +01001058 // Can't have keyframe with non-zero temporal layer.
1059 RTC_DCHECK(pics_since_key_ != 0 || layer_id.temporal_layer_id == 0);
1060
sprang3958ed82017-08-17 08:12:10 -07001061 RTC_CHECK_GT(num_temporal_layers_, 0);
“Michael23c5a992018-06-21 11:07:21 -05001062 RTC_CHECK_GT(num_active_spatial_layers_, 0);
asaperssona9455ab2015-07-31 06:10:09 -07001063 if (num_temporal_layers_ == 1) {
sprang3958ed82017-08-17 08:12:10 -07001064 RTC_CHECK_EQ(layer_id.temporal_layer_id, 0);
asaperssona9455ab2015-07-31 06:10:09 -07001065 vp9_info->temporal_idx = kNoTemporalIdx;
1066 } else {
1067 vp9_info->temporal_idx = layer_id.temporal_layer_id;
1068 }
“Michael23c5a992018-06-21 11:07:21 -05001069 if (num_active_spatial_layers_ == 1) {
sprang3958ed82017-08-17 08:12:10 -07001070 RTC_CHECK_EQ(layer_id.spatial_layer_id, 0);
Niels Möllerd3b8c632018-08-27 15:33:42 +02001071 *spatial_idx = absl::nullopt;
asaperssona9455ab2015-07-31 06:10:09 -07001072 } else {
Niels Möllerd3b8c632018-08-27 15:33:42 +02001073 *spatial_idx = layer_id.spatial_layer_id;
asaperssona9455ab2015-07-31 06:10:09 -07001074 }
asaperssona9455ab2015-07-31 06:10:09 -07001075
asaperssona9455ab2015-07-31 06:10:09 -07001076 // TODO(asapersson): this info has to be obtained from the encoder.
asaperssoncb50c962015-11-18 01:58:55 -08001077 vp9_info->temporal_up_switch = false;
asaperssona9455ab2015-07-31 06:10:09 -07001078
Sergey Silkin6a8f30e2018-04-26 11:03:49 +02001079 const bool is_key_pic = (pics_since_key_ == 0);
1080 const bool is_inter_layer_pred_allowed =
1081 (inter_layer_pred_ == InterLayerPredMode::kOn ||
1082 (inter_layer_pred_ == InterLayerPredMode::kOnKeyPic && is_key_pic));
1083
1084 // Always set inter_layer_predicted to true on high layer frame if inter-layer
1085 // prediction (ILP) is allowed even if encoder didn't actually use it.
1086 // Setting inter_layer_predicted to false would allow receiver to decode high
1087 // layer frame without decoding low layer frame. If that would happen (e.g.
1088 // if low layer frame is lost) then receiver won't be able to decode next high
1089 // layer frame which uses ILP.
1090 vp9_info->inter_layer_predicted =
Sergey Silkin88ce4ef2018-11-23 13:59:24 +01001091 first_frame_in_picture_ ? false : is_inter_layer_pred_allowed;
Sergey Silkin6a8f30e2018-04-26 11:03:49 +02001092
Sergey Silkinc5f152d2018-09-26 13:28:50 +02001093 // Mark all low spatial layer frames as references (not just frames of
1094 // active low spatial layers) if inter-layer prediction is enabled since
1095 // these frames are indirect references of high spatial layer, which can
1096 // later be enabled without key frame.
Sergey Silkin6a8f30e2018-04-26 11:03:49 +02001097 vp9_info->non_ref_for_inter_layer_pred =
Sergey Silkinc5f152d2018-09-26 13:28:50 +02001098 !is_inter_layer_pred_allowed ||
1099 layer_id.spatial_layer_id + 1 == num_spatial_layers_;
asapersson00ac85e2015-11-11 05:30:48 -08001100
ivica7f6a6fc2015-09-08 02:40:29 -07001101 // Always populate this, so that the packetizer can properly set the marker
1102 // bit.
“Michael23c5a992018-06-21 11:07:21 -05001103 vp9_info->num_spatial_layers = num_active_spatial_layers_;
philipelcfc319b2015-11-10 07:17:23 -08001104
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +02001105 vp9_info->num_ref_pics = 0;
Ilya Nikolaevskiy2ec0c652019-01-18 11:56:48 +01001106 FillReferenceIndices(pkt, pics_since_key_, vp9_info->inter_layer_predicted,
1107 vp9_info);
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +02001108 if (vp9_info->flexible_mode) {
1109 vp9_info->gof_idx = kNoGofIdx;
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +02001110 } else {
1111 vp9_info->gof_idx =
1112 static_cast<uint8_t>(pics_since_key_ % gof_.num_frames_in_gof);
1113 vp9_info->temporal_up_switch = gof_.temporal_up_switch[vp9_info->gof_idx];
Ilya Nikolaevskiy2ec0c652019-01-18 11:56:48 +01001114 RTC_DCHECK(vp9_info->num_ref_pics == gof_.num_ref_pics[vp9_info->gof_idx] ||
1115 vp9_info->num_ref_pics == 0);
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +02001116 }
1117
1118 vp9_info->inter_pic_predicted = (!is_key_pic && vp9_info->num_ref_pics > 0);
1119
Sergey Silkina323cc02019-04-23 10:09:28 +02001120 // Write SS on key frame of independently coded spatial layers and on base
1121 // temporal/spatial layer frame if number of layers changed without issuing
1122 // of key picture (inter-layer prediction is enabled).
1123 const bool is_key_frame = is_key_pic && !vp9_info->inter_layer_predicted;
1124 if (is_key_frame || (ss_info_needed_ && layer_id.temporal_layer_id == 0 &&
1125 layer_id.spatial_layer_id == 0)) {
1126 vp9_info->ss_data_available = true;
asaperssona9455ab2015-07-31 06:10:09 -07001127 vp9_info->spatial_layer_resolution_present = true;
“Michael23c5a992018-06-21 11:07:21 -05001128 for (size_t i = 0; i < num_active_spatial_layers_; ++i) {
Yves Gerey665174f2018-06-19 15:03:05 +02001129 vp9_info->width[i] = codec_.width * svc_params_.scaling_factor_num[i] /
johannkoenig8225c402017-01-26 13:23:44 -08001130 svc_params_.scaling_factor_den[i];
Yves Gerey665174f2018-06-19 15:03:05 +02001131 vp9_info->height[i] = codec_.height * svc_params_.scaling_factor_num[i] /
johannkoenig8225c402017-01-26 13:23:44 -08001132 svc_params_.scaling_factor_den[i];
asaperssona9455ab2015-07-31 06:10:09 -07001133 }
Sergey Silkin738b7e92018-08-23 16:37:27 +02001134 if (vp9_info->flexible_mode) {
1135 vp9_info->gof.num_frames_in_gof = 0;
1136 } else {
asaperssona9455ab2015-07-31 06:10:09 -07001137 vp9_info->gof.CopyGofInfoVP9(gof_);
1138 }
Sergey Silkina323cc02019-04-23 10:09:28 +02001139
1140 ss_info_needed_ = false;
1141 } else {
1142 vp9_info->ss_data_available = false;
asaperssona9455ab2015-07-31 06:10:09 -07001143 }
Sergey Silkin88ce4ef2018-11-23 13:59:24 +01001144
1145 first_frame_in_picture_ = false;
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001146}
1147
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +02001148void VP9EncoderImpl::FillReferenceIndices(const vpx_codec_cx_pkt& pkt,
1149 const size_t pic_num,
1150 const bool inter_layer_predicted,
1151 CodecSpecificInfoVP9* vp9_info) {
1152 vpx_svc_layer_id_t layer_id = {0};
1153 vpx_codec_control(encoder_, VP9E_GET_SVC_LAYER_ID, &layer_id);
1154
Sergey Silkin76be2952018-08-21 12:30:33 +02001155 const bool is_key_frame =
1156 (pkt.data.frame.flags & VPX_FRAME_IS_KEY) ? true : false;
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +02001157
1158 std::vector<RefFrameBuffer> ref_buf_list;
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +02001159
Sergey Silkin76be2952018-08-21 12:30:33 +02001160 if (is_svc_) {
1161 vpx_svc_ref_frame_config_t enc_layer_conf = {{0}};
1162 vpx_codec_control(encoder_, VP9E_GET_SVC_REF_FRAME_CONFIG, &enc_layer_conf);
Sergey Silkin38fabff2019-03-21 10:08:40 +01001163 int ref_buf_flags = 0;
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +02001164
Sergey Silkin76be2952018-08-21 12:30:33 +02001165 if (enc_layer_conf.reference_last[layer_id.spatial_layer_id]) {
1166 const size_t fb_idx =
1167 enc_layer_conf.lst_fb_idx[layer_id.spatial_layer_id];
1168 RTC_DCHECK(ref_buf_.find(fb_idx) != ref_buf_.end());
Sergey Silkin82276592018-08-27 14:54:20 +02001169 if (std::find(ref_buf_list.begin(), ref_buf_list.end(),
1170 ref_buf_.at(fb_idx)) == ref_buf_list.end()) {
1171 ref_buf_list.push_back(ref_buf_.at(fb_idx));
Sergey Silkin38fabff2019-03-21 10:08:40 +01001172 ref_buf_flags |= 1 << fb_idx;
Sergey Silkin82276592018-08-27 14:54:20 +02001173 }
Sergey Silkin76be2952018-08-21 12:30:33 +02001174 }
1175
1176 if (enc_layer_conf.reference_alt_ref[layer_id.spatial_layer_id]) {
1177 const size_t fb_idx =
1178 enc_layer_conf.alt_fb_idx[layer_id.spatial_layer_id];
1179 RTC_DCHECK(ref_buf_.find(fb_idx) != ref_buf_.end());
Sergey Silkin82276592018-08-27 14:54:20 +02001180 if (std::find(ref_buf_list.begin(), ref_buf_list.end(),
1181 ref_buf_.at(fb_idx)) == ref_buf_list.end()) {
1182 ref_buf_list.push_back(ref_buf_.at(fb_idx));
Sergey Silkin38fabff2019-03-21 10:08:40 +01001183 ref_buf_flags |= 1 << fb_idx;
Sergey Silkin82276592018-08-27 14:54:20 +02001184 }
Sergey Silkin76be2952018-08-21 12:30:33 +02001185 }
1186
1187 if (enc_layer_conf.reference_golden[layer_id.spatial_layer_id]) {
1188 const size_t fb_idx =
1189 enc_layer_conf.gld_fb_idx[layer_id.spatial_layer_id];
1190 RTC_DCHECK(ref_buf_.find(fb_idx) != ref_buf_.end());
Sergey Silkin82276592018-08-27 14:54:20 +02001191 if (std::find(ref_buf_list.begin(), ref_buf_list.end(),
1192 ref_buf_.at(fb_idx)) == ref_buf_list.end()) {
1193 ref_buf_list.push_back(ref_buf_.at(fb_idx));
Sergey Silkin38fabff2019-03-21 10:08:40 +01001194 ref_buf_flags |= 1 << fb_idx;
Sergey Silkin82276592018-08-27 14:54:20 +02001195 }
Sergey Silkin76be2952018-08-21 12:30:33 +02001196 }
Sergey Silkin38fabff2019-03-21 10:08:40 +01001197
1198 RTC_LOG(LS_VERBOSE) << "Frame " << pic_num << " sl "
1199 << layer_id.spatial_layer_id << " tl "
1200 << layer_id.temporal_layer_id << " refered buffers "
1201 << (ref_buf_flags & (1 << 0) ? 1 : 0)
1202 << (ref_buf_flags & (1 << 1) ? 1 : 0)
1203 << (ref_buf_flags & (1 << 2) ? 1 : 0)
1204 << (ref_buf_flags & (1 << 3) ? 1 : 0)
1205 << (ref_buf_flags & (1 << 4) ? 1 : 0)
1206 << (ref_buf_flags & (1 << 5) ? 1 : 0)
1207 << (ref_buf_flags & (1 << 6) ? 1 : 0)
1208 << (ref_buf_flags & (1 << 7) ? 1 : 0);
1209
Sergey Silkin76be2952018-08-21 12:30:33 +02001210 } else if (!is_key_frame) {
1211 RTC_DCHECK_EQ(num_spatial_layers_, 1);
1212 RTC_DCHECK_EQ(num_temporal_layers_, 1);
1213 // In non-SVC mode encoder doesn't provide reference list. Assume each frame
1214 // refers previous one, which is stored in buffer 0.
1215 ref_buf_list.push_back(ref_buf_.at(0));
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +02001216 }
1217
1218 size_t max_ref_temporal_layer_id = 0;
1219
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +01001220 std::vector<size_t> ref_pid_list;
1221
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +02001222 vp9_info->num_ref_pics = 0;
1223 for (const RefFrameBuffer& ref_buf : ref_buf_list) {
1224 RTC_DCHECK_LE(ref_buf.pic_num, pic_num);
1225 if (ref_buf.pic_num < pic_num) {
1226 if (inter_layer_pred_ != InterLayerPredMode::kOn) {
1227 // RTP spec limits temporal prediction to the same spatial layer.
1228 // It is safe to ignore this requirement if inter-layer prediction is
1229 // enabled for all frames when all base frames are relayed to receiver.
1230 RTC_DCHECK_EQ(ref_buf.spatial_layer_id, layer_id.spatial_layer_id);
Ilya Nikolaevskiy5c18a5f2019-05-24 11:51:31 +02001231 } else {
1232 RTC_DCHECK_LE(ref_buf.spatial_layer_id, layer_id.spatial_layer_id);
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +02001233 }
1234 RTC_DCHECK_LE(ref_buf.temporal_layer_id, layer_id.temporal_layer_id);
1235
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +01001236 // Encoder may reference several spatial layers on the same previous
1237 // frame in case if some spatial layers are skipped on the current frame.
1238 // We shouldn't put duplicate references as it may break some old
1239 // clients and isn't RTP compatible.
1240 if (std::find(ref_pid_list.begin(), ref_pid_list.end(),
1241 ref_buf.pic_num) != ref_pid_list.end()) {
1242 continue;
1243 }
1244 ref_pid_list.push_back(ref_buf.pic_num);
1245
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +02001246 const size_t p_diff = pic_num - ref_buf.pic_num;
1247 RTC_DCHECK_LE(p_diff, 127UL);
1248
1249 vp9_info->p_diff[vp9_info->num_ref_pics] = static_cast<uint8_t>(p_diff);
1250 ++vp9_info->num_ref_pics;
1251
1252 max_ref_temporal_layer_id =
1253 std::max(max_ref_temporal_layer_id, ref_buf.temporal_layer_id);
1254 } else {
1255 RTC_DCHECK(inter_layer_predicted);
1256 // RTP spec only allows to use previous spatial layer for inter-layer
1257 // prediction.
1258 RTC_DCHECK_EQ(ref_buf.spatial_layer_id + 1, layer_id.spatial_layer_id);
1259 }
1260 }
1261
1262 vp9_info->temporal_up_switch =
1263 (max_ref_temporal_layer_id <
1264 static_cast<size_t>(layer_id.temporal_layer_id));
1265}
1266
1267void VP9EncoderImpl::UpdateReferenceBuffers(const vpx_codec_cx_pkt& pkt,
1268 const size_t pic_num) {
1269 vpx_svc_layer_id_t layer_id = {0};
1270 vpx_codec_control(encoder_, VP9E_GET_SVC_LAYER_ID, &layer_id);
1271
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +02001272 RefFrameBuffer frame_buf(pic_num, layer_id.spatial_layer_id,
1273 layer_id.temporal_layer_id);
1274
Sergey Silkin38fabff2019-03-21 10:08:40 +01001275 if (is_svc_) {
Sergey Silkin76be2952018-08-21 12:30:33 +02001276 vpx_svc_ref_frame_config_t enc_layer_conf = {{0}};
1277 vpx_codec_control(encoder_, VP9E_GET_SVC_REF_FRAME_CONFIG, &enc_layer_conf);
Sergey Silkin38fabff2019-03-21 10:08:40 +01001278 const int update_buffer_slot =
1279 enc_layer_conf.update_buffer_slot[layer_id.spatial_layer_id];
Sergey Silkin76be2952018-08-21 12:30:33 +02001280
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +01001281 for (size_t i = 0; i < kNumVp9Buffers; ++i) {
Sergey Silkin38fabff2019-03-21 10:08:40 +01001282 if (update_buffer_slot & (1 << i)) {
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +01001283 ref_buf_[i] = frame_buf;
1284 }
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +02001285 }
Sergey Silkin38fabff2019-03-21 10:08:40 +01001286
1287 RTC_LOG(LS_VERBOSE) << "Frame " << pic_num << " sl "
1288 << layer_id.spatial_layer_id << " tl "
1289 << layer_id.temporal_layer_id << " updated buffers "
1290 << (update_buffer_slot & (1 << 0) ? 1 : 0)
1291 << (update_buffer_slot & (1 << 1) ? 1 : 0)
1292 << (update_buffer_slot & (1 << 2) ? 1 : 0)
1293 << (update_buffer_slot & (1 << 3) ? 1 : 0)
1294 << (update_buffer_slot & (1 << 4) ? 1 : 0)
1295 << (update_buffer_slot & (1 << 5) ? 1 : 0)
1296 << (update_buffer_slot & (1 << 6) ? 1 : 0)
1297 << (update_buffer_slot & (1 << 7) ? 1 : 0);
Sergey Silkin76be2952018-08-21 12:30:33 +02001298 } else {
1299 RTC_DCHECK_EQ(num_spatial_layers_, 1);
1300 RTC_DCHECK_EQ(num_temporal_layers_, 1);
1301 // In non-svc mode encoder doesn't provide reference list. Assume each frame
1302 // is reference and stored in buffer 0.
1303 ref_buf_[0] = frame_buf;
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +02001304 }
1305}
1306
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +01001307vpx_svc_ref_frame_config_t VP9EncoderImpl::SetReferences(
1308 bool is_key_pic,
1309 size_t first_active_spatial_layer_id) {
Sergey Silkin390f3582018-10-01 17:13:50 +02001310 // kRefBufIdx, kUpdBufIdx need to be updated to support longer GOFs.
1311 RTC_DCHECK_LE(gof_.num_frames_in_gof, 4);
1312
1313 vpx_svc_ref_frame_config_t ref_config;
1314 memset(&ref_config, 0, sizeof(ref_config));
1315
1316 const size_t num_temporal_refs = std::max(1, num_temporal_layers_ - 1);
1317 const bool is_inter_layer_pred_allowed =
1318 inter_layer_pred_ == InterLayerPredMode::kOn ||
1319 (inter_layer_pred_ == InterLayerPredMode::kOnKeyPic && is_key_pic);
1320 absl::optional<int> last_updated_buf_idx;
1321
1322 // Put temporal reference to LAST and spatial reference to GOLDEN. Update
1323 // frame buffer (i.e. store encoded frame) if current frame is a temporal
1324 // reference (i.e. it belongs to a low temporal layer) or it is a spatial
1325 // reference. In later case, always store spatial reference in the last
1326 // reference frame buffer.
1327 // For the case of 3 temporal and 3 spatial layers we need 6 frame buffers
1328 // for temporal references plus 1 buffer for spatial reference. 7 buffers
1329 // in total.
1330
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +01001331 for (size_t sl_idx = first_active_spatial_layer_id;
1332 sl_idx < num_active_spatial_layers_; ++sl_idx) {
1333 const size_t curr_pic_num = is_key_pic ? 0 : pics_since_key_ + 1;
1334 const size_t gof_idx = curr_pic_num % gof_.num_frames_in_gof;
Sergey Silkin390f3582018-10-01 17:13:50 +02001335
1336 if (!is_key_pic) {
1337 // Set up temporal reference.
1338 const int buf_idx = sl_idx * num_temporal_refs + kRefBufIdx[gof_idx];
1339
1340 // Last reference frame buffer is reserved for spatial reference. It is
1341 // not supposed to be used for temporal prediction.
1342 RTC_DCHECK_LT(buf_idx, kNumVp9Buffers - 1);
1343
1344 // Sanity check that reference picture number is smaller than current
1345 // picture number.
Sergey Silkin390f3582018-10-01 17:13:50 +02001346 RTC_DCHECK_LT(ref_buf_[buf_idx].pic_num, curr_pic_num);
1347 const size_t pid_diff = curr_pic_num - ref_buf_[buf_idx].pic_num;
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +01001348 // Incorrect spatial layer may be in the buffer due to a key-frame.
1349 const bool same_spatial_layer =
1350 ref_buf_[buf_idx].spatial_layer_id == sl_idx;
1351 bool correct_pid = false;
Ilya Nikolaevskiy5c18a5f2019-05-24 11:51:31 +02001352 if (is_flexible_mode_) {
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +01001353 correct_pid = pid_diff < kMaxAllowedPidDIff;
1354 } else {
1355 // Below code assumes single temporal referecence.
1356 RTC_DCHECK_EQ(gof_.num_ref_pics[gof_idx], 1);
1357 correct_pid = pid_diff == gof_.pid_diff[gof_idx][0];
1358 }
Sergey Silkin390f3582018-10-01 17:13:50 +02001359
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +01001360 if (same_spatial_layer && correct_pid) {
Sergey Silkin390f3582018-10-01 17:13:50 +02001361 ref_config.lst_fb_idx[sl_idx] = buf_idx;
1362 ref_config.reference_last[sl_idx] = 1;
1363 } else {
1364 // This reference doesn't match with one specified by GOF. This can
1365 // only happen if spatial layer is enabled dynamically without key
1366 // frame. Spatial prediction is supposed to be enabled in this case.
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +01001367 RTC_DCHECK(is_inter_layer_pred_allowed &&
1368 sl_idx > first_active_spatial_layer_id);
Sergey Silkin390f3582018-10-01 17:13:50 +02001369 }
1370 }
1371
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +01001372 if (is_inter_layer_pred_allowed && sl_idx > first_active_spatial_layer_id) {
Sergey Silkin390f3582018-10-01 17:13:50 +02001373 // Set up spatial reference.
1374 RTC_DCHECK(last_updated_buf_idx);
1375 ref_config.gld_fb_idx[sl_idx] = *last_updated_buf_idx;
1376 ref_config.reference_golden[sl_idx] = 1;
1377 } else {
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +01001378 RTC_DCHECK(ref_config.reference_last[sl_idx] != 0 ||
1379 sl_idx == first_active_spatial_layer_id ||
Sergey Silkin390f3582018-10-01 17:13:50 +02001380 inter_layer_pred_ == InterLayerPredMode::kOff);
1381 }
1382
1383 last_updated_buf_idx.reset();
1384
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +01001385 if (gof_.temporal_idx[gof_idx] < num_temporal_layers_ - 1 ||
1386 num_temporal_layers_ == 1) {
Sergey Silkin390f3582018-10-01 17:13:50 +02001387 last_updated_buf_idx = sl_idx * num_temporal_refs + kUpdBufIdx[gof_idx];
1388
1389 // Ensure last frame buffer is not used for temporal prediction (it is
1390 // reserved for spatial reference).
1391 RTC_DCHECK_LT(*last_updated_buf_idx, kNumVp9Buffers - 1);
1392 } else if (is_inter_layer_pred_allowed) {
1393 last_updated_buf_idx = kNumVp9Buffers - 1;
1394 }
1395
1396 if (last_updated_buf_idx) {
1397 ref_config.update_buffer_slot[sl_idx] = 1 << *last_updated_buf_idx;
1398 }
1399 }
1400
1401 return ref_config;
1402}
1403
asaperssona9455ab2015-07-31 06:10:09 -07001404int VP9EncoderImpl::GetEncodedLayerFrame(const vpx_codec_cx_pkt* pkt) {
asapersson86956de2016-01-26 01:05:20 -08001405 RTC_DCHECK_EQ(pkt->kind, VPX_CODEC_CX_FRAME_PKT);
asaperssona9455ab2015-07-31 06:10:09 -07001406
Sergey Silkin2a1f1832018-04-04 11:45:41 +02001407 if (pkt->data.frame.sz == 0) {
1408 // Ignore dropped frame.
1409 return WEBRTC_VIDEO_CODEC_OK;
1410 }
1411
Sergey Silkin07f80cc2018-04-09 13:11:59 +02001412 vpx_svc_layer_id_t layer_id = {0};
1413 vpx_codec_control(encoder_, VP9E_GET_SVC_LAYER_ID, &layer_id);
1414
Sergey Silkin88ce4ef2018-11-23 13:59:24 +01001415 if (!full_superframe_drop_) {
1416 // Deliver buffered low spatial layer frame.
1417 const bool end_of_picture = false;
1418 DeliverBufferedFrame(end_of_picture);
1419 }
Sergey Silkin2a1f1832018-04-04 11:45:41 +02001420
Niels Möller4d504c72019-06-18 15:56:56 +02001421 // TODO(nisse): Introduce some buffer cache or buffer pool, to reduce
1422 // allocations and/or copy operations.
1423 encoded_image_.SetEncodedData(EncodedImageBuffer::Create(
1424 static_cast<const uint8_t*>(pkt->data.frame.buf), pkt->data.frame.sz));
asaperssond9f641e2016-01-21 01:11:35 -08001425
Sergey Silkinbd0954e2018-05-03 14:14:09 +02001426 const bool is_key_frame =
1427 (pkt->data.frame.flags & VPX_FRAME_IS_KEY) ? true : false;
1428 // Ensure encoder issued key frame on request.
1429 RTC_DCHECK(is_key_frame || !force_key_frame_);
1430
asaperssona9455ab2015-07-31 06:10:09 -07001431 // Check if encoded frame is a key frame.
Niels Möller8f7ce222019-03-21 15:43:58 +01001432 encoded_image_._frameType = VideoFrameType::kVideoFrameDelta;
Sergey Silkinbd0954e2018-05-03 14:14:09 +02001433 if (is_key_frame) {
Niels Möller8f7ce222019-03-21 15:43:58 +01001434 encoded_image_._frameType = VideoFrameType::kVideoFrameKey;
Sergey Silkinbd0954e2018-05-03 14:14:09 +02001435 force_key_frame_ = false;
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001436 }
Niels Möller77536a22019-01-15 08:50:01 +01001437 RTC_DCHECK_LE(encoded_image_.size(), encoded_image_.capacity());
asapersson86956de2016-01-26 01:05:20 -08001438
philipeld1d03592019-03-01 13:53:55 +01001439 codec_specific_ = {};
Niels Möllerd3b8c632018-08-27 15:33:42 +02001440 absl::optional<int> spatial_index;
1441 PopulateCodecSpecific(&codec_specific_, &spatial_index, *pkt,
Sergey Silkin88ce4ef2018-11-23 13:59:24 +01001442 input_image_->timestamp());
Niels Möllerd3b8c632018-08-27 15:33:42 +02001443 encoded_image_.SetSpatialIndex(spatial_index);
asaperssona9455ab2015-07-31 06:10:09 -07001444
Ilya Nikolaevskiy2ec0c652019-01-18 11:56:48 +01001445 UpdateReferenceBuffers(*pkt, pics_since_key_);
Sergey Silkin4e6cd5e2018-05-28 12:26:36 +02001446
Niels Möller77536a22019-01-15 08:50:01 +01001447 TRACE_COUNTER1("webrtc", "EncodedFrameSize", encoded_image_.size());
Niels Möller23775882018-08-16 10:24:12 +02001448 encoded_image_.SetTimestamp(input_image_->timestamp());
Sergey Silkin2a1f1832018-04-04 11:45:41 +02001449 encoded_image_._encodedHeight =
1450 pkt->data.frame.height[layer_id.spatial_layer_id];
1451 encoded_image_._encodedWidth =
1452 pkt->data.frame.width[layer_id.spatial_layer_id];
Sergey Silkin2a1f1832018-04-04 11:45:41 +02001453 int qp = -1;
1454 vpx_codec_control(encoder_, VP8E_GET_LAST_QUANTIZER, &qp);
1455 encoded_image_.qp_ = qp;
ilnik04f4d122017-06-19 07:18:55 -07001456
Sergey Silkin88ce4ef2018-11-23 13:59:24 +01001457 if (full_superframe_drop_) {
1458 const bool end_of_picture = encoded_image_.SpatialIndex().value_or(0) + 1 ==
1459 num_active_spatial_layers_;
1460 DeliverBufferedFrame(end_of_picture);
1461 }
1462
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001463 return WEBRTC_VIDEO_CODEC_OK;
1464}
1465
Sergey Silkinbc0f0d32018-04-24 21:29:14 +02001466void VP9EncoderImpl::DeliverBufferedFrame(bool end_of_picture) {
Niels Möller77536a22019-01-15 08:50:01 +01001467 if (encoded_image_.size() > 0) {
Ilya Nikolaevskiy039a7142019-05-24 16:50:00 +02001468 if (num_spatial_layers_ > 1) {
1469 // Restore frame dropping settings, as dropping may be temporary forbidden
1470 // due to dynamically enabled layers.
1471 svc_drop_frame_.framedrop_thresh[0] = config_->rc_dropframe_thresh;
1472 for (size_t i = 1; i < num_spatial_layers_; ++i) {
1473 svc_drop_frame_.framedrop_thresh[i] =
1474 dropping_only_base_layer_ ? 0 : config_->rc_dropframe_thresh;
1475 }
1476 }
1477
Sergey Silkinbc0f0d32018-04-24 21:29:14 +02001478 codec_specific_.codecSpecific.VP9.end_of_picture = end_of_picture;
Sergey Silkin2a1f1832018-04-04 11:45:41 +02001479
1480 // No data partitioning in VP9, so 1 partition only.
1481 int part_idx = 0;
1482 RTPFragmentationHeader frag_info;
1483 frag_info.VerifyAndAllocateFragmentationHeader(1);
1484 frag_info.fragmentationOffset[part_idx] = 0;
Niels Möller77536a22019-01-15 08:50:01 +01001485 frag_info.fragmentationLength[part_idx] = encoded_image_.size();
Sergey Silkin2a1f1832018-04-04 11:45:41 +02001486
1487 encoded_complete_callback_->OnEncodedImage(encoded_image_, &codec_specific_,
1488 &frag_info);
Sergey Silkind902d582018-05-18 17:31:19 +02001489
Sergey Silkin96f2c972018-09-05 21:07:17 +02001490 if (codec_.mode == VideoCodecMode::kScreensharing) {
1491 const uint8_t spatial_idx = encoded_image_.SpatialIndex().value_or(0);
1492 const uint32_t frame_timestamp_ms =
Niels Möller23775882018-08-16 10:24:12 +02001493 1000 * encoded_image_.Timestamp() / kVideoPayloadTypeFrequency;
Sergey Silkin96f2c972018-09-05 21:07:17 +02001494 framerate_controller_[spatial_idx].AddFrame(frame_timestamp_ms);
Ilya Nikolaevskiy61170682019-03-06 16:04:32 +01001495
1496 const size_t steady_state_size = SteadyStateSize(
1497 spatial_idx, codec_specific_.codecSpecific.VP9.temporal_idx);
1498
1499 // Only frames on spatial layers, which may be limited in a steady state
1500 // are considered for steady state detection.
1501 if (framerate_controller_[spatial_idx].GetTargetRate() >
1502 variable_framerate_experiment_.framerate_limit + 1e-9) {
1503 if (encoded_image_.qp_ <=
1504 variable_framerate_experiment_.steady_state_qp &&
1505 encoded_image_.size() <= steady_state_size) {
1506 ++num_steady_state_frames_;
1507 } else {
1508 num_steady_state_frames_ = 0;
1509 }
1510 }
Sergey Silkind902d582018-05-18 17:31:19 +02001511 }
Ilya Nikolaevskiy61170682019-03-06 16:04:32 +01001512 encoded_image_.set_size(0);
Sergey Silkin2a1f1832018-04-04 11:45:41 +02001513 }
1514}
1515
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001516int VP9EncoderImpl::RegisterEncodeCompleteCallback(
1517 EncodedImageCallback* callback) {
1518 encoded_complete_callback_ = callback;
1519 return WEBRTC_VIDEO_CODEC_OK;
1520}
1521
Erik Språng727d1642018-11-07 16:54:15 +01001522VideoEncoder::EncoderInfo VP9EncoderImpl::GetEncoderInfo() const {
1523 EncoderInfo info;
1524 info.supports_native_handle = false;
1525 info.implementation_name = "libvpx";
1526 info.scaling_settings = VideoEncoder::ScalingSettings::kOff;
Erik Språngd3438aa2018-11-08 16:56:43 +01001527 info.has_trusted_rate_controller = trusted_rate_controller_;
Mirta Dvornicic897a9912018-11-30 13:12:21 +01001528 info.is_hardware_accelerated = false;
1529 info.has_internal_source = false;
Erik Språngdbdd8392019-01-17 15:27:50 +01001530 for (size_t si = 0; si < num_spatial_layers_; ++si) {
1531 info.fps_allocation[si].clear();
1532 if (!codec_.spatialLayers[si].active) {
1533 continue;
1534 }
1535 // This spatial layer may already use a fraction of the total frame rate.
1536 const float sl_fps_fraction =
1537 codec_.spatialLayers[si].maxFramerate / codec_.maxFramerate;
1538 for (size_t ti = 0; ti < num_temporal_layers_; ++ti) {
1539 const uint32_t decimator =
1540 num_temporal_layers_ <= 1 ? 1 : config_->ts_rate_decimator[ti];
1541 RTC_DCHECK_GT(decimator, 0);
1542 info.fps_allocation[si].push_back(rtc::saturated_cast<uint8_t>(
1543 EncoderInfo::kMaxFramerateFraction * (sl_fps_fraction / decimator)));
1544 }
1545 }
Erik Språng727d1642018-11-07 16:54:15 +01001546 return info;
Peter Boströmb7d9a972015-12-18 16:01:11 +01001547}
1548
Ilya Nikolaevskiy61170682019-03-06 16:04:32 +01001549size_t VP9EncoderImpl::SteadyStateSize(int sid, int tid) {
1550 const size_t bitrate_bps = current_bitrate_allocation_.GetBitrate(
1551 sid, tid == kNoTemporalIdx ? 0 : tid);
1552 const float fps = (codec_.mode == VideoCodecMode::kScreensharing)
Ilya Nikolaevskiy5c18a5f2019-05-24 11:51:31 +02001553 ? std::min(static_cast<float>(codec_.maxFramerate),
1554 framerate_controller_[sid].GetTargetRate())
Ilya Nikolaevskiy61170682019-03-06 16:04:32 +01001555 : codec_.maxFramerate;
1556 return static_cast<size_t>(
1557 bitrate_bps / (8 * fps) *
1558 (100 -
1559 variable_framerate_experiment_.steady_state_undershoot_percentage) /
1560 100 +
1561 0.5);
1562}
1563
1564// static
1565VP9EncoderImpl::VariableFramerateExperiment
1566VP9EncoderImpl::ParseVariableFramerateConfig(std::string group_name) {
1567 FieldTrialFlag enabled = FieldTrialFlag("Enabled");
1568 FieldTrialParameter<double> framerate_limit("min_fps", 5.0);
1569 FieldTrialParameter<int> qp("min_qp", 32);
1570 FieldTrialParameter<int> undershoot_percentage("undershoot", 30);
1571 FieldTrialParameter<int> frames_before_steady_state(
1572 "frames_before_steady_state", 5);
1573 ParseFieldTrial({&enabled, &framerate_limit, &qp, &undershoot_percentage,
1574 &frames_before_steady_state},
1575 field_trial::FindFullName(group_name));
1576 VariableFramerateExperiment config;
1577 config.enabled = enabled.Get();
1578 config.framerate_limit = framerate_limit.Get();
1579 config.steady_state_qp = qp.Get();
1580 config.steady_state_undershoot_percentage = undershoot_percentage.Get();
1581 config.frames_before_steady_state = frames_before_steady_state.Get();
1582
1583 return config;
1584}
1585
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001586VP9DecoderImpl::VP9DecoderImpl()
sprang3958ed82017-08-17 08:12:10 -07001587 : decode_complete_callback_(nullptr),
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001588 inited_(false),
sprang3958ed82017-08-17 08:12:10 -07001589 decoder_(nullptr),
philipel9d7d75b2018-04-04 13:03:01 +02001590 key_frame_required_(true) {}
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001591
1592VP9DecoderImpl::~VP9DecoderImpl() {
1593 inited_ = true; // in order to do the actual release
1594 Release();
Henrik Boström9695d852015-05-06 10:42:15 +02001595 int num_buffers_in_use = frame_buffer_pool_.GetNumBuffersInUse();
1596 if (num_buffers_in_use > 0) {
1597 // The frame buffers are reference counted and frames are exposed after
1598 // decoding. There may be valid usage cases where previous frames are still
1599 // referenced after ~VP9DecoderImpl that is not a leak.
Mirko Bonadei675513b2017-11-09 11:09:25 +01001600 RTC_LOG(LS_INFO) << num_buffers_in_use << " Vp9FrameBuffers are still "
1601 << "referenced during ~VP9DecoderImpl.";
Henrik Boström9695d852015-05-06 10:42:15 +02001602 }
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001603}
1604
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001605int VP9DecoderImpl::InitDecode(const VideoCodec* inst, int number_of_cores) {
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001606 int ret_val = Release();
1607 if (ret_val < 0) {
1608 return ret_val;
1609 }
Sergey Silkinb674cd12018-10-09 10:59:06 +02001610
sprang3958ed82017-08-17 08:12:10 -07001611 if (decoder_ == nullptr) {
pbos@webrtc.orge728ee02014-12-17 13:43:55 +00001612 decoder_ = new vpx_codec_ctx_t;
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001613 }
philipelcce46fc2015-12-21 03:04:49 -08001614 vpx_codec_dec_cfg_t cfg;
Sergey Silkinb674cd12018-10-09 10:59:06 +02001615 memset(&cfg, 0, sizeof(cfg));
1616
1617 // We want to use multithreading when decoding high resolution videos. But,
1618 // since we don't know resolution of input stream at this stage, we always
1619 // enable it.
1620 cfg.threads = std::min(number_of_cores, kMaxNumTiles4kVideo);
1621
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001622 vpx_codec_flags_t flags = 0;
1623 if (vpx_codec_dec_init(decoder_, vpx_codec_vp9_dx(), &cfg, flags)) {
1624 return WEBRTC_VIDEO_CODEC_MEMORY;
1625 }
Henrik Boström9695d852015-05-06 10:42:15 +02001626
1627 if (!frame_buffer_pool_.InitializeVpxUsePool(decoder_)) {
1628 return WEBRTC_VIDEO_CODEC_MEMORY;
1629 }
1630
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001631 inited_ = true;
1632 // Always start with a complete key frame.
1633 key_frame_required_ = true;
1634 return WEBRTC_VIDEO_CODEC_OK;
1635}
1636
1637int VP9DecoderImpl::Decode(const EncodedImage& input_image,
1638 bool missing_frames,
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001639 int64_t /*render_time_ms*/) {
1640 if (!inited_) {
1641 return WEBRTC_VIDEO_CODEC_UNINITIALIZED;
1642 }
sprang3958ed82017-08-17 08:12:10 -07001643 if (decode_complete_callback_ == nullptr) {
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001644 return WEBRTC_VIDEO_CODEC_UNINITIALIZED;
1645 }
1646 // Always start with a complete key frame.
1647 if (key_frame_required_) {
Niels Möller8f7ce222019-03-21 15:43:58 +01001648 if (input_image._frameType != VideoFrameType::kVideoFrameKey)
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001649 return WEBRTC_VIDEO_CODEC_ERROR;
1650 // We have a key frame - is it complete?
1651 if (input_image._completeFrame) {
1652 key_frame_required_ = false;
1653 } else {
1654 return WEBRTC_VIDEO_CODEC_ERROR;
1655 }
1656 }
sprang3958ed82017-08-17 08:12:10 -07001657 vpx_codec_iter_t iter = nullptr;
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001658 vpx_image_t* img;
Niels Möller24871e42019-01-17 11:31:13 +01001659 const uint8_t* buffer = input_image.data();
Niels Möller77536a22019-01-15 08:50:01 +01001660 if (input_image.size() == 0) {
sprang3958ed82017-08-17 08:12:10 -07001661 buffer = nullptr; // Triggers full frame concealment.
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001662 }
Henrik Boström9695d852015-05-06 10:42:15 +02001663 // During decode libvpx may get and release buffers from |frame_buffer_pool_|.
1664 // In practice libvpx keeps a few (~3-4) buffers alive at a time.
philipelcce46fc2015-12-21 03:04:49 -08001665 if (vpx_codec_decode(decoder_, buffer,
Niels Möller77536a22019-01-15 08:50:01 +01001666 static_cast<unsigned int>(input_image.size()), 0,
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001667 VPX_DL_REALTIME)) {
1668 return WEBRTC_VIDEO_CODEC_ERROR;
1669 }
Henrik Boström9695d852015-05-06 10:42:15 +02001670 // |img->fb_priv| contains the image data, a reference counted Vp9FrameBuffer.
1671 // It may be released by libvpx during future vpx_codec_decode or
1672 // vpx_codec_destroy calls.
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001673 img = vpx_codec_get_frame(decoder_, &iter);
sakal7adadb12017-02-23 02:54:57 -08001674 int qp;
1675 vpx_codec_err_t vpx_ret =
1676 vpx_codec_control(decoder_, VPXD_GET_LAST_QUANTIZER, &qp);
1677 RTC_DCHECK_EQ(vpx_ret, VPX_CODEC_OK);
Ilya Nikolaevskiyab62b2e2019-06-05 15:55:51 +02001678 int ret = ReturnFrame(img, input_image.Timestamp(), qp);
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001679 if (ret != 0) {
1680 return ret;
1681 }
1682 return WEBRTC_VIDEO_CODEC_OK;
1683}
1684
Ilya Nikolaevskiyab62b2e2019-06-05 15:55:51 +02001685int VP9DecoderImpl::ReturnFrame(const vpx_image_t* img,
1686 uint32_t timestamp,
1687 int qp) {
sprang3958ed82017-08-17 08:12:10 -07001688 if (img == nullptr) {
1689 // Decoder OK and nullptr image => No show frame.
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001690 return WEBRTC_VIDEO_CODEC_NO_OUTPUT;
1691 }
Henrik Boström9695d852015-05-06 10:42:15 +02001692
1693 // This buffer contains all of |img|'s image data, a reference counted
perkj14f41442015-11-30 22:15:45 -08001694 // Vp9FrameBuffer. (libvpx is done with the buffers after a few
Henrik Boström9695d852015-05-06 10:42:15 +02001695 // vpx_codec_decode calls or vpx_codec_destroy).
1696 Vp9FrameBufferPool::Vp9FrameBuffer* img_buffer =
1697 static_cast<Vp9FrameBufferPool::Vp9FrameBuffer*>(img->fb_priv);
Emircan Uysaler0823eec2018-07-13 17:10:00 -07001698
Miguel Casas-Sanchez47650702015-05-29 17:21:40 -07001699 // The buffer can be used directly by the VideoFrame (without copy) by
Emircan Uysaler0823eec2018-07-13 17:10:00 -07001700 // using a Wrapped*Buffer.
1701 rtc::scoped_refptr<VideoFrameBuffer> img_wrapped_buffer;
1702 switch (img->bit_depth) {
1703 case 8:
1704 img_wrapped_buffer = WrapI420Buffer(
philipelcce46fc2015-12-21 03:04:49 -08001705 img->d_w, img->d_h, img->planes[VPX_PLANE_Y],
1706 img->stride[VPX_PLANE_Y], img->planes[VPX_PLANE_U],
1707 img->stride[VPX_PLANE_U], img->planes[VPX_PLANE_V],
1708 img->stride[VPX_PLANE_V],
Henrik Boström9695d852015-05-06 10:42:15 +02001709 // WrappedI420Buffer's mechanism for allowing the release of its frame
1710 // buffer is through a callback function. This is where we should
1711 // release |img_buffer|.
Emircan Uysaler0823eec2018-07-13 17:10:00 -07001712 rtc::KeepRefUntilDone(img_buffer));
1713 break;
1714 case 10:
1715 img_wrapped_buffer = WrapI010Buffer(
1716 img->d_w, img->d_h,
1717 reinterpret_cast<const uint16_t*>(img->planes[VPX_PLANE_Y]),
1718 img->stride[VPX_PLANE_Y] / 2,
1719 reinterpret_cast<const uint16_t*>(img->planes[VPX_PLANE_U]),
1720 img->stride[VPX_PLANE_U] / 2,
1721 reinterpret_cast<const uint16_t*>(img->planes[VPX_PLANE_V]),
1722 img->stride[VPX_PLANE_V] / 2, rtc::KeepRefUntilDone(img_buffer));
1723 break;
1724 default:
1725 RTC_NOTREACHED();
1726 return WEBRTC_VIDEO_CODEC_NO_OUTPUT;
1727 }
nisseca6d5d12016-06-17 05:03:04 -07001728
Johannes Kron4749e4e2018-11-21 10:18:18 +01001729 auto builder = VideoFrame::Builder()
1730 .set_video_frame_buffer(img_wrapped_buffer)
Johannes Kron4749e4e2018-11-21 10:18:18 +01001731 .set_timestamp_rtp(timestamp)
Ilya Nikolaevskiyab62b2e2019-06-05 15:55:51 +02001732 .set_color_space(ExtractVP9ColorSpace(img->cs, img->range,
1733 img->bit_depth));
Johannes Kron4749e4e2018-11-21 10:18:18 +01001734
1735 VideoFrame decoded_image = builder.build();
1736
Danil Chapovalov0040b662018-06-18 10:48:16 +02001737 decode_complete_callback_->Decoded(decoded_image, absl::nullopt, qp);
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001738 return WEBRTC_VIDEO_CODEC_OK;
1739}
1740
1741int VP9DecoderImpl::RegisterDecodeCompleteCallback(
1742 DecodedImageCallback* callback) {
1743 decode_complete_callback_ = callback;
1744 return WEBRTC_VIDEO_CODEC_OK;
1745}
1746
1747int VP9DecoderImpl::Release() {
Sergey Silkin3e871ea2018-03-02 13:11:04 +01001748 int ret_val = WEBRTC_VIDEO_CODEC_OK;
1749
sprang3958ed82017-08-17 08:12:10 -07001750 if (decoder_ != nullptr) {
Sergey Silkin90399692018-03-02 14:44:10 +01001751 if (inited_) {
1752 // When a codec is destroyed libvpx will release any buffers of
1753 // |frame_buffer_pool_| it is currently using.
1754 if (vpx_codec_destroy(decoder_)) {
1755 ret_val = WEBRTC_VIDEO_CODEC_MEMORY;
1756 }
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001757 }
1758 delete decoder_;
sprang3958ed82017-08-17 08:12:10 -07001759 decoder_ = nullptr;
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001760 }
Henrik Boström9695d852015-05-06 10:42:15 +02001761 // Releases buffers from the pool. Any buffers not in use are deleted. Buffers
1762 // still referenced externally are deleted once fully released, not returning
1763 // to the pool.
1764 frame_buffer_pool_.ClearPool();
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001765 inited_ = false;
Sergey Silkin3e871ea2018-03-02 13:11:04 +01001766 return ret_val;
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001767}
Peter Boströmb7d9a972015-12-18 16:01:11 +01001768
1769const char* VP9DecoderImpl::ImplementationName() const {
1770 return "libvpx";
1771}
1772
marpan@webrtc.org5b883172014-11-01 06:10:48 +00001773} // namespace webrtc
Mirko Bonadei95adedb2018-11-19 09:52:37 +01001774
1775#endif // RTC_ENABLE_VP9