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