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/internal.h"
31 #include "libavutil/mem.h"
32 #include "libavutil/opt.h"
35 FF_DISABLE_DEPRECATION_WARNINGS
36 #include "options_table.h"
37 FF_ENABLE_DEPRECATION_WARNINGS
39 static const char* context_to_name(void* ptr) {
40 AVCodecContext *avc= ptr;
42 if (avc && avc->codec)
43 return avc->codec->name;
48 static void *codec_child_next(void *obj, void *prev)
50 AVCodecContext *s = obj;
51 if (!prev && s->codec && s->codec->priv_class && s->priv_data)
56 #if FF_API_CHILD_CLASS_NEXT
57 static const AVClass *codec_child_class_next(const AVClass *prev)
60 const AVCodec *c = NULL;
62 /* find the codec that corresponds to prev */
63 while (prev && (c = av_codec_iterate(&iter)))
64 if (c->priv_class == prev)
67 /* find next codec with priv options */
68 while (c = av_codec_iterate(&iter))
75 static const AVClass *codec_child_class_iterate(void **iter)
78 /* find next codec with priv options */
79 while (c = av_codec_iterate(iter))
85 static AVClassCategory get_category(void *ptr)
87 AVCodecContext* avctx = ptr;
88 if(avctx->codec && avctx->codec->decode) return AV_CLASS_CATEGORY_DECODER;
89 else return AV_CLASS_CATEGORY_ENCODER;
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,
102 .child_class_iterate = codec_child_class_iterate,
103 .category = AV_CLASS_CATEGORY_ENCODER,
104 .get_category = get_category,
107 static int init_context_defaults(AVCodecContext *s, const AVCodec *codec)
110 memset(s, 0, sizeof(AVCodecContext));
112 s->av_class = &av_codec_context_class;
114 s->codec_type = codec ? codec->type : AVMEDIA_TYPE_UNKNOWN;
117 s->codec_id = codec->id;
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);
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;
141 s->reordered_opaque = AV_NOPTS_VALUE;
142 if(codec && codec->priv_data_size){
143 s->priv_data = av_mallocz(codec->priv_data_size);
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);
151 if (codec && codec->defaults) {
153 const AVCodecDefault *d = codec->defaults;
155 ret = av_opt_set(s, d->key, d->value, 0);
156 av_assert0(ret >= 0);
163 #if FF_API_GET_CONTEXT_DEFAULTS
164 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec)
166 return init_context_defaults(s, codec);
170 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec)
172 AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
177 if (init_context_defaults(avctx, codec) < 0) {
185 void avcodec_free_context(AVCodecContext **pavctx)
187 AVCodecContext *avctx = *pavctx;
192 avcodec_close(avctx);
194 av_freep(&avctx->extradata);
195 av_freep(&avctx->subtitle_header);
196 av_freep(&avctx->intra_matrix);
197 av_freep(&avctx->inter_matrix);
198 av_freep(&avctx->rc_override);
203 #if FF_API_COPY_CONTEXT
204 static void copy_context_reset(AVCodecContext *avctx)
209 #if FF_API_CODED_FRAME
210 FF_DISABLE_DEPRECATION_WARNINGS
211 av_frame_free(&avctx->coded_frame);
212 FF_ENABLE_DEPRECATION_WARNINGS
214 av_freep(&avctx->rc_override);
215 av_freep(&avctx->intra_matrix);
216 av_freep(&avctx->inter_matrix);
217 av_freep(&avctx->extradata);
218 av_freep(&avctx->subtitle_header);
219 av_buffer_unref(&avctx->hw_frames_ctx);
220 av_buffer_unref(&avctx->hw_device_ctx);
221 for (i = 0; i < avctx->nb_coded_side_data; i++)
222 av_freep(&avctx->coded_side_data[i].data);
223 av_freep(&avctx->coded_side_data);
224 avctx->subtitle_header_size = 0;
225 avctx->nb_coded_side_data = 0;
226 avctx->extradata_size = 0;
229 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
231 const AVCodec *orig_codec = dest->codec;
232 uint8_t *orig_priv_data = dest->priv_data;
234 if (avcodec_is_open(dest)) { // check that the dest context is uninitialized
235 av_log(dest, AV_LOG_ERROR,
236 "Tried to copy AVCodecContext %p into already-initialized %p\n",
238 return AVERROR(EINVAL);
241 copy_context_reset(dest);
243 memcpy(dest, src, sizeof(*dest));
244 av_opt_copy(dest, src);
246 dest->priv_data = orig_priv_data;
247 dest->codec = orig_codec;
249 if (orig_priv_data && src->codec && src->codec->priv_class &&
250 dest->codec && dest->codec->priv_class)
251 av_opt_copy(orig_priv_data, src->priv_data);
254 /* set values specific to opened codecs back to their default state */
255 dest->slice_offset = NULL;
256 dest->hwaccel = NULL;
257 dest->internal = NULL;
258 #if FF_API_CODED_FRAME
259 FF_DISABLE_DEPRECATION_WARNINGS
260 dest->coded_frame = NULL;
261 FF_ENABLE_DEPRECATION_WARNINGS
264 /* reallocate values that should be allocated separately */
265 dest->extradata = NULL;
266 dest->coded_side_data = NULL;
267 dest->intra_matrix = NULL;
268 dest->inter_matrix = NULL;
269 dest->rc_override = NULL;
270 dest->subtitle_header = NULL;
271 dest->hw_frames_ctx = NULL;
272 dest->hw_device_ctx = NULL;
273 dest->nb_coded_side_data = 0;
275 #define alloc_and_copy_or_fail(obj, size, pad) \
276 if (src->obj && size > 0) { \
277 dest->obj = av_malloc(size + pad); \
280 memcpy(dest->obj, src->obj, size); \
282 memset(((uint8_t *) dest->obj) + size, 0, pad); \
284 alloc_and_copy_or_fail(extradata, src->extradata_size,
285 AV_INPUT_BUFFER_PADDING_SIZE);
286 dest->extradata_size = src->extradata_size;
287 alloc_and_copy_or_fail(intra_matrix, 64 * sizeof(int16_t), 0);
288 alloc_and_copy_or_fail(inter_matrix, 64 * sizeof(int16_t), 0);
289 alloc_and_copy_or_fail(rc_override, src->rc_override_count * sizeof(*src->rc_override), 0);
290 alloc_and_copy_or_fail(subtitle_header, src->subtitle_header_size, 1);
291 av_assert0(dest->subtitle_header_size == src->subtitle_header_size);
292 #undef alloc_and_copy_or_fail
294 if (src->hw_frames_ctx) {
295 dest->hw_frames_ctx = av_buffer_ref(src->hw_frames_ctx);
296 if (!dest->hw_frames_ctx)
303 copy_context_reset(dest);
304 return AVERROR(ENOMEM);
308 const AVClass *avcodec_get_class(void)
310 return &av_codec_context_class;
313 #if FF_API_GET_FRAME_CLASS
314 #define FOFFSET(x) offsetof(AVFrame,x)
316 static const AVOption frame_options[]={
317 {"best_effort_timestamp", "", FOFFSET(best_effort_timestamp), AV_OPT_TYPE_INT64, {.i64 = AV_NOPTS_VALUE }, INT64_MIN, INT64_MAX, 0},
318 {"pkt_pos", "", FOFFSET(pkt_pos), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
319 {"pkt_size", "", FOFFSET(pkt_size), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
320 {"sample_aspect_ratio", "", FOFFSET(sample_aspect_ratio), AV_OPT_TYPE_RATIONAL, {.dbl = 0 }, 0, INT_MAX, 0},
321 {"width", "", FOFFSET(width), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
322 {"height", "", FOFFSET(height), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
323 {"format", "", FOFFSET(format), AV_OPT_TYPE_INT, {.i64 = -1 }, 0, INT_MAX, 0},
324 {"channel_layout", "", FOFFSET(channel_layout), AV_OPT_TYPE_INT64, {.i64 = 0 }, 0, INT64_MAX, 0},
325 {"sample_rate", "", FOFFSET(sample_rate), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
329 static const AVClass av_frame_class = {
330 .class_name = "AVFrame",
332 .option = frame_options,
333 .version = LIBAVUTIL_VERSION_INT,
336 const AVClass *avcodec_get_frame_class(void)
338 return &av_frame_class;
342 #define SROFFSET(x) offsetof(AVSubtitleRect,x)
344 static const AVOption subtitle_rect_options[]={
345 {"x", "", SROFFSET(x), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
346 {"y", "", SROFFSET(y), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
347 {"w", "", SROFFSET(w), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
348 {"h", "", SROFFSET(h), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
349 {"type", "", SROFFSET(type), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
350 {"flags", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0, "flags"},
351 {"forced", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0},
355 static const AVClass av_subtitle_rect_class = {
356 .class_name = "AVSubtitleRect",
358 .option = subtitle_rect_options,
359 .version = LIBAVUTIL_VERSION_INT,
362 const AVClass *avcodec_get_subtitle_rect_class(void)
364 return &av_subtitle_rect_class;