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