git.sesse.net Git - ffmpeg/blob - libavutil/opt.c

   1 /*
   2  * AVOptions
   3  * Copyright (c) 2005 Michael Niedermayer <michaelni@gmx.at>
   4  *
   5  * This file is part of Libav.
   6  *
   7  * Libav 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  * Libav 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 Libav; 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
  24  * AVOptions
  25  * @author Michael Niedermayer <michaelni@gmx.at>
  26  */
  27
  28 #include "avutil.h"
  29 #include "avstring.h"
  30 #include "common.h"
  31 #include "opt.h"
  32 #include "eval.h"
  33 #include "dict.h"
  34 #include "log.h"
  35 #include "mathematics.h"
  36
  37 const AVOption *av_opt_next(void *obj, const AVOption *last)
  38 {
  39     AVClass *class = *(AVClass**)obj;
  40     if (!last && class->option && class->option[0].name)
  41         return class->option;
  42     if (last && last[1].name)
  43         return ++last;
  44     return NULL;
  45 }
  46
  47 static int read_number(const AVOption *o, void *dst, double *num, int *den, int64_t *intnum)
  48 {
  49     switch (o->type) {
  50     case AV_OPT_TYPE_FLAGS:     *intnum = *(unsigned int*)dst;return 0;
  51     case AV_OPT_TYPE_INT:       *intnum = *(int         *)dst;return 0;
  52     case AV_OPT_TYPE_INT64:     *intnum = *(int64_t     *)dst;return 0;
  53     case AV_OPT_TYPE_FLOAT:     *num    = *(float       *)dst;return 0;
  54     case AV_OPT_TYPE_DOUBLE:    *num    = *(double      *)dst;return 0;
  55     case AV_OPT_TYPE_RATIONAL:  *intnum = ((AVRational*)dst)->num;
  56                                 *den    = ((AVRational*)dst)->den;
  57                                                         return 0;
  58     }
  59     return AVERROR(EINVAL);
  60 }
  61
  62 static int write_number(void *obj, const AVOption *o, void *dst, double num, int den, int64_t intnum)
  63 {
  64     if (o->type != AV_OPT_TYPE_FLAGS &&
  65         (o->max * den < num * intnum || o->min * den > num * intnum)) {
  66         av_log(obj, AV_LOG_ERROR, "Value %f for parameter '%s' out of range\n",
  67                num*intnum/den, o->name);
  68         return AVERROR(ERANGE);
  69     }
  70
  71     switch (o->type) {
  72     case AV_OPT_TYPE_FLAGS:
  73     case AV_OPT_TYPE_INT:   *(int       *)dst= llrint(num/den)*intnum; break;
  74     case AV_OPT_TYPE_INT64: *(int64_t   *)dst= llrint(num/den)*intnum; break;
  75     case AV_OPT_TYPE_FLOAT: *(float     *)dst= num*intnum/den;         break;
  76     case AV_OPT_TYPE_DOUBLE:*(double    *)dst= num*intnum/den;         break;
  77     case AV_OPT_TYPE_RATIONAL:
  78         if ((int)num == num) *(AVRational*)dst= (AVRational){num*intnum, den};
  79         else                 *(AVRational*)dst= av_d2q(num*intnum/den, 1<<24);
  80         break;
  81     default:
  82         return AVERROR(EINVAL);
  83     }
  84     return 0;
  85 }
  86
  87 static const double const_values[] = {
  88     M_PI,
  89     M_E,
  90     FF_QP2LAMBDA,
  91     0
  92 };
  93
  94 static const char * const const_names[] = {
  95     "PI",
  96     "E",
  97     "QP2LAMBDA",
  98     0
  99 };
 100
 101 static int hexchar2int(char c) {
 102     if (c >= '0' && c <= '9') return c - '0';
 103     if (c >= 'a' && c <= 'f') return c - 'a' + 10;
 104     if (c >= 'A' && c <= 'F') return c - 'A' + 10;
 105     return -1;
 106 }
 107
 108 static int set_string_binary(void *obj, const AVOption *o, const char *val, uint8_t **dst)
 109 {
 110     int *lendst = (int *)(dst + 1);
 111     uint8_t *bin, *ptr;
 112     int len = strlen(val);
 113
 114     av_freep(dst);
 115     *lendst = 0;
 116
 117     if (len & 1)
 118         return AVERROR(EINVAL);
 119     len /= 2;
 120
 121     ptr = bin = av_malloc(len);
 122     while (*val) {
 123         int a = hexchar2int(*val++);
 124         int b = hexchar2int(*val++);
 125         if (a < 0 || b < 0) {
 126             av_free(bin);
 127             return AVERROR(EINVAL);
 128         }
 129         *ptr++ = (a << 4) | b;
 130     }
 131     *dst = bin;
 132     *lendst = len;
 133
 134     return 0;
 135 }
 136
 137 static int set_string(void *obj, const AVOption *o, const char *val, uint8_t **dst)
 138 {
 139     av_freep(dst);
 140     *dst = av_strdup(val);
 141     return 0;
 142 }
 143
 144 #define DEFAULT_NUMVAL(opt) ((opt->type == AV_OPT_TYPE_INT64 || \
 145                               opt->type == AV_OPT_TYPE_CONST || \
 146                               opt->type == AV_OPT_TYPE_FLAGS || \
 147                               opt->type == AV_OPT_TYPE_INT) ? \
 148                              opt->default_val.i64 : opt->default_val.dbl)
 149
 150 static int set_string_number(void *obj, void *target_obj, const AVOption *o, const char *val, void *dst)
 151 {
 152     int ret = 0, notfirst = 0;
 153     for (;;) {
 154         int i, den = 1;
 155         char buf[256];
 156         int cmd = 0;
 157         double d, num = 1;
 158         int64_t intnum = 1;
 159
 160         i = 0;
 161         if (*val == '+' || *val == '-') {
 162             if (o->type == AV_OPT_TYPE_FLAGS)
 163                 cmd = *(val++);
 164             else if (!notfirst)
 165                 buf[i++] = *val;
 166         }
 167
 168         for (; i < sizeof(buf) - 1 && val[i] && val[i] != '+' && val[i] != '-'; i++)
 169             buf[i] = val[i];
 170         buf[i] = 0;
 171
 172         {
 173             const AVOption *o_named = av_opt_find(target_obj, buf, o->unit, 0, 0);
 174             if (o_named && o_named->type == AV_OPT_TYPE_CONST)
 175                 d = DEFAULT_NUMVAL(o_named);
 176             else if (!strcmp(buf, "default")) d = DEFAULT_NUMVAL(o);
 177             else if (!strcmp(buf, "max"    )) d = o->max;
 178             else if (!strcmp(buf, "min"    )) d = o->min;
 179             else if (!strcmp(buf, "none"   )) d = 0;
 180             else if (!strcmp(buf, "all"    )) d = ~0;
 181             else {
 182                 int res = av_expr_parse_and_eval(&d, buf, const_names, const_values, NULL, NULL, NULL, NULL, NULL, 0, obj);
 183                 if (res < 0) {
 184                     av_log(obj, AV_LOG_ERROR, "Unable to parse option value \"%s\"\n", val);
 185                     return res;
 186                 }
 187             }
 188         }
 189         if (o->type == AV_OPT_TYPE_FLAGS) {
 190             read_number(o, dst, NULL, NULL, &intnum);
 191             if      (cmd == '+') d = intnum | (int64_t)d;
 192             else if (cmd == '-') d = intnum &~(int64_t)d;
 193         } else {
 194             read_number(o, dst, &num, &den, &intnum);
 195             if      (cmd == '+') d = notfirst*num*intnum/den + d;
 196             else if (cmd == '-') d = notfirst*num*intnum/den - d;
 197         }
 198
 199         if ((ret = write_number(obj, o, dst, d, 1, 1)) < 0)
 200             return ret;
 201         val += i;
 202         if (!*val)
 203             return 0;
 204         notfirst = 1;
 205     }
 206
 207     return 0;
 208 }
 209
 210 int av_opt_set(void *obj, const char *name, const char *val, int search_flags)
 211 {
 212     void *dst, *target_obj;
 213     const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
 214     if (!o || !target_obj)
 215         return AVERROR_OPTION_NOT_FOUND;
 216     if (!val || o->flags & AV_OPT_FLAG_READONLY)
 217         return AVERROR(EINVAL);
 218
 219     dst = ((uint8_t*)target_obj) + o->offset;
 220     switch (o->type) {
 221     case AV_OPT_TYPE_STRING:   return set_string(obj, o, val, dst);
 222     case AV_OPT_TYPE_BINARY:   return set_string_binary(obj, o, val, dst);
 223     case AV_OPT_TYPE_FLAGS:
 224     case AV_OPT_TYPE_INT:
 225     case AV_OPT_TYPE_INT64:
 226     case AV_OPT_TYPE_FLOAT:
 227     case AV_OPT_TYPE_DOUBLE:
 228     case AV_OPT_TYPE_RATIONAL: return set_string_number(obj, target_obj, o, val, dst);
 229     }
 230
 231     av_log(obj, AV_LOG_ERROR, "Invalid option type.\n");
 232     return AVERROR(EINVAL);
 233 }
 234
 235 #define OPT_EVAL_NUMBER(name, opttype, vartype)\
 236     int av_opt_eval_ ## name(void *obj, const AVOption *o, const char *val, vartype *name ## _out)\
 237     {\
 238         if (!o || o->type != opttype || o->flags & AV_OPT_FLAG_READONLY)\
 239             return AVERROR(EINVAL);\
 240         return set_string_number(obj, obj, o, val, name ## _out);\
 241     }
 242
 243 OPT_EVAL_NUMBER(flags,  AV_OPT_TYPE_FLAGS,    int)
 244 OPT_EVAL_NUMBER(int,    AV_OPT_TYPE_INT,      int)
 245 OPT_EVAL_NUMBER(int64,  AV_OPT_TYPE_INT64,    int64_t)
 246 OPT_EVAL_NUMBER(float,  AV_OPT_TYPE_FLOAT,    float)
 247 OPT_EVAL_NUMBER(double, AV_OPT_TYPE_DOUBLE,   double)
 248 OPT_EVAL_NUMBER(q,      AV_OPT_TYPE_RATIONAL, AVRational)
 249
 250 static int set_number(void *obj, const char *name, double num, int den, int64_t intnum,
 251                                   int search_flags)
 252 {
 253     void *dst, *target_obj;
 254     const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
 255
 256     if (!o || !target_obj)
 257         return AVERROR_OPTION_NOT_FOUND;
 258
 259     if (o->flags & AV_OPT_FLAG_READONLY)
 260         return AVERROR(EINVAL);
 261
 262     dst = ((uint8_t*)target_obj) + o->offset;
 263     return write_number(obj, o, dst, num, den, intnum);
 264 }
 265
 266 int av_opt_set_int(void *obj, const char *name, int64_t val, int search_flags)
 267 {
 268     return set_number(obj, name, 1, 1, val, search_flags);
 269 }
 270
 271 int av_opt_set_double(void *obj, const char *name, double val, int search_flags)
 272 {
 273     return set_number(obj, name, val, 1, 1, search_flags);
 274 }
 275
 276 int av_opt_set_q(void *obj, const char *name, AVRational val, int search_flags)
 277 {
 278     return set_number(obj, name, val.num, val.den, 1, search_flags);
 279 }
 280
 281 int av_opt_set_bin(void *obj, const char *name, const uint8_t *val, int len, int search_flags)
 282 {
 283     void *target_obj;
 284     const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
 285     uint8_t *ptr;
 286     uint8_t **dst;
 287     int *lendst;
 288
 289     if (!o || !target_obj)
 290         return AVERROR_OPTION_NOT_FOUND;
 291
 292     if (o->type != AV_OPT_TYPE_BINARY || o->flags & AV_OPT_FLAG_READONLY)
 293         return AVERROR(EINVAL);
 294
 295     ptr = av_malloc(len);
 296     if (!ptr)
 297         return AVERROR(ENOMEM);
 298
 299     dst = (uint8_t **)(((uint8_t *)target_obj) + o->offset);
 300     lendst = (int *)(dst + 1);
 301
 302     av_free(*dst);
 303     *dst = ptr;
 304     *lendst = len;
 305     memcpy(ptr, val, len);
 306
 307     return 0;
 308 }
 309
 310 int av_opt_get(void *obj, const char *name, int search_flags, uint8_t **out_val)
 311 {
 312     void *dst, *target_obj;
 313     const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
 314     uint8_t *bin, buf[128];
 315     int len, i, ret;
 316
 317     if (!o || !target_obj)
 318         return AVERROR_OPTION_NOT_FOUND;
 319
 320     dst = (uint8_t*)target_obj + o->offset;
 321
 322     buf[0] = 0;
 323     switch (o->type) {
 324     case AV_OPT_TYPE_FLAGS:     ret = snprintf(buf, sizeof(buf), "0x%08X",  *(int    *)dst);break;
 325     case AV_OPT_TYPE_INT:       ret = snprintf(buf, sizeof(buf), "%d" ,     *(int    *)dst);break;
 326     case AV_OPT_TYPE_INT64:     ret = snprintf(buf, sizeof(buf), "%"PRId64, *(int64_t*)dst);break;
 327     case AV_OPT_TYPE_FLOAT:     ret = snprintf(buf, sizeof(buf), "%f" ,     *(float  *)dst);break;
 328     case AV_OPT_TYPE_DOUBLE:    ret = snprintf(buf, sizeof(buf), "%f" ,     *(double *)dst);break;
 329     case AV_OPT_TYPE_RATIONAL:  ret = snprintf(buf, sizeof(buf), "%d/%d",   ((AVRational*)dst)->num, ((AVRational*)dst)->den);break;
 330     case AV_OPT_TYPE_STRING:
 331         if (*(uint8_t**)dst)
 332             *out_val = av_strdup(*(uint8_t**)dst);
 333         else
 334             *out_val = av_strdup("");
 335         return 0;
 336     case AV_OPT_TYPE_BINARY:
 337         len = *(int*)(((uint8_t *)dst) + sizeof(uint8_t *));
 338         if ((uint64_t)len*2 + 1 > INT_MAX)
 339             return AVERROR(EINVAL);
 340         if (!(*out_val = av_malloc(len*2 + 1)))
 341             return AVERROR(ENOMEM);
 342         bin = *(uint8_t**)dst;
 343         for (i = 0; i < len; i++)
 344             snprintf(*out_val + i*2, 3, "%02X", bin[i]);
 345         return 0;
 346     default:
 347         return AVERROR(EINVAL);
 348     }
 349
 350     if (ret >= sizeof(buf))
 351         return AVERROR(EINVAL);
 352     *out_val = av_strdup(buf);
 353     return 0;
 354 }
 355
 356 static int get_number(void *obj, const char *name, double *num, int *den, int64_t *intnum,
 357                       int search_flags)
 358 {
 359     void *dst, *target_obj;
 360     const AVOption *o = av_opt_find2(obj, name, NULL, 0, search_flags, &target_obj);
 361     if (!o || !target_obj)
 362         goto error;
 363
 364     dst = ((uint8_t*)target_obj) + o->offset;
 365
 366     return read_number(o, dst, num, den, intnum);
 367
 368 error:
 369     *den=*intnum=0;
 370     return -1;
 371 }
 372
 373 int av_opt_get_int(void *obj, const char *name, int search_flags, int64_t *out_val)
 374 {
 375     int64_t intnum = 1;
 376     double     num = 1;
 377     int   ret, den = 1;
 378
 379     if ((ret = get_number(obj, name, &num, &den, &intnum, search_flags)) < 0)
 380         return ret;
 381     *out_val = num*intnum/den;
 382     return 0;
 383 }
 384
 385 int av_opt_get_double(void *obj, const char *name, int search_flags, double *out_val)
 386 {
 387     int64_t intnum = 1;
 388     double     num = 1;
 389     int   ret, den = 1;
 390
 391     if ((ret = get_number(obj, name, &num, &den, &intnum, search_flags)) < 0)
 392         return ret;
 393     *out_val = num*intnum/den;
 394     return 0;
 395 }
 396
 397 int av_opt_get_q(void *obj, const char *name, int search_flags, AVRational *out_val)
 398 {
 399     int64_t intnum = 1;
 400     double     num = 1;
 401     int   ret, den = 1;
 402
 403     if ((ret = get_number(obj, name, &num, &den, &intnum, search_flags)) < 0)
 404         return ret;
 405
 406     if (num == 1.0 && (int)intnum == intnum)
 407         *out_val = (AVRational){intnum, den};
 408     else
 409         *out_val = av_d2q(num*intnum/den, 1<<24);
 410     return 0;
 411 }
 412
 413 int av_opt_flag_is_set(void *obj, const char *field_name, const char *flag_name)
 414 {
 415     const AVOption *field = av_opt_find(obj, field_name, NULL, 0, 0);
 416     const AVOption *flag  = av_opt_find(obj, flag_name,
 417                                         field ? field->unit : NULL, 0, 0);
 418     int64_t res;
 419
 420     if (!field || !flag || flag->type != AV_OPT_TYPE_CONST ||
 421         av_opt_get_int(obj, field_name, 0, &res) < 0)
 422         return 0;
 423     return res & flag->default_val.i64;
 424 }
 425
 426 static void opt_list(void *obj, void *av_log_obj, const char *unit,
 427                      int req_flags, int rej_flags)
 428 {
 429     const AVOption *opt=NULL;
 430
 431     while ((opt = av_opt_next(obj, opt))) {
 432         if (!(opt->flags & req_flags) || (opt->flags & rej_flags))
 433             continue;
 434
 435         /* Don't print CONST's on level one.
 436          * Don't print anything but CONST's on level two.
 437          * Only print items from the requested unit.
 438          */
 439         if (!unit && opt->type==AV_OPT_TYPE_CONST)
 440             continue;
 441         else if (unit && opt->type!=AV_OPT_TYPE_CONST)
 442             continue;
 443         else if (unit && opt->type==AV_OPT_TYPE_CONST && strcmp(unit, opt->unit))
 444             continue;
 445         else if (unit && opt->type == AV_OPT_TYPE_CONST)
 446             av_log(av_log_obj, AV_LOG_INFO, "   %-15s ", opt->name);
 447         else
 448             av_log(av_log_obj, AV_LOG_INFO, "-%-17s ", opt->name);
 449
 450         switch (opt->type) {
 451             case AV_OPT_TYPE_FLAGS:
 452                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<flags>");
 453                 break;
 454             case AV_OPT_TYPE_INT:
 455                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<int>");
 456                 break;
 457             case AV_OPT_TYPE_INT64:
 458                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<int64>");
 459                 break;
 460             case AV_OPT_TYPE_DOUBLE:
 461                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<double>");
 462                 break;
 463             case AV_OPT_TYPE_FLOAT:
 464                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<float>");
 465                 break;
 466             case AV_OPT_TYPE_STRING:
 467                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<string>");
 468                 break;
 469             case AV_OPT_TYPE_RATIONAL:
 470                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<rational>");
 471                 break;
 472             case AV_OPT_TYPE_BINARY:
 473                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "<binary>");
 474                 break;
 475             case AV_OPT_TYPE_CONST:
 476             default:
 477                 av_log(av_log_obj, AV_LOG_INFO, "%-7s ", "");
 478                 break;
 479         }
 480         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_ENCODING_PARAM) ? 'E' : '.');
 481         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_DECODING_PARAM) ? 'D' : '.');
 482         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_VIDEO_PARAM   ) ? 'V' : '.');
 483         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_AUDIO_PARAM   ) ? 'A' : '.');
 484         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_SUBTITLE_PARAM) ? 'S' : '.');
 485         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_EXPORT)         ? 'X' : '.');
 486         av_log(av_log_obj, AV_LOG_INFO, "%c", (opt->flags & AV_OPT_FLAG_READONLY)       ? 'R' : '.');
 487
 488         if (opt->help)
 489             av_log(av_log_obj, AV_LOG_INFO, " %s", opt->help);
 490         av_log(av_log_obj, AV_LOG_INFO, "\n");
 491         if (opt->unit && opt->type != AV_OPT_TYPE_CONST) {
 492             opt_list(obj, av_log_obj, opt->unit, req_flags, rej_flags);
 493         }
 494     }
 495 }
 496
 497 int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags)
 498 {
 499     if (!obj)
 500         return -1;
 501
 502     av_log(av_log_obj, AV_LOG_INFO, "%s AVOptions:\n", (*(AVClass**)obj)->class_name);
 503
 504     opt_list(obj, av_log_obj, NULL, req_flags, rej_flags);
 505
 506     return 0;
 507 }
 508
 509 void av_opt_set_defaults(void *s)
 510 {
 511     const AVOption *opt = NULL;
 512     while ((opt = av_opt_next(s, opt)) != NULL) {
 513         if (opt->flags & AV_OPT_FLAG_READONLY)
 514             continue;
 515
 516         switch (opt->type) {
 517             case AV_OPT_TYPE_CONST:
 518                 /* Nothing to be done here */
 519             break;
 520             case AV_OPT_TYPE_FLAGS:
 521             case AV_OPT_TYPE_INT:
 522             case AV_OPT_TYPE_INT64:
 523                 av_opt_set_int(s, opt->name, opt->default_val.i64, 0);
 524             break;
 525             case AV_OPT_TYPE_DOUBLE:
 526             case AV_OPT_TYPE_FLOAT: {
 527                 double val;
 528                 val = opt->default_val.dbl;
 529                 av_opt_set_double(s, opt->name, val, 0);
 530             }
 531             break;
 532             case AV_OPT_TYPE_RATIONAL: {
 533                 AVRational val;
 534                 val = av_d2q(opt->default_val.dbl, INT_MAX);
 535                 av_opt_set_q(s, opt->name, val, 0);
 536             }
 537             break;
 538             case AV_OPT_TYPE_STRING:
 539                 av_opt_set(s, opt->name, opt->default_val.str, 0);
 540                 break;
 541             case AV_OPT_TYPE_BINARY:
 542                 /* Cannot set default for binary */
 543             break;
 544             default:
 545                 av_log(s, AV_LOG_DEBUG, "AVOption type %d of option %s not implemented yet\n", opt->type, opt->name);
 546         }
 547     }
 548 }
 549
 550 /**
 551  * Store the value in the field in ctx that is named like key.
 552  * ctx must be an AVClass context, storing is done using AVOptions.
 553  *
 554  * @param buf the string to parse, buf will be updated to point at the
 555  * separator just after the parsed key/value pair
 556  * @param key_val_sep a 0-terminated list of characters used to
 557  * separate key from value
 558  * @param pairs_sep a 0-terminated list of characters used to separate
 559  * two pairs from each other
 560  * @return 0 if the key/value pair has been successfully parsed and
 561  * set, or a negative value corresponding to an AVERROR code in case
 562  * of error:
 563  * AVERROR(EINVAL) if the key/value pair cannot be parsed,
 564  * the error code issued by av_opt_set() if the key/value pair
 565  * cannot be set
 566  */
 567 static int parse_key_value_pair(void *ctx, const char **buf,
 568                                 const char *key_val_sep, const char *pairs_sep)
 569 {
 570     char *key = av_get_token(buf, key_val_sep);
 571     char *val;
 572     int ret;
 573
 574     if (!key)
 575         return AVERROR(ENOMEM);
 576
 577     if (*key && strspn(*buf, key_val_sep)) {
 578         (*buf)++;
 579         val = av_get_token(buf, pairs_sep);
 580         if (!val) {
 581             av_freep(&key);
 582             return AVERROR(ENOMEM);
 583         }
 584     } else {
 585         av_log(ctx, AV_LOG_ERROR, "Missing key or no key/value separator found after key '%s'\n", key);
 586         av_free(key);
 587         return AVERROR(EINVAL);
 588     }
 589
 590     av_log(ctx, AV_LOG_DEBUG, "Setting value '%s' for key '%s'\n", val, key);
 591
 592     ret = av_opt_set(ctx, key, val, AV_OPT_SEARCH_CHILDREN);
 593     if (ret == AVERROR_OPTION_NOT_FOUND)
 594         av_log(ctx, AV_LOG_ERROR, "Key '%s' not found.\n", key);
 595
 596     av_free(key);
 597     av_free(val);
 598     return ret;
 599 }
 600
 601 int av_set_options_string(void *ctx, const char *opts,
 602                           const char *key_val_sep, const char *pairs_sep)
 603 {
 604     int ret, count = 0;
 605
 606     if (!opts)
 607         return 0;
 608
 609     while (*opts) {
 610         if ((ret = parse_key_value_pair(ctx, &opts, key_val_sep, pairs_sep)) < 0)
 611             return ret;
 612         count++;
 613
 614         if (*opts)
 615             opts++;
 616     }
 617
 618     return count;
 619 }
 620
 621 void av_opt_free(void *obj)
 622 {
 623     const AVOption *o = NULL;
 624     while ((o = av_opt_next(obj, o)))
 625         if (o->type == AV_OPT_TYPE_STRING || o->type == AV_OPT_TYPE_BINARY)
 626             av_freep((uint8_t *)obj + o->offset);
 627 }
 628
 629 int av_opt_set_dict(void *obj, AVDictionary **options)
 630 {
 631     AVDictionaryEntry *t = NULL;
 632     AVDictionary    *tmp = NULL;
 633     int ret = 0;
 634
 635     while ((t = av_dict_get(*options, "", t, AV_DICT_IGNORE_SUFFIX))) {
 636         ret = av_opt_set(obj, t->key, t->value, 0);
 637         if (ret == AVERROR_OPTION_NOT_FOUND)
 638             av_dict_set(&tmp, t->key, t->value, 0);
 639         else if (ret < 0) {
 640             av_log(obj, AV_LOG_ERROR, "Error setting option %s to value %s.\n", t->key, t->value);
 641             break;
 642         }
 643         ret = 0;
 644     }
 645     av_dict_free(options);
 646     *options = tmp;
 647     return ret;
 648 }
 649
 650 const AVOption *av_opt_find(void *obj, const char *name, const char *unit,
 651                             int opt_flags, int search_flags)
 652 {
 653     return av_opt_find2(obj, name, unit, opt_flags, search_flags, NULL);
 654 }
 655
 656 const AVOption *av_opt_find2(void *obj, const char *name, const char *unit,
 657                              int opt_flags, int search_flags, void **target_obj)
 658 {
 659     const AVClass  *c = *(AVClass**)obj;
 660     const AVOption *o = NULL;
 661
 662     if (!c)
 663         return NULL;
 664
 665     if (search_flags & AV_OPT_SEARCH_CHILDREN) {
 666         if (search_flags & AV_OPT_SEARCH_FAKE_OBJ) {
 667             const AVClass *child = NULL;
 668             while (child = av_opt_child_class_next(c, child))
 669                 if (o = av_opt_find2(&child, name, unit, opt_flags, search_flags, NULL))
 670                     return o;
 671         } else {
 672             void *child = NULL;
 673             while (child = av_opt_child_next(obj, child))
 674                 if (o = av_opt_find2(child, name, unit, opt_flags, search_flags, target_obj))
 675                     return o;
 676         }
 677     }
 678
 679     while (o = av_opt_next(obj, o)) {
 680         if (!strcmp(o->name, name) && (o->flags & opt_flags) == opt_flags &&
 681             ((!unit && o->type != AV_OPT_TYPE_CONST) ||
 682              (unit  && o->unit && !strcmp(o->unit, unit)))) {
 683             if (target_obj) {
 684                 if (!(search_flags & AV_OPT_SEARCH_FAKE_OBJ))
 685                     *target_obj = obj;
 686                 else
 687                     *target_obj = NULL;
 688             }
 689             return o;
 690         }
 691     }
 692     return NULL;
 693 }
 694
 695 void *av_opt_child_next(void *obj, void *prev)
 696 {
 697     const AVClass *c = *(AVClass**)obj;
 698     if (c->child_next)
 699         return c->child_next(obj, prev);
 700     return NULL;
 701 }
 702
 703 const AVClass *av_opt_child_class_next(const AVClass *parent, const AVClass *prev)
 704 {
 705     if (parent->child_class_next)
 706         return parent->child_class_next(prev);
 707     return NULL;
 708 }
 709
 710 #ifdef TEST
 711
 712 typedef struct TestContext
 713 {
 714     const AVClass *class;
 715     int num;
 716     int toggle;
 717     char *string;
 718     int flags;
 719     AVRational rational;
 720 } TestContext;
 721
 722 #define OFFSET(x) offsetof(TestContext, x)
 723
 724 #define TEST_FLAG_COOL 01
 725 #define TEST_FLAG_LAME 02
 726 #define TEST_FLAG_MU   04
 727
 728 static const AVOption test_options[]= {
 729 {"num",      "set num",        OFFSET(num),      AV_OPT_TYPE_INT,      {.i64 = 0},       0,        100                 },
 730 {"toggle",   "set toggle",     OFFSET(toggle),   AV_OPT_TYPE_INT,      {.i64 = 0},       0,        1                   },
 731 {"rational", "set rational",   OFFSET(rational), AV_OPT_TYPE_RATIONAL, {.dbl = 0},  0,        10                  },
 732 {"string",   "set string",     OFFSET(string),   AV_OPT_TYPE_STRING,   {0},              CHAR_MIN, CHAR_MAX            },
 733 {"flags",    "set flags",      OFFSET(flags),    AV_OPT_TYPE_FLAGS,    {.i64 = 0},       0,        INT_MAX, 0, "flags" },
 734 {"cool",     "set cool flag ", 0,                AV_OPT_TYPE_CONST,    {.i64 = TEST_FLAG_COOL}, INT_MIN,  INT_MAX, 0, "flags" },
 735 {"lame",     "set lame flag ", 0,                AV_OPT_TYPE_CONST,    {.i64 = TEST_FLAG_LAME}, INT_MIN,  INT_MAX, 0, "flags" },
 736 {"mu",       "set mu flag ",   0,                AV_OPT_TYPE_CONST,    {.i64 = TEST_FLAG_MU},   INT_MIN,  INT_MAX, 0, "flags" },
 737 {NULL},
 738 };
 739
 740 static const char *test_get_name(void *ctx)
 741 {
 742     return "test";
 743 }
 744
 745 static const AVClass test_class = {
 746     "TestContext",
 747     test_get_name,
 748     test_options
 749 };
 750
 751 int main(void)
 752 {
 753     int i;
 754
 755     printf("\nTesting av_set_options_string()\n");
 756     {
 757         TestContext test_ctx;
 758         const char *options[] = {
 759             "",
 760             ":",
 761             "=",
 762             "foo=:",
 763             ":=foo",
 764             "=foo",
 765             "foo=",
 766             "foo",
 767             "foo=val",
 768             "foo==val",
 769             "toggle=:",
 770             "string=:",
 771             "toggle=1 : foo",
 772             "toggle=100",
 773             "toggle==1",
 774             "flags=+mu-lame : num=42: toggle=0",
 775             "num=42 : string=blahblah",
 776             "rational=0 : rational=1/2 : rational=1/-1",
 777             "rational=-1/0",
 778         };
 779
 780         test_ctx.class = &test_class;
 781         av_opt_set_defaults(&test_ctx);
 782         test_ctx.string = av_strdup("default");
 783
 784         av_log_set_level(AV_LOG_DEBUG);
 785
 786         for (i=0; i < FF_ARRAY_ELEMS(options); i++) {
 787             av_log(&test_ctx, AV_LOG_DEBUG, "Setting options string '%s'\n", options[i]);
 788             if (av_set_options_string(&test_ctx, options[i], "=", ":") < 0)
 789                 av_log(&test_ctx, AV_LOG_ERROR, "Error setting options string: '%s'\n", options[i]);
 790             printf("\n");
 791         }
 792     }
 793
 794     return 0;
 795 }
 796
 797 #endif