3 * Copyright (c) 2005 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
25 * @author Michael Niedermayer <michaelni@gmx.at>
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;
37 for(;o && o->name; o++){
38 if(!strcmp(o->name, name) && (!unit || (o->unit && !strcmp(o->unit, unit))) && (o->flags & mask) == flags )
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;
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);
53 if(!o || o->offset<=0)
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);
61 dst= ((uint8_t*)obj) + o->offset;
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);
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;
84 for(;o && o->name; o++){
85 if(o->type != FF_OPT_TYPE_CONST && o->unit && !strcmp(o->unit, unit)){
87 if(o->type == FF_OPT_TYPE_FLAGS)
88 tmp= av_get_int(v, o->name, NULL) | (int64_t)d;
90 av_set_number(v, o->name, tmp, 1, 1);
97 static double const_values[]={
104 static const char *const_names[]={
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;
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);
123 if(!o || !val || o->offset<=0)
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);
129 int len = strlen(val);
132 if (len & 1) return NULL;
134 ptr = bin = av_malloc(len);
136 int a = hexchar2int(*val++);
137 int b = hexchar2int(*val++);
138 if (a < 0 || b < 0) {
142 *ptr++ = (a << 4) | b;
148 if(o->type != FF_OPT_TYPE_STRING){
154 const char *error = NULL;
156 if(*val == '+' || *val == '-')
159 for(i=0; i<sizeof(buf)-1 && val[i] && val[i]!='+' && val[i]!='-'; i++)
163 d = ff_eval2(buf, const_values, const_names, NULL, NULL, NULL, NULL, NULL, &error);
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;
175 av_log(NULL, AV_LOG_ERROR, "Unable to parse option value \"%s\": %s\n", val, error);
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;
183 if (cmd=='+') d= av_get_double(obj, name, NULL) + d;
184 else if(cmd=='-') d= av_get_double(obj, name, NULL) - d;
187 if (!av_set_number(obj, name, d, 1, 1))
196 memcpy(((uint8_t*)obj) + o->offset, &val, sizeof(val));
200 const AVOption *av_set_double(void *obj, const char *name, double n){
201 return av_set_number(obj, name, n, 1, 1);
204 const AVOption *av_set_q(void *obj, const char *name, AVRational n){
205 return av_set_number(obj, name, n.num, n.den, 1);
208 const AVOption *av_set_int(void *obj, const char *name, int64_t n){
209 return av_set_number(obj, name, 1, 1, n);
214 * @param buf a buffer which is used for returning non string values as strings, can be NULL
215 * @param buf_len allocated length in bytes of buf
217 const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len){
218 const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
222 if(!o || o->offset<=0)
224 if(o->type != FF_OPT_TYPE_STRING && (!buf || !buf_len))
227 dst= ((uint8_t*)obj) + o->offset;
231 case FF_OPT_TYPE_FLAGS: snprintf(buf, buf_len, "0x%08X",*(int *)dst);break;
232 case FF_OPT_TYPE_INT: snprintf(buf, buf_len, "%d" , *(int *)dst);break;
233 case FF_OPT_TYPE_INT64: snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
234 case FF_OPT_TYPE_FLOAT: snprintf(buf, buf_len, "%f" , *(float *)dst);break;
235 case FF_OPT_TYPE_DOUBLE: snprintf(buf, buf_len, "%f" , *(double *)dst);break;
236 case FF_OPT_TYPE_RATIONAL: snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
237 case FF_OPT_TYPE_STRING: return *(void**)dst;
238 case FF_OPT_TYPE_BINARY:
239 len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
240 if(len >= (buf_len + 1)/2) return NULL;
241 bin = *(uint8_t**)dst;
242 for(i = 0; i < len; i++) snprintf(buf + i*2, 3, "%02X", bin[i]);
244 default: return NULL;
249 static int av_get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum){
250 const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
252 if(!o || o->offset<=0)
255 dst= ((uint8_t*)obj) + o->offset;
260 case FF_OPT_TYPE_FLAGS: *intnum= *(unsigned int*)dst;return 0;
261 case FF_OPT_TYPE_INT: *intnum= *(int *)dst;return 0;
262 case FF_OPT_TYPE_INT64: *intnum= *(int64_t*)dst;return 0;
263 case FF_OPT_TYPE_FLOAT: *num= *(float *)dst;return 0;
264 case FF_OPT_TYPE_DOUBLE: *num= *(double *)dst;return 0;
265 case FF_OPT_TYPE_RATIONAL: *intnum= ((AVRational*)dst)->num;
266 *den = ((AVRational*)dst)->den;
274 double av_get_double(void *obj, const char *name, const AVOption **o_out){
279 av_get_number(obj, name, o_out, &num, &den, &intnum);
280 return num*intnum/den;
283 AVRational av_get_q(void *obj, const char *name, const AVOption **o_out){
288 av_get_number(obj, name, o_out, &num, &den, &intnum);
289 if(num == 1.0 && (int)intnum == intnum)
290 return (AVRational){intnum, den};
292 return av_d2q(num*intnum/den, 1<<24);
295 int64_t av_get_int(void *obj, const char *name, const AVOption **o_out){
300 av_get_number(obj, name, o_out, &num, &den, &intnum);
301 return num*intnum/den;
304 static void opt_list(void *obj, void *av_log_obj, const char *unit)
306 const AVOption *opt=NULL;
308 while((opt= av_next_option(obj, opt))){
309 if(!(opt->flags & (AV_OPT_FLAG_ENCODING_PARAM|AV_OPT_FLAG_DECODING_PARAM)))
312 /* Don't print CONST's on level one.
313 * Don't print anything but CONST's on level two.
314 * Only print items from the requested unit.
316 if (!unit && opt->type==FF_OPT_TYPE_CONST)
318 else if (unit && opt->type!=FF_OPT_TYPE_CONST)
320 else if (unit && opt->type==FF_OPT_TYPE_CONST && strcmp(unit, opt->unit))
322 else if (unit && opt->type == FF_OPT_TYPE_CONST)
323 av_log(av_log_obj, AV_LOG_INFO, " %-15s ", opt->name);
325 av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
329 case FF_OPT_TYPE_FLAGS:
330 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>" );
332 case FF_OPT_TYPE_INT:
333 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int>" );
335 case FF_OPT_TYPE_INT64:
336 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>" );
338 case FF_OPT_TYPE_DOUBLE:
339 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<double>" );
341 case FF_OPT_TYPE_FLOAT:
342 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<float>" );
344 case FF_OPT_TYPE_STRING:
345 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<string>" );
347 case FF_OPT_TYPE_RATIONAL:
348 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>" );
350 case FF_OPT_TYPE_BINARY:
351 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>" );
353 case FF_OPT_TYPE_CONST:
355 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "" );
358 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
359 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
360 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM ) ? 'V' : '.');
361 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM ) ? 'A' : '.');
362 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
365 av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
366 av_log(av_log_obj, AV_LOG_INFO, "\n");
367 if (opt->unit && opt->type != FF_OPT_TYPE_CONST) {
368 opt_list(obj, av_log_obj, opt->unit);
373 int av_opt_show(void *obj, void *av_log_obj){
377 av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
379 opt_list(obj, av_log_obj, NULL);
384 /** Set the values of the AVCodecContext or AVFormatContext structure.
385 * They are set to the defaults specified in the according AVOption options
386 * array default_val field.
388 * @param s AVCodecContext or AVFormatContext for which the defaults will be set
390 void av_opt_set_defaults2(void *s, int mask, int flags)
392 const AVOption *opt = NULL;
393 while ((opt = av_next_option(s, opt)) != NULL) {
394 if((opt->flags & mask) != flags)
397 case FF_OPT_TYPE_CONST:
398 /* Nothing to be done here */
400 case FF_OPT_TYPE_FLAGS:
401 case FF_OPT_TYPE_INT: {
403 val = opt->default_val;
404 av_set_int(s, opt->name, val);
407 case FF_OPT_TYPE_FLOAT: {
409 val = opt->default_val;
410 av_set_double(s, opt->name, val);
413 case FF_OPT_TYPE_RATIONAL: {
415 val = av_d2q(opt->default_val, INT_MAX);
416 av_set_q(s, opt->name, val);
419 case FF_OPT_TYPE_STRING:
420 case FF_OPT_TYPE_BINARY:
421 /* Cannot set default for string as default_val is of type * double */
424 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
429 void av_opt_set_defaults(void *s){
430 av_opt_set_defaults2(s, 0, 0);