AVCodec Struct Reference
[Core functions/structures.]

#include <avcodec.h>

Data Fields

const char * name

Name of the codec implementation.

const char * long_name

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

enum AVMediaType type

enum CodecID id

int capabilities

Codec capabilities.

const AVRational * supported_framerates

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

enum PixelFormat *pix_fmts
const int
*supported_samplerates enum
AVSampleFormat *sample_fmts
const uint64_t
*channel_layouts uint8_t
max_lowres const AVClass
*priv_class const AVProfile
*profiles int priv_data_size
struct AVCodec * next

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

const AVCodecDefault * defaults

Private codec-specific defaults.

void(* init_static_data )(struct AVCodec *codec)

Initialize codec static data, called from avcodec_register().

int(* init )(AVCodecContext *)

int(* encode )(AVCodecContext *, uint8_t *buf, int buf_size, void *data)

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

Encode data to an AVPacket.

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

int(* close )(AVCodecContext *)

void(* flush )(AVCodecContext *)

Flush buffers.

Frame-level threading support functions

int(* init_thread_copy )(AVCodecContext *)

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

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

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

Detailed Description

AVCodec.

Definition at line 2932 of file avcodec.h.

Field Documentation

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

Referenced by avcodec_close(), and frame_thread_free().

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

Referenced by av_codec_is_decoder(), avcodec_decode_audio4(), avcodec_decode_subtitle2(), avcodec_decode_video2(), common_end(), and frame_worker_thread().

const AVCodecDefault* AVCodec::defaults

Private codec-specific defaults.

Definition at line 2993 of file avcodec.h.

Referenced by avcodec_get_context_defaults3().

int(* AVCodec::encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data)

Referenced by av_codec_is_encoder(), and avcodec_encode_subtitle().

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

Referenced by av_codec_is_encoder(), avcodec_encode_audio2(), and avcodec_encode_video2().

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

Flush buffers.

Will be called when seeking

Referenced by avcodec_flush_buffers(), and ff_thread_flush().

enum CodecID AVCodec::id

Definition at line 2946 of file avcodec.h.

Referenced by a64_write_header(), a64_write_packet(), a64multi_init_encoder(), adpcm_compress_trellis(), adpcm_decode_frame(), adpcm_decode_init(), adpcm_encode_init(), assert_codec_experimental(), avcodec_find_decoder(), avcodec_find_encoder(), avcodec_open2(), choose_decoder(), choose_encoder(), common_init(), copy_frame(), decode_end(), decode_frame(), decode_init(), decode_slice_header(), do_video_out(), dpcm_decode_frame(), dpcm_decode_init(), eightsvx_decode_frame(), eightsvx_decode_init(), encode_init(), ff_h263_decode_init(), ff_mjpeg_decode_init(), ff_MPV_encode_init(), ff_vdpau_mpeg4_decode_picture(), ff_vp56_init(), ff_wma_init(), flush_encoders(), get_nb_samples(), h261_decode_init(), init(), mpeg_decode_init(), opt_audio_codec(), opt_input_file(), opt_video_codec(), pcm_decode_frame(), pcm_decode_init(), pcm_encode_frame(), pcm_encode_init(), receive_frame(), svq1_decode_init(), v4l2_read_header(), vaapi_mpeg4_decode_slice(), vaapi_mpeg4_start_frame(), vc1_decode_init(), vcr2_init_sequence(), vp56_add_predictors_dc(), vp56_decode_4mv(), vp6_decode_init(), wma_decode_init(), and xan_decode_frame().

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

Referenced by avcodec_open2(), and frame_thread_init().

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

Initialize codec static data, called from avcodec_register().

Referenced by avcodec_register().

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.

Referenced by frame_thread_init().

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 2944 of file avcodec.h.

Referenced by show_stream().

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.

Definition at line 2939 of file avcodec.h.

Referenced by asf_write_header1(), assert_codec_experimental(), avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(), avcodec_get_name(), avcodec_open2(), choose_pixel_fmt(), choose_sample_fmt(), compute_status(), context_to_name(), ffserver_opt_preset(), init(), list_formats(), mov_write_video_tag(), new_output_stream(), opt_codecs(), show_stream(), transcode_init(), and write_frame().

enum PixelFormat* pix_fmts const int* supported_samplerates enum AVSampleFormat* sample_fmts const uint64_t* channel_layouts uint8_t max_lowres const AVClass* priv_class const AVProfile* profiles int priv_data_size struct AVCodec* AVCodec::next [read]

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

array of supported audio samplerates, or NULL if unknown, array is terminated by 0 array of supported sample formats, or NULL if unknown, array is terminated by -1 array of support channel layouts, or NULL if unknown. array is terminated by 0 maximum value for lowres supported by the decoder AVClass for the private context array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}

Definition at line 2969 of file avcodec.h.

Referenced by av_codec_next(), avcodec_find_decoder(), avcodec_find_decoder_by_name(), avcodec_find_encoder(), avcodec_find_encoder_by_name(), and avcodec_register().

const AVRational* AVCodec::supported_framerates

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

Definition at line 2952 of file avcodec.h.

Referenced by transcode_init().

enum AVMediaType AVCodec::type

Definition at line 2945 of file avcodec.h.

Referenced by avcodec_decode_audio4(), avcodec_decode_subtitle2(), avcodec_decode_video2(), avcodec_get_context_defaults2(), avcodec_get_context_defaults3(), avcodec_get_type(), avcodec_open2(), filter_codec_opts(), find_codec_or_die(), init_input_stream(), opt_audio_codec(), opt_video_codec(), poll_filters(), and read_ffserver_streams().

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.

Referenced by ff_thread_can_start_frame(), ff_thread_get_buffer(), frame_worker_thread(), and update_context_from_thread().

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

libavcodec/avcodec.h


Data Fields
const char *	name
	Name of the codec implementation.
const char *	long_name
	Descriptive name for the codec, meant to be more human readable than name.
enum AVMediaType	type
enum CodecID	id
int	capabilities
	Codec capabilities.
const AVRational *	supported_framerates
	array of supported framerates, or NULL if any, array is terminated by {0,0}
enum PixelFormat pix_fmts const int supported_samplerates enum AVSampleFormat sample_fmts const uint64_t channel_layouts uint8_t max_lowres const AVClass priv_class const AVProfile profiles int priv_data_size struct AVCodec *	next
	array of supported pixel formats, or NULL if unknown, array is terminated by -1
const AVCodecDefault *	defaults
	Private codec-specific defaults.
void(*	init_static_data )(struct AVCodec *codec)
	Initialize codec static data, called from avcodec_register().
int(*	init )(AVCodecContext *)
int(*	encode )(AVCodecContext , uint8_t buf, int buf_size, void *data)
int(*	encode2 )(AVCodecContext avctx, AVPacket avpkt, const AVFrame frame, int got_packet_ptr)
	Encode data to an AVPacket.
int(*	decode )(AVCodecContext , void outdata, int outdata_size, AVPacket avpkt)
int(*	close )(AVCodecContext *)
void(*	flush )(AVCodecContext *)
	Flush buffers.
Frame-level threading support functions
int(*	init_thread_copy )(AVCodecContext *)
	If defined, called on thread contexts when they are created.
int(*	update_thread_context )(AVCodecContext dst, const AVCodecContext src)
	Copy necessary context variables from a previous thread context to the current one.

AVCodec Struct Reference [Core functions/structures.]

Data Fields

Detailed Description

Field Documentation

AVCodec Struct Reference
[Core functions/structures.]