Loading...
Searching...
No Matches
opt.h File Reference

AVOptions. More...

`#include "rational.h"`
`#include "avutil.h"`
`#include "channel_layout.h"`
`#include "dict.h"`
`#include "log.h"`
`#include "pixfmt.h"`
`#include "samplefmt.h"`

Go to the source code of this file.

## Data Structures

struct | AVOptionArrayDef
| May be set as default_val for AV_OPT_TYPE_FLAG_ARRAY options. More...
struct | AVOption
| AVOption. More...
struct | AVOptionRange
| A single allowed range of values, or a single allowed value. More...
struct | AVOptionRanges
| List of AVOptionRange structs. More...

## Macros

#define | AV_OPT_FLAG_ENCODING_PARAM (1 << 0)
| A generic parameter which can be set by the user for muxing or encoding.
#define | AV_OPT_FLAG_DECODING_PARAM (1 << 1)
| A generic parameter which can be set by the user for demuxing or decoding.
#define | AV_OPT_FLAG_AUDIO_PARAM (1 << 3)
#define | AV_OPT_FLAG_VIDEO_PARAM (1 << 4)
#define | AV_OPT_FLAG_SUBTITLE_PARAM (1 << 5)
#define | AV_OPT_FLAG_EXPORT (1 << 6)
| The option is intended for exporting values to the caller.
#define | AV_OPT_FLAG_READONLY (1 << 7)
| The option may not be set through the AVOptions API, only read.
#define | AV_OPT_FLAG_BSF_PARAM (1 << 8)
| A generic parameter which can be set by the user for bit stream filtering.
#define | AV_OPT_FLAG_RUNTIME_PARAM (1 << 15)
| A generic parameter which can be set by the user at runtime.
#define | AV_OPT_FLAG_FILTERING_PARAM (1 << 16)
| A generic parameter which can be set by the user for filtering.
#define | AV_OPT_FLAG_DEPRECATED (1 << 17)
| Set if option is deprecated, users should refer to AVOption.help text for more information.
#define | AV_OPT_FLAG_CHILD_CONSTS (1 << 18)
| Set if option constants can also reside in child objects.
#define | AV_OPT_SEARCH_CHILDREN (1 << 0)
| Search in possible children of the given object first.
#define | AV_OPT_SEARCH_FAKE_OBJ (1 << 1)
| 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.
#define | AV_OPT_ALLOW_NULL (1 << 2)
| In av_opt_get, return NULL if the option has a pointer type and is set to NULL, rather than returning an empty string.
#define | AV_OPT_ARRAY_REPLACE (1 << 3)
| May be used with av_opt_set_array() to signal that new elements should replace the existing ones in the indicated range.
#define | AV_OPT_MULTI_COMPONENT_RANGE (1 << 12)
| Allows av_opt_query_ranges and av_opt_query_ranges_default to return more than one component for certain option types.
#define | AV_OPT_SERIALIZE_SKIP_DEFAULTS 0x00000001
| Serialize options that are not set to default values only.
#define | AV_OPT_SERIALIZE_OPT_FLAGS_EXACT 0x00000002
| Serialize options that exactly match opt_flags only.
#define | AV_OPT_SERIALIZE_SEARCH_CHILDREN 0x00000004
| Serialize options in possible children of the given object.

## Enumerations

enum

AVOptionType {
AV_OPT_TYPE_FLAGS = 1 , 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_DICT , AV_OPT_TYPE_UINT64 , AV_OPT_TYPE_CONST , AV_OPT_TYPE_IMAGE_SIZE ,
AV_OPT_TYPE_PIXEL_FMT , AV_OPT_TYPE_SAMPLE_FMT , AV_OPT_TYPE_VIDEO_RATE , AV_OPT_TYPE_DURATION ,
AV_OPT_TYPE_COLOR , AV_OPT_TYPE_BOOL , AV_OPT_TYPE_CHLAYOUT , AV_OPT_TYPE_UINT ,
AV_OPT_TYPE_FLAG_ARRAY = (1 << 16)
}

| An option type determines: More...
enum | { AV_OPT_FLAG_IMPLICIT_KEY = 1 }

## Functions

void | av_opt_set_defaults (void *s)
| Set the values of all AVOption fields to their default values.
void | av_opt_set_defaults2 (void *s, int mask, int flags)
| Set the values of all AVOption fields to their default values.
void | av_opt_free (void *obj)
| Free all allocated objects in obj.
const AVOption * | av_opt_next (const 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 AVClass * | av_opt_child_class_iterate (const AVClass *parent, void **iter)
| Iterate over potential AVOptions-enabled children of parent.
const AVOption * | av_opt_find (void *obj, const char *name, const char *unit, int opt_flags, int search_flags)
| Look for an option in an object.
const AVOption * | av_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.
int | av_opt_show2 (void *obj, void *av_log_obj, int req_flags, int rej_flags)
| Show the obj options.
int | av_opt_get_key_value (const char **ropts, const char *key_val_sep, const char *pairs_sep, unsigned flags, char **rkey, char **rval)
| Extract a key-value pair from the beginning of a string.
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.
int | av_opt_set_from_string (void *ctx, const char *opts, const char *const *shorthand, const char *key_val_sep, const char *pairs_sep)
| Parse the key-value pairs list in opts.
int | av_opt_set_dict (void *obj, struct AVDictionary **options)
| Set all the options from a given dictionary on an object.
int | av_opt_set_dict2 (void *obj, struct AVDictionary **options, int search_flags)
| Set all the options from a given dictionary on an object.
int | av_opt_copy (void *dest, const void *src)
| Copy options from src object into dest object.
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_set_bin (void *obj, const char *name, const uint8_t *val, int size, int search_flags)
int | av_opt_set_image_size (void *obj, const char *name, int w, int h, int search_flags)
int | av_opt_set_pixel_fmt (void *obj, const char *name, enum AVPixelFormat fmt, int search_flags)
int | av_opt_set_sample_fmt (void *obj, const char *name, enum AVSampleFormat fmt, int search_flags)
int | av_opt_set_video_rate (void *obj, const char *name, AVRational val, int search_flags)
int | av_opt_set_chlayout (void *obj, const char *name, const AVChannelLayout *layout, int search_flags)
int | av_opt_set_dict_val (void *obj, const char *name, const AVDictionary *val, int search_flags)
int | av_opt_set_array (void *obj, const char *name, int search_flags, unsigned int start_elem, unsigned int nb_elems, enum AVOptionType val_type, const void *val)
| Add, replace, or remove elements for an array option.
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)
int | av_opt_get_image_size (void *obj, const char *name, int search_flags, int *w_out, int *h_out)
int | av_opt_get_pixel_fmt (void *obj, const char *name, int search_flags, enum AVPixelFormat *out_fmt)
int | av_opt_get_sample_fmt (void *obj, const char *name, int search_flags, enum AVSampleFormat *out_fmt)
int | av_opt_get_video_rate (void *obj, const char *name, int search_flags, AVRational *out_val)
int | av_opt_get_chlayout (void *obj, const char *name, int search_flags, AVChannelLayout *layout)
int | av_opt_get_dict_val (void *obj, const char *name, int search_flags, AVDictionary **out_val)
int | av_opt_get_array_size (void *obj, const char *name, int search_flags, unsigned int *out_val)
| For an array-type option, get the number of elements in the array.
int | av_opt_get_array (void *obj, const char *name, int search_flags, unsigned int start_elem, unsigned int nb_elems, enum AVOptionType out_type, void *out_val)
| For an array-type option, retrieve the values of one or more array elements.
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_uint (void *obj, const AVOption *o, const char *val, unsigned *uint_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)
int | av_opt_is_set_to_default (void *obj, const AVOption *o)
| Check if given option is set to its default value.
int | av_opt_is_set_to_default_by_name (void *obj, const char *name, int search_flags)
| Check if given option is set to its default value.
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_serialize (void *obj, int opt_flags, int flags, char **buffer, const char key_val_sep, const char pairs_sep)
| Serialize object's options.
void | av_opt_freep_ranges (AVOptionRanges **ranges)
| Free an AVOptionRanges struct and set it to NULL.
int | av_opt_query_ranges (AVOptionRanges **, void *obj, const char *key, int flags)
| Get a list of allowed ranges for the given option.
int | av_opt_query_ranges_default (AVOptionRanges **, void *obj, const char *key, int flags)
| Get a default list of allowed ranges for the given option.

## Detailed Description

AVOptions.

Definition in file opt.h.