FFmpeg 5.1.6
Data Fields
AVCodecParameters Struct Reference

This struct describes the properties of an encoded stream. More...

#include <libavcodec/codec_par.h>

Data Fields

enum AVMediaType codec_type
 General type of the encoded data. More...
 
enum AVCodecID codec_id
 Specific type of the encoded data (the codec used). More...
 
uint32_t codec_tag
 Additional information about the codec (corresponds to the AVI FOURCC). More...
 
uint8_t * extradata
 Extra binary data needed for initializing the decoder, codec-dependent. More...
 
int extradata_size
 Size of the extradata content in bytes. More...
 
int format
 
int64_t bit_rate
 The average bitrate of the encoded data (in bits per second). More...
 
int bits_per_coded_sample
 The number of bits per sample in the codedwords. More...
 
int bits_per_raw_sample
 This is the number of valid bits in each output sample. More...
 
int profile
 Codec-specific bitstream restrictions that the stream conforms to. More...
 
int level
 
int width
 Video only. More...
 
int height
 
AVRational sample_aspect_ratio
 Video only. More...
 
enum AVFieldOrder field_order
 Video only. More...
 
enum AVColorRange color_range
 Video only. More...
 
enum AVColorPrimaries color_primaries
 
enum AVColorTransferCharacteristic color_trc
 
enum AVColorSpace color_space
 
enum AVChromaLocation chroma_location
 
int video_delay
 Video only. More...
 
int sample_rate
 Audio only. More...
 
int block_align
 Audio only. More...
 
int frame_size
 Audio only. More...
 
int initial_padding
 Audio only. More...
 
int trailing_padding
 Audio only. More...
 
int seek_preroll
 Audio only. More...
 
AVChannelLayout ch_layout
 Audio only. More...
 

Detailed Description

This struct describes the properties of an encoded stream.

sizeof(AVCodecParameters) is not a part of the public ABI, this struct must be allocated with avcodec_parameters_alloc() and freed with avcodec_parameters_free().

Examples
remuxing.c.

Definition at line 53 of file codec_par.h.

Field Documentation

◆ codec_type

enum AVMediaType AVCodecParameters::codec_type

General type of the encoded data.

Examples
remuxing.c, and transcoding.c.

Definition at line 57 of file codec_par.h.

Referenced by init_filters(), and main().

◆ codec_id

enum AVCodecID AVCodecParameters::codec_id

Specific type of the encoded data (the codec used).

Examples
demuxing_decoding.c, qsvdec.c, transcode_aac.c, and transcoding.c.

Definition at line 61 of file codec_par.h.

Referenced by main(), open_codec_context(), and open_input_file().

◆ codec_tag

uint32_t AVCodecParameters::codec_tag

Additional information about the codec (corresponds to the AVI FOURCC).

Examples
remuxing.c.

Definition at line 65 of file codec_par.h.

Referenced by main().

◆ extradata

uint8_t* AVCodecParameters::extradata

Extra binary data needed for initializing the decoder, codec-dependent.

Must be allocated with av_malloc() and will be freed by avcodec_parameters_free(). The allocated size of extradata must be at least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding bytes zeroed.

Examples
qsvdec.c.

Definition at line 75 of file codec_par.h.

Referenced by main().

◆ extradata_size

int AVCodecParameters::extradata_size

Size of the extradata content in bytes.

Examples
qsvdec.c.

Definition at line 79 of file codec_par.h.

Referenced by main().

◆ format

int AVCodecParameters::format
  • video: the pixel format, the value corresponds to enum AVPixelFormat.
  • audio: the sample format, the value corresponds to enum AVSampleFormat.

Definition at line 85 of file codec_par.h.

◆ bit_rate

int64_t AVCodecParameters::bit_rate

The average bitrate of the encoded data (in bits per second).

Definition at line 90 of file codec_par.h.

◆ bits_per_coded_sample

int AVCodecParameters::bits_per_coded_sample

The number of bits per sample in the codedwords.

This is basically the bitrate per sample. It is mandatory for a bunch of formats to actually decode them. It's the number of bits for one sample in the actual coded bitstream.

This could be for example 4 for ADPCM For PCM formats this matches bits_per_raw_sample Can be 0

Definition at line 103 of file codec_par.h.

◆ bits_per_raw_sample

int AVCodecParameters::bits_per_raw_sample

This is the number of valid bits in each output sample.

If the sample format has more bits, the least significant bits are additional padding bits, which are always 0. Use right shifts to reduce the sample to its actual size. For example, audio formats with 24 bit samples will have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32. To get the original sample use "(int32_t)sample >> 8"."

For ADPCM this might be 12 or 16 or similar Can be 0

Definition at line 116 of file codec_par.h.

◆ profile

int AVCodecParameters::profile

Codec-specific bitstream restrictions that the stream conforms to.

Definition at line 121 of file codec_par.h.

◆ level

int AVCodecParameters::level

Definition at line 122 of file codec_par.h.

◆ width

int AVCodecParameters::width

Video only.

The dimensions of the video frame in pixels.

Definition at line 127 of file codec_par.h.

◆ height

int AVCodecParameters::height

Definition at line 128 of file codec_par.h.

◆ sample_aspect_ratio

AVRational AVCodecParameters::sample_aspect_ratio

Video only.

The aspect ratio (width / height) which a single pixel should have when displayed.

When the aspect ratio is unknown / undefined, the numerator should be set to 0 (the denominator may have any value).

Definition at line 137 of file codec_par.h.

◆ field_order

enum AVFieldOrder AVCodecParameters::field_order

Video only.

The order of the fields in interlaced video.

Definition at line 142 of file codec_par.h.

◆ color_range

enum AVColorRange AVCodecParameters::color_range

Video only.

Additional colorspace characteristics.

Definition at line 147 of file codec_par.h.

◆ color_primaries

enum AVColorPrimaries AVCodecParameters::color_primaries

Definition at line 148 of file codec_par.h.

◆ color_trc

enum AVColorTransferCharacteristic AVCodecParameters::color_trc

Definition at line 149 of file codec_par.h.

◆ color_space

enum AVColorSpace AVCodecParameters::color_space

Definition at line 150 of file codec_par.h.

◆ chroma_location

enum AVChromaLocation AVCodecParameters::chroma_location

Definition at line 151 of file codec_par.h.

◆ video_delay

int AVCodecParameters::video_delay

Video only.

Number of delayed frames.

Definition at line 156 of file codec_par.h.

◆ sample_rate

int AVCodecParameters::sample_rate

Audio only.

The number of audio samples per second.

Definition at line 177 of file codec_par.h.

◆ block_align

int AVCodecParameters::block_align

Audio only.

The number of bytes per coded audio frame, required by some formats.

Corresponds to nBlockAlign in WAVEFORMATEX.

Definition at line 184 of file codec_par.h.

◆ frame_size

int AVCodecParameters::frame_size

Audio only.

Audio frame size, if known. Required by some formats to be static.

Definition at line 188 of file codec_par.h.

◆ initial_padding

int AVCodecParameters::initial_padding

Audio only.

The amount of padding (in samples) inserted by the encoder at the beginning of the audio. I.e. this number of leading decoded samples must be discarded by the caller to get the original audio without leading padding.

Definition at line 196 of file codec_par.h.

◆ trailing_padding

int AVCodecParameters::trailing_padding

Audio only.

The amount of padding (in samples) appended by the encoder to the end of the audio. I.e. this number of decoded samples must be discarded by the caller from the end of the stream to get the original audio without any trailing padding.

Definition at line 203 of file codec_par.h.

◆ seek_preroll

int AVCodecParameters::seek_preroll

Audio only.

Number of samples to skip after a discontinuity.

Definition at line 207 of file codec_par.h.

◆ ch_layout

AVChannelLayout AVCodecParameters::ch_layout

Audio only.

The channel layout and number of channels.

Definition at line 212 of file codec_par.h.


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