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