src/third_party/libvpx/source/libvpx/examples/simple_encoder.c

   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 // Processing The Encoded Data
  69 // ---------------------------
  70 // Each packet of type `VPX_CODEC_CX_FRAME_PKT` contains the encoded data
  71 // for this frame. We write a IVF frame header, followed by the raw data.
  72 //
  73 // Cleanup
  74 // -------
  75 // The `vpx_codec_destroy` call frees any memory allocated by the codec.
  76 //
  77 // Error Handling
  78 // --------------
  79 // This example does not special case any error return codes. If there was
  80 // an error, a descriptive message is printed and the program exits. With
  81 // few exeptions, vpx_codec functions return an enumerated error status,
  82 // with the value `0` indicating success.
  83 //
  84 // Error Resiliency Features
  85 // -------------------------
  86 // Error resiliency is controlled by the g_error_resilient member of the
  87 // configuration structure. Use the `decode_with_drops` example to decode with
  88 // frames 5-10 dropped. Compare the output for a file encoded with this example
  89 // versus one encoded with the `simple_encoder` example.
  90
  91 #include <stdio.h>
  92 #include <stdlib.h>
  93 #include <string.h>
  94
  95 #define VPX_CODEC_DISABLE_COMPAT 1
  96 #include "vpx/vpx_encoder.h"
  97
  98 #include "./tools_common.h"
  99 #include "./video_writer.h"
 100
 101 static const char *exec_name;
 102
 103 void usage_exit() {
 104   fprintf(stderr,
 105           "Usage: %s <codec> <width> <height> <infile> <outfile> "
 106               "[<error-resilient>]\nSee comments in simple_encoder.c for more "
 107               "information.\n",
 108           exec_name);
 109   exit(EXIT_FAILURE);
 110 }
 111
 112 static void encode_frame(vpx_codec_ctx_t *codec,
 113                          vpx_image_t *img,
 114                          int frame_index,
 115                          VpxVideoWriter *writer) {
 116   vpx_codec_iter_t iter = NULL;
 117   const vpx_codec_cx_pkt_t *pkt = NULL;
 118   const vpx_codec_err_t res = vpx_codec_encode(codec, img, frame_index, 1, 0,
 119                                                VPX_DL_GOOD_QUALITY);
 120   if (res != VPX_CODEC_OK)
 121     die_codec(codec, "Failed to encode frame");
 122
 123   while ((pkt = vpx_codec_get_cx_data(codec, &iter)) != NULL) {
 124     if (pkt->kind == VPX_CODEC_CX_FRAME_PKT) {
 125       const int keyframe = (pkt->data.frame.flags & VPX_FRAME_IS_KEY) != 0;
 126       if (!vpx_video_writer_write_frame(writer,
 127                                         pkt->data.frame.buf,
 128                                         pkt->data.frame.sz,
 129                                         pkt->data.frame.pts)) {
 130         die_codec(codec, "Failed to write compressed frame");
 131       }
 132
 133       printf(keyframe ? "K" : ".");
 134       fflush(stdout);
 135     }
 136   }
 137 }
 138
 139 int main(int argc, char **argv) {
 140   FILE *infile = NULL;
 141   vpx_codec_ctx_t codec;
 142   vpx_codec_enc_cfg_t cfg;
 143   int frame_count = 0;
 144   vpx_image_t raw;
 145   vpx_codec_err_t res;
 146   VpxVideoInfo info = {0};
 147   VpxVideoWriter *writer = NULL;
 148   const VpxInterface *encoder = NULL;
 149   const int fps = 30;        // TODO(dkovalev) add command line argument
 150   const int bitrate = 200;   // kbit/s TODO(dkovalev) add command line argument
 151   const char *codec_arg = NULL;
 152   const char *width_arg = NULL;
 153   const char *height_arg = NULL;
 154   const char *infile_arg = NULL;
 155   const char *outfile_arg = NULL;
 156
 157   exec_name = argv[0];
 158
 159   if (argc < 6)
 160     die("Invalid number of arguments");
 161
 162   codec_arg = argv[1];
 163   width_arg = argv[2];
 164   height_arg = argv[3];
 165   infile_arg = argv[4];
 166   outfile_arg = argv[5];
 167
 168   encoder = get_vpx_encoder_by_name(codec_arg);
 169   if (!encoder)
 170      die("Unsupported codec.");
 171
 172   info.codec_fourcc = encoder->fourcc;
 173   info.frame_width = strtol(width_arg, NULL, 0);
 174   info.frame_height = strtol(height_arg, NULL, 0);
 175   info.time_base.numerator = 1;
 176   info.time_base.denominator = fps;
 177
 178   if (info.frame_width <= 0 ||
 179       info.frame_height <= 0 ||
 180       (info.frame_width % 2) != 0 ||
 181       (info.frame_height % 2) != 0) {
 182     die("Invalid frame size: %dx%d", info.frame_width, info.frame_height);
 183   }
 184
 185   if (!vpx_img_alloc(&raw, VPX_IMG_FMT_I420, info.frame_width,
 186                                              info.frame_height, 1)) {
 187     die("Failed to allocate image.");
 188   }
 189
 190   printf("Using %s\n", vpx_codec_iface_name(encoder->interface()));
 191
 192   res = vpx_codec_enc_config_default(encoder->interface(), &cfg, 0);
 193   if (res)
 194     die_codec(&codec, "Failed to get default codec config.");
 195
 196   cfg.g_w = info.frame_width;
 197   cfg.g_h = info.frame_height;
 198   cfg.g_timebase.num = info.time_base.numerator;
 199   cfg.g_timebase.den = info.time_base.denominator;
 200   cfg.rc_target_bitrate = bitrate;
 201   cfg.g_error_resilient = argc > 6 ? strtol(argv[6], NULL, 0) : 0;
 202
 203   writer = vpx_video_writer_open(outfile_arg, kContainerIVF, &info);
 204   if (!writer)
 205     die("Failed to open %s for writing.", outfile_arg);
 206
 207   if (!(infile = fopen(infile_arg, "rb")))
 208     die("Failed to open %s for reading.", infile_arg);
 209
 210   if (vpx_codec_enc_init(&codec, encoder->interface(), &cfg, 0))
 211     die_codec(&codec, "Failed to initialize encoder");
 212
 213   while (vpx_img_read(&raw, infile))
 214     encode_frame(&codec, &raw, frame_count++, writer);
 215   encode_frame(&codec, NULL, -1, writer);  // flush the encoder
 216
 217   printf("\n");
 218   fclose(infile);
 219   printf("Processed %d frames.\n", frame_count);
 220
 221   vpx_img_free(&raw);
 222   if (vpx_codec_destroy(&codec))
 223     die_codec(&codec, "Failed to destroy codec.");
 224
 225   vpx_video_writer_close(writer);
 226
 227   return EXIT_SUCCESS;
 228 }