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