1 /* 2 * Copyright (c) 2010 The WebM 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 // Simple Encoder 12 // ============== 13 // 14 // This is an example of a simple encoder loop. It takes an input file in 15 // YV12 format, passes it through the encoder, and writes the compressed 16 // frames to disk in IVF format. Other decoder examples build upon this 17 // one. 18 // 19 // The details of the IVF format have been elided from this example for 20 // simplicity of presentation, as IVF files will not generally be used by 21 // your application. In general, an IVF file consists of a file header, 22 // followed by a variable number of frames. Each frame consists of a frame 23 // header followed by a variable length payload. The length of the payload 24 // is specified in the first four bytes of the frame header. The payload is 25 // the raw compressed data. 26 // 27 // Standard Includes 28 // ----------------- 29 // For encoders, you only have to include `vpx_encoder.h` and then any 30 // header files for the specific codecs you use. In this case, we're using 31 // vp8. The `VPX_CODEC_DISABLE_COMPAT` macro can be defined to ensure 32 // strict compliance with the latest SDK by disabling some backwards 33 // compatibility features. Defining this macro is encouraged. 34 // 35 // Getting The Default Configuration 36 // --------------------------------- 37 // Encoders have the notion of "usage profiles." For example, an encoder 38 // may want to publish default configurations for both a video 39 // conferencing application and a best quality offline encoder. These 40 // obviously have very different default settings. Consult the 41 // documentation for your codec to see if it provides any default 42 // configurations. All codecs provide a default configuration, number 0, 43 // which is valid for material in the vacinity of QCIF/QVGA. 44 // 45 // Updating The Configuration 46 // --------------------------------- 47 // Almost all applications will want to update the default configuration 48 // with settings specific to their usage. Here we set the width and height 49 // of the video file to that specified on the command line. We also scale 50 // the default bitrate based on the ratio between the default resolution 51 // and the resolution specified on the command line. 52 // 53 // Initializing The Codec 54 // ---------------------- 55 // The encoder is initialized by the following code. 56 // 57 // Encoding A Frame 58 // ---------------- 59 // The frame is read as a continuous block (size width * height * 3 / 2) 60 // from the input file. If a frame was read (the input file has not hit 61 // EOF) then the frame is passed to the encoder. Otherwise, a NULL 62 // is passed, indicating the End-Of-Stream condition to the encoder. The 63 // `frame_cnt` is reused as the presentation time stamp (PTS) and each 64 // frame is shown for one frame-time in duration. The flags parameter is 65 // unused in this example. The deadline is set to VPX_DL_REALTIME to 66 // make the example run as quickly as possible. 67 68 // Forced Keyframes 69 // ---------------- 70 // Keyframes can be forced by setting the VPX_EFLAG_FORCE_KF bit of the 71 // flags passed to `vpx_codec_control()`. In this example, we force a 72 // keyframe every <keyframe-interval> frames. Note, the output stream can 73 // contain additional keyframes beyond those that have been forced using the 74 // VPX_EFLAG_FORCE_KF flag because of automatic keyframe placement by the 75 // encoder. 76 // 77 // Processing The Encoded Data 78 // --------------------------- 79 // Each packet of type `VPX_CODEC_CX_FRAME_PKT` contains the encoded data 80 // for this frame. We write a IVF frame header, followed by the raw data. 81 // 82 // Cleanup 83 // ------- 84 // The `vpx_codec_destroy` call frees any memory allocated by the codec. 85 // 86 // Error Handling 87 // -------------- 88 // This example does not special case any error return codes. If there was 89 // an error, a descriptive message is printed and the program exits. With 90 // few exeptions, vpx_codec functions return an enumerated error status, 91 // with the value `0` indicating success. 92 // 93 // Error Resiliency Features 94 // ------------------------- 95 // Error resiliency is controlled by the g_error_resilient member of the 96 // configuration structure. Use the `decode_with_drops` example to decode with 97 // frames 5-10 dropped. Compare the output for a file encoded with this example 98 // versus one encoded with the `simple_encoder` example. 99 100 #include <stdio.h> 101 #include <stdlib.h> 102 #include <string.h> 103 104 #define VPX_CODEC_DISABLE_COMPAT 1 105 #include "vpx/vpx_encoder.h" 106 107 #include "./tools_common.h" 108 #include "./video_writer.h" 109 110 static const char *exec_name; 111 112 void usage_exit() { 113 fprintf(stderr, 114 "Usage: %s <codec> <width> <height> <infile> <outfile> " 115 "<keyframe-interval> [<error-resilient>]\nSee comments in " 116 "simple_encoder.c for more information.\n", 117 exec_name); 118 exit(EXIT_FAILURE); 119 } 120 121 static void encode_frame(vpx_codec_ctx_t *codec, 122 vpx_image_t *img, 123 int frame_index, 124 int flags, 125 VpxVideoWriter *writer) { 126 vpx_codec_iter_t iter = NULL; 127 const vpx_codec_cx_pkt_t *pkt = NULL; 128 const vpx_codec_err_t res = vpx_codec_encode(codec, img, frame_index, 1, 129 flags, VPX_DL_GOOD_QUALITY); 130 if (res != VPX_CODEC_OK) 131 die_codec(codec, "Failed to encode frame"); 132 133 while ((pkt = vpx_codec_get_cx_data(codec, &iter)) != NULL) { 134 if (pkt->kind == VPX_CODEC_CX_FRAME_PKT) { 135 const int keyframe = (pkt->data.frame.flags & VPX_FRAME_IS_KEY) != 0; 136 if (!vpx_video_writer_write_frame(writer, 137 pkt->data.frame.buf, 138 pkt->data.frame.sz, 139 pkt->data.frame.pts)) { 140 die_codec(codec, "Failed to write compressed frame"); 141 } 142 143 printf(keyframe ? "K" : "."); 144 fflush(stdout); 145 } 146 } 147 } 148 149 int main(int argc, char **argv) { 150 FILE *infile = NULL; 151 vpx_codec_ctx_t codec; 152 vpx_codec_enc_cfg_t cfg; 153 int frame_count = 0; 154 vpx_image_t raw; 155 vpx_codec_err_t res; 156 VpxVideoInfo info = {0}; 157 VpxVideoWriter *writer = NULL; 158 const VpxInterface *encoder = NULL; 159 const int fps = 30; // TODO(dkovalev) add command line argument 160 const int bitrate = 200; // kbit/s TODO(dkovalev) add command line argument 161 int keyframe_interval = 0; 162 163 // TODO(dkovalev): Add some simple command line parsing code to make the 164 // command line more flexible. 165 const char *codec_arg = NULL; 166 const char *width_arg = NULL; 167 const char *height_arg = NULL; 168 const char *infile_arg = NULL; 169 const char *outfile_arg = NULL; 170 const char *keyframe_interval_arg = NULL; 171 172 exec_name = argv[0]; 173 174 if (argc < 7) 175 die("Invalid number of arguments"); 176 177 codec_arg = argv[1]; 178 width_arg = argv[2]; 179 height_arg = argv[3]; 180 infile_arg = argv[4]; 181 outfile_arg = argv[5]; 182 keyframe_interval_arg = argv[6]; 183 184 encoder = get_vpx_encoder_by_name(codec_arg); 185 if (!encoder) 186 die("Unsupported codec."); 187 188 info.codec_fourcc = encoder->fourcc; 189 info.frame_width = strtol(width_arg, NULL, 0); 190 info.frame_height = strtol(height_arg, NULL, 0); 191 info.time_base.numerator = 1; 192 info.time_base.denominator = fps; 193 194 if (info.frame_width <= 0 || 195 info.frame_height <= 0 || 196 (info.frame_width % 2) != 0 || 197 (info.frame_height % 2) != 0) { 198 die("Invalid frame size: %dx%d", info.frame_width, info.frame_height); 199 } 200 201 if (!vpx_img_alloc(&raw, VPX_IMG_FMT_I420, info.frame_width, 202 info.frame_height, 1)) { 203 die("Failed to allocate image."); 204 } 205 206 keyframe_interval = strtol(keyframe_interval_arg, NULL, 0); 207 if (keyframe_interval < 0) 208 die("Invalid keyframe interval value."); 209 210 printf("Using %s\n", vpx_codec_iface_name(encoder->interface())); 211 212 res = vpx_codec_enc_config_default(encoder->interface(), &cfg, 0); 213 if (res) 214 die_codec(&codec, "Failed to get default codec config."); 215 216 cfg.g_w = info.frame_width; 217 cfg.g_h = info.frame_height; 218 cfg.g_timebase.num = info.time_base.numerator; 219 cfg.g_timebase.den = info.time_base.denominator; 220 cfg.rc_target_bitrate = bitrate; 221 cfg.g_error_resilient = argc > 7 ? strtol(argv[7], NULL, 0) : 0; 222 223 writer = vpx_video_writer_open(outfile_arg, kContainerIVF, &info); 224 if (!writer) 225 die("Failed to open %s for writing.", outfile_arg); 226 227 if (!(infile = fopen(infile_arg, "rb"))) 228 die("Failed to open %s for reading.", infile_arg); 229 230 if (vpx_codec_enc_init(&codec, encoder->interface(), &cfg, 0)) 231 die_codec(&codec, "Failed to initialize encoder"); 232 233 while (vpx_img_read(&raw, infile)) { 234 int flags = 0; 235 if (keyframe_interval > 0 && frame_count % keyframe_interval == 0) 236 flags |= VPX_EFLAG_FORCE_KF; 237 encode_frame(&codec, &raw, frame_count++, flags, writer); 238 } 239 encode_frame(&codec, NULL, -1, 0, writer); // flush the encoder 240 241 printf("\n"); 242 fclose(infile); 243 printf("Processed %d frames.\n", frame_count); 244 245 vpx_img_free(&raw); 246 if (vpx_codec_destroy(&codec)) 247 die_codec(&codec, "Failed to destroy codec."); 248 249 vpx_video_writer_close(writer); 250 251 return EXIT_SUCCESS; 252 } 253