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