simple_encoder.c 8.23 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
/*
2
 *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
John Koleszar's avatar
John Koleszar committed
3
 *
4
 *  Use of this source code is governed by a BSD-style license
5 6
 *  that can be found in the LICENSE file in the root of the source
 *  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.
John Koleszar's avatar
John Koleszar committed
9 10
 */

11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
// Simple Encoder
// ==============
//
// This is an example of a simple encoder loop. It takes an input file in
// YV12 format, passes it through the encoder, and writes the compressed
// frames to disk in IVF format. Other decoder examples build upon this
// one.
//
// The details of the IVF format have been elided from this example for
// simplicity of presentation, as IVF files will not generally be used by
// your application. In general, an IVF file consists of a file header,
// followed by a variable number of frames. Each frame consists of a frame
// header followed by a variable length payload. The length of the payload
// is specified in the first four bytes of the frame header. The payload is
// the raw compressed data.
//
// Standard Includes
// -----------------
// For encoders, you only have to include `vpx_encoder.h` and then any
// header files for the specific codecs you use. In this case, we're using
// vp8. The `VPX_CODEC_DISABLE_COMPAT` macro can be defined to ensure
// strict compliance with the latest SDK by disabling some backwards
// compatibility features. Defining this macro is encouraged.
//
// Getting The Default Configuration
// ---------------------------------
// Encoders have the notion of "usage profiles." For example, an encoder
// may want to publish default configurations for both a video
39
// conferencing application and a best quality offline encoder. These
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
// obviously have very different default settings. Consult the
// documentation for your codec to see if it provides any default
// configurations. All codecs provide a default configuration, number 0,
// which is valid for material in the vacinity of QCIF/QVGA.
//
// Updating The Configuration
// ---------------------------------
// Almost all applications will want to update the default configuration
// with settings specific to their usage. Here we set the width and height
// of the video file to that specified on the command line. We also scale
// the default bitrate based on the ratio between the default resolution
// and the resolution specified on the command line.
//
// Initializing The Codec
// ----------------------
// The encoder is initialized by the following code.
//
// Encoding A Frame
// ----------------
// The frame is read as a continuous block (size width * height * 3 / 2)
// from the input file. If a frame was read (the input file has not hit
// EOF) then the frame is passed to the encoder. Otherwise, a NULL
// is passed, indicating the End-Of-Stream condition to the encoder. The
// `frame_cnt` is reused as the presentation time stamp (PTS) and each
// frame is shown for one frame-time in duration. The flags parameter is
// unused in this example. The deadline is set to VPX_DL_REALTIME to
// make the example run as quickly as possible.
//
// Processing The Encoded Data
// ---------------------------
// Each packet of type `VPX_CODEC_CX_FRAME_PKT` contains the encoded data
// for this frame. We write a IVF frame header, followed by the raw data.
//
// Cleanup
// -------
// The `vpx_codec_destroy` call frees any memory allocated by the codec.
//
// Error Handling
// --------------
// This example does not special case any error return codes. If there was
// an error, a descriptive message is printed and the program exits. With
// few exeptions, vpx_codec functions return an enumerated error status,
// with the value `0` indicating success.
83 84 85 86 87 88 89
//
// Error Resiliency Features
// -------------------------
// Error resiliency is controlled by the g_error_resilient member of the
// configuration structure. Use the `decode_with_drops` example to decode with
// frames 5-10 dropped. Compare the output for a file encoded with this example
// versus one encoded with the `simple_encoder` example.
John Koleszar's avatar
John Koleszar committed
90 91 92 93 94

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

95 96
#define VPX_CODEC_DISABLE_COMPAT 1
#include "vpx/vpx_encoder.h"
John Koleszar's avatar
John Koleszar committed
97

98 99
#include "./tools_common.h"
#include "./video_writer.h"
John Koleszar's avatar
John Koleszar committed
100

101
static const char *exec_name;
102

103
void usage_exit() {
104 105 106 107
  fprintf(stderr,
          "Usage: %s <codec> <width> <height> <infile> <outfile> "
              "[<error-resilient>]\nSee comments in simple_encoder.c for more "
              "information.\n",
108
          exec_name);
109
  exit(EXIT_FAILURE);
110
}
John Koleszar's avatar
John Koleszar committed
111

112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
static void encode_frame(vpx_codec_ctx_t *codec,
                         vpx_image_t *img,
                         int frame_index,
                         VpxVideoWriter *writer) {
  vpx_codec_iter_t iter = NULL;
  const vpx_codec_cx_pkt_t *pkt = NULL;
  const vpx_codec_err_t res = vpx_codec_encode(codec, img, frame_index, 1, 0,
                                               VPX_DL_GOOD_QUALITY);
  if (res != VPX_CODEC_OK)
    die_codec(codec, "Failed to encode frame");

  while ((pkt = vpx_codec_get_cx_data(codec, &iter)) != NULL) {
    if (pkt->kind == VPX_CODEC_CX_FRAME_PKT) {
      const int keyframe = (pkt->data.frame.flags & VPX_FRAME_IS_KEY) != 0;
      if (!vpx_video_writer_write_frame(writer,
                                        pkt->data.frame.buf,
                                        pkt->data.frame.sz,
                                        pkt->data.frame.pts)) {
        die_codec(codec, "Failed to write compressed frame");
      }

      printf(keyframe ? "K" : ".");
      fflush(stdout);
    }
  }
}

John Koleszar's avatar
John Koleszar committed
139
int main(int argc, char **argv) {
140
  FILE *infile = NULL;
141 142 143 144 145
  vpx_codec_ctx_t codec;
  vpx_codec_enc_cfg_t cfg;
  int frame_count = 0;
  vpx_image_t raw;
  vpx_codec_err_t res;
146 147
  VpxVideoInfo info = {0};
  VpxVideoWriter *writer = NULL;
148
  const VpxInterface *encoder = NULL;
149 150
  const int fps = 30;        // TODO(dkovalev) add command line argument
  const int bitrate = 200;   // kbit/s TODO(dkovalev) add command line argument
151 152 153 154 155
  const char *codec_arg = NULL;
  const char *width_arg = NULL;
  const char *height_arg = NULL;
  const char *infile_arg = NULL;
  const char *outfile_arg = NULL;
156 157 158

  exec_name = argv[0];

159
  if (argc < 6)
160 161
    die("Invalid number of arguments");

162 163 164 165 166 167
  codec_arg = argv[1];
  width_arg = argv[2];
  height_arg = argv[3];
  infile_arg = argv[4];
  outfile_arg = argv[5];

168 169 170 171 172 173 174
  encoder = get_vpx_encoder_by_name(codec_arg);
  if (!encoder)
     die("Unsupported codec.");

  info.codec_fourcc = encoder->fourcc;
  info.frame_width = strtol(width_arg, NULL, 0);
  info.frame_height = strtol(height_arg, NULL, 0);
175 176 177
  info.time_base.numerator = 1;
  info.time_base.denominator = fps;

178 179 180 181 182 183
  if (info.frame_width <= 0 ||
      info.frame_height <= 0 ||
      (info.frame_width % 2) != 0 ||
      (info.frame_height % 2) != 0) {
    die("Invalid frame size: %dx%d", info.frame_width, info.frame_height);
  }
184 185

  if (!vpx_img_alloc(&raw, VPX_IMG_FMT_I420, info.frame_width,
186 187 188
                                             info.frame_height, 1)) {
    die("Failed to allocate image.");
  }
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 194
  if (res)
    die_codec(&codec, "Failed to get default codec config.");
195 196 197 198 199 200

  cfg.g_w = info.frame_width;
  cfg.g_h = info.frame_height;
  cfg.g_timebase.num = info.time_base.numerator;
  cfg.g_timebase.den = info.time_base.denominator;
  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 208
  if (!(infile = fopen(infile_arg, "rb")))
    die("Failed to open %s for reading.", infile_arg);
209

210
  if (vpx_codec_enc_init(&codec, encoder->interface(), &cfg, 0))
211 212
    die_codec(&codec, "Failed to initialize encoder");

213 214 215 216
  while (vpx_img_read(&raw, infile))
    encode_frame(&codec, &raw, frame_count++, writer);
  encode_frame(&codec, NULL, -1, writer);  // flush the encoder

217 218 219
  printf("\n");
  fclose(infile);
  printf("Processed %d frames.\n", frame_count);
220

221 222 223
  vpx_img_free(&raw);
  if (vpx_codec_destroy(&codec))
    die_codec(&codec, "Failed to destroy codec.");
John Koleszar's avatar
John Koleszar committed
224

225
  vpx_video_writer_close(writer);
John Koleszar's avatar
John Koleszar committed
226

227
  return EXIT_SUCCESS;
John Koleszar's avatar
John Koleszar committed
228
}