Statistics
| Branch: | Revision:

ffmpeg / libavcodec / opt.c @ f16dd7e6

History | View | Annotate | Download (15.1 KB)

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 int av_set_number2(void *obj, const char *name, double num, int den, int64_t intnum, const AVOption **o_out){
51
    const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
52
    void *dst;
53
    if(o_out)
54
        *o_out= o;
55
    if(!o || o->offset<=0)
56
        return AVERROR(ENOENT);
57

    
58
    if(o->max*den < num*intnum || o->min*den > num*intnum) {
59
        av_log(NULL, AV_LOG_ERROR, "Value %lf for parameter '%s' out of range\n", num, name);
60
        return AVERROR(ERANGE);
61
    }
62

    
63
    dst= ((uint8_t*)obj) + o->offset;
64

    
65
    switch(o->type){
66
    case FF_OPT_TYPE_FLAGS:
67
    case FF_OPT_TYPE_INT:   *(int       *)dst= llrint(num/den)*intnum; break;
68
    case FF_OPT_TYPE_INT64: *(int64_t   *)dst= llrint(num/den)*intnum; break;
69
    case FF_OPT_TYPE_FLOAT: *(float     *)dst= num*intnum/den;         break;
70
    case FF_OPT_TYPE_DOUBLE:*(double    *)dst= num*intnum/den;         break;
71
    case FF_OPT_TYPE_RATIONAL:
72
        if((int)num == num) *(AVRational*)dst= (AVRational){num*intnum, den};
73
        else                *(AVRational*)dst= av_d2q(num*intnum/den, 1<<24);
74
        break;
75
    default:
76
        return AVERROR(EINVAL);
77
    }
78
    return 0;
79
}
80

    
81
static const AVOption *av_set_number(void *obj, const char *name, double num, int den, int64_t intnum){
82
    const AVOption *o = NULL;
83
    if (av_set_number2(obj, name, num, den, intnum, &o) < 0)
84
        return NULL;
85
    else
86
        return o;
87
}
88

    
89
static const double const_values[]={
90
    M_PI,
91
    M_E,
92
    FF_QP2LAMBDA,
93
    0
94
};
95

    
96
static const char * const const_names[]={
97
    "PI",
98
    "E",
99
    "QP2LAMBDA",
100
    0
101
};
102

    
103
static int hexchar2int(char c) {
104
    if (c >= '0' && c <= '9') return c - '0';
105
    if (c >= 'a' && c <= 'f') return c - 'a' + 10;
106
    if (c >= 'A' && c <= 'F') return c - 'A' + 10;
107
    return -1;
108
}
109

    
110
int av_set_string3(void *obj, const char *name, const char *val, int alloc, const AVOption **o_out){
111
    int ret;
112
    const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
113
    if (o_out)
114
        *o_out = o;
115
    if(!o)
116
        return AVERROR(ENOENT);
117
    if(!val || o->offset<=0)
118
        return AVERROR(EINVAL);
119

    
120
    if(o->type == FF_OPT_TYPE_BINARY){
121
        uint8_t **dst = (uint8_t **)(((uint8_t*)obj) + o->offset);
122
        int *lendst = (int *)(dst + 1);
123
        uint8_t *bin, *ptr;
124
        int len = strlen(val);
125
        av_freep(dst);
126
        *lendst = 0;
127
        if (len & 1) return AVERROR(EINVAL);
128
        len /= 2;
129
        ptr = bin = av_malloc(len);
130
        while (*val) {
131
            int a = hexchar2int(*val++);
132
            int b = hexchar2int(*val++);
133
            if (a < 0 || b < 0) {
134
                av_free(bin);
135
                return AVERROR(EINVAL);
136
            }
137
            *ptr++ = (a << 4) | b;
138
        }
139
        *dst = bin;
140
        *lendst = len;
141
        return 0;
142
    }
143
    if(o->type != FF_OPT_TYPE_STRING){
144
        int notfirst=0;
145
        for(;;){
146
            int i;
147
            char buf[256];
148
            int cmd=0;
149
            double d;
150
            const char *error = NULL;
151

    
152
            if(*val == '+' || *val == '-')
153
                cmd= *(val++);
154

    
155
            for(i=0; i<sizeof(buf)-1 && val[i] && val[i]!='+' && val[i]!='-'; i++)
156
                buf[i]= val[i];
157
            buf[i]=0;
158

    
159
            d = ff_eval2(buf, const_values, const_names, NULL, NULL, NULL, NULL, NULL, &error);
160
            if(isnan(d)) {
161
                const AVOption *o_named= av_find_opt(obj, buf, o->unit, 0, 0);
162
                if(o_named && o_named->type == FF_OPT_TYPE_CONST)
163
                    d= o_named->default_val;
164
                else if(!strcmp(buf, "default")) d= o->default_val;
165
                else if(!strcmp(buf, "max"    )) d= o->max;
166
                else if(!strcmp(buf, "min"    )) d= o->min;
167
                else if(!strcmp(buf, "none"   )) d= 0;
168
                else if(!strcmp(buf, "all"    )) d= ~0;
169
                else {
170
                    if (error)
171
                        av_log(NULL, AV_LOG_ERROR, "Unable to parse option value \"%s\": %s\n", val, error);
172
                    return AVERROR(EINVAL);
173
                }
174
            }
175
            if(o->type == FF_OPT_TYPE_FLAGS){
176
                if     (cmd=='+') d= av_get_int(obj, name, NULL) | (int64_t)d;
177
                else if(cmd=='-') d= av_get_int(obj, name, NULL) &~(int64_t)d;
178
            }else{
179
                if     (cmd=='+') d= notfirst*av_get_double(obj, name, NULL) + d;
180
                else if(cmd=='-') d= notfirst*av_get_double(obj, name, NULL) - d;
181
            }
182

    
183
            if ((ret = av_set_number2(obj, name, d, 1, 1, o_out)) < 0)
184
                return ret;
185
            val+= i;
186
            if(!*val)
187
                return 0;
188
            notfirst=1;
189
        }
190
        return AVERROR(EINVAL);
191
    }
192

    
193
    if(alloc){
194
        av_free(*(void**)(((uint8_t*)obj) + o->offset));
195
        val= av_strdup(val);
196
    }
197

    
198
    memcpy(((uint8_t*)obj) + o->offset, &val, sizeof(val));
199
    return 0;
200
}
201

    
202
const AVOption *av_set_string2(void *obj, const char *name, const char *val, int alloc){
203
    const AVOption *o;
204
    if (av_set_string3(obj, name, val, alloc, &o) < 0)
205
        return NULL;
206
    return o;
207
}
208

    
209
const AVOption *av_set_string(void *obj, const char *name, const char *val){
210
    const AVOption *o;
211
    if (av_set_string3(obj, name, val, 0, &o) < 0)
212
        return NULL;
213
    return o;
214
}
215

    
216
const AVOption *av_set_double(void *obj, const char *name, double n){
217
    return av_set_number(obj, name, n, 1, 1);
218
}
219

    
220
const AVOption *av_set_q(void *obj, const char *name, AVRational n){
221
    return av_set_number(obj, name, n.num, n.den, 1);
222
}
223

    
224
const AVOption *av_set_int(void *obj, const char *name, int64_t n){
225
    return av_set_number(obj, name, 1, 1, n);
226
}
227

    
228
/**
229
 *
230
 * @param buf a buffer which is used for returning non string values as strings, can be NULL
231
 * @param buf_len allocated length in bytes of buf
232
 */
233
const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len){
234
    const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
235
    void *dst;
236
    uint8_t *bin;
237
    int len, i;
238
    if(!o || o->offset<=0)
239
        return NULL;
240
    if(o->type != FF_OPT_TYPE_STRING && (!buf || !buf_len))
241
        return NULL;
242

    
243
    dst= ((uint8_t*)obj) + o->offset;
244
    if(o_out) *o_out= o;
245

    
246
    switch(o->type){
247
    case FF_OPT_TYPE_FLAGS:     snprintf(buf, buf_len, "0x%08X",*(int    *)dst);break;
248
    case FF_OPT_TYPE_INT:       snprintf(buf, buf_len, "%d" , *(int    *)dst);break;
249
    case FF_OPT_TYPE_INT64:     snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
250
    case FF_OPT_TYPE_FLOAT:     snprintf(buf, buf_len, "%f" , *(float  *)dst);break;
251
    case FF_OPT_TYPE_DOUBLE:    snprintf(buf, buf_len, "%f" , *(double *)dst);break;
252
    case FF_OPT_TYPE_RATIONAL:  snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
253
    case FF_OPT_TYPE_STRING:    return *(void**)dst;
254
    case FF_OPT_TYPE_BINARY:
255
        len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
256
        if(len >= (buf_len + 1)/2) return NULL;
257
        bin = *(uint8_t**)dst;
258
        for(i = 0; i < len; i++) snprintf(buf + i*2, 3, "%02X", bin[i]);
259
        break;
260
    default: return NULL;
261
    }
262
    return buf;
263
}
264

    
265
static int av_get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum){
266
    const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
267
    void *dst;
268
    if(!o || o->offset<=0)
269
        goto error;
270

    
271
    dst= ((uint8_t*)obj) + o->offset;
272

    
273
    if(o_out) *o_out= o;
274

    
275
    switch(o->type){
276
    case FF_OPT_TYPE_FLAGS:     *intnum= *(unsigned int*)dst;return 0;
277
    case FF_OPT_TYPE_INT:       *intnum= *(int    *)dst;return 0;
278
    case FF_OPT_TYPE_INT64:     *intnum= *(int64_t*)dst;return 0;
279
    case FF_OPT_TYPE_FLOAT:     *num=    *(float  *)dst;return 0;
280
    case FF_OPT_TYPE_DOUBLE:    *num=    *(double *)dst;return 0;
281
    case FF_OPT_TYPE_RATIONAL:  *intnum= ((AVRational*)dst)->num;
282
                                *den   = ((AVRational*)dst)->den;
283
                                                        return 0;
284
    }
285
error:
286
    *den=*intnum=0;
287
    return -1;
288
}
289

    
290
double av_get_double(void *obj, const char *name, const AVOption **o_out){
291
    int64_t intnum=1;
292
    double num=1;
293
    int den=1;
294

    
295
    av_get_number(obj, name, o_out, &num, &den, &intnum);
296
    return num*intnum/den;
297
}
298

    
299
AVRational av_get_q(void *obj, const char *name, const AVOption **o_out){
300
    int64_t intnum=1;
301
    double num=1;
302
    int den=1;
303

    
304
    av_get_number(obj, name, o_out, &num, &den, &intnum);
305
    if(num == 1.0 && (int)intnum == intnum)
306
        return (AVRational){intnum, den};
307
    else
308
        return av_d2q(num*intnum/den, 1<<24);
309
}
310

    
311
int64_t av_get_int(void *obj, const char *name, const AVOption **o_out){
312
    int64_t intnum=1;
313
    double num=1;
314
    int den=1;
315

    
316
    av_get_number(obj, name, o_out, &num, &den, &intnum);
317
    return num*intnum/den;
318
}
319

    
320
static void opt_list(void *obj, void *av_log_obj, const char *unit)
321
{
322
    const AVOption *opt=NULL;
323

    
324
    while((opt= av_next_option(obj, opt))){
325
        if(!(opt->flags & (AV_OPT_FLAG_ENCODING_PARAM|AV_OPT_FLAG_DECODING_PARAM)))
326
            continue;
327

    
328
        /* Don't print CONST's on level one.
329
         * Don't print anything but CONST's on level two.
330
         * Only print items from the requested unit.
331
         */
332
        if (!unit && opt->type==FF_OPT_TYPE_CONST)
333
            continue;
334
        else if (unit && opt->type!=FF_OPT_TYPE_CONST)
335
            continue;
336
        else if (unit && opt->type==FF_OPT_TYPE_CONST && strcmp(unit, opt->unit))
337
            continue;
338
        else if (unit && opt->type == FF_OPT_TYPE_CONST)
339
            av_log(av_log_obj, AV_LOG_INFO, "   %-15s ", opt->name);
340
        else
341
            av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
342

    
343
        switch( opt->type )
344
        {
345
            case FF_OPT_TYPE_FLAGS:
346
                av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>" );
347
                break;
348
            case FF_OPT_TYPE_INT:
349
                av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int>" );
350
                break;
351
            case FF_OPT_TYPE_INT64:
352
                av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>" );
353
                break;
354
            case FF_OPT_TYPE_DOUBLE:
355
                av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<double>" );
356
                break;
357
            case FF_OPT_TYPE_FLOAT:
358
                av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<float>" );
359
                break;
360
            case FF_OPT_TYPE_STRING:
361
                av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<string>" );
362
                break;
363
            case FF_OPT_TYPE_RATIONAL:
364
                av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>" );
365
                break;
366
            case FF_OPT_TYPE_BINARY:
367
                av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>" );
368
                break;
369
            case FF_OPT_TYPE_CONST:
370
            default:
371
                av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "" );
372
                break;
373
        }
374
        av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
375
        av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
376
        av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM   ) ? 'V' : '.');
377
        av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM   ) ? 'A' : '.');
378
        av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
379

    
380
        if(opt->help)
381
            av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
382
        av_log(av_log_obj, AV_LOG_INFO, "\n");
383
        if (opt->unit && opt->type != FF_OPT_TYPE_CONST) {
384
            opt_list(obj, av_log_obj, opt->unit);
385
        }
386
    }
387
}
388

    
389
int av_opt_show(void *obj, void *av_log_obj){
390
    if(!obj)
391
        return -1;
392

    
393
    av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
394

    
395
    opt_list(obj, av_log_obj, NULL);
396

    
397
    return 0;
398
}
399

    
400
/** Set the values of the AVCodecContext or AVFormatContext structure.
401
 * They are set to the defaults specified in the according AVOption options
402
 * array default_val field.
403
 *
404
 * @param s AVCodecContext or AVFormatContext for which the defaults will be set
405
 */
406
void av_opt_set_defaults2(void *s, int mask, int flags)
407
{
408
    const AVOption *opt = NULL;
409
    while ((opt = av_next_option(s, opt)) != NULL) {
410
        if((opt->flags & mask) != flags)
411
            continue;
412
        switch(opt->type) {
413
            case FF_OPT_TYPE_CONST:
414
                /* Nothing to be done here */
415
            break;
416
            case FF_OPT_TYPE_FLAGS:
417
            case FF_OPT_TYPE_INT: {
418
                int val;
419
                val = opt->default_val;
420
                av_set_int(s, opt->name, val);
421
            }
422
            break;
423
            case FF_OPT_TYPE_INT64:
424
                if((double)(opt->default_val+0.6) == opt->default_val)
425
                    av_log(s, AV_LOG_DEBUG, "loss of precission in default of %s\n", opt->name);
426
                av_set_int(s, opt->name, opt->default_val);
427
            break;
428
            case FF_OPT_TYPE_FLOAT: {
429
                double val;
430
                val = opt->default_val;
431
                av_set_double(s, opt->name, val);
432
            }
433
            break;
434
            case FF_OPT_TYPE_RATIONAL: {
435
                AVRational val;
436
                val = av_d2q(opt->default_val, INT_MAX);
437
                av_set_q(s, opt->name, val);
438
            }
439
            break;
440
            case FF_OPT_TYPE_STRING:
441
            case FF_OPT_TYPE_BINARY:
442
                /* Cannot set default for string as default_val is of type * double */
443
            break;
444
            default:
445
                av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
446
        }
447
    }
448
}
449

    
450
void av_opt_set_defaults(void *s){
451
    av_opt_set_defaults2(s, 0, 0);
452
}
453