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.
13 * This is an example demonstrating how to implement a multi-layer VP8
14 * encoding scheme based on temporal scalability for video applications
15 * that benefit from a scalable bitstream.
21 #define VPX_CODEC_DISABLE_COMPAT 1
22 #include "vpx/vpx_encoder.h"
23 #include "vpx/vp8cx.h"
24 #define interface (vpx_codec_vp8_cx())
25 #define fourcc 0x30385056
27 #define IVF_FILE_HDR_SZ (32)
28 #define IVF_FRAME_HDR_SZ (12)
30 static void mem_put_le16(char *mem, unsigned int val) {
35 static void mem_put_le32(char *mem, unsigned int val) {
42 static void die(const char *fmt, ...) {
47 if(fmt[strlen(fmt)-1] != '\n')
52 static void die_codec(vpx_codec_ctx_t *ctx, const char *s) {
53 const char *detail = vpx_codec_error_detail(ctx);
55 printf("%s: %s\n", s, vpx_codec_error(ctx));
57 printf(" %s\n",detail);
61 static int read_frame(FILE *f, vpx_image_t *img) {
62 size_t nbytes, to_read;
65 to_read = img->w*img->h*3/2;
66 nbytes = fread(img->planes[0], 1, to_read, f);
67 if(nbytes != to_read) {
70 printf("Warning: Read partial frame. Check your width & height!\n");
75 static void write_ivf_file_header(FILE *outfile,
76 const vpx_codec_enc_cfg_t *cfg,
80 if(cfg->g_pass != VPX_RC_ONE_PASS && cfg->g_pass != VPX_RC_LAST_PASS)
86 mem_put_le16(header+4, 0); /* version */
87 mem_put_le16(header+6, 32); /* headersize */
88 mem_put_le32(header+8, fourcc); /* headersize */
89 mem_put_le16(header+12, cfg->g_w); /* width */
90 mem_put_le16(header+14, cfg->g_h); /* height */
91 mem_put_le32(header+16, cfg->g_timebase.den); /* rate */
92 mem_put_le32(header+20, cfg->g_timebase.num); /* scale */
93 mem_put_le32(header+24, frame_cnt); /* length */
94 mem_put_le32(header+28, 0); /* unused */
96 (void) fwrite(header, 1, 32, outfile);
100 static void write_ivf_frame_header(FILE *outfile,
101 const vpx_codec_cx_pkt_t *pkt)
106 if(pkt->kind != VPX_CODEC_CX_FRAME_PKT)
109 pts = pkt->data.frame.pts;
110 mem_put_le32(header, pkt->data.frame.sz);
111 mem_put_le32(header+4, pts&0xFFFFFFFF);
112 mem_put_le32(header+8, pts >> 32);
114 (void) fwrite(header, 1, 12, outfile);
117 static int mode_to_num_layers[9] = {2, 2, 3, 3, 3, 3, 5, 2, 3};
119 int main(int argc, char **argv) {
120 FILE *infile, *outfile[VPX_TS_MAX_LAYERS];
121 vpx_codec_ctx_t codec;
122 vpx_codec_enc_cfg_t cfg;
132 int pts = 0; /* PTS starts at 0 */
133 int frame_duration = 1; /* 1 timebase tick per frame */
135 int layering_mode = 0;
136 int frames_in_layer[VPX_TS_MAX_LAYERS] = {0};
137 int layer_flags[VPX_TS_MAX_PERIODICITY] = {0};
138 int flag_periodicity;
139 int max_intra_size_pct;
141 /* Check usage and arguments */
143 die("Usage: %s <infile> <outfile> <width> <height> <rate_num> "
144 " <rate_den> <mode> <Rate_0> ... <Rate_nlayers-1>\n", argv[0]);
146 width = strtol (argv[3], NULL, 0);
147 height = strtol (argv[4], NULL, 0);
148 if (width < 16 || width%2 || height <16 || height%2)
149 die ("Invalid resolution: %d x %d", width, height);
151 if (!sscanf(argv[7], "%d", &layering_mode))
152 die ("Invalid mode %s", argv[7]);
153 if (layering_mode<0 || layering_mode>8)
154 die ("Invalid mode (0..8) %s", argv[7]);
156 if (argc != 8+mode_to_num_layers[layering_mode])
157 die ("Invalid number of arguments");
159 if (!vpx_img_alloc (&raw, VPX_IMG_FMT_I420, width, height, 32))
160 die ("Failed to allocate image", width, height);
162 printf("Using %s\n",vpx_codec_iface_name(interface));
164 /* Populate encoder configuration */
165 res = vpx_codec_enc_config_default(interface, &cfg, 0);
167 printf("Failed to get config: %s\n", vpx_codec_err_to_string(res));
171 /* Update the default configuration with our settings */
175 /* Timebase format e.g. 30fps: numerator=1, demoninator=30 */
176 if (!sscanf (argv[5], "%d", &cfg.g_timebase.num ))
177 die ("Invalid timebase numerator %s", argv[5]);
178 if (!sscanf (argv[6], "%d", &cfg.g_timebase.den ))
179 die ("Invalid timebase denominator %s", argv[6]);
181 for (i=8; i<8+mode_to_num_layers[layering_mode]; i++)
182 if (!sscanf(argv[i], "%ud", &cfg.ts_target_bitrate[i-8]))
183 die ("Invalid data rate %s", argv[i]);
185 /* Real time parameters */
186 cfg.rc_dropframe_thresh = 0;
187 cfg.rc_end_usage = VPX_CBR;
188 cfg.rc_resize_allowed = 0;
189 cfg.rc_min_quantizer = 8;
190 cfg.rc_max_quantizer = 56;
191 cfg.rc_undershoot_pct = 100;
192 cfg.rc_overshoot_pct = 15;
193 cfg.rc_buf_initial_sz = 500;
194 cfg.rc_buf_optimal_sz = 600;
195 cfg.rc_buf_sz = 1000;
197 /* Enable error resilient mode */
198 cfg.g_error_resilient = 1;
199 cfg.g_lag_in_frames = 0;
200 cfg.kf_mode = VPX_KF_DISABLED;
202 /* Disable automatic keyframe placement */
203 cfg.kf_min_dist = cfg.kf_max_dist = 1000;
205 /* Temporal scaling parameters: */
206 /* NOTE: The 3 prediction frames cannot be used interchangeably due to
207 * differences in the way they are handled throughout the code. The
208 * frames should be allocated to layers in the order LAST, GF, ARF.
209 * Other combinations work, but may produce slightly inferior results.
211 switch (layering_mode)
216 /* 2-layers, 2-frame period */
218 cfg.ts_number_layers = 2;
219 cfg.ts_periodicity = 2;
220 cfg.ts_rate_decimator[0] = 2;
221 cfg.ts_rate_decimator[1] = 1;
222 memcpy(cfg.ts_layer_id, ids, sizeof(ids));
224 flag_periodicity = cfg.ts_periodicity;
226 /* 0=L, 1=GF, Intra-layer prediction enabled */
227 layer_flags[0] = VPX_EFLAG_FORCE_KF |
228 VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF |
229 VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF;
230 layer_flags[1] = VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_NO_UPD_LAST |
231 VP8_EFLAG_NO_REF_ARF;
233 /* 0=L, 1=GF, Intra-layer prediction disabled */
234 layer_flags[0] = VPX_EFLAG_FORCE_KF |
235 VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF |
236 VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF;
237 layer_flags[1] = VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_NO_UPD_LAST |
238 VP8_EFLAG_NO_REF_ARF | VP8_EFLAG_NO_REF_LAST;
245 /* 2-layers, 3-frame period */
246 int ids[3] = {0,1,1};
247 cfg.ts_number_layers = 2;
248 cfg.ts_periodicity = 3;
249 cfg.ts_rate_decimator[0] = 3;
250 cfg.ts_rate_decimator[1] = 1;
251 memcpy(cfg.ts_layer_id, ids, sizeof(ids));
253 flag_periodicity = cfg.ts_periodicity;
255 /* 0=L, 1=GF, Intra-layer prediction enabled */
256 layer_flags[0] = VPX_EFLAG_FORCE_KF |
257 VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
258 VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
260 layer_flags[2] = VP8_EFLAG_NO_REF_GF |
261 VP8_EFLAG_NO_REF_ARF | VP8_EFLAG_NO_UPD_ARF |
262 VP8_EFLAG_NO_UPD_LAST;
268 /* 3-layers, 6-frame period */
269 int ids[6] = {0,2,2,1,2,2};
270 cfg.ts_number_layers = 3;
271 cfg.ts_periodicity = 6;
272 cfg.ts_rate_decimator[0] = 6;
273 cfg.ts_rate_decimator[1] = 3;
274 cfg.ts_rate_decimator[2] = 1;
275 memcpy(cfg.ts_layer_id, ids, sizeof(ids));
277 flag_periodicity = cfg.ts_periodicity;
279 /* 0=L, 1=GF, 2=ARF, Intra-layer prediction enabled */
280 layer_flags[0] = VPX_EFLAG_FORCE_KF |
281 VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
282 VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
283 layer_flags[3] = VP8_EFLAG_NO_REF_ARF | VP8_EFLAG_NO_UPD_ARF |
284 VP8_EFLAG_NO_UPD_LAST;
288 layer_flags[5] = VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_LAST;
294 /* 3-layers, 4-frame period */
295 int ids[4] = {0,2,1,2};
296 cfg.ts_number_layers = 3;
297 cfg.ts_periodicity = 4;
298 cfg.ts_rate_decimator[0] = 4;
299 cfg.ts_rate_decimator[1] = 2;
300 cfg.ts_rate_decimator[2] = 1;
301 memcpy(cfg.ts_layer_id, ids, sizeof(ids));
303 flag_periodicity = cfg.ts_periodicity;
305 /* 0=L, 1=GF, 2=ARF, Intra-layer prediction disabled */
306 layer_flags[0] = VPX_EFLAG_FORCE_KF |
307 VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
308 VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
309 layer_flags[2] = VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
310 VP8_EFLAG_NO_UPD_ARF |
311 VP8_EFLAG_NO_UPD_LAST;
313 layer_flags[3] = VP8_EFLAG_NO_REF_ARF |
314 VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_GF |
315 VP8_EFLAG_NO_UPD_ARF;
321 /* 3-layers, 4-frame period */
322 int ids[4] = {0,2,1,2};
323 cfg.ts_number_layers = 3;
324 cfg.ts_periodicity = 4;
325 cfg.ts_rate_decimator[0] = 4;
326 cfg.ts_rate_decimator[1] = 2;
327 cfg.ts_rate_decimator[2] = 1;
328 memcpy(cfg.ts_layer_id, ids, sizeof(ids));
330 flag_periodicity = cfg.ts_periodicity;
332 /* 0=L, 1=GF, 2=ARF, Intra-layer prediction enabled in layer 1,
333 * disabled in layer 2
335 layer_flags[0] = VPX_EFLAG_FORCE_KF |
336 VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
337 VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
338 layer_flags[2] = VP8_EFLAG_NO_REF_ARF |
339 VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_ARF;
341 layer_flags[3] = VP8_EFLAG_NO_REF_ARF |
342 VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_GF |
343 VP8_EFLAG_NO_UPD_ARF;
349 /* 3-layers, 4-frame period */
350 int ids[4] = {0,2,1,2};
351 cfg.ts_number_layers = 3;
352 cfg.ts_periodicity = 4;
353 cfg.ts_rate_decimator[0] = 4;
354 cfg.ts_rate_decimator[1] = 2;
355 cfg.ts_rate_decimator[2] = 1;
356 memcpy(cfg.ts_layer_id, ids, sizeof(ids));
358 flag_periodicity = cfg.ts_periodicity;
360 /* 0=L, 1=GF, 2=ARF, Intra-layer prediction enabled */
361 layer_flags[0] = VPX_EFLAG_FORCE_KF |
362 VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
363 VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
364 layer_flags[2] = VP8_EFLAG_NO_REF_ARF |
365 VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_ARF;
367 layer_flags[3] = VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_GF;
373 /* NOTE: Probably of academic interest only */
375 /* 5-layers, 16-frame period */
376 int ids[16] = {0,4,3,4,2,4,3,4,1,4,3,4,2,4,3,4};
377 cfg.ts_number_layers = 5;
378 cfg.ts_periodicity = 16;
379 cfg.ts_rate_decimator[0] = 16;
380 cfg.ts_rate_decimator[1] = 8;
381 cfg.ts_rate_decimator[2] = 4;
382 cfg.ts_rate_decimator[3] = 2;
383 cfg.ts_rate_decimator[4] = 1;
384 memcpy(cfg.ts_layer_id, ids, sizeof(ids));
386 flag_periodicity = cfg.ts_periodicity;
388 layer_flags[0] = VPX_EFLAG_FORCE_KF;
396 layer_flags[15] = VP8_EFLAG_NO_UPD_LAST |
397 VP8_EFLAG_NO_UPD_GF |
398 VP8_EFLAG_NO_UPD_ARF;
402 layer_flags[14] = VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_NO_UPD_GF;
404 layer_flags[12] = VP8_EFLAG_NO_REF_LAST |
405 VP8_EFLAG_NO_UPD_ARF;
406 layer_flags[8] = VP8_EFLAG_NO_REF_LAST | VP8_EFLAG_NO_REF_GF;
414 cfg.ts_number_layers = 2;
415 cfg.ts_periodicity = 2;
416 cfg.ts_rate_decimator[0] = 2;
417 cfg.ts_rate_decimator[1] = 1;
418 memcpy(cfg.ts_layer_id, ids, sizeof(ids));
420 flag_periodicity = 8;
423 layer_flags[0] = VPX_EFLAG_FORCE_KF |
424 VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
425 VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
426 layer_flags[1] = VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
427 VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_ARF;
430 layer_flags[6] = VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
431 VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
433 layer_flags[5] = VP8_EFLAG_NO_REF_ARF |
434 VP8_EFLAG_NO_UPD_ARF | VP8_EFLAG_NO_UPD_LAST;
435 layer_flags[7] = VP8_EFLAG_NO_REF_ARF |
436 VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_GF |
437 VP8_EFLAG_NO_UPD_ARF |
438 VP8_EFLAG_NO_UPD_ENTROPY;
446 int ids[4] = {0,2,1,2};
447 cfg.ts_number_layers = 3;
448 cfg.ts_periodicity = 4;
449 cfg.ts_rate_decimator[0] = 4;
450 cfg.ts_rate_decimator[1] = 2;
451 cfg.ts_rate_decimator[2] = 1;
452 memcpy(cfg.ts_layer_id, ids, sizeof(ids));
454 flag_periodicity = 8;
456 /* 0=L, 1=GF, 2=ARF */
457 layer_flags[0] = VPX_EFLAG_FORCE_KF |
458 VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
459 VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
460 layer_flags[1] = VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
461 VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_GF;
462 layer_flags[2] = VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
463 VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_ARF;
465 layer_flags[5] = VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_GF;
466 layer_flags[4] = VP8_EFLAG_NO_REF_GF | VP8_EFLAG_NO_REF_ARF |
467 VP8_EFLAG_NO_UPD_GF | VP8_EFLAG_NO_UPD_ARF;
468 layer_flags[6] = VP8_EFLAG_NO_REF_ARF |
469 VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_ARF;
470 layer_flags[7] = VP8_EFLAG_NO_UPD_LAST | VP8_EFLAG_NO_UPD_GF |
471 VP8_EFLAG_NO_UPD_ARF |
472 VP8_EFLAG_NO_UPD_ENTROPY;
477 /* Open input file */
478 if(!(infile = fopen(argv[1], "rb")))
479 die("Failed to open %s for reading", argv[1]);
481 /* Open an output file for each stream */
482 for (i=0; i<cfg.ts_number_layers; i++)
485 sprintf (file_name, "%s_%d.ivf", argv[2], i);
486 if (!(outfile[i] = fopen(file_name, "wb")))
487 die("Failed to open %s for writing", file_name);
488 write_ivf_file_header(outfile[i], &cfg, 0);
491 /* Initialize codec */
492 if (vpx_codec_enc_init (&codec, interface, &cfg, 0))
493 die_codec (&codec, "Failed to initialize encoder");
495 /* Cap CPU & first I-frame size */
496 vpx_codec_control (&codec, VP8E_SET_CPUUSED, -6);
497 vpx_codec_control (&codec, VP8E_SET_STATIC_THRESHOLD, 800);
498 vpx_codec_control (&codec, VP8E_SET_NOISE_SENSITIVITY, 1);
500 max_intra_size_pct = (int) (((double)cfg.rc_buf_optimal_sz * 0.5)
501 * ((double) cfg.g_timebase.den / cfg.g_timebase.num)
503 /* printf ("max_intra_size_pct=%d\n", max_intra_size_pct); */
505 vpx_codec_control(&codec, VP8E_SET_MAX_INTRA_BITRATE_PCT,
509 while (frame_avail || got_data) {
510 vpx_codec_iter_t iter = NULL;
511 const vpx_codec_cx_pkt_t *pkt;
513 flags = layer_flags[frame_cnt % flag_periodicity];
515 frame_avail = read_frame(infile, &raw);
516 if (vpx_codec_encode(&codec, frame_avail? &raw : NULL, pts,
517 1, flags, VPX_DL_REALTIME))
518 die_codec(&codec, "Failed to encode frame");
521 if (layering_mode != 6)
522 layer_flags[0] &= ~VPX_EFLAG_FORCE_KF;
525 while ( (pkt = vpx_codec_get_cx_data(&codec, &iter)) ) {
528 case VPX_CODEC_CX_FRAME_PKT:
529 for (i=cfg.ts_layer_id[frame_cnt % cfg.ts_periodicity];
530 i<cfg.ts_number_layers; i++)
532 write_ivf_frame_header(outfile[i], pkt);
533 (void) fwrite(pkt->data.frame.buf, 1, pkt->data.frame.sz,
535 frames_in_layer[i]++;
541 printf (pkt->kind == VPX_CODEC_CX_FRAME_PKT
542 && (pkt->data.frame.flags & VPX_FRAME_IS_KEY)? "K":".");
546 pts += frame_duration;
551 printf ("Processed %d frames.\n",frame_cnt-1);
552 if (vpx_codec_destroy(&codec))
553 die_codec (&codec, "Failed to destroy codec");
555 /* Try to rewrite the output file headers with the actual frame count */
556 for (i=0; i<cfg.ts_number_layers; i++)
558 if (!fseek(outfile[i], 0, SEEK_SET))
559 write_ivf_file_header (outfile[i], &cfg, frames_in_layer[i]);