ffmpeg.libavutil.opt

Undocumented in source.

Members

Enums

AVOptionType
enum AVOptionType

@defgroup avoptions AVOptions @ingroup lavu_data @{ AVOptions provide a generic system to declare options on arbitrary structs ("objects"). An option can have a help text, a type and a range of possible values. Options may then be enumerated, read and written to.

Functions

av_opt_child_class_next
AVClass* av_opt_child_class_next(AVClass* parent, AVClass* prev)

Iterate over potential AVOptions-enabled children of parent.

av_opt_child_next
void* av_opt_child_next(void* obj, void* prev)

Iterate over AVOptions-enabled children of obj.

av_opt_copy
int av_opt_copy(void* dest, void* src)

Copy options from src object into dest object.

av_opt_eval_double
int av_opt_eval_double(void* obj, AVOption* o, char* val, double* double_out)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_eval_flags
int av_opt_eval_flags(void* obj, AVOption* o, char* val, int* flags_out)

@defgroup opt_eval_funcs Evaluating option strings @{ This group of functions can be used to evaluate option strings and get numbers out of them. They do the same thing as av_opt_set(), except the result is written into the caller-supplied pointer.

av_opt_eval_float
int av_opt_eval_float(void* obj, AVOption* o, char* val, float* float_out)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_eval_int
int av_opt_eval_int(void* obj, AVOption* o, char* val, int* int_out)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_eval_int64
int av_opt_eval_int64(void* obj, AVOption* o, char* val, int64_t* int64_out)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_eval_q
int av_opt_eval_q(void* obj, AVOption* o, char* val, AVRational* q_out)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_find
AVOption* av_opt_find(void* obj, char* name, char* unit, int opt_flags, int search_flags)

Look for an option in an object. Consider only options which have all the specified flags set.

av_opt_find2
AVOption* av_opt_find2(void* obj, char* name, char* unit, int opt_flags, int search_flags, void** target_obj)

Look for an option in an object. Consider only options which have all the specified flags set.

av_opt_flag_is_set
int av_opt_flag_is_set(void* obj, char* field_name, char* flag_name)

Check whether a particular flag is set in a flags field.

av_opt_free
void av_opt_free(void* obj)

Free all string and binary options in obj.

av_opt_freep_ranges
void av_opt_freep_ranges(AVOptionRanges** ranges)

Free an AVOptionRanges struct and set it to NULL.

av_opt_get
int av_opt_get(void* obj, char* name, int search_flags, uint8_t** out_val)

@note the returned string will be av_malloc()ed and must be av_free()ed by the caller

av_opt_get_channel_layout
int av_opt_get_channel_layout(void* obj, char* name, int search_flags, int64_t* ch_layout)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_get_dict_val
int av_opt_get_dict_val(void* obj, char* name, int search_flags, AVDictionary** out_val)

@paramout out_val The returned dictionary is a copy of the actual value and must be freed with av_dict_free() by the caller

av_opt_get_double
int av_opt_get_double(void* obj, char* name, int search_flags, double* out_val)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_get_image_size
int av_opt_get_image_size(void* obj, char* name, int search_flags, int* w_out, int* h_out)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_get_int
int av_opt_get_int(void* obj, char* name, int search_flags, int64_t* out_val)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_get_key_value
int av_opt_get_key_value(char** ropts, char* key_val_sep, char* pairs_sep, uint flags, char** rkey, char** rval)

Extract a key-value pair from the beginning of a string.

av_opt_get_pixel_fmt
int av_opt_get_pixel_fmt(void* obj, char* name, int search_flags, AVPixelFormat* out_fmt)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_get_q
int av_opt_get_q(void* obj, char* name, int search_flags, AVRational* out_val)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_get_sample_fmt
int av_opt_get_sample_fmt(void* obj, char* name, int search_flags, AVSampleFormat* out_fmt)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_get_video_rate
int av_opt_get_video_rate(void* obj, char* name, int search_flags, AVRational* out_val)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_is_set_to_default
int av_opt_is_set_to_default(void* obj, AVOption* o)

Check if given option is set to its default value.

av_opt_is_set_to_default_by_name
int av_opt_is_set_to_default_by_name(void* obj, char* name, int search_flags)

Check if given option is set to its default value.

av_opt_next
AVOption* av_opt_next(void* obj, AVOption* prev)

Iterate over all AVOptions belonging to obj.

av_opt_ptr
void* av_opt_ptr(AVClass* avclass, void* obj, char* name)

Gets a pointer to the requested field in a struct. This function allows accessing a struct even when its fields are moved or renamed since the application making the access has been compiled,

av_opt_query_ranges
int av_opt_query_ranges(AVOptionRanges** , void* obj, char* key, int flags)

Get a list of allowed ranges for the given option.

av_opt_query_ranges_default
int av_opt_query_ranges_default(AVOptionRanges** , void* obj, char* key, int flags)

Get a default list of allowed ranges for the given option.

av_opt_serialize
int av_opt_serialize(void* obj, int opt_flags, int flags, char** buffer, char key_val_sep, char pairs_sep)

Serialize object's options.

av_opt_set
int av_opt_set(void* obj, char* name, char* val, int search_flags)

@defgroup opt_set_funcs Option setting functions @{ Those functions set the field of obj with the given name to value.

av_opt_set_bin
int av_opt_set_bin(void* obj, char* name, uint8_t* val, int size, int search_flags)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_set_channel_layout
int av_opt_set_channel_layout(void* obj, char* name, int64_t ch_layout, int search_flags)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_set_defaults
void av_opt_set_defaults(void* s)

Set the values of all AVOption fields to their default values.

av_opt_set_defaults2
void av_opt_set_defaults2(void* s, int mask, int flags)

Set the values of all AVOption fields to their default values. Only these AVOption fields for which (opt->flags & mask) == flags will have their default applied to s.

av_opt_set_dict
int av_opt_set_dict(void* obj, AVDictionary** options)

Set all the options from a given dictionary on an object.

av_opt_set_dict2
int av_opt_set_dict2(void* obj, AVDictionary** options, int search_flags)

Set all the options from a given dictionary on an object.

av_opt_set_dict_val
int av_opt_set_dict_val(void* obj, char* name, AVDictionary* val, int search_flags)

@note Any old dictionary present is discarded and replaced with a copy of the new one. The caller still owns val is and responsible for freeing it.

av_opt_set_double
int av_opt_set_double(void* obj, char* name, double val, int search_flags)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_set_from_string
int av_opt_set_from_string(void* ctx, char* opts, char** shorthand, char* key_val_sep, char* pairs_sep)

Parse the key-value pairs list in opts. For each key=value pair found, set the value of the corresponding option in ctx.

av_opt_set_image_size
int av_opt_set_image_size(void* obj, char* name, int w, int h, int search_flags)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_set_int
int av_opt_set_int(void* obj, char* name, int64_t val, int search_flags)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_set_pixel_fmt
int av_opt_set_pixel_fmt(void* obj, char* name, AVPixelFormat fmt, int search_flags)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_set_q
int av_opt_set_q(void* obj, char* name, AVRational val, int search_flags)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_set_sample_fmt
int av_opt_set_sample_fmt(void* obj, char* name, AVSampleFormat fmt, int search_flags)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_set_video_rate
int av_opt_set_video_rate(void* obj, char* name, AVRational val, int search_flags)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_opt_show2
int av_opt_show2(void* obj, void* av_log_obj, int req_flags, int rej_flags)

Show the obj options.

av_set_options_string
int av_set_options_string(void* ctx, char* opts, char* key_val_sep, char* pairs_sep)

Parse the key/value pairs list in opts. For each key/value pair found, stores the value in the field in ctx that is named like the key. ctx must be an AVClass context, storing is done using AVOptions.

Manifest constants

AV_OPT_ALLOW_NULL
enum AV_OPT_ALLOW_NULL;

In av_opt_get, return NULL if the option has a pointer type and is set to NULL, rather than returning an empty string.

AV_OPT_FLAG_IMPLICIT_KEY
enum AV_OPT_FLAG_IMPLICIT_KEY;

Accept to parse a value without a key; the key will then be returned as NULL.

AV_OPT_MULTI_COMPONENT_RANGE
enum AV_OPT_MULTI_COMPONENT_RANGE;

Allows av_opt_query_ranges and av_opt_query_ranges_default to return more than one component for certain option types. @see AVOptionRanges for details.

AV_OPT_SEARCH_CHILDREN
enum AV_OPT_SEARCH_CHILDREN;

* @} *//**< Search in possible children of the given object first.

AV_OPT_SEARCH_FAKE_OBJ
enum AV_OPT_SEARCH_FAKE_OBJ;

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. This is useful for searching for options without needing to allocate the corresponding object.

AV_OPT_SERIALIZE_OPT_FLAGS_EXACT
enum AV_OPT_SERIALIZE_OPT_FLAGS_EXACT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
AV_OPT_SERIALIZE_SKIP_DEFAULTS
enum AV_OPT_SERIALIZE_SKIP_DEFAULTS;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Structs

AVOption
struct AVOption
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
AVOptionRange
struct AVOptionRange

A single allowed range of values, or a single allowed value.

AVOptionRanges
struct AVOptionRanges

List of AVOptionRange structs

Variables

AV_OPT_FLAG_AUDIO_PARAM
uint AV_OPT_FLAG_AUDIO_PARAM;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
AV_OPT_FLAG_DECODING_PARAM
uint AV_OPT_FLAG_DECODING_PARAM;

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

AV_OPT_FLAG_ENCODING_PARAM
uint AV_OPT_FLAG_ENCODING_PARAM;

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

AV_OPT_FLAG_EXPORT
uint AV_OPT_FLAG_EXPORT;

The option is inteded for exporting values to the caller.

AV_OPT_FLAG_FILTERING_PARA
uint AV_OPT_FLAG_FILTERING_PARA;

< a generic parameter which can be set by the user for filtering

AV_OPT_FLAG_METADATA
uint AV_OPT_FLAG_METADATA;

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

AV_OPT_FLAG_READONLY
uint AV_OPT_FLAG_READONLY;

The option may not be set through the AVOptions API, only read. This flag only makes sense when AV_OPT_FLAG_EXPORT is also set.

AV_OPT_FLAG_SUBTITLE_PARAM
uint AV_OPT_FLAG_SUBTITLE_PARAM;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
AV_OPT_FLAG_VIDEO_PARAM
uint AV_OPT_FLAG_VIDEO_PARAM;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Meta