libavutil/opt.h File Reference

AVOptions. More...

#include "rational.h"
#include "avutil.h"
#include "dict.h"
#include "log.h"

Go to the source code of this file.

Data Structures

struct  AVOption
 AVOption. More...

Defines

#define AV_OPT_FLAG_ENCODING_PARAM   1
 a generic parameter which can be set by the user for muxing or encoding
#define AV_OPT_FLAG_DECODING_PARAM   2
 a generic parameter which can be set by the user for demuxing or decoding
#define AV_OPT_FLAG_METADATA   4
 some data extracted or inserted into the file like title, comment, ...
#define AV_OPT_FLAG_AUDIO_PARAM   8
#define AV_OPT_FLAG_VIDEO_PARAM   16
#define AV_OPT_FLAG_SUBTITLE_PARAM   32
#define AV_OPT_SEARCH_CHILDREN   0x0001
 Search in possible children of the given object first.
#define AV_OPT_SEARCH_FAKE_OBJ   0x0002
 The obj passed to av_opt_find() is fake -- only a double pointer to AVClass instead of a required pointer to a struct containing AVClass.

Enumerations

enum  AVOptionType {
  AV_OPT_TYPE_FLAGS, AV_OPT_TYPE_INT, AV_OPT_TYPE_INT64, AV_OPT_TYPE_DOUBLE,
  AV_OPT_TYPE_FLOAT, AV_OPT_TYPE_STRING, AV_OPT_TYPE_RATIONAL, AV_OPT_TYPE_BINARY,
  AV_OPT_TYPE_CONST = 128, FF_OPT_TYPE_FLAGS = 0, FF_OPT_TYPE_INT, FF_OPT_TYPE_INT64,
  FF_OPT_TYPE_DOUBLE, FF_OPT_TYPE_FLOAT, FF_OPT_TYPE_STRING, FF_OPT_TYPE_RATIONAL,
  FF_OPT_TYPE_BINARY, FF_OPT_TYPE_CONST = 128
}

Functions

attribute_deprecated const
AVOption
av_find_opt (void *obj, const char *name, const char *unit, int mask, int flags)
 Look for an option in obj.
attribute_deprecated int av_set_string3 (void *obj, const char *name, const char *val, int alloc, const AVOption **o_out)
 Set the field of obj with the given name to value.
attribute_deprecated const
AVOption
av_set_double (void *obj, const char *name, double n)
attribute_deprecated const
AVOption
av_set_q (void *obj, const char *name, AVRational n)
attribute_deprecated const
AVOption
av_set_int (void *obj, const char *name, int64_t n)
double av_get_double (void *obj, const char *name, const AVOption **o_out)
AVRational av_get_q (void *obj, const char *name, const AVOption **o_out)
int64_t av_get_int (void *obj, const char *name, const AVOption **o_out)
attribute_deprecated const char * av_get_string (void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len)
attribute_deprecated const
AVOption
av_next_option (void *obj, const AVOption *last)
int av_opt_show2 (void *obj, void *av_log_obj, int req_flags, int rej_flags)
 Show the obj options.
void av_opt_set_defaults (void *s)
 Set the values of all AVOption fields to their default values.
attribute_deprecated void av_opt_set_defaults2 (void *s, int mask, int flags)
int av_set_options_string (void *ctx, const char *opts, const char *key_val_sep, const char *pairs_sep)
 Parse the key/value pairs list in opts.
void av_opt_free (void *obj)
 Free all string and binary options in obj.
int av_opt_flag_is_set (void *obj, const char *field_name, const char *flag_name)
 Check whether a particular flag is set in a flags field.
int av_opt_set_dict (void *obj, struct AVDictionary **options)
int av_opt_eval_flags (void *obj, const AVOption *o, const char *val, int *flags_out)
int av_opt_eval_int (void *obj, const AVOption *o, const char *val, int *int_out)
int av_opt_eval_int64 (void *obj, const AVOption *o, const char *val, int64_t *int64_out)
int av_opt_eval_float (void *obj, const AVOption *o, const char *val, float *float_out)
int av_opt_eval_double (void *obj, const AVOption *o, const char *val, double *double_out)
int av_opt_eval_q (void *obj, const AVOption *o, const char *val, AVRational *q_out)
const AVOptionav_opt_find (void *obj, const char *name, const char *unit, int opt_flags, int search_flags)
 Look for an option in an object.
const AVOptionav_opt_find2 (void *obj, const char *name, const char *unit, int opt_flags, int search_flags, void **target_obj)
 Look for an option in an object.
const AVOptionav_opt_next (void *obj, const AVOption *prev)
 Iterate over all AVOptions belonging to obj.
void * av_opt_child_next (void *obj, void *prev)
 Iterate over AVOptions-enabled children of obj.
const AVClassav_opt_child_class_next (const AVClass *parent, const AVClass *prev)
 Iterate over potential AVOptions-enabled children of parent.
int av_opt_set (void *obj, const char *name, const char *val, int search_flags)
int av_opt_set_int (void *obj, const char *name, int64_t val, int search_flags)
int av_opt_set_double (void *obj, const char *name, double val, int search_flags)
int av_opt_set_q (void *obj, const char *name, AVRational val, int search_flags)
int av_opt_get (void *obj, const char *name, int search_flags, uint8_t **out_val)
int av_opt_get_int (void *obj, const char *name, int search_flags, int64_t *out_val)
int av_opt_get_double (void *obj, const char *name, int search_flags, double *out_val)
int av_opt_get_q (void *obj, const char *name, int search_flags, AVRational *out_val)
void * av_opt_ptr (const AVClass *avclass, void *obj, const char *name)
 Gets a pointer to the requested field in a struct.


Detailed Description

AVOptions.

Definition in file opt.h.


Define Documentation

#define AV_OPT_FLAG_AUDIO_PARAM   8

Definition at line 277 of file opt.h.

Referenced by avcodec_get_context_defaults3(), filter_codec_opts(), opt_list(), and parse_ffconfig().

#define AV_OPT_FLAG_DECODING_PARAM   2

a generic parameter which can be set by the user for demuxing or decoding

Definition at line 275 of file opt.h.

Referenced by filter_codec_opts(), opt_help(), and opt_list().

#define AV_OPT_FLAG_ENCODING_PARAM   1

a generic parameter which can be set by the user for muxing or encoding

Definition at line 274 of file opt.h.

Referenced by filter_codec_opts(), opt_help(), opt_list(), parse_ffconfig(), and print_option().

#define AV_OPT_FLAG_METADATA   4

some data extracted or inserted into the file like title, comment, ...

Definition at line 276 of file opt.h.

#define AV_OPT_FLAG_SUBTITLE_PARAM   32

Definition at line 279 of file opt.h.

Referenced by avcodec_get_context_defaults3(), filter_codec_opts(), and opt_list().

#define AV_OPT_FLAG_VIDEO_PARAM   16

Definition at line 278 of file opt.h.

Referenced by avcodec_get_context_defaults3(), filter_codec_opts(), opt_list(), and parse_ffconfig().


Generated on Fri Oct 26 02:43:49 2012 for FFmpeg by  doxygen 1.5.8