Data Fields
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 436 of file opt.h.

Field Documentation

◆ range

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.

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;
AVOptionRange *range[3]; //may require more than 3 in the future.
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.

Definition at line 467 of file opt.h.

Referenced by av_opt_freep_ranges(), and av_opt_query_ranges_default().

◆ nb_ranges

int AVOptionRanges::nb_ranges

Number of ranges per component.

Definition at line 471 of file opt.h.

Referenced by av_opt_freep_ranges(), and av_opt_query_ranges_default().

◆ nb_components

int AVOptionRanges::nb_components

Number of componentes.

Definition at line 475 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:
int nb_components
Number of componentes.
Definition: opt.h:475
int nb_ranges
Number of ranges per component.
Definition: opt.h:471
const char * key
Definition: hwcontext_opencl.c:189
AVOptionRange ** range
Array of option ranges.
Definition: opt.h:467
A single allowed range of values, or a single allowed value.
Definition: opt.h:413
Allows av_opt_query_ranges and av_opt_query_ranges_default to return more than one component for cert...
Definition: opt.h:554
List of AVOptionRange structs.
Definition: opt.h:436
int av_opt_query_ranges(AVOptionRanges **ranges_arg, void *obj, const char *key, int flags)
Get a list of allowed ranges for the given option.
Definition: opt.c:2151
void av_opt_freep_ranges(AVOptionRanges **rangesp)
Free an AVOptionRanges struct and set it to NULL.
Definition: opt.c:2241