libavcodec/opt.c
860a40c8
 /*
  * AVOptions
  * Copyright (c) 2005 Michael Niedermayer <michaelni@gmx.at>
  *
b78e7197
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
860a40c8
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
b78e7197
  * version 2.1 of the License, or (at your option) any later version.
860a40c8
  *
b78e7197
  * FFmpeg is distributed in the hope that it will be useful,
860a40c8
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
b78e7197
  * License along with FFmpeg; if not, write to the Free Software
5509bffa
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
860a40c8
  */
115329f1
 
860a40c8
 /**
bad5537e
  * @file libavcodec/opt.c
860a40c8
  * AVOptions
  * @author Michael Niedermayer <michaelni@gmx.at>
  */
115329f1
 
860a40c8
 #include "avcodec.h"
6fd46414
 #include "opt.h"
4d7b4613
 #include "eval.h"
860a40c8
 
 //FIXME order them and do a bin search
bc2a1c34
 const AVOption *av_find_opt(void *v, const char *name, const char *unit, int mask, int flags){
860a40c8
     AVClass *c= *(AVClass**)v; //FIXME silly way of storing AVClass
f8a32f45
     const AVOption *o= c->option;
115329f1
 
860a40c8
     for(;o && o->name; o++){
a4072c45
         if(!strcmp(o->name, name) && (!unit || (o->unit && !strcmp(o->unit, unit))) && (o->flags & mask) == flags )
860a40c8
             return o;
     }
     return NULL;
 }
 
f8a32f45
 const AVOption *av_next_option(void *obj, const AVOption *last){
3735e82f
     if(last && last[1].name) return ++last;
     else if(last)            return NULL;
     else                     return (*(AVClass**)obj)->option;
 }
 
301cc4f3
 static int av_set_number2(void *obj, const char *name, double num, int den, int64_t intnum, const AVOption **o_out){
bc2a1c34
     const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
860a40c8
     void *dst;
301cc4f3
     if(o_out)
         *o_out= o;
115329f1
     if(!o || o->offset<=0)
301cc4f3
         return AVERROR(ENOENT);
115329f1
 
fcc9b956
     if(o->max*den < num*intnum || o->min*den > num*intnum) {
a59d44fd
         av_log(NULL, AV_LOG_ERROR, "Value %lf for parameter '%s' out of range\n", num, name);
301cc4f3
         return AVERROR(ERANGE);
fcc9b956
     }
115329f1
 
860a40c8
     dst= ((uint8_t*)obj) + o->offset;
 
     switch(o->type){
115329f1
     case FF_OPT_TYPE_FLAGS:
378774e9
     case FF_OPT_TYPE_INT:   *(int       *)dst= llrint(num/den)*intnum; break;
     case FF_OPT_TYPE_INT64: *(int64_t   *)dst= llrint(num/den)*intnum; break;
8bbf6db9
     case FF_OPT_TYPE_FLOAT: *(float     *)dst= num*intnum/den;         break;
     case FF_OPT_TYPE_DOUBLE:*(double    *)dst= num*intnum/den;         break;
860a40c8
     case FF_OPT_TYPE_RATIONAL:
8bbf6db9
         if((int)num == num) *(AVRational*)dst= (AVRational){num*intnum, den};
         else                *(AVRational*)dst= av_d2q(num*intnum/den, 1<<24);
603972fc
         break;
860a40c8
     default:
301cc4f3
         return AVERROR(EINVAL);
860a40c8
     }
301cc4f3
     return 0;
 }
 
 static const AVOption *av_set_number(void *obj, const char *name, double num, int den, int64_t intnum){
     const AVOption *o = NULL;
     if (av_set_number2(obj, name, num, den, intnum, &o) < 0)
         return NULL;
     else
         return o;
860a40c8
 }
 
cf2baeb3
 static const double const_values[]={
95c99430
     M_PI,
     M_E,
     FF_QP2LAMBDA,
     0
 };
 
cf2baeb3
 static const char * const const_names[]={
95c99430
     "PI",
     "E",
     "QP2LAMBDA",
     0
 };
 
841f39a7
 static int hexchar2int(char c) {
     if (c >= '0' && c <= '9') return c - '0';
     if (c >= 'a' && c <= 'f') return c - 'a' + 10;
     if (c >= 'A' && c <= 'F') return c - 'A' + 10;
     return -1;
 }
 
7b1454c4
 int av_set_string3(void *obj, const char *name, const char *val, int alloc, const AVOption **o_out){
     int ret;
bc2a1c34
     const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
7b1454c4
     if (o_out)
         *o_out = o;
     if(!o)
         return AVERROR(ENOENT);
     if(!val || o->offset<=0)
         return AVERROR(EINVAL);
 
841f39a7
     if(o->type == FF_OPT_TYPE_BINARY){
         uint8_t **dst = (uint8_t **)(((uint8_t*)obj) + o->offset);
         int *lendst = (int *)(dst + 1);
         uint8_t *bin, *ptr;
         int len = strlen(val);
         av_freep(dst);
         *lendst = 0;
7b1454c4
         if (len & 1) return AVERROR(EINVAL);
841f39a7
         len /= 2;
         ptr = bin = av_malloc(len);
         while (*val) {
             int a = hexchar2int(*val++);
             int b = hexchar2int(*val++);
             if (a < 0 || b < 0) {
                 av_free(bin);
7b1454c4
                 return AVERROR(EINVAL);
841f39a7
             }
             *ptr++ = (a << 4) | b;
         }
         *dst = bin;
         *lendst = len;
7b1454c4
         return 0;
841f39a7
     }
860a40c8
     if(o->type != FF_OPT_TYPE_STRING){
9d2e6e84
         int notfirst=0;
860a40c8
         for(;;){
             int i;
95c99430
             char buf[256];
233f6f88
             int cmd=0;
             double d;
408ed51c
             const char *error = NULL;
860a40c8
 
233f6f88
             if(*val == '+' || *val == '-')
                 cmd= *(val++);
115329f1
 
233f6f88
             for(i=0; i<sizeof(buf)-1 && val[i] && val[i]!='+' && val[i]!='-'; i++)
860a40c8
                 buf[i]= val[i];
             buf[i]=0;
115329f1
 
95c99430
             d = ff_eval2(buf, const_values, const_names, NULL, NULL, NULL, NULL, NULL, &error);
             if(isnan(d)) {
bc2a1c34
                 const AVOption *o_named= av_find_opt(obj, buf, o->unit, 0, 0);
115329f1
                 if(o_named && o_named->type == FF_OPT_TYPE_CONST)
233f6f88
                     d= o_named->default_val;
                 else if(!strcmp(buf, "default")) d= o->default_val;
                 else if(!strcmp(buf, "max"    )) d= o->max;
                 else if(!strcmp(buf, "min"    )) d= o->min;
226d6947
                 else if(!strcmp(buf, "none"   )) d= 0;
                 else if(!strcmp(buf, "all"    )) d= ~0;
95c99430
                 else {
0be2f1e3
                     if (error)
95c99430
                         av_log(NULL, AV_LOG_ERROR, "Unable to parse option value \"%s\": %s\n", val, error);
7b1454c4
                     return AVERROR(EINVAL);
95c99430
                 }
860a40c8
             }
233f6f88
             if(o->type == FF_OPT_TYPE_FLAGS){
                 if     (cmd=='+') d= av_get_int(obj, name, NULL) | (int64_t)d;
                 else if(cmd=='-') d= av_get_int(obj, name, NULL) &~(int64_t)d;
4a13a2d4
             }else{
9d2e6e84
                 if     (cmd=='+') d= notfirst*av_get_double(obj, name, NULL) + d;
                 else if(cmd=='-') d= notfirst*av_get_double(obj, name, NULL) - d;
4a13a2d4
             }
860a40c8
 
7b1454c4
             if ((ret = av_set_number2(obj, name, d, 1, 1, o_out)) < 0)
                 return ret;
9203741a
             val+= i;
860a40c8
             if(!*val)
7b1454c4
                 return 0;
9d2e6e84
             notfirst=1;
860a40c8
         }
7b1454c4
         return AVERROR(EINVAL);
860a40c8
     }
115329f1
 
8dbee653
     if(alloc){
f9690589
         av_free(*(void**)(((uint8_t*)obj) + o->offset));
8dbee653
         val= av_strdup(val);
     }
 
24cdc39e
     memcpy(((uint8_t*)obj) + o->offset, &val, sizeof(val));
7b1454c4
     return 0;
 }
 
64e74b68
 #if LIBAVCODEC_VERSION_MAJOR < 53
7b1454c4
 const AVOption *av_set_string2(void *obj, const char *name, const char *val, int alloc){
     const AVOption *o;
     if (av_set_string3(obj, name, val, alloc, &o) < 0)
         return NULL;
8bbf6db9
     return o;
860a40c8
 }
 
8dbee653
 const AVOption *av_set_string(void *obj, const char *name, const char *val){
f16dd7e6
     const AVOption *o;
     if (av_set_string3(obj, name, val, 0, &o) < 0)
         return NULL;
     return o;
8dbee653
 }
64e74b68
 #endif
8dbee653
 
f8a32f45
 const AVOption *av_set_double(void *obj, const char *name, double n){
860a40c8
     return av_set_number(obj, name, n, 1, 1);
 }
 
f8a32f45
 const AVOption *av_set_q(void *obj, const char *name, AVRational n){
860a40c8
     return av_set_number(obj, name, n.num, n.den, 1);
 }
 
f8a32f45
 const AVOption *av_set_int(void *obj, const char *name, int64_t n){
860a40c8
     return av_set_number(obj, name, 1, 1, n);
 }
 
8bbf6db9
 /**
115329f1
  *
8bbf6db9
  * @param buf a buffer which is used for returning non string values as strings, can be NULL
  * @param buf_len allocated length in bytes of buf
  */
f8a32f45
 const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len){
bc2a1c34
     const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
8bbf6db9
     void *dst;
841f39a7
     uint8_t *bin;
     int len, i;
860a40c8
     if(!o || o->offset<=0)
         return NULL;
8bbf6db9
     if(o->type != FF_OPT_TYPE_STRING && (!buf || !buf_len))
860a40c8
         return NULL;
 
8bbf6db9
     dst= ((uint8_t*)obj) + o->offset;
     if(o_out) *o_out= o;
115329f1
 
8bbf6db9
     switch(o->type){
233f6f88
     case FF_OPT_TYPE_FLAGS:     snprintf(buf, buf_len, "0x%08X",*(int    *)dst);break;
8bbf6db9
     case FF_OPT_TYPE_INT:       snprintf(buf, buf_len, "%d" , *(int    *)dst);break;
4733abcb
     case FF_OPT_TYPE_INT64:     snprintf(buf, buf_len, "%"PRId64, *(int64_t*)dst);break;
8bbf6db9
     case FF_OPT_TYPE_FLOAT:     snprintf(buf, buf_len, "%f" , *(float  *)dst);break;
     case FF_OPT_TYPE_DOUBLE:    snprintf(buf, buf_len, "%f" , *(double *)dst);break;
     case FF_OPT_TYPE_RATIONAL:  snprintf(buf, buf_len, "%d/%d", ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
b81f2b3d
     case FF_OPT_TYPE_STRING:    return *(void**)dst;
841f39a7
     case FF_OPT_TYPE_BINARY:
         len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
         if(len >= (buf_len + 1)/2) return NULL;
         bin = *(uint8_t**)dst;
         for(i = 0; i < len; i++) snprintf(buf + i*2, 3, "%02X", bin[i]);
         break;
8bbf6db9
     default: return NULL;
     }
     return buf;
860a40c8
 }
 
f8a32f45
 static int av_get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum){
bc2a1c34
     const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
860a40c8
     void *dst;
     if(!o || o->offset<=0)
8bbf6db9
         goto error;
860a40c8
 
     dst= ((uint8_t*)obj) + o->offset;
 
8bbf6db9
     if(o_out) *o_out= o;
 
860a40c8
     switch(o->type){
378774e9
     case FF_OPT_TYPE_FLAGS:     *intnum= *(unsigned int*)dst;return 0;
8bbf6db9
     case FF_OPT_TYPE_INT:       *intnum= *(int    *)dst;return 0;
     case FF_OPT_TYPE_INT64:     *intnum= *(int64_t*)dst;return 0;
     case FF_OPT_TYPE_FLOAT:     *num=    *(float  *)dst;return 0;
     case FF_OPT_TYPE_DOUBLE:    *num=    *(double *)dst;return 0;
115329f1
     case FF_OPT_TYPE_RATIONAL:  *intnum= ((AVRational*)dst)->num;
8bbf6db9
                                 *den   = ((AVRational*)dst)->den;
                                                         return 0;
860a40c8
     }
8bbf6db9
 error:
     *den=*intnum=0;
     return -1;
 }
 
f8a32f45
 double av_get_double(void *obj, const char *name, const AVOption **o_out){
8bbf6db9
     int64_t intnum=1;
     double num=1;
     int den=1;
 
     av_get_number(obj, name, o_out, &num, &den, &intnum);
     return num*intnum/den;
 }
 
f8a32f45
 AVRational av_get_q(void *obj, const char *name, const AVOption **o_out){
8bbf6db9
     int64_t intnum=1;
     double num=1;
     int den=1;
 
     av_get_number(obj, name, o_out, &num, &den, &intnum);
     if(num == 1.0 && (int)intnum == intnum)
         return (AVRational){intnum, den};
     else
         return av_d2q(num*intnum/den, 1<<24);
 }
 
f8a32f45
 int64_t av_get_int(void *obj, const char *name, const AVOption **o_out){
8bbf6db9
     int64_t intnum=1;
     double num=1;
     int den=1;
 
     av_get_number(obj, name, o_out, &num, &den, &intnum);
     return num*intnum/den;
 }
 
f8a32f45
 static void opt_list(void *obj, void *av_log_obj, const char *unit)
d70ef6d7
 {
f8a32f45
     const AVOption *opt=NULL;
115329f1
 
8bbf6db9
     while((opt= av_next_option(obj, opt))){
         if(!(opt->flags & (AV_OPT_FLAG_ENCODING_PARAM|AV_OPT_FLAG_DECODING_PARAM)))
             continue;
115329f1
 
d70ef6d7
         /* Don't print CONST's on level one.
          * Don't print anything but CONST's on level two.
          * Only print items from the requested unit.
          */
         if (!unit && opt->type==FF_OPT_TYPE_CONST)
             continue;
         else if (unit && opt->type!=FF_OPT_TYPE_CONST)
             continue;
         else if (unit && opt->type==FF_OPT_TYPE_CONST && strcmp(unit, opt->unit))
             continue;
         else if (unit && opt->type == FF_OPT_TYPE_CONST)
             av_log(av_log_obj, AV_LOG_INFO, "   %-15s ", opt->name);
         else
             av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
88d6903e
 
         switch( opt->type )
         {
             case FF_OPT_TYPE_FLAGS:
                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>" );
                 break;
             case FF_OPT_TYPE_INT:
                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int>" );
                 break;
             case FF_OPT_TYPE_INT64:
                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>" );
                 break;
             case FF_OPT_TYPE_DOUBLE:
                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<double>" );
                 break;
             case FF_OPT_TYPE_FLOAT:
                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<float>" );
                 break;
             case FF_OPT_TYPE_STRING:
                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<string>" );
                 break;
             case FF_OPT_TYPE_RATIONAL:
                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>" );
                 break;
841f39a7
             case FF_OPT_TYPE_BINARY:
                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>" );
                 break;
88d6903e
             case FF_OPT_TYPE_CONST:
             default:
                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "" );
                 break;
         }
a1689e2f
         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM   ) ? 'V' : '.');
         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM   ) ? 'A' : '.');
         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
115329f1
 
d2752a0d
         if(opt->help)
             av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
         av_log(av_log_obj, AV_LOG_INFO, "\n");
d70ef6d7
         if (opt->unit && opt->type != FF_OPT_TYPE_CONST) {
             opt_list(obj, av_log_obj, opt->unit);
         }
8bbf6db9
     }
d70ef6d7
 }
 
 int av_opt_show(void *obj, void *av_log_obj){
     if(!obj)
         return -1;
 
     av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
 
     opt_list(obj, av_log_obj, NULL);
 
8bbf6db9
     return 0;
860a40c8
 }
73a8ceaa
 
493f7857
 /** Set the values of the AVCodecContext or AVFormatContext structure.
  * They are set to the defaults specified in the according AVOption options
  * array default_val field.
  *
  * @param s AVCodecContext or AVFormatContext for which the defaults will be set
  */
20e708cb
 void av_opt_set_defaults2(void *s, int mask, int flags)
73a8ceaa
 {
f8a32f45
     const AVOption *opt = NULL;
73a8ceaa
     while ((opt = av_next_option(s, opt)) != NULL) {
20e708cb
         if((opt->flags & mask) != flags)
             continue;
73a8ceaa
         switch(opt->type) {
             case FF_OPT_TYPE_CONST:
                 /* Nothing to be done here */
             break;
             case FF_OPT_TYPE_FLAGS:
             case FF_OPT_TYPE_INT: {
                 int val;
                 val = opt->default_val;
                 av_set_int(s, opt->name, val);
             }
             break;
36d5b175
             case FF_OPT_TYPE_INT64:
                 if((double)(opt->default_val+0.6) == opt->default_val)
                     av_log(s, AV_LOG_DEBUG, "loss of precission in default of %s\n", opt->name);
                 av_set_int(s, opt->name, opt->default_val);
             break;
73a8ceaa
             case FF_OPT_TYPE_FLOAT: {
                 double val;
                 val = opt->default_val;
                 av_set_double(s, opt->name, val);
             }
             break;
             case FF_OPT_TYPE_RATIONAL: {
                 AVRational val;
                 val = av_d2q(opt->default_val, INT_MAX);
                 av_set_q(s, opt->name, val);
             }
             break;
             case FF_OPT_TYPE_STRING:
841f39a7
             case FF_OPT_TYPE_BINARY:
73a8ceaa
                 /* Cannot set default for string as default_val is of type * double */
             break;
             default:
                 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
         }
     }
 }
 
20e708cb
 void av_opt_set_defaults(void *s){
     av_opt_set_defaults2(s, 0, 0);
 }