indent
[libav.git] / libavcodec / opt.c
CommitLineData
860a40c8
MN
1/*
2 * AVOptions
3 * Copyright (c) 2005 Michael Niedermayer <michaelni@gmx.at>
4 *
b78e7197
DB
5 * This file is part of FFmpeg.
6 *
7 * FFmpeg is free software; you can redistribute it and/or
860a40c8
MN
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
b78e7197 10 * version 2.1 of the License, or (at your option) any later version.
860a40c8 11 *
b78e7197 12 * FFmpeg is distributed in the hope that it will be useful,
860a40c8
MN
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
b78e7197 18 * License along with FFmpeg; if not, write to the Free Software
5509bffa 19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
860a40c8 20 */
115329f1 21
860a40c8
MN
22/**
23 * @file opt.c
24 * AVOptions
25 * @author Michael Niedermayer <michaelni@gmx.at>
26 */
115329f1 27
860a40c8 28#include "avcodec.h"
6fd46414 29#include "opt.h"
4d7b4613 30#include "eval.h"
860a40c8
MN
31
32//FIXME order them and do a bin search
bc2a1c34 33const AVOption *av_find_opt(void *v, const char *name, const char *unit, int mask, int flags){
860a40c8 34 AVClass *c= *(AVClass**)v; //FIXME silly way of storing AVClass
f8a32f45 35 const AVOption *o= c->option;
115329f1 36
860a40c8 37 for(;o && o->name; o++){
a4072c45 38 if(!strcmp(o->name, name) && (!unit || (o->unit && !strcmp(o->unit, unit))) && (o->flags & mask) == flags )
860a40c8
MN
39 return o;
40 }
41 return NULL;
42}
43
f8a32f45 44const AVOption *av_next_option(void *obj, const AVOption *last){
3735e82f
MN
45 if(last && last[1].name) return ++last;
46 else if(last) return NULL;
47 else return (*(AVClass**)obj)->option;
48}
49
f8a32f45 50static const AVOption *av_set_number(void *obj, const char *name, double num, int den, int64_t intnum){
bc2a1c34 51 const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
860a40c8 52 void *dst;
115329f1 53 if(!o || o->offset<=0)
8bbf6db9 54 return NULL;
115329f1 55
fcc9b956
PI
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);
8bbf6db9 58 return NULL;
fcc9b956 59 }
115329f1 60
860a40c8
MN
61 dst= ((uint8_t*)obj) + o->offset;
62
63 switch(o->type){
115329f1 64 case FF_OPT_TYPE_FLAGS:
378774e9
MN
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;
8bbf6db9
MN
67 case FF_OPT_TYPE_FLOAT: *(float *)dst= num*intnum/den; break;
68 case FF_OPT_TYPE_DOUBLE:*(double *)dst= num*intnum/den; break;
860a40c8 69 case FF_OPT_TYPE_RATIONAL:
8bbf6db9
MN
70 if((int)num == num) *(AVRational*)dst= (AVRational){num*intnum, den};
71 else *(AVRational*)dst= av_d2q(num*intnum/den, 1<<24);
603972fc 72 break;
860a40c8 73 default:
8bbf6db9 74 return NULL;
860a40c8 75 }
8bbf6db9 76 return o;
860a40c8
MN
77}
78
f8a32f45 79static const AVOption *set_all_opt(void *v, const char *unit, double d){
637b5326 80 AVClass *c= *(AVClass**)v; //FIXME silly way of storing AVClass
f8a32f45
LB
81 const AVOption *o= c->option;
82 const AVOption *ret=NULL;
115329f1 83
637b5326
MN
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
cf2baeb3 97static const double const_values[]={
95c99430
PI
98 M_PI,
99 M_E,
100 FF_QP2LAMBDA,
101 0
102};
103
cf2baeb3 104static const char * const const_names[]={
95c99430
PI
105 "PI",
106 "E",
107 "QP2LAMBDA",
108 0
109};
110
841f39a7
RD
111static 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
f8a32f45 118const AVOption *av_set_string(void *obj, const char *name, const char *val){
bc2a1c34 119 const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
637b5326
MN
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 }
115329f1 123 if(!o || !val || o->offset<=0)
8bbf6db9 124 return NULL;
841f39a7
RD
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 }
860a40c8 148 if(o->type != FF_OPT_TYPE_STRING){
9d2e6e84 149 int notfirst=0;
860a40c8
MN
150 for(;;){
151 int i;
95c99430 152 char buf[256];
233f6f88
MN
153 int cmd=0;
154 double d;
408ed51c 155 const char *error = NULL;
860a40c8 156
233f6f88
MN
157 if(*val == '+' || *val == '-')
158 cmd= *(val++);
115329f1 159
233f6f88 160 for(i=0; i<sizeof(buf)-1 && val[i] && val[i]!='+' && val[i]!='-'; i++)
860a40c8
MN
161 buf[i]= val[i];
162 buf[i]=0;
115329f1 163
95c99430
PI
164 d = ff_eval2(buf, const_values, const_names, NULL, NULL, NULL, NULL, NULL, &error);
165 if(isnan(d)) {
bc2a1c34 166 const AVOption *o_named= av_find_opt(obj, buf, o->unit, 0, 0);
115329f1 167 if(o_named && o_named->type == FF_OPT_TYPE_CONST)
233f6f88
MN
168 d= o_named->default_val;
169 else if(!strcmp(buf, "default")) d= o->default_val;
170 else if(!strcmp(buf, "max" )) d= o->max;
171 else if(!strcmp(buf, "min" )) d= o->min;
226d6947
LW
172 else if(!strcmp(buf, "none" )) d= 0;
173 else if(!strcmp(buf, "all" )) d= ~0;
95c99430 174 else {
0be2f1e3 175 if (error)
95c99430
PI
176 av_log(NULL, AV_LOG_ERROR, "Unable to parse option value \"%s\": %s\n", val, error);
177 return NULL;
178 }
860a40c8 179 }
233f6f88
MN
180 if(o->type == FF_OPT_TYPE_FLAGS){
181 if (cmd=='+') d= av_get_int(obj, name, NULL) | (int64_t)d;
182 else if(cmd=='-') d= av_get_int(obj, name, NULL) &~(int64_t)d;
4a13a2d4 183 }else{
9d2e6e84
MN
184 if (cmd=='+') d= notfirst*av_get_double(obj, name, NULL) + d;
185 else if(cmd=='-') d= notfirst*av_get_double(obj, name, NULL) - d;
4a13a2d4 186 }
860a40c8 187
5cec11b6
SS
188 if (!av_set_number(obj, name, d, 1, 1))
189 return NULL;
9203741a 190 val+= i;
860a40c8 191 if(!*val)
233f6f88 192 return o;
9d2e6e84 193 notfirst=1;
860a40c8 194 }
8bbf6db9 195 return NULL;
860a40c8 196 }
115329f1 197
24cdc39e 198 memcpy(((uint8_t*)obj) + o->offset, &val, sizeof(val));
8bbf6db9 199 return o;
860a40c8
MN
200}
201
f8a32f45 202const AVOption *av_set_double(void *obj, const char *name, double n){
860a40c8
MN
203 return av_set_number(obj, name, n, 1, 1);
204}
205
f8a32f45 206const AVOption *av_set_q(void *obj, const char *name, AVRational n){
860a40c8
MN
207 return av_set_number(obj, name, n.num, n.den, 1);
208}
209
f8a32f45 210const AVOption *av_set_int(void *obj, const char *name, int64_t n){
860a40c8
MN
211 return av_set_number(obj, name, 1, 1, n);
212}
213
8bbf6db9 214/**
115329f1 215 *
8bbf6db9
MN
216 * @param buf a buffer which is used for returning non string values as strings, can be NULL
217 * @param buf_len allocated length in bytes of buf
218 */
f8a32f45 219const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len){
bc2a1c34 220 const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
8bbf6db9 221 void *dst;
841f39a7
RD
222 uint8_t *bin;
223 int len, i;
860a40c8
MN
224 if(!o || o->offset<=0)
225 return NULL;
8bbf6db9 226 if(o->type != FF_OPT_TYPE_STRING && (!buf || !buf_len))
860a40c8
MN
227 return NULL;
228
8bbf6db9
MN
229 dst= ((uint8_t*)obj) + o->offset;
230 if(o_out) *o_out= o;
115329f1 231
8bbf6db9 232 switch(o->type){
233f6f88 233 case FF_OPT_TYPE_FLAGS: snprintf(buf, buf_len, "0x%08X",*(int *)dst);break;
8bbf6db9 234 case FF_OPT_TYPE_INT: snprintf(buf, buf_len, "%d" , *(int *)dst);break;
4733abcb 235 case FF_OPT_TYPE_INT64: snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
8bbf6db9
MN
236 case FF_OPT_TYPE_FLOAT: snprintf(buf, buf_len, "%f" , *(float *)dst);break;
237 case FF_OPT_TYPE_DOUBLE: snprintf(buf, buf_len, "%f" , *(double *)dst);break;
238 case FF_OPT_TYPE_RATIONAL: snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
b81f2b3d 239 case FF_OPT_TYPE_STRING: return *(void**)dst;
841f39a7
RD
240 case FF_OPT_TYPE_BINARY:
241 len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
242 if(len >= (buf_len + 1)/2) return NULL;
243 bin = *(uint8_t**)dst;
244 for(i = 0; i < len; i++) snprintf(buf + i*2, 3, "%02X", bin[i]);
245 break;
8bbf6db9
MN
246 default: return NULL;
247 }
248 return buf;
860a40c8
MN
249}
250
f8a32f45 251static int av_get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum){
bc2a1c34 252 const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
860a40c8
MN
253 void *dst;
254 if(!o || o->offset<=0)
8bbf6db9 255 goto error;
860a40c8
MN
256
257 dst= ((uint8_t*)obj) + o->offset;
258
8bbf6db9
MN
259 if(o_out) *o_out= o;
260
860a40c8 261 switch(o->type){
378774e9 262 case FF_OPT_TYPE_FLAGS: *intnum= *(unsigned int*)dst;return 0;
8bbf6db9
MN
263 case FF_OPT_TYPE_INT: *intnum= *(int *)dst;return 0;
264 case FF_OPT_TYPE_INT64: *intnum= *(int64_t*)dst;return 0;
265 case FF_OPT_TYPE_FLOAT: *num= *(float *)dst;return 0;
266 case FF_OPT_TYPE_DOUBLE: *num= *(double *)dst;return 0;
115329f1 267 case FF_OPT_TYPE_RATIONAL: *intnum= ((AVRational*)dst)->num;
8bbf6db9
MN
268 *den = ((AVRational*)dst)->den;
269 return 0;
860a40c8 270 }
8bbf6db9
MN
271error:
272 *den=*intnum=0;
273 return -1;
274}
275
f8a32f45 276double av_get_double(void *obj, const char *name, const AVOption **o_out){
8bbf6db9
MN
277 int64_t intnum=1;
278 double num=1;
279 int den=1;
280
281 av_get_number(obj, name, o_out, &num, &den, &intnum);
282 return num*intnum/den;
283}
284
f8a32f45 285AVRational av_get_q(void *obj, const char *name, const AVOption **o_out){
8bbf6db9
MN
286 int64_t intnum=1;
287 double num=1;
288 int den=1;
289
290 av_get_number(obj, name, o_out, &num, &den, &intnum);
291 if(num == 1.0 && (int)intnum == intnum)
292 return (AVRational){intnum, den};
293 else
294 return av_d2q(num*intnum/den, 1<<24);
295}
296
f8a32f45 297int64_t av_get_int(void *obj, const char *name, const AVOption **o_out){
8bbf6db9
MN
298 int64_t intnum=1;
299 double num=1;
300 int den=1;
301
302 av_get_number(obj, name, o_out, &num, &den, &intnum);
303 return num*intnum/den;
304}
305
f8a32f45 306static void opt_list(void *obj, void *av_log_obj, const char *unit)
d70ef6d7 307{
f8a32f45 308 const AVOption *opt=NULL;
115329f1 309
8bbf6db9
MN
310 while((opt= av_next_option(obj, opt))){
311 if(!(opt->flags & (AV_OPT_FLAG_ENCODING_PARAM|AV_OPT_FLAG_DECODING_PARAM)))
312 continue;
115329f1 313
d70ef6d7
PI
314 /* Don't print CONST's on level one.
315 * Don't print anything but CONST's on level two.
316 * Only print items from the requested unit.
317 */
318 if (!unit && opt->type==FF_OPT_TYPE_CONST)
319 continue;
320 else if (unit && opt->type!=FF_OPT_TYPE_CONST)
321 continue;
322 else if (unit && opt->type==FF_OPT_TYPE_CONST && strcmp(unit, opt->unit))
323 continue;
324 else if (unit && opt->type == FF_OPT_TYPE_CONST)
325 av_log(av_log_obj, AV_LOG_INFO, " %-15s ", opt->name);
326 else
327 av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
88d6903e
AC
328
329 switch( opt->type )
330 {
331 case FF_OPT_TYPE_FLAGS:
332 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>" );
333 break;
334 case FF_OPT_TYPE_INT:
335 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int>" );
336 break;
337 case FF_OPT_TYPE_INT64:
338 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>" );
339 break;
340 case FF_OPT_TYPE_DOUBLE:
341 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<double>" );
342 break;
343 case FF_OPT_TYPE_FLOAT:
344 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<float>" );
345 break;
346 case FF_OPT_TYPE_STRING:
347 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<string>" );
348 break;
349 case FF_OPT_TYPE_RATIONAL:
350 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>" );
351 break;
841f39a7
RD
352 case FF_OPT_TYPE_BINARY:
353 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>" );
354 break;
88d6903e
AC
355 case FF_OPT_TYPE_CONST:
356 default:
357 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "" );
358 break;
359 }
a1689e2f
MN
360 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
361 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
362 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM ) ? 'V' : '.');
363 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM ) ? 'A' : '.');
364 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
115329f1 365
d2752a0d
MN
366 if(opt->help)
367 av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
368 av_log(av_log_obj, AV_LOG_INFO, "\n");
d70ef6d7
PI
369 if (opt->unit && opt->type != FF_OPT_TYPE_CONST) {
370 opt_list(obj, av_log_obj, opt->unit);
371 }
8bbf6db9 372 }
d70ef6d7
PI
373}
374
375int av_opt_show(void *obj, void *av_log_obj){
376 if(!obj)
377 return -1;
378
379 av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
380
381 opt_list(obj, av_log_obj, NULL);
382
8bbf6db9 383 return 0;
860a40c8 384}
73a8ceaa 385
493f7857
PI
386/** Set the values of the AVCodecContext or AVFormatContext structure.
387 * They are set to the defaults specified in the according AVOption options
388 * array default_val field.
389 *
390 * @param s AVCodecContext or AVFormatContext for which the defaults will be set
391 */
20e708cb 392void av_opt_set_defaults2(void *s, int mask, int flags)
73a8ceaa 393{
f8a32f45 394 const AVOption *opt = NULL;
73a8ceaa 395 while ((opt = av_next_option(s, opt)) != NULL) {
20e708cb
MN
396 if((opt->flags & mask) != flags)
397 continue;
73a8ceaa
PI
398 switch(opt->type) {
399 case FF_OPT_TYPE_CONST:
400 /* Nothing to be done here */
401 break;
402 case FF_OPT_TYPE_FLAGS:
403 case FF_OPT_TYPE_INT: {
404 int val;
405 val = opt->default_val;
406 av_set_int(s, opt->name, val);
407 }
408 break;
409 case FF_OPT_TYPE_FLOAT: {
410 double val;
411 val = opt->default_val;
412 av_set_double(s, opt->name, val);
413 }
414 break;
415 case FF_OPT_TYPE_RATIONAL: {
416 AVRational val;
417 val = av_d2q(opt->default_val, INT_MAX);
418 av_set_q(s, opt->name, val);
419 }
420 break;
421 case FF_OPT_TYPE_STRING:
841f39a7 422 case FF_OPT_TYPE_BINARY:
73a8ceaa
PI
423 /* Cannot set default for string as default_val is of type * double */
424 break;
425 default:
426 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
427 }
428 }
429}
430
20e708cb
MN
431void av_opt_set_defaults(void *s){
432 av_opt_set_defaults2(s, 0, 0);
433}
434