2 * Copyright (c) 2010 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.
12 /* This is a simple program that reads ivf files and decodes them
13 * using the new interface. Decoded frames are output as YV12 raw.
22 #define snprintf _snprintf
23 #define isatty _isatty
24 #define fileno _fileno
28 #define VPX_CODEC_DISABLE_COMPAT 1
29 #include "vpx_config.h"
30 #include "vpx/vpx_decoder.h"
31 #include "vpx_ports/vpx_timer.h"
32 #if CONFIG_VP8_DECODER
33 #include "vpx/vp8dx.h"
36 #include "md5_utils.h"
38 #include "tools_common.h"
39 #include "nestegg/include/nestegg/nestegg.h"
45 static const char *exec_name;
47 #define VP8_FOURCC (0x00385056)
51 const vpx_codec_iface_t *iface;
53 unsigned int fourcc_mask;
56 #if CONFIG_VP8_DECODER
57 {"vp8", &vpx_codec_vp8_dx_algo, VP8_FOURCC, 0x00FFFFFF},
62 static const arg_def_t codecarg = ARG_DEF(NULL, "codec", 1,
64 static const arg_def_t use_yv12 = ARG_DEF(NULL, "yv12", 0,
65 "Output raw YV12 frames");
66 static const arg_def_t use_i420 = ARG_DEF(NULL, "i420", 0,
67 "Output raw I420 frames");
68 static const arg_def_t flipuvarg = ARG_DEF(NULL, "flipuv", 0,
69 "Flip the chroma planes in the output");
70 static const arg_def_t noblitarg = ARG_DEF(NULL, "noblit", 0,
71 "Don't process the decoded frames");
72 static const arg_def_t progressarg = ARG_DEF(NULL, "progress", 0,
73 "Show progress after each frame decodes");
74 static const arg_def_t limitarg = ARG_DEF(NULL, "limit", 1,
75 "Stop decoding after n frames");
76 static const arg_def_t postprocarg = ARG_DEF(NULL, "postproc", 0,
77 "Postprocess decoded frames");
78 static const arg_def_t summaryarg = ARG_DEF(NULL, "summary", 0,
79 "Show timing summary");
80 static const arg_def_t outputfile = ARG_DEF("o", "output", 1,
81 "Output file name pattern (see below)");
82 static const arg_def_t threadsarg = ARG_DEF("t", "threads", 1,
83 "Max threads to use");
84 static const arg_def_t verbosearg = ARG_DEF("v", "verbose", 0,
85 "Show version string");
88 static const arg_def_t md5arg = ARG_DEF(NULL, "md5", 0,
89 "Compute the MD5 sum of the decoded frame");
91 static const arg_def_t *all_args[] =
93 &codecarg, &use_yv12, &use_i420, &flipuvarg, &noblitarg,
94 &progressarg, &limitarg, &postprocarg, &summaryarg, &outputfile,
95 &threadsarg, &verbosearg,
102 #if CONFIG_VP8_DECODER
103 static const arg_def_t addnoise_level = ARG_DEF(NULL, "noise-level", 1,
104 "Enable VP8 postproc add noise");
105 static const arg_def_t deblock = ARG_DEF(NULL, "deblock", 0,
106 "Enable VP8 deblocking");
107 static const arg_def_t demacroblock_level = ARG_DEF(NULL, "demacroblock-level", 1,
108 "Enable VP8 demacroblocking, w/ level");
109 static const arg_def_t pp_debug_info = ARG_DEF(NULL, "pp-debug-info", 1,
110 "Enable VP8 visible debug info");
113 static const arg_def_t *vp8_pp_args[] =
115 &addnoise_level, &deblock, &demacroblock_level, &pp_debug_info,
120 static void usage_exit()
124 fprintf(stderr, "Usage: %s <options> filename\n\n"
125 "Options:\n", exec_name);
126 arg_show_usage(stderr, all_args);
127 #if CONFIG_VP8_DECODER
128 fprintf(stderr, "\nVP8 Postprocessing Options:\n");
129 arg_show_usage(stderr, vp8_pp_args);
132 "\nOutput File Patterns:\n\n"
133 " The -o argument specifies the name of the file(s) to "
134 "write to. If the\n argument does not include any escape "
135 "characters, the output will be\n written to a single file. "
136 "Otherwise, the filename will be calculated by\n expanding "
137 "the following escape characters:\n"
138 "\n\t%%w - Frame width"
139 "\n\t%%h - Frame height"
140 "\n\t%%<n> - Frame number, zero padded to <n> places (1..9)"
141 "\n\n Pattern arguments are only supported in conjunction "
142 "with the --yv12 and\n --i420 options. If the -o option is "
143 "not specified, the output will be\n directed to stdout.\n"
145 fprintf(stderr, "\nIncluded decoders:\n\n");
147 for (i = 0; i < sizeof(ifaces) / sizeof(ifaces[0]); i++)
148 fprintf(stderr, " %-6s - %s\n",
150 vpx_codec_iface_name(ifaces[i].iface));
155 void die(const char *fmt, ...)
159 vfprintf(stderr, fmt, ap);
160 fprintf(stderr, "\n");
164 static unsigned int mem_get_le16(const void *vmem)
167 const unsigned char *mem = (const unsigned char *)vmem;
174 static unsigned int mem_get_le32(const void *vmem)
177 const unsigned char *mem = (const unsigned char *)vmem;
197 nestegg *nestegg_ctx;
201 unsigned int video_track;
204 #define IVF_FRAME_HDR_SZ (sizeof(uint32_t) + sizeof(uint64_t))
205 #define RAW_FRAME_HDR_SZ (sizeof(uint32_t))
206 static int read_frame(struct input_ctx *input,
209 size_t *buf_alloc_sz)
211 char raw_hdr[IVF_FRAME_HDR_SZ];
213 FILE *infile = input->infile;
214 enum file_kind kind = input->kind;
215 if(kind == WEBM_FILE)
217 if(input->chunk >= input->chunks)
223 /* End of this packet, get another. */
225 nestegg_free_packet(input->pkt);
227 if(nestegg_read_packet(input->nestegg_ctx, &input->pkt) <= 0
228 || nestegg_packet_track(input->pkt, &track))
231 } while(track != input->video_track);
233 if(nestegg_packet_count(input->pkt, &input->chunks))
238 if(nestegg_packet_data(input->pkt, input->chunk, buf, buf_sz))
244 /* For both the raw and ivf formats, the frame size is the first 4 bytes
245 * of the frame header. We just need to special case on the header
248 else if (fread(raw_hdr, kind==IVF_FILE
249 ? IVF_FRAME_HDR_SZ : RAW_FRAME_HDR_SZ, 1, infile) != 1)
252 fprintf(stderr, "Failed to read frame size\n");
258 new_buf_sz = mem_get_le32(raw_hdr);
260 if (new_buf_sz > 256 * 1024 * 1024)
262 fprintf(stderr, "Error: Read invalid frame size (%u)\n",
263 (unsigned int)new_buf_sz);
267 if (kind == RAW_FILE && new_buf_sz > 256 * 1024)
268 fprintf(stderr, "Warning: Read invalid frame size (%u)"
269 " - not a raw file?\n", (unsigned int)new_buf_sz);
271 if (new_buf_sz > *buf_alloc_sz)
273 uint8_t *new_buf = realloc(*buf, 2 * new_buf_sz);
278 *buf_alloc_sz = 2 * new_buf_sz;
282 fprintf(stderr, "Failed to allocate compressed data buffer\n");
288 *buf_sz = new_buf_sz;
292 if (fread(*buf, 1, *buf_sz, infile) != *buf_sz)
294 fprintf(stderr, "Failed to read full frame\n");
304 void *out_open(const char *out_fn, int do_md5)
311 MD5Context *md5_ctx = out = malloc(sizeof(MD5Context));
318 FILE *outfile = out = strcmp("-", out_fn) ? fopen(out_fn, "wb")
319 : set_binary_mode(stdout);
323 fprintf(stderr, "Failed to output file");
331 void out_put(void *out, const uint8_t *buf, unsigned int len, int do_md5)
336 MD5Update(out, buf, len);
341 if(fwrite(buf, 1, len, out));
345 void out_close(void *out, const char *out_fn, int do_md5)
356 for (i = 0; i < 16; i++)
357 printf("%02x", md5[i]);
359 printf(" %s\n", out_fn);
368 unsigned int file_is_ivf(FILE *infile,
369 unsigned int *fourcc,
371 unsigned int *height,
372 unsigned int *fps_den,
373 unsigned int *fps_num)
378 if (fread(raw_hdr, 1, 32, infile) == 32)
380 if (raw_hdr[0] == 'D' && raw_hdr[1] == 'K'
381 && raw_hdr[2] == 'I' && raw_hdr[3] == 'F')
385 if (mem_get_le16(raw_hdr + 4) != 0)
386 fprintf(stderr, "Error: Unrecognized IVF version! This file may not"
387 " decode properly.");
389 *fourcc = mem_get_le32(raw_hdr + 8);
390 *width = mem_get_le16(raw_hdr + 12);
391 *height = mem_get_le16(raw_hdr + 14);
392 *fps_num = mem_get_le32(raw_hdr + 16);
393 *fps_den = mem_get_le32(raw_hdr + 20);
395 /* Some versions of vpxenc used 1/(2*fps) for the timebase, so
396 * we can guess the framerate using only the timebase in this
397 * case. Other files would require reading ahead to guess the
398 * timebase, like we do for webm.
402 /* Correct for the factor of 2 applied to the timebase in the
405 if(*fps_num&1)*fps_den<<=1;
410 /* Don't know FPS for sure, and don't have readahead code
411 * (yet?), so just default to 30fps.
426 unsigned int file_is_raw(FILE *infile,
427 unsigned int *fourcc,
429 unsigned int *height,
430 unsigned int *fps_den,
431 unsigned int *fps_num)
433 unsigned char buf[32];
435 vpx_codec_stream_info_t si;
437 if (fread(buf, 1, 32, infile) == 32)
441 if(mem_get_le32(buf) < 256 * 1024 * 1024)
442 for (i = 0; i < sizeof(ifaces) / sizeof(ifaces[0]); i++)
443 if(!vpx_codec_peek_stream_info(ifaces[i].iface,
444 buf + 4, 32 - 4, &si))
447 *fourcc = ifaces[i].fourcc;
462 nestegg_read_cb(void *buffer, size_t length, void *userdata)
466 if(fread(buffer, 1, length, f) < length)
478 nestegg_seek_cb(int64_t offset, int whence, void * userdata)
481 case NESTEGG_SEEK_SET: whence = SEEK_SET; break;
482 case NESTEGG_SEEK_CUR: whence = SEEK_CUR; break;
483 case NESTEGG_SEEK_END: whence = SEEK_END; break;
485 return fseek(userdata, offset, whence)? -1 : 0;
490 nestegg_tell_cb(void * userdata)
492 return ftell(userdata);
497 nestegg_log_cb(nestegg * context, unsigned int severity, char const * format,
502 va_start(ap, format);
503 vfprintf(stderr, format, ap);
504 fprintf(stderr, "\n");
510 webm_guess_framerate(struct input_ctx *input,
511 unsigned int *fps_den,
512 unsigned int *fps_num)
517 /* Guess the framerate. Read up to 1 second, or 50 video packets,
518 * whichever comes first.
520 for(i=0; tstamp < 1000000000 && i < 50;)
522 nestegg_packet * pkt;
525 if(nestegg_read_packet(input->nestegg_ctx, &pkt) <= 0)
528 nestegg_packet_track(pkt, &track);
529 if(track == input->video_track)
531 nestegg_packet_tstamp(pkt, &tstamp);
535 nestegg_free_packet(pkt);
538 if(nestegg_track_seek(input->nestegg_ctx, input->video_track, 0))
541 *fps_num = (i - 1) * 1000000;
542 *fps_den = tstamp / 1000;
545 input->nestegg_ctx = NULL;
546 rewind(input->infile);
552 file_is_webm(struct input_ctx *input,
553 unsigned int *fourcc,
555 unsigned int *height,
556 unsigned int *fps_den,
557 unsigned int *fps_num)
563 nestegg_io io = {nestegg_read_cb, nestegg_seek_cb, nestegg_tell_cb,
565 nestegg_video_params params;
566 nestegg_packet * pkt;
568 if(nestegg_init(&input->nestegg_ctx, io, NULL))
571 if(nestegg_track_count(input->nestegg_ctx, &n))
576 track_type = nestegg_track_type(input->nestegg_ctx, i);
578 if(track_type == NESTEGG_TRACK_VIDEO)
580 else if(track_type < 0)
584 if(nestegg_track_codec_id(input->nestegg_ctx, i) != NESTEGG_CODEC_VP8)
586 fprintf(stderr, "Not VP8 video, quitting.\n");
590 input->video_track = i;
592 if(nestegg_track_video_params(input->nestegg_ctx, i, ¶ms))
597 *fourcc = VP8_FOURCC;
598 *width = params.width;
599 *height = params.height;
602 input->nestegg_ctx = NULL;
603 rewind(input->infile);
608 void show_progress(int frame_in, int frame_out, unsigned long dx_time)
610 fprintf(stderr, "%d decoded frames/%d showed frames in %lu us (%.2f fps)\r",
611 frame_in, frame_out, dx_time,
612 (float)frame_out * 1000000.0 / (float)dx_time);
616 void generate_filename(const char *pattern, char *out, size_t q_len,
617 unsigned int d_w, unsigned int d_h,
618 unsigned int frame_in)
620 const char *p = pattern;
625 char *next_pat = strchr(p, '%');
635 case 'w': snprintf(q, q_len - 1, "%d", d_w); break;
636 case 'h': snprintf(q, q_len - 1, "%d", d_h); break;
637 case '1': snprintf(q, q_len - 1, "%d", frame_in); break;
638 case '2': snprintf(q, q_len - 1, "%02d", frame_in); break;
639 case '3': snprintf(q, q_len - 1, "%03d", frame_in); break;
640 case '4': snprintf(q, q_len - 1, "%04d", frame_in); break;
641 case '5': snprintf(q, q_len - 1, "%05d", frame_in); break;
642 case '6': snprintf(q, q_len - 1, "%06d", frame_in); break;
643 case '7': snprintf(q, q_len - 1, "%07d", frame_in); break;
644 case '8': snprintf(q, q_len - 1, "%08d", frame_in); break;
645 case '9': snprintf(q, q_len - 1, "%09d", frame_in); break;
647 die("Unrecognized pattern %%%c\n", p[1]);
651 if(pat_len >= q_len - 1)
652 die("Output filename too long.\n");
661 // copy the next segment
663 copy_len = strlen(p);
665 copy_len = next_pat - p;
667 if(copy_len >= q_len - 1)
668 die("Output filename too long.\n");
670 memcpy(q, p, copy_len);
680 int main(int argc, const char **argv_)
682 vpx_codec_ctx_t decoder;
686 size_t buf_sz = 0, buf_alloc_sz = 0;
688 int frame_in = 0, frame_out = 0, flipuv = 0, noblit = 0, do_md5 = 0, progress = 0;
689 int stop_after = 0, postproc = 0, summary = 0, quiet = 1;
690 vpx_codec_iface_t *iface = NULL;
692 unsigned long dx_time = 0;
694 char **argv, **argi, **argj;
695 const char *outfile_pattern = 0;
696 char outfile[PATH_MAX];
701 unsigned int fps_den;
702 unsigned int fps_num;
704 vpx_codec_dec_cfg_t cfg = {0};
705 #if CONFIG_VP8_DECODER
706 vp8_postproc_cfg_t vp8_pp_cfg = {0};
708 struct input_ctx input = {0};
710 /* Parse command line */
711 exec_name = argv_[0];
712 argv = argv_dup(argc - 1, argv_ + 1);
714 for (argi = argj = argv; (*argj = *argi); argi += arg.argv_step)
716 memset(&arg, 0, sizeof(arg));
719 if (arg_match(&arg, &codecarg, argi))
723 for (j = 0; j < sizeof(ifaces) / sizeof(ifaces[0]); j++)
724 if (!strcmp(ifaces[j].name, arg.val))
728 iface = ifaces[k].iface;
730 die("Error: Unrecognized argument (%s) to --codec\n",
733 else if (arg_match(&arg, &outputfile, argi))
734 outfile_pattern = arg.val;
735 else if (arg_match(&arg, &use_yv12, argi))
740 else if (arg_match(&arg, &use_i420, argi))
745 else if (arg_match(&arg, &flipuvarg, argi))
747 else if (arg_match(&arg, &noblitarg, argi))
749 else if (arg_match(&arg, &progressarg, argi))
751 else if (arg_match(&arg, &limitarg, argi))
752 stop_after = arg_parse_uint(&arg);
753 else if (arg_match(&arg, &postprocarg, argi))
755 else if (arg_match(&arg, &md5arg, argi))
757 else if (arg_match(&arg, &summaryarg, argi))
759 else if (arg_match(&arg, &threadsarg, argi))
760 cfg.threads = arg_parse_uint(&arg);
761 else if (arg_match(&arg, &verbosearg, argi))
764 #if CONFIG_VP8_DECODER
765 else if (arg_match(&arg, &addnoise_level, argi))
768 vp8_pp_cfg.post_proc_flag |= VP8_ADDNOISE;
769 vp8_pp_cfg.noise_level = arg_parse_uint(&arg);
771 else if (arg_match(&arg, &demacroblock_level, argi))
774 vp8_pp_cfg.post_proc_flag |= VP8_DEMACROBLOCK;
775 vp8_pp_cfg.deblocking_level = arg_parse_uint(&arg);
777 else if (arg_match(&arg, &deblock, argi))
780 vp8_pp_cfg.post_proc_flag |= VP8_DEBLOCK;
782 else if (arg_match(&arg, &pp_debug_info, argi))
784 unsigned int level = arg_parse_uint(&arg);
787 vp8_pp_cfg.post_proc_flag &= ~0x7;
790 vp8_pp_cfg.post_proc_flag |= level;
798 /* Check for unrecognized options */
799 for (argi = argv; *argi; argi++)
800 if (argi[0][0] == '-' && strlen(argi[0]) > 1)
801 die("Error: Unrecognized option %s\n", *argi);
803 /* Handle non-option arguments */
810 infile = strcmp(fn, "-") ? fopen(fn, "rb") : set_binary_mode(stdin);
814 fprintf(stderr, "Failed to open file '%s'",
815 strcmp(fn, "-") ? fn : "stdin");
819 /* Make sure we don't dump to the terminal, unless forced to with -o - */
820 if(!outfile_pattern && isatty(fileno(stdout)) && !do_md5 && !noblit)
823 "Not dumping raw video to your terminal. Use '-o -' to "
828 input.infile = infile;
829 if(file_is_ivf(infile, &fourcc, &width, &height, &fps_den,
831 input.kind = IVF_FILE;
832 else if(file_is_webm(&input, &fourcc, &width, &height, &fps_den, &fps_num))
833 input.kind = WEBM_FILE;
834 else if(file_is_raw(infile, &fourcc, &width, &height, &fps_den, &fps_num))
835 input.kind = RAW_FILE;
838 fprintf(stderr, "Unrecognized input file type.\n");
842 /* If the output file is not set or doesn't have a sequence number in
843 * it, then we only open it once.
845 outfile_pattern = outfile_pattern ? outfile_pattern : "-";
848 const char *p = outfile_pattern;
852 if(p && p[1] >= '1' && p[1] <= '9')
854 // pattern contains sequence number, so it's not unique.
863 if(single_file && !noblit)
865 generate_filename(outfile_pattern, outfile, sizeof(outfile)-1,
867 out = out_open(outfile, do_md5);
870 if (use_y4m && !noblit)
875 fprintf(stderr, "YUV4MPEG2 not supported with output patterns,"
876 " try --i420 or --yv12.\n");
880 if(input.kind == WEBM_FILE)
881 webm_guess_framerate(&input, &fps_den, &fps_num);
883 /*Note: We can't output an aspect ratio here because IVF doesn't
884 store one, and neither does VP8.
885 That will have to wait until these tools support WebM natively.*/
886 sprintf(buffer, "YUV4MPEG2 C%s W%u H%u F%u:%u I%c\n",
887 "420jpeg", width, height, fps_num, fps_den, 'p');
888 out_put(out, (unsigned char *)buffer, strlen(buffer), do_md5);
891 /* Try to determine the codec from the fourcc. */
892 for (i = 0; i < sizeof(ifaces) / sizeof(ifaces[0]); i++)
893 if ((fourcc & ifaces[i].fourcc_mask) == ifaces[i].fourcc)
895 vpx_codec_iface_t *ivf_iface = ifaces[i].iface;
897 if (iface && iface != ivf_iface)
898 fprintf(stderr, "Notice -- IVF header indicates codec: %s\n",
906 if (vpx_codec_dec_init(&decoder, iface ? iface : ifaces[0].iface, &cfg,
907 postproc ? VPX_CODEC_USE_POSTPROC : 0))
909 fprintf(stderr, "Failed to initialize decoder: %s\n", vpx_codec_error(&decoder));
914 fprintf(stderr, "%s\n", decoder.name);
916 #if CONFIG_VP8_DECODER
918 if (vp8_pp_cfg.post_proc_flag
919 && vpx_codec_control(&decoder, VP8_SET_POSTPROC, &vp8_pp_cfg))
921 fprintf(stderr, "Failed to configure postproc: %s\n", vpx_codec_error(&decoder));
928 while (!read_frame(&input, &buf, &buf_sz, &buf_alloc_sz))
930 vpx_codec_iter_t iter = NULL;
932 struct vpx_usec_timer timer;
934 vpx_usec_timer_start(&timer);
936 if (vpx_codec_decode(&decoder, buf, buf_sz, NULL, 0))
938 const char *detail = vpx_codec_error_detail(&decoder);
939 fprintf(stderr, "Failed to decode frame: %s\n", vpx_codec_error(&decoder));
942 fprintf(stderr, " Additional information: %s\n", detail);
947 vpx_usec_timer_mark(&timer);
948 dx_time += vpx_usec_timer_elapsed(&timer);
952 if ((img = vpx_codec_get_frame(&decoder, &iter)))
956 show_progress(frame_in, frame_out, dx_time);
963 char out_fn[PATH_MAX];
968 size_t len = sizeof(out_fn)-1;
971 generate_filename(outfile_pattern, out_fn, len-1,
972 img->d_w, img->d_h, frame_in);
973 out = out_open(out_fn, do_md5);
976 out_put(out, (unsigned char *)"FRAME\n", 6, do_md5);
978 buf = img->planes[VPX_PLANE_Y];
980 for (y = 0; y < img->d_h; y++)
982 out_put(out, buf, img->d_w, do_md5);
983 buf += img->stride[VPX_PLANE_Y];
986 buf = img->planes[flipuv?VPX_PLANE_V:VPX_PLANE_U];
988 for (y = 0; y < (1 + img->d_h) / 2; y++)
990 out_put(out, buf, (1 + img->d_w) / 2, do_md5);
991 buf += img->stride[VPX_PLANE_U];
994 buf = img->planes[flipuv?VPX_PLANE_U:VPX_PLANE_V];
996 for (y = 0; y < (1 + img->d_h) / 2; y++)
998 out_put(out, buf, (1 + img->d_w) / 2, do_md5);
999 buf += img->stride[VPX_PLANE_V];
1003 out_close(out, out_fn, do_md5);
1007 if (stop_after && frame_in >= stop_after)
1011 if (summary || progress)
1013 show_progress(frame_in, frame_out, dx_time);
1014 fprintf(stderr, "\n");
1019 if (vpx_codec_destroy(&decoder))
1021 fprintf(stderr, "Failed to destroy decoder: %s\n", vpx_codec_error(&decoder));
1022 return EXIT_FAILURE;
1025 if (single_file && !noblit)
1026 out_close(out, outfile, do_md5);
1028 if(input.nestegg_ctx)
1029 nestegg_destroy(input.nestegg_ctx);
1030 if(input.kind != WEBM_FILE)
1035 return EXIT_SUCCESS;