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 // VP8 Set Active and ROI Maps
13 // ===========================
15 // This is an example demonstrating how to control the VP8 encoder's
16 // ROI and Active maps.
18 // ROI (Reigon of Interest) maps are a way for the application to assign
19 // each macroblock in the image to a region, and then set quantizer and
20 // filtering parameters on that image.
22 // Active maps are a way for the application to specify on a
23 // macroblock-by-macroblock basis whether there is any activity in that
29 // An ROI map is set on frame 22. If the width of the image in macroblocks
30 // is evenly divisble by 4, then the output will appear to have distinct
31 // columns, where the quantizer, loopfilter, and static threshold differ
32 // from column to column.
34 // An active map is set on frame 33. If the width of the image in macroblocks
35 // is evenly divisble by 4, then the output will appear to have distinct
36 // columns, where one column will have motion and the next will not.
38 // The active map is cleared on frame 44.
40 // Observing The Effects
41 // ---------------------
42 // Use the `simple_decoder` example to decode this sample, and observe
43 // the change in the image at frames 22, 33, and 44.
49 #define VPX_CODEC_DISABLE_COMPAT 1
50 #include "vpx/vp8cx.h"
51 #include "vpx/vpx_encoder.h"
53 #include "./tools_common.h"
54 #include "./video_writer.h"
56 static const char *exec_name;
59 fprintf(stderr, "Usage: %s <codec> <width> <height> <infile> <outfile>\n",
64 static void set_roi_map(const vpx_codec_enc_cfg_t *cfg,
65 vpx_codec_ctx_t *codec) {
68 memset(&roi, 0, sizeof(roi));
70 roi.rows = (cfg->g_h + 15) / 16;
71 roi.cols = (cfg->g_w + 15) / 16;
83 roi.static_threshold[0] = 1500;
84 roi.static_threshold[1] = 1000;
85 roi.static_threshold[2] = 500;
86 roi.static_threshold[3] = 0;
88 roi.roi_map = (uint8_t *)malloc(roi.rows * roi.cols);
89 for (i = 0; i < roi.rows * roi.cols; ++i)
90 roi.roi_map[i] = i % 4;
92 if (vpx_codec_control(codec, VP8E_SET_ROI_MAP, &roi))
93 die_codec(codec, "Failed to set ROI map");
98 static void set_active_map(const vpx_codec_enc_cfg_t *cfg,
99 vpx_codec_ctx_t *codec) {
101 vpx_active_map_t map = {0, 0, 0};
103 map.rows = (cfg->g_h + 15) / 16;
104 map.cols = (cfg->g_w + 15) / 16;
106 map.active_map = (uint8_t *)malloc(map.rows * map.cols);
107 for (i = 0; i < map.rows * map.cols; ++i)
108 map.active_map[i] = i % 2;
110 if (vpx_codec_control(codec, VP8E_SET_ACTIVEMAP, &map))
111 die_codec(codec, "Failed to set active map");
113 free(map.active_map);
116 static void unset_active_map(const vpx_codec_enc_cfg_t *cfg,
117 vpx_codec_ctx_t *codec) {
118 vpx_active_map_t map = {0, 0, 0};
120 map.rows = (cfg->g_h + 15) / 16;
121 map.cols = (cfg->g_w + 15) / 16;
122 map.active_map = NULL;
124 if (vpx_codec_control(codec, VP8E_SET_ACTIVEMAP, &map))
125 die_codec(codec, "Failed to set active map");
128 static void encode_frame(vpx_codec_ctx_t *codec,
131 VpxVideoWriter *writer) {
132 vpx_codec_iter_t iter = NULL;
133 const vpx_codec_cx_pkt_t *pkt = NULL;
134 const vpx_codec_err_t res = vpx_codec_encode(codec, img, frame_index, 1, 0,
135 VPX_DL_GOOD_QUALITY);
136 if (res != VPX_CODEC_OK)
137 die_codec(codec, "Failed to encode frame");
139 while ((pkt = vpx_codec_get_cx_data(codec, &iter)) != NULL) {
140 if (pkt->kind == VPX_CODEC_CX_FRAME_PKT) {
141 const int keyframe = (pkt->data.frame.flags & VPX_FRAME_IS_KEY) != 0;
142 if (!vpx_video_writer_write_frame(writer,
145 pkt->data.frame.pts)) {
146 die_codec(codec, "Failed to write compressed frame");
149 printf(keyframe ? "K" : ".");
155 int main(int argc, char **argv) {
157 vpx_codec_ctx_t codec;
158 vpx_codec_enc_cfg_t cfg;
163 VpxVideoWriter *writer = NULL;
164 const VpxInterface *encoder = NULL;
165 const int fps = 2; // TODO(dkovalev) add command line argument
166 const double bits_per_pixel_per_frame = 0.067;
170 die("Invalid number of arguments");
172 memset(&info, 0, sizeof(info));
174 encoder = get_vpx_encoder_by_name(argv[1]);
176 die("Unsupported codec.");
178 info.codec_fourcc = encoder->fourcc;
179 info.frame_width = strtol(argv[2], NULL, 0);
180 info.frame_height = strtol(argv[3], NULL, 0);
181 info.time_base.numerator = 1;
182 info.time_base.denominator = fps;
184 if (info.frame_width <= 0 ||
185 info.frame_height <= 0 ||
186 (info.frame_width % 2) != 0 ||
187 (info.frame_height % 2) != 0) {
188 die("Invalid frame size: %dx%d", info.frame_width, info.frame_height);
191 if (!vpx_img_alloc(&raw, VPX_IMG_FMT_I420, info.frame_width,
192 info.frame_height, 1)) {
193 die("Failed to allocate image.");
196 printf("Using %s\n", vpx_codec_iface_name(encoder->codec_interface()));
198 res = vpx_codec_enc_config_default(encoder->codec_interface(), &cfg, 0);
200 die_codec(&codec, "Failed to get default codec config.");
202 cfg.g_w = info.frame_width;
203 cfg.g_h = info.frame_height;
204 cfg.g_timebase.num = info.time_base.numerator;
205 cfg.g_timebase.den = info.time_base.denominator;
206 cfg.rc_target_bitrate = (unsigned int)(bits_per_pixel_per_frame * cfg.g_w *
207 cfg.g_h * fps / 1000);
208 cfg.g_lag_in_frames = 0;
210 writer = vpx_video_writer_open(argv[5], kContainerIVF, &info);
212 die("Failed to open %s for writing.", argv[5]);
214 if (!(infile = fopen(argv[4], "rb")))
215 die("Failed to open %s for reading.", argv[4]);
217 if (vpx_codec_enc_init(&codec, encoder->codec_interface(), &cfg, 0))
218 die_codec(&codec, "Failed to initialize encoder");
220 while (vpx_img_read(&raw, infile)) {
223 if (frame_count == 22 && encoder->fourcc == VP8_FOURCC) {
224 set_roi_map(&cfg, &codec);
225 } else if (frame_count == 33) {
226 set_active_map(&cfg, &codec);
227 } else if (frame_count == 44) {
228 unset_active_map(&cfg, &codec);
231 encode_frame(&codec, &raw, frame_count, writer);
233 encode_frame(&codec, NULL, -1, writer);
236 printf("Processed %d frames.\n", frame_count);
239 if (vpx_codec_destroy(&codec))
240 die_codec(&codec, "Failed to destroy codec.");
242 vpx_video_writer_close(writer);