]> git.sesse.net Git - ffmpeg/blobdiff - libavcodec/opt.c
Spelling and puctuation
[ffmpeg] / libavcodec / opt.c
index 0de7c18621bf7010b0bf509148baa6a060db5035..928580857a6b3e3388b3bcfff866d0d3fed12e19 100644 (file)
@@ -2,20 +2,21 @@
  * AVOptions
  * Copyright (c) 2005 Michael Niedermayer <michaelni@gmx.at>
  *
- * This library is free software; you can redistribute it and/or
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
- * version 2 of the License, or (at your option) any later version.
+ * version 2.1 of the License, or (at your option) any later version.
  *
- * This library is distributed in the hope that it will be useful,
+ * FFmpeg is distributed in the hope that it will be useful,
  * 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
- * License along with this library; if not, write to the Free Software
+ * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
- *
  */
 
 /**
 
 #include "avcodec.h"
 #include "opt.h"
-
-static int8_t si_prefixes['z' - 'E' + 1]={
-    ['y'-'E']= -24,
-    ['z'-'E']= -21,
-    ['a'-'E']= -18,
-    ['f'-'E']= -15,
-    ['p'-'E']= -12,
-    ['n'-'E']= - 9,
-    ['u'-'E']= - 6,
-    ['m'-'E']= - 3,
-    ['c'-'E']= - 2,
-    ['d'-'E']= - 1,
-    ['h'-'E']=   2,
-    ['k'-'E']=   3,
-    ['K'-'E']=   3,
-    ['M'-'E']=   6,
-    ['G'-'E']=   9,
-    ['T'-'E']=  12,
-    ['P'-'E']=  15,
-    ['E'-'E']=  18,
-    ['Z'-'E']=  21,
-    ['Y'-'E']=  24,
-};
-
-/** strtod() function extended with 'k', 'M', 'G', 'ki', 'Mi', 'Gi' and 'B'
- * postfixes.  This allows using f.e. kB, MiB, G and B as a postfix. This
- * function assumes that the unit of numbers is bits not bytes.
- */
-double av_strtod(const char *name, char **tail) {
-    double d;
-    int p = 0;
-    char *next;
-    d = strtod(name, &next);
-    /* if parsing succeeded, check for and interpret postfixes */
-    if (next!=name) {
-
-        if(*next >= 'E' && *next <= 'z'){
-            int e= si_prefixes[*next - 'E'];
-            if(e){
-                if(next[1] == 'i'){
-                    d*= pow( 2, e/0.3);
-                    next+=2;
-                }else{
-                    d*= pow(10, e);
-                    next++;
-                }
-            }
-        }
-
-        if(*next=='B') {
-            d*=8;
-            *next++;
-        }
-    }
-    /* if requested, fill in tail with the position after the last parsed
-       character */
-    if (tail)
-        *tail = next;
-    return d;
-}
-
-static double av_parse_num(const char *name, char **tail){
-    double d;
-    d= av_strtod(name, tail);
-    if(*tail>name && (**tail=='/' || **tail==':'))
-        d/=av_strtod((*tail)+1, tail);
-    return d;
-}
+#include "eval.h"
 
 //FIXME order them and do a bin search
-static AVOption *find_opt(void *v, const char *name, const char *unit){
+const AVOption *av_find_opt(void *v, const char *name, const char *unit, int mask, int flags){
     AVClass *c= *(AVClass**)v; //FIXME silly way of storing AVClass
-    AVOption *o= c->option;
+    const AVOption *o= c->option;
 
     for(;o && o->name; o++){
-        if(!strcmp(o->name, name) && (!unit || !strcmp(o->unit, unit)) )
+        if(!strcmp(o->name, name) && (!unit || (o->unit && !strcmp(o->unit, unit))) && (o->flags & mask) == flags )
             return o;
     }
     return NULL;
 }
 
-AVOption *av_next_option(void *obj, AVOption *last){
+const AVOption *av_next_option(void *obj, const AVOption *last){
     if(last && last[1].name) return ++last;
     else if(last)            return NULL;
     else                     return (*(AVClass**)obj)->option;
 }
 
-static AVOption *av_set_number(void *obj, const char *name, double num, int den, int64_t intnum){
-    AVOption *o= find_opt(obj, name, NULL);
+static const AVOption *av_set_number(void *obj, const char *name, double num, int den, int64_t intnum){
+    const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
     void *dst;
     if(!o || o->offset<=0)
         return NULL;
 
-    if(o->max*den < num*intnum || o->min*den > num*intnum)
+    if(o->max*den < num*intnum || o->min*den > num*intnum) {
+        av_log(NULL, AV_LOG_ERROR, "Value %lf for parameter '%s' out of range.\n", num, name);
         return NULL;
+    }
 
     dst= ((uint8_t*)obj) + o->offset;
 
     switch(o->type){
     case FF_OPT_TYPE_FLAGS:
-    case FF_OPT_TYPE_INT:   *(int       *)dst= lrintf(num/den)*intnum; break;
-    case FF_OPT_TYPE_INT64: *(int64_t   *)dst= lrintf(num/den)*intnum; break;
+    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;
     case FF_OPT_TYPE_FLOAT: *(float     *)dst= num*intnum/den;         break;
     case FF_OPT_TYPE_DOUBLE:*(double    *)dst= num*intnum/den;         break;
     case FF_OPT_TYPE_RATIONAL:
         if((int)num == num) *(AVRational*)dst= (AVRational){num*intnum, den};
         else                *(AVRational*)dst= av_d2q(num*intnum/den, 1<<24);
+        break;
     default:
         return NULL;
     }
     return o;
 }
 
-static AVOption *set_all_opt(void *v, const char *unit, double d){
+static const AVOption *set_all_opt(void *v, const char *unit, double d){
     AVClass *c= *(AVClass**)v; //FIXME silly way of storing AVClass
-    AVOption *o= c->option;
-    AVOption *ret=NULL;
+    const AVOption *o= c->option;
+    const AVOption *ret=NULL;
 
     for(;o && o->name; o++){
         if(o->type != FF_OPT_TYPE_CONST && o->unit && !strcmp(o->unit, unit)){
@@ -157,20 +94,64 @@ static AVOption *set_all_opt(void *v, const char *unit, double d){
     return ret;
 }
 
-//FIXME use eval.c maybe?
-AVOption *av_set_string(void *obj, const char *name, const char *val){
-    AVOption *o= find_opt(obj, name, NULL);
+static double const_values[]={
+    M_PI,
+    M_E,
+    FF_QP2LAMBDA,
+    0
+};
+
+static const char *const_names[]={
+    "PI",
+    "E",
+    "QP2LAMBDA",
+    0
+};
+
+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;
+}
+
+const AVOption *av_set_string(void *obj, const char *name, const char *val){
+    const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
     if(o && o->offset==0 && o->type == FF_OPT_TYPE_CONST && o->unit){
         return set_all_opt(obj, o->unit, o->default_val);
     }
     if(!o || !val || o->offset<=0)
         return NULL;
+    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;
+        if (len & 1) return NULL;
+        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);
+                return NULL;
+            }
+            *ptr++ = (a << 4) | b;
+        }
+        *dst = bin;
+        *lendst = len;
+        return o;
+    }
     if(o->type != FF_OPT_TYPE_STRING){
         for(;;){
             int i;
-            char buf[256], *tail;
+            char buf[256];
             int cmd=0;
             double d;
+            const char *error = NULL;
 
             if(*val == '+' || *val == '-')
                 cmd= *(val++);
@@ -180,15 +161,21 @@ AVOption *av_set_string(void *obj, const char *name, const char *val){
             buf[i]=0;
             val+= i;
 
-            d= av_parse_num(buf, &tail);
-            if(tail <= buf){
-                AVOption *o_named= find_opt(obj, buf, o->unit);
+            d = ff_eval2(buf, const_values, const_names, NULL, NULL, NULL, NULL, NULL, &error);
+            if(isnan(d)) {
+                const AVOption *o_named= av_find_opt(obj, buf, o->unit, 0, 0);
                 if(o_named && o_named->type == FF_OPT_TYPE_CONST)
                     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;
-                else return NULL;
+                else if(!strcmp(buf, "none"   )) d= 0;
+                else if(!strcmp(buf, "all"    )) d= ~0;
+                else {
+                    if (!error)
+                        av_log(NULL, AV_LOG_ERROR, "Unable to parse option value \"%s\": %s\n", val, error);
+                    return NULL;
+                }
             }
             if(o->type == FF_OPT_TYPE_FLAGS){
                 if     (cmd=='+') d= av_get_int(obj, name, NULL) | (int64_t)d;
@@ -203,19 +190,19 @@ AVOption *av_set_string(void *obj, const char *name, const char *val){
         return NULL;
     }
 
-    memcpy(((uint8_t*)obj) + o->offset, val, sizeof(val));
+    memcpy(((uint8_t*)obj) + o->offset, &val, sizeof(val));
     return o;
 }
 
-AVOption *av_set_double(void *obj, const char *name, double n){
+const AVOption *av_set_double(void *obj, const char *name, double n){
     return av_set_number(obj, name, n, 1, 1);
 }
 
-AVOption *av_set_q(void *obj, const char *name, AVRational n){
+const AVOption *av_set_q(void *obj, const char *name, AVRational n){
     return av_set_number(obj, name, n.num, n.den, 1);
 }
 
-AVOption *av_set_int(void *obj, const char *name, int64_t n){
+const AVOption *av_set_int(void *obj, const char *name, int64_t n){
     return av_set_number(obj, name, 1, 1, n);
 }
 
@@ -224,9 +211,11 @@ AVOption *av_set_int(void *obj, const char *name, int64_t n){
  * @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
  */
-const char *av_get_string(void *obj, const char *name, AVOption **o_out, char *buf, int buf_len){
-    AVOption *o= find_opt(obj, name, NULL);
+const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len){
+    const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
     void *dst;
+    uint8_t *bin;
+    int len, i;
     if(!o || o->offset<=0)
         return NULL;
     if(o->type != FF_OPT_TYPE_STRING && (!buf || !buf_len))
@@ -235,9 +224,6 @@ const char *av_get_string(void *obj, const char *name, AVOption **o_out, char *b
     dst= ((uint8_t*)obj) + o->offset;
     if(o_out) *o_out= o;
 
-    if(o->type == FF_OPT_TYPE_STRING)
-        return dst;
-
     switch(o->type){
     case FF_OPT_TYPE_FLAGS:     snprintf(buf, buf_len, "0x%08X",*(int    *)dst);break;
     case FF_OPT_TYPE_INT:       snprintf(buf, buf_len, "%d" , *(int    *)dst);break;
@@ -245,13 +231,20 @@ const char *av_get_string(void *obj, const char *name, AVOption **o_out, char *b
     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;
+    case FF_OPT_TYPE_STRING:    return *(void**)dst;
+    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;
     default: return NULL;
     }
     return buf;
 }
 
-static int av_get_number(void *obj, const char *name, AVOption **o_out, double *num, int *den, int64_t *intnum){
-    AVOption *o= find_opt(obj, name, NULL);
+static int av_get_number(void *obj, const char *name, const AVOption **o_out, double *num, int *den, int64_t *intnum){
+    const AVOption *o= av_find_opt(obj, name, NULL, 0, 0);
     void *dst;
     if(!o || o->offset<=0)
         goto error;
@@ -261,7 +254,7 @@ static int av_get_number(void *obj, const char *name, AVOption **o_out, double *
     if(o_out) *o_out= o;
 
     switch(o->type){
-    case FF_OPT_TYPE_FLAGS:
+    case FF_OPT_TYPE_FLAGS:     *intnum= *(unsigned int*)dst;return 0;
     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;
@@ -275,7 +268,7 @@ error:
     return -1;
 }
 
-double av_get_double(void *obj, const char *name, AVOption **o_out){
+double av_get_double(void *obj, const char *name, const AVOption **o_out){
     int64_t intnum=1;
     double num=1;
     int den=1;
@@ -284,7 +277,7 @@ double av_get_double(void *obj, const char *name, AVOption **o_out){
     return num*intnum/den;
 }
 
-AVRational av_get_q(void *obj, const char *name, AVOption **o_out){
+AVRational av_get_q(void *obj, const char *name, const AVOption **o_out){
     int64_t intnum=1;
     double num=1;
     int den=1;
@@ -296,7 +289,7 @@ AVRational av_get_q(void *obj, const char *name, AVOption **o_out){
         return av_d2q(num*intnum/den, 1<<24);
 }
 
-int64_t av_get_int(void *obj, const char *name, AVOption **o_out){
+int64_t av_get_int(void *obj, const char *name, const AVOption **o_out){
     int64_t intnum=1;
     double num=1;
     int den=1;
@@ -305,19 +298,28 @@ int64_t av_get_int(void *obj, const char *name, AVOption **o_out){
     return num*intnum/den;
 }
 
-int av_opt_show(void *obj, void *av_log_obj){
-    AVOption *opt=NULL;
-
-    if(!obj)
-        return -1;
-
-    av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
+static void opt_list(void *obj, void *av_log_obj, const char *unit)
+{
+    const AVOption *opt=NULL;
 
     while((opt= av_next_option(obj, opt))){
         if(!(opt->flags & (AV_OPT_FLAG_ENCODING_PARAM|AV_OPT_FLAG_DECODING_PARAM)))
             continue;
 
-        av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
+        /* 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);
 
         switch( opt->type )
         {
@@ -342,6 +344,9 @@ int av_opt_show(void *obj, void *av_log_obj){
             case FF_OPT_TYPE_RATIONAL:
                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>" );
                 break;
+            case FF_OPT_TYPE_BINARY:
+                av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>" );
+                break;
             case FF_OPT_TYPE_CONST:
             default:
                 av_log( av_log_obj, AV_LOG_INFO, "%-7s ", "" );
@@ -356,7 +361,20 @@ int av_opt_show(void *obj, void *av_log_obj){
         if(opt->help)
             av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
         av_log(av_log_obj, AV_LOG_INFO, "\n");
+        if (opt->unit && opt->type != FF_OPT_TYPE_CONST) {
+            opt_list(obj, av_log_obj, opt->unit);
+        }
     }
+}
+
+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);
+
     return 0;
 }
 
@@ -366,10 +384,12 @@ int av_opt_show(void *obj, void *av_log_obj){
  *
  * @param s AVCodecContext or AVFormatContext for which the defaults will be set
  */
-void av_opt_set_defaults(void *s)
+void av_opt_set_defaults2(void *s, int mask, int flags)
 {
-    AVOption *opt = NULL;
+    const AVOption *opt = NULL;
     while ((opt = av_next_option(s, opt)) != NULL) {
+        if((opt->flags & mask) != flags)
+            continue;
         switch(opt->type) {
             case FF_OPT_TYPE_CONST:
                 /* Nothing to be done here */
@@ -394,6 +414,7 @@ void av_opt_set_defaults(void *s)
             }
             break;
             case FF_OPT_TYPE_STRING:
+            case FF_OPT_TYPE_BINARY:
                 /* Cannot set default for string as default_val is of type * double */
             break;
             default:
@@ -402,3 +423,7 @@ void av_opt_set_defaults(void *s)
     }
 }
 
+void av_opt_set_defaults(void *s){
+    av_opt_set_defaults2(s, 0, 0);
+}
+