FFmpeg  3.1.3
Data Fields
AVStream Struct Reference

Stream structure. More...

#include <avformat.h>

Data Fields

int index
 stream index in AVFormatContext More...
 
int id
 Format-specific stream ID. More...
 
void * priv_data
 
AVRational time_base
 This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented. More...
 
int64_t start_time
 Decoding: pts of the first frame of the stream in presentation order, in stream time base. More...
 
int64_t duration
 Decoding: duration of the stream, in stream time base. More...
 
int64_t nb_frames
 number of frames in this stream if known or 0 More...
 
int disposition
 AV_DISPOSITION_* bit field. More...
 
enum AVDiscard discard
 Selects which packets can be discarded at will and do not need to be demuxed. More...
 
AVRational sample_aspect_ratio
 sample aspect ratio (0 if unknown) More...
 
AVDictionarymetadata
 
AVRational avg_frame_rate
 Average framerate. More...
 
AVPacket attached_pic
 For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet will contain the attached picture. More...
 
AVPacketSideDataside_data
 An array of side data that applies to the whole stream (i.e. More...
 
int nb_side_data
 The number of elements in the AVStream.side_data array. More...
 
int event_flags
 Flags for the user to detect events happening on the stream. More...
 
struct {
   int64_t   last_dts
 
   int64_t   duration_gcd
 
   int   duration_count
 
   int64_t   rfps_duration_sum
 
   double(*   duration_error )[2][MAX_STD_TIMEBASES]
 
   int64_t   codec_info_duration
 
   int64_t   codec_info_duration_fields
 
   int   found_decoder
 0 -> decoder has not been searched for yet. More...
 
   int64_t   last_duration
 
   int64_t   fps_first_dts
 Those are used for average framerate estimation. More...
 
   int   fps_first_dts_idx
 
   int64_t   fps_last_dts
 
   int   fps_last_dts_idx
 
} * info
 
int pts_wrap_bits
 number of bits in pts (used for wrapping control) More...
 
int64_t first_dts
 Timestamp corresponding to the last dts sync point. More...
 
int64_t cur_dts
 
int64_t last_IP_pts
 
int last_IP_duration
 
int probe_packets
 Number of packets to buffer for codec probing. More...
 
int codec_info_nb_frames
 Number of frames that have been demuxed during av_find_stream_info() More...
 
enum AVStreamParseType need_parsing
 
struct AVCodecParserContextparser
 
struct AVPacketListlast_in_packet_buffer
 last packet in packet_buffer for this stream when muxing. More...
 
AVProbeData probe_data
 
int64_t pts_buffer [MAX_REORDER_DELAY+1]
 
AVIndexEntryindex_entries
 Only used if the format does not support seeking natively. More...
 
int nb_index_entries
 
unsigned int index_entries_allocated_size
 
AVRational r_frame_rate
 Real base framerate of the stream. More...
 
int stream_identifier
 Stream Identifier This is the MPEG-TS stream identifier +1 0 means unknown. More...
 
int64_t interleaver_chunk_size
 
int64_t interleaver_chunk_duration
 
int request_probe
 stream probing state -1 -> probing finished 0 -> no probing requested rest -> perform probing with request_probe being the minimum score to accept. More...
 
int skip_to_keyframe
 Indicates that everything up to the next keyframe should be discarded. More...
 
int skip_samples
 Number of samples to skip at the start of the frame decoded from the next packet. More...
 
int64_t start_skip_samples
 If not 0, the number of samples that should be skipped from the start of the stream (the samples are removed from packets with pts==0, which also assumes negative timestamps do not happen). More...
 
int64_t first_discard_sample
 If not 0, the first audio sample that should be discarded from the stream. More...
 
int64_t last_discard_sample
 The sample after last sample that is intended to be discarded after first_discard_sample. More...
 
int nb_decoded_frames
 Number of internally decoded frames, used internally in libavformat, do not access its lifetime differs from info which is why it is not in that structure. More...
 
int64_t mux_ts_offset
 Timestamp offset added to timestamps before muxing NOT PART OF PUBLIC API. More...
 
int64_t pts_wrap_reference
 Internal data to check for wrapping of the time stamp. More...
 
int pts_wrap_behavior
 Options for behavior, when a wrap is detected. More...
 
int update_initial_durations_done
 Internal data to prevent doing update_initial_durations() twice. More...
 
int64_t pts_reorder_error [MAX_REORDER_DELAY+1]
 Internal data to generate dts from pts. More...
 
uint8_t pts_reorder_error_count [MAX_REORDER_DELAY+1]
 
int64_t last_dts_for_order_check
 Internal data to analyze DTS and detect faulty mpeg streams. More...
 
uint8_t dts_ordered
 
uint8_t dts_misordered
 
int inject_global_side_data
 Internal data to inject global side data. More...
 
char * recommended_encoder_configuration
 String containing paris of key and values describing recommended encoder configuration. More...
 
AVRational display_aspect_ratio
 display aspect ratio (0 if unknown) More...
 
struct FFFrac * priv_pts
 
AVStreamInternalinternal
 An opaque field for libavformat internal usage. More...
 
AVCodecParameterscodecpar
 

Detailed Description

Stream structure.

New fields can be added to the end with minor version bumps. Removal, reordering and changes to existing fields require a major version bump. sizeof(AVStream) must not be used outside libav*.

Examples:
demuxing_decoding.c, muxing.c, remuxing.c, transcode_aac.c, and transcoding.c.

Definition at line 876 of file avformat.h.

Field Documentation

int AVStream::index

stream index in AVFormatContext

Examples:
muxing.c.

Definition at line 877 of file avformat.h.

Referenced by write_frame().

int AVStream::id

Format-specific stream ID.

decoding: set by libavformat encoding: set by the user, replaced by libavformat if left unset

Examples:
muxing.c.

Definition at line 883 of file avformat.h.

Referenced by add_stream().

void* AVStream::priv_data

Definition at line 891 of file avformat.h.

AVRational AVStream::time_base

This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented.

decoding: set by libavformat encoding: May be set by the caller before avformat_write_header() to provide a hint to the muxer about the desired timebase. In avformat_write_header(), the muxer will overwrite this field with the timebase that will actually be used for the timestamps written into the file (which may or may not be related to the user-provided one, depending on the format).

Examples:
filtering_audio.c, filtering_video.c, muxing.c, remuxing.c, transcode_aac.c, and transcoding.c.

Definition at line 913 of file avformat.h.

Referenced by add_stream(), encode_write_frame(), init_filters(), log_packet(), main(), open_output_file(), and write_frame().

int64_t AVStream::start_time

Decoding: pts of the first frame of the stream in presentation order, in stream time base.

Only set this if you are absolutely 100% sure that the value you set it to really is the pts of the first frame. This may be undefined (AV_NOPTS_VALUE).

Note
The ASF header does NOT contain a correct start_time the ASF demuxer must NOT set this.

Definition at line 923 of file avformat.h.

int64_t AVStream::duration

Decoding: duration of the stream, in stream time base.

If a source file does not specify a duration, but does specify a bitrate, this value will be estimated from bitrate and file size.

Definition at line 930 of file avformat.h.

int64_t AVStream::nb_frames

number of frames in this stream if known or 0

Definition at line 932 of file avformat.h.

int AVStream::disposition

AV_DISPOSITION_* bit field.

Definition at line 934 of file avformat.h.

enum AVDiscard AVStream::discard

Selects which packets can be discarded at will and do not need to be demuxed.

Definition at line 936 of file avformat.h.

AVRational AVStream::sample_aspect_ratio

sample aspect ratio (0 if unknown)

  • encoding: Set by user.
  • decoding: Set by libavformat.

Definition at line 943 of file avformat.h.

AVDictionary* AVStream::metadata

Definition at line 945 of file avformat.h.

AVRational AVStream::avg_frame_rate

Average framerate.

Definition at line 954 of file avformat.h.

AVPacket AVStream::attached_pic

For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet will contain the attached picture.

decoding: set by libavformat, must not be modified by the caller. encoding: unused

Definition at line 963 of file avformat.h.

AVPacketSideData* AVStream::side_data

An array of side data that applies to the whole stream (i.e.

the container does not allow it to change between packets).

There may be no overlap between the side data in this array and side data in the packets. I.e. a given side data is either exported by the muxer (demuxing) / set by the caller (muxing) in this array, then it never appears in the packets, or the side data is exported / sent through the packets (always in the first packet where the value becomes known or changes), then it does not appear in this array.

  • demuxing: Set by libavformat when the stream is created.
  • muxing: May be set by the caller before avformat_write_header().

Freed by libavformat in avformat_free_context().

See also
av_format_inject_global_side_data()

Definition at line 983 of file avformat.h.

int AVStream::nb_side_data

The number of elements in the AVStream.side_data array.

Definition at line 987 of file avformat.h.

int AVStream::event_flags

Flags for the user to detect events happening on the stream.

Flags must be cleared by the user once the event has been handled. A combination of AVSTREAM_EVENT_FLAG_*.

Definition at line 994 of file avformat.h.

int64_t AVStream::last_dts

Definition at line 1010 of file avformat.h.

int64_t AVStream::duration_gcd

Definition at line 1011 of file avformat.h.

int AVStream::duration_count

Definition at line 1012 of file avformat.h.

int64_t AVStream::rfps_duration_sum

Definition at line 1013 of file avformat.h.

double(* AVStream::duration_error)[2][MAX_STD_TIMEBASES]

Definition at line 1014 of file avformat.h.

int64_t AVStream::codec_info_duration

Definition at line 1015 of file avformat.h.

int64_t AVStream::codec_info_duration_fields

Definition at line 1016 of file avformat.h.

int AVStream::found_decoder

0 -> decoder has not been searched for yet.

>0 -> decoder found <0 -> decoder with codec_id == -found_decoder has not been found

Definition at line 1023 of file avformat.h.

int64_t AVStream::last_duration

Definition at line 1025 of file avformat.h.

int64_t AVStream::fps_first_dts

Those are used for average framerate estimation.

Definition at line 1030 of file avformat.h.

int AVStream::fps_first_dts_idx

Definition at line 1031 of file avformat.h.

int64_t AVStream::fps_last_dts

Definition at line 1032 of file avformat.h.

int AVStream::fps_last_dts_idx

Definition at line 1033 of file avformat.h.

struct { ... } * AVStream::info
int AVStream::pts_wrap_bits

number of bits in pts (used for wrapping control)

Definition at line 1037 of file avformat.h.

int64_t AVStream::first_dts

Timestamp corresponding to the last dts sync point.

Initialized when AVCodecParserContext.dts_sync_point >= 0 and a DTS is received from the underlying container. Otherwise set to AV_NOPTS_VALUE by default.

Definition at line 1047 of file avformat.h.

int64_t AVStream::cur_dts

Definition at line 1048 of file avformat.h.

int64_t AVStream::last_IP_pts

Definition at line 1049 of file avformat.h.

int AVStream::last_IP_duration

Definition at line 1050 of file avformat.h.

int AVStream::probe_packets

Number of packets to buffer for codec probing.

Definition at line 1055 of file avformat.h.

int AVStream::codec_info_nb_frames

Number of frames that have been demuxed during av_find_stream_info()

Definition at line 1060 of file avformat.h.

enum AVStreamParseType AVStream::need_parsing

Definition at line 1063 of file avformat.h.

struct AVCodecParserContext* AVStream::parser

Definition at line 1064 of file avformat.h.

struct AVPacketList* AVStream::last_in_packet_buffer

last packet in packet_buffer for this stream when muxing.

Definition at line 1069 of file avformat.h.

AVProbeData AVStream::probe_data

Definition at line 1070 of file avformat.h.

int64_t AVStream::pts_buffer[MAX_REORDER_DELAY+1]

Definition at line 1072 of file avformat.h.

AVIndexEntry* AVStream::index_entries

Only used if the format does not support seeking natively.

Definition at line 1074 of file avformat.h.

int AVStream::nb_index_entries

Definition at line 1076 of file avformat.h.

unsigned int AVStream::index_entries_allocated_size

Definition at line 1077 of file avformat.h.

AVRational AVStream::r_frame_rate

Real base framerate of the stream.

This is the lowest framerate with which all timestamps can be represented accurately (it is the least common multiple of all framerates in the stream). Note, this value is just a guess! For example, if the time base is 1/90000 and all frames have either approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.

Code outside avformat should access this field using: av_stream_get/set_r_frame_rate(stream)

Definition at line 1090 of file avformat.h.

int AVStream::stream_identifier

Stream Identifier This is the MPEG-TS stream identifier +1 0 means unknown.

Definition at line 1097 of file avformat.h.

int64_t AVStream::interleaver_chunk_size

Definition at line 1099 of file avformat.h.

int64_t AVStream::interleaver_chunk_duration

Definition at line 1100 of file avformat.h.

int AVStream::request_probe

stream probing state -1 -> probing finished 0 -> no probing requested rest -> perform probing with request_probe being the minimum score to accept.

NOT PART OF PUBLIC API

Definition at line 1109 of file avformat.h.

int AVStream::skip_to_keyframe

Indicates that everything up to the next keyframe should be discarded.

Definition at line 1114 of file avformat.h.

int AVStream::skip_samples

Number of samples to skip at the start of the frame decoded from the next packet.

Definition at line 1119 of file avformat.h.

int64_t AVStream::start_skip_samples

If not 0, the number of samples that should be skipped from the start of the stream (the samples are removed from packets with pts==0, which also assumes negative timestamps do not happen).

Intended for use with formats such as mp3 with ad-hoc gapless audio support.

Definition at line 1128 of file avformat.h.

int64_t AVStream::first_discard_sample

If not 0, the first audio sample that should be discarded from the stream.

This is broken by design (needs global sample count), but can't be avoided for broken by design formats such as mp3 with ad-hoc gapless audio support.

Definition at line 1136 of file avformat.h.

int64_t AVStream::last_discard_sample

The sample after last sample that is intended to be discarded after first_discard_sample.

Works on frame boundaries only. Used to prevent early EOF if the gapless info is broken (considered concatenated mp3s).

Definition at line 1143 of file avformat.h.

int AVStream::nb_decoded_frames

Number of internally decoded frames, used internally in libavformat, do not access its lifetime differs from info which is why it is not in that structure.

Definition at line 1149 of file avformat.h.

int64_t AVStream::mux_ts_offset

Timestamp offset added to timestamps before muxing NOT PART OF PUBLIC API.

Definition at line 1155 of file avformat.h.

int64_t AVStream::pts_wrap_reference

Internal data to check for wrapping of the time stamp.

Definition at line 1160 of file avformat.h.

int AVStream::pts_wrap_behavior

Options for behavior, when a wrap is detected.

Defined by AV_PTS_WRAP_ values.

If correction is enabled, there are two possibilities: If the first time stamp is near the wrap point, the wrap offset will be subtracted, which will create negative time stamps. Otherwise the offset will be added.

Definition at line 1172 of file avformat.h.

int AVStream::update_initial_durations_done

Internal data to prevent doing update_initial_durations() twice.

Definition at line 1177 of file avformat.h.

int64_t AVStream::pts_reorder_error[MAX_REORDER_DELAY+1]

Internal data to generate dts from pts.

Definition at line 1182 of file avformat.h.

uint8_t AVStream::pts_reorder_error_count[MAX_REORDER_DELAY+1]

Definition at line 1183 of file avformat.h.

int64_t AVStream::last_dts_for_order_check

Internal data to analyze DTS and detect faulty mpeg streams.

Definition at line 1188 of file avformat.h.

uint8_t AVStream::dts_ordered

Definition at line 1189 of file avformat.h.

uint8_t AVStream::dts_misordered

Definition at line 1190 of file avformat.h.

int AVStream::inject_global_side_data

Internal data to inject global side data.

Definition at line 1195 of file avformat.h.

char* AVStream::recommended_encoder_configuration

String containing paris of key and values describing recommended encoder configuration.

Paris are separated by ','. Keys are separated from values by '='.

Definition at line 1202 of file avformat.h.

AVRational AVStream::display_aspect_ratio

display aspect ratio (0 if unknown)

  • encoding: unused
  • decoding: Set by libavformat to calculate sample_aspect_ratio internally

Definition at line 1209 of file avformat.h.

struct FFFrac* AVStream::priv_pts

Definition at line 1211 of file avformat.h.

AVStreamInternal* AVStream::internal

An opaque field for libavformat internal usage.

Must not be accessed in any way by callers.

Definition at line 1217 of file avformat.h.

AVCodecParameters* AVStream::codecpar

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