Libav
Data Structures | Macros | Enumerations | Functions
opt.h File Reference

AVOptions. More...

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

Go to the source code of this file.

Data Structures

struct  AVOption
 AVOption. More...
 

Macros

#define AV_OPT_FLAG_ENCODING_PARAM   1
 a generic parameter which can be set by the user for muxing or encoding More...
 
#define AV_OPT_FLAG_DECODING_PARAM   2
 a generic parameter which can be set by the user for demuxing or decoding More...
 
#define AV_OPT_FLAG_METADATA   4
 some data extracted or inserted into the file like title, comment, ... More...
 
#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. More...
 
#define AV_OPT_FLAG_READONLY   128
 The option may not be set through the AVOptions API, only read. More...
 
#define AV_OPT_SEARCH_CHILDREN   0x0001
 Search in possible children of the given object first. More...
 
#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. More...
 

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_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
}
 

Functions

int av_opt_show2 (void *obj, void *av_log_obj, int req_flags, int rej_flags)
 Show the obj options. More...
 
void av_opt_set_defaults (void *s)
 Set the values of all AVOption fields to their default values. More...
 
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. More...
 
void av_opt_free (void *obj)
 Free all allocated objects in obj. More...
 
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. More...
 
int av_opt_set_dict (void *obj, struct AVDictionary **options)
 
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. More...
 
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. More...
 
const AVOptionav_opt_next (void *obj, const AVOption *prev)
 Iterate over all AVOptions belonging to obj. More...
 
voidav_opt_child_next (void *obj, void *prev)
 Iterate over AVOptions-enabled children of obj. More...
 
const AVClassav_opt_child_class_next (const AVClass *parent, const AVClass *prev)
 Iterate over potential AVOptions-enabled children of parent. More...
 
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_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_dict_val (void *obj, const char *name, int search_flags, AVDictionary **out_val)
 

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 264 of file opt.h.

#define AV_OPT_FLAG_DECODING_PARAM   2

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

Definition at line 265 of file opt.h.

#define AV_OPT_FLAG_METADATA   4

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

Definition at line 267 of file opt.h.

#define AV_OPT_FLAG_AUDIO_PARAM   8

Definition at line 269 of file opt.h.

#define AV_OPT_FLAG_VIDEO_PARAM   16

Definition at line 270 of file opt.h.

#define AV_OPT_FLAG_SUBTITLE_PARAM   32

Definition at line 271 of file opt.h.

#define AV_OPT_FLAG_EXPORT   64

The option is inteded for exporting values to the caller.

Definition at line 275 of file opt.h.

#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 280 of file opt.h.