Fix FF_OPT_TYPE_INT64 support of defaults.
[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
8dbee653 118const AVOption *av_set_string2(void *obj, const char *name, const char *val, int alloc){
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
8dbee653 198 if(alloc){
f9690589 199 av_free(*(void**)(((uint8_t*)obj) + o->offset));
8dbee653
MN
200 val= av_strdup(val);
201 }
202
24cdc39e 203 memcpy(((uint8_t*)obj) + o->offset, &val, sizeof(val));
8bbf6db9 204 return o;
860a40c8
MN
205}
206
8dbee653
MN
207const AVOption *av_set_string(void *obj, const char *name, const char *val){
208 return av_set_string2(obj, name, val, 0);
209}
210
f8a32f45 211const AVOption *av_set_double(void *obj, const char *name, double n){
860a40c8
MN
212 return av_set_number(obj, name, n, 1, 1);
213}
214
f8a32f45 215const AVOption *av_set_q(void *obj, const char *name, AVRational n){
860a40c8
MN
216 return av_set_number(obj, name, n.num, n.den, 1);
217}
218
f8a32f45 219const AVOption *av_set_int(void *obj, const char *name, int64_t n){
860a40c8
MN
220 return av_set_number(obj, name, 1, 1, n);
221}
222
8bbf6db9 223/**
115329f1 224 *
8bbf6db9
MN
225 * @param buf a buffer which is used for returning non string values as strings, can be NULL
226 * @param buf_len allocated length in bytes of buf
227 */
f8a32f45 228const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len){
bc2a1c34 229 const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
8bbf6db9 230 void *dst;
841f39a7
RD
231 uint8_t *bin;
232 int len, i;
860a40c8
MN
233 if(!o || o->offset<=0)
234 return NULL;
8bbf6db9 235 if(o->type != FF_OPT_TYPE_STRING && (!buf || !buf_len))
860a40c8
MN
236 return NULL;
237
8bbf6db9
MN
238 dst= ((uint8_t*)obj) + o->offset;
239 if(o_out) *o_out= o;
115329f1 240
8bbf6db9 241 switch(o->type){
233f6f88 242 case FF_OPT_TYPE_FLAGS: snprintf(buf, buf_len, "0x%08X",*(int *)dst);break;
8bbf6db9 243 case FF_OPT_TYPE_INT: snprintf(buf, buf_len, "%d" , *(int *)dst);break;
4733abcb 244 case FF_OPT_TYPE_INT64: snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
8bbf6db9
MN
245 case FF_OPT_TYPE_FLOAT: snprintf(buf, buf_len, "%f" , *(float *)dst);break;
246 case FF_OPT_TYPE_DOUBLE: snprintf(buf, buf_len, "%f" , *(double *)dst);break;
247 case FF_OPT_TYPE_RATIONAL: snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
b81f2b3d 248 case FF_OPT_TYPE_STRING: return *(void**)dst;
841f39a7
RD
249 case FF_OPT_TYPE_BINARY:
250 len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
251 if(len >= (buf_len + 1)/2) return NULL;
252 bin = *(uint8_t**)dst;
253 for(i = 0; i < len; i++) snprintf(buf + i*2, 3, "%02X", bin[i]);
254 break;
8bbf6db9
MN
255 default: return NULL;
256 }
257 return buf;
860a40c8
MN
258}
259
f8a32f45 260static int av_get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum){
bc2a1c34 261 const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
860a40c8
MN
262 void *dst;
263 if(!o || o->offset<=0)
8bbf6db9 264 goto error;
860a40c8
MN
265
266 dst= ((uint8_t*)obj) + o->offset;
267
8bbf6db9
MN
268 if(o_out) *o_out= o;
269
860a40c8 270 switch(o->type){
378774e9 271 case FF_OPT_TYPE_FLAGS: *intnum= *(unsigned int*)dst;return 0;
8bbf6db9
MN
272 case FF_OPT_TYPE_INT: *intnum= *(int *)dst;return 0;
273 case FF_OPT_TYPE_INT64: *intnum= *(int64_t*)dst;return 0;
274 case FF_OPT_TYPE_FLOAT: *num= *(float *)dst;return 0;
275 case FF_OPT_TYPE_DOUBLE: *num= *(double *)dst;return 0;
115329f1 276 case FF_OPT_TYPE_RATIONAL: *intnum= ((AVRational*)dst)->num;
8bbf6db9
MN
277 *den = ((AVRational*)dst)->den;
278 return 0;
860a40c8 279 }
8bbf6db9
MN
280error:
281 *den=*intnum=0;
282 return -1;
283}
284
f8a32f45 285double av_get_double(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 return num*intnum/den;
292}
293
f8a32f45 294AVRational av_get_q(void *obj, const char *name, const AVOption **o_out){
8bbf6db9
MN
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 if(num == 1.0 && (int)intnum == intnum)
301 return (AVRational){intnum, den};
302 else
303 return av_d2q(num*intnum/den, 1<<24);
304}
305
f8a32f45 306int64_t av_get_int(void *obj, const char *name, const AVOption **o_out){
8bbf6db9
MN
307 int64_t intnum=1;
308 double num=1;
309 int den=1;
310
311 av_get_number(obj, name, o_out, &num, &den, &intnum);
312 return num*intnum/den;
313}
314
f8a32f45 315static void opt_list(void *obj, void *av_log_obj, const char *unit)
d70ef6d7 316{
f8a32f45 317 const AVOption *opt=NULL;
115329f1 318
8bbf6db9
MN
319 while((opt= av_next_option(obj, opt))){
320 if(!(opt->flags & (AV_OPT_FLAG_ENCODING_PARAM|AV_OPT_FLAG_DECODING_PARAM)))
321 continue;
115329f1 322
d70ef6d7
PI
323 /* Don't print CONST's on level one.
324 * Don't print anything but CONST's on level two.
325 * Only print items from the requested unit.
326 */
327 if (!unit && opt->type==FF_OPT_TYPE_CONST)
328 continue;
329 else if (unit && opt->type!=FF_OPT_TYPE_CONST)
330 continue;
331 else if (unit && opt->type==FF_OPT_TYPE_CONST && strcmp(unit, opt->unit))
332 continue;
333 else if (unit && opt->type == FF_OPT_TYPE_CONST)
334 av_log(av_log_obj, AV_LOG_INFO, " %-15s ", opt->name);
335 else
336 av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
88d6903e
AC
337
338 switch( opt->type )
339 {
340 case FF_OPT_TYPE_FLAGS:
341 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>" );
342 break;
343 case FF_OPT_TYPE_INT:
344 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int>" );
345 break;
346 case FF_OPT_TYPE_INT64:
347 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>" );
348 break;
349 case FF_OPT_TYPE_DOUBLE:
350 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<double>" );
351 break;
352 case FF_OPT_TYPE_FLOAT:
353 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<float>" );
354 break;
355 case FF_OPT_TYPE_STRING:
356 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<string>" );
357 break;
358 case FF_OPT_TYPE_RATIONAL:
359 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>" );
360 break;
841f39a7
RD
361 case FF_OPT_TYPE_BINARY:
362 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>" );
363 break;
88d6903e
AC
364 case FF_OPT_TYPE_CONST:
365 default:
366 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "" );
367 break;
368 }
a1689e2f
MN
369 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
370 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
371 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM ) ? 'V' : '.');
372 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM ) ? 'A' : '.');
373 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
115329f1 374
d2752a0d
MN
375 if(opt->help)
376 av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
377 av_log(av_log_obj, AV_LOG_INFO, "\n");
d70ef6d7
PI
378 if (opt->unit && opt->type != FF_OPT_TYPE_CONST) {
379 opt_list(obj, av_log_obj, opt->unit);
380 }
8bbf6db9 381 }
d70ef6d7
PI
382}
383
384int av_opt_show(void *obj, void *av_log_obj){
385 if(!obj)
386 return -1;
387
388 av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
389
390 opt_list(obj, av_log_obj, NULL);
391
8bbf6db9 392 return 0;
860a40c8 393}
73a8ceaa 394
493f7857
PI
395/** Set the values of the AVCodecContext or AVFormatContext structure.
396 * They are set to the defaults specified in the according AVOption options
397 * array default_val field.
398 *
399 * @param s AVCodecContext or AVFormatContext for which the defaults will be set
400 */
20e708cb 401void av_opt_set_defaults2(void *s, int mask, int flags)
73a8ceaa 402{
f8a32f45 403 const AVOption *opt = NULL;
73a8ceaa 404 while ((opt = av_next_option(s, opt)) != NULL) {
20e708cb
MN
405 if((opt->flags & mask) != flags)
406 continue;
73a8ceaa
PI
407 switch(opt->type) {
408 case FF_OPT_TYPE_CONST:
409 /* Nothing to be done here */
410 break;
411 case FF_OPT_TYPE_FLAGS:
412 case FF_OPT_TYPE_INT: {
413 int val;
414 val = opt->default_val;
415 av_set_int(s, opt->name, val);
416 }
417 break;
36d5b175
MN
418 case FF_OPT_TYPE_INT64:
419 if((double)(opt->default_val+0.6) == opt->default_val)
420 av_log(s, AV_LOG_DEBUG, "loss of precission in default of %s\n", opt->name);
421 av_set_int(s, opt->name, opt->default_val);
422 break;
73a8ceaa
PI
423 case FF_OPT_TYPE_FLOAT: {
424 double val;
425 val = opt->default_val;
426 av_set_double(s, opt->name, val);
427 }
428 break;
429 case FF_OPT_TYPE_RATIONAL: {
430 AVRational val;
431 val = av_d2q(opt->default_val, INT_MAX);
432 av_set_q(s, opt->name, val);
433 }
434 break;
435 case FF_OPT_TYPE_STRING:
841f39a7 436 case FF_OPT_TYPE_BINARY:
73a8ceaa
PI
437 /* Cannot set default for string as default_val is of type * double */
438 break;
439 default:
440 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
441 }
442 }
443}
444
20e708cb
MN
445void av_opt_set_defaults(void *s){
446 av_opt_set_defaults2(s, 0, 0);
447}
448