libavcodec/opt.h File Reference

AVOptions. More...

#include "rational.h"

Go to the source code of this file.

Data Structures

struct  AVOption
 AVOption. More...

Defines

#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

Enumerations

enum  AVOptionType {
  FF_OPT_TYPE_FLAGS, 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
}

Functions

const AVOptionav_find_opt (void *obj, const char *name, const char *unit, int mask, int flags)
const AVOptionav_set_string (void *obj, const char *name, const char *val)
const AVOptionav_set_double (void *obj, const char *name, double n)
const AVOptionav_set_q (void *obj, const char *name, AVRational n)
const AVOptionav_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)
const char * av_get_string (void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len)
const AVOptionav_next_option (void *obj, const AVOption *last)
int av_opt_show (void *obj, void *av_log_obj)
void av_opt_set_defaults (void *s)
void av_opt_set_defaults2 (void *s, int mask, int flags)
 Set the values of the AVCodecContext or AVFormatContext structure.


Detailed Description

AVOptions.

Definition in file opt.h.


Define Documentation

#define AV_OPT_FLAG_AUDIO_PARAM   8

#define AV_OPT_FLAG_DECODING_PARAM   2

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

Definition at line 64 of file opt.h.

Referenced by opt_input_file(), and opt_list().

#define AV_OPT_FLAG_ENCODING_PARAM   1

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

Definition at line 63 of file opt.h.

Referenced by new_audio_stream(), new_subtitle_stream(), new_video_stream(), opt_list(), and opt_output_file().

#define AV_OPT_FLAG_METADATA   4

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

Definition at line 65 of file opt.h.

#define AV_OPT_FLAG_SUBTITLE_PARAM   32

Definition at line 68 of file opt.h.

Referenced by avcodec_get_context_defaults2(), new_subtitle_stream(), opt_default(), and opt_list().

#define AV_OPT_FLAG_VIDEO_PARAM   16


Enumeration Type Documentation

Enumerator:
FF_OPT_TYPE_FLAGS 
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  offset must point to a pointer immediately followed by an int for the length
FF_OPT_TYPE_CONST 

Definition at line 32 of file opt.h.


Function Documentation

const AVOption* av_find_opt ( void *  obj,
const char *  name,
const char *  unit,
int  mask,
int  flags 
)

Definition at line 33 of file opt.c.

Referenced by av_get_number(), av_get_string(), av_set_number(), av_set_string(), and opt_default().

double av_get_double ( void *  obj,
const char *  name,
const AVOption **  o_out 
)

Definition at line 271 of file opt.c.

int64_t av_get_int ( void *  obj,
const char *  name,
const AVOption **  o_out 
)

Definition at line 292 of file opt.c.

Referenced by av_encode(), av_set_string(), opt_bitrate(), and set_all_opt().

AVRational av_get_q ( void *  obj,
const char *  name,
const AVOption **  o_out 
)

Definition at line 280 of file opt.c.

const char* av_get_string ( void *  obj,
const char *  name,
const AVOption **  o_out,
char *  buf,
int  buf_len 
)

Parameters:
buf a buffer which is used for returning non string values as strings, can be NULL
buf_len allocated length in bytes of buf

Definition at line 214 of file opt.c.

Referenced by new_audio_stream(), new_subtitle_stream(), new_video_stream(), opt_input_file(), and opt_output_file().

const AVOption* av_next_option ( void *  obj,
const AVOption last 
)

Definition at line 44 of file opt.c.

Referenced by av_opt_set_defaults2(), and opt_list().

void av_opt_set_defaults ( void *  s  ) 

Definition at line 426 of file opt.c.

Referenced by avformat_get_context_defaults().

void av_opt_set_defaults2 ( void *  s,
int  mask,
int  flags 
)

Set the values of the AVCodecContext or AVFormatContext structure.

They are set to the defaults specified in the according AVOption options array default_val field.

Parameters:
s AVCodecContext or AVFormatContext for which the defaults will be set

Definition at line 387 of file opt.c.

Referenced by av_opt_set_defaults(), and avcodec_get_context_defaults2().

int av_opt_show ( void *  obj,
void *  av_log_obj 
)

Definition at line 370 of file opt.c.

Referenced by show_help().

const AVOption* av_set_double ( void *  obj,
const char *  name,
double  n 
)

Definition at line 197 of file opt.c.

Referenced by av_opt_set_defaults2().

const AVOption* av_set_int ( void *  obj,
const char *  name,
int64_t  n 
)

Definition at line 205 of file opt.c.

Referenced by av_opt_set_defaults2().

const AVOption* av_set_q ( void *  obj,
const char *  name,
AVRational  n 
)

Definition at line 201 of file opt.c.

Referenced by av_opt_set_defaults2().

const AVOption* av_set_string ( void *  obj,
const char *  name,
const char *  val 
)


Generated on Wed Feb 9 19:10:12 2011 for ffmpeg by  doxygen 1.5.6