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