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