Search in possible children of the given object first.

Examples

avio_http_serve_files.c, decode_filter_audio.c, decode_filter_video.c, filter_audio.c, and transcode.c.

Definition at line 605 of file opt.h.

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.

Definition at line 613 of file opt.h.

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

Definition at line 619 of file opt.h.

May be used with av_opt_set_array() to signal that new elements should replace the existing ones in the indicated range.

Definition at line 625 of file opt.h.

Allows av_opt_query_ranges and av_opt_query_ranges_default to return more than one component for certain option types.

See also

AVOptionRanges for details.

Definition at line 632 of file opt.h.

Definition at line 718 of file opt.h.

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

Parameters

s an AVOption-enabled struct (its first member must be a pointer to AVClass)

Definition at line 1678 of file opt.c.

Referenced by av_bsf_alloc(), av_iamf_audio_element_alloc(), av_iamf_mix_presentation_alloc(), av_iamf_param_definition_alloc(), avcodec_dct_alloc(), avcodec_open2(), avfilter_graph_alloc(), avformat_alloc_context(), avformat_alloc_output_context2(), avformat_open_input(), avformat_stream_group_create(), avtext_context_open(), avtextwriter_context_open(), ff_alloc_input_device_context(), ff_filter_alloc(), ff_framesync_preinit(), init(), init_context_defaults(), init_muxer(), main(), swr_alloc(), sws_alloc_context(), and url_alloc_for_protocol().

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.

Parameters

s an AVOption-enabled struct (its first member must be a pointer to AVClass)

mask combination of AV_OPT_FLAG_*

flags combination of AV_OPT_FLAG_*

Definition at line 1683 of file opt.c.

Referenced by av_opt_set_defaults(), and init_context_defaults().

Free all allocated objects in obj.

Definition at line 1949 of file opt.c.

Referenced by av_bsf_free(), av_iamf_audio_element_free(), av_iamf_mix_presentation_free(), av_write_trailer(), avfilter_free(), avfilter_graph_free(), avformat_free_context(), avio_close(), avtext_context_close(), avtextwriter_context_close(), close(), command(), ff_codec_close(), ff_frame_thread_free(), ff_free_stream_group(), ffurl_closep(), and main().

Iterate over all AVOptions belonging to obj.

Parameters

obj an AVOptions-enabled struct or a double pointer to an AVClass describing it.

prev result of the previous call to av_opt_next() on this object or NULL

Returns

next AVOption or NULL

Definition at line 48 of file opt.c.

Referenced by av_opt_copy(), av_opt_find2(), av_opt_free(), av_opt_set_defaults2(), bsf_list_append_internal(), ff_filter_opt_parse(), get_opt_const_name(), get_opt_flags_string(), main(), opt_list(), opt_serialize(), print_option(), print_private_data(), set_string_number(), and show_opts().

Iterate over AVOptions-enabled children of obj.

Parameters

prev result of a previous call to this function or NULL

Returns

next AVOptions-enabled child or NULL

Definition at line 2042 of file opt.c.

Referenced by av_opt_find2(), and opt_serialize().

Iterate over potential AVOptions-enabled children of parent.

Parameters

iter a pointer where iteration state is stored.

Returns

AVClass corresponding to next potential child or NULL

Definition at line 2050 of file opt.c.

Referenced by av_opt_find2(), and show_help_children().

Look for an option in an object.

Consider only options which have all the specified flags set.

Parameters

[in] obj A pointer to a struct whose first element is a pointer to an AVClass. Alternatively a double pointer to an AVClass, if AV_OPT_SEARCH_FAKE_OBJ search flag is set.

[in] name The name of the option to look for.

[in] unit When searching for named constants, name of the unit it belongs to.

opt_flags Find only options with all the specified flags set (AV_OPT_FLAG).

search_flags A combination of AV_OPT_SEARCH_*.

Returns

A pointer to the option found, or NULL if no option was found.

Note

Options found with AV_OPT_SEARCH_CHILDREN flag may not be settable directly with av_opt_set(). Use special calls which take an options AVDictionary (e.g. avformat_open_input()) to set options found with this flag.

Definition at line 1991 of file opt.c.

Referenced by av_opt_flag_is_set(), av_opt_query_ranges_default(), check_avoptions_used(), check_opt_bitexact(), filter_codec_opts(), filter_opt_apply(), find_opt(), ifile_open(), main(), opt_find(), set_string_number(), and stream_specifier_parse().

Look for an option in an object.

Consider only options which have all the specified flags set.

Parameters

[in] obj A pointer to a struct whose first element is a pointer to an AVClass. Alternatively a double pointer to an AVClass, if AV_OPT_SEARCH_FAKE_OBJ search flag is set.

[in] name The name of the option to look for.

[in] unit When searching for named constants, name of the unit it belongs to.

opt_flags Find only options with all the specified flags set (AV_OPT_FLAG).

search_flags A combination of AV_OPT_SEARCH_*.

[out] target_obj if non-NULL, an object to which the option belongs will be written here. It may be different from obj if AV_OPT_SEARCH_CHILDREN is present in search_flags. This parameter is ignored if search_flags contain AV_OPT_SEARCH_FAKE_OBJ.

Returns

A pointer to the option found, or NULL if no option was found.

Definition at line 1997 of file opt.c.

Referenced by av_opt_find(), av_opt_find2(), av_opt_get(), av_opt_get_array(), av_opt_get_array_size(), av_opt_get_chlayout(), av_opt_get_dict_val(), av_opt_get_image_size(), av_opt_is_set_to_default_by_name(), av_opt_ptr(), ff_filter_process_command(), get_format(), get_number(), main(), and opt_set_init().

Show the obj options.

Parameters

req_flags requested flags for the options to show. Show only the options for which it is opt->flags & req_flags.

rej_flags rejected flags for the options to show. Show only the options for which it is !(opt->flags & req_flags).

av_log_obj log context to use for showing the options

Definition at line 1666 of file opt.c.

Referenced by main(), and show_help_children().

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

Parameters

ropts pointer to the options string, will be updated to point to the rest of the string (one of the pairs_sep or the final NUL)

key_val_sep a 0-terminated list of characters used to separate key from value, for example '='

pairs_sep a 0-terminated list of characters used to separate two pairs from each other, for example ':' or ','

flags flags; see the AV_OPT_FLAG_* values below

rkey parsed key; must be freed using av_free()

rval parsed value; must be freed using av_free()

Returns

>=0 for success, or a negative value corresponding to an AVERROR code in case of error; in particular: AVERROR(EINVAL) if no key is present

Definition at line 1875 of file opt.c.

Referenced by av_opt_set_from_string(), ff_filter_opt_parse(), ff_tee_parse_slave_options(), init_report(), and parse_channel_list().