simple_encoder.c 8.89 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
// 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
31
// vp8.
32 33 34 35 36
//
// 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
37
// conferencing application and a best quality offline encoder. These
38 39 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
// 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.
65 66 67 68 69 70 71 72 73

// Forced Keyframes
// ----------------
// Keyframes can be forced by setting the VPX_EFLAG_FORCE_KF bit of the
// flags passed to `vpx_codec_control()`. In this example, we force a
// keyframe every <keyframe-interval> frames. Note, the output stream can
// contain additional keyframes beyond those that have been forced using the
// VPX_EFLAG_FORCE_KF flag because of automatic keyframe placement by the
// encoder.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
//
// 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.
90 91 92 93 94 95 96
//
// 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
97 98 99 100 101

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

102
#include "aom/vpx_encoder.h"
John Koleszar's avatar
John Koleszar committed
103

Tom Finegan's avatar
Tom Finegan committed
104 105
#include "../tools_common.h"
#include "../video_writer.h"
John Koleszar's avatar
John Koleszar committed
106

107
static const char *exec_name;
108

109
void usage_exit(void) {
110 111
  fprintf(stderr,
          "Usage: %s <codec> <width> <height> <infile> <outfile> "
clang-format's avatar
clang-format committed
112 113
          "<keyframe-interval> <error-resilient> <frames to encode>\n"
          "See comments in simple_encoder.c for more information.\n",
114
          exec_name);
115
  exit(EXIT_FAILURE);
116
}
John Koleszar's avatar
John Koleszar committed
117

clang-format's avatar
clang-format committed
118 119
static int encode_frame(vpx_codec_ctx_t *codec, vpx_image_t *img,
                        int frame_index, int flags, VpxVideoWriter *writer) {
120
  int got_pkts = 0;
121 122
  vpx_codec_iter_t iter = NULL;
  const vpx_codec_cx_pkt_t *pkt = NULL;
clang-format's avatar
clang-format committed
123 124 125
  const vpx_codec_err_t res =
      vpx_codec_encode(codec, img, frame_index, 1, flags, VPX_DL_GOOD_QUALITY);
  if (res != VPX_CODEC_OK) die_codec(codec, "Failed to encode frame");
126 127

  while ((pkt = vpx_codec_get_cx_data(codec, &iter)) != NULL) {
128 129
    got_pkts = 1;

130 131
    if (pkt->kind == VPX_CODEC_CX_FRAME_PKT) {
      const int keyframe = (pkt->data.frame.flags & VPX_FRAME_IS_KEY) != 0;
clang-format's avatar
clang-format committed
132
      if (!vpx_video_writer_write_frame(writer, pkt->data.frame.buf,
133 134 135 136 137 138 139 140
                                        pkt->data.frame.sz,
                                        pkt->data.frame.pts)) {
        die_codec(codec, "Failed to write compressed frame");
      }
      printf(keyframe ? "K" : ".");
      fflush(stdout);
    }
  }
141 142

  return got_pkts;
143 144
}

145
// TODO(tomfinegan): Improve command line parsing and add args for bitrate/fps.
John Koleszar's avatar
John Koleszar committed
146
int main(int argc, char **argv) {
147
  FILE *infile = NULL;
148 149 150 151 152
  vpx_codec_ctx_t codec;
  vpx_codec_enc_cfg_t cfg;
  int frame_count = 0;
  vpx_image_t raw;
  vpx_codec_err_t res;
clang-format's avatar
clang-format committed
153
  VpxVideoInfo info = { 0 };
154
  VpxVideoWriter *writer = NULL;
155
  const VpxInterface *encoder = NULL;
156 157
  const int fps = 30;
  const int bitrate = 200;
158
  int keyframe_interval = 0;
159 160
  int max_frames = 0;
  int frames_encoded = 0;
161 162 163 164 165
  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;
166
  const char *keyframe_interval_arg = NULL;
167 168 169

  exec_name = argv[0];

clang-format's avatar
clang-format committed
170
  if (argc != 9) die("Invalid number of arguments");
171

172 173 174 175 176
  codec_arg = argv[1];
  width_arg = argv[2];
  height_arg = argv[3];
  infile_arg = argv[4];
  outfile_arg = argv[5];
177
  keyframe_interval_arg = argv[6];
178
  max_frames = strtol(argv[8], NULL, 0);
179

180
  encoder = get_vpx_encoder_by_name(codec_arg);
clang-format's avatar
clang-format committed
181
  if (!encoder) die("Unsupported codec.");
182 183 184 185

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

clang-format's avatar
clang-format committed
189 190
  if (info.frame_width <= 0 || info.frame_height <= 0 ||
      (info.frame_width % 2) != 0 || (info.frame_height % 2) != 0) {
191 192
    die("Invalid frame size: %dx%d", info.frame_width, info.frame_height);
  }
193 194

  if (!vpx_img_alloc(&raw, VPX_IMG_FMT_I420, info.frame_width,
clang-format's avatar
clang-format committed
195
                     info.frame_height, 1)) {
196 197
    die("Failed to allocate image.");
  }
198

199
  keyframe_interval = strtol(keyframe_interval_arg, NULL, 0);
clang-format's avatar
clang-format committed
200
  if (keyframe_interval < 0) die("Invalid keyframe interval value.");
201

202
  printf("Using %s\n", vpx_codec_iface_name(encoder->codec_interface()));
203

204
  res = vpx_codec_enc_config_default(encoder->codec_interface(), &cfg, 0);
clang-format's avatar
clang-format committed
205
  if (res) die_codec(&codec, "Failed to get default codec config.");
206 207 208 209 210 211

  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;
212
  cfg.g_error_resilient = strtol(argv[7], NULL, 0);
213

214
  writer = vpx_video_writer_open(outfile_arg, kContainerIVF, &info);
clang-format's avatar
clang-format committed
215
  if (!writer) die("Failed to open %s for writing.", outfile_arg);
216

217 218
  if (!(infile = fopen(infile_arg, "rb")))
    die("Failed to open %s for reading.", infile_arg);
219

220
  if (vpx_codec_enc_init(&codec, encoder->codec_interface(), &cfg, 0))
221 222
    die_codec(&codec, "Failed to initialize encoder");

223
  // Encode frames.
224 225 226 227 228
  while (vpx_img_read(&raw, infile)) {
    int flags = 0;
    if (keyframe_interval > 0 && frame_count % keyframe_interval == 0)
      flags |= VPX_EFLAG_FORCE_KF;
    encode_frame(&codec, &raw, frame_count++, flags, writer);
229
    frames_encoded++;
clang-format's avatar
clang-format committed
230
    if (max_frames > 0 && frames_encoded >= max_frames) break;
231
  }
232 233

  // Flush encoder.
clang-format's avatar
clang-format committed
234 235
  while (encode_frame(&codec, NULL, -1, 0, writer)) {
  }
236

237 238 239
  printf("\n");
  fclose(infile);
  printf("Processed %d frames.\n", frame_count);
240

241
  vpx_img_free(&raw);
clang-format's avatar
clang-format committed
242
  if (vpx_codec_destroy(&codec)) die_codec(&codec, "Failed to destroy codec.");
John Koleszar's avatar
John Koleszar committed
243

244
  vpx_video_writer_close(writer);
John Koleszar's avatar
John Koleszar committed
245

246
  return EXIT_SUCCESS;
John Koleszar's avatar
John Koleszar committed
247
}