Prevent AAC frame size overflows.
[ffmpeg.git] / libavcodec / opt.c
1 /*
2  * AVOptions
3  * Copyright (c) 2005 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 libavcodec/opt.c
24  * AVOptions
25  * @author Michael Niedermayer <michaelni@gmx.at>
26  */
27
28 #include "avcodec.h"
29 #include "opt.h"
30 #include "eval.h"
31
32 //FIXME order them and do a bin search
33 const AVOption *av_find_opt(void *v, const char *name, const char *unit, int mask, int flags){
34     AVClass *c= *(AVClass**)v; //FIXME silly way of storing AVClass
35     const AVOption *o= c->option;
36
37     for(;o && o->name; o++){
38         if(!strcmp(o->name, name) && (!unit || (o->unit && !strcmp(o->unit, unit))) && (o->flags & mask) == flags )
39             return o;
40     }
41     return NULL;
42 }
43
44 const AVOption *av_next_option(void *obj, const AVOption *last){
45     if(last && last[1].name) return ++last;
46     else if(last)            return NULL;
47     else                     return (*(AVClass**)obj)->option;
48 }
49
50 static int av_set_number2(void *obj, const char *name, double num, int den, int64_t intnum, const AVOption **o_out){
51     const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
52     void *dst;
53     if(o_out)
54         *o_out= o;
55     if(!o || o->offset<=0)
56         return AVERROR(ENOENT);
57
58     if(o->max*den < num*intnum || o->min*den > num*intnum) {
59         av_log(obj, AV_LOG_ERROR, "Value %lf for parameter '%s' out of range\n", num, name);
60         return AVERROR(ERANGE);
61     }
62
63     dst= ((uint8_t*)obj) + o->offset;
64
65     switch(o->type){
66     case FF_OPT_TYPE_FLAGS:
67     case FF_OPT_TYPE_INT:   *(int       *)dst= llrint(num/den)*intnum; break;
68     case FF_OPT_TYPE_INT64: *(int64_t   *)dst= llrint(num/den)*intnum; break;
69     case FF_OPT_TYPE_FLOAT: *(float     *)dst= num*intnum/den;         break;
70     case FF_OPT_TYPE_DOUBLE:*(double    *)dst= num*intnum/den;         break;
71     case FF_OPT_TYPE_RATIONAL:
72         if((int)num == num) *(AVRational*)dst= (AVRational){num*intnum, den};
73         else                *(AVRational*)dst= av_d2q(num*intnum/den, 1<<24);
74         break;
75     default:
76         return AVERROR(EINVAL);
77     }
78     return 0;
79 }
80
81 static const AVOption *av_set_number(void *obj, const char *name, double num, int den, int64_t intnum){
82     const AVOption *o = NULL;
83     if (av_set_number2(obj, name, num, den, intnum, &o) < 0)
84         return NULL;
85     else
86         return o;
87 }
88
89 static const double const_values[]={
90     M_PI,
91     M_E,
92     FF_QP2LAMBDA,
93     0
94 };
95
96 static const char * const const_names[]={
97     "PI",
98     "E",
99     "QP2LAMBDA",
100     0
101 };
102
103 static int hexchar2int(char c) {
104     if (c >= '0' && c <= '9') return c - '0';
105     if (c >= 'a' && c <= 'f') return c - 'a' + 10;
106     if (c >= 'A' && c <= 'F') return c - 'A' + 10;
107     return -1;
108 }
109
110 int av_set_string3(void *obj, const char *name, const char *val, int alloc, const AVOption **o_out){
111     int ret;
112     const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
113     if (o_out)
114         *o_out = o;
115     if(!o) {
116         av_log(obj, AV_LOG_ERROR, "Unknown option '%s'\n", name);
117         return AVERROR(ENOENT);
118     }
119     if(!val || o->offset<=0)
120         return AVERROR(EINVAL);
121
122     if(o->type == FF_OPT_TYPE_BINARY){
123         uint8_t **dst = (uint8_t **)(((uint8_t*)obj) + o->offset);
124         int *lendst = (int *)(dst + 1);
125         uint8_t *bin, *ptr;
126         int len = strlen(val);
127         av_freep(dst);
128         *lendst = 0;
129         if (len & 1) return AVERROR(EINVAL);
130         len /= 2;
131         ptr = bin = av_malloc(len);
132         while (*val) {
133             int a = hexchar2int(*val++);
134             int b = hexchar2int(*val++);
135             if (a < 0 || b < 0) {
136                 av_free(bin);
137                 return AVERROR(EINVAL);
138             }
139             *ptr++ = (a << 4) | b;
140         }
141         *dst = bin;
142         *lendst = len;
143         return 0;
144     }
145     if(o->type != FF_OPT_TYPE_STRING){
146         int notfirst=0;
147         for(;;){
148             int i;
149             char buf[256];
150             int cmd=0;
151             double d;
152             const char *error = NULL;
153
154             if(*val == '+' || *val == '-')
155                 cmd= *(val++);
156
157             for(i=0; i<sizeof(buf)-1 && val[i] && val[i]!='+' && val[i]!='-'; i++)
158                 buf[i]= val[i];
159             buf[i]=0;
160
161             d = ff_eval2(buf, const_values, const_names, NULL, NULL, NULL, NULL, NULL, &error);
162             if(isnan(d)) {
163                 const AVOption *o_named= av_find_opt(obj, buf, o->unit, 0, 0);
164                 if(o_named && o_named->type == FF_OPT_TYPE_CONST)
165                     d= o_named->default_val;
166                 else if(!strcmp(buf, "default")) d= o->default_val;
167                 else if(!strcmp(buf, "max"    )) d= o->max;
168                 else if(!strcmp(buf, "min"    )) d= o->min;
169                 else if(!strcmp(buf, "none"   )) d= 0;
170                 else if(!strcmp(buf, "all"    )) d= ~0;
171                 else {
172                     if (error)
173                         av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\": %s\n", val, error);
174                     return AVERROR(EINVAL);
175                 }
176             }
177             if(o->type == FF_OPT_TYPE_FLAGS){
178                 if     (cmd=='+') d= av_get_int(obj, name, NULL) | (int64_t)d;
179                 else if(cmd=='-') d= av_get_int(obj, name, NULL) &~(int64_t)d;
180             }else{
181                 if     (cmd=='+') d= notfirst*av_get_double(obj, name, NULL) + d;
182                 else if(cmd=='-') d= notfirst*av_get_double(obj, name, NULL) - d;
183             }
184
185             if ((ret = av_set_number2(obj, name, d, 1, 1, o_out)) < 0)
186                 return ret;
187             val+= i;
188             if(!*val)
189                 return 0;
190             notfirst=1;
191         }
192         return AVERROR(EINVAL);
193     }
194
195     if(alloc){
196         av_free(*(void**)(((uint8_t*)obj) + o->offset));
197         val= av_strdup(val);
198     }
199
200     memcpy(((uint8_t*)obj) + o->offset, &val, sizeof(val));
201     return 0;
202 }
203
204 #if LIBAVCODEC_VERSION_MAJOR < 53
205 const AVOption *av_set_string2(void *obj, const char *name, const char *val, int alloc){
206     const AVOption *o;
207     if (av_set_string3(obj, name, val, alloc, &o) < 0)
208         return NULL;
209     return o;
210 }
211
212 const AVOption *av_set_string(void *obj, const char *name, const char *val){
213     const AVOption *o;
214     if (av_set_string3(obj, name, val, 0, &o) < 0)
215         return NULL;
216     return o;
217 }
218 #endif
219
220 const AVOption *av_set_double(void *obj, const char *name, double n){
221     return av_set_number(obj, name, n, 1, 1);
222 }
223
224 const AVOption *av_set_q(void *obj, const char *name, AVRational n){
225     return av_set_number(obj, name, n.num, n.den, 1);
226 }
227
228 const AVOption *av_set_int(void *obj, const char *name, int64_t n){
229     return av_set_number(obj, name, 1, 1, n);
230 }
231
232 /**
233  *
234  * @param buf a buffer which is used for returning non string values as strings, can be NULL
235  * @param buf_len allocated length in bytes of buf
236  */
237 const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len){
238     const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
239     void *dst;
240     uint8_t *bin;
241     int len, i;
242     if(!o || o->offset<=0)
243         return NULL;
244     if(o->type != FF_OPT_TYPE_STRING && (!buf || !buf_len))
245         return NULL;
246
247     dst= ((uint8_t*)obj) + o->offset;
248     if(o_out) *o_out= o;
249
250     switch(o->type){
251     case FF_OPT_TYPE_FLAGS:     snprintf(buf, buf_len, "0x%08X",*(int    *)dst);break;
252     case FF_OPT_TYPE_INT:       snprintf(buf, buf_len, "%d" , *(int    *)dst);break;
253     case FF_OPT_TYPE_INT64:     snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
254     case FF_OPT_TYPE_FLOAT:     snprintf(buf, buf_len, "%f" , *(float  *)dst);break;
255     case FF_OPT_TYPE_DOUBLE:    snprintf(buf, buf_len, "%f" , *(double *)dst);break;
256     case FF_OPT_TYPE_RATIONAL:  snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
257     case FF_OPT_TYPE_STRING:    return *(void**)dst;
258     case FF_OPT_TYPE_BINARY:
259         len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
260         if(len >= (buf_len + 1)/2) return NULL;
261         bin = *(uint8_t**)dst;
262         for(i = 0; i < len; i++) snprintf(buf + i*2, 3, "%02X", bin[i]);
263         break;
264     default: return NULL;
265     }
266     return buf;
267 }
268
269 static int av_get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum){
270     const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
271     void *dst;
272     if(!o || o->offset<=0)
273         goto error;
274
275     dst= ((uint8_t*)obj) + o->offset;
276
277     if(o_out) *o_out= o;
278
279     switch(o->type){
280     case FF_OPT_TYPE_FLAGS:     *intnum= *(unsigned int*)dst;return 0;
281     case FF_OPT_TYPE_INT:       *intnum= *(int    *)dst;return 0;
282     case FF_OPT_TYPE_INT64:     *intnum= *(int64_t*)dst;return 0;
283     case FF_OPT_TYPE_FLOAT:     *num=    *(float  *)dst;return 0;
284     case FF_OPT_TYPE_DOUBLE:    *num=    *(double *)dst;return 0;
285     case FF_OPT_TYPE_RATIONAL:  *intnum= ((AVRational*)dst)->num;
286                                 *den   = ((AVRational*)dst)->den;
287                                                         return 0;
288     }
289 error:
290     *den=*intnum=0;
291     return -1;
292 }
293
294 double av_get_double(void *obj, const char *name, const AVOption **o_out){
295     int64_t intnum=1;
296     double num=1;
297     int den=1;
298
299     av_get_number(obj, name, o_out, &num, &den, &intnum);
300     return num*intnum/den;
301 }
302
303 AVRational av_get_q(void *obj, const char *name, const AVOption **o_out){
304     int64_t intnum=1;
305     double num=1;
306     int den=1;
307
308     av_get_number(obj, name, o_out, &num, &den, &intnum);
309     if(num == 1.0 && (int)intnum == intnum)
310         return (AVRational){intnum, den};
311     else
312         return av_d2q(num*intnum/den, 1<<24);
313 }
314
315 int64_t av_get_int(void *obj, const char *name, const AVOption **o_out){
316     int64_t intnum=1;
317     double num=1;
318     int den=1;
319
320     av_get_number(obj, name, o_out, &num, &den, &intnum);
321     return num*intnum/den;
322 }
323
324 static void opt_list(void *obj, void *av_log_obj, const char *unit)
325 {
326     const AVOption *opt=NULL;
327
328     while((opt= av_next_option(obj, opt))){
329         if(!(opt->flags & (AV_OPT_FLAG_ENCODING_PARAM|AV_OPT_FLAG_DECODING_PARAM)))
330             continue;
331
332         /* Don't print CONST's on level one.
333          * Don't print anything but CONST's on level two.
334          * Only print items from the requested unit.
335          */
336         if (!unit && opt->type==FF_OPT_TYPE_CONST)
337             continue;
338         else if (unit && opt->type!=FF_OPT_TYPE_CONST)
339             continue;
340         else if (unit && opt->type==FF_OPT_TYPE_CONST && strcmp(unit, opt->unit))
341             continue;
342         else if (unit && opt->type == FF_OPT_TYPE_CONST)
343             av_log(av_log_obj, AV_LOG_INFO, "   %-15s ", opt->name);
344         else
345             av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
346
347         switch( opt->type )
348         {
349             case FF_OPT_TYPE_FLAGS:
350                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>" );
351                 break;
352             case FF_OPT_TYPE_INT:
353                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int>" );
354                 break;
355             case FF_OPT_TYPE_INT64:
356                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>" );
357                 break;
358             case FF_OPT_TYPE_DOUBLE:
359                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<double>" );
360                 break;
361             case FF_OPT_TYPE_FLOAT:
362                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<float>" );
363                 break;
364             case FF_OPT_TYPE_STRING:
365                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<string>" );
366                 break;
367             case FF_OPT_TYPE_RATIONAL:
368                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>" );
369                 break;
370             case FF_OPT_TYPE_BINARY:
371                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>" );
372                 break;
373             case FF_OPT_TYPE_CONST:
374             default:
375                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "" );
376                 break;
377         }
378         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
379         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
380         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM   ) ? 'V' : '.');
381         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM   ) ? 'A' : '.');
382         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
383
384         if(opt->help)
385             av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
386         av_log(av_log_obj, AV_LOG_INFO, "\n");
387         if (opt->unit && opt->type != FF_OPT_TYPE_CONST) {
388             opt_list(obj, av_log_obj, opt->unit);
389         }
390     }
391 }
392
393 int av_opt_show(void *obj, void *av_log_obj){
394     if(!obj)
395         return -1;
396
397     av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
398
399     opt_list(obj, av_log_obj, NULL);
400
401     return 0;
402 }
403
404 /** Set the values of the AVCodecContext or AVFormatContext structure.
405  * They are set to the defaults specified in the according AVOption options
406  * array default_val field.
407  *
408  * @param s AVCodecContext or AVFormatContext for which the defaults will be set
409  */
410 void av_opt_set_defaults2(void *s, int mask, int flags)
411 {
412     const AVOption *opt = NULL;
413     while ((opt = av_next_option(s, opt)) != NULL) {
414         if((opt->flags & mask) != flags)
415             continue;
416         switch(opt->type) {
417             case FF_OPT_TYPE_CONST:
418                 /* Nothing to be done here */
419             break;
420             case FF_OPT_TYPE_FLAGS:
421             case FF_OPT_TYPE_INT: {
422                 int val;
423                 val = opt->default_val;
424                 av_set_int(s, opt->name, val);
425             }
426             break;
427             case FF_OPT_TYPE_INT64:
428                 if((double)(opt->default_val+0.6) == opt->default_val)
429                     av_log(s, AV_LOG_DEBUG, "loss of precission in default of %s\n", opt->name);
430                 av_set_int(s, opt->name, opt->default_val);
431             break;
432             case FF_OPT_TYPE_FLOAT: {
433                 double val;
434                 val = opt->default_val;
435                 av_set_double(s, opt->name, val);
436             }
437             break;
438             case FF_OPT_TYPE_RATIONAL: {
439                 AVRational val;
440                 val = av_d2q(opt->default_val, INT_MAX);
441                 av_set_q(s, opt->name, val);
442             }
443             break;
444             case FF_OPT_TYPE_STRING:
445             case FF_OPT_TYPE_BINARY:
446                 /* Cannot set default for string as default_val is of type * double */
447             break;
448             default:
449                 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
450         }
451     }
452 }
453
454 void av_opt_set_defaults(void *s){
455     av_opt_set_defaults2(s, 0, 0);
456 }
457