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 
context_to_name(void * ptr)39 static const char* context_to_name(void* ptr) {
40     AVCodecContext *avc= ptr;
41 
42     if(avc && avc->codec && avc->codec->name)
43         return avc->codec->name;
44     else
45         return "NULL";
46 }
47 
codec_child_next(void * obj,void * prev)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
codec_child_class_next(const AVClass * prev)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 
codec_child_class_iterate(void ** iter)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 
get_category(void * ptr)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 
init_context_defaults(AVCodecContext * s,const AVCodec * codec)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         if(!s->priv_data){
144             s->priv_data= av_mallocz(codec->priv_data_size);
145             if (!s->priv_data) {
146                 return AVERROR(ENOMEM);
147             }
148         }
149         if(codec->priv_class){
150             *(const AVClass**)s->priv_data = codec->priv_class;
151             av_opt_set_defaults(s->priv_data);
152         }
153     }
154     if (codec && codec->defaults) {
155         int ret;
156         const AVCodecDefault *d = codec->defaults;
157         while (d->key) {
158             ret = av_opt_set(s, d->key, d->value, 0);
159             av_assert0(ret >= 0);
160             d++;
161         }
162     }
163     return 0;
164 }
165 
166 #if FF_API_GET_CONTEXT_DEFAULTS
avcodec_get_context_defaults3(AVCodecContext * s,const AVCodec * codec)167 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec)
168 {
169     return init_context_defaults(s, codec);
170 }
171 #endif
172 
avcodec_alloc_context3(const AVCodec * codec)173 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec)
174 {
175     AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
176 
177     if (!avctx)
178         return NULL;
179 
180     if (init_context_defaults(avctx, codec) < 0) {
181         av_free(avctx);
182         return NULL;
183     }
184 
185     return avctx;
186 }
187 
avcodec_free_context(AVCodecContext ** pavctx)188 void avcodec_free_context(AVCodecContext **pavctx)
189 {
190     AVCodecContext *avctx = *pavctx;
191 
192     if (!avctx)
193         return;
194 
195     avcodec_close(avctx);
196 
197     av_freep(&avctx->extradata);
198     av_freep(&avctx->subtitle_header);
199     av_freep(&avctx->intra_matrix);
200     av_freep(&avctx->inter_matrix);
201     av_freep(&avctx->rc_override);
202 
203     av_freep(pavctx);
204 }
205 
206 #if FF_API_COPY_CONTEXT
copy_context_reset(AVCodecContext * avctx)207 static void copy_context_reset(AVCodecContext *avctx)
208 {
209     int i;
210 
211     av_opt_free(avctx);
212 #if FF_API_CODED_FRAME
213 FF_DISABLE_DEPRECATION_WARNINGS
214     av_frame_free(&avctx->coded_frame);
215 FF_ENABLE_DEPRECATION_WARNINGS
216 #endif
217     av_freep(&avctx->rc_override);
218     av_freep(&avctx->intra_matrix);
219     av_freep(&avctx->inter_matrix);
220     av_freep(&avctx->extradata);
221     av_freep(&avctx->subtitle_header);
222     av_buffer_unref(&avctx->hw_frames_ctx);
223     av_buffer_unref(&avctx->hw_device_ctx);
224     for (i = 0; i < avctx->nb_coded_side_data; i++)
225         av_freep(&avctx->coded_side_data[i].data);
226     av_freep(&avctx->coded_side_data);
227     avctx->subtitle_header_size = 0;
228     avctx->nb_coded_side_data = 0;
229     avctx->extradata_size = 0;
230 }
231 
avcodec_copy_context(AVCodecContext * dest,const AVCodecContext * src)232 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
233 {
234     const AVCodec *orig_codec = dest->codec;
235     uint8_t *orig_priv_data = dest->priv_data;
236 
237     if (avcodec_is_open(dest)) { // check that the dest context is uninitialized
238         av_log(dest, AV_LOG_ERROR,
239                "Tried to copy AVCodecContext %p into already-initialized %p\n",
240                src, dest);
241         return AVERROR(EINVAL);
242     }
243 
244     copy_context_reset(dest);
245 
246     memcpy(dest, src, sizeof(*dest));
247     av_opt_copy(dest, src);
248 
249     dest->priv_data       = orig_priv_data;
250     dest->codec           = orig_codec;
251 
252     if (orig_priv_data && src->codec && src->codec->priv_class &&
253         dest->codec && dest->codec->priv_class)
254         av_opt_copy(orig_priv_data, src->priv_data);
255 
256 
257     /* set values specific to opened codecs back to their default state */
258     dest->slice_offset    = NULL;
259     dest->hwaccel         = NULL;
260     dest->internal        = NULL;
261 #if FF_API_CODED_FRAME
262 FF_DISABLE_DEPRECATION_WARNINGS
263     dest->coded_frame     = NULL;
264 FF_ENABLE_DEPRECATION_WARNINGS
265 #endif
266 
267     /* reallocate values that should be allocated separately */
268     dest->extradata       = NULL;
269     dest->coded_side_data = NULL;
270     dest->intra_matrix    = NULL;
271     dest->inter_matrix    = NULL;
272     dest->rc_override     = NULL;
273     dest->subtitle_header = NULL;
274     dest->hw_frames_ctx   = NULL;
275     dest->hw_device_ctx   = NULL;
276     dest->nb_coded_side_data = 0;
277 
278 #define alloc_and_copy_or_fail(obj, size, pad) \
279     if (src->obj && size > 0) { \
280         dest->obj = av_malloc(size + pad); \
281         if (!dest->obj) \
282             goto fail; \
283         memcpy(dest->obj, src->obj, size); \
284         if (pad) \
285             memset(((uint8_t *) dest->obj) + size, 0, pad); \
286     }
287     alloc_and_copy_or_fail(extradata,    src->extradata_size,
288                            AV_INPUT_BUFFER_PADDING_SIZE);
289     dest->extradata_size  = src->extradata_size;
290     alloc_and_copy_or_fail(intra_matrix, 64 * sizeof(int16_t), 0);
291     alloc_and_copy_or_fail(inter_matrix, 64 * sizeof(int16_t), 0);
292     alloc_and_copy_or_fail(rc_override,  src->rc_override_count * sizeof(*src->rc_override), 0);
293     alloc_and_copy_or_fail(subtitle_header, src->subtitle_header_size, 1);
294     av_assert0(dest->subtitle_header_size == src->subtitle_header_size);
295 #undef alloc_and_copy_or_fail
296 
297     if (src->hw_frames_ctx) {
298         dest->hw_frames_ctx = av_buffer_ref(src->hw_frames_ctx);
299         if (!dest->hw_frames_ctx)
300             goto fail;
301     }
302 
303     return 0;
304 
305 fail:
306     copy_context_reset(dest);
307     return AVERROR(ENOMEM);
308 }
309 #endif
310 
avcodec_get_class(void)311 const AVClass *avcodec_get_class(void)
312 {
313     return &av_codec_context_class;
314 }
315 
316 #if FF_API_GET_FRAME_CLASS
317 #define FOFFSET(x) offsetof(AVFrame,x)
318 
319 static const AVOption frame_options[]={
320 {"best_effort_timestamp", "", FOFFSET(best_effort_timestamp), AV_OPT_TYPE_INT64, {.i64 = AV_NOPTS_VALUE }, INT64_MIN, INT64_MAX, 0},
321 {"pkt_pos", "", FOFFSET(pkt_pos), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
322 {"pkt_size", "", FOFFSET(pkt_size), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
323 {"sample_aspect_ratio", "", FOFFSET(sample_aspect_ratio), AV_OPT_TYPE_RATIONAL, {.dbl = 0 }, 0, INT_MAX, 0},
324 {"width", "", FOFFSET(width), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
325 {"height", "", FOFFSET(height), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
326 {"format", "", FOFFSET(format), AV_OPT_TYPE_INT, {.i64 = -1 }, 0, INT_MAX, 0},
327 {"channel_layout", "", FOFFSET(channel_layout), AV_OPT_TYPE_INT64, {.i64 = 0 }, 0, INT64_MAX, 0},
328 {"sample_rate", "", FOFFSET(sample_rate), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
329 {NULL},
330 };
331 
332 static const AVClass av_frame_class = {
333     .class_name              = "AVFrame",
334     .item_name               = NULL,
335     .option                  = frame_options,
336     .version                 = LIBAVUTIL_VERSION_INT,
337 };
338 
avcodec_get_frame_class(void)339 const AVClass *avcodec_get_frame_class(void)
340 {
341     return &av_frame_class;
342 }
343 #endif
344 
345 #define SROFFSET(x) offsetof(AVSubtitleRect,x)
346 
347 static const AVOption subtitle_rect_options[]={
348 {"x", "", SROFFSET(x), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
349 {"y", "", SROFFSET(y), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
350 {"w", "", SROFFSET(w), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
351 {"h", "", SROFFSET(h), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
352 {"type", "", SROFFSET(type), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
353 {"flags", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0, "flags"},
354 {"forced", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0},
355 {NULL},
356 };
357 
358 static const AVClass av_subtitle_rect_class = {
359     .class_name             = "AVSubtitleRect",
360     .item_name              = NULL,
361     .option                 = subtitle_rect_options,
362     .version                = LIBAVUTIL_VERSION_INT,
363 };
364 
avcodec_get_subtitle_rect_class(void)365 const AVClass *avcodec_get_subtitle_rect_class(void)
366 {
367     return &av_subtitle_rect_class;
368 }
369