2 * Copyright (c) 2001 Fabrice Bellard
3 * Copyright (c) 2002-2004 Michael Niedermayer <michaelni@gmx.at>
5 * This file is part of FFmpeg.
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.
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.
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
24 * Options definition for AVCodecContext.
29 #include "libavutil/avassert.h"
30 #include "libavutil/opt.h"
31 #include <float.h> /* FLT_MIN, FLT_MAX */
33 #include "options_table.h"
35 static const char* context_to_name(void* ptr) {
36 AVCodecContext *avc= ptr;
38 if(avc && avc->codec && avc->codec->name)
39 return avc->codec->name;
44 static void *codec_child_next(void *obj, void *prev)
46 AVCodecContext *s = obj;
47 if (!prev && s->codec && s->codec->priv_class && s->priv_data)
52 static const AVClass *codec_child_class_next(const AVClass *prev)
56 /* find the codec that corresponds to prev */
57 while (prev && (c = av_codec_next(c)))
58 if (c->priv_class == prev)
61 /* find next codec with priv options */
62 while (c = av_codec_next(c))
68 static AVClassCategory get_category(AVCodecContext *avctx)
70 if(avctx->codec && avctx->codec->decode) return AV_CLASS_CATEGORY_DECODER;
71 else return AV_CLASS_CATEGORY_ENCODER;
74 static const AVClass av_codec_context_class = {
75 .class_name = "AVCodecContext",
76 .item_name = context_to_name,
78 .version = LIBAVUTIL_VERSION_INT,
79 .log_level_offset_offset = offsetof(AVCodecContext, log_level_offset),
80 .child_next = codec_child_next,
81 .child_class_next = codec_child_class_next,
82 .category = AV_CLASS_CATEGORY_ENCODER,
83 .get_category = (void*)get_category,
86 #if FF_API_ALLOC_CONTEXT
87 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType codec_type){
90 avcodec_get_context_defaults3(s, &c);
94 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec){
96 memset(s, 0, sizeof(AVCodecContext));
98 s->av_class = &av_codec_context_class;
100 s->codec_type = codec ? codec->type : AVMEDIA_TYPE_UNKNOWN;
101 if(s->codec_type == AVMEDIA_TYPE_AUDIO)
102 flags= AV_OPT_FLAG_AUDIO_PARAM;
103 else if(s->codec_type == AVMEDIA_TYPE_VIDEO)
104 flags= AV_OPT_FLAG_VIDEO_PARAM;
105 else if(s->codec_type == AVMEDIA_TYPE_SUBTITLE)
106 flags= AV_OPT_FLAG_SUBTITLE_PARAM;
107 av_opt_set_defaults2(s, flags, flags);
109 s->time_base = (AVRational){0,1};
110 s->get_buffer = avcodec_default_get_buffer;
111 s->release_buffer = avcodec_default_release_buffer;
112 s->get_format = avcodec_default_get_format;
113 s->execute = avcodec_default_execute;
114 s->execute2 = avcodec_default_execute2;
115 s->sample_aspect_ratio = (AVRational){0,1};
116 s->pix_fmt = PIX_FMT_NONE;
117 s->sample_fmt = AV_SAMPLE_FMT_NONE;
118 s->timecode_frame_start = -1;
120 s->reget_buffer = avcodec_default_reget_buffer;
121 s->reordered_opaque = AV_NOPTS_VALUE;
122 if(codec && codec->priv_data_size){
124 s->priv_data= av_mallocz(codec->priv_data_size);
126 return AVERROR(ENOMEM);
129 if(codec->priv_class){
130 *(const AVClass**)s->priv_data = codec->priv_class;
131 av_opt_set_defaults(s->priv_data);
134 if (codec && codec->defaults) {
136 const AVCodecDefault *d = codec->defaults;
138 ret = av_opt_set(s, d->key, d->value, 0);
139 av_assert0(ret >= 0);
146 AVCodecContext *avcodec_alloc_context3(AVCodec *codec){
147 AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
149 if(avctx==NULL) return NULL;
151 if(avcodec_get_context_defaults3(avctx, codec) < 0){
159 #if FF_API_ALLOC_CONTEXT
160 AVCodecContext *avcodec_alloc_context2(enum AVMediaType codec_type){
161 AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
163 if(avctx==NULL) return NULL;
165 avcodec_get_context_defaults2(avctx, codec_type);
170 void avcodec_get_context_defaults(AVCodecContext *s){
171 avcodec_get_context_defaults2(s, AVMEDIA_TYPE_UNKNOWN);
174 AVCodecContext *avcodec_alloc_context(void){
175 return avcodec_alloc_context2(AVMEDIA_TYPE_UNKNOWN);
179 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
181 if (avcodec_is_open(dest)) { // check that the dest context is uninitialized
182 av_log(dest, AV_LOG_ERROR,
183 "Tried to copy AVCodecContext %p into already-initialized %p\n",
185 return AVERROR(EINVAL);
187 memcpy(dest, src, sizeof(*dest));
189 /* set values specific to opened codecs back to their default state */
190 dest->priv_data = NULL;
192 dest->slice_offset = NULL;
193 dest->hwaccel = NULL;
194 dest->thread_opaque = NULL;
195 dest->internal = NULL;
197 /* reallocate values that should be allocated separately */
199 dest->extradata = NULL;
200 dest->intra_matrix = NULL;
201 dest->inter_matrix = NULL;
202 dest->rc_override = NULL;
204 dest->rc_eq = av_strdup(src->rc_eq);
206 return AVERROR(ENOMEM);
209 #define alloc_and_copy_or_fail(obj, size, pad) \
210 if (src->obj && size > 0) { \
211 dest->obj = av_malloc(size + pad); \
214 memcpy(dest->obj, src->obj, size); \
216 memset(((uint8_t *) dest->obj) + size, 0, pad); \
218 alloc_and_copy_or_fail(extradata, src->extradata_size,
219 FF_INPUT_BUFFER_PADDING_SIZE);
220 alloc_and_copy_or_fail(intra_matrix, 64 * sizeof(int16_t), 0);
221 alloc_and_copy_or_fail(inter_matrix, 64 * sizeof(int16_t), 0);
222 alloc_and_copy_or_fail(rc_override, src->rc_override_count * sizeof(*src->rc_override), 0);
223 #undef alloc_and_copy_or_fail
228 av_freep(&dest->rc_override);
229 av_freep(&dest->intra_matrix);
230 av_freep(&dest->inter_matrix);
231 av_freep(&dest->extradata);
232 av_freep(&dest->rc_eq);
233 return AVERROR(ENOMEM);
236 const AVClass *avcodec_get_class(void)
238 return &av_codec_context_class;
241 #define FOFFSET(x) offsetof(AVFrame,x)
243 static const AVOption frame_options[]={
244 {"best_effort_timestamp", "", FOFFSET(best_effort_timestamp), AV_OPT_TYPE_INT64, {.dbl = AV_NOPTS_VALUE }, INT64_MIN, INT64_MAX, 0},
245 {"pkt_pos", "", FOFFSET(pkt_pos), AV_OPT_TYPE_INT64, {.dbl = -1 }, INT64_MIN, INT64_MAX, 0},
246 {"sample_aspect_ratio", "", FOFFSET(sample_aspect_ratio), AV_OPT_TYPE_RATIONAL, {.dbl = 0 }, 0, INT_MAX, 0},
247 {"width", "", FOFFSET(width), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
248 {"height", "", FOFFSET(height), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
249 {"format", "", FOFFSET(format), AV_OPT_TYPE_INT, {.dbl = -1 }, 0, INT_MAX, 0},
250 {"channel_layout", "", FOFFSET(channel_layout), AV_OPT_TYPE_INT64, {.dbl = 0 }, 0, INT64_MAX, 0},
251 {"sample_rate", "", FOFFSET(sample_rate), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
255 static const AVClass av_frame_class = {
256 .class_name = "AVFrame",
258 .option = frame_options,
259 .version = LIBAVUTIL_VERSION_INT,
262 const AVClass *avcodec_get_frame_class(void)
264 return &av_frame_class;
267 #define SROFFSET(x) offsetof(AVSubtitleRect,x)
269 static const AVOption subtitle_rect_options[]={
270 {"x", "", SROFFSET(x), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
271 {"y", "", SROFFSET(y), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
272 {"w", "", SROFFSET(w), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
273 {"h", "", SROFFSET(h), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
274 {"type", "", SROFFSET(type), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
275 {"forced", "", SROFFSET(forced), AV_OPT_TYPE_INT, {.dbl = 0}, 0, 1, 0},
279 static const AVClass av_subtitle_rect_class = {
280 .class_name = "AVSubtitleRect",
282 .option = subtitle_rect_options,
283 .version = LIBAVUTIL_VERSION_INT,
286 const AVClass *avcodec_get_subtitle_rect_class(void)
288 return &av_subtitle_rect_class;