#include <avcodec.h>

Public Attributes
const char *	name
	Name of the codec implementation. More...

const char *	long_name
	Descriptive name for the codec, meant to be more human readable than name. More...

enum AVMediaType	type

enum AVCodecID	id

int	capabilities
	Codec capabilities. More...

const AVRational *	supported_framerates
	array of supported framerates, or NULL if any, array is terminated by {0,0}

enum AVPixelFormat *	pix_fmts
	array of supported pixel formats, or NULL if unknown, array is terminated by -1

const int *	supported_samplerates
	array of supported audio samplerates, or NULL if unknown, array is terminated by 0

enum AVSampleFormat *	sample_fmts
	array of supported sample formats, or NULL if unknown, array is terminated by -1

const uint64_t *	channel_layouts
	array of support channel layouts, or NULL if unknown. array is terminated by 0

uint8_t	max_lowres
	maximum value for lowres supported by the decoder

const AVClass *	priv_class
	AVClass for the private context.

const AVProfile *	profiles
	array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}

const char *	wrapper_name
	Group name of the codec implementation. More...

int	priv_data_size

struct AVCodec *	next

const AVCodecDefault *	defaults
	Private codec-specific defaults.

void(*	init_static_data )(struct AVCodec *codec)
	Initialize codec static data, called from avcodec_register(). More...

int(*	init )(AVCodecContext *)

int(*	encode_sub )(AVCodecContext , uint8_t buf, int buf_size, const struct AVSubtitle *sub)

int(*	encode2 )(AVCodecContext avctx, AVPacket avpkt, const AVFrame frame, int got_packet_ptr)
	Encode data to an AVPacket. More...

int(*	decode )(AVCodecContext , void outdata, int outdata_size, AVPacket avpkt)

int(*	close )(AVCodecContext *)

int(*	send_frame )(AVCodecContext avctx, const AVFrame frame)
	Encode API with decoupled packet/frame dataflow. More...

int(*	receive_packet )(AVCodecContext avctx, AVPacket avpkt)

int(*	receive_frame )(AVCodecContext avctx, AVFrame frame)
	Decode API with decoupled packet/frame dataflow. More...

void(*	flush )(AVCodecContext *)
	Flush buffers. More...

int	caps_internal
	Internal codec capabilities. More...

const char *	bsfs
	Decoding only, a comma-separated list of bitstream filters to apply to packets before decoding.

const struct AVCodecHWConfigInternal **	hw_configs
	Array of pointers to hardware configurations supported by the codec, or NULL if no hardware supported. More...

Frame-level threading support functions
int(*	init_thread_copy )(AVCodecContext *)
	If defined, called on thread contexts when they are created. More...

int(*	update_thread_context )(AVCodecContext dst, const AVCodecContext src)
	Copy necessary context variables from a previous thread context to the current one. More...

Detailed Description

AVCodec.

Member Data Documentation

§ capabilities

int AVCodec::capabilities

Codec capabilities.

see AV_CODEC_CAP_*

§ caps_internal

int AVCodec::caps_internal

Internal codec capabilities.

See FF_CODEC_CAP_* in internal.h

§ encode2

int(* AVCodec::encode2) (AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)

Encode data to an AVPacket.

Parameters

	avctx	codec context
	avpkt	output AVPacket (may contain a user-provided buffer)
[in]	frame	AVFrame containing the raw data to be encoded
[out]	got_packet_ptr	encoder sets to 0 or 1 to indicate that a non-empty packet was returned in avpkt.

Returns: 0 on success, negative error code on failure

§ flush

void(* AVCodec::flush) (AVCodecContext *)

Flush buffers.

Will be called when seeking

§ hw_configs

const struct AVCodecHWConfigInternal** AVCodec::hw_configs

Array of pointers to hardware configurations supported by the codec, or NULL if no hardware supported.

The array is terminated by a NULL pointer.

The user can only access this field via avcodec_get_hw_config().

§ init_static_data

void(* AVCodec::init_static_data) (struct AVCodec *codec)

Initialize codec static data, called from avcodec_register().

This is not intended for time consuming operations as it is run for every codec regardless of that codec being used.

§ init_thread_copy

int(* AVCodec::init_thread_copy) (AVCodecContext *)

If defined, called on thread contexts when they are created.

If the codec allocates writable tables in init(), re-allocate them here. priv_data will be set to a copy of the original.

§ long_name

const char* AVCodec::long_name

Descriptive name for the codec, meant to be more human readable than name.

You should use the NULL_IF_CONFIG_SMALL() macro to define it.

§ name

const char* AVCodec::name

Name of the codec implementation.

The name is globally unique among encoders and among decoders (but an encoder and a decoder can share the same name). This is the primary way to find a codec from the user perspective.

§ receive_frame

int(* AVCodec::receive_frame) (AVCodecContext *avctx, AVFrame *frame)

Decode API with decoupled packet/frame dataflow.

This function is called to get one output frame. It should call ff_decode_get_packet() to obtain input data.

§ send_frame

int(* AVCodec::send_frame) (AVCodecContext *avctx, const AVFrame *frame)

Encode API with decoupled packet/frame dataflow.

The API is the same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except that:

never called if the codec is closed or the wrong type,
if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
only one drain frame is ever passed down,

§ update_thread_context

int(* AVCodec::update_thread_context) (AVCodecContext *dst, const AVCodecContext *src)

Copy necessary context variables from a previous thread context to the current one.

If not defined, the next thread will start automatically; otherwise, the codec must call ff_thread_finish_setup().

dst and src will (rarely) point to the same context, in which case memcpy should be skipped.

§ wrapper_name

const char* AVCodec::wrapper_name

Group name of the codec implementation.

This is a short symbolic name of the wrapper backing this codec. A wrapper uses some kind of external implementation for the codec, such as an external library, or a codec implementation provided by the OS or the hardware. If this field is NULL, this is a builtin, libavcodec native codec. If non-NULL, this will be the suffix in AVCodec.name in most cases (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").

The documentation for this struct was generated from the following file:

libavcodec/avcodec.h

Public Attributes