AVCodec Struct Reference

AVCodec. More...

#include <avcodec.h>

Data Fields

const char * name
 Name of the codec implementation.
enum AVMediaType type
enum CodecID id
int priv_data_size
int(* init )(AVCodecContext *)
int(* encode )(AVCodecContext *, uint8_t *buf, int buf_size, void *data)
int(* close )(AVCodecContext *)
int(* decode )(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt)
int capabilities
 Codec capabilities.
struct AVCodecnext
void(* flush )(AVCodecContext *)
 Flush buffers.
const AVRationalsupported_framerates
 array of supported framerates, or NULL if any, array is terminated by {0,0}
enum PixelFormatpix_fmts
 array of supported pixel formats, or NULL if unknown, array is terminated by -1
const char * long_name
 Descriptive name for the codec, meant to be more human readable than name.
const int * supported_samplerates
 array of supported audio samplerates, or NULL if unknown, array is terminated by 0
enum AVSampleFormatsample_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 AVClasspriv_class
 AVClass for the private context.
const AVProfileprofiles
 array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
const AVCodecDefaultdefaults
 Private codec-specific defaults.
void(* init_static_data )(struct AVCodec *codec)
 Initialize codec static data, called from avcodec_register().
int(* encode2 )(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
 Encode data to an AVPacket.
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:
libavcodec/api-example.c, and libavformat/output-example.c.

Definition at line 3188 of file avcodec.h.

Field Documentation

const uint64_t* AVCodec::channel_layouts

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

Definition at line 3223 of file avcodec.h.

Referenced by avcodec_open2().

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

Definition at line 3201 of file avcodec.h.

Referenced by avcodec_close(), and frame_thread_free().

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

Private codec-specific defaults.

Definition at line 3251 of file avcodec.h.

Referenced by avcodec_get_context_defaults3().

int(* AVCodec::encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data)
int(* AVCodec::encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)

Encode data to an AVPacket.

Parameters
avctxcodec context
avpktoutput AVPacket (may contain a user-provided buffer)
[in]frameAVFrame containing the raw data to be encoded
[out]got_packet_ptrencoder 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 3268 of file avcodec.h.

Referenced by avcodec_encode_audio2(), and codec_is_encoder().

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

Flush buffers.

Will be called when seeking

Definition at line 3213 of file avcodec.h.

Referenced by avcodec_flush_buffers(), and ff_thread_flush().

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

Definition at line 3199 of file avcodec.h.

Referenced by avcodec_open2(), and frame_thread_init().

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

Initialize codec static data, called from avcodec_register().

Definition at line 3256 of file avcodec.h.

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.

Definition at line 3237 of file avcodec.h.

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

Referenced by show_stream().

uint8_t AVCodec::max_lowres

maximum value for lowres supported by the decoder

Definition at line 3224 of file avcodec.h.

Referenced by avcodec_open2().

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

Referenced by asf_write_header1(), assert_codec_experimental(), avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(), avcodec_open2(), avcodec_string(), avserver_opt_preset(), choose_pixel_fmt(), choose_sample_fmt(), compute_status(), context_to_name(), list_formats(), mov_write_video_tag(), mpeg12_class(), new_output_stream(), show_codecs(), show_stream(), transcode_init(), and write_frame().

enum PixelFormat* AVCodec::pix_fmts

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

Definition at line 3215 of file avcodec.h.

Referenced by choose_pixel_fmt(), decode_slice_header(), ff_h263_decode_init(), svq3_decode_init(), vc1_decode_init(), and X264_init_static().

const AVClass* AVCodec::priv_class
int AVCodec::priv_data_size

Definition at line 3198 of file avcodec.h.

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

const AVProfile* AVCodec::profiles

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

Definition at line 3226 of file avcodec.h.

Referenced by av_get_profile_name().

enum AVSampleFormat* AVCodec::sample_fmts

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

Definition at line 3222 of file avcodec.h.

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

const AVRational* AVCodec::supported_framerates

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

Definition at line 3214 of file avcodec.h.

Referenced by transcode(), and transcode_init().

const int* AVCodec::supported_samplerates

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

Definition at line 3221 of file avcodec.h.

Referenced by avcodec_open2(), and choose_sample_rate().

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

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


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