opt.h
上传用户:jylinhe
上传日期:2022-07-11
资源大小:334k
文件大小:6k
源码类别:

多媒体编程

开发平台:

Visual 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. #ifndef AVCODEC_OPT_H
  22. #define AVCODEC_OPT_H
  23. /**
  24.  * @file opt.h
  25.  * AVOptions
  26.  */
  27. //#include "rational.h"
  28. //#include "avcodec.h"
  29. enum AVOptionType{
  30.     FF_OPT_TYPE_FLAGS,
  31.     FF_OPT_TYPE_INT,
  32.     FF_OPT_TYPE_INT64,
  33.     FF_OPT_TYPE_DOUBLE,
  34.     FF_OPT_TYPE_FLOAT,
  35.     FF_OPT_TYPE_STRING,
  36.     FF_OPT_TYPE_RATIONAL,
  37.     FF_OPT_TYPE_BINARY,  ///< offset must point to a pointer immediately followed by an int for the length
  38.     FF_OPT_TYPE_CONST=128,
  39. };
  40. /**
  41.  * AVOption
  42.  */
  43. typedef struct AVOption {
  44.     const char *name;
  45.     /**
  46.      * short English help text
  47.      * @todo What about other languages?
  48.      */
  49.     const char *help;
  50.     /**
  51.      * The offset relative to the context structure where the option
  52.      * value is stored. It should be 0 for named constants.
  53.      */
  54.     int offset;
  55.     enum AVOptionType type;
  56.     /**
  57.      * the default value for scalar options
  58.      */
  59.     double default_val;
  60.     double min;                 ///< minimum valid value for the option
  61.     double max;                 ///< maximum valid value for the option
  62.     int flags;
  63. #define AV_OPT_FLAG_ENCODING_PARAM  1   ///< a generic parameter which can be set by the user for muxing or encoding
  64. #define AV_OPT_FLAG_DECODING_PARAM  2   ///< a generic parameter which can be set by the user for demuxing or decoding
  65. #define AV_OPT_FLAG_METADATA        4   ///< some data extracted or inserted into the file like title, comment, ...
  66. #define AV_OPT_FLAG_AUDIO_PARAM     8
  67. #define AV_OPT_FLAG_VIDEO_PARAM     16
  68. #define AV_OPT_FLAG_SUBTITLE_PARAM  32
  69. //FIXME think about enc-audio, ... style flags
  70.     /**
  71.      * The logical unit to which the option belongs. Non-constant
  72.      * options and corresponding named constants share the same
  73.      * unit. May be NULL.
  74.      */
  75.     const char *unit;
  76. } AVOption;
  77. /**
  78.  * Looks for an option in p obj. Looks only for the options which
  79.  * have the flags set as specified in p mask and p flags (that is,
  80.  * for which it is the case that opt->flags & mask == flags).
  81.  *
  82.  * @param[in] obj a pointer to a struct whose first element is a
  83.  * pointer to an AVClass
  84.  * @param[in] name the name of the option to look for
  85.  * @param[in] unit the unit of the option to look for, or any if NULL
  86.  * @return a pointer to the option found, or NULL if no option
  87.  * has been found
  88.  */
  89. const AVOption *av_find_opt(void *obj, const char *name, const char *unit, int mask, int flags);
  90. #if LIBAVCODEC_VERSION_MAJOR < 53
  91. /**
  92.  * @see av_set_string2()
  93.  */
  94. attribute_deprecated const AVOption *av_set_string(void *obj, const char *name, const char *val);
  95. /**
  96.  * @return a pointer to the AVOption corresponding to the field set or
  97.  * NULL if no matching AVOption exists, or if the value p val is not
  98.  * valid
  99.  * @see av_set_string3()
  100.  */
  101. attribute_deprecated const AVOption *av_set_string2(void *obj, const char *name, const char *val, int alloc);
  102. #endif
  103. /**
  104.  * Sets the field of obj with the given name to value.
  105.  *
  106.  * @param[in] obj A struct whose first element is a pointer to an
  107.  * AVClass.
  108.  * @param[in] name the name of the field to set
  109.  * @param[in] val The value to set. If the field is not of a string
  110.  * type, then the given string is parsed.
  111.  * SI postfixes and some named scalars are supported.
  112.  * If the field is of a numeric type, it has to be a numeric or named
  113.  * scalar. Behavior with more than one scalar and +- infix operators
  114.  * is undefined.
  115.  * If the field is of a flags type, it has to be a sequence of numeric
  116.  * scalars or named flags separated by '+' or '-'. Prefixing a flag
  117.  * with '+' causes it to be set without affecting the other flags;
  118.  * similarly, '-' unsets a flag.
  119.  * @param[out] o_out if non-NULL put here a pointer to the AVOption
  120.  * found
  121.  * @param alloc when 1 then the old value will be av_freed() and the
  122.  *                     new av_strduped()
  123.  *              when 0 then no av_free() nor av_strdup() will be used
  124.  * @return 0 if the value has been set, an AVERROR* error code if no
  125.  * matching option exists, or if the value p val is not valid
  126.  */
  127. int av_set_string3(void *obj, const char *name, const char *val, int alloc, const AVOption **o_out);
  128. const AVOption *av_set_double(void *obj, const char *name, double n);
  129. const AVOption *av_set_q(void *obj, const char *name, AVRational n);
  130. const AVOption *av_set_int(void *obj, const char *name, int64_t n);
  131. double av_get_double(void *obj, const char *name, const AVOption **o_out);
  132. AVRational av_get_q(void *obj, const char *name, const AVOption **o_out);
  133. int64_t av_get_int(void *obj, const char *name, const AVOption **o_out);
  134. const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len);
  135. const AVOption *av_next_option(void *obj, const AVOption *last);
  136. int av_opt_show(void *obj, void *av_log_obj);
  137. void av_opt_set_defaults(void *s);
  138. void av_opt_set_defaults2(void *s, int mask, int flags);
  139. #endif /* AVCODEC_OPT_H */