AOMedia Codec SDK

set_maps
1 /*
2 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
3 *
4 * This source code is subject to the terms of the BSD 2 Clause License and
5 * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
6 * was not distributed with this source code in the LICENSE file, you can
7 * obtain it at www.aomedia.org/license/software. If the Alliance for Open
8 * Media Patent License 1.0 was not distributed with this source code in the
9 * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
10 */
11
12 // AOM Set Active and ROI Maps
13 // ===========================
14 //
15 // This is an example demonstrating how to control the AOM encoder's
16 // ROI and Active maps.
17 //
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.
21 //
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
24 // macroblock.
25 //
26 //
27 // Configuration
28 // -------------
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.
33 //
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.
37 //
38 // The active map is cleared on frame 44.
39 //
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.
44
45 #include <assert.h>
46 #include <stdio.h>
47 #include <stdlib.h>
48 #include <string.h>
49
50 #include "aom/aom_encoder.h"
51 #include "aom/aomcx.h"
52 #include "common/tools_common.h"
53 #include "common/video_writer.h"
54
55 static const char *exec_name;
56
57 void usage_exit(void) {
58 fprintf(stderr, "Usage: %s <codec> <width> <height> <infile> <outfile>\n",
59 exec_name);
60 exit(EXIT_FAILURE);
61 }
62
63 static void set_active_map(const aom_codec_enc_cfg_t *cfg,
64 aom_codec_ctx_t *codec) {
65 unsigned int i;
66 aom_active_map_t map = { 0, 0, 0 };
67
68 map.rows = (cfg->g_h + 15) / 16;
69 map.cols = (cfg->g_w + 15) / 16;
70
71 map.active_map = (uint8_t *)malloc(map.rows * map.cols);
72 for (i = 0; i < map.rows * map.cols; ++i) map.active_map[i] = i % 2;
73
74 if (aom_codec_control(codec, AOME_SET_ACTIVEMAP, &map))
75 die_codec(codec, "Failed to set active map");
76
77 free(map.active_map);
78 }
79
80 static void unset_active_map(const aom_codec_enc_cfg_t *cfg,
81 aom_codec_ctx_t *codec) {
82 aom_active_map_t map = { 0, 0, 0 };
83
84 map.rows = (cfg->g_h + 15) / 16;
85 map.cols = (cfg->g_w + 15) / 16;
86 map.active_map = NULL;
87
88 if (aom_codec_control(codec, AOME_SET_ACTIVEMAP, &map))
89 die_codec(codec, "Failed to set active map");
90 }
91
92 static int encode_frame(aom_codec_ctx_t *codec, aom_image_t *img,
93 int frame_index, AvxVideoWriter *writer) {
94 int got_pkts = 0;
95 aom_codec_iter_t iter = NULL;
96 const aom_codec_cx_pkt_t *pkt = NULL;
97 const aom_codec_err_t res = aom_codec_encode(codec, img, frame_index, 1, 0);
98 if (res != AOM_CODEC_OK) die_codec(codec, "Failed to encode frame");
99
100 while ((pkt = aom_codec_get_cx_data(codec, &iter)) != NULL) {
101 got_pkts = 1;
102
103 if (pkt->kind == AOM_CODEC_CX_FRAME_PKT) {
104 const int keyframe = (pkt->data.frame.flags & AOM_FRAME_IS_KEY) != 0;
105 if (!aom_video_writer_write_frame(writer, pkt->data.frame.buf,
106 pkt->data.frame.sz,
107 pkt->data.frame.pts)) {
108 die_codec(codec, "Failed to write compressed frame");
109 }
110
111 printf(keyframe ? "K" : ".");
112 fflush(stdout);
113 }
114 }
115
116 return got_pkts;
117 }
118
119 int main(int argc, char **argv) {
120 FILE *infile = NULL;
121 aom_codec_ctx_t codec;
122 aom_codec_enc_cfg_t cfg;
123 int frame_count = 0;
124 const int limit = 15;
125 aom_image_t raw;
126 aom_codec_err_t res;
127 AvxVideoInfo info;
128 AvxVideoWriter *writer = NULL;
129 const AvxInterface *encoder = NULL;
130 const int fps = 2; // TODO(dkovalev) add command line argument
131 const double bits_per_pixel_per_frame = 0.067;
132
133 exec_name = argv[0];
134 if (argc != 6) die("Invalid number of arguments");
135
136 memset(&info, 0, sizeof(info));
137
138 encoder = get_aom_encoder_by_name(argv[1]);
139 if (encoder == NULL) {
140 die("Unsupported codec.");
141 }
142 assert(encoder != NULL);
143 info.codec_fourcc = encoder->fourcc;
144 info.frame_width = (int)strtol(argv[2], NULL, 0);
145 info.frame_height = (int)strtol(argv[3], NULL, 0);
146 info.time_base.numerator = 1;
147 info.time_base.denominator = fps;
148
149 if (info.frame_width <= 0 || info.frame_height <= 0 ||
150 (info.frame_width % 2) != 0 || (info.frame_height % 2) != 0) {
151 die("Invalid frame size: %dx%d", info.frame_width, info.frame_height);
152 }
153
154 if (!aom_img_alloc(&raw, AOM_IMG_FMT_I420, info.frame_width,
155 info.frame_height, 1)) {
156 die("Failed to allocate image.");
157 }
158
159 printf("Using %s\n", aom_codec_iface_name(encoder->codec_interface()));
160
161 res = aom_codec_enc_config_default(encoder->codec_interface(), &cfg, 0);
162 if (res) die_codec(&codec, "Failed to get default codec config.");
163
164 cfg.g_w = info.frame_width;
165 cfg.g_h = info.frame_height;
166 cfg.g_timebase.num = info.time_base.numerator;
167 cfg.g_timebase.den = info.time_base.denominator;
168 cfg.rc_target_bitrate =
169 (unsigned int)(bits_per_pixel_per_frame * cfg.g_w * cfg.g_h * fps / 1000);
170 cfg.g_lag_in_frames = 0;
171
172 writer = aom_video_writer_open(argv[5], kContainerIVF, &info);
173 if (!writer) die("Failed to open %s for writing.", argv[5]);
174
175 if (!(infile = fopen(argv[4], "rb")))
176 die("Failed to open %s for reading.", argv[4]);
177
178 if (aom_codec_enc_init(&codec, encoder->codec_interface(), &cfg, 0))
179 die_codec(&codec, "Failed to initialize encoder");
180
181 // Encode frames.
182 while (aom_img_read(&raw, infile) && frame_count < limit) {
183 ++frame_count;
184
185 if (frame_count == 5) {
186 set_active_map(&cfg, &codec);
187 } else if (frame_count == 11) {
188 unset_active_map(&cfg, &codec);
189 }
190
191 encode_frame(&codec, &raw, frame_count, writer);
192 }
193
194 // Flush encoder.
195 while (encode_frame(&codec, NULL, -1, writer)) {
196 }
197
198 printf("\n");
199 fclose(infile);
200 printf("Processed %d frames.\n", frame_count);
201
202 aom_img_free(&raw);
203 if (aom_codec_destroy(&codec)) die_codec(&codec, "Failed to destroy codec.");
204
205 aom_video_writer_close(writer);
206
207 return EXIT_SUCCESS;
208 }
AOM_CODEC_OK
Operation completed without error.
Definition: aom_codec.h:103
aom_codec_enc_cfg::g_w
unsigned int g_w
Width of the frame.
Definition: aom_encoder.h:276
aom_codec_enc_cfg::rc_target_bitrate
unsigned int rc_target_bitrate
Target data rate.
Definition: aom_encoder.h:491
aom_active_map::active_map
unsigned char * active_map
specify an on (1) or off (0) each 16x16 region within a frame
Definition: aomcx.h:905
aom_encoder.h
Describes the encoder algorithm interface to applications.
aom_codec_enc_init
#define aom_codec_enc_init(ctx, iface, cfg, flags)
Convenience macro for aom_codec_enc_init_ver()
Definition: aom_encoder.h:774
aom_codec_enc_cfg
Encoder configuration structure.
Definition: aom_encoder.h:237
aomcx.h
Provides definitions for using AOM or AV1 encoder algorithm within the aom Codec Interface.
aom_codec_ctx
Codec context structure.
Definition: aom_codec.h:204
AOM_FRAME_IS_KEY
#define AOM_FRAME_IS_KEY
Definition: aom_encoder.h:104
aom_codec_enc_config_default
aom_codec_err_t aom_codec_enc_config_default(aom_codec_iface_t *iface, aom_codec_enc_cfg_t *cfg, unsigned int reserved)
Get a default configuration.
aom_image
Image Descriptor.
Definition: aom_image.h:141
aom_img_alloc
aom_image_t * aom_img_alloc(aom_image_t *img, aom_img_fmt_t fmt, unsigned int d_w, unsigned int d_h, unsigned int align)
Open a descriptor, allocating storage for the underlying image.
aom_codec_get_cx_data
const aom_codec_cx_pkt_t * aom_codec_get_cx_data(aom_codec_ctx_t *ctx, aom_codec_iter_t *iter)
Encoded data iterator.
aom_codec_encode
aom_codec_err_t aom_codec_encode(aom_codec_ctx_t *ctx, const aom_image_t *img, aom_codec_pts_t pts, unsigned long duration, aom_enc_frame_flags_t flags)
Encode a frame.
aom_codec_iface_name
const char * aom_codec_iface_name(aom_codec_iface_t *iface)
Return the name for a given interface.
aom_codec_enc_cfg::g_timebase
struct aom_rational g_timebase
Stream timebase units.
Definition: aom_encoder.h:334
aom_codec_destroy
aom_codec_err_t aom_codec_destroy(aom_codec_ctx_t *ctx)
Destroy a codec instance.
aom_active_map::cols
unsigned int cols
Definition: aomcx.h:907
aom_codec_cx_pkt::kind
enum aom_codec_cx_pkt_kind kind
Definition: aom_encoder.h:148
aom_img_free
void aom_img_free(aom_image_t *img)
Close an image descriptor.
aom_codec_cx_pkt::frame
struct aom_codec_cx_pkt::@1::@2 frame
AOM_CODEC_CX_FRAME_PKT
Definition: aom_encoder.h:135
aom_active_map
aom active region map
Definition: aomcx.h:903
aom_codec_control
#define aom_codec_control(ctx, id, data)
aom_codec_control wrapper macro
Definition: aom_codec.h:423
AOME_SET_ACTIVEMAP
Codec control function to pass an Active map to encoder.
Definition: aomcx.h:164
aom_codec_iter_t
const void * aom_codec_iter_t
Iterator.
Definition: aom_codec.h:194
aom_active_map::rows
unsigned int rows
Definition: aomcx.h:906
aom_codec_err_t
aom_codec_err_t
Algorithm return codes.
Definition: aom_codec.h:101
aom_rational::den
int den
Definition: aom_encoder.h:189
aom_codec_cx_pkt
Encoder output packet.
Definition: aom_encoder.h:147
aom_rational::num
int num
Definition: aom_encoder.h:188
AOM_IMG_FMT_I420
Definition: aom_image.h:45
aom_codec_enc_cfg::g_lag_in_frames
unsigned int g_lag_in_frames
Allow lagged encoding.
Definition: aom_encoder.h:363
aom_codec_cx_pkt::data
union aom_codec_cx_pkt::@1 data
aom_codec_enc_cfg::g_h
unsigned int g_h
Height of the frame.
Definition: aom_encoder.h:285