FFmpeg
Data Structures | Macros | Enumerations | Functions
opt.h File Reference
#include "rational.h"
#include "avutil.h"
#include "channel_layout.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 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_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 intended 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_FLAG_BSF_PARAM   (1<<8)
  a generic parameter which can be set by the user for bit stream filtering More...
 
#define  AV_OPT_FLAG_RUNTIME_PARAM   (1<<15)
  a generic parameter which can be set by the user at runtime More...
 
#define  AV_OPT_FLAG_FILTERING_PARAM   (1<<16)
  a generic parameter which can be set by the user for filtering More...
 
#define  AV_OPT_FLAG_DEPRECATED   (1<<17)
  set if option is deprecated, users should refer to AVOption.help text for more information More...
 
#define  AV_OPT_FLAG_CHILD_CONSTS   (1<<18)
  set if option constants can also reside in child objects More...
 
#define  AV_OPT_SEARCH_CHILDREN   (1 << 0)
  Search in possible children of the given object first. More...
 
#define  AV_OPT_SEARCH_FAKE_OBJ   (1 << 1)
  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...
 
#define  AV_OPT_ALLOW_NULL   (1 << 2)
  In av_opt_get, return NULL if the option has a pointer type and is set to NULL, rather than returning an empty string. More...
 
#define  AV_OPT_MULTI_COMPONENT_RANGE   (1 << 12)
  Allows av_opt_query_ranges and av_opt_query_ranges_default to return more than one component for certain option types. More...
 
#define  av_opt_set_int_list(obj, name, val, term, flags)
  Set a binary option to an integer list. More...
 
#define  AV_OPT_SERIALIZE_SKIP_DEFAULTS   0x00000001
  Serialize options that are not set to default values only. More...
 
#define  AV_OPT_SERIALIZE_OPT_FLAGS_EXACT   0x00000002
  Serialize options that exactly match opt_flags only. 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_UINT64, AV_OPT_TYPE_CONST, AV_OPT_TYPE_IMAGE_SIZE,
  AV_OPT_TYPE_PIXEL_FMT, AV_OPT_TYPE_SAMPLE_FMT, AV_OPT_TYPE_VIDEO_RATE, AV_OPT_TYPE_DURATION,
  AV_OPT_TYPE_COLOR, AV_OPT_TYPE_CHANNEL_LAYOUT, AV_OPT_TYPE_BOOL, AV_OPT_TYPE_CHLAYOUT
}
 
enum   { AV_OPT_FLAG_IMPLICIT_KEY = 1 }
 

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...
 
void  av_opt_set_defaults2 (void *s, int mask, int flags)
  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...
 
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. 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)
  Set all the options from a given dictionary on an object. More...
 
int  av_opt_set_dict2 (void *obj, struct AVDictionary **options, int search_flags)
  Set all the options from a given dictionary on an object. More...
 
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. More...
 
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 AVOption *  av_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 AVOption *  av_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 AVOption *  av_opt_next (const void *obj, const AVOption *prev)
  Iterate over all AVOptions belonging to obj. More...
 
void *  av_opt_child_next (void *obj, void *prev)
  Iterate over AVOptions-enabled children of obj. More...
 
const AVClass *  av_opt_child_class_iterate (const AVClass *parent, void **iter)
  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_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)
 
attribute_deprecated int  av_opt_set_channel_layout (void *obj, const char *name, int64_t ch_layout, int search_flags)
 
int  av_opt_set_chlayout (void *obj, const char *name, const AVChannelLayout *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)
 
attribute_deprecated int  av_opt_get_channel_layout (void *obj, const char *name, int search_flags, int64_t *ch_layout)
 
int  av_opt_get_chlayout (void *obj, const char *name, int search_flags, AVChannelLayout *layout)
 
int  av_opt_get_dict_val (void *obj, const char *name, int search_flags, AVDictionary **out_val)
 
void *  av_opt_ptr (const AVClass *avclass, void *obj, const char *name)
  Gets a pointer to the requested field in a struct. More...
 
void  av_opt_freep_ranges (AVOptionRanges **ranges)
  Free an AVOptionRanges struct and set it to NULL. More...
 
int  av_opt_query_ranges (AVOptionRanges **, void *obj, const char *key, int flags)
  Get a list of allowed ranges for the given option. More...
 
int  av_opt_copy (void *dest, const void *src)
  Copy options from src object into dest object. More...
 
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. More...
 
int  av_opt_is_set_to_default (void *obj, const AVOption *o)
  Check if given option is set to its default value. More...
 
int  av_opt_is_set_to_default_by_name (void *obj, const char *name, int search_flags)
  Check if given option is set to its default value. More...
 
int  av_opt_serialize (void *obj, int opt_flags, int flags, char **buffer, const char key_val_sep, const char pairs_sep)
  Serialize object's options. More...
 

Detailed Description

AVOptions

Definition in file opt.h.

Macro Definition Documentation

◆ AV_OPT_FLAG_ENCODING_PARAM

#define AV_OPT_FLAG_ENCODING_PARAM   1

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

Definition at line 281 of file opt.h.

◆ AV_OPT_FLAG_DECODING_PARAM

#define AV_OPT_FLAG_DECODING_PARAM   2

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

Definition at line 282 of file opt.h.

◆ AV_OPT_FLAG_AUDIO_PARAM

#define AV_OPT_FLAG_AUDIO_PARAM   8

Definition at line 283 of file opt.h.

◆ AV_OPT_FLAG_VIDEO_PARAM

#define AV_OPT_FLAG_VIDEO_PARAM   16

Definition at line 284 of file opt.h.

◆ AV_OPT_FLAG_SUBTITLE_PARAM

#define AV_OPT_FLAG_SUBTITLE_PARAM   32

Definition at line 285 of file opt.h.

◆ AV_OPT_FLAG_EXPORT

#define AV_OPT_FLAG_EXPORT   64

The option is intended for exporting values to the caller.

Definition at line 289 of file opt.h.

◆ AV_OPT_FLAG_READONLY

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

◆ AV_OPT_FLAG_BSF_PARAM

#define AV_OPT_FLAG_BSF_PARAM   (1<<8)

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

Definition at line 295 of file opt.h.

◆ AV_OPT_FLAG_RUNTIME_PARAM

#define AV_OPT_FLAG_RUNTIME_PARAM   (1<<15)

a generic parameter which can be set by the user at runtime

Definition at line 296 of file opt.h.

◆ AV_OPT_FLAG_FILTERING_PARAM

#define AV_OPT_FLAG_FILTERING_PARAM   (1<<16)

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

Definition at line 297 of file opt.h.

◆ AV_OPT_FLAG_DEPRECATED

#define AV_OPT_FLAG_DEPRECATED   (1<<17)

set if option is deprecated, users should refer to AVOption.help text for more information

Definition at line 298 of file opt.h.

◆ AV_OPT_FLAG_CHILD_CONSTS

#define AV_OPT_FLAG_CHILD_CONSTS   (1<<18)

set if option constants can also reside in child objects

Definition at line 299 of file opt.h.

Generated on Tue Feb 28 2023 21:34:37 for FFmpeg by   doxygen 1.8.17

AltStyle によって変換されたページ (->オリジナル) /