git.sesse.net Git - ffmpeg/blob - 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 #include "libavutil/common.h"
  32
  33 //FIXME order them and do a bin search
  34 const AVOption *av_find_opt(void *v, const char *name, const char *unit, int mask, int flags){
  35     AVClass *c= *(AVClass**)v; //FIXME silly way of storing AVClass
  36     const AVOption *o= c->option;
  37
  38     for(;o && o->name; o++){
  39         if(!strcmp(o->name, name) && (!unit || (o->unit && !strcmp(o->unit, unit))) && (o->flags & mask) == flags )
  40             return o;
  41     }
  42     return NULL;
  43 }
  44
  45 const AVOption *av_next_option(void *obj, const AVOption *last){
  46     if(last && last[1].name) return ++last;
  47     else if(last)            return NULL;
  48     else                     return (*(AVClass**)obj)->option;
  49 }
  50
  51 static int av_set_number2(void *obj, const char *name, double num, int den, int64_t intnum, const AVOption **o_out){
  52     const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
  53     void *dst;
  54     if(o_out)
  55         *o_out= o;
  56     if(!o || o->offset<=0)
  57         return AVERROR(ENOENT);
  58
  59     if(o->max*den < num*intnum || o->min*den > num*intnum) {
  60         av_log(NULL, AV_LOG_ERROR, "Value %lf for parameter '%s' out of range\n", num, name);
  61         return AVERROR(ERANGE);
  62     }
  63
  64     dst= ((uint8_t*)obj) + o->offset;
  65
  66     switch(o->type){
  67     case FF_OPT_TYPE_FLAGS:
  68     case FF_OPT_TYPE_INT:   *(int       *)dst= llrint(num/den)*intnum; break;
  69     case FF_OPT_TYPE_INT64: *(int64_t   *)dst= llrint(num/den)*intnum; break;
  70     case FF_OPT_TYPE_FLOAT: *(float     *)dst= num*intnum/den;         break;
  71     case FF_OPT_TYPE_DOUBLE:*(double    *)dst= num*intnum/den;         break;
  72     case FF_OPT_TYPE_RATIONAL:
  73         if((int)num == num) *(AVRational*)dst= (AVRational){num*intnum, den};
  74         else                *(AVRational*)dst= av_d2q(num*intnum/den, 1<<24);
  75         break;
  76     default:
  77         return AVERROR(EINVAL);
  78     }
  79     return 0;
  80 }
  81
  82 static const AVOption *av_set_number(void *obj, const char *name, double num, int den, int64_t intnum){
  83     const AVOption *o = NULL;
  84     if (av_set_number2(obj, name, num, den, intnum, &o) < 0)
  85         return NULL;
  86     else
  87         return o;
  88 }
  89
  90 static const double const_values[]={
  91     M_PI,
  92     M_E,
  93     FF_QP2LAMBDA,
  94     0
  95 };
  96
  97 static const char * const const_names[]={
  98     "PI",
  99     "E",
 100     "QP2LAMBDA",
 101     0
 102 };
 103
 104 static int hexchar2int(char c) {
 105     if (c >= '0' && c <= '9') return c - '0';
 106     if (c >= 'a' && c <= 'f') return c - 'a' + 10;
 107     if (c >= 'A' && c <= 'F') return c - 'A' + 10;
 108     return -1;
 109 }
 110
 111 int av_set_string3(void *obj, const char *name, const char *val, int alloc, const AVOption **o_out){
 112     int ret;
 113     const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
 114     if (o_out)
 115         *o_out = o;
 116     if(!o)
 117         return AVERROR(ENOENT);
 118     if(!val || o->offset<=0)
 119         return AVERROR(EINVAL);
 120
 121     if(o->type == FF_OPT_TYPE_BINARY){
 122         uint8_t **dst = (uint8_t **)(((uint8_t*)obj) + o->offset);
 123         int *lendst = (int *)(dst + 1);
 124         uint8_t *bin, *ptr;
 125         int len = strlen(val);
 126         av_freep(dst);
 127         *lendst = 0;
 128         if (len & 1) return AVERROR(EINVAL);
 129         len /= 2;
 130         ptr = bin = av_malloc(len);
 131         while (*val) {
 132             int a = hexchar2int(*val++);
 133             int b = hexchar2int(*val++);
 134             if (a < 0 || b < 0) {
 135                 av_free(bin);
 136                 return AVERROR(EINVAL);
 137             }
 138             *ptr++ = (a << 4) | b;
 139         }
 140         *dst = bin;
 141         *lendst = len;
 142         return 0;
 143     }
 144     if(o->type != FF_OPT_TYPE_STRING){
 145         int notfirst=0;
 146         for(;;){
 147             int i;
 148             char buf[256];
 149             int cmd=0;
 150             double d;
 151             const char *error = NULL;
 152
 153             if(*val == '+' || *val == '-')
 154                 cmd= *(val++);
 155
 156             for(i=0; i<sizeof(buf)-1 && val[i] && val[i]!='+' && val[i]!='-'; i++)
 157                 buf[i]= val[i];
 158             buf[i]=0;
 159
 160             d = ff_eval2(buf, const_values, const_names, NULL, NULL, NULL, NULL, NULL, &error);
 161             if(isnan(d)) {
 162                 const AVOption *o_named= av_find_opt(obj, buf, o->unit, 0, 0);
 163                 if(o_named && o_named->type == FF_OPT_TYPE_CONST)
 164                     d= o_named->default_val;
 165                 else if(!strcmp(buf, "default")) d= o->default_val;
 166                 else if(!strcmp(buf, "max"    )) d= o->max;
 167                 else if(!strcmp(buf, "min"    )) d= o->min;
 168                 else if(!strcmp(buf, "none"   )) d= 0;
 169                 else if(!strcmp(buf, "all"    )) d= ~0;
 170                 else {
 171                     if (error)
 172                         av_log(NULL, AV_LOG_ERROR, "Unable to parse option value \"%s\": %s\n", val, error);
 173                     return AVERROR(EINVAL);
 174                 }
 175             }
 176             if(o->type == FF_OPT_TYPE_FLAGS){
 177                 if     (cmd=='+') d= av_get_int(obj, name, NULL) | (int64_t)d;
 178                 else if(cmd=='-') d= av_get_int(obj, name, NULL) &~(int64_t)d;
 179             }else{
 180                 if     (cmd=='+') d= notfirst*av_get_double(obj, name, NULL) + d;
 181                 else if(cmd=='-') d= notfirst*av_get_double(obj, name, NULL) - d;
 182             }
 183
 184             if ((ret = av_set_number2(obj, name, d, 1, 1, o_out)) < 0)
 185                 return ret;
 186             val+= i;
 187             if(!*val)
 188                 return 0;
 189             notfirst=1;
 190         }
 191         return AVERROR(EINVAL);
 192     }
 193
 194     if(alloc){
 195         av_free(*(void**)(((uint8_t*)obj) + o->offset));
 196         val= av_strdup(val);
 197     }
 198
 199     memcpy(((uint8_t*)obj) + o->offset, &val, sizeof(val));
 200     return 0;
 201 }
 202
 203 #if LIBAVCODEC_VERSION_MAJOR < 53
 204 const AVOption *av_set_string2(void *obj, const char *name, const char *val, int alloc){
 205     const AVOption *o;
 206     if (av_set_string3(obj, name, val, alloc, &o) < 0)
 207         return NULL;
 208     return o;
 209 }
 210
 211 const AVOption *av_set_string(void *obj, const char *name, const char *val){
 212     const AVOption *o;
 213     if (av_set_string3(obj, name, val, 0, &o) < 0)
 214         return NULL;
 215     return o;
 216 }
 217 #endif
 218
 219 const AVOption *av_set_double(void *obj, const char *name, double n){
 220     return av_set_number(obj, name, n, 1, 1);
 221 }
 222
 223 const AVOption *av_set_q(void *obj, const char *name, AVRational n){
 224     return av_set_number(obj, name, n.num, n.den, 1);
 225 }
 226
 227 const AVOption *av_set_int(void *obj, const char *name, int64_t n){
 228     return av_set_number(obj, name, 1, 1, n);
 229 }
 230
 231 /**
 232  *
 233  * @param buf a buffer which is used for returning non string values as strings, can be NULL
 234  * @param buf_len allocated length in bytes of buf
 235  */
 236 const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len){
 237     const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
 238     void *dst;
 239     uint8_t *bin;
 240     int len, i;
 241     if(!o || o->offset<=0)
 242         return NULL;
 243     if(o->type != FF_OPT_TYPE_STRING && (!buf || !buf_len))
 244         return NULL;
 245
 246     dst= ((uint8_t*)obj) + o->offset;
 247     if(o_out) *o_out= o;
 248
 249     switch(o->type){
 250     case FF_OPT_TYPE_FLAGS:     snprintf(buf, buf_len, "0x%08X",*(int    *)dst);break;
 251     case FF_OPT_TYPE_INT:       snprintf(buf, buf_len, "%d" , *(int    *)dst);break;
 252     case FF_OPT_TYPE_INT64:     snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
 253     case FF_OPT_TYPE_FLOAT:     snprintf(buf, buf_len, "%f" , *(float  *)dst);break;
 254     case FF_OPT_TYPE_DOUBLE:    snprintf(buf, buf_len, "%f" , *(double *)dst);break;
 255     case FF_OPT_TYPE_RATIONAL:  snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
 256     case FF_OPT_TYPE_STRING:    return *(void**)dst;
 257     case FF_OPT_TYPE_BINARY:
 258         len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
 259         if(len >= (buf_len + 1)/2) return NULL;
 260         bin = *(uint8_t**)dst;
 261         for(i = 0; i < len; i++) snprintf(buf + i*2, 3, "%02X", bin[i]);
 262         break;
 263     default: return NULL;
 264     }
 265     return buf;
 266 }
 267
 268 static int av_get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum){
 269     const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
 270     void *dst;
 271     if(!o || o->offset<=0)
 272         goto error;
 273
 274     dst= ((uint8_t*)obj) + o->offset;
 275
 276     if(o_out) *o_out= o;
 277
 278     switch(o->type){
 279     case FF_OPT_TYPE_FLAGS:     *intnum= *(unsigned int*)dst;return 0;
 280     case FF_OPT_TYPE_INT:       *intnum= *(int    *)dst;return 0;
 281     case FF_OPT_TYPE_INT64:     *intnum= *(int64_t*)dst;return 0;
 282     case FF_OPT_TYPE_FLOAT:     *num=    *(float  *)dst;return 0;
 283     case FF_OPT_TYPE_DOUBLE:    *num=    *(double *)dst;return 0;
 284     case FF_OPT_TYPE_RATIONAL:  *intnum= ((AVRational*)dst)->num;
 285                                 *den   = ((AVRational*)dst)->den;
 286                                                         return 0;
 287     }
 288 error:
 289     *den=*intnum=0;
 290     return -1;
 291 }
 292
 293 double av_get_double(void *obj, const char *name, const AVOption **o_out){
 294     int64_t intnum=1;
 295     double num=1;
 296     int den=1;
 297
 298     av_get_number(obj, name, o_out, &num, &den, &intnum);
 299     return num*intnum/den;
 300 }
 301
 302 AVRational av_get_q(void *obj, const char *name, const AVOption **o_out){
 303     int64_t intnum=1;
 304     double num=1;
 305     int den=1;
 306
 307     av_get_number(obj, name, o_out, &num, &den, &intnum);
 308     if(num == 1.0 && (int)intnum == intnum)
 309         return (AVRational){intnum, den};
 310     else
 311         return av_d2q(num*intnum/den, 1<<24);
 312 }
 313
 314 int64_t av_get_int(void *obj, const char *name, const AVOption **o_out){
 315     int64_t intnum=1;
 316     double num=1;
 317     int den=1;
 318
 319     av_get_number(obj, name, o_out, &num, &den, &intnum);
 320     return num*intnum/den;
 321 }
 322
 323 static void opt_list(void *obj, void *av_log_obj, const char *unit)
 324 {
 325     const AVOption *opt=NULL;
 326
 327     while((opt= av_next_option(obj, opt))){
 328         if(!(opt->flags & (AV_OPT_FLAG_ENCODING_PARAM|AV_OPT_FLAG_DECODING_PARAM)))
 329             continue;
 330
 331         /* Don't print CONST's on level one.
 332          * Don't print anything but CONST's on level two.
 333          * Only print items from the requested unit.
 334          */
 335         if (!unit && opt->type==FF_OPT_TYPE_CONST)
 336             continue;
 337         else if (unit && opt->type!=FF_OPT_TYPE_CONST)
 338             continue;
 339         else if (unit && opt->type==FF_OPT_TYPE_CONST && strcmp(unit, opt->unit))
 340             continue;
 341         else if (unit && opt->type == FF_OPT_TYPE_CONST)
 342             av_log(av_log_obj, AV_LOG_INFO, "   %-15s ", opt->name);
 343         else
 344             av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
 345
 346         switch( opt->type )
 347         {
 348             case FF_OPT_TYPE_FLAGS:
 349                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>" );
 350                 break;
 351             case FF_OPT_TYPE_INT:
 352                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int>" );
 353                 break;
 354             case FF_OPT_TYPE_INT64:
 355                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>" );
 356                 break;
 357             case FF_OPT_TYPE_DOUBLE:
 358                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<double>" );
 359                 break;
 360             case FF_OPT_TYPE_FLOAT:
 361                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<float>" );
 362                 break;
 363             case FF_OPT_TYPE_STRING:
 364                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<string>" );
 365                 break;
 366             case FF_OPT_TYPE_RATIONAL:
 367                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>" );
 368                 break;
 369             case FF_OPT_TYPE_BINARY:
 370                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>" );
 371                 break;
 372             case FF_OPT_TYPE_CONST:
 373             default:
 374                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "" );
 375                 break;
 376         }
 377         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
 378         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
 379         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM   ) ? 'V' : '.');
 380         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM   ) ? 'A' : '.');
 381         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
 382
 383         if(opt->help)
 384             av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
 385         av_log(av_log_obj, AV_LOG_INFO, "\n");
 386         if (opt->unit && opt->type != FF_OPT_TYPE_CONST) {
 387             opt_list(obj, av_log_obj, opt->unit);
 388         }
 389     }
 390 }
 391
 392 int av_opt_show(void *obj, void *av_log_obj){
 393     if(!obj)
 394         return -1;
 395
 396     av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
 397
 398     opt_list(obj, av_log_obj, NULL);
 399
 400     return 0;
 401 }
 402
 403 /** Set the values of the AVCodecContext or AVFormatContext structure.
 404  * They are set to the defaults specified in the according AVOption options
 405  * array default_val field.
 406  *
 407  * @param s AVCodecContext or AVFormatContext for which the defaults will be set
 408  */
 409 void av_opt_set_defaults2(void *s, int mask, int flags)
 410 {
 411     const AVOption *opt = NULL;
 412     while ((opt = av_next_option(s, opt)) != NULL) {
 413         if((opt->flags & mask) != flags)
 414             continue;
 415         switch(opt->type) {
 416             case FF_OPT_TYPE_CONST:
 417                 /* Nothing to be done here */
 418             break;
 419             case FF_OPT_TYPE_FLAGS:
 420             case FF_OPT_TYPE_INT: {
 421                 int val;
 422                 val = opt->default_val;
 423                 av_set_int(s, opt->name, val);
 424             }
 425             break;
 426             case FF_OPT_TYPE_INT64:
 427                 if((double)(opt->default_val+0.6) == opt->default_val)
 428                     av_log(s, AV_LOG_DEBUG, "loss of precission in default of %s\n", opt->name);
 429                 av_set_int(s, opt->name, opt->default_val);
 430             break;
 431             case FF_OPT_TYPE_FLOAT: {
 432                 double val;
 433                 val = opt->default_val;
 434                 av_set_double(s, opt->name, val);
 435             }
 436             break;
 437             case FF_OPT_TYPE_RATIONAL: {
 438                 AVRational val;
 439                 val = av_d2q(opt->default_val, INT_MAX);
 440                 av_set_q(s, opt->name, val);
 441             }
 442             break;
 443             case FF_OPT_TYPE_STRING:
 444             case FF_OPT_TYPE_BINARY:
 445                 /* Cannot set default for string as default_val is of type * double */
 446             break;
 447             default:
 448                 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
 449         }
 450     }
 451 }
 452
 453 void av_opt_set_defaults(void *s){
 454     av_opt_set_defaults2(s, 0, 0);
 455 }
 456