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 #include "options_table.h"
38 static const char* context_to_name(void* ptr) {
39 AVCodecContext *avc= ptr;
41 if(avc && avc->codec && avc->codec->name)
42 return avc->codec->name;
47 static void *codec_child_next(void *obj, void *prev)
49 AVCodecContext *s = obj;
50 if (!prev && s->codec && s->codec->priv_class && s->priv_data)
55 static const AVClass *codec_child_class_next(const AVClass *prev)
59 /* find the codec that corresponds to prev */
60 while (prev && (c = av_codec_next(c)))
61 if (c->priv_class == prev)
64 /* find next codec with priv options */
65 while (c = av_codec_next(c))
71 static AVClassCategory get_category(void *ptr)
73 AVCodecContext* avctx = ptr;
74 if(avctx->codec && avctx->codec->decode) return AV_CLASS_CATEGORY_DECODER;
75 else return AV_CLASS_CATEGORY_ENCODER;
78 static const AVClass av_codec_context_class = {
79 .class_name = "AVCodecContext",
80 .item_name = context_to_name,
81 .option = avcodec_options,
82 .version = LIBAVUTIL_VERSION_INT,
83 .log_level_offset_offset = offsetof(AVCodecContext, log_level_offset),
84 .child_next = codec_child_next,
85 .child_class_next = codec_child_class_next,
86 .category = AV_CLASS_CATEGORY_ENCODER,
87 .get_category = get_category,
90 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec)
93 memset(s, 0, sizeof(AVCodecContext));
95 s->av_class = &av_codec_context_class;
97 s->codec_type = codec ? codec->type : AVMEDIA_TYPE_UNKNOWN;
100 s->codec_id = codec->id;
103 if(s->codec_type == AVMEDIA_TYPE_AUDIO)
104 flags= AV_OPT_FLAG_AUDIO_PARAM;
105 else if(s->codec_type == AVMEDIA_TYPE_VIDEO)
106 flags= AV_OPT_FLAG_VIDEO_PARAM;
107 else if(s->codec_type == AVMEDIA_TYPE_SUBTITLE)
108 flags= AV_OPT_FLAG_SUBTITLE_PARAM;
109 av_opt_set_defaults2(s, flags, flags);
111 s->time_base = (AVRational){0,1};
112 s->framerate = (AVRational){ 0, 1 };
113 s->pkt_timebase = (AVRational){ 0, 1 };
114 s->get_buffer2 = avcodec_default_get_buffer2;
115 s->get_format = avcodec_default_get_format;
116 s->execute = avcodec_default_execute;
117 s->execute2 = avcodec_default_execute2;
118 s->sample_aspect_ratio = (AVRational){0,1};
119 s->pix_fmt = AV_PIX_FMT_NONE;
120 s->sample_fmt = AV_SAMPLE_FMT_NONE;
122 s->reordered_opaque = AV_NOPTS_VALUE;
123 if(codec && codec->priv_data_size){
125 s->priv_data= av_mallocz(codec->priv_data_size);
127 return AVERROR(ENOMEM);
130 if(codec->priv_class){
131 *(const AVClass**)s->priv_data = codec->priv_class;
132 av_opt_set_defaults(s->priv_data);
135 if (codec && codec->defaults) {
137 const AVCodecDefault *d = codec->defaults;
139 ret = av_opt_set(s, d->key, d->value, 0);
140 av_assert0(ret >= 0);
147 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec)
149 AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
154 if(avcodec_get_context_defaults3(avctx, codec) < 0){
162 void avcodec_free_context(AVCodecContext **pavctx)
164 AVCodecContext *avctx = *pavctx;
169 avcodec_close(avctx);
171 av_freep(&avctx->extradata);
172 av_freep(&avctx->subtitle_header);
173 av_freep(&avctx->intra_matrix);
174 av_freep(&avctx->inter_matrix);
175 av_freep(&avctx->rc_override);
180 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
182 const AVCodec *orig_codec = dest->codec;
183 uint8_t *orig_priv_data = dest->priv_data;
185 if (avcodec_is_open(dest)) { // check that the dest context is uninitialized
186 av_log(dest, AV_LOG_ERROR,
187 "Tried to copy AVCodecContext %p into already-initialized %p\n",
189 return AVERROR(EINVAL);
193 av_freep(&dest->rc_override);
194 av_freep(&dest->intra_matrix);
195 av_freep(&dest->inter_matrix);
196 av_freep(&dest->extradata);
197 av_freep(&dest->subtitle_header);
199 memcpy(dest, src, sizeof(*dest));
200 av_opt_copy(dest, src);
202 dest->priv_data = orig_priv_data;
203 dest->codec = orig_codec;
205 if (orig_priv_data && src->codec && src->codec->priv_class &&
206 dest->codec && dest->codec->priv_class)
207 av_opt_copy(orig_priv_data, src->priv_data);
210 /* set values specific to opened codecs back to their default state */
211 dest->slice_offset = NULL;
212 dest->hwaccel = NULL;
213 dest->internal = NULL;
214 dest->coded_frame = NULL;
216 /* reallocate values that should be allocated separately */
217 dest->extradata = NULL;
218 dest->intra_matrix = NULL;
219 dest->inter_matrix = NULL;
220 dest->rc_override = NULL;
221 dest->subtitle_header = NULL;
223 #define alloc_and_copy_or_fail(obj, size, pad) \
224 if (src->obj && size > 0) { \
225 dest->obj = av_malloc(size + pad); \
228 memcpy(dest->obj, src->obj, size); \
230 memset(((uint8_t *) dest->obj) + size, 0, pad); \
232 alloc_and_copy_or_fail(extradata, src->extradata_size,
233 FF_INPUT_BUFFER_PADDING_SIZE);
234 dest->extradata_size = src->extradata_size;
235 alloc_and_copy_or_fail(intra_matrix, 64 * sizeof(int16_t), 0);
236 alloc_and_copy_or_fail(inter_matrix, 64 * sizeof(int16_t), 0);
237 alloc_and_copy_or_fail(rc_override, src->rc_override_count * sizeof(*src->rc_override), 0);
238 alloc_and_copy_or_fail(subtitle_header, src->subtitle_header_size, 1);
239 av_assert0(dest->subtitle_header_size == src->subtitle_header_size);
240 #undef alloc_and_copy_or_fail
245 av_freep(&dest->rc_override);
246 av_freep(&dest->intra_matrix);
247 av_freep(&dest->inter_matrix);
248 av_freep(&dest->extradata);
249 av_freep(&dest->subtitle_header);
250 dest->subtitle_header_size = 0;
251 dest->extradata_size = 0;
253 return AVERROR(ENOMEM);
256 const AVClass *avcodec_get_class(void)
258 return &av_codec_context_class;
261 #define FOFFSET(x) offsetof(AVFrame,x)
263 static const AVOption frame_options[]={
264 {"best_effort_timestamp", "", FOFFSET(best_effort_timestamp), AV_OPT_TYPE_INT64, {.i64 = AV_NOPTS_VALUE }, INT64_MIN, INT64_MAX, 0},
265 {"pkt_pos", "", FOFFSET(pkt_pos), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
266 {"pkt_size", "", FOFFSET(pkt_size), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
267 {"sample_aspect_ratio", "", FOFFSET(sample_aspect_ratio), AV_OPT_TYPE_RATIONAL, {.dbl = 0 }, 0, INT_MAX, 0},
268 {"width", "", FOFFSET(width), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
269 {"height", "", FOFFSET(height), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
270 {"format", "", FOFFSET(format), AV_OPT_TYPE_INT, {.i64 = -1 }, 0, INT_MAX, 0},
271 {"channel_layout", "", FOFFSET(channel_layout), AV_OPT_TYPE_INT64, {.i64 = 0 }, 0, INT64_MAX, 0},
272 {"sample_rate", "", FOFFSET(sample_rate), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
276 static const AVClass av_frame_class = {
277 .class_name = "AVFrame",
279 .option = frame_options,
280 .version = LIBAVUTIL_VERSION_INT,
283 const AVClass *avcodec_get_frame_class(void)
285 return &av_frame_class;
288 #define SROFFSET(x) offsetof(AVSubtitleRect,x)
290 static const AVOption subtitle_rect_options[]={
291 {"x", "", SROFFSET(x), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
292 {"y", "", SROFFSET(y), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
293 {"w", "", SROFFSET(w), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
294 {"h", "", SROFFSET(h), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
295 {"type", "", SROFFSET(type), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
296 {"flags", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0, "flags"},
297 {"forced", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0},
301 static const AVClass av_subtitle_rect_class = {
302 .class_name = "AVSubtitleRect",
304 .option = subtitle_rect_options,
305 .version = LIBAVUTIL_VERSION_INT,
308 const AVClass *avcodec_get_subtitle_rect_class(void)
310 return &av_subtitle_rect_class;
314 static int dummy_init(AVCodecContext *ctx)
316 //TODO: this code should set every possible pointer that could be set by codec and is not an option;
317 ctx->extradata_size = 8;
318 ctx->extradata = av_malloc(ctx->extradata_size);
319 ctx->coded_frame = av_frame_alloc();
323 static int dummy_close(AVCodecContext *ctx)
325 av_freep(&ctx->extradata);
326 ctx->extradata_size = 0;
327 av_frame_free(&ctx->coded_frame);
331 static int dummy_encode(AVCodecContext *ctx, AVPacket *pkt, const AVFrame *frame, int *got_packet)
333 return AVERROR(ENOSYS);
336 typedef struct Dummy12Context {
342 typedef struct Dummy3Context {
348 #define OFFSET(x) offsetof(Dummy12Context, x)
349 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
350 static const AVOption dummy_options[] = {
351 { "str", "set str", OFFSET(str), AV_OPT_TYPE_STRING, { .str = "i'm src default value" }, 0, 0, VE},
352 { "num", "set num", OFFSET(num), AV_OPT_TYPE_INT, { .i64 = 1500100900 }, 0, INT_MAX, VE},
356 static const AVClass dummy_v1_class = {
357 .class_name = "dummy_v1_class",
358 .item_name = av_default_item_name,
359 .option = dummy_options,
360 .version = LIBAVUTIL_VERSION_INT,
363 static const AVClass dummy_v2_class = {
364 .class_name = "dummy_v2_class",
365 .item_name = av_default_item_name,
366 .option = dummy_options,
367 .version = LIBAVUTIL_VERSION_INT,
370 /* codec with options */
371 AVCodec dummy_v1_encoder = {
372 .name = "dummy_v1_codec",
373 .type = AVMEDIA_TYPE_VIDEO,
374 .id = AV_CODEC_ID_NONE - 1,
375 .encode2 = dummy_encode,
377 .close = dummy_close,
378 .priv_class = &dummy_v1_class,
379 .priv_data_size = sizeof(Dummy12Context),
382 /* codec with options, different class */
383 AVCodec dummy_v2_encoder = {
384 .name = "dummy_v2_codec",
385 .type = AVMEDIA_TYPE_VIDEO,
386 .id = AV_CODEC_ID_NONE - 2,
387 .encode2 = dummy_encode,
389 .close = dummy_close,
390 .priv_class = &dummy_v2_class,
391 .priv_data_size = sizeof(Dummy12Context),
394 /* codec with priv data, but no class */
395 AVCodec dummy_v3_encoder = {
396 .name = "dummy_v3_codec",
397 .type = AVMEDIA_TYPE_VIDEO,
398 .id = AV_CODEC_ID_NONE - 3,
399 .encode2 = dummy_encode,
401 .close = dummy_close,
402 .priv_data_size = sizeof(Dummy3Context),
405 /* codec without priv data */
406 AVCodec dummy_v4_encoder = {
407 .name = "dummy_v4_codec",
408 .type = AVMEDIA_TYPE_VIDEO,
409 .id = AV_CODEC_ID_NONE - 4,
410 .encode2 = dummy_encode,
412 .close = dummy_close,
415 static void test_copy_print_codec(const AVCodecContext *ctx)
417 printf("%-14s: %dx%d prv: %s",
418 ctx->codec ? ctx->codec->name : "NULL",
419 ctx->width, ctx->height,
420 ctx->priv_data ? "set" : "null");
421 if (ctx->codec && ctx->codec->priv_class && ctx->codec->priv_data_size) {
424 av_opt_get_int(ctx->priv_data, "num", 0, &i64);
425 av_opt_get(ctx->priv_data, "str", 0, (uint8_t**)&str);
426 printf(" opts: %"PRId64" %s", i64, str);
432 static void test_copy(const AVCodec *c1, const AVCodec *c2)
434 AVCodecContext *ctx1, *ctx2;
435 printf("%s -> %s\nclosed:\n", c1 ? c1->name : "NULL", c2 ? c2->name : "NULL");
436 ctx1 = avcodec_alloc_context3(c1);
437 ctx2 = avcodec_alloc_context3(c2);
438 ctx1->width = ctx1->height = 128;
439 if (ctx2->codec && ctx2->codec->priv_class && ctx2->codec->priv_data_size) {
440 av_opt_set(ctx2->priv_data, "num", "667", 0);
441 av_opt_set(ctx2->priv_data, "str", "i'm dest value before copy", 0);
443 avcodec_copy_context(ctx2, ctx1);
444 test_copy_print_codec(ctx1);
445 test_copy_print_codec(ctx2);
448 avcodec_open2(ctx1, ctx1->codec, NULL);
449 if (ctx2->codec && ctx2->codec->priv_class && ctx2->codec->priv_data_size) {
450 av_opt_set(ctx2->priv_data, "num", "667", 0);
451 av_opt_set(ctx2->priv_data, "str", "i'm dest value before copy", 0);
453 avcodec_copy_context(ctx2, ctx1);
454 test_copy_print_codec(ctx1);
455 test_copy_print_codec(ctx2);
458 avcodec_free_context(&ctx1);
459 avcodec_free_context(&ctx2);
464 AVCodec *dummy_codec[] = {
473 for (i = 0; dummy_codec[i]; i++)
474 avcodec_register(dummy_codec[i]);
476 printf("testing avcodec_copy_context()\n");
477 for (i = 0; i < FF_ARRAY_ELEMS(dummy_codec); i++)
478 for (j = 0; j < FF_ARRAY_ELEMS(dummy_codec); j++)
479 test_copy(dummy_codec[i], dummy_codec[j]);