AVOptionRanges Struct Reference

List of AVOptionRange structs. More...

#include <opt.h>

Data Fields
AVOptionRange **	range
	Array of option ranges. More...
int	nb_ranges
	Number of ranges per component. More...
int	nb_components
	Number of componentes. More...

Detailed Description

List of AVOptionRange structs.

Definition at line 329 of file opt.h.

Field Documentation

AVOptionRange** AVOptionRanges::range

Array of option ranges.

Most of option types use just one component. Following describes multi-component option types:

AV_OPT_TYPE_IMAGE_SIZE: component index 0: range of pixel count (width * height). component index 1: range of width. component index 2: range of height.

Note

To obtain multi-component version of this structure, user must provide AV_OPT_MULTI_COMPONENT_RANGE to av_opt_query_ranges or av_opt_query_ranges_default function.

Multi-component range can be read as in following example:

int range_index, component_index;
AVOptionRanges *ranges;
AVOptionRange *range[3]; //may require more than 3 in the future.
av_opt_query_ranges(&ranges, obj, key, AV_OPT_MULTI_COMPONENT_RANGE);
for (range_index = 0; range_index < ranges->nb_ranges; range_index++) {
    for (component_index = 0; component_index < ranges->nb_components; component_index++)
        range[component_index] = ranges->range[ranges->nb_ranges * component_index + range_index];
    //do something with range here.
}
av_opt_freep_ranges(&ranges);

Definition at line 360 of file opt.h.

Referenced by av_opt_freep_ranges(), av_opt_query_ranges_default(), and opt_list().

int AVOptionRanges::nb_ranges

Number of ranges per component.

Definition at line 364 of file opt.h.

Referenced by av_opt_freep_ranges(), av_opt_query_ranges_default(), and opt_list().

int AVOptionRanges::nb_components

Number of componentes.

Definition at line 368 of file opt.h.

Referenced by av_opt_freep_ranges(), and av_opt_query_ranges_default().

---

The documentation for this struct was generated from the following file:

• libavutil/opt.h