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/opt.h"
31 #include <float.h>              /* FLT_MIN, FLT_MAX */
32
33 #include "options_table.h"
34
35 static const char* context_to_name(void* ptr) {
36     AVCodecContext *avc= ptr;
37
38     if(avc && avc->codec && avc->codec->name)
39         return avc->codec->name;
40     else
41         return "NULL";
42 }
43
44 static void *codec_child_next(void *obj, void *prev)
45 {
46     AVCodecContext *s = obj;
47     if (!prev && s->codec && s->codec->priv_class && s->priv_data)
48         return s->priv_data;
49     return NULL;
50 }
51
52 static const AVClass *codec_child_class_next(const AVClass *prev)
53 {
54     AVCodec *c = NULL;
55
56     /* find the codec that corresponds to prev */
57     while (prev && (c = av_codec_next(c)))
58         if (c->priv_class == prev)
59             break;
60
61     /* find next codec with priv options */
62     while (c = av_codec_next(c))
63         if (c->priv_class)
64             return c->priv_class;
65     return NULL;
66 }
67
68 static const AVClass av_codec_context_class = {
69     .class_name              = "AVCodecContext",
70     .item_name               = context_to_name,
71     .option                  = options,
72     .version                 = LIBAVUTIL_VERSION_INT,
73     .log_level_offset_offset = offsetof(AVCodecContext, log_level_offset),
74     .child_next              = codec_child_next,
75     .child_class_next        = codec_child_class_next,
76 };
77
78 #if FF_API_ALLOC_CONTEXT
79 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType codec_type){
80     AVCodec c= {0};
81     c.type= codec_type;
82     avcodec_get_context_defaults3(s, &c);
83 }
84 #endif
85
86 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec){
87     int flags=0;
88     memset(s, 0, sizeof(AVCodecContext));
89
90     s->av_class = &av_codec_context_class;
91
92     s->codec_type = codec ? codec->type : AVMEDIA_TYPE_UNKNOWN;
93     if(s->codec_type == AVMEDIA_TYPE_AUDIO)
94         flags= AV_OPT_FLAG_AUDIO_PARAM;
95     else if(s->codec_type == AVMEDIA_TYPE_VIDEO)
96         flags= AV_OPT_FLAG_VIDEO_PARAM;
97     else if(s->codec_type == AVMEDIA_TYPE_SUBTITLE)
98         flags= AV_OPT_FLAG_SUBTITLE_PARAM;
99     av_opt_set_defaults2(s, flags, flags);
100
101     s->time_base           = (AVRational){0,1};
102     s->get_buffer          = avcodec_default_get_buffer;
103     s->release_buffer      = avcodec_default_release_buffer;
104     s->get_format          = avcodec_default_get_format;
105     s->execute             = avcodec_default_execute;
106     s->execute2            = avcodec_default_execute2;
107     s->sample_aspect_ratio = (AVRational){0,1};
108     s->pix_fmt             = PIX_FMT_NONE;
109     s->sample_fmt          = AV_SAMPLE_FMT_NONE;
110     s->timecode_frame_start = -1;
111
112     s->reget_buffer        = avcodec_default_reget_buffer;
113     s->reordered_opaque    = AV_NOPTS_VALUE;
114     if(codec && codec->priv_data_size){
115         if(!s->priv_data){
116             s->priv_data= av_mallocz(codec->priv_data_size);
117             if (!s->priv_data) {
118                 return AVERROR(ENOMEM);
119             }
120         }
121         if(codec->priv_class){
122             *(const AVClass**)s->priv_data = codec->priv_class;
123             av_opt_set_defaults(s->priv_data);
124         }
125     }
126     if (codec && codec->defaults) {
127         int ret;
128         const AVCodecDefault *d = codec->defaults;
129         while (d->key) {
130             ret = av_opt_set(s, d->key, d->value, 0);
131             av_assert0(ret >= 0);
132             d++;
133         }
134     }
135     return 0;
136 }
137
138 AVCodecContext *avcodec_alloc_context3(AVCodec *codec){
139     AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
140
141     if(avctx==NULL) return NULL;
142
143     if(avcodec_get_context_defaults3(avctx, codec) < 0){
144         av_free(avctx);
145         return NULL;
146     }
147
148     return avctx;
149 }
150
151 #if FF_API_ALLOC_CONTEXT
152 AVCodecContext *avcodec_alloc_context2(enum AVMediaType codec_type){
153     AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
154
155     if(avctx==NULL) return NULL;
156
157     avcodec_get_context_defaults2(avctx, codec_type);
158
159     return avctx;
160 }
161
162 void avcodec_get_context_defaults(AVCodecContext *s){
163     avcodec_get_context_defaults2(s, AVMEDIA_TYPE_UNKNOWN);
164 }
165
166 AVCodecContext *avcodec_alloc_context(void){
167     return avcodec_alloc_context2(AVMEDIA_TYPE_UNKNOWN);
168 }
169 #endif
170
171 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
172 {
173     if (avcodec_is_open(dest)) { // check that the dest context is uninitialized
174         av_log(dest, AV_LOG_ERROR,
175                "Tried to copy AVCodecContext %p into already-initialized %p\n",
176                src, dest);
177         return AVERROR(EINVAL);
178     }
179     memcpy(dest, src, sizeof(*dest));
180
181     /* set values specific to opened codecs back to their default state */
182     dest->priv_data       = NULL;
183     dest->codec           = NULL;
184     dest->slice_offset    = NULL;
185     dest->hwaccel         = NULL;
186     dest->thread_opaque   = NULL;
187     dest->internal        = NULL;
188
189     /* reallocate values that should be allocated separately */
190     dest->rc_eq           = NULL;
191     dest->extradata       = NULL;
192     dest->intra_matrix    = NULL;
193     dest->inter_matrix    = NULL;
194     dest->rc_override     = NULL;
195     if (src->rc_eq) {
196         dest->rc_eq = av_strdup(src->rc_eq);
197         if (!dest->rc_eq)
198             return AVERROR(ENOMEM);
199     }
200
201 #define alloc_and_copy_or_fail(obj, size, pad) \
202     if (src->obj && size > 0) { \
203         dest->obj = av_malloc(size + pad); \
204         if (!dest->obj) \
205             goto fail; \
206         memcpy(dest->obj, src->obj, size); \
207         if (pad) \
208             memset(((uint8_t *) dest->obj) + size, 0, pad); \
209     }
210     alloc_and_copy_or_fail(extradata,    src->extradata_size,
211                            FF_INPUT_BUFFER_PADDING_SIZE);
212     alloc_and_copy_or_fail(intra_matrix, 64 * sizeof(int16_t), 0);
213     alloc_and_copy_or_fail(inter_matrix, 64 * sizeof(int16_t), 0);
214     alloc_and_copy_or_fail(rc_override,  src->rc_override_count * sizeof(*src->rc_override), 0);
215 #undef alloc_and_copy_or_fail
216
217     return 0;
218
219 fail:
220     av_freep(&dest->rc_override);
221     av_freep(&dest->intra_matrix);
222     av_freep(&dest->inter_matrix);
223     av_freep(&dest->extradata);
224     av_freep(&dest->rc_eq);
225     return AVERROR(ENOMEM);
226 }
227
228 const AVClass *avcodec_get_class(void)
229 {
230     return &av_codec_context_class;
231 }
232
233 #define FOFFSET(x) offsetof(AVFrame,x)
234
235 static const AVOption frame_options[]={
236 {"best_effort_timestamp", "", FOFFSET(best_effort_timestamp), AV_OPT_TYPE_INT64, {.dbl = AV_NOPTS_VALUE }, INT64_MIN, INT64_MAX, 0},
237 {"pkt_pos", "", FOFFSET(pkt_pos), AV_OPT_TYPE_INT64, {.dbl = -1 }, INT64_MIN, INT64_MAX, 0},
238 {"sample_aspect_ratio", "", FOFFSET(sample_aspect_ratio), AV_OPT_TYPE_RATIONAL, {.dbl = 0 }, 0, INT_MAX, 0},
239 {"width", "", FOFFSET(width), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
240 {"height", "", FOFFSET(height), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
241 {"format", "", FOFFSET(format), AV_OPT_TYPE_INT, {.dbl = -1 }, 0, INT_MAX, 0},
242 {NULL},
243 };
244
245 static const AVClass av_frame_class = {
246     .class_name              = "AVFrame",
247     .item_name               = NULL,
248     .option                  = frame_options,
249     .version                 = LIBAVUTIL_VERSION_INT,
250 };
251
252 const AVClass *avcodec_get_frame_class(void)
253 {
254     return &av_frame_class;
255 }