FFmpeg: libavformat/avformat.h File Reference

FFmpeg

libavformat

Data Structures | Macros | Typedefs | Enumerations | Functions

avformat.h File Reference

#include <time.h>
#include <stdio.h>
#include "libavcodec/codec.h"
#include "libavcodec/codec_par.h"
#include "libavcodec/defs.h"
#include "libavcodec/packet.h"
#include "libavutil/dict.h"
#include "libavutil/log.h"
#include "avio.h"
#include "libavformat/version_major.h"

Go to the source code of this file.

Data Structures

struct AVProbeData

This structure contains the data a format has to probe a file. More...

struct AVOutputFormat

struct AVInputFormat

struct AVIndexEntry

struct AVStream

Stream structure. More...

struct AVProgram

New fields can be added to the end with minor version bumps. More...

struct AVChapter

struct AVFormatContext

Format I/O context. More...

Macros

#define AVPROBE_SCORE_RETRY (AVPROBE_SCORE_MAX/4)

#define AVPROBE_SCORE_STREAM_RETRY (AVPROBE_SCORE_MAX/4-1)

#define AVPROBE_SCORE_EXTENSION 50

score for file extension More...

#define AVPROBE_SCORE_MIME 75

score for file mime type More...

#define AVPROBE_SCORE_MAX 100

maximum score More...

#define AVPROBE_PADDING_SIZE 32

extra allocated bytes at the end of the probe buffer More...

#define AVFMT_NOFILE 0x0001

Demuxer will use avio_open, no opened file should be provided by the caller. More...

#define AVFMT_NEEDNUMBER 0x0002

Needs 'd' in filename. More...

#define AVFMT_EXPERIMENTAL 0x0004

The muxer/demuxer is experimental and should be used with caution. More...

#define AVFMT_SHOW_IDS 0x0008

Show format stream IDs numbers. More...

#define AVFMT_GLOBALHEADER 0x0040

Format wants global header. More...

#define AVFMT_NOTIMESTAMPS 0x0080

Format does not need / have any timestamps. More...

#define AVFMT_GENERIC_INDEX 0x0100

Use generic index building code. More...

#define AVFMT_TS_DISCONT 0x0200

Format allows timestamp discontinuities. More...

#define AVFMT_VARIABLE_FPS 0x0400

Format allows variable fps. More...

#define AVFMT_NODIMENSIONS 0x0800

Format does not need width/height. More...

#define AVFMT_NOSTREAMS 0x1000

Format does not require any streams. More...

#define AVFMT_NOBINSEARCH 0x2000

Format does not allow to fall back on binary search via read_timestamp. More...

#define AVFMT_NOGENSEARCH 0x4000

Format does not allow to fall back on generic search. More...

#define AVFMT_NO_BYTE_SEEK 0x8000

Format does not allow seeking by bytes. More...

#define AVFMT_ALLOW_FLUSH 0x10000

Format allows flushing. More...

#define AVFMT_TS_NONSTRICT 0x20000

Format does not require strictly increasing timestamps, but they must still be monotonic. More...

#define AVFMT_TS_NEGATIVE 0x40000

Format allows muxing negative timestamps. More...

#define AVFMT_SEEK_TO_PTS 0x4000000

Seeking is based on PTS. More...

#define AVINDEX_KEYFRAME 0x0001

#define AVINDEX_DISCARD_FRAME

#define AV_DISPOSITION_DEFAULT (1 << 0)

The stream should be chosen by default among other streams of the same type, unless the user has explicitly specified otherwise. More...

#define AV_DISPOSITION_DUB (1 << 1)

The stream is not in original language. More...

#define AV_DISPOSITION_ORIGINAL (1 << 2)

The stream is in original language. More...

#define AV_DISPOSITION_COMMENT (1 << 3)

The stream is a commentary track. More...

#define AV_DISPOSITION_LYRICS (1 << 4)

The stream contains song lyrics. More...

#define AV_DISPOSITION_KARAOKE (1 << 5)

The stream contains karaoke audio. More...

#define AV_DISPOSITION_FORCED (1 << 6)

Track should be used during playback by default. More...

#define AV_DISPOSITION_HEARING_IMPAIRED (1 << 7)

The stream is intended for hearing impaired audiences. More...

#define AV_DISPOSITION_VISUAL_IMPAIRED (1 << 8)

The stream is intended for visually impaired audiences. More...

#define AV_DISPOSITION_CLEAN_EFFECTS (1 << 9)

The audio stream contains music and sound effects without voice. More...

#define AV_DISPOSITION_ATTACHED_PIC (1 << 10)

The stream is stored in the file as an attached picture/"cover art" (e.g. More...

#define AV_DISPOSITION_TIMED_THUMBNAILS (1 << 11)

The stream is sparse, and contains thumbnail images, often corresponding to chapter markers. More...

#define AV_DISPOSITION_NON_DIEGETIC (1 << 12)

The stream is intended to be mixed with a spatial audio track. More...

#define AV_DISPOSITION_CAPTIONS (1 << 16)

The subtitle stream contains captions, providing a transcription and possibly a translation of audio. More...

#define AV_DISPOSITION_DESCRIPTIONS (1 << 17)

The subtitle stream contains a textual description of the video content. More...

#define AV_DISPOSITION_METADATA (1 << 18)

The subtitle stream contains time-aligned metadata that is not intended to be directly presented to the user. More...

#define AV_DISPOSITION_DEPENDENT (1 << 19)

The audio stream is intended to be mixed with another stream before presentation. More...

#define AV_DISPOSITION_STILL_IMAGE (1 << 20)

The video stream contains still images. More...

#define AV_PTS_WRAP_IGNORE 0

Options for behavior on timestamp wrap detection. More...

#define AV_PTS_WRAP_ADD_OFFSET 1

add the format specific offset on wrap detection More...

#define AV_PTS_WRAP_SUB_OFFSET -1

subtract the format specific offset on wrap detection More...

#define AVSTREAM_EVENT_FLAG_METADATA_UPDATED 0x0001

#define AVSTREAM_EVENT_FLAG_NEW_PACKETS (1 << 1)

#define AV_PROGRAM_RUNNING 1

#define AVFMTCTX_NOHEADER 0x0001

signal that no header is present (streams are added dynamically) More...

#define AVFMTCTX_UNSEEKABLE 0x0002

signal that the stream is definitely not seekable, and attempts to call the seek function will fail. More...

#define AVFMT_FLAG_GENPTS 0x0001

Generate missing pts even if it requires parsing future frames. More...

#define AVFMT_FLAG_IGNIDX 0x0002

Ignore index. More...

#define AVFMT_FLAG_NONBLOCK 0x0004

Do not block when reading packets from input. More...

#define AVFMT_FLAG_IGNDTS 0x0008

Ignore DTS on frames that contain both DTS & PTS. More...

#define AVFMT_FLAG_NOFILLIN 0x0010

Do not infer any values from other values, just return what is stored in the container. More...

#define AVFMT_FLAG_NOPARSE 0x0020

Do not use AVParsers, you also must set AVFMT_FLAG_NOFILLIN as the fillin code works on frames and no parsing -> no frames. Also seeking to frames can not work if parsing to find frame boundaries has been disabled. More...

#define AVFMT_FLAG_NOBUFFER 0x0040

Do not buffer frames when possible. More...

#define AVFMT_FLAG_CUSTOM_IO 0x0080

The caller has supplied a custom AVIOContext, don't avio_close() it. More...

#define AVFMT_FLAG_DISCARD_CORRUPT 0x0100

Discard frames marked corrupted. More...

#define AVFMT_FLAG_FLUSH_PACKETS 0x0200

Flush the AVIOContext every packet. More...

#define AVFMT_FLAG_BITEXACT 0x0400

When muxing, try to avoid writing any random/volatile data to the output. More...

#define AVFMT_FLAG_SORT_DTS 0x10000

try to interleave outputted packets by dts (using this flag can slow demuxing down) More...

#define AVFMT_FLAG_FAST_SEEK 0x80000

Enable fast, but inaccurate seeks for some formats. More...

#define AVFMT_FLAG_SHORTEST 0x100000

Stop muxing when the shortest stream stops. More...

#define AVFMT_FLAG_AUTO_BSF 0x200000

Add bitstream filters as requested by the muxer. More...

#define FF_FDEBUG_TS 0x0001

#define AVFMT_EVENT_FLAG_METADATA_UPDATED 0x0001

#define AVFMT_AVOID_NEG_TS_AUTO -1

Enabled when required by target format. More...

#define AVFMT_AVOID_NEG_TS_DISABLED 0

Do not shift timestamps even when they are negative. More...

#define AVFMT_AVOID_NEG_TS_MAKE_NON_NEGATIVE 1

Shift timestamps so they are non negative. More...

#define AVFMT_AVOID_NEG_TS_MAKE_ZERO 2

Shift timestamps so that they start at 0. More...

#define AVSEEK_FLAG_BACKWARD 1

#define AVSEEK_FLAG_BYTE 2

seeking based on position in bytes More...

#define AVSEEK_FLAG_ANY 4

seek to any frame, even non-keyframes More...

#define AVSEEK_FLAG_FRAME 8

seeking based on frame number More...

#define AVSTREAM_INIT_IN_WRITE_HEADER 0

stream parameters initialized in avformat_write_header More...

#define AVSTREAM_INIT_IN_INIT_OUTPUT 1

stream parameters initialized in avformat_init_output More...

#define AV_FRAME_FILENAME_FLAGS_MULTIPLE 1

Allow multiple d. More...

Typedefs

typedef int(* av_format_control_message) (struct AVFormatContext *s, int type, void *data, size_t data_size)

Callback used by devices to communicate with application. More...

typedef int(* AVOpenCallback) (struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags, const AVIOInterruptCB *int_cb, AVDictionary **options)

Enumerations

enum AVStreamParseType {
AVSTREAM_PARSE_NONE, AVSTREAM_PARSE_FULL, AVSTREAM_PARSE_HEADERS, AVSTREAM_PARSE_TIMESTAMPS,
AVSTREAM_PARSE_FULL_ONCE, AVSTREAM_PARSE_FULL_RAW
}

enum AVDurationEstimationMethod { AVFMT_DURATION_FROM_PTS, AVFMT_DURATION_FROM_STREAM, AVFMT_DURATION_FROM_BITRATE }

The duration of a video can be estimated through various ways, and this enum can be used to know how the duration was estimated. More...

enum AVTimebaseSource { AVFMT_TBCF_AUTO = -1, AVFMT_TBCF_DECODER, AVFMT_TBCF_DEMUXER }

Functions

int av_get_packet (AVIOContext *s, AVPacket *pkt, int size)

Allocate and read the payload of a packet and initialize its fields with default values. More...

int av_append_packet (AVIOContext *s, AVPacket *pkt, int size)

Read data and append it to the current content of the AVPacket. More...

int av_disposition_from_string (const char *disp)

const char * av_disposition_to_string (int disposition)

struct AVCodecParserContext * av_stream_get_parser (const AVStream *s)

int64_t av_stream_get_end_pts (const AVStream *st)

Returns the pts of the last muxed packet + its duration. More...

void av_format_inject_global_side_data (AVFormatContext *s)

This function will cause global side data to be injected in the next packet of each stream as well as after any subsequent seek. More...

enum AVDurationEstimationMethod av_fmt_ctx_get_duration_estimation_method (const AVFormatContext *ctx)

Returns the method used to set ctx->duration. More...

unsigned avformat_version (void)

Return the LIBAVFORMAT_VERSION_INT constant. More...

const char * avformat_configuration (void)

Return the libavformat build-time configuration. More...

const char * avformat_license (void)

Return the libavformat license. More...

int avformat_network_init (void)

Do global initialization of network libraries. More...

int avformat_network_deinit (void)

Undo the initialization done by avformat_network_init. More...

const AVOutputFormat * av_muxer_iterate (void **opaque)

Iterate over all registered muxers. More...

const AVInputFormat * av_demuxer_iterate (void **opaque)

Iterate over all registered demuxers. More...

AVFormatContext * avformat_alloc_context (void)

Allocate an AVFormatContext. More...

void avformat_free_context (AVFormatContext *s)

Free an AVFormatContext and all its streams. More...

const AVClass * avformat_get_class (void)

Get the AVClass for AVFormatContext. More...

const AVClass * av_stream_get_class (void)

Get the AVClass for AVStream. More...

AVStream * avformat_new_stream (AVFormatContext *s, const AVCodec *c)

Add a new stream to a media file. More...

int av_stream_add_side_data (AVStream *st, enum AVPacketSideDataType type, uint8_t *data, size_t size)

Wrap an existing array as stream side data. More...

uint8_t * av_stream_new_side_data (AVStream *stream, enum AVPacketSideDataType type, size_t size)

Allocate new information from stream. More...

uint8_t * av_stream_get_side_data (const AVStream *stream, enum AVPacketSideDataType type, size_t *size)

Get side information from stream. More...

AVProgram * av_new_program (AVFormatContext *s, int id)

int avformat_alloc_output_context2 (AVFormatContext **ctx, const AVOutputFormat *oformat, const char *format_name, const char *filename)

Allocate an AVFormatContext for an output format. More...

const AVInputFormat * av_find_input_format (const char *short_name)

Find AVInputFormat based on the short name of the input format. More...

const AVInputFormat * av_probe_input_format (const AVProbeData *pd, int is_opened)

Guess the file format. More...

const AVInputFormat * av_probe_input_format2 (const AVProbeData *pd, int is_opened, int *score_max)

Guess the file format. More...

const AVInputFormat * av_probe_input_format3 (const AVProbeData *pd, int is_opened, int *score_ret)

Guess the file format. More...

int av_probe_input_buffer2 (AVIOContext *pb, const AVInputFormat **fmt, const char *url, void *logctx, unsigned int offset, unsigned int max_probe_size)

Probe a bytestream to determine the input format. More...

int av_probe_input_buffer (AVIOContext *pb, const AVInputFormat **fmt, const char *url, void *logctx, unsigned int offset, unsigned int max_probe_size)

Like av_probe_input_buffer2() but returns 0 on success. More...

int avformat_open_input (AVFormatContext **ps, const char *url, const AVInputFormat *fmt, AVDictionary **options)

Open an input stream and read the header. More...

int avformat_find_stream_info (AVFormatContext *ic, AVDictionary **options)

Read packets of a media file to get stream information. More...

AVProgram * av_find_program_from_stream (AVFormatContext *ic, AVProgram *last, int s)

Find the programs which belong to a given stream. More...

void av_program_add_stream_index (AVFormatContext *ac, int progid, unsigned int idx)

int av_find_best_stream (AVFormatContext *ic, enum AVMediaType type, int wanted_stream_nb, int related_stream, const AVCodec **decoder_ret, int flags)

Find the "best" stream in the file. More...

int av_read_frame (AVFormatContext *s, AVPacket *pkt)

Return the next frame of a stream. More...

int av_seek_frame (AVFormatContext *s, int stream_index, int64_t timestamp, int flags)

Seek to the keyframe at timestamp. More...

int avformat_seek_file (AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags)

Seek to timestamp ts. More...

int avformat_flush (AVFormatContext *s)

Discard all internally buffered data. More...

int av_read_play (AVFormatContext *s)

Start playing a network-based stream (e.g. More...

int av_read_pause (AVFormatContext *s)

Pause a network-based stream (e.g. More...

void avformat_close_input (AVFormatContext **s)

Close an opened input AVFormatContext. More...

av_warn_unused_result int avformat_write_header (AVFormatContext *s, AVDictionary **options)

Allocate the stream private data and write the stream header to an output media file. More...

av_warn_unused_result int avformat_init_output (AVFormatContext *s, AVDictionary **options)

Allocate the stream private data and initialize the codec, but do not write the header. More...

int av_write_frame (AVFormatContext *s, AVPacket *pkt)

Write a packet to an output media file. More...

int av_interleaved_write_frame (AVFormatContext *s, AVPacket *pkt)

Write a packet to an output media file ensuring correct interleaving. More...

int av_write_uncoded_frame (AVFormatContext *s, int stream_index, AVFrame *frame)

Write an uncoded frame to an output media file. More...

int av_interleaved_write_uncoded_frame (AVFormatContext *s, int stream_index, AVFrame *frame)

Write an uncoded frame to an output media file. More...

int av_write_uncoded_frame_query (AVFormatContext *s, int stream_index)

Test whether a muxer supports uncoded frame. More...

int av_write_trailer (AVFormatContext *s)

Write the stream trailer to an output media file and free the file private data. More...

const AVOutputFormat * av_guess_format (const char *short_name, const char *filename, const char *mime_type)

Return the output format in the list of registered output formats which best matches the provided parameters, or return NULL if there is no match. More...

enum AVCodecID av_guess_codec (const AVOutputFormat *fmt, const char *short_name, const char *filename, const char *mime_type, enum AVMediaType type)

Guess the codec ID based upon muxer and filename. More...

int av_get_output_timestamp (struct AVFormatContext *s, int stream, int64_t *dts, int64_t *wall)

Get timing information for the data currently output. More...

void av_hex_dump (FILE *f, const uint8_t *buf, int size)

Send a nice hexadecimal dump of a buffer to the specified file stream. More...

void av_hex_dump_log (void *avcl, int level, const uint8_t *buf, int size)

Send a nice hexadecimal dump of a buffer to the log. More...

void av_pkt_dump2 (FILE *f, const AVPacket *pkt, int dump_payload, const AVStream *st)

Send a nice dump of a packet to the specified file stream. More...

void av_pkt_dump_log2 (void *avcl, int level, const AVPacket *pkt, int dump_payload, const AVStream *st)

Send a nice dump of a packet to the log. More...

enum AVCodecID av_codec_get_id (const struct AVCodecTag *const *tags, unsigned int tag)

Get the AVCodecID for the given codec tag tag. More...

unsigned int av_codec_get_tag (const struct AVCodecTag *const *tags, enum AVCodecID id)

Get the codec tag for the given codec id id. More...

int av_codec_get_tag2 (const struct AVCodecTag *const *tags, enum AVCodecID id, unsigned int *tag)

Get the codec tag for the given codec id. More...

int av_find_default_stream_index (AVFormatContext *s)

int av_index_search_timestamp (AVStream *st, int64_t timestamp, int flags)

Get the index for a specific timestamp. More...

int avformat_index_get_entries_count (const AVStream *st)

Get the index entry count for the given AVStream. More...

const AVIndexEntry * avformat_index_get_entry (AVStream *st, int idx)

Get the AVIndexEntry corresponding to the given index. More...

const AVIndexEntry * avformat_index_get_entry_from_timestamp (AVStream *st, int64_t wanted_timestamp, int flags)

Get the AVIndexEntry corresponding to the given timestamp. More...

int av_add_index_entry (AVStream *st, int64_t pos, int64_t timestamp, int size, int distance, int flags)

Add an index entry into a sorted list. More...

void av_url_split (char *proto, int proto_size, char *authorization, int authorization_size, char *hostname, int hostname_size, int *port_ptr, char *path, int path_size, const char *url)

Split a URL string into components. More...

void av_dump_format (AVFormatContext *ic, int index, const char *url, int is_output)

Print detailed information about the input or output format, such as duration, bitrate, streams, container, programs, metadata, side data, codec and time base. More...

int av_get_frame_filename2 (char *buf, int buf_size, const char *path, int number, int flags)

Return in 'buf' the path with 'd' replaced by a number. More...

int av_get_frame_filename (char *buf, int buf_size, const char *path, int number)

int av_filename_number_test (const char *filename)

Check whether filename actually is a numbered sequence generator. More...

int av_sdp_create (AVFormatContext *ac[], int n_files, char *buf, int size)

Generate an SDP for an RTP session. More...

int av_match_ext (const char *filename, const char *extensions)

Return a positive value if the given filename has one of the given extensions, 0 otherwise. More...

int avformat_query_codec (const AVOutputFormat *ofmt, enum AVCodecID codec_id, int std_compliance)

Test if the given container can store a codec. More...

const struct AVCodecTag * avformat_get_riff_video_tags (void)

const struct AVCodecTag * avformat_get_riff_audio_tags (void)

const struct AVCodecTag * avformat_get_mov_video_tags (void)

const struct AVCodecTag * avformat_get_mov_audio_tags (void)

AVRational av_guess_sample_aspect_ratio (AVFormatContext *format, AVStream *stream, AVFrame *frame)

Guess the sample aspect ratio of a frame, based on both the stream and the frame aspect ratio. More...

AVRational av_guess_frame_rate (AVFormatContext *ctx, AVStream *stream, AVFrame *frame)

Guess the frame rate, based on both the container and codec information. More...

int avformat_match_stream_specifier (AVFormatContext *s, AVStream *st, const char *spec)

Check if the stream st contained in s is matched by the stream specifier spec. More...

int avformat_queue_attached_pictures (AVFormatContext *s)

int avformat_transfer_internal_stream_timing_info (const AVOutputFormat *ofmt, AVStream *ost, const AVStream *ist, enum AVTimebaseSource copy_tb)

Transfer internal timing information from one stream to another. More...

AVRational av_stream_get_codec_timebase (const AVStream *st)

Get the internal codec timebase from a stream. More...

Detailed Description

Main libavformat public API header

Definition in file avformat.h.

Macro Definition Documentation

◆ AVPROBE_SCORE_RETRY

#define AVPROBE_SCORE_RETRY (AVPROBE_SCORE_MAX/4)

Definition at line 460 of file avformat.h.

◆ AVPROBE_SCORE_STREAM_RETRY

#define AVPROBE_SCORE_STREAM_RETRY (AVPROBE_SCORE_MAX/4-1)

Definition at line 461 of file avformat.h.

◆ AVPROBE_SCORE_EXTENSION

#define AVPROBE_SCORE_EXTENSION 50

score for file extension

Definition at line 463 of file avformat.h.

◆ AVPROBE_SCORE_MIME

#define AVPROBE_SCORE_MIME 75

score for file mime type

Definition at line 464 of file avformat.h.

◆ AVPROBE_SCORE_MAX

#define AVPROBE_SCORE_MAX 100

maximum score

Definition at line 465 of file avformat.h.

◆ AVPROBE_PADDING_SIZE

#define AVPROBE_PADDING_SIZE 32

extra allocated bytes at the end of the probe buffer

Definition at line 467 of file avformat.h.

◆ AVFMT_NOFILE

#define AVFMT_NOFILE 0x0001

Demuxer will use avio_open, no opened file should be provided by the caller.

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

Definition at line 470 of file avformat.h.

◆ AVFMT_NEEDNUMBER

#define AVFMT_NEEDNUMBER 0x0002

Needs 'd' in filename.

Definition at line 471 of file avformat.h.

◆ AVFMT_EXPERIMENTAL

#define AVFMT_EXPERIMENTAL 0x0004

The muxer/demuxer is experimental and should be used with caution.

demuxers: will not be selected automatically by probing, must be specified explicitly.

Definition at line 478 of file avformat.h.

◆ AVFMT_SHOW_IDS

#define AVFMT_SHOW_IDS 0x0008

Show format stream IDs numbers.

Definition at line 479 of file avformat.h.

◆ AVFMT_GLOBALHEADER

#define AVFMT_GLOBALHEADER 0x0040

Format wants global header.

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

Definition at line 480 of file avformat.h.

◆ AVFMT_NOTIMESTAMPS

#define AVFMT_NOTIMESTAMPS 0x0080

Format does not need / have any timestamps.

Definition at line 481 of file avformat.h.

◆ AVFMT_GENERIC_INDEX

#define AVFMT_GENERIC_INDEX 0x0100

Use generic index building code.

Definition at line 482 of file avformat.h.

◆ AVFMT_TS_DISCONT

#define AVFMT_TS_DISCONT 0x0200

Format allows timestamp discontinuities.

Note, muxers always require valid (monotone) timestamps

Definition at line 483 of file avformat.h.

◆ AVFMT_VARIABLE_FPS

#define AVFMT_VARIABLE_FPS 0x0400

Format allows variable fps.

Definition at line 484 of file avformat.h.

◆ AVFMT_NODIMENSIONS

#define AVFMT_NODIMENSIONS 0x0800

Format does not need width/height.

Definition at line 485 of file avformat.h.

◆ AVFMT_NOSTREAMS

#define AVFMT_NOSTREAMS 0x1000

Format does not require any streams.

Definition at line 486 of file avformat.h.

◆ AVFMT_NOBINSEARCH

#define AVFMT_NOBINSEARCH 0x2000

Format does not allow to fall back on binary search via read_timestamp.

Definition at line 487 of file avformat.h.

◆ AVFMT_NOGENSEARCH

#define AVFMT_NOGENSEARCH 0x4000

Format does not allow to fall back on generic search.

Definition at line 488 of file avformat.h.

◆ AVFMT_NO_BYTE_SEEK

#define AVFMT_NO_BYTE_SEEK 0x8000

Format does not allow seeking by bytes.

Definition at line 489 of file avformat.h.

◆ AVFMT_ALLOW_FLUSH

#define AVFMT_ALLOW_FLUSH 0x10000

Format allows flushing.

If not set, the muxer will not receive a NULL packet in the write_packet function.

Definition at line 490 of file avformat.h.

◆ AVFMT_TS_NONSTRICT

#define AVFMT_TS_NONSTRICT 0x20000

Format does not require strictly increasing timestamps, but they must still be monotonic.

Definition at line 491 of file avformat.h.

◆ AVFMT_TS_NEGATIVE

#define AVFMT_TS_NEGATIVE 0x40000

Format allows muxing negative timestamps.

If not set the timestamp will be shifted in av_write_frame and av_interleaved_write_frame so they start from 0. The user or muxer can override this through AVFormatContext.avoid_negative_ts

Definition at line 494 of file avformat.h.

◆ AVFMT_SEEK_TO_PTS

#define AVFMT_SEEK_TO_PTS 0x4000000

Seeking is based on PTS.

Definition at line 503 of file avformat.h.

◆ AVINDEX_KEYFRAME

#define AVINDEX_KEYFRAME 0x0001

Definition at line 815 of file avformat.h.

◆ AVINDEX_DISCARD_FRAME

#define AVINDEX_DISCARD_FRAME

Value:

0x0002 /**

* Flag is used to indicate which frame should be discarded after decoding.

Definition at line 816 of file avformat.h.

◆ AV_DISPOSITION_DEFAULT

#define AV_DISPOSITION_DEFAULT (1 << 0)

The stream should be chosen by default among other streams of the same type, unless the user has explicitly specified otherwise.

Definition at line 826 of file avformat.h.

◆ AV_DISPOSITION_DUB

#define AV_DISPOSITION_DUB (1 << 1)

The stream is not in original language.

Note: AV_DISPOSITION_ORIGINAL is the inverse of this disposition. At most one of them should be set in properly tagged streams.; This disposition may apply to any stream type, not just audio.

Definition at line 834 of file avformat.h.

◆ AV_DISPOSITION_ORIGINAL

#define AV_DISPOSITION_ORIGINAL (1 << 2)

The stream is in original language.

See also: the notes for AV_DISPOSITION_DUB

Definition at line 840 of file avformat.h.

◆ AV_DISPOSITION_COMMENT

#define AV_DISPOSITION_COMMENT (1 << 3)

The stream is a commentary track.

Definition at line 844 of file avformat.h.

◆ AV_DISPOSITION_LYRICS

#define AV_DISPOSITION_LYRICS (1 << 4)

The stream contains song lyrics.

Definition at line 848 of file avformat.h.

◆ AV_DISPOSITION_KARAOKE

#define AV_DISPOSITION_KARAOKE (1 << 5)

The stream contains karaoke audio.

Definition at line 852 of file avformat.h.

◆ AV_DISPOSITION_FORCED

#define AV_DISPOSITION_FORCED (1 << 6)

Track should be used during playback by default.

Useful for subtitle track that should be displayed even when user did not explicitly ask for subtitles.

Definition at line 859 of file avformat.h.

◆ AV_DISPOSITION_HEARING_IMPAIRED

#define AV_DISPOSITION_HEARING_IMPAIRED (1 << 7)

The stream is intended for hearing impaired audiences.

Definition at line 863 of file avformat.h.

◆ AV_DISPOSITION_VISUAL_IMPAIRED

#define AV_DISPOSITION_VISUAL_IMPAIRED (1 << 8)

The stream is intended for visually impaired audiences.

Definition at line 867 of file avformat.h.

◆ AV_DISPOSITION_CLEAN_EFFECTS

#define AV_DISPOSITION_CLEAN_EFFECTS (1 << 9)

The audio stream contains music and sound effects without voice.

Definition at line 871 of file avformat.h.

◆ AV_DISPOSITION_ATTACHED_PIC

#define AV_DISPOSITION_ATTACHED_PIC (1 << 10)

The stream is stored in the file as an attached picture/"cover art" (e.g.

APIC frame in ID3v2). The first (usually only) packet associated with it will be returned among the first few packets read from the file unless seeking takes place. It can also be accessed at any time in AVStream.attached_pic.

Definition at line 879 of file avformat.h.

◆ AV_DISPOSITION_TIMED_THUMBNAILS

#define AV_DISPOSITION_TIMED_THUMBNAILS (1 << 11)

The stream is sparse, and contains thumbnail images, often corresponding to chapter markers.

Only ever used with AV_DISPOSITION_ATTACHED_PIC.

Definition at line 884 of file avformat.h.

◆ AV_DISPOSITION_NON_DIEGETIC

#define AV_DISPOSITION_NON_DIEGETIC (1 << 12)

The stream is intended to be mixed with a spatial audio track.

For example, it could be used for narration or stereo music, and may remain unchanged by listener head rotation.

Definition at line 891 of file avformat.h.

◆ AV_DISPOSITION_CAPTIONS

#define AV_DISPOSITION_CAPTIONS (1 << 16)

The subtitle stream contains captions, providing a transcription and possibly a translation of audio.

Typically intended for hearing-impaired audiences.

Definition at line 897 of file avformat.h.

◆ AV_DISPOSITION_DESCRIPTIONS

#define AV_DISPOSITION_DESCRIPTIONS (1 << 17)

The subtitle stream contains a textual description of the video content.

Typically intended for visually-impaired audiences or for the cases where the video cannot be seen.

Definition at line 903 of file avformat.h.

◆ AV_DISPOSITION_METADATA

#define AV_DISPOSITION_METADATA (1 << 18)

The subtitle stream contains time-aligned metadata that is not intended to be directly presented to the user.

Definition at line 908 of file avformat.h.

◆ AV_DISPOSITION_DEPENDENT

#define AV_DISPOSITION_DEPENDENT (1 << 19)

The audio stream is intended to be mixed with another stream before presentation.

Corresponds to mix_type=0 in mpegts.

Definition at line 914 of file avformat.h.

◆ AV_DISPOSITION_STILL_IMAGE

#define AV_DISPOSITION_STILL_IMAGE (1 << 20)

The video stream contains still images.

Definition at line 918 of file avformat.h.

◆ AV_PTS_WRAP_IGNORE

#define AV_PTS_WRAP_IGNORE 0

Options for behavior on timestamp wrap detection.

ignore the wrap

Definition at line 937 of file avformat.h.

◆ AV_PTS_WRAP_ADD_OFFSET

#define AV_PTS_WRAP_ADD_OFFSET 1

add the format specific offset on wrap detection

Definition at line 938 of file avformat.h.

◆ AV_PTS_WRAP_SUB_OFFSET

#define AV_PTS_WRAP_SUB_OFFSET -1

subtract the format specific offset on wrap detection

Definition at line 939 of file avformat.h.

◆ AVSTREAM_EVENT_FLAG_METADATA_UPDATED

#define AVSTREAM_EVENT_FLAG_METADATA_UPDATED 0x0001

demuxing: the demuxer read new metadata from the file and updated AVStream.metadata accordingly
muxing: the user updated AVStream.metadata and wishes the muxer to write it into the file

Definition at line 1081 of file avformat.h.

◆ AVSTREAM_EVENT_FLAG_NEW_PACKETS

#define AVSTREAM_EVENT_FLAG_NEW_PACKETS (1 << 1)

demuxing: new packets for this stream were read from the file. This event is informational only and does not guarantee that new packets for this stream will necessarily be returned from av_read_frame().

Definition at line 1087 of file avformat.h.

◆ AV_PROGRAM_RUNNING

#define AV_PROGRAM_RUNNING 1

Definition at line 1129 of file avformat.h.

◆ AVFMTCTX_NOHEADER

#define AVFMTCTX_NOHEADER 0x0001

signal that no header is present (streams are added dynamically)

Definition at line 1164 of file avformat.h.

◆ AVFMTCTX_UNSEEKABLE

#define AVFMTCTX_UNSEEKABLE 0x0002

signal that the stream is definitely not seekable, and attempts to call the seek function will fail.

For some network protocols (e.g. HLS), this can change dynamically at runtime.

Definition at line 1166 of file avformat.h.

◆ AVFMT_FLAG_GENPTS

#define AVFMT_FLAG_GENPTS 0x0001

Generate missing pts even if it requires parsing future frames.

Definition at line 1332 of file avformat.h.

◆ AVFMT_FLAG_IGNIDX

#define AVFMT_FLAG_IGNIDX 0x0002

Ignore index.

Definition at line 1333 of file avformat.h.

◆ AVFMT_FLAG_NONBLOCK

#define AVFMT_FLAG_NONBLOCK 0x0004

Do not block when reading packets from input.

Definition at line 1334 of file avformat.h.

◆ AVFMT_FLAG_IGNDTS

#define AVFMT_FLAG_IGNDTS 0x0008

Ignore DTS on frames that contain both DTS & PTS.

Definition at line 1335 of file avformat.h.

◆ AVFMT_FLAG_NOFILLIN

#define AVFMT_FLAG_NOFILLIN 0x0010

Do not infer any values from other values, just return what is stored in the container.

Definition at line 1336 of file avformat.h.

◆ AVFMT_FLAG_NOPARSE

#define AVFMT_FLAG_NOPARSE 0x0020

Definition at line 1337 of file avformat.h.

◆ AVFMT_FLAG_NOBUFFER

#define AVFMT_FLAG_NOBUFFER 0x0040

Do not buffer frames when possible.

Definition at line 1338 of file avformat.h.

◆ AVFMT_FLAG_CUSTOM_IO

#define AVFMT_FLAG_CUSTOM_IO 0x0080

The caller has supplied a custom AVIOContext, don't avio_close() it.

Definition at line 1339 of file avformat.h.

◆ AVFMT_FLAG_DISCARD_CORRUPT

#define AVFMT_FLAG_DISCARD_CORRUPT 0x0100

Discard frames marked corrupted.

Definition at line 1340 of file avformat.h.

◆ AVFMT_FLAG_FLUSH_PACKETS

#define AVFMT_FLAG_FLUSH_PACKETS 0x0200

Flush the AVIOContext every packet.

Definition at line 1341 of file avformat.h.

◆ AVFMT_FLAG_BITEXACT

#define AVFMT_FLAG_BITEXACT 0x0400

When muxing, try to avoid writing any random/volatile data to the output.

This includes any random IDs, real-time timestamps/dates, muxer version, etc.

This flag is mainly intended for testing.

Definition at line 1348 of file avformat.h.

◆ AVFMT_FLAG_SORT_DTS

#define AVFMT_FLAG_SORT_DTS 0x10000

try to interleave outputted packets by dts (using this flag can slow demuxing down)

Definition at line 1349 of file avformat.h.

◆ AVFMT_FLAG_FAST_SEEK

#define AVFMT_FLAG_FAST_SEEK 0x80000

Enable fast, but inaccurate seeks for some formats.

Definition at line 1353 of file avformat.h.

◆ AVFMT_FLAG_SHORTEST

#define AVFMT_FLAG_SHORTEST 0x100000

Stop muxing when the shortest stream stops.

Definition at line 1354 of file avformat.h.

◆ AVFMT_FLAG_AUTO_BSF

#define AVFMT_FLAG_AUTO_BSF 0x200000

Add bitstream filters as requested by the muxer.

Definition at line 1355 of file avformat.h.

◆ FF_FDEBUG_TS

#define FF_FDEBUG_TS 0x0001

Definition at line 1486 of file avformat.h.

◆ AVFMT_EVENT_FLAG_METADATA_UPDATED

#define AVFMT_EVENT_FLAG_METADATA_UPDATED 0x0001

demuxing: the demuxer read new metadata from the file and updated AVFormatContext.metadata accordingly
muxing: the user updated AVFormatContext.metadata and wishes the muxer to write it into the file

Definition at line 1530 of file avformat.h.

◆ AVFMT_AVOID_NEG_TS_AUTO

#define AVFMT_AVOID_NEG_TS_AUTO -1

Enabled when required by target format.

Definition at line 1546 of file avformat.h.

◆ AVFMT_AVOID_NEG_TS_DISABLED

#define AVFMT_AVOID_NEG_TS_DISABLED 0

Do not shift timestamps even when they are negative.

Definition at line 1547 of file avformat.h.

◆ AVFMT_AVOID_NEG_TS_MAKE_NON_NEGATIVE

#define AVFMT_AVOID_NEG_TS_MAKE_NON_NEGATIVE 1

Shift timestamps so they are non negative.

Definition at line 1548 of file avformat.h.

◆ AVFMT_AVOID_NEG_TS_MAKE_ZERO

#define AVFMT_AVOID_NEG_TS_MAKE_ZERO 2

Shift timestamps so that they start at 0.

Definition at line 1549 of file avformat.h.

◆ AVSEEK_FLAG_BACKWARD

#define AVSEEK_FLAG_BACKWARD 1

seek backward

Definition at line 2289 of file avformat.h.

◆ AVSEEK_FLAG_BYTE

#define AVSEEK_FLAG_BYTE 2

seeking based on position in bytes

Definition at line 2290 of file avformat.h.

◆ AVSEEK_FLAG_ANY

#define AVSEEK_FLAG_ANY 4

seek to any frame, even non-keyframes

Definition at line 2291 of file avformat.h.

◆ AVSEEK_FLAG_FRAME

#define AVSEEK_FLAG_FRAME 8

seeking based on frame number

Definition at line 2292 of file avformat.h.

Typedef Documentation

◆ av_format_control_message

typedef int(* av_format_control_message) (struct AVFormatContext *s, int type, void *data, size_t data_size)

Callback used by devices to communicate with application.

Definition at line 1183 of file avformat.h.

◆ AVOpenCallback

typedef int(* AVOpenCallback) (struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags, const AVIOInterruptCB *int_cb, AVDictionary **options)

Definition at line 1186 of file avformat.h.

Enumeration Type Documentation

◆ AVStreamParseType

enum AVStreamParseType

Enumerator
AVSTREAM_PARSE_NONE
AVSTREAM_PARSE_FULL	full parsing and repack
AVSTREAM_PARSE_HEADERS	Only parse headers, do not repack.
AVSTREAM_PARSE_TIMESTAMPS	full parsing and interpolation of timestamps for frames not starting on a packet boundary
AVSTREAM_PARSE_FULL_ONCE	full parsing and repack of the first frame only, only implemented for H.264 currently
AVSTREAM_PARSE_FULL_RAW	full parsing and repack with timestamp and position generation by parser for raw this assumes that each packet in the file contains no demuxer level headers and just codec level data, otherwise position generation would fail

Definition at line 796 of file avformat.h.

◆ AVDurationEstimationMethod

enum AVDurationEstimationMethod

The duration of a video can be estimated through various ways, and this enum can be used to know how the duration was estimated.

Enumerator
AVFMT_DURATION_FROM_PTS	Duration accurately estimated from PTSes.
AVFMT_DURATION_FROM_STREAM	Duration estimated from a stream with a known duration.
AVFMT_DURATION_FROM_BITRATE	Duration estimated from bitrate (less accurate)

Definition at line 1193 of file avformat.h.

Function Documentation

◆ av_get_packet()

int av_get_packet ( AVIOContext * s,

AVPacket * pkt,

int size

)

Allocate and read the payload of a packet and initialize its fields with default values.

Parameters: s associated IO context

pkt packet

size desired payload size

Returns: >0 (read size) if OK, AVERROR_xxx otherwise

Definition at line 102 of file utils.c.

Referenced by aa_read_packet(), aal_read_packet(), aax_read_packet(), ace_read_packet(), adp_read_packet(), ads_read_packet(), adts_aac_read_packet(), adx_read_packet(), aea_read_packet(), afc_read_packet(), aiff_read_packet(), aix_read_packet(), apc_read_packet(), aptx_hd_read_packet(), aptx_read_packet(), argo_brp_read_packet(), asf_read_header(), asf_read_subpayload(), ast_read_packet(), av_append_packet(), avi_read_packet(), bfi_read_packet(), cdata_read_packet(), cdxl_read_packet(), cin_read_packet(), cine_read_packet(), codec2_read_packet(), dat_read_packet(), daud_packet(), dcstr_read_packet(), dfa_read_packet(), dhav_read_packet(), dsf_read_packet(), dxa_read_packet(), ea_read_packet(), ff_add_attached_pic(), ff_pcm_read_packet(), ff_rm_parse_packet(), ff_rm_retrieve_cache(), ff_voc_get_packet(), film_read_packet(), flv_data_packet(), flv_read_packet(), fourxm_read_packet(), frm_read_packet(), fsb_read_packet(), g726_read_packet(), g729_read_packet(), gdv_read_packet(), genh_read_packet(), gif_read_packet(), gsm_read_packet(), gxf_packet(), hca_read_packet(), hnm_read_packet(), idcin_read_packet(), iff_read_packet(), ifv_read_packet(), ilbc_read_packet(), ingenient_read_packet(), iss_read_packet(), lmlm4_read_packet(), load_ipmovie_packet(), lvf_read_packet(), mmf_read_packet(), mods_read_packet(), mov_read_packet(), mp3_read_packet(), mpc8_read_packet(), mpegps_read_packet(), mpjpeg_read_packet(), msf_read_packet(), msnwc_tcp_read_packet(), msp_read_packet(), mtaf_read_packet(), mtv_read_packet(), musx_read_packet(), mv_read_packet(), mxf_decrypt_triplet(), mxf_get_d10_aes3_packet(), mxf_get_eia608_packet(), mxf_read_packet(), nc_read_packet(), nsv_read_chunk(), nuv_packet(), pmp_packet(), pp_bnk_read_packet(), pva_read_packet(), qcp_read_packet(), r3d_read_reda(), r3d_read_redv(), raw_read_packet(), rawvideo_read_packet(), read_dst_frame(), read_packet(), redspark_read_packet(), rl2_read_packet(), roq_read_packet(), rpl_read_packet(), rsd_read_packet(), s337m_read_packet(), scd_read_packet(), sdr2_read_packet(), seq_read_packet(), ser_read_packet(), siff_read_packet(), simbiosis_imx_read_packet(), smacker_read_packet(), smjpeg_read_packet(), smush_read_packet(), sol_read_packet(), sup_read_packet(), svag_read_packet(), svs_read_packet(), swf_read_packet(), thp_read_packet(), threedostr_read_packet(), tmv_read_packet(), tta_read_packet(), txd_read_packet(), vag_read_packet(), vc1t_read_packet(), vid_read_packet(), viv_read_packet(), vivo_read_packet(), vpk_read_packet(), wc3_read_packet(), wsaud_read_packet(), wsvqa_read_packet(), xa_read_packet(), xmv_fetch_audio_packet(), xmv_fetch_video_packet(), xvag_read_packet(), xwma_read_packet(), yop_read_packet(), and yuv4_read_packet().

◆ av_append_packet()

int av_append_packet ( AVIOContext * s,

AVPacket * pkt,

int size

)

Read data and append it to the current content of the AVPacket.

If pkt->size is 0 this is identical to av_get_packet. Note that this uses av_grow_packet and thus involves a realloc which is inefficient. Thus this function should only be used when there is no reasonable way to know (an upper bound of) the final size.

Parameters: s associated IO context

pkt packet

size amount of data to read

Returns: >0 (read size) if OK, AVERROR_xxx otherwise, previous data will not be lost even if an error occurs.

Definition at line 118 of file utils.c.

Referenced by adts_aac_read_packet(), apng_read_packet(), dfa_read_packet(), ea_read_packet(), handle_id3(), moflex_read_packet(), mpjpeg_read_packet(), msp_read_packet(), read_packet(), sup_read_packet(), vivo_read_packet(), wc3_read_header(), wc3_read_packet(), and wsvqa_read_packet().

◆ av_disposition_from_string()

int av_disposition_from_string ( const char * disp )

Returns: The AV_DISPOSITION_* flag corresponding to disp or a negative error code if disp does not correspond to a known stream disposition.

Definition at line 326 of file options.c.

◆ av_disposition_to_string()

const char* av_disposition_to_string ( int disposition )

Parameters: disposition a combination of AV_DISPOSITION_* values

Returns: The string description corresponding to the lowest set bit in disposition. NULL when the lowest set bit does not correspond to a known disposition or when disposition is 0.

Definition at line 334 of file options.c.

Referenced by show_dispositions().

◆ av_stream_get_parser()

struct AVCodecParserContext* av_stream_get_parser ( const AVStream * s )

Definition at line 32 of file demux_utils.c.

Referenced by process_input_packet().

◆ av_stream_get_end_pts()

int64_t av_stream_get_end_pts ( const AVStream * st )

Returns the pts of the last muxed packet + its duration.

the retuned value is undefined when used with a demuxer.

Definition at line 32 of file mux_utils.c.

Referenced by print_report().

◆ av_format_inject_global_side_data()

void av_format_inject_global_side_data ( AVFormatContext * s )

This function will cause global side data to be injected in the next packet of each stream as well as after any subsequent seek.

Definition at line 83 of file demux_utils.c.

Referenced by read_thread().

◆ av_fmt_ctx_get_duration_estimation_method()

enum AVDurationEstimationMethod av_fmt_ctx_get_duration_estimation_method ( const AVFormatContext * ctx )

Returns the method used to set ctx->duration.

Returns: AVFMT_DURATION_FROM_PTS, AVFMT_DURATION_FROM_STREAM, or AVFMT_DURATION_FROM_BITRATE.

Definition at line 192 of file options.c.

◆ avformat_alloc_output_context2()

int avformat_alloc_output_context2 ( AVFormatContext ** ctx,

const AVOutputFormat * oformat,

const char * format_name,

const char * filename

)

Allocate an AVFormatContext for an output format.

avformat_free_context() can be used to free the context and everything allocated by the framework within it.

Parameters: *ctx is set to the created format context, or to NULL in case of failure

oformat format to use for allocating the context, if NULL format_name and filename are used instead

format_name the name of output format to use for allocating the context, if NULL filename is used instead

filename the name of the filename to use for allocating the context, may be NULL

Returns: >= 0 in case of success, a negative AVERROR code in case of failure

Examples: muxing.c, remuxing.c, transcoding.c, and vaapi_transcode.c.

Definition at line 91 of file mux.c.

Referenced by avdevice_list_output_sinks(), fifo_mux_init(), hls_mux_init(), initialize_fifo_tst_muxer_chain(), main(), mov_init_ttml_writer(), open_output_file(), open_slave(), segment_mux_init(), webm_chunk_init(), and write_muxed_file().

Generated on Wed Aug 24 2022 21:42:43 for FFmpeg by doxygen 1.8.17