]> git.sesse.net Git - ffmpeg/blob - libavcodec/options.c
369110b8d00f8f085ef6c09761337480bcf4fe94
[ffmpeg] / 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 <string.h>
34
35 FF_DISABLE_DEPRECATION_WARNINGS
36 #include "options_table.h"
37 FF_ENABLE_DEPRECATION_WARNINGS
38
39 static const char* context_to_name(void* ptr) {
40     AVCodecContext *avc= ptr;
41
42     if (avc && avc->codec)
43         return avc->codec->name;
44     else
45         return "NULL";
46 }
47
48 static void *codec_child_next(void *obj, void *prev)
49 {
50     AVCodecContext *s = obj;
51     if (!prev && s->codec && s->codec->priv_class && s->priv_data)
52         return s->priv_data;
53     return NULL;
54 }
55
56 #if FF_API_CHILD_CLASS_NEXT
57 static const AVClass *codec_child_class_next(const AVClass *prev)
58 {
59     void *iter = NULL;
60     const AVCodec *c = NULL;
61
62     /* find the codec that corresponds to prev */
63     while (prev && (c = av_codec_iterate(&iter)))
64         if (c->priv_class == prev)
65             break;
66
67     /* find next codec with priv options */
68     while (c = av_codec_iterate(&iter))
69         if (c->priv_class)
70             return c->priv_class;
71     return NULL;
72 }
73 #endif
74
75 static const AVClass *codec_child_class_iterate(void **iter)
76 {
77     const AVCodec *c;
78     /* find next codec with priv options */
79     while (c = av_codec_iterate(iter))
80         if (c->priv_class)
81             return c->priv_class;
82     return NULL;
83 }
84
85 static AVClassCategory get_category(void *ptr)
86 {
87     AVCodecContext* avctx = ptr;
88     if(avctx->codec && avctx->codec->decode) return AV_CLASS_CATEGORY_DECODER;
89     else                                     return AV_CLASS_CATEGORY_ENCODER;
90 }
91
92 static const AVClass av_codec_context_class = {
93     .class_name              = "AVCodecContext",
94     .item_name               = context_to_name,
95     .option                  = avcodec_options,
96     .version                 = LIBAVUTIL_VERSION_INT,
97     .log_level_offset_offset = offsetof(AVCodecContext, log_level_offset),
98     .child_next              = codec_child_next,
99 #if FF_API_CHILD_CLASS_NEXT
100     .child_class_next        = codec_child_class_next,
101 #endif
102     .child_class_iterate     = codec_child_class_iterate,
103     .category                = AV_CLASS_CATEGORY_ENCODER,
104     .get_category            = get_category,
105 };
106
107 static int init_context_defaults(AVCodecContext *s, const AVCodec *codec)
108 {
109     int flags=0;
110     memset(s, 0, sizeof(AVCodecContext));
111
112     s->av_class = &av_codec_context_class;
113
114     s->codec_type = codec ? codec->type : AVMEDIA_TYPE_UNKNOWN;
115     if (codec) {
116         s->codec = codec;
117         s->codec_id = codec->id;
118     }
119
120     if(s->codec_type == AVMEDIA_TYPE_AUDIO)
121         flags= AV_OPT_FLAG_AUDIO_PARAM;
122     else if(s->codec_type == AVMEDIA_TYPE_VIDEO)
123         flags= AV_OPT_FLAG_VIDEO_PARAM;
124     else if(s->codec_type == AVMEDIA_TYPE_SUBTITLE)
125         flags= AV_OPT_FLAG_SUBTITLE_PARAM;
126     av_opt_set_defaults2(s, flags, flags);
127
128     s->time_base           = (AVRational){0,1};
129     s->framerate           = (AVRational){ 0, 1 };
130     s->pkt_timebase        = (AVRational){ 0, 1 };
131     s->get_buffer2         = avcodec_default_get_buffer2;
132     s->get_format          = avcodec_default_get_format;
133     s->get_encode_buffer   = avcodec_default_get_encode_buffer;
134     s->execute             = avcodec_default_execute;
135     s->execute2            = avcodec_default_execute2;
136     s->sample_aspect_ratio = (AVRational){0,1};
137     s->pix_fmt             = AV_PIX_FMT_NONE;
138     s->sw_pix_fmt          = AV_PIX_FMT_NONE;
139     s->sample_fmt          = AV_SAMPLE_FMT_NONE;
140
141     s->reordered_opaque    = AV_NOPTS_VALUE;
142     if(codec && codec->priv_data_size){
143         s->priv_data = av_mallocz(codec->priv_data_size);
144         if (!s->priv_data)
145             return AVERROR(ENOMEM);
146         if(codec->priv_class){
147             *(const AVClass**)s->priv_data = codec->priv_class;
148             av_opt_set_defaults(s->priv_data);
149         }
150     }
151     if (codec && codec->defaults) {
152         int ret;
153         const AVCodecDefault *d = codec->defaults;
154         while (d->key) {
155             ret = av_opt_set(s, d->key, d->value, 0);
156             av_assert0(ret >= 0);
157             d++;
158         }
159     }
160     return 0;
161 }
162
163 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec)
164 {
165     AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
166
167     if (!avctx)
168         return NULL;
169
170     if (init_context_defaults(avctx, codec) < 0) {
171         av_free(avctx);
172         return NULL;
173     }
174
175     return avctx;
176 }
177
178 void avcodec_free_context(AVCodecContext **pavctx)
179 {
180     AVCodecContext *avctx = *pavctx;
181
182     if (!avctx)
183         return;
184
185     avcodec_close(avctx);
186
187     av_freep(&avctx->extradata);
188     av_freep(&avctx->subtitle_header);
189     av_freep(&avctx->intra_matrix);
190     av_freep(&avctx->inter_matrix);
191     av_freep(&avctx->rc_override);
192
193     av_freep(pavctx);
194 }
195
196 const AVClass *avcodec_get_class(void)
197 {
198     return &av_codec_context_class;
199 }
200
201 #if FF_API_GET_FRAME_CLASS
202 #define FOFFSET(x) offsetof(AVFrame,x)
203
204 static const AVOption frame_options[]={
205 {"best_effort_timestamp", "", FOFFSET(best_effort_timestamp), AV_OPT_TYPE_INT64, {.i64 = AV_NOPTS_VALUE }, INT64_MIN, INT64_MAX, 0},
206 {"pkt_pos", "", FOFFSET(pkt_pos), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
207 {"pkt_size", "", FOFFSET(pkt_size), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
208 {"sample_aspect_ratio", "", FOFFSET(sample_aspect_ratio), AV_OPT_TYPE_RATIONAL, {.dbl = 0 }, 0, INT_MAX, 0},
209 {"width", "", FOFFSET(width), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
210 {"height", "", FOFFSET(height), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
211 {"format", "", FOFFSET(format), AV_OPT_TYPE_INT, {.i64 = -1 }, 0, INT_MAX, 0},
212 {"channel_layout", "", FOFFSET(channel_layout), AV_OPT_TYPE_INT64, {.i64 = 0 }, 0, INT64_MAX, 0},
213 {"sample_rate", "", FOFFSET(sample_rate), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
214 {NULL},
215 };
216
217 static const AVClass av_frame_class = {
218     .class_name              = "AVFrame",
219     .item_name               = NULL,
220     .option                  = frame_options,
221     .version                 = LIBAVUTIL_VERSION_INT,
222 };
223
224 const AVClass *avcodec_get_frame_class(void)
225 {
226     return &av_frame_class;
227 }
228 #endif
229
230 #define SROFFSET(x) offsetof(AVSubtitleRect,x)
231
232 static const AVOption subtitle_rect_options[]={
233 {"x", "", SROFFSET(x), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
234 {"y", "", SROFFSET(y), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
235 {"w", "", SROFFSET(w), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
236 {"h", "", SROFFSET(h), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
237 {"type", "", SROFFSET(type), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
238 {"flags", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0, "flags"},
239 {"forced", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0},
240 {NULL},
241 };
242
243 static const AVClass av_subtitle_rect_class = {
244     .class_name             = "AVSubtitleRect",
245     .item_name              = NULL,
246     .option                 = subtitle_rect_options,
247     .version                = LIBAVUTIL_VERSION_INT,
248 };
249
250 const AVClass *avcodec_get_subtitle_rect_class(void)
251 {
252     return &av_subtitle_rect_class;
253 }