Merge remote-tracking branch 'qatar/master'
[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, AVCodec *codec){
98     int flags=0;
99     memset(s, 0, sizeof(AVCodecContext));
100
101     s->av_class = &av_codec_context_class;
102
103     s->codec_type = codec ? codec->type : AVMEDIA_TYPE_UNKNOWN;
104     if(s->codec_type == AVMEDIA_TYPE_AUDIO)
105         flags= AV_OPT_FLAG_AUDIO_PARAM;
106     else if(s->codec_type == AVMEDIA_TYPE_VIDEO)
107         flags= AV_OPT_FLAG_VIDEO_PARAM;
108     else if(s->codec_type == AVMEDIA_TYPE_SUBTITLE)
109         flags= AV_OPT_FLAG_SUBTITLE_PARAM;
110     av_opt_set_defaults2(s, flags, flags);
111
112     s->time_base           = (AVRational){0,1};
113     s->get_buffer          = avcodec_default_get_buffer;
114     s->release_buffer      = avcodec_default_release_buffer;
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             = PIX_FMT_NONE;
120     s->sample_fmt          = AV_SAMPLE_FMT_NONE;
121     s->timecode_frame_start = -1;
122
123     s->reget_buffer        = avcodec_default_reget_buffer;
124     s->reordered_opaque    = AV_NOPTS_VALUE;
125     if(codec && codec->priv_data_size){
126         if(!s->priv_data){
127             s->priv_data= av_mallocz(codec->priv_data_size);
128             if (!s->priv_data) {
129                 return AVERROR(ENOMEM);
130             }
131         }
132         if(codec->priv_class){
133             *(const AVClass**)s->priv_data = codec->priv_class;
134             av_opt_set_defaults(s->priv_data);
135         }
136     }
137     if (codec && codec->defaults) {
138         int ret;
139         const AVCodecDefault *d = codec->defaults;
140         while (d->key) {
141             ret = av_opt_set(s, d->key, d->value, 0);
142             av_assert0(ret >= 0);
143             d++;
144         }
145     }
146     return 0;
147 }
148
149 AVCodecContext *avcodec_alloc_context3(AVCodec *codec){
150     AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
151
152     if(avctx==NULL) return NULL;
153
154     if(avcodec_get_context_defaults3(avctx, codec) < 0){
155         av_free(avctx);
156         return NULL;
157     }
158
159     return avctx;
160 }
161
162 #if FF_API_ALLOC_CONTEXT
163 AVCodecContext *avcodec_alloc_context2(enum AVMediaType codec_type){
164     AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
165
166     if(avctx==NULL) return NULL;
167
168     avcodec_get_context_defaults2(avctx, codec_type);
169
170     return avctx;
171 }
172
173 void avcodec_get_context_defaults(AVCodecContext *s){
174     avcodec_get_context_defaults2(s, AVMEDIA_TYPE_UNKNOWN);
175 }
176
177 AVCodecContext *avcodec_alloc_context(void){
178     return avcodec_alloc_context2(AVMEDIA_TYPE_UNKNOWN);
179 }
180 #endif
181
182 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
183 {
184     if (avcodec_is_open(dest)) { // check that the dest context is uninitialized
185         av_log(dest, AV_LOG_ERROR,
186                "Tried to copy AVCodecContext %p into already-initialized %p\n",
187                src, dest);
188         return AVERROR(EINVAL);
189     }
190     memcpy(dest, src, sizeof(*dest));
191
192     /* set values specific to opened codecs back to their default state */
193     dest->priv_data       = NULL;
194     dest->codec           = NULL;
195     dest->slice_offset    = NULL;
196     dest->hwaccel         = NULL;
197     dest->thread_opaque   = NULL;
198     dest->internal        = NULL;
199
200     /* reallocate values that should be allocated separately */
201     dest->rc_eq           = NULL;
202     dest->extradata       = NULL;
203     dest->intra_matrix    = NULL;
204     dest->inter_matrix    = NULL;
205     dest->rc_override     = NULL;
206     if (src->rc_eq) {
207         dest->rc_eq = av_strdup(src->rc_eq);
208         if (!dest->rc_eq)
209             return AVERROR(ENOMEM);
210     }
211
212 #define alloc_and_copy_or_fail(obj, size, pad) \
213     if (src->obj && size > 0) { \
214         dest->obj = av_malloc(size + pad); \
215         if (!dest->obj) \
216             goto fail; \
217         memcpy(dest->obj, src->obj, size); \
218         if (pad) \
219             memset(((uint8_t *) dest->obj) + size, 0, pad); \
220     }
221     alloc_and_copy_or_fail(extradata,    src->extradata_size,
222                            FF_INPUT_BUFFER_PADDING_SIZE);
223     alloc_and_copy_or_fail(intra_matrix, 64 * sizeof(int16_t), 0);
224     alloc_and_copy_or_fail(inter_matrix, 64 * sizeof(int16_t), 0);
225     alloc_and_copy_or_fail(rc_override,  src->rc_override_count * sizeof(*src->rc_override), 0);
226 #undef alloc_and_copy_or_fail
227
228     return 0;
229
230 fail:
231     av_freep(&dest->rc_override);
232     av_freep(&dest->intra_matrix);
233     av_freep(&dest->inter_matrix);
234     av_freep(&dest->extradata);
235     av_freep(&dest->rc_eq);
236     return AVERROR(ENOMEM);
237 }
238
239 const AVClass *avcodec_get_class(void)
240 {
241     return &av_codec_context_class;
242 }
243
244 #define FOFFSET(x) offsetof(AVFrame,x)
245
246 static const AVOption frame_options[]={
247 {"best_effort_timestamp", "", FOFFSET(best_effort_timestamp), AV_OPT_TYPE_INT64, {.dbl = AV_NOPTS_VALUE }, INT64_MIN, INT64_MAX, 0},
248 {"pkt_pos", "", FOFFSET(pkt_pos), AV_OPT_TYPE_INT64, {.dbl = -1 }, INT64_MIN, INT64_MAX, 0},
249 {"sample_aspect_ratio", "", FOFFSET(sample_aspect_ratio), AV_OPT_TYPE_RATIONAL, {.dbl = 0 }, 0, INT_MAX, 0},
250 {"width", "", FOFFSET(width), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
251 {"height", "", FOFFSET(height), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
252 {"format", "", FOFFSET(format), AV_OPT_TYPE_INT, {.dbl = -1 }, 0, INT_MAX, 0},
253 {"channel_layout", "", FOFFSET(channel_layout), AV_OPT_TYPE_INT64, {.dbl = 0 }, 0, INT64_MAX, 0},
254 {"sample_rate", "", FOFFSET(sample_rate), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
255 {NULL},
256 };
257
258 static const AVClass av_frame_class = {
259     .class_name              = "AVFrame",
260     .item_name               = NULL,
261     .option                  = frame_options,
262     .version                 = LIBAVUTIL_VERSION_INT,
263 };
264
265 const AVClass *avcodec_get_frame_class(void)
266 {
267     return &av_frame_class;
268 }
269
270 #define SROFFSET(x) offsetof(AVSubtitleRect,x)
271
272 static const AVOption subtitle_rect_options[]={
273 {"x", "", SROFFSET(x), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
274 {"y", "", SROFFSET(y), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
275 {"w", "", SROFFSET(w), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
276 {"h", "", SROFFSET(h), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
277 {"type", "", SROFFSET(type), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
278 {"forced", "", SROFFSET(forced), AV_OPT_TYPE_INT, {.dbl = 0}, 0, 1, 0},
279 {NULL},
280 };
281
282 static const AVClass av_subtitle_rect_class = {
283     .class_name             = "AVSubtitleRect",
284     .item_name              = NULL,
285     .option                 = subtitle_rect_options,
286     .version                = LIBAVUTIL_VERSION_INT,
287 };
288
289 const AVClass *avcodec_get_subtitle_rect_class(void)
290 {
291     return &av_subtitle_rect_class;
292 }