Add FF_OPT_TYPE_BINARY and use it to add a cryptokey option
[libav.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= lrintf(num/den)*intnum; break;
66 case FF_OPT_TYPE_INT64: *(int64_t *)dst= lrintf(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 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 val+= i;
163
164 d = ff_eval2(buf, const_values, const_names, NULL, NULL, NULL, NULL, NULL, &error);
165 if(isnan(d)) {
166 const AVOption *o_named= av_find_opt(obj, buf, o->unit, 0, 0);
167 if(o_named && o_named->type == FF_OPT_TYPE_CONST)
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;
172 else if(!strcmp(buf, "none" )) d= 0;
173 else if(!strcmp(buf, "all" )) d= ~0;
174 else {
175 if (!error)
176 av_log(NULL, AV_LOG_ERROR, "Unable to parse option value \"%s\": %s\n", val, error);
177 return NULL;
178 }
179 }
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;
183 }else if(cmd=='-')
184 d= -d;
185
186 av_set_number(obj, name, d, 1, 1);
187 if(!*val)
188 return o;
189 }
190 return NULL;
191 }
192
193 memcpy(((uint8_t*)obj) + o->offset, &val, sizeof(val));
194 return o;
195 }
196
197 const AVOption *av_set_double(void *obj, const char *name, double n){
198 return av_set_number(obj, name, n, 1, 1);
199 }
200
201 const AVOption *av_set_q(void *obj, const char *name, AVRational n){
202 return av_set_number(obj, name, n.num, n.den, 1);
203 }
204
205 const AVOption *av_set_int(void *obj, const char *name, int64_t n){
206 return av_set_number(obj, name, 1, 1, n);
207 }
208
209 /**
210 *
211 * @param buf a buffer which is used for returning non string values as strings, can be NULL
212 * @param buf_len allocated length in bytes of buf
213 */
214 const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len){
215 const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
216 void *dst;
217 uint8_t *bin;
218 int len, i;
219 if(!o || o->offset<=0)
220 return NULL;
221 if(o->type != FF_OPT_TYPE_STRING && (!buf || !buf_len))
222 return NULL;
223
224 dst= ((uint8_t*)obj) + o->offset;
225 if(o_out) *o_out= o;
226
227 switch(o->type){
228 case FF_OPT_TYPE_FLAGS: snprintf(buf, buf_len, "0x%08X",*(int *)dst);break;
229 case FF_OPT_TYPE_INT: snprintf(buf, buf_len, "%d" , *(int *)dst);break;
230 case FF_OPT_TYPE_INT64: snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
231 case FF_OPT_TYPE_FLOAT: snprintf(buf, buf_len, "%f" , *(float *)dst);break;
232 case FF_OPT_TYPE_DOUBLE: snprintf(buf, buf_len, "%f" , *(double *)dst);break;
233 case FF_OPT_TYPE_RATIONAL: snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
234 case FF_OPT_TYPE_STRING: return *(void**)dst;
235 case FF_OPT_TYPE_BINARY:
236 len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
237 if(len >= (buf_len + 1)/2) return NULL;
238 bin = *(uint8_t**)dst;
239 for(i = 0; i < len; i++) snprintf(buf + i*2, 3, "%02X", bin[i]);
240 break;
241 default: return NULL;
242 }
243 return buf;
244 }
245
246 static int av_get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum){
247 const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
248 void *dst;
249 if(!o || o->offset<=0)
250 goto error;
251
252 dst= ((uint8_t*)obj) + o->offset;
253
254 if(o_out) *o_out= o;
255
256 switch(o->type){
257 case FF_OPT_TYPE_FLAGS:
258 case FF_OPT_TYPE_INT: *intnum= *(int *)dst;return 0;
259 case FF_OPT_TYPE_INT64: *intnum= *(int64_t*)dst;return 0;
260 case FF_OPT_TYPE_FLOAT: *num= *(float *)dst;return 0;
261 case FF_OPT_TYPE_DOUBLE: *num= *(double *)dst;return 0;
262 case FF_OPT_TYPE_RATIONAL: *intnum= ((AVRational*)dst)->num;
263 *den = ((AVRational*)dst)->den;
264 return 0;
265 }
266 error:
267 *den=*intnum=0;
268 return -1;
269 }
270
271 double av_get_double(void *obj, const char *name, const AVOption **o_out){
272 int64_t intnum=1;
273 double num=1;
274 int den=1;
275
276 av_get_number(obj, name, o_out, &num, &den, &intnum);
277 return num*intnum/den;
278 }
279
280 AVRational av_get_q(void *obj, const char *name, const AVOption **o_out){
281 int64_t intnum=1;
282 double num=1;
283 int den=1;
284
285 av_get_number(obj, name, o_out, &num, &den, &intnum);
286 if(num == 1.0 && (int)intnum == intnum)
287 return (AVRational){intnum, den};
288 else
289 return av_d2q(num*intnum/den, 1<<24);
290 }
291
292 int64_t av_get_int(void *obj, const char *name, const AVOption **o_out){
293 int64_t intnum=1;
294 double num=1;
295 int den=1;
296
297 av_get_number(obj, name, o_out, &num, &den, &intnum);
298 return num*intnum/den;
299 }
300
301 static void opt_list(void *obj, void *av_log_obj, const char *unit)
302 {
303 const AVOption *opt=NULL;
304
305 while((opt= av_next_option(obj, opt))){
306 if(!(opt->flags & (AV_OPT_FLAG_ENCODING_PARAM|AV_OPT_FLAG_DECODING_PARAM)))
307 continue;
308
309 /* Don't print CONST's on level one.
310 * Don't print anything but CONST's on level two.
311 * Only print items from the requested unit.
312 */
313 if (!unit && opt->type==FF_OPT_TYPE_CONST)
314 continue;
315 else if (unit && opt->type!=FF_OPT_TYPE_CONST)
316 continue;
317 else if (unit && opt->type==FF_OPT_TYPE_CONST && strcmp(unit, opt->unit))
318 continue;
319 else if (unit && opt->type == FF_OPT_TYPE_CONST)
320 av_log(av_log_obj, AV_LOG_INFO, " %-15s ", opt->name);
321 else
322 av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
323
324 switch( opt->type )
325 {
326 case FF_OPT_TYPE_FLAGS:
327 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>" );
328 break;
329 case FF_OPT_TYPE_INT:
330 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int>" );
331 break;
332 case FF_OPT_TYPE_INT64:
333 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>" );
334 break;
335 case FF_OPT_TYPE_DOUBLE:
336 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<double>" );
337 break;
338 case FF_OPT_TYPE_FLOAT:
339 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<float>" );
340 break;
341 case FF_OPT_TYPE_STRING:
342 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<string>" );
343 break;
344 case FF_OPT_TYPE_RATIONAL:
345 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>" );
346 break;
347 case FF_OPT_TYPE_BINARY:
348 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>" );
349 break;
350 case FF_OPT_TYPE_CONST:
351 default:
352 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "" );
353 break;
354 }
355 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
356 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
357 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM ) ? 'V' : '.');
358 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM ) ? 'A' : '.');
359 av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
360
361 if(opt->help)
362 av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
363 av_log(av_log_obj, AV_LOG_INFO, "\n");
364 if (opt->unit && opt->type != FF_OPT_TYPE_CONST) {
365 opt_list(obj, av_log_obj, opt->unit);
366 }
367 }
368 }
369
370 int av_opt_show(void *obj, void *av_log_obj){
371 if(!obj)
372 return -1;
373
374 av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
375
376 opt_list(obj, av_log_obj, NULL);
377
378 return 0;
379 }
380
381 /** Set the values of the AVCodecContext or AVFormatContext structure.
382 * They are set to the defaults specified in the according AVOption options
383 * array default_val field.
384 *
385 * @param s AVCodecContext or AVFormatContext for which the defaults will be set
386 */
387 void av_opt_set_defaults2(void *s, int mask, int flags)
388 {
389 const AVOption *opt = NULL;
390 while ((opt = av_next_option(s, opt)) != NULL) {
391 if((opt->flags & mask) != flags)
392 continue;
393 switch(opt->type) {
394 case FF_OPT_TYPE_CONST:
395 /* Nothing to be done here */
396 break;
397 case FF_OPT_TYPE_FLAGS:
398 case FF_OPT_TYPE_INT: {
399 int val;
400 val = opt->default_val;
401 av_set_int(s, opt->name, val);
402 }
403 break;
404 case FF_OPT_TYPE_FLOAT: {
405 double val;
406 val = opt->default_val;
407 av_set_double(s, opt->name, val);
408 }
409 break;
410 case FF_OPT_TYPE_RATIONAL: {
411 AVRational val;
412 val = av_d2q(opt->default_val, INT_MAX);
413 av_set_q(s, opt->name, val);
414 }
415 break;
416 case FF_OPT_TYPE_STRING:
417 case FF_OPT_TYPE_BINARY:
418 /* Cannot set default for string as default_val is of type * double */
419 break;
420 default:
421 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
422 }
423 }
424 }
425
426 void av_opt_set_defaults(void *s){
427 av_opt_set_defaults2(s, 0, 0);
428 }
429