2 * Copyright (c) 2012 The WebM project authors. All Rights Reserved.
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.
11 // This is an example demonstrating how to implement a multi-layer VPx
12 // encoding scheme based on temporal scalability for video applications
13 // that benefit from a scalable bitstream.
21 #include "./vpx_config.h"
22 #include "../vpx_ports/vpx_timer.h"
23 #include "vpx/vp8cx.h"
24 #include "vpx/vpx_encoder.h"
26 #include "../tools_common.h"
27 #include "../video_writer.h"
29 static const char *exec_name;
31 void usage_exit(void) {
35 // Denoiser states, for temporal denoising.
40 kDenoiserOnYUVAggressive,
44 static int mode_to_num_layers[12] = {1, 2, 2, 3, 3, 3, 3, 5, 2, 3, 3, 3};
46 // For rate control encoding stats.
47 struct RateControlMetrics {
48 // Number of input frames per layer.
49 int layer_input_frames[VPX_TS_MAX_LAYERS];
50 // Total (cumulative) number of encoded frames per layer.
51 int layer_tot_enc_frames[VPX_TS_MAX_LAYERS];
52 // Number of encoded non-key frames per layer.
53 int layer_enc_frames[VPX_TS_MAX_LAYERS];
54 // Framerate per layer layer (cumulative).
55 double layer_framerate[VPX_TS_MAX_LAYERS];
56 // Target average frame size per layer (per-frame-bandwidth per layer).
57 double layer_pfb[VPX_TS_MAX_LAYERS];
58 // Actual average frame size per layer.
59 double layer_avg_frame_size[VPX_TS_MAX_LAYERS];
60 // Average rate mismatch per layer (|target - actual| / target).
61 double layer_avg_rate_mismatch[VPX_TS_MAX_LAYERS];
62 // Actual encoding bitrate per layer (cumulative).
63 double layer_encoding_bitrate[VPX_TS_MAX_LAYERS];
64 // Average of the short-time encoder actual bitrate.
65 // TODO(marpan): Should we add these short-time stats for each layer?
66 double avg_st_encoding_bitrate;
67 // Variance of the short-time encoder actual bitrate.
68 double variance_st_encoding_bitrate;
69 // Window (number of frames) for computing short-timee encoding bitrate.
71 // Number of window measurements.
75 // Note: these rate control metrics assume only 1 key frame in the
76 // sequence (i.e., first frame only). So for temporal pattern# 7
77 // (which has key frame for every frame on base layer), the metrics
78 // computation will be off/wrong.
79 // TODO(marpan): Update these metrics to account for multiple key frames
81 static void set_rate_control_metrics(struct RateControlMetrics *rc,
82 vpx_codec_enc_cfg_t *cfg) {
84 // Set the layer (cumulative) framerate and the target layer (non-cumulative)
85 // per-frame-bandwidth, for the rate control encoding stats below.
86 const double framerate = cfg->g_timebase.den / cfg->g_timebase.num;
87 rc->layer_framerate[0] = framerate / cfg->ts_rate_decimator[0];
88 rc->layer_pfb[0] = 1000.0 * cfg->layer_target_bitrate[0] /
89 rc->layer_framerate[0];
90 for (i = 0; i < cfg->ts_number_layers; ++i) {
92 rc->layer_framerate[i] = framerate / cfg->ts_rate_decimator[i];
93 rc->layer_pfb[i] = 1000.0 *
94 (cfg->layer_target_bitrate[i] - cfg->layer_target_bitrate[i - 1]) /
95 (rc->layer_framerate[i] - rc->layer_framerate[i - 1]);
97 rc->layer_input_frames[i] = 0;
98 rc->layer_enc_frames[i] = 0;
99 rc->layer_tot_enc_frames[i] = 0;
100 rc->layer_encoding_bitrate[i] = 0.0;
101 rc->layer_avg_frame_size[i] = 0.0;
102 rc->layer_avg_rate_mismatch[i] = 0.0;
104 rc->window_count = 0;
105 rc->window_size = 15;
106 rc->avg_st_encoding_bitrate = 0.0;
107 rc->variance_st_encoding_bitrate = 0.0;
110 static void printout_rate_control_summary(struct RateControlMetrics *rc,
111 vpx_codec_enc_cfg_t *cfg,
114 int tot_num_frames = 0;
115 double perc_fluctuation = 0.0;
116 printf("Total number of processed frames: %d\n\n", frame_cnt -1);
117 printf("Rate control layer stats for %d layer(s):\n\n",
118 cfg->ts_number_layers);
119 for (i = 0; i < cfg->ts_number_layers; ++i) {
120 const int num_dropped = (i > 0) ?
121 (rc->layer_input_frames[i] - rc->layer_enc_frames[i]) :
122 (rc->layer_input_frames[i] - rc->layer_enc_frames[i] - 1);
123 tot_num_frames += rc->layer_input_frames[i];
124 rc->layer_encoding_bitrate[i] = 0.001 * rc->layer_framerate[i] *
125 rc->layer_encoding_bitrate[i] / tot_num_frames;
126 rc->layer_avg_frame_size[i] = rc->layer_avg_frame_size[i] /
127 rc->layer_enc_frames[i];
128 rc->layer_avg_rate_mismatch[i] = 100.0 * rc->layer_avg_rate_mismatch[i] /
129 rc->layer_enc_frames[i];
130 printf("For layer#: %d \n", i);
131 printf("Bitrate (target vs actual): %d %f \n", cfg->layer_target_bitrate[i],
132 rc->layer_encoding_bitrate[i]);
133 printf("Average frame size (target vs actual): %f %f \n", rc->layer_pfb[i],
134 rc->layer_avg_frame_size[i]);
135 printf("Average rate_mismatch: %f \n", rc->layer_avg_rate_mismatch[i]);
136 printf("Number of input frames, encoded (non-key) frames, "
137 "and perc dropped frames: %d %d %f \n", rc->layer_input_frames[i],
138 rc->layer_enc_frames[i],
139 100.0 * num_dropped / rc->layer_input_frames[i]);
142 rc->avg_st_encoding_bitrate = rc->avg_st_encoding_bitrate / rc->window_count;
143 rc->variance_st_encoding_bitrate =
144 rc->variance_st_encoding_bitrate / rc->window_count -
145 (rc->avg_st_encoding_bitrate * rc->avg_st_encoding_bitrate);
146 perc_fluctuation = 100.0 * sqrt(rc->variance_st_encoding_bitrate) /
147 rc->avg_st_encoding_bitrate;
148 printf("Short-time stats, for window of %d frames: \n",rc->window_size);
149 printf("Average, rms-variance, and percent-fluct: %f %f %f \n",
150 rc->avg_st_encoding_bitrate,
151 sqrt(rc->variance_st_encoding_bitrate),
153 if ((frame_cnt - 1) != tot_num_frames)
154 die("Error: Number of input frames not equal to output! \n");
157 // Temporal scaling parameters:
158 // NOTE: The 3 prediction frames cannot be used interchangeably due to
159 // differences in the way they are handled throughout the code. The
160 // frames should be allocated to layers in the order LAST, GF, ARF.
161 // Other combinations work, but may produce slightly inferior results.
162 static void set_temporal_layer_pattern(int layering_mode,
163 vpx_codec_enc_cfg_t *cfg,
165 int *flag_periodicity) {
166 switch (layering_mode) {
170 cfg->ts_periodicity = 1;
171 *flag_periodicity = 1;
172 cfg->ts_number_layers = 1;
173 cfg->ts_rate_decimator[0] = 1;
174 memcpy(cfg->ts_layer_id, ids, sizeof(ids));
176 layer_flags[0] = VPX_EFLAG_FORCE_KF | VP8_EFLAG_NO_UPD_GF |
177 VP8_EFLAG_NO_UPD_ARF;
181 // 2-layers, 2-frame period.
183 cfg->ts_periodicity = 2;
184 *flag_periodicity = 2;
185 cfg->ts_number_layers = 2;
186 cfg->ts_rate_decimator[0] = 2;
187 cfg->ts_rate_decimator[1] = 1;
188 memcpy(cfg->ts_layer_id, ids, sizeof(ids));
190 // 0=L, 1=GF, Intra-layer prediction enabled.
191 layer_flags[0] = VPX_EFLAG_FORCE_KF | VP8_EFLAG_NO_UPD_GF |
192 VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF;
193 layer_flags[1] = VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_NO_UPD_LAST |
194 VP8_EFLAG_NO_REF_ARF;
196 // 0=L, 1=GF, Intra-layer prediction disabled.
197 layer_flags[0] = VPX_EFLAG_FORCE_KF | VP8_EFLAG_NO_UPD_GF |
198 VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF;
199 layer_flags[1] = VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_NO_UPD_LAST |
200 VP8_EFLAG_NO_REF_ARF | VP8_EFLAG_NO_REF_LAST;
205 // 2-layers, 3-frame period.
206 int ids[3] = {0, 1, 1};
207 cfg->ts_periodicity = 3;
208 *flag_periodicity = 3;
209 cfg->ts_number_layers = 2;
210 cfg->ts_rate_decimator[0] = 3;
211 cfg->ts_rate_decimator[1] = 1;
212 memcpy(cfg->ts_layer_id, ids, sizeof(ids));
213 // 0=L, 1=GF, Intra-layer prediction enabled.
214 layer_flags[0] = VPX_EFLAG_FORCE_KF | VP8_EFLAG_NO_REF_GF |
215 VP8_EFLAG_NO_REF_ARF | VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
217 layer_flags[2] = VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
218 VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_NO_UPD_LAST;
222 // 3-layers, 6-frame period.
223 int ids[6] = {0, 2, 2, 1, 2, 2};
224 cfg->ts_periodicity = 6;
225 *flag_periodicity = 6;
226 cfg->ts_number_layers = 3;
227 cfg->ts_rate_decimator[0] = 6;
228 cfg->ts_rate_decimator[1] = 3;
229 cfg->ts_rate_decimator[2] = 1;
230 memcpy(cfg->ts_layer_id, ids, sizeof(ids));
231 // 0=L, 1=GF, 2=ARF, Intra-layer prediction enabled.
232 layer_flags[0] = VPX_EFLAG_FORCE_KF | VP8_EFLAG_NO_REF_GF |
233 VP8_EFLAG_NO_REF_ARF | VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
234 layer_flags[3] = VP8_EFLAG_NO_REF_ARF | VP8_EFLAG_NO_UPD_ARF |
235 VP8_EFLAG_NO_UPD_LAST;
239 layer_flags[5] = VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_LAST;
243 // 3-layers, 4-frame period.
244 int ids[4] = {0, 2, 1, 2};
245 cfg->ts_periodicity = 4;
246 *flag_periodicity = 4;
247 cfg->ts_number_layers = 3;
248 cfg->ts_rate_decimator[0] = 4;
249 cfg->ts_rate_decimator[1] = 2;
250 cfg->ts_rate_decimator[2] = 1;
251 memcpy(cfg->ts_layer_id, ids, sizeof(ids));
252 // 0=L, 1=GF, 2=ARF, Intra-layer prediction disabled.
253 layer_flags[0] = VPX_EFLAG_FORCE_KF | VP8_EFLAG_NO_REF_GF |
254 VP8_EFLAG_NO_REF_ARF | VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
255 layer_flags[2] = VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
256 VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_NO_UPD_LAST;
258 layer_flags[3] = VP8_EFLAG_NO_REF_ARF | VP8_EFLAG_NO_UPD_LAST |
259 VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
263 // 3-layers, 4-frame period.
264 int ids[4] = {0, 2, 1, 2};
265 cfg->ts_periodicity = 4;
266 *flag_periodicity = 4;
267 cfg->ts_number_layers = 3;
268 cfg->ts_rate_decimator[0] = 4;
269 cfg->ts_rate_decimator[1] = 2;
270 cfg->ts_rate_decimator[2] = 1;
271 memcpy(cfg->ts_layer_id, ids, sizeof(ids));
272 // 0=L, 1=GF, 2=ARF, Intra-layer prediction enabled in layer 1, disabled
274 layer_flags[0] = VPX_EFLAG_FORCE_KF | VP8_EFLAG_NO_REF_GF |
275 VP8_EFLAG_NO_REF_ARF | VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
276 layer_flags[2] = VP8_EFLAG_NO_REF_ARF | VP8_EFLAG_NO_UPD_LAST |
277 VP8_EFLAG_NO_UPD_ARF;
279 layer_flags[3] = VP8_EFLAG_NO_REF_ARF | VP8_EFLAG_NO_UPD_LAST |
280 VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
284 // 3-layers, 4-frame period.
285 int ids[4] = {0, 2, 1, 2};
286 cfg->ts_periodicity = 4;
287 *flag_periodicity = 4;
288 cfg->ts_number_layers = 3;
289 cfg->ts_rate_decimator[0] = 4;
290 cfg->ts_rate_decimator[1] = 2;
291 cfg->ts_rate_decimator[2] = 1;
292 memcpy(cfg->ts_layer_id, ids, sizeof(ids));
293 // 0=L, 1=GF, 2=ARF, Intra-layer prediction enabled.
294 layer_flags[0] = VPX_EFLAG_FORCE_KF | VP8_EFLAG_NO_REF_GF |
295 VP8_EFLAG_NO_REF_ARF | VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
296 layer_flags[2] = VP8_EFLAG_NO_REF_ARF | VP8_EFLAG_NO_UPD_LAST |
297 VP8_EFLAG_NO_UPD_ARF;
299 layer_flags[3] = VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_GF;
303 // NOTE: Probably of academic interest only.
304 // 5-layers, 16-frame period.
305 int ids[16] = {0, 4, 3, 4, 2, 4, 3, 4, 1, 4, 3, 4, 2, 4, 3, 4};
306 cfg->ts_periodicity = 16;
307 *flag_periodicity = 16;
308 cfg->ts_number_layers = 5;
309 cfg->ts_rate_decimator[0] = 16;
310 cfg->ts_rate_decimator[1] = 8;
311 cfg->ts_rate_decimator[2] = 4;
312 cfg->ts_rate_decimator[3] = 2;
313 cfg->ts_rate_decimator[4] = 1;
314 memcpy(cfg->ts_layer_id, ids, sizeof(ids));
315 layer_flags[0] = VPX_EFLAG_FORCE_KF;
323 layer_flags[15] = VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_GF |
324 VP8_EFLAG_NO_UPD_ARF;
328 layer_flags[14] = VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_NO_UPD_GF;
330 layer_flags[12] = VP8_EFLAG_NO_REF_LAST | VP8_EFLAG_NO_UPD_ARF;
331 layer_flags[8] = VP8_EFLAG_NO_REF_LAST | VP8_EFLAG_NO_REF_GF;
335 // 2-layers, with sync point at first frame of layer 1.
337 cfg->ts_periodicity = 2;
338 *flag_periodicity = 8;
339 cfg->ts_number_layers = 2;
340 cfg->ts_rate_decimator[0] = 2;
341 cfg->ts_rate_decimator[1] = 1;
342 memcpy(cfg->ts_layer_id, ids, sizeof(ids));
344 // ARF is used as predictor for all frames, and is only updated on
345 // key frame. Sync point every 8 frames.
347 // Layer 0: predict from L and ARF, update L and G.
348 layer_flags[0] = VPX_EFLAG_FORCE_KF | VP8_EFLAG_NO_REF_GF |
349 VP8_EFLAG_NO_UPD_ARF;
350 // Layer 1: sync point: predict from L and ARF, and update G.
351 layer_flags[1] = VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_UPD_LAST |
352 VP8_EFLAG_NO_UPD_ARF;
353 // Layer 0, predict from L and ARF, update L.
354 layer_flags[2] = VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_UPD_GF |
355 VP8_EFLAG_NO_UPD_ARF;
356 // Layer 1: predict from L, G and ARF, and update G.
357 layer_flags[3] = VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_NO_UPD_LAST |
358 VP8_EFLAG_NO_UPD_ENTROPY;
360 layer_flags[4] = layer_flags[2];
362 layer_flags[5] = layer_flags[3];
364 layer_flags[6] = layer_flags[4];
366 layer_flags[7] = layer_flags[5];
370 // 3-layers: Sync points for layer 1 and 2 every 8 frames.
371 int ids[4] = {0, 2, 1, 2};
372 cfg->ts_periodicity = 4;
373 *flag_periodicity = 8;
374 cfg->ts_number_layers = 3;
375 cfg->ts_rate_decimator[0] = 4;
376 cfg->ts_rate_decimator[1] = 2;
377 cfg->ts_rate_decimator[2] = 1;
378 memcpy(cfg->ts_layer_id, ids, sizeof(ids));
380 layer_flags[0] = VPX_EFLAG_FORCE_KF | VP8_EFLAG_NO_REF_GF |
381 VP8_EFLAG_NO_REF_ARF | VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
382 layer_flags[1] = VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
383 VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_GF;
384 layer_flags[2] = VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
385 VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_ARF;
387 layer_flags[5] = VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_GF;
388 layer_flags[4] = VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
389 VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
390 layer_flags[6] = VP8_EFLAG_NO_REF_ARF | VP8_EFLAG_NO_UPD_LAST |
391 VP8_EFLAG_NO_UPD_ARF;
392 layer_flags[7] = VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_GF |
393 VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_NO_UPD_ENTROPY;
397 // 3-layers structure where ARF is used as predictor for all frames,
398 // and is only updated on key frame.
399 // Sync points for layer 1 and 2 every 8 frames.
401 int ids[4] = {0, 2, 1, 2};
402 cfg->ts_periodicity = 4;
403 *flag_periodicity = 8;
404 cfg->ts_number_layers = 3;
405 cfg->ts_rate_decimator[0] = 4;
406 cfg->ts_rate_decimator[1] = 2;
407 cfg->ts_rate_decimator[2] = 1;
408 memcpy(cfg->ts_layer_id, ids, sizeof(ids));
410 // Layer 0: predict from L and ARF; update L and G.
411 layer_flags[0] = VPX_EFLAG_FORCE_KF | VP8_EFLAG_NO_UPD_ARF |
413 // Layer 2: sync point: predict from L and ARF; update none.
414 layer_flags[1] = VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_UPD_GF |
415 VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_NO_UPD_LAST |
416 VP8_EFLAG_NO_UPD_ENTROPY;
417 // Layer 1: sync point: predict from L and ARF; update G.
418 layer_flags[2] = VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_UPD_ARF |
419 VP8_EFLAG_NO_UPD_LAST;
420 // Layer 2: predict from L, G, ARF; update none.
421 layer_flags[3] = VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF |
422 VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_ENTROPY;
423 // Layer 0: predict from L and ARF; update L.
424 layer_flags[4] = VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF |
426 // Layer 2: predict from L, G, ARF; update none.
427 layer_flags[5] = layer_flags[3];
428 // Layer 1: predict from L, G, ARF; update G.
429 layer_flags[6] = VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_NO_UPD_LAST;
430 // Layer 2: predict from L, G, ARF; update none.
431 layer_flags[7] = layer_flags[3];
436 // 3-layers structure as in case 10, but no sync/refresh points for
438 int ids[4] = {0, 2, 1, 2};
439 cfg->ts_periodicity = 4;
440 *flag_periodicity = 8;
441 cfg->ts_number_layers = 3;
442 cfg->ts_rate_decimator[0] = 4;
443 cfg->ts_rate_decimator[1] = 2;
444 cfg->ts_rate_decimator[2] = 1;
445 memcpy(cfg->ts_layer_id, ids, sizeof(ids));
447 // Layer 0: predict from L and ARF; update L.
448 layer_flags[0] = VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF |
450 layer_flags[4] = layer_flags[0];
451 // Layer 1: predict from L, G, ARF; update G.
452 layer_flags[2] = VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_NO_UPD_LAST;
453 layer_flags[6] = layer_flags[2];
454 // Layer 2: predict from L, G, ARF; update none.
455 layer_flags[1] = VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF |
456 VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_ENTROPY;
457 layer_flags[3] = layer_flags[1];
458 layer_flags[5] = layer_flags[1];
459 layer_flags[7] = layer_flags[1];
465 int main(int argc, char **argv) {
466 VpxVideoWriter *outfile[VPX_TS_MAX_LAYERS] = {NULL};
467 vpx_codec_ctx_t codec;
468 vpx_codec_enc_cfg_t cfg;
479 int pts = 0; // PTS starts at 0.
480 int frame_duration = 1; // 1 timebase tick per frame.
481 int layering_mode = 0;
482 int layer_flags[VPX_TS_MAX_PERIODICITY] = {0};
483 int flag_periodicity = 1;
484 #if VPX_ENCODER_ABI_VERSION > (4 + VPX_CODEC_ABI_VERSION)
485 vpx_svc_layer_id_t layer_id = {0, 0};
487 vpx_svc_layer_id_t layer_id = {0};
489 const VpxInterface *encoder = NULL;
491 struct RateControlMetrics rc;
493 const int min_args_base = 11;
494 #if CONFIG_VP9_HIGHBITDEPTH
495 vpx_bit_depth_t bit_depth = VPX_BITS_8;
496 int input_bit_depth = 8;
497 const int min_args = min_args_base + 1;
499 const int min_args = min_args_base;
500 #endif // CONFIG_VP9_HIGHBITDEPTH
501 double sum_bitrate = 0.0;
502 double sum_bitrate2 = 0.0;
503 double framerate = 30.0;
506 // Check usage and arguments.
507 if (argc < min_args) {
508 #if CONFIG_VP9_HIGHBITDEPTH
509 die("Usage: %s <infile> <outfile> <codec_type(vp8/vp9)> <width> <height> "
510 "<rate_num> <rate_den> <speed> <frame_drop_threshold> <mode> "
511 "<Rate_0> ... <Rate_nlayers-1> <bit-depth> \n", argv[0]);
513 die("Usage: %s <infile> <outfile> <codec_type(vp8/vp9)> <width> <height> "
514 "<rate_num> <rate_den> <speed> <frame_drop_threshold> <mode> "
515 "<Rate_0> ... <Rate_nlayers-1> \n", argv[0]);
516 #endif // CONFIG_VP9_HIGHBITDEPTH
519 encoder = get_vpx_encoder_by_name(argv[3]);
521 die("Unsupported codec.");
523 printf("Using %s\n", vpx_codec_iface_name(encoder->codec_interface()));
525 width = strtol(argv[4], NULL, 0);
526 height = strtol(argv[5], NULL, 0);
527 if (width < 16 || width % 2 || height < 16 || height % 2) {
528 die("Invalid resolution: %d x %d", width, height);
531 layering_mode = strtol(argv[10], NULL, 0);
532 if (layering_mode < 0 || layering_mode > 12) {
533 die("Invalid layering mode (0..12) %s", argv[10]);
536 if (argc != min_args + mode_to_num_layers[layering_mode]) {
537 die("Invalid number of arguments");
540 #if CONFIG_VP9_HIGHBITDEPTH
541 switch (strtol(argv[argc-1], NULL, 0)) {
543 bit_depth = VPX_BITS_8;
547 bit_depth = VPX_BITS_10;
548 input_bit_depth = 10;
551 bit_depth = VPX_BITS_12;
552 input_bit_depth = 12;
555 die("Invalid bit depth (8, 10, 12) %s", argv[argc-1]);
557 if (!vpx_img_alloc(&raw,
558 bit_depth == VPX_BITS_8 ? VPX_IMG_FMT_I420 :
560 width, height, 32)) {
561 die("Failed to allocate image", width, height);
564 if (!vpx_img_alloc(&raw, VPX_IMG_FMT_I420, width, height, 32)) {
565 die("Failed to allocate image", width, height);
567 #endif // CONFIG_VP9_HIGHBITDEPTH
569 // Populate encoder configuration.
570 res = vpx_codec_enc_config_default(encoder->codec_interface(), &cfg, 0);
572 printf("Failed to get config: %s\n", vpx_codec_err_to_string(res));
576 // Update the default configuration with our settings.
580 #if CONFIG_VP9_HIGHBITDEPTH
581 if (bit_depth != VPX_BITS_8) {
582 cfg.g_bit_depth = bit_depth;
583 cfg.g_input_bit_depth = input_bit_depth;
586 #endif // CONFIG_VP9_HIGHBITDEPTH
588 // Timebase format e.g. 30fps: numerator=1, demoninator = 30.
589 cfg.g_timebase.num = strtol(argv[6], NULL, 0);
590 cfg.g_timebase.den = strtol(argv[7], NULL, 0);
592 speed = strtol(argv[8], NULL, 0);
594 die("Invalid speed setting: must be positive");
597 for (i = min_args_base;
598 (int)i < min_args_base + mode_to_num_layers[layering_mode];
600 cfg.layer_target_bitrate[i - 11] = strtol(argv[i], NULL, 0);
603 // Real time parameters.
604 cfg.rc_dropframe_thresh = strtol(argv[9], NULL, 0);
605 cfg.rc_end_usage = VPX_CBR;
606 cfg.rc_resize_allowed = 0;
607 cfg.rc_min_quantizer = 2;
608 cfg.rc_max_quantizer = 56;
609 if (strncmp(encoder->name, "vp9", 3) == 0)
610 cfg.rc_max_quantizer = 52;
611 cfg.rc_undershoot_pct = 50;
612 cfg.rc_overshoot_pct = 50;
613 cfg.rc_buf_initial_sz = 500;
614 cfg.rc_buf_optimal_sz = 600;
615 cfg.rc_buf_sz = 1000;
617 // Use 1 thread as default.
620 // Enable error resilient mode.
621 cfg.g_error_resilient = 1;
622 cfg.g_lag_in_frames = 0;
623 cfg.kf_mode = VPX_KF_AUTO;
625 // Disable automatic keyframe placement.
626 cfg.kf_min_dist = cfg.kf_max_dist = 3000;
628 cfg.temporal_layering_mode = VP9E_TEMPORAL_LAYERING_MODE_BYPASS;
630 set_temporal_layer_pattern(layering_mode,
635 set_rate_control_metrics(&rc, &cfg);
637 // Target bandwidth for the whole stream.
638 // Set to layer_target_bitrate for highest layer (total bitrate).
639 cfg.rc_target_bitrate = cfg.layer_target_bitrate[cfg.ts_number_layers - 1];
642 if (!(infile = fopen(argv[1], "rb"))) {
643 die("Failed to open %s for reading", argv[1]);
646 framerate = cfg.g_timebase.den / cfg.g_timebase.num;
647 // Open an output file for each stream.
648 for (i = 0; i < cfg.ts_number_layers; ++i) {
649 char file_name[PATH_MAX];
651 info.codec_fourcc = encoder->fourcc;
652 info.frame_width = cfg.g_w;
653 info.frame_height = cfg.g_h;
654 info.time_base.numerator = cfg.g_timebase.num;
655 info.time_base.denominator = cfg.g_timebase.den;
657 snprintf(file_name, sizeof(file_name), "%s_%d.ivf", argv[2], i);
658 outfile[i] = vpx_video_writer_open(file_name, kContainerIVF, &info);
660 die("Failed to open %s for writing", file_name);
662 assert(outfile[i] != NULL);
664 // No spatial layers in this encoder.
665 cfg.ss_number_layers = 1;
668 #if CONFIG_VP9_HIGHBITDEPTH
669 if (vpx_codec_enc_init(
670 &codec, encoder->codec_interface(), &cfg,
671 bit_depth == VPX_BITS_8 ? 0 : VPX_CODEC_USE_HIGHBITDEPTH))
673 if (vpx_codec_enc_init(&codec, encoder->codec_interface(), &cfg, 0))
674 #endif // CONFIG_VP9_HIGHBITDEPTH
675 die_codec(&codec, "Failed to initialize encoder");
677 if (strncmp(encoder->name, "vp8", 3) == 0) {
678 vpx_codec_control(&codec, VP8E_SET_CPUUSED, -speed);
679 vpx_codec_control(&codec, VP8E_SET_NOISE_SENSITIVITY, kDenoiserOff);
680 vpx_codec_control(&codec, VP8E_SET_STATIC_THRESHOLD, 0);
681 } else if (strncmp(encoder->name, "vp9", 3) == 0) {
682 #if VPX_ENCODER_ABI_VERSION > (4 + VPX_CODEC_ABI_VERSION)
683 vpx_svc_extra_cfg_t svc_params;
685 vpx_codec_control(&codec, VP8E_SET_CPUUSED, speed);
686 vpx_codec_control(&codec, VP9E_SET_AQ_MODE, 3);
687 vpx_codec_control(&codec, VP9E_SET_FRAME_PERIODIC_BOOST, 0);
688 vpx_codec_control(&codec, VP9E_SET_NOISE_SENSITIVITY, 0);
689 vpx_codec_control(&codec, VP8E_SET_STATIC_THRESHOLD, 0);
690 vpx_codec_control(&codec, VP9E_SET_TILE_COLUMNS, (cfg.g_threads >> 1));
691 if (vpx_codec_control(&codec, VP9E_SET_SVC, layering_mode > 0 ? 1: 0)) {
692 die_codec(&codec, "Failed to set SVC");
693 #if VPX_ENCODER_ABI_VERSION > (4 + VPX_CODEC_ABI_VERSION)
694 for (i = 0; i < cfg.ts_number_layers; ++i) {
695 svc_params.max_quantizers[i] = cfg.rc_max_quantizer;
696 svc_params.min_quantizers[i] = cfg.rc_min_quantizer;
698 svc_params.scaling_factor_num[0] = cfg.g_h;
699 svc_params.scaling_factor_den[0] = cfg.g_h;
700 vpx_codec_control(&codec, VP9E_SET_SVC_PARAMETERS, &svc_params);
704 if (strncmp(encoder->name, "vp8", 3) == 0) {
705 vpx_codec_control(&codec, VP8E_SET_SCREEN_CONTENT_MODE, 0);
707 vpx_codec_control(&codec, VP8E_SET_TOKEN_PARTITIONS, 1);
708 // This controls the maximum target size of the key frame.
709 // For generating smaller key frames, use a smaller max_intra_size_pct
710 // value, like 100 or 200.
712 const int max_intra_size_pct = 900;
713 vpx_codec_control(&codec, VP8E_SET_MAX_INTRA_BITRATE_PCT,
718 while (frame_avail || got_data) {
719 struct vpx_usec_timer timer;
720 vpx_codec_iter_t iter = NULL;
721 const vpx_codec_cx_pkt_t *pkt;
722 #if VPX_ENCODER_ABI_VERSION > (4 + VPX_CODEC_ABI_VERSION)
723 // Update the temporal layer_id. No spatial layers in this test.
724 layer_id.spatial_layer_id = 0;
726 layer_id.temporal_layer_id =
727 cfg.ts_layer_id[frame_cnt % cfg.ts_periodicity];
728 if (strncmp(encoder->name, "vp9", 3) == 0) {
729 vpx_codec_control(&codec, VP9E_SET_SVC_LAYER_ID, &layer_id);
730 } else if (strncmp(encoder->name, "vp8", 3) == 0) {
731 vpx_codec_control(&codec, VP8E_SET_TEMPORAL_LAYER_ID,
732 layer_id.temporal_layer_id);
734 flags = layer_flags[frame_cnt % flag_periodicity];
735 if (layering_mode == 0)
737 frame_avail = vpx_img_read(&raw, infile);
739 ++rc.layer_input_frames[layer_id.temporal_layer_id];
740 vpx_usec_timer_start(&timer);
741 if (vpx_codec_encode(&codec, frame_avail? &raw : NULL, pts, 1, flags,
743 die_codec(&codec, "Failed to encode frame");
745 vpx_usec_timer_mark(&timer);
746 cx_time += vpx_usec_timer_elapsed(&timer);
748 if (layering_mode != 7) {
749 layer_flags[0] &= ~VPX_EFLAG_FORCE_KF;
752 while ( (pkt = vpx_codec_get_cx_data(&codec, &iter)) ) {
755 case VPX_CODEC_CX_FRAME_PKT:
756 for (i = cfg.ts_layer_id[frame_cnt % cfg.ts_periodicity];
757 i < cfg.ts_number_layers; ++i) {
758 vpx_video_writer_write_frame(outfile[i], pkt->data.frame.buf,
759 pkt->data.frame.sz, pts);
760 ++rc.layer_tot_enc_frames[i];
761 rc.layer_encoding_bitrate[i] += 8.0 * pkt->data.frame.sz;
762 // Keep count of rate control stats per layer (for non-key frames).
763 if (i == cfg.ts_layer_id[frame_cnt % cfg.ts_periodicity] &&
764 !(pkt->data.frame.flags & VPX_FRAME_IS_KEY)) {
765 rc.layer_avg_frame_size[i] += 8.0 * pkt->data.frame.sz;
766 rc.layer_avg_rate_mismatch[i] +=
767 fabs(8.0 * pkt->data.frame.sz - rc.layer_pfb[i]) /
769 ++rc.layer_enc_frames[i];
772 // Update for short-time encoding bitrate states, for moving window
773 // of size rc->window, shifted by rc->window / 2.
774 // Ignore first window segment, due to key frame.
775 if (frame_cnt > rc.window_size) {
776 sum_bitrate += 0.001 * 8.0 * pkt->data.frame.sz * framerate;
777 if (frame_cnt % rc.window_size == 0) {
778 rc.window_count += 1;
779 rc.avg_st_encoding_bitrate += sum_bitrate / rc.window_size;
780 rc.variance_st_encoding_bitrate +=
781 (sum_bitrate / rc.window_size) *
782 (sum_bitrate / rc.window_size);
786 // Second shifted window.
787 if (frame_cnt > rc.window_size + rc.window_size / 2) {
788 sum_bitrate2 += 0.001 * 8.0 * pkt->data.frame.sz * framerate;
789 if (frame_cnt > 2 * rc.window_size &&
790 frame_cnt % rc.window_size == 0) {
791 rc.window_count += 1;
792 rc.avg_st_encoding_bitrate += sum_bitrate2 / rc.window_size;
793 rc.variance_st_encoding_bitrate +=
794 (sum_bitrate2 / rc.window_size) *
795 (sum_bitrate2 / rc.window_size);
805 pts += frame_duration;
808 printout_rate_control_summary(&rc, &cfg, frame_cnt);
810 printf("Frame cnt and encoding time/FPS stats for encoding: %d %f %f \n",
812 1000 * (float)cx_time / (double)(frame_cnt * 1000000),
813 1000000 * (double)frame_cnt / (double)cx_time);
815 if (vpx_codec_destroy(&codec))
816 die_codec(&codec, "Failed to destroy codec");
818 // Try to rewrite the output file headers with the actual frame count.
819 for (i = 0; i < cfg.ts_number_layers; ++i)
820 vpx_video_writer_close(outfile[i]);