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
26 * @author Michael Niedermayer <michaelni@gmx.at>
33 //FIXME order them and do a bin search
34 static AVOption *find_opt(void *v, const char *name, const char *unit){
35 AVClass *c= *(AVClass**)v; //FIXME silly way of storing AVClass
36 AVOption *o= c->option;
38 for(;o && o->name; o++){
39 if(!strcmp(o->name, name) && (!unit || !strcmp(o->unit, unit)) )
45 AVOption *av_next_option(void *obj, AVOption *last){
46 if(last && last[1].name) return ++last;
47 else if(last) return NULL;
48 else return (*(AVClass**)obj)->option;
51 static AVOption *av_set_number(void *obj, const char *name, double num, int den, int64_t intnum){
52 AVOption *o= find_opt(obj, name, NULL);
54 if(!o || o->offset<=0)
57 if(o->max*den < num*intnum || o->min*den > num*intnum) {
58 av_log(NULL, AV_LOG_ERROR, "Value %lf for parameter '%s' out of range.\n", num, name);
62 dst= ((uint8_t*)obj) + o->offset;
65 case FF_OPT_TYPE_FLAGS:
66 case FF_OPT_TYPE_INT: *(int *)dst= lrintf(num/den)*intnum; break;
67 case FF_OPT_TYPE_INT64: *(int64_t *)dst= lrintf(num/den)*intnum; break;
68 case FF_OPT_TYPE_FLOAT: *(float *)dst= num*intnum/den; break;
69 case FF_OPT_TYPE_DOUBLE:*(double *)dst= num*intnum/den; break;
70 case FF_OPT_TYPE_RATIONAL:
71 if((int)num == num) *(AVRational*)dst= (AVRational){num*intnum, den};
72 else *(AVRational*)dst= av_d2q(num*intnum/den, 1<<24);
79 static AVOption *set_all_opt(void *v, const char *unit, double d){
80 AVClass *c= *(AVClass**)v; //FIXME silly way of storing AVClass
81 AVOption *o= c->option;
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 AVOption *av_set_string(void *obj, const char *name, const char *val){
112 AVOption *o= find_opt(obj, name, NULL);
113 if(o && o->offset==0 && o->type == FF_OPT_TYPE_CONST && o->unit){
114 return set_all_opt(obj, o->unit, o->default_val);
116 if(!o || !val || o->offset<=0)
118 if(o->type != FF_OPT_TYPE_STRING){
126 if(*val == '+' || *val == '-')
129 for(i=0; i<sizeof(buf)-1 && val[i] && val[i]!='+' && val[i]!='-'; i++)
134 d = ff_eval2(buf, const_values, const_names, NULL, NULL, NULL, NULL, NULL, &error);
136 AVOption *o_named= find_opt(obj, buf, o->unit);
137 if(o_named && o_named->type == FF_OPT_TYPE_CONST)
138 d= o_named->default_val;
139 else if(!strcmp(buf, "default")) d= o->default_val;
140 else if(!strcmp(buf, "max" )) d= o->max;
141 else if(!strcmp(buf, "min" )) d= o->min;
144 av_log(NULL, AV_LOG_ERROR, "Unable to parse option value \"%s\": %s\n", val, error);
148 if(o->type == FF_OPT_TYPE_FLAGS){
149 if (cmd=='+') d= av_get_int(obj, name, NULL) | (int64_t)d;
150 else if(cmd=='-') d= av_get_int(obj, name, NULL) &~(int64_t)d;
154 av_set_number(obj, name, d, 1, 1);
161 memcpy(((uint8_t*)obj) + o->offset, val, sizeof(val));
165 AVOption *av_set_double(void *obj, const char *name, double n){
166 return av_set_number(obj, name, n, 1, 1);
169 AVOption *av_set_q(void *obj, const char *name, AVRational n){
170 return av_set_number(obj, name, n.num, n.den, 1);
173 AVOption *av_set_int(void *obj, const char *name, int64_t n){
174 return av_set_number(obj, name, 1, 1, n);
179 * @param buf a buffer which is used for returning non string values as strings, can be NULL
180 * @param buf_len allocated length in bytes of buf
182 const char *av_get_string(void *obj, const char *name, AVOption **o_out, char *buf, int buf_len){
183 AVOption *o= find_opt(obj, name, NULL);
185 if(!o || o->offset<=0)
187 if(o->type != FF_OPT_TYPE_STRING && (!buf || !buf_len))
190 dst= ((uint8_t*)obj) + o->offset;
193 if(o->type == FF_OPT_TYPE_STRING)
197 case FF_OPT_TYPE_FLAGS: snprintf(buf, buf_len, "0x%08X",*(int *)dst);break;
198 case FF_OPT_TYPE_INT: snprintf(buf, buf_len, "%d" , *(int *)dst);break;
199 case FF_OPT_TYPE_INT64: snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
200 case FF_OPT_TYPE_FLOAT: snprintf(buf, buf_len, "%f" , *(float *)dst);break;
201 case FF_OPT_TYPE_DOUBLE: snprintf(buf, buf_len, "%f" , *(double *)dst);break;
202 case FF_OPT_TYPE_RATIONAL: snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
203 default: return NULL;
208 static int av_get_number(void *obj, const char *name, AVOption **o_out, double *num, int *den, int64_t *intnum){
209 AVOption *o= find_opt(obj, name, NULL);
211 if(!o || o->offset<=0)
214 dst= ((uint8_t*)obj) + o->offset;
219 case FF_OPT_TYPE_FLAGS:
220 case FF_OPT_TYPE_INT: *intnum= *(int *)dst;return 0;
221 case FF_OPT_TYPE_INT64: *intnum= *(int64_t*)dst;return 0;
222 case FF_OPT_TYPE_FLOAT: *num= *(float *)dst;return 0;
223 case FF_OPT_TYPE_DOUBLE: *num= *(double *)dst;return 0;
224 case FF_OPT_TYPE_RATIONAL: *intnum= ((AVRational*)dst)->num;
225 *den = ((AVRational*)dst)->den;
233 double av_get_double(void *obj, const char *name, AVOption **o_out){
238 av_get_number(obj, name, o_out, &num, &den, &intnum);
239 return num*intnum/den;
242 AVRational av_get_q(void *obj, const char *name, AVOption **o_out){
247 av_get_number(obj, name, o_out, &num, &den, &intnum);
248 if(num == 1.0 && (int)intnum == intnum)
249 return (AVRational){intnum, den};
251 return av_d2q(num*intnum/den, 1<<24);
254 int64_t av_get_int(void *obj, const char *name, AVOption **o_out){
259 av_get_number(obj, name, o_out, &num, &den, &intnum);
260 return num*intnum/den;
263 static void opt_list(void *obj, void *av_log_obj, char *unit)
267 while((opt= av_next_option(obj, opt))){
268 if(!(opt->flags & (AV_OPT_FLAG_ENCODING_PARAM|AV_OPT_FLAG_DECODING_PARAM)))
271 /* Don't print CONST's on level one.
272 * Don't print anything but CONST's on level two.
273 * Only print items from the requested unit.
275 if (!unit && opt->type==FF_OPT_TYPE_CONST)
277 else if (unit && opt->type!=FF_OPT_TYPE_CONST)
279 else if (unit && opt->type==FF_OPT_TYPE_CONST && strcmp(unit, opt->unit))
281 else if (unit && opt->type == FF_OPT_TYPE_CONST)
282 av_log(av_log_obj, AV_LOG_INFO, " %-15s ", opt->name);
284 av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
288 case FF_OPT_TYPE_FLAGS:
289 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>" );
291 case FF_OPT_TYPE_INT:
292 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int>" );
294 case FF_OPT_TYPE_INT64:
295 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>" );
297 case FF_OPT_TYPE_DOUBLE:
298 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<double>" );
300 case FF_OPT_TYPE_FLOAT:
301 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<float>" );
303 case FF_OPT_TYPE_STRING:
304 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<string>" );
306 case FF_OPT_TYPE_RATIONAL:
307 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>" );
309 case FF_OPT_TYPE_CONST:
311 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "" );
314 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
315 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
316 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM ) ? 'V' : '.');
317 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM ) ? 'A' : '.');
318 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
321 av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
322 av_log(av_log_obj, AV_LOG_INFO, "\n");
323 if (opt->unit && opt->type != FF_OPT_TYPE_CONST) {
324 opt_list(obj, av_log_obj, opt->unit);
329 int av_opt_show(void *obj, void *av_log_obj){
333 av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
335 opt_list(obj, av_log_obj, NULL);
340 /** Set the values of the AVCodecContext or AVFormatContext structure.
341 * They are set to the defaults specified in the according AVOption options
342 * array default_val field.
344 * @param s AVCodecContext or AVFormatContext for which the defaults will be set
346 void av_opt_set_defaults(void *s)
348 AVOption *opt = NULL;
349 while ((opt = av_next_option(s, opt)) != NULL) {
351 case FF_OPT_TYPE_CONST:
352 /* Nothing to be done here */
354 case FF_OPT_TYPE_FLAGS:
355 case FF_OPT_TYPE_INT: {
357 val = opt->default_val;
358 av_set_int(s, opt->name, val);
361 case FF_OPT_TYPE_FLOAT: {
363 val = opt->default_val;
364 av_set_double(s, opt->name, val);
367 case FF_OPT_TYPE_RATIONAL: {
369 val = av_d2q(opt->default_val, INT_MAX);
370 av_set_q(s, opt->name, val);
373 case FF_OPT_TYPE_STRING:
374 /* Cannot set default for string as default_val is of type * double */
377 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);