b98da9378af6493323a36e327b509c9e3b528833
[ffmpeg.git] / libavcodec / options.c
1 /*
2  * Copyright (c) 2001 Fabrice Bellard
3  * Copyright (c) 2002-2004 Michael Niedermayer <michaelni@gmx.at>
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 /**
23  * @file
24  * Options definition for AVCodecContext.
25  */
26
27 #include "avcodec.h"
28 #include "internal.h"
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 */
34 #include <string.h>
35
36 FF_DISABLE_DEPRECATION_WARNINGS
37 #include "options_table.h"
38 FF_ENABLE_DEPRECATION_WARNINGS
39
40 static const char* context_to_name(void* ptr) {
41     AVCodecContext *avc= ptr;
42
43     if(avc && avc->codec && avc->codec->name)
44         return avc->codec->name;
45     else
46         return "NULL";
47 }
48
49 static void *codec_child_next(void *obj, void *prev)
50 {
51     AVCodecContext *s = obj;
52     if (!prev && s->codec && s->codec->priv_class && s->priv_data)
53         return s->priv_data;
54     return NULL;
55 }
56
57 static const AVClass *codec_child_class_next(const AVClass *prev)
58 {
59     AVCodec *c = NULL;
60
61     /* find the codec that corresponds to prev */
62     while (prev && (c = av_codec_next(c)))
63         if (c->priv_class == prev)
64             break;
65
66     /* find next codec with priv options */
67     while (c = av_codec_next(c))
68         if (c->priv_class)
69             return c->priv_class;
70     return NULL;
71 }
72
73 static AVClassCategory get_category(void *ptr)
74 {
75     AVCodecContext* avctx = ptr;
76     if(avctx->codec && avctx->codec->decode) return AV_CLASS_CATEGORY_DECODER;
77     else                                     return AV_CLASS_CATEGORY_ENCODER;
78 }
79
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,
90 };
91
92 static int init_context_defaults(AVCodecContext *s, const AVCodec *codec)
93 {
94     int flags=0;
95     memset(s, 0, sizeof(AVCodecContext));
96
97     s->av_class = &av_codec_context_class;
98
99     s->codec_type = codec ? codec->type : AVMEDIA_TYPE_UNKNOWN;
100     if (codec) {
101         s->codec = codec;
102         s->codec_id = codec->id;
103     }
104
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);
112
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->sw_pix_fmt          = AV_PIX_FMT_NONE;
123     s->sample_fmt          = AV_SAMPLE_FMT_NONE;
124
125     s->reordered_opaque    = AV_NOPTS_VALUE;
126     if(codec && codec->priv_data_size){
127         if(!s->priv_data){
128             s->priv_data= av_mallocz(codec->priv_data_size);
129             if (!s->priv_data) {
130                 return AVERROR(ENOMEM);
131             }
132         }
133         if(codec->priv_class){
134             *(const AVClass**)s->priv_data = codec->priv_class;
135             av_opt_set_defaults(s->priv_data);
136         }
137     }
138     if (codec && codec->defaults) {
139         int ret;
140         const AVCodecDefault *d = codec->defaults;
141         while (d->key) {
142             ret = av_opt_set(s, d->key, d->value, 0);
143             av_assert0(ret >= 0);
144             d++;
145         }
146     }
147     return 0;
148 }
149
150 #if FF_API_GET_CONTEXT_DEFAULTS
151 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec)
152 {
153     return init_context_defaults(s, codec);
154 }
155 #endif
156
157 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec)
158 {
159     AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
160
161     if (!avctx)
162         return NULL;
163
164     if (init_context_defaults(avctx, codec) < 0) {
165         av_free(avctx);
166         return NULL;
167     }
168
169     return avctx;
170 }
171
172 void avcodec_free_context(AVCodecContext **pavctx)
173 {
174     AVCodecContext *avctx = *pavctx;
175
176     if (!avctx)
177         return;
178
179     avcodec_close(avctx);
180
181     av_freep(&avctx->extradata);
182     av_freep(&avctx->subtitle_header);
183     av_freep(&avctx->intra_matrix);
184     av_freep(&avctx->inter_matrix);
185     av_freep(&avctx->rc_override);
186
187     av_freep(pavctx);
188 }
189
190 #if FF_API_COPY_CONTEXT
191 static void copy_context_reset(AVCodecContext *avctx)
192 {
193     av_opt_free(avctx);
194     av_freep(&avctx->rc_override);
195     av_freep(&avctx->intra_matrix);
196     av_freep(&avctx->inter_matrix);
197     av_freep(&avctx->extradata);
198     av_freep(&avctx->subtitle_header);
199     av_buffer_unref(&avctx->hw_frames_ctx);
200     avctx->subtitle_header_size = 0;
201     avctx->extradata_size = 0;
202 }
203
204 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
205 {
206     const AVCodec *orig_codec = dest->codec;
207     uint8_t *orig_priv_data = dest->priv_data;
208
209     if (avcodec_is_open(dest)) { // check that the dest context is uninitialized
210         av_log(dest, AV_LOG_ERROR,
211                "Tried to copy AVCodecContext %p into already-initialized %p\n",
212                src, dest);
213         return AVERROR(EINVAL);
214     }
215
216     copy_context_reset(dest);
217
218     memcpy(dest, src, sizeof(*dest));
219     av_opt_copy(dest, src);
220
221     dest->priv_data       = orig_priv_data;
222     dest->codec           = orig_codec;
223
224     if (orig_priv_data && src->codec && src->codec->priv_class &&
225         dest->codec && dest->codec->priv_class)
226         av_opt_copy(orig_priv_data, src->priv_data);
227
228
229     /* set values specific to opened codecs back to their default state */
230     dest->slice_offset    = NULL;
231     dest->hwaccel         = NULL;
232     dest->internal        = NULL;
233 #if FF_API_CODED_FRAME
234 FF_DISABLE_DEPRECATION_WARNINGS
235     dest->coded_frame     = NULL;
236 FF_ENABLE_DEPRECATION_WARNINGS
237 #endif
238
239     /* reallocate values that should be allocated separately */
240     dest->extradata       = NULL;
241     dest->intra_matrix    = NULL;
242     dest->inter_matrix    = NULL;
243     dest->rc_override     = NULL;
244     dest->subtitle_header = NULL;
245     dest->hw_frames_ctx   = NULL;
246
247 #define alloc_and_copy_or_fail(obj, size, pad) \
248     if (src->obj && size > 0) { \
249         dest->obj = av_malloc(size + pad); \
250         if (!dest->obj) \
251             goto fail; \
252         memcpy(dest->obj, src->obj, size); \
253         if (pad) \
254             memset(((uint8_t *) dest->obj) + size, 0, pad); \
255     }
256     alloc_and_copy_or_fail(extradata,    src->extradata_size,
257                            AV_INPUT_BUFFER_PADDING_SIZE);
258     dest->extradata_size  = src->extradata_size;
259     alloc_and_copy_or_fail(intra_matrix, 64 * sizeof(int16_t), 0);
260     alloc_and_copy_or_fail(inter_matrix, 64 * sizeof(int16_t), 0);
261     alloc_and_copy_or_fail(rc_override,  src->rc_override_count * sizeof(*src->rc_override), 0);
262     alloc_and_copy_or_fail(subtitle_header, src->subtitle_header_size, 1);
263     av_assert0(dest->subtitle_header_size == src->subtitle_header_size);
264 #undef alloc_and_copy_or_fail
265
266     if (src->hw_frames_ctx) {
267         dest->hw_frames_ctx = av_buffer_ref(src->hw_frames_ctx);
268         if (!dest->hw_frames_ctx)
269             goto fail;
270     }
271
272     return 0;
273
274 fail:
275     copy_context_reset(dest);
276     return AVERROR(ENOMEM);
277 }
278 #endif
279
280 const AVClass *avcodec_get_class(void)
281 {
282     return &av_codec_context_class;
283 }
284
285 #define FOFFSET(x) offsetof(AVFrame,x)
286
287 static const AVOption frame_options[]={
288 {"best_effort_timestamp", "", FOFFSET(best_effort_timestamp), AV_OPT_TYPE_INT64, {.i64 = AV_NOPTS_VALUE }, INT64_MIN, INT64_MAX, 0},
289 {"pkt_pos", "", FOFFSET(pkt_pos), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
290 {"pkt_size", "", FOFFSET(pkt_size), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
291 {"sample_aspect_ratio", "", FOFFSET(sample_aspect_ratio), AV_OPT_TYPE_RATIONAL, {.dbl = 0 }, 0, INT_MAX, 0},
292 {"width", "", FOFFSET(width), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
293 {"height", "", FOFFSET(height), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
294 {"format", "", FOFFSET(format), AV_OPT_TYPE_INT, {.i64 = -1 }, 0, INT_MAX, 0},
295 {"channel_layout", "", FOFFSET(channel_layout), AV_OPT_TYPE_INT64, {.i64 = 0 }, 0, INT64_MAX, 0},
296 {"sample_rate", "", FOFFSET(sample_rate), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
297 {NULL},
298 };
299
300 static const AVClass av_frame_class = {
301     .class_name              = "AVFrame",
302     .item_name               = NULL,
303     .option                  = frame_options,
304     .version                 = LIBAVUTIL_VERSION_INT,
305 };
306
307 const AVClass *avcodec_get_frame_class(void)
308 {
309     return &av_frame_class;
310 }
311
312 #define SROFFSET(x) offsetof(AVSubtitleRect,x)
313
314 static const AVOption subtitle_rect_options[]={
315 {"x", "", SROFFSET(x), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
316 {"y", "", SROFFSET(y), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
317 {"w", "", SROFFSET(w), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
318 {"h", "", SROFFSET(h), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
319 {"type", "", SROFFSET(type), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
320 {"flags", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0, "flags"},
321 {"forced", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0},
322 {NULL},
323 };
324
325 static const AVClass av_subtitle_rect_class = {
326     .class_name             = "AVSubtitleRect",
327     .item_name              = NULL,
328     .option                 = subtitle_rect_options,
329     .version                = LIBAVUTIL_VERSION_INT,
330 };
331
332 const AVClass *avcodec_get_subtitle_rect_class(void)
333 {
334     return &av_subtitle_rect_class;
335 }
336
337 #ifdef TEST
338 static int dummy_init(AVCodecContext *ctx)
339 {
340     //TODO: this code should set every possible pointer that could be set by codec and is not an option;
341     ctx->extradata_size = 8;
342     ctx->extradata = av_malloc(ctx->extradata_size);
343     return 0;
344 }
345
346 static int dummy_close(AVCodecContext *ctx)
347 {
348     av_freep(&ctx->extradata);
349     ctx->extradata_size = 0;
350     return 0;
351 }
352
353 static int dummy_encode(AVCodecContext *ctx, AVPacket *pkt, const AVFrame *frame, int *got_packet)
354 {
355     return AVERROR(ENOSYS);
356 }
357
358 typedef struct Dummy12Context {
359     AVClass  *av_class;
360     int      num;
361     char*    str;
362 } Dummy12Context;
363
364 typedef struct Dummy3Context {
365     void     *fake_av_class;
366     int      num;
367     char*    str;
368 } Dummy3Context;
369
370 #define OFFSET(x) offsetof(Dummy12Context, x)
371 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
372 static const AVOption dummy_options[] = {
373     { "str", "set str", OFFSET(str), AV_OPT_TYPE_STRING, { .str = "i'm src default value" }, 0, 0, VE},
374     { "num", "set num", OFFSET(num), AV_OPT_TYPE_INT,    { .i64 = 1500100900 },    0, INT_MAX, VE},
375     { NULL },
376 };
377
378 static const AVClass dummy_v1_class = {
379     .class_name = "dummy_v1_class",
380     .item_name  = av_default_item_name,
381     .option     = dummy_options,
382     .version    = LIBAVUTIL_VERSION_INT,
383 };
384
385 static const AVClass dummy_v2_class = {
386     .class_name = "dummy_v2_class",
387     .item_name  = av_default_item_name,
388     .option     = dummy_options,
389     .version    = LIBAVUTIL_VERSION_INT,
390 };
391
392 /* codec with options */
393 static AVCodec dummy_v1_encoder = {
394     .name             = "dummy_v1_codec",
395     .type             = AVMEDIA_TYPE_VIDEO,
396     .id               = AV_CODEC_ID_NONE - 1,
397     .encode2          = dummy_encode,
398     .init             = dummy_init,
399     .close            = dummy_close,
400     .priv_class       = &dummy_v1_class,
401     .priv_data_size   = sizeof(Dummy12Context),
402 };
403
404 /* codec with options, different class */
405 static AVCodec dummy_v2_encoder = {
406     .name             = "dummy_v2_codec",
407     .type             = AVMEDIA_TYPE_VIDEO,
408     .id               = AV_CODEC_ID_NONE - 2,
409     .encode2          = dummy_encode,
410     .init             = dummy_init,
411     .close            = dummy_close,
412     .priv_class       = &dummy_v2_class,
413     .priv_data_size   = sizeof(Dummy12Context),
414 };
415
416 /* codec with priv data, but no class */
417 static AVCodec dummy_v3_encoder = {
418     .name             = "dummy_v3_codec",
419     .type             = AVMEDIA_TYPE_VIDEO,
420     .id               = AV_CODEC_ID_NONE - 3,
421     .encode2          = dummy_encode,
422     .init             = dummy_init,
423     .close            = dummy_close,
424     .priv_data_size   = sizeof(Dummy3Context),
425 };
426
427 /* codec without priv data */
428 static AVCodec dummy_v4_encoder = {
429     .name             = "dummy_v4_codec",
430     .type             = AVMEDIA_TYPE_VIDEO,
431     .id               = AV_CODEC_ID_NONE - 4,
432     .encode2          = dummy_encode,
433     .init             = dummy_init,
434     .close            = dummy_close,
435 };
436
437 static void test_copy_print_codec(const AVCodecContext *ctx)
438 {
439     printf("%-14s: %dx%d prv: %s",
440            ctx->codec ? ctx->codec->name : "NULL",
441            ctx->width, ctx->height,
442            ctx->priv_data ? "set" : "null");
443     if (ctx->codec && ctx->codec->priv_class && ctx->codec->priv_data_size) {
444         int64_t i64;
445         char *str = NULL;
446         av_opt_get_int(ctx->priv_data, "num", 0, &i64);
447         av_opt_get(ctx->priv_data, "str", 0, (uint8_t**)&str);
448         printf(" opts: %"PRId64" %s", i64, str);
449         av_free(str);
450     }
451     printf("\n");
452 }
453
454 static void test_copy(const AVCodec *c1, const AVCodec *c2)
455 {
456     AVCodecContext *ctx1, *ctx2;
457     printf("%s -> %s\nclosed:\n", c1 ? c1->name : "NULL", c2 ? c2->name : "NULL");
458     ctx1 = avcodec_alloc_context3(c1);
459     ctx2 = avcodec_alloc_context3(c2);
460     ctx1->width = ctx1->height = 128;
461     if (ctx2->codec && ctx2->codec->priv_class && ctx2->codec->priv_data_size) {
462         av_opt_set(ctx2->priv_data, "num", "667", 0);
463         av_opt_set(ctx2->priv_data, "str", "i'm dest value before copy", 0);
464     }
465     avcodec_copy_context(ctx2, ctx1);
466     test_copy_print_codec(ctx1);
467     test_copy_print_codec(ctx2);
468     if (ctx1->codec) {
469         printf("opened:\n");
470         avcodec_open2(ctx1, ctx1->codec, NULL);
471         if (ctx2->codec && ctx2->codec->priv_class && ctx2->codec->priv_data_size) {
472             av_opt_set(ctx2->priv_data, "num", "667", 0);
473             av_opt_set(ctx2->priv_data, "str", "i'm dest value before copy", 0);
474         }
475         avcodec_copy_context(ctx2, ctx1);
476         test_copy_print_codec(ctx1);
477         test_copy_print_codec(ctx2);
478         avcodec_close(ctx1);
479     }
480     avcodec_free_context(&ctx1);
481     avcodec_free_context(&ctx2);
482 }
483
484 int main(void)
485 {
486     AVCodec *dummy_codec[] = {
487         &dummy_v1_encoder,
488         &dummy_v2_encoder,
489         &dummy_v3_encoder,
490         &dummy_v4_encoder,
491         NULL,
492     };
493     int i, j;
494
495     for (i = 0; dummy_codec[i]; i++)
496         avcodec_register(dummy_codec[i]);
497
498     printf("testing avcodec_copy_context()\n");
499     for (i = 0; i < FF_ARRAY_ELEMS(dummy_codec); i++)
500         for (j = 0; j < FF_ARRAY_ELEMS(dummy_codec); j++)
501             test_copy(dummy_codec[i], dummy_codec[j]);
502     return 0;
503 }
504 #endif