FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Macros | Enumerations | Functions
opt.h File Reference

AVOptions. More...

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

Go to the source code of this file.

Data Structures

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
 a generic parameter which can be set by the user for muxing or encoding
 
#define AV_OPT_FLAG_DECODING_PARAM   2
 a generic parameter which can be set by the user for demuxing or decoding
 
#define AV_OPT_FLAG_METADATA   4
 some data extracted or inserted into the file like title, comment, ...
 
#define AV_OPT_FLAG_AUDIO_PARAM   8
 
#define AV_OPT_FLAG_VIDEO_PARAM   16
 
#define AV_OPT_FLAG_SUBTITLE_PARAM   32
 
#define AV_OPT_FLAG_EXPORT   64
 The option is inteded for exporting values to the caller.
 
#define AV_OPT_FLAG_READONLY   128
 The option may not be set through the AVOptions API, only read.
 
#define AV_OPT_FLAG_FILTERING_PARAM   (1<<16)
 a generic parameter which can be set by the user for filtering
 
#define AV_OPT_SEARCH_CHILDREN   0x0001
 Search in possible children of the given object first.
 
#define AV_OPT_SEARCH_FAKE_OBJ   0x0002
 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_MULTI_COMPONENT_RANGE   0x1000
 Allows av_opt_query_ranges and av_opt_query_ranges_default to return more than one component for certain option types.
 
#define av_opt_set_int_list(obj, name, val, term, flags)
 Set a binary option to an integer list.
 

Enumerations

enum  AVOptionType {
  AV_OPT_TYPE_FLAGS, 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_CONST = 128, AV_OPT_TYPE_IMAGE_SIZE = MKBETAG('S','I','Z','E'), AV_OPT_TYPE_PIXEL_FMT = MKBETAG('P','F','M','T'),
  AV_OPT_TYPE_SAMPLE_FMT = MKBETAG('S','F','M','T'), AV_OPT_TYPE_VIDEO_RATE = MKBETAG('V','R','A','T'), AV_OPT_TYPE_DURATION = MKBETAG('D','U','R',' '), AV_OPT_TYPE_COLOR = MKBETAG('C','O','L','R'),
  AV_OPT_TYPE_CHANNEL_LAYOUT = MKBETAG('C','H','L','A'), FF_OPT_TYPE_FLAGS = 0, FF_OPT_TYPE_INT, FF_OPT_TYPE_INT64,
  FF_OPT_TYPE_DOUBLE, FF_OPT_TYPE_FLOAT, FF_OPT_TYPE_STRING, FF_OPT_TYPE_RATIONAL,
  FF_OPT_TYPE_BINARY, FF_OPT_TYPE_CONST =128
}
 
enum  { AV_OPT_FLAG_IMPLICIT_KEY = 1 }
 

Functions

attribute_deprecated int av_set_string3 (void *obj, const char *name, const char *val, int alloc, const AVOption **o_out)
 Set the field of obj with the given name to value.
 
attribute_deprecated const
AVOption
av_set_double (void *obj, const char *name, double n)
 
attribute_deprecated const
AVOption
av_set_q (void *obj, const char *name, AVRational n)
 
attribute_deprecated const
AVOption
av_set_int (void *obj, const char *name, int64_t n)
 
double av_get_double (void *obj, const char *name, const AVOption **o_out)
 
AVRational av_get_q (void *obj, const char *name, const AVOption **o_out)
 
int64_t av_get_int (void *obj, const char *name, const AVOption **o_out)
 
attribute_deprecated const char * av_get_string (void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len)
 
attribute_deprecated const
AVOption
av_next_option (void *obj, const AVOption *last)
 
int av_opt_show2 (void *obj, void *av_log_obj, int req_flags, int rej_flags)
 Show the obj options.
 
void av_opt_set_defaults (void *s)
 Set the values of all AVOption fields to their default values.
 
attribute_deprecated void av_opt_set_defaults2 (void *s, int mask, int flags)
 
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.
 
void av_opt_free (void *obj)
 Free all allocated objects in obj.
 
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_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_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_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_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)
 
const AVOptionav_opt_find (void *obj, const char *name, const char *unit, int opt_flags, int search_flags)
 Look for an option in an object.
 
const AVOptionav_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.
 
const AVOptionav_opt_next (void *obj, const AVOption *prev)
 Iterate over all AVOptions belonging to obj.
 
voidav_opt_child_next (void *obj, void *prev)
 Iterate over AVOptions-enabled children of obj.
 
const AVClassav_opt_child_class_next (const AVClass *parent, const AVClass *prev)
 Iterate over potential AVOptions-enabled children of parent.
 
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_channel_layout (void *obj, const char *name, int64_t ch_layout, int search_flags)
 
int av_opt_set_dict_val (void *obj, const char *name, const AVDictionary *val, int search_flags)
 
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_channel_layout (void *obj, const char *name, int search_flags, int64_t *ch_layout)
 
int av_opt_get_dict_val (void *obj, const char *name, int search_flags, AVDictionary **out_val)
 
voidav_opt_ptr (const AVClass *avclass, void *obj, const char *name)
 Gets a pointer to the requested field in a struct.
 
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_copy (void *dest, void *src)
 
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.

Macro Definition Documentation

#define AV_OPT_FLAG_ENCODING_PARAM   1

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

Definition at line 284 of file opt.h.

Referenced by ffserver_parse_config_stream(), filter_codec_opts(), open_output_file(), opt_list(), print_codec(), print_option(), show_help_default(), and show_help_muxer().

#define AV_OPT_FLAG_DECODING_PARAM   2

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

Definition at line 285 of file opt.h.

Referenced by filter_codec_opts(), open_input_file(), opt_list(), PCMDEF(), print_codec(), show_help_default(), and show_help_demuxer().

#define AV_OPT_FLAG_METADATA   4

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

Definition at line 287 of file opt.h.

#define AV_OPT_FLAG_AUDIO_PARAM   8
#define AV_OPT_FLAG_VIDEO_PARAM   16
#define AV_OPT_FLAG_SUBTITLE_PARAM   32

Definition at line 291 of file opt.h.

Referenced by avcodec_get_context_defaults3(), filter_codec_opts(), and opt_list().

#define AV_OPT_FLAG_EXPORT   64

The option is inteded for exporting values to the caller.

Definition at line 295 of file opt.h.

Referenced by opt_list().

#define AV_OPT_FLAG_READONLY   128

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.

Definition at line 300 of file opt.h.

Referenced by av_opt_set(), av_opt_set_bin(), av_opt_set_defaults2(), av_opt_set_dict_val(), opt_list(), and set_number().

#define AV_OPT_FLAG_FILTERING_PARAM   (1<<16)

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

Definition at line 301 of file opt.h.

Referenced by opt_list(), and show_help_default().