#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 AVCodecID	id

int	capabilities
	Codec capabilities.

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}

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

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.

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.

Examples:: doc/examples/decoding_encoding.c, doc/examples/demuxing.c, doc/examples/filtering_audio.c, doc/examples/filtering_video.c, and doc/examples/muxing.c.

Definition at line 3251 of file avcodec.h.

Field Documentation

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

Referenced by asf_write_header1(), 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(), dshow_cycle_formats(), ffserver_opt_preset(), find_codec_or_die(), init(), list_formats(), mov_write_video_tag(), mpeg12_class(), new_output_stream(), print_codec(), print_codecs(), print_codecs_for_id(), show_codecs(), show_stream(), transcode_init(), and write_frame().

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

Referenced by print_codec(), print_codecs(), and show_stream().

enum AVMediaType AVCodec::type

Definition at line 3264 of file avcodec.h.

Referenced by avcodec_decode_audio4(), avcodec_decode_subtitle2(), avcodec_decode_video2(), avcodec_get_context_defaults3(), avcodec_get_type(), avcodec_open2(), decode_audio(), ff_init_buffer_info(), find_codec_or_die(), init_input_stream(), movie_common_init(), opt_audio_codec(), opt_video_codec(), print_codec(), process_input(), read_ffserver_streams(), and transcode_init().

enum AVCodecID AVCodec::id

Definition at line 3265 of file avcodec.h.

Referenced by a64_write_header(), a64multi_init_encoder(), adpcm_compress_trellis(), adpcm_decode_frame(), adpcm_decode_init(), adpcm_encode_init(), avcodec_open2(), check_format(), choose_decoder(), choose_encoder(), copy_frame(), decode_end(), decode_frame(), decode_init(), do_video_out(), dpcm_decode_frame(), dpcm_decode_init(), eightsvx_decode_init(), encode_init(), ff_h263_decode_init(), ff_mjpeg_decode_init(), ff_MPV_encode_init(), ff_print_debug_info2(), ff_vdpau_mpeg4_decode_picture(), ff_vp56_init_context(), ff_wma_init(), find_encdec(), flush_encoders(), get_nb_samples(), h261_decode_init(), h264_slice_header_init(), init(), mpeg_decode_init(), new_output_stream(), next_codec_for_id(), open_input_file(), opt_audio_codec(), opt_video_codec(), pcm_decode_frame(), pcm_encode_frame(), pcm_encode_init(), receive_frame(), srt_decode_frame(), srt_encode_frame(), srt_end_cb(), srt_move_cb(), stream_component_open(), v4l2_read_header(), vaapi_mpeg4_decode_slice(), vaapi_mpeg4_start_frame(), vc1_decode_init(), vcr2_init_sequence(), vdpau_mpeg4_start_frame(), vp6_decode_init(), and wma_decode_init().

int AVCodec::capabilities

Codec capabilities.

see CODEC_CAP_*

Examples:: doc/examples/decoding_encoding.c, and doc/examples/muxing.c.

Definition at line 3270 of file avcodec.h.

Referenced by apply_param_change(), audio_decode_frame(), avcodec_decode_audio4(), avcodec_decode_video2(), avcodec_encode_audio2(), avcodec_encode_video2(), avcodec_open2(), choose_sample_fmt(), decode_audio(), decode_nal_units(), do_video_out(), execute_decode_slices(), ff_draw_horiz_band(), ff_er_frame_end(), ff_frame_thread_encoder_init(), ff_h263_decode_frame(), ff_h264_frame_start(), ff_MPV_frame_end(), ff_print_debug_info2(), field_end(), find_encdec(), h264_set_parameter_from_sps(), init_input_stream(), open_audio(), print_codec(), print_codecs(), read_thread(), reap_filters(), stream_component_open(), submit_packet(), transcode_init(), try_decode_frame(), validate_thread_parameters(), vc1_decode_frame(), video_decode_example(), and video_thread().

const AVRational* AVCodec::supported_framerates

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

Definition at line 3271 of file avcodec.h.

Referenced by print_codec(), and transcode_init().

enum AVPixelFormat* AVCodec::pix_fmts

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

Definition at line 3272 of file avcodec.h.

Referenced by avcodec_open2(), choose_pix_fmts(), choose_pixel_fmt(), ff_h263_decode_init(), get_pixel_format(), svq3_decode_init(), vc1_decode_init(), vdadec_init(), and X264_init_static().

const int* AVCodec::supported_samplerates

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

Examples:: doc/examples/decoding_encoding.c.

Definition at line 3273 of file avcodec.h.

Referenced by avcodec_open2(), and select_sample_rate().

enum AVSampleFormat* AVCodec::sample_fmts

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

Examples:: doc/examples/decoding_encoding.c.

Definition at line 3274 of file avcodec.h.

Referenced by avcodec_open2(), check_sample_fmt(), choose_sample_fmt(), and pcm_decode_init().

const uint64_t* AVCodec::channel_layouts

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

Examples:: doc/examples/decoding_encoding.c.

Definition at line 3275 of file avcodec.h.

Referenced by avcodec_open2(), and select_channel_layout().

uint8_t AVCodec::max_lowres

maximum value for lowres supported by the decoder

Definition at line 3276 of file avcodec.h.

Referenced by avcodec_open2(), and stream_component_open().

const AVClass* AVCodec::priv_class

AVClass for the private context.

Definition at line 3277 of file avcodec.h.

Referenced by avcodec_close(), avcodec_get_context_defaults3(), avcodec_open2(), codec_child_class_next(), codec_child_next(), filter_codec_opts(), print_codec(), show_codec_opts(), and show_stream().

const AVProfile* AVCodec::profiles

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

Definition at line 3278 of file avcodec.h.

Referenced by av_get_profile_name().

int AVCodec::priv_data_size

Definition at line 3287 of file avcodec.h.

Referenced by avcodec_get_context_defaults3(), avcodec_open2(), ff_frame_thread_encoder_init(), and frame_thread_init().

struct AVCodec* AVCodec::next

Definition at line 3288 of file avcodec.h.

Referenced by av_codec_next(), avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(), avcodec_register(), and find_encdec().

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

Referenced by frame_thread_init().

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

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

const AVCodecDefault* AVCodec::defaults

Private codec-specific defaults.

Definition at line 3312 of file avcodec.h.

Referenced by avcodec_get_context_defaults3().

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

Initialize codec static data, called from avcodec_register().

Definition at line 3317 of file avcodec.h.

Referenced by avcodec_register().

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

Definition at line 3319 of file avcodec.h.

Referenced by avcodec_open2(), frame_thread_init(), and vdadec_init().

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

Definition at line 3320 of file avcodec.h.

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.