Merge commit '716d413c13981da15323c7a3821860536eefdbbb'
[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/mem.h"
31 #include "libavutil/opt.h"
32 #include <float.h>              /* FLT_MIN, FLT_MAX */
33 #include <string.h>
34
35 #include "options_table.h"
36
37 static const char* context_to_name(void* ptr) {
38     AVCodecContext *avc= ptr;
39
40     if(avc && avc->codec && avc->codec->name)
41         return avc->codec->name;
42     else
43         return "NULL";
44 }
45
46 static void *codec_child_next(void *obj, void *prev)
47 {
48     AVCodecContext *s = obj;
49     if (!prev && s->codec && s->codec->priv_class && s->priv_data)
50         return s->priv_data;
51     return NULL;
52 }
53
54 static const AVClass *codec_child_class_next(const AVClass *prev)
55 {
56     AVCodec *c = NULL;
57
58     /* find the codec that corresponds to prev */
59     while (prev && (c = av_codec_next(c)))
60         if (c->priv_class == prev)
61             break;
62
63     /* find next codec with priv options */
64     while (c = av_codec_next(c))
65         if (c->priv_class)
66             return c->priv_class;
67     return NULL;
68 }
69
70 static AVClassCategory get_category(void *ptr)
71 {
72     AVCodecContext* avctx = ptr;
73     if(avctx->codec && avctx->codec->decode) return AV_CLASS_CATEGORY_DECODER;
74     else                                     return AV_CLASS_CATEGORY_ENCODER;
75 }
76
77 static const AVClass av_codec_context_class = {
78     .class_name              = "AVCodecContext",
79     .item_name               = context_to_name,
80     .option                  = options,
81     .version                 = LIBAVUTIL_VERSION_INT,
82     .log_level_offset_offset = offsetof(AVCodecContext, log_level_offset),
83     .child_next              = codec_child_next,
84     .child_class_next        = codec_child_class_next,
85     .category                = AV_CLASS_CATEGORY_ENCODER,
86     .get_category            = get_category,
87 };
88
89 #if FF_API_ALLOC_CONTEXT
90 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType codec_type){
91     AVCodec c= {0};
92     c.type= codec_type;
93     avcodec_get_context_defaults3(s, &c);
94 }
95 #endif
96
97 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec)
98 {
99     int flags=0;
100     memset(s, 0, sizeof(AVCodecContext));
101
102     s->av_class = &av_codec_context_class;
103
104     s->codec_type = codec ? codec->type : AVMEDIA_TYPE_UNKNOWN;
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->get_buffer          = avcodec_default_get_buffer;
115     s->release_buffer      = avcodec_default_release_buffer;
116     s->get_format          = avcodec_default_get_format;
117     s->execute             = avcodec_default_execute;
118     s->execute2            = avcodec_default_execute2;
119     s->sample_aspect_ratio = (AVRational){0,1};
120     s->pix_fmt             = AV_PIX_FMT_NONE;
121     s->sample_fmt          = AV_SAMPLE_FMT_NONE;
122     s->timecode_frame_start = -1;
123
124     s->reget_buffer        = avcodec_default_reget_buffer;
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 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec)
151 {
152     AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
153
154     if(avctx==NULL) return NULL;
155
156     if(avcodec_get_context_defaults3(avctx, codec) < 0){
157         av_free(avctx);
158         return NULL;
159     }
160
161     return avctx;
162 }
163
164 #if FF_API_ALLOC_CONTEXT
165 AVCodecContext *avcodec_alloc_context2(enum AVMediaType codec_type){
166     AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
167
168     if(avctx==NULL) return NULL;
169
170     avcodec_get_context_defaults2(avctx, codec_type);
171
172     return avctx;
173 }
174
175 void avcodec_get_context_defaults(AVCodecContext *s){
176     avcodec_get_context_defaults2(s, AVMEDIA_TYPE_UNKNOWN);
177 }
178
179 AVCodecContext *avcodec_alloc_context(void){
180     return avcodec_alloc_context2(AVMEDIA_TYPE_UNKNOWN);
181 }
182 #endif
183
184 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
185 {
186     if (avcodec_is_open(dest)) { // check that the dest context is uninitialized
187         av_log(dest, AV_LOG_ERROR,
188                "Tried to copy AVCodecContext %p into already-initialized %p\n",
189                src, dest);
190         return AVERROR(EINVAL);
191     }
192     memcpy(dest, src, sizeof(*dest));
193
194     /* set values specific to opened codecs back to their default state */
195     dest->priv_data       = NULL;
196     dest->codec           = NULL;
197     dest->slice_offset    = NULL;
198     dest->hwaccel         = NULL;
199     dest->thread_opaque   = NULL;
200     dest->internal        = NULL;
201
202     /* reallocate values that should be allocated separately */
203     dest->rc_eq           = NULL;
204     dest->extradata       = NULL;
205     dest->intra_matrix    = NULL;
206     dest->inter_matrix    = NULL;
207     dest->rc_override     = NULL;
208     if (src->rc_eq) {
209         dest->rc_eq = av_strdup(src->rc_eq);
210         if (!dest->rc_eq)
211             return AVERROR(ENOMEM);
212     }
213
214 #define alloc_and_copy_or_fail(obj, size, pad) \
215     if (src->obj && size > 0) { \
216         dest->obj = av_malloc(size + pad); \
217         if (!dest->obj) \
218             goto fail; \
219         memcpy(dest->obj, src->obj, size); \
220         if (pad) \
221             memset(((uint8_t *) dest->obj) + size, 0, pad); \
222     }
223     alloc_and_copy_or_fail(extradata,    src->extradata_size,
224                            FF_INPUT_BUFFER_PADDING_SIZE);
225     alloc_and_copy_or_fail(intra_matrix, 64 * sizeof(int16_t), 0);
226     alloc_and_copy_or_fail(inter_matrix, 64 * sizeof(int16_t), 0);
227     alloc_and_copy_or_fail(rc_override,  src->rc_override_count * sizeof(*src->rc_override), 0);
228 #undef alloc_and_copy_or_fail
229
230     return 0;
231
232 fail:
233     av_freep(&dest->rc_override);
234     av_freep(&dest->intra_matrix);
235     av_freep(&dest->inter_matrix);
236     av_freep(&dest->extradata);
237     av_freep(&dest->rc_eq);
238     return AVERROR(ENOMEM);
239 }
240
241 const AVClass *avcodec_get_class(void)
242 {
243     return &av_codec_context_class;
244 }
245
246 #define FOFFSET(x) offsetof(AVFrame,x)
247
248 static const AVOption frame_options[]={
249 {"best_effort_timestamp", "", FOFFSET(best_effort_timestamp), AV_OPT_TYPE_INT64, {.i64 = AV_NOPTS_VALUE }, INT64_MIN, INT64_MAX, 0},
250 {"pkt_pos", "", FOFFSET(pkt_pos), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
251 {"sample_aspect_ratio", "", FOFFSET(sample_aspect_ratio), AV_OPT_TYPE_RATIONAL, {.dbl = 0 }, 0, INT_MAX, 0},
252 {"width", "", FOFFSET(width), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
253 {"height", "", FOFFSET(height), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
254 {"format", "", FOFFSET(format), AV_OPT_TYPE_INT, {.i64 = -1 }, 0, INT_MAX, 0},
255 {"channel_layout", "", FOFFSET(channel_layout), AV_OPT_TYPE_INT64, {.i64 = 0 }, 0, INT64_MAX, 0},
256 {"sample_rate", "", FOFFSET(sample_rate), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
257 {NULL},
258 };
259
260 static const AVClass av_frame_class = {
261     .class_name              = "AVFrame",
262     .item_name               = NULL,
263     .option                  = frame_options,
264     .version                 = LIBAVUTIL_VERSION_INT,
265 };
266
267 const AVClass *avcodec_get_frame_class(void)
268 {
269     return &av_frame_class;
270 }
271
272 #define SROFFSET(x) offsetof(AVSubtitleRect,x)
273
274 static const AVOption subtitle_rect_options[]={
275 {"x", "", SROFFSET(x), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
276 {"y", "", SROFFSET(y), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
277 {"w", "", SROFFSET(w), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
278 {"h", "", SROFFSET(h), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
279 {"type", "", SROFFSET(type), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
280 {"forced", "", SROFFSET(forced), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, 0},
281 {NULL},
282 };
283
284 static const AVClass av_subtitle_rect_class = {
285     .class_name             = "AVSubtitleRect",
286     .item_name              = NULL,
287     .option                 = subtitle_rect_options,
288     .version                = LIBAVUTIL_VERSION_INT,
289 };
290
291 const AVClass *avcodec_get_subtitle_rect_class(void)
292 {
293     return &av_subtitle_rect_class;
294 }