#include <libavcodec/avcodec.h>

Data Fields
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} More...

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

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

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

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

uint8_t	max_lowres
	maximum value for lowres supported by the decoder More...

const AVClass *	priv_class
	AVClass for the private context. More...

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

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. More...

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. More...

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.

Examples:: decode_audio.c, decode_video.c, demuxing_decoding.c, encode_audio.c, encode_video.c, filtering_audio.c, filtering_video.c, hw_decode.c, muxing.c, transcode_aac.c, and transcoding.c.

Definition at line 3481 of file avcodec.h.

Field Documentation

◆ 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.

Examples:: hw_decode.c.

Definition at line 3488 of file avcodec.h.

Referenced by main().

◆ 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.

Definition at line 3493 of file avcodec.h.

◆ type

enum AVMediaType AVCodec::type

Definition at line 3494 of file avcodec.h.

◆ id

enum AVCodecID AVCodec::id

Examples:: decode_audio.c, decode_video.c, and encode_video.c.

Definition at line 3495 of file avcodec.h.

Referenced by main().

◆ capabilities

int AVCodec::capabilities

Codec capabilities.

see AV_CODEC_CAP_*

Examples:: muxing.c, and transcoding.c.

Definition at line 3500 of file avcodec.h.

Referenced by open_audio().

◆ supported_framerates

const AVRational* AVCodec::supported_framerates

array of supported framerates, or NULL if any, array is terminated by {0,0}

Definition at line 3501 of file avcodec.h.

◆ pix_fmts

enum AVPixelFormat* AVCodec::pix_fmts

array of supported pixel formats, or NULL if unknown, array is terminated by -1

Examples:: transcoding.c.

Definition at line 3502 of file avcodec.h.

Referenced by open_output_file().

◆ supported_samplerates

const int* AVCodec::supported_samplerates

array of supported audio samplerates, or NULL if unknown, array is terminated by 0

Examples:: encode_audio.c.

Definition at line 3503 of file avcodec.h.

Referenced by select_sample_rate().

◆ sample_fmts

enum AVSampleFormat* AVCodec::sample_fmts

array of supported sample formats, or NULL if unknown, array is terminated by -1

Examples:: encode_audio.c, transcode_aac.c, and transcoding.c.

Definition at line 3504 of file avcodec.h.

Referenced by check_sample_fmt(), and open_output_file().

◆ channel_layouts

const uint64_t* AVCodec::channel_layouts

array of support channel layouts, or NULL if unknown. array is terminated by 0

Examples:: encode_audio.c.

Definition at line 3505 of file avcodec.h.

Referenced by select_channel_layout().

◆ max_lowres

uint8_t AVCodec::max_lowres

maximum value for lowres supported by the decoder

Definition at line 3506 of file avcodec.h.

◆ priv_class

const AVClass* AVCodec::priv_class

AVClass for the private context.

Definition at line 3507 of file avcodec.h.

◆ profiles

const AVProfile* AVCodec::profiles

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

Definition at line 3508 of file avcodec.h.

◆ 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>").

Definition at line 3520 of file avcodec.h.

◆ priv_data_size

int AVCodec::priv_data_size

Definition at line 3529 of file avcodec.h.

◆ next

struct AVCodec* AVCodec::next

Definition at line 3530 of file avcodec.h.

◆ 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.

Definition at line 3540 of file avcodec.h.

◆ 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.

Definition at line 3548 of file avcodec.h.

◆ defaults

const AVCodecDefault* AVCodec::defaults

Private codec-specific defaults.

Definition at line 3554 of file avcodec.h.

◆ 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.

Definition at line 3562 of file avcodec.h.

◆ init

int(* AVCodec::init) (AVCodecContext *)

Definition at line 3564 of file avcodec.h.

◆ encode_sub

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

Definition at line 3565 of file avcodec.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

Definition at line 3577 of file avcodec.h.

◆ decode

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

Definition at line 3579 of file avcodec.h.

◆ close

int(* AVCodec::close) (AVCodecContext *)

Definition at line 3580 of file avcodec.h.

◆ 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,

Definition at line 3589 of file avcodec.h.

◆ receive_packet

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

Definition at line 3590 of file avcodec.h.

◆ 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.

Definition at line 3597 of file avcodec.h.

◆ flush

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

Flush buffers.

Will be called when seeking

Definition at line 3602 of file avcodec.h.

◆ caps_internal

int AVCodec::caps_internal

Internal codec capabilities.

See FF_CODEC_CAP_* in internal.h

Definition at line 3607 of file avcodec.h.

◆ bsfs

const char* AVCodec::bsfs

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

Definition at line 3613 of file avcodec.h.

◆ 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().

Definition at line 3622 of file avcodec.h.

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

libavcodec/avcodec.h

Data Fields