2 * Copyright (c) 2001 Fabrice Bellard
3 * Copyright (c) 2002-2004 Michael Niedermayer <michaelni@gmx.at>
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * Options definition for AVCodecContext.
29 #include "libavutil/avassert.h"
30 #include "libavutil/internal.h"
31 #include "libavutil/mem.h"
32 #include "libavutil/opt.h"
33 #include <float.h> /* FLT_MIN, FLT_MAX */
36 FF_DISABLE_DEPRECATION_WARNINGS
37 #include "options_table.h"
38 FF_ENABLE_DEPRECATION_WARNINGS
40 static const char* context_to_name(void* ptr) {
41 AVCodecContext *avc= ptr;
43 if(avc && avc->codec && avc->codec->name)
44 return avc->codec->name;
49 static void *codec_child_next(void *obj, void *prev)
51 AVCodecContext *s = obj;
52 if (!prev && s->codec && s->codec->priv_class && s->priv_data)
57 static const AVClass *codec_child_class_next(const AVClass *prev)
61 /* find the codec that corresponds to prev */
62 while (prev && (c = av_codec_next(c)))
63 if (c->priv_class == prev)
66 /* find next codec with priv options */
67 while (c = av_codec_next(c))
73 static AVClassCategory get_category(void *ptr)
75 AVCodecContext* avctx = ptr;
76 if(avctx->codec && avctx->codec->decode) return AV_CLASS_CATEGORY_DECODER;
77 else return AV_CLASS_CATEGORY_ENCODER;
80 static const AVClass av_codec_context_class = {
81 .class_name = "AVCodecContext",
82 .item_name = context_to_name,
83 .option = avcodec_options,
84 .version = LIBAVUTIL_VERSION_INT,
85 .log_level_offset_offset = offsetof(AVCodecContext, log_level_offset),
86 .child_next = codec_child_next,
87 .child_class_next = codec_child_class_next,
88 .category = AV_CLASS_CATEGORY_ENCODER,
89 .get_category = get_category,
92 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec)
95 memset(s, 0, sizeof(AVCodecContext));
97 s->av_class = &av_codec_context_class;
99 s->codec_type = codec ? codec->type : AVMEDIA_TYPE_UNKNOWN;
102 s->codec_id = codec->id;
105 if(s->codec_type == AVMEDIA_TYPE_AUDIO)
106 flags= AV_OPT_FLAG_AUDIO_PARAM;
107 else if(s->codec_type == AVMEDIA_TYPE_VIDEO)
108 flags= AV_OPT_FLAG_VIDEO_PARAM;
109 else if(s->codec_type == AVMEDIA_TYPE_SUBTITLE)
110 flags= AV_OPT_FLAG_SUBTITLE_PARAM;
111 av_opt_set_defaults2(s, flags, flags);
113 s->time_base = (AVRational){0,1};
114 s->framerate = (AVRational){ 0, 1 };
115 s->pkt_timebase = (AVRational){ 0, 1 };
116 s->get_buffer2 = avcodec_default_get_buffer2;
117 s->get_format = avcodec_default_get_format;
118 s->execute = avcodec_default_execute;
119 s->execute2 = avcodec_default_execute2;
120 s->sample_aspect_ratio = (AVRational){0,1};
121 s->pix_fmt = AV_PIX_FMT_NONE;
122 s->sample_fmt = AV_SAMPLE_FMT_NONE;
124 s->reordered_opaque = AV_NOPTS_VALUE;
125 if(codec && codec->priv_data_size){
127 s->priv_data= av_mallocz(codec->priv_data_size);
129 return AVERROR(ENOMEM);
132 if(codec->priv_class){
133 *(const AVClass**)s->priv_data = codec->priv_class;
134 av_opt_set_defaults(s->priv_data);
137 if (codec && codec->defaults) {
139 const AVCodecDefault *d = codec->defaults;
141 ret = av_opt_set(s, d->key, d->value, 0);
142 av_assert0(ret >= 0);
149 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec)
151 AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
156 if(avcodec_get_context_defaults3(avctx, codec) < 0){
164 void avcodec_free_context(AVCodecContext **pavctx)
166 AVCodecContext *avctx = *pavctx;
171 avcodec_close(avctx);
173 av_freep(&avctx->extradata);
174 av_freep(&avctx->subtitle_header);
175 av_freep(&avctx->intra_matrix);
176 av_freep(&avctx->inter_matrix);
177 av_freep(&avctx->rc_override);
182 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
184 const AVCodec *orig_codec = dest->codec;
185 uint8_t *orig_priv_data = dest->priv_data;
187 if (avcodec_is_open(dest)) { // check that the dest context is uninitialized
188 av_log(dest, AV_LOG_ERROR,
189 "Tried to copy AVCodecContext %p into already-initialized %p\n",
191 return AVERROR(EINVAL);
195 av_freep(&dest->rc_override);
196 av_freep(&dest->intra_matrix);
197 av_freep(&dest->inter_matrix);
198 av_freep(&dest->extradata);
199 av_freep(&dest->subtitle_header);
201 memcpy(dest, src, sizeof(*dest));
202 av_opt_copy(dest, src);
204 dest->priv_data = orig_priv_data;
205 dest->codec = orig_codec;
207 if (orig_priv_data && src->codec && src->codec->priv_class &&
208 dest->codec && dest->codec->priv_class)
209 av_opt_copy(orig_priv_data, src->priv_data);
212 /* set values specific to opened codecs back to their default state */
213 dest->slice_offset = NULL;
214 dest->hwaccel = NULL;
215 dest->internal = NULL;
216 dest->coded_frame = NULL;
218 /* reallocate values that should be allocated separately */
219 dest->extradata = NULL;
220 dest->intra_matrix = NULL;
221 dest->inter_matrix = NULL;
222 dest->rc_override = NULL;
223 dest->subtitle_header = NULL;
225 #define alloc_and_copy_or_fail(obj, size, pad) \
226 if (src->obj && size > 0) { \
227 dest->obj = av_malloc(size + pad); \
230 memcpy(dest->obj, src->obj, size); \
232 memset(((uint8_t *) dest->obj) + size, 0, pad); \
234 alloc_and_copy_or_fail(extradata, src->extradata_size,
235 FF_INPUT_BUFFER_PADDING_SIZE);
236 dest->extradata_size = src->extradata_size;
237 alloc_and_copy_or_fail(intra_matrix, 64 * sizeof(int16_t), 0);
238 alloc_and_copy_or_fail(inter_matrix, 64 * sizeof(int16_t), 0);
239 alloc_and_copy_or_fail(rc_override, src->rc_override_count * sizeof(*src->rc_override), 0);
240 alloc_and_copy_or_fail(subtitle_header, src->subtitle_header_size, 1);
241 av_assert0(dest->subtitle_header_size == src->subtitle_header_size);
242 #undef alloc_and_copy_or_fail
247 av_freep(&dest->rc_override);
248 av_freep(&dest->intra_matrix);
249 av_freep(&dest->inter_matrix);
250 av_freep(&dest->extradata);
251 av_freep(&dest->subtitle_header);
252 dest->subtitle_header_size = 0;
253 dest->extradata_size = 0;
255 return AVERROR(ENOMEM);
258 const AVClass *avcodec_get_class(void)
260 return &av_codec_context_class;
263 #define FOFFSET(x) offsetof(AVFrame,x)
265 static const AVOption frame_options[]={
266 {"best_effort_timestamp", "", FOFFSET(best_effort_timestamp), AV_OPT_TYPE_INT64, {.i64 = AV_NOPTS_VALUE }, INT64_MIN, INT64_MAX, 0},
267 {"pkt_pos", "", FOFFSET(pkt_pos), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
268 {"pkt_size", "", FOFFSET(pkt_size), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
269 {"sample_aspect_ratio", "", FOFFSET(sample_aspect_ratio), AV_OPT_TYPE_RATIONAL, {.dbl = 0 }, 0, INT_MAX, 0},
270 {"width", "", FOFFSET(width), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
271 {"height", "", FOFFSET(height), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
272 {"format", "", FOFFSET(format), AV_OPT_TYPE_INT, {.i64 = -1 }, 0, INT_MAX, 0},
273 {"channel_layout", "", FOFFSET(channel_layout), AV_OPT_TYPE_INT64, {.i64 = 0 }, 0, INT64_MAX, 0},
274 {"sample_rate", "", FOFFSET(sample_rate), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
278 static const AVClass av_frame_class = {
279 .class_name = "AVFrame",
281 .option = frame_options,
282 .version = LIBAVUTIL_VERSION_INT,
285 const AVClass *avcodec_get_frame_class(void)
287 return &av_frame_class;
290 #define SROFFSET(x) offsetof(AVSubtitleRect,x)
292 static const AVOption subtitle_rect_options[]={
293 {"x", "", SROFFSET(x), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
294 {"y", "", SROFFSET(y), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
295 {"w", "", SROFFSET(w), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
296 {"h", "", SROFFSET(h), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
297 {"type", "", SROFFSET(type), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
298 {"flags", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0, "flags"},
299 {"forced", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0},
303 static const AVClass av_subtitle_rect_class = {
304 .class_name = "AVSubtitleRect",
306 .option = subtitle_rect_options,
307 .version = LIBAVUTIL_VERSION_INT,
310 const AVClass *avcodec_get_subtitle_rect_class(void)
312 return &av_subtitle_rect_class;
316 static int dummy_init(AVCodecContext *ctx)
318 //TODO: this code should set every possible pointer that could be set by codec and is not an option;
319 ctx->extradata_size = 8;
320 ctx->extradata = av_malloc(ctx->extradata_size);
321 ctx->coded_frame = av_frame_alloc();
325 static int dummy_close(AVCodecContext *ctx)
327 av_freep(&ctx->extradata);
328 ctx->extradata_size = 0;
329 av_frame_free(&ctx->coded_frame);
333 static int dummy_encode(AVCodecContext *ctx, AVPacket *pkt, const AVFrame *frame, int *got_packet)
335 return AVERROR(ENOSYS);
338 typedef struct Dummy12Context {
344 typedef struct Dummy3Context {
350 #define OFFSET(x) offsetof(Dummy12Context, x)
351 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
352 static const AVOption dummy_options[] = {
353 { "str", "set str", OFFSET(str), AV_OPT_TYPE_STRING, { .str = "i'm src default value" }, 0, 0, VE},
354 { "num", "set num", OFFSET(num), AV_OPT_TYPE_INT, { .i64 = 1500100900 }, 0, INT_MAX, VE},
358 static const AVClass dummy_v1_class = {
359 .class_name = "dummy_v1_class",
360 .item_name = av_default_item_name,
361 .option = dummy_options,
362 .version = LIBAVUTIL_VERSION_INT,
365 static const AVClass dummy_v2_class = {
366 .class_name = "dummy_v2_class",
367 .item_name = av_default_item_name,
368 .option = dummy_options,
369 .version = LIBAVUTIL_VERSION_INT,
372 /* codec with options */
373 AVCodec dummy_v1_encoder = {
374 .name = "dummy_v1_codec",
375 .type = AVMEDIA_TYPE_VIDEO,
376 .id = AV_CODEC_ID_NONE - 1,
377 .encode2 = dummy_encode,
379 .close = dummy_close,
380 .priv_class = &dummy_v1_class,
381 .priv_data_size = sizeof(Dummy12Context),
384 /* codec with options, different class */
385 AVCodec dummy_v2_encoder = {
386 .name = "dummy_v2_codec",
387 .type = AVMEDIA_TYPE_VIDEO,
388 .id = AV_CODEC_ID_NONE - 2,
389 .encode2 = dummy_encode,
391 .close = dummy_close,
392 .priv_class = &dummy_v2_class,
393 .priv_data_size = sizeof(Dummy12Context),
396 /* codec with priv data, but no class */
397 AVCodec dummy_v3_encoder = {
398 .name = "dummy_v3_codec",
399 .type = AVMEDIA_TYPE_VIDEO,
400 .id = AV_CODEC_ID_NONE - 3,
401 .encode2 = dummy_encode,
403 .close = dummy_close,
404 .priv_data_size = sizeof(Dummy3Context),
407 /* codec without priv data */
408 AVCodec dummy_v4_encoder = {
409 .name = "dummy_v4_codec",
410 .type = AVMEDIA_TYPE_VIDEO,
411 .id = AV_CODEC_ID_NONE - 4,
412 .encode2 = dummy_encode,
414 .close = dummy_close,
417 static void test_copy_print_codec(const AVCodecContext *ctx)
419 printf("%-14s: %dx%d prv: %s",
420 ctx->codec ? ctx->codec->name : "NULL",
421 ctx->width, ctx->height,
422 ctx->priv_data ? "set" : "null");
423 if (ctx->codec && ctx->codec->priv_class && ctx->codec->priv_data_size) {
426 av_opt_get_int(ctx->priv_data, "num", 0, &i64);
427 av_opt_get(ctx->priv_data, "str", 0, (uint8_t**)&str);
428 printf(" opts: %"PRId64" %s", i64, str);
434 static void test_copy(const AVCodec *c1, const AVCodec *c2)
436 AVCodecContext *ctx1, *ctx2;
437 printf("%s -> %s\nclosed:\n", c1 ? c1->name : "NULL", c2 ? c2->name : "NULL");
438 ctx1 = avcodec_alloc_context3(c1);
439 ctx2 = avcodec_alloc_context3(c2);
440 ctx1->width = ctx1->height = 128;
441 if (ctx2->codec && ctx2->codec->priv_class && ctx2->codec->priv_data_size) {
442 av_opt_set(ctx2->priv_data, "num", "667", 0);
443 av_opt_set(ctx2->priv_data, "str", "i'm dest value before copy", 0);
445 avcodec_copy_context(ctx2, ctx1);
446 test_copy_print_codec(ctx1);
447 test_copy_print_codec(ctx2);
450 avcodec_open2(ctx1, ctx1->codec, NULL);
451 if (ctx2->codec && ctx2->codec->priv_class && ctx2->codec->priv_data_size) {
452 av_opt_set(ctx2->priv_data, "num", "667", 0);
453 av_opt_set(ctx2->priv_data, "str", "i'm dest value before copy", 0);
455 avcodec_copy_context(ctx2, ctx1);
456 test_copy_print_codec(ctx1);
457 test_copy_print_codec(ctx2);
460 avcodec_free_context(&ctx1);
461 avcodec_free_context(&ctx2);
466 AVCodec *dummy_codec[] = {
475 for (i = 0; dummy_codec[i]; i++)
476 avcodec_register(dummy_codec[i]);
478 printf("testing avcodec_copy_context()\n");
479 for (i = 0; i < FF_ARRAY_ELEMS(dummy_codec); i++)
480 for (j = 0; j < FF_ARRAY_ELEMS(dummy_codec); j++)
481 test_copy(dummy_codec[i], dummy_codec[j]);