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 static int init_context_defaults(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 #if FF_API_GET_CONTEXT_DEFAULTS
150 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec)
152 return init_context_defaults(s, codec);
156 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec)
158 AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
163 if (init_context_defaults(avctx, codec) < 0) {
171 void avcodec_free_context(AVCodecContext **pavctx)
173 AVCodecContext *avctx = *pavctx;
178 avcodec_close(avctx);
180 av_freep(&avctx->extradata);
181 av_freep(&avctx->subtitle_header);
182 av_freep(&avctx->intra_matrix);
183 av_freep(&avctx->inter_matrix);
184 av_freep(&avctx->rc_override);
189 #if FF_API_COPY_CONTEXT
190 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
192 const AVCodec *orig_codec = dest->codec;
193 uint8_t *orig_priv_data = dest->priv_data;
195 if (avcodec_is_open(dest)) { // check that the dest context is uninitialized
196 av_log(dest, AV_LOG_ERROR,
197 "Tried to copy AVCodecContext %p into already-initialized %p\n",
199 return AVERROR(EINVAL);
203 av_freep(&dest->rc_override);
204 av_freep(&dest->intra_matrix);
205 av_freep(&dest->inter_matrix);
206 av_freep(&dest->extradata);
207 av_freep(&dest->subtitle_header);
209 memcpy(dest, src, sizeof(*dest));
210 av_opt_copy(dest, src);
212 dest->priv_data = orig_priv_data;
213 dest->codec = orig_codec;
215 if (orig_priv_data && src->codec && src->codec->priv_class &&
216 dest->codec && dest->codec->priv_class)
217 av_opt_copy(orig_priv_data, src->priv_data);
220 /* set values specific to opened codecs back to their default state */
221 dest->slice_offset = NULL;
222 dest->hwaccel = NULL;
223 dest->internal = NULL;
224 #if FF_API_CODED_FRAME
225 FF_DISABLE_DEPRECATION_WARNINGS
226 dest->coded_frame = NULL;
227 FF_ENABLE_DEPRECATION_WARNINGS
230 /* reallocate values that should be allocated separately */
231 dest->extradata = NULL;
232 dest->intra_matrix = NULL;
233 dest->inter_matrix = NULL;
234 dest->rc_override = NULL;
235 dest->subtitle_header = NULL;
236 dest->hw_frames_ctx = NULL;
238 #define alloc_and_copy_or_fail(obj, size, pad) \
239 if (src->obj && size > 0) { \
240 dest->obj = av_malloc(size + pad); \
243 memcpy(dest->obj, src->obj, size); \
245 memset(((uint8_t *) dest->obj) + size, 0, pad); \
247 alloc_and_copy_or_fail(extradata, src->extradata_size,
248 AV_INPUT_BUFFER_PADDING_SIZE);
249 dest->extradata_size = src->extradata_size;
250 alloc_and_copy_or_fail(intra_matrix, 64 * sizeof(int16_t), 0);
251 alloc_and_copy_or_fail(inter_matrix, 64 * sizeof(int16_t), 0);
252 alloc_and_copy_or_fail(rc_override, src->rc_override_count * sizeof(*src->rc_override), 0);
253 alloc_and_copy_or_fail(subtitle_header, src->subtitle_header_size, 1);
254 av_assert0(dest->subtitle_header_size == src->subtitle_header_size);
255 #undef alloc_and_copy_or_fail
257 if (src->hw_frames_ctx) {
258 dest->hw_frames_ctx = av_buffer_ref(src->hw_frames_ctx);
259 if (!dest->hw_frames_ctx)
266 av_freep(&dest->subtitle_header);
267 av_freep(&dest->rc_override);
268 av_freep(&dest->intra_matrix);
269 av_freep(&dest->inter_matrix);
270 av_freep(&dest->extradata);
271 av_buffer_unref(&dest->hw_frames_ctx);
272 dest->subtitle_header_size = 0;
273 dest->extradata_size = 0;
275 return AVERROR(ENOMEM);
279 const AVClass *avcodec_get_class(void)
281 return &av_codec_context_class;
284 #define FOFFSET(x) offsetof(AVFrame,x)
286 static const AVOption frame_options[]={
287 {"best_effort_timestamp", "", FOFFSET(best_effort_timestamp), AV_OPT_TYPE_INT64, {.i64 = AV_NOPTS_VALUE }, INT64_MIN, INT64_MAX, 0},
288 {"pkt_pos", "", FOFFSET(pkt_pos), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
289 {"pkt_size", "", FOFFSET(pkt_size), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
290 {"sample_aspect_ratio", "", FOFFSET(sample_aspect_ratio), AV_OPT_TYPE_RATIONAL, {.dbl = 0 }, 0, INT_MAX, 0},
291 {"width", "", FOFFSET(width), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
292 {"height", "", FOFFSET(height), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
293 {"format", "", FOFFSET(format), AV_OPT_TYPE_INT, {.i64 = -1 }, 0, INT_MAX, 0},
294 {"channel_layout", "", FOFFSET(channel_layout), AV_OPT_TYPE_INT64, {.i64 = 0 }, 0, INT64_MAX, 0},
295 {"sample_rate", "", FOFFSET(sample_rate), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
299 static const AVClass av_frame_class = {
300 .class_name = "AVFrame",
302 .option = frame_options,
303 .version = LIBAVUTIL_VERSION_INT,
306 const AVClass *avcodec_get_frame_class(void)
308 return &av_frame_class;
311 #define SROFFSET(x) offsetof(AVSubtitleRect,x)
313 static const AVOption subtitle_rect_options[]={
314 {"x", "", SROFFSET(x), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
315 {"y", "", SROFFSET(y), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
316 {"w", "", SROFFSET(w), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
317 {"h", "", SROFFSET(h), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
318 {"type", "", SROFFSET(type), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
319 {"flags", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0, "flags"},
320 {"forced", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0},
324 static const AVClass av_subtitle_rect_class = {
325 .class_name = "AVSubtitleRect",
327 .option = subtitle_rect_options,
328 .version = LIBAVUTIL_VERSION_INT,
331 const AVClass *avcodec_get_subtitle_rect_class(void)
333 return &av_subtitle_rect_class;
337 static int dummy_init(AVCodecContext *ctx)
339 //TODO: this code should set every possible pointer that could be set by codec and is not an option;
340 ctx->extradata_size = 8;
341 ctx->extradata = av_malloc(ctx->extradata_size);
345 static int dummy_close(AVCodecContext *ctx)
347 av_freep(&ctx->extradata);
348 ctx->extradata_size = 0;
352 static int dummy_encode(AVCodecContext *ctx, AVPacket *pkt, const AVFrame *frame, int *got_packet)
354 return AVERROR(ENOSYS);
357 typedef struct Dummy12Context {
363 typedef struct Dummy3Context {
369 #define OFFSET(x) offsetof(Dummy12Context, x)
370 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
371 static const AVOption dummy_options[] = {
372 { "str", "set str", OFFSET(str), AV_OPT_TYPE_STRING, { .str = "i'm src default value" }, 0, 0, VE},
373 { "num", "set num", OFFSET(num), AV_OPT_TYPE_INT, { .i64 = 1500100900 }, 0, INT_MAX, VE},
377 static const AVClass dummy_v1_class = {
378 .class_name = "dummy_v1_class",
379 .item_name = av_default_item_name,
380 .option = dummy_options,
381 .version = LIBAVUTIL_VERSION_INT,
384 static const AVClass dummy_v2_class = {
385 .class_name = "dummy_v2_class",
386 .item_name = av_default_item_name,
387 .option = dummy_options,
388 .version = LIBAVUTIL_VERSION_INT,
391 /* codec with options */
392 static AVCodec dummy_v1_encoder = {
393 .name = "dummy_v1_codec",
394 .type = AVMEDIA_TYPE_VIDEO,
395 .id = AV_CODEC_ID_NONE - 1,
396 .encode2 = dummy_encode,
398 .close = dummy_close,
399 .priv_class = &dummy_v1_class,
400 .priv_data_size = sizeof(Dummy12Context),
403 /* codec with options, different class */
404 static AVCodec dummy_v2_encoder = {
405 .name = "dummy_v2_codec",
406 .type = AVMEDIA_TYPE_VIDEO,
407 .id = AV_CODEC_ID_NONE - 2,
408 .encode2 = dummy_encode,
410 .close = dummy_close,
411 .priv_class = &dummy_v2_class,
412 .priv_data_size = sizeof(Dummy12Context),
415 /* codec with priv data, but no class */
416 static AVCodec dummy_v3_encoder = {
417 .name = "dummy_v3_codec",
418 .type = AVMEDIA_TYPE_VIDEO,
419 .id = AV_CODEC_ID_NONE - 3,
420 .encode2 = dummy_encode,
422 .close = dummy_close,
423 .priv_data_size = sizeof(Dummy3Context),
426 /* codec without priv data */
427 static AVCodec dummy_v4_encoder = {
428 .name = "dummy_v4_codec",
429 .type = AVMEDIA_TYPE_VIDEO,
430 .id = AV_CODEC_ID_NONE - 4,
431 .encode2 = dummy_encode,
433 .close = dummy_close,
436 static void test_copy_print_codec(const AVCodecContext *ctx)
438 printf("%-14s: %dx%d prv: %s",
439 ctx->codec ? ctx->codec->name : "NULL",
440 ctx->width, ctx->height,
441 ctx->priv_data ? "set" : "null");
442 if (ctx->codec && ctx->codec->priv_class && ctx->codec->priv_data_size) {
445 av_opt_get_int(ctx->priv_data, "num", 0, &i64);
446 av_opt_get(ctx->priv_data, "str", 0, (uint8_t**)&str);
447 printf(" opts: %"PRId64" %s", i64, str);
453 static void test_copy(const AVCodec *c1, const AVCodec *c2)
455 AVCodecContext *ctx1, *ctx2;
456 printf("%s -> %s\nclosed:\n", c1 ? c1->name : "NULL", c2 ? c2->name : "NULL");
457 ctx1 = avcodec_alloc_context3(c1);
458 ctx2 = avcodec_alloc_context3(c2);
459 ctx1->width = ctx1->height = 128;
460 if (ctx2->codec && ctx2->codec->priv_class && ctx2->codec->priv_data_size) {
461 av_opt_set(ctx2->priv_data, "num", "667", 0);
462 av_opt_set(ctx2->priv_data, "str", "i'm dest value before copy", 0);
464 avcodec_copy_context(ctx2, ctx1);
465 test_copy_print_codec(ctx1);
466 test_copy_print_codec(ctx2);
469 avcodec_open2(ctx1, ctx1->codec, NULL);
470 if (ctx2->codec && ctx2->codec->priv_class && ctx2->codec->priv_data_size) {
471 av_opt_set(ctx2->priv_data, "num", "667", 0);
472 av_opt_set(ctx2->priv_data, "str", "i'm dest value before copy", 0);
474 avcodec_copy_context(ctx2, ctx1);
475 test_copy_print_codec(ctx1);
476 test_copy_print_codec(ctx2);
479 avcodec_free_context(&ctx1);
480 avcodec_free_context(&ctx2);
485 AVCodec *dummy_codec[] = {
494 for (i = 0; dummy_codec[i]; i++)
495 avcodec_register(dummy_codec[i]);
497 printf("testing avcodec_copy_context()\n");
498 for (i = 0; i < FF_ARRAY_ELEMS(dummy_codec); i++)
499 for (j = 0; j < FF_ARRAY_ELEMS(dummy_codec); j++)
500 test_copy(dummy_codec[i], dummy_codec[j]);