Loading...
Searching...
No Matches
avformat.h File Reference
libavformat

Main libavformat public API header. More...

`#include <stdio.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"`
`#include "libavformat/version.h"`
`#include "libavutil/frame.h"`
`#include "libavcodec/codec.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 | AVStreamGroupTileGrid
| AVStreamGroupTileGrid holds information on how to combine several independent images on a single canvas for presentation. More...
struct | AVStreamGroupLCEVC
| AVStreamGroupLCEVC is meant to define the relation between video streams and a data stream containing LCEVC enhancement layer NALUs. More...
struct | AVStreamGroup
struct | AVProgram
| New fields can be added to the end with minor version bumps. More...
struct | AVChapter
struct | AVFormatContext
| Format I/O context. More...
struct | AVRTSPCommandRequest
struct | AVRTSPResponse

## 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
#define | AVPROBE_SCORE_MIME_BONUS 30
| score added for matching mime type
#define | AVPROBE_SCORE_MAX 100
| maximum score
#define | AVPROBE_PADDING_SIZE 32
| extra allocated bytes at the end of the probe buffer
#define | AVFMT_NOFILE 0x0001
| Demuxer will use avio_open, no opened file should be provided by the caller.
#define | AVFMT_NEEDNUMBER 0x0002
| Needs 'd' in filename.
#define | AVFMT_EXPERIMENTAL 0x0004
| The muxer/demuxer is experimental and should be used with caution.
#define | AVFMT_SHOW_IDS 0x0008
| Show format stream IDs numbers.
#define | AVFMT_GLOBALHEADER 0x0040
| Format wants global header.
#define | AVFMT_NOTIMESTAMPS 0x0080
| Format does not need / have any timestamps.
#define | AVFMT_GENERIC_INDEX 0x0100
| Use generic index building code.
#define | AVFMT_TS_DISCONT 0x0200
| Format allows timestamp discontinuities.
#define | AVFMT_VARIABLE_FPS 0x0400
| Format allows variable fps.
#define | AVFMT_NODIMENSIONS 0x0800
| Format does not need width/height.
#define | AVFMT_NOSTREAMS 0x1000
| Format does not require any streams.
#define | AVFMT_NOBINSEARCH 0x2000
| Format does not allow to fall back on binary search via read_timestamp.
#define | AVFMT_NOGENSEARCH 0x4000
| Format does not allow to fall back on generic search.
#define | AVFMT_NO_BYTE_SEEK 0x8000
| Format does not allow seeking by bytes.
#define | AVFMT_TS_NONSTRICT 0x20000
| Format does not require strictly increasing timestamps, but they must still be monotonic.
#define | AVFMT_TS_NEGATIVE 0x40000
| Format allows muxing negative timestamps.
#define | AVFMT_SEEK_TO_PTS 0x4000000
| Seeking is based on PTS.
#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.
#define | AV_DISPOSITION_DUB (1 << 1)
| The stream is not in original language.
#define | AV_DISPOSITION_ORIGINAL (1 << 2)
| The stream is in original language.
#define | AV_DISPOSITION_COMMENT (1 << 3)
| The stream is a commentary track.
#define | AV_DISPOSITION_LYRICS (1 << 4)
| The stream contains song lyrics.
#define | AV_DISPOSITION_KARAOKE (1 << 5)
| The stream contains karaoke audio.
#define | AV_DISPOSITION_FORCED (1 << 6)
| Track should be used during playback by default.
#define | AV_DISPOSITION_HEARING_IMPAIRED (1 << 7)
| The stream is intended for hearing impaired audiences.
#define | AV_DISPOSITION_VISUAL_IMPAIRED (1 << 8)
| The stream is intended for visually impaired audiences.
#define | AV_DISPOSITION_CLEAN_EFFECTS (1 << 9)
| The audio stream contains music and sound effects without voice.
#define | AV_DISPOSITION_ATTACHED_PIC (1 << 10)
| The stream is stored in the file as an attached picture/"cover art" (e.g.
#define | AV_DISPOSITION_TIMED_THUMBNAILS (1 << 11)
| The stream is sparse, and contains thumbnail images, often corresponding to chapter markers.
#define | AV_DISPOSITION_NON_DIEGETIC (1 << 12)
| The stream is intended to be mixed with a spatial audio track.
#define | AV_DISPOSITION_CAPTIONS (1 << 16)
| The subtitle stream contains captions, providing a transcription and possibly a translation of audio.
#define | AV_DISPOSITION_DESCRIPTIONS (1 << 17)
| The subtitle stream contains a textual description of the video content.
#define | AV_DISPOSITION_METADATA (1 << 18)
| The subtitle stream contains time-aligned metadata that is not intended to be directly presented to the user.
#define | AV_DISPOSITION_DEPENDENT (1 << 19)
| The stream is intended to be mixed with another stream before presentation.
#define | AV_DISPOSITION_STILL_IMAGE (1 << 20)
| The video stream contains still images.
#define | AV_DISPOSITION_MULTILAYER (1 << 21)
| The video stream contains multiple layers, e.g.
#define | AV_PTS_WRAP_IGNORE 0
| Options for behavior on timestamp wrap detection.
#define | AV_PTS_WRAP_ADD_OFFSET 1
| add the format specific offset on wrap detection
#define | AV_PTS_WRAP_SUB_OFFSET -1
| subtract the format specific offset on wrap detection
#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)
#define | AVFMTCTX_UNSEEKABLE 0x0002
| signal that the stream is definitely not seekable, and attempts to call the seek function will fail.
#define | AVFMT_FLAG_GENPTS 0x0001
| Generate missing pts even if it requires parsing future frames.
#define | AVFMT_FLAG_IGNIDX 0x0002
| Ignore index.
#define | AVFMT_FLAG_NONBLOCK 0x0004
| Do not block when reading packets from input.
#define | AVFMT_FLAG_IGNDTS 0x0008
| Ignore DTS on frames that contain both DTS & PTS.
#define | AVFMT_FLAG_NOFILLIN 0x0010
| Do not infer any values from other values, just return what is stored in the container.
#define | AVFMT_FLAG_NOPARSE 0x0020
| Do not use AVParsers, you also must set AVFMT_FLAG_NOFILLIN as the filling 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.
#define | AVFMT_FLAG_NOBUFFER 0x0040
| Do not buffer frames when possible.
#define | AVFMT_FLAG_CUSTOM_IO 0x0080
| The caller has supplied a custom AVIOContext, don't avio_close() it.
#define | AVFMT_FLAG_DISCARD_CORRUPT 0x0100
| Discard frames marked corrupted.
#define | AVFMT_FLAG_FLUSH_PACKETS 0x0200
| Flush the AVIOContext every packet.
#define | AVFMT_FLAG_BITEXACT 0x0400
| When muxing, try to avoid writing any random/volatile data to the output.
#define | AVFMT_FLAG_SORT_DTS 0x10000
| try to interleave outputted packets by dts (using this flag can slow demuxing down)
#define | AVFMT_FLAG_FAST_SEEK 0x80000
| Enable fast, but inaccurate seeks for some formats.
#define | AVFMT_FLAG_AUTO_BSF 0x200000
| Add bitstream filters as requested by the muxer.
#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.
#define | AVFMT_AVOID_NEG_TS_DISABLED 0
| Do not shift timestamps even when they are negative.
#define | AVFMT_AVOID_NEG_TS_MAKE_NON_NEGATIVE 1
| Shift timestamps so they are non negative.
#define | AVFMT_AVOID_NEG_TS_MAKE_ZERO 2
| Shift timestamps so that they start at 0.
#define | AVSEEK_FLAG_BACKWARD 1
| seek backward
#define | AVSEEK_FLAG_BYTE 2
| seeking based on position in bytes
#define | AVSEEK_FLAG_ANY 4
| seek to any frame, even non-keyframes
#define | AVSEEK_FLAG_FRAME 8
| seeking based on frame number
#define | AVSTREAM_INIT_IN_WRITE_HEADER 0
| stream parameters initialized in avformat_write_header
#define | AVSTREAM_INIT_IN_INIT_OUTPUT 1
| stream parameters initialized in avformat_init_output
#define | AV_FRAME_FILENAME_FLAGS_MULTIPLE 1
| Allow multiple d.
#define | AV_FRAME_FILENAME_FLAGS_IGNORE_TRUNCATION 2
| Ignore truncated output instead of returning an error.

## 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.
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 | AVStreamGroupParamsType { AV_STREAM_GROUP_PARAMS_NONE , AV_STREAM_GROUP_PARAMS_IAMF_AUDIO_ELEMENT , AV_STREAM_GROUP_PARAMS_IAMF_MIX_PRESENTATION , AV_STREAM_GROUP_PARAMS_TILE_GRID , AV_STREAM_GROUP_PARAMS_LCEVC }
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 | AVFormatCommandID { AVFORMAT_COMMAND_RTSP_SET_PARAMETER }
| Command IDs that can be sent to the demuxer. More...

## 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.
int | av_append_packet (AVIOContext *s, AVPacket *pkt, int size)
| Read data and append it to the current content of the AVPacket.
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)
unsigned | avformat_version (void)
| Return the LIBAVFORMAT_VERSION_INT constant.
const char * | avformat_configuration (void)
| Return the libavformat build-time configuration.
const char * | avformat_license (void)
| Return the libavformat license.
int | avformat_network_init (void)
| Do global initialization of network libraries.
int | avformat_network_deinit (void)
| Undo the initialization done by avformat_network_init.
const AVOutputFormat * | av_muxer_iterate (void **opaque)
| Iterate over all registered muxers.
const AVInputFormat * | av_demuxer_iterate (void **opaque)
| Iterate over all registered demuxers.
AVFormatContext * | avformat_alloc_context (void)
| Allocate an AVFormatContext.
void | avformat_free_context (AVFormatContext *s)
| Free an AVFormatContext and all its streams.
const AVClass * | avformat_get_class (void)
| Get the AVClass for AVFormatContext.
const AVClass * | av_stream_get_class (void)
| Get the AVClass for AVStream.
const AVClass * | av_stream_group_get_class (void)
| Get the AVClass for AVStreamGroup.
const char * | avformat_stream_group_name (enum AVStreamGroupParamsType type)
AVStreamGroup * | avformat_stream_group_create (AVFormatContext *s, enum AVStreamGroupParamsType type, AVDictionary **options)
| Add a new empty stream group to a media file.
AVStream * | avformat_new_stream (AVFormatContext *s, const struct AVCodec *c)
| Add a new stream to a media file.
int | avformat_stream_group_add_stream (AVStreamGroup *stg, AVStream *st)
| Add an already allocated stream to a stream group.
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.
const AVInputFormat * | av_find_input_format (const char *short_name)
| Find AVInputFormat based on the short name of the input format.
const AVInputFormat * | av_probe_input_format (const AVProbeData *pd, int is_opened)
| Guess the file format.
const AVInputFormat * | av_probe_input_format2 (const AVProbeData *pd, int is_opened, int *score_max)
| Guess the file format.
const AVInputFormat * | av_probe_input_format3 (const AVProbeData *pd, int is_opened, int *score_ret)
| Guess the file format.
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.
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.
int | avformat_open_input (AVFormatContext **ps, const char *url, const AVInputFormat *fmt, AVDictionary **options)
| Open an input stream and read the header.
int | avformat_find_stream_info (AVFormatContext *ic, AVDictionary **options)
| Read packets of a media file to get stream information.
AVProgram * | av_find_program_from_stream (AVFormatContext *ic, AVProgram *last, int s)
| Find the programs which belong to a given stream.
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 struct AVCodec **decoder_ret, int flags)
| Find the "best" stream in the file.
int | av_read_frame (AVFormatContext *s, AVPacket *pkt)
| Return the next frame of a stream.
int | av_seek_frame (AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
| Seek to the keyframe at timestamp.
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.
int | avformat_flush (AVFormatContext *s)
| Discard all internally buffered data.
int | av_read_play (AVFormatContext *s)
| Start playing a network-based stream (e.g.
int | av_read_pause (AVFormatContext *s)
| Pause a network-based stream (e.g.
int | avformat_send_command (AVFormatContext *s, enum AVFormatCommandID id, void *data)
| Send a command to the demuxer.
int | avformat_receive_command_reply (AVFormatContext *s, enum AVFormatCommandID id, void **data_out)
| Receive a command reply from the demuxer.
void | avformat_close_input (AVFormatContext **s)
| Close an opened input AVFormatContext.
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.
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.
int | av_write_frame (AVFormatContext *s, AVPacket *pkt)
| Write a packet to an output media file.
int | av_interleaved_write_frame (AVFormatContext *s, AVPacket *pkt)
| Write a packet to an output media file ensuring correct interleaving.
int | av_write_uncoded_frame (AVFormatContext *s, int stream_index, struct AVFrame *frame)
| Write an uncoded frame to an output media file.
int | av_interleaved_write_uncoded_frame (AVFormatContext *s, int stream_index, struct AVFrame *frame)
| Write an uncoded frame to an output media file.
int | av_write_uncoded_frame_query (AVFormatContext *s, int stream_index)
| Test whether a muxer supports uncoded frame.
int | av_write_trailer (AVFormatContext *s)
| Write the stream trailer to an output media file and free the file private data.
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.
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.
int | av_get_output_timestamp (struct AVFormatContext *s, int stream, int64_t *dts, int64_t *wall)
| Get timing information for the data currently output.
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.
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.
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.
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.
enum AVCodecID | av_codec_get_id (const struct AVCodecTag *const *tags, unsigned int tag)
| Get the AVCodecID for the given codec tag tag.
unsigned int | av_codec_get_tag (const struct AVCodecTag *const *tags, enum AVCodecID id)
| Get the codec tag for the given codec id id.
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.
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.
int | avformat_index_get_entries_count (const AVStream *st)
| Get the index entry count for the given AVStream.
const AVIndexEntry * | avformat_index_get_entry (AVStream *st, int idx)
| Get the AVIndexEntry corresponding to the given index.
const AVIndexEntry * | avformat_index_get_entry_from_timestamp (AVStream *st, int64_t wanted_timestamp, int flags)
| Get the AVIndexEntry corresponding to the given timestamp.
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.
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.
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.
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.
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.
int | av_sdp_create (AVFormatContext *ac[], int n_files, char *buf, int size)
| Generate an SDP for an RTP session.
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.
int | avformat_query_codec (const AVOutputFormat *ofmt, enum AVCodecID codec_id, int std_compliance)
| Test if the given container can store a codec.
int | av_mime_codec_str (const AVCodecParameters *par, AVRational frame_rate, struct AVBPrint *out)
| Make a RFC 4281/6381 like string describing a codec for MIME types.
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, struct AVFrame *frame)
| Guess the sample aspect ratio of a frame, based on both the stream and the frame aspect ratio.
AVRational | av_guess_frame_rate (AVFormatContext *ctx, AVStream *stream, struct AVFrame *frame)
| Guess the frame rate, based on both the container and codec information.
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.
int | avformat_queue_attached_pictures (AVFormatContext *s)

## 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 458 of file avformat.h.

## AVPROBE_SCORE_STREAM_RETRY

#define AVPROBE_SCORE_STREAM_RETRY (AVPROBE_SCORE_MAX/4-1)

Definition at line 459 of file avformat.h.

## AVPROBE_SCORE_EXTENSION

#define AVPROBE_SCORE_EXTENSION 50

score for file extension

Definition at line 461 of file avformat.h.

## AVPROBE_SCORE_MIME_BONUS

#define AVPROBE_SCORE_MIME_BONUS 30

score added for matching mime type

Definition at line 462 of file avformat.h.

## AVPROBE_SCORE_MAX

#define AVPROBE_SCORE_MAX 100

maximum score

Definition at line 463 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 465 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
  mux.c, remux.c, and transcode.c.

Definition at line 468 of file avformat.h.

Referenced by main(), and open_output_file().

## AVFMT_NEEDNUMBER

#define AVFMT_NEEDNUMBER 0x0002

Needs 'd' in filename.

Definition at line 469 of file avformat.h.

## AVFMT_EXPERIMENTAL

#define AVFMT_EXPERIMENTAL 0x0004

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

It will not be selected automatically, and must be specified explicitly.

Definition at line 475 of file avformat.h.

## AVFMT_SHOW_IDS

#define AVFMT_SHOW_IDS 0x0008

Show format stream IDs numbers.

Definition at line 476 of file avformat.h.

## AVFMT_GLOBALHEADER

#define AVFMT_GLOBALHEADER 0x0040

Format wants global header.

Examples
  mux.c, transcode.c, and transcode_aac.c.

Definition at line 477 of file avformat.h.

Referenced by add_stream(), open_output_file(), and open_output_file().

## AVFMT_NOTIMESTAMPS

#define AVFMT_NOTIMESTAMPS 0x0080

Format does not need / have any timestamps.

Definition at line 478 of file avformat.h.

## AVFMT_GENERIC_INDEX

#define AVFMT_GENERIC_INDEX 0x0100

Use generic index building code.

Definition at line 479 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 480 of file avformat.h.

## AVFMT_VARIABLE_FPS

#define AVFMT_VARIABLE_FPS 0x0400

Format allows variable fps.

Definition at line 481 of file avformat.h.

## AVFMT_NODIMENSIONS

#define AVFMT_NODIMENSIONS 0x0800

Format does not need width/height.

Definition at line 482 of file avformat.h.

## AVFMT_NOSTREAMS

#define AVFMT_NOSTREAMS 0x1000

Format does not require any streams.

Definition at line 483 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 484 of file avformat.h.

## AVFMT_NOGENSEARCH

#define AVFMT_NOGENSEARCH 0x4000

Format does not allow to fall back on generic search.

Definition at line 485 of file avformat.h.

## AVFMT_NO_BYTE_SEEK

#define AVFMT_NO_BYTE_SEEK 0x8000

Format does not allow seeking by bytes.

Definition at line 486 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 487 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 490 of file avformat.h.

## AVFMT_SEEK_TO_PTS

#define AVFMT_SEEK_TO_PTS 0x4000000

Seeking is based on PTS.

Definition at line 499 of file avformat.h.

## AVINDEX_KEYFRAME

#define AVINDEX_KEYFRAME 0x0001

Definition at line 606 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 607 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 617 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 625 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 631 of file avformat.h.

## AV_DISPOSITION_COMMENT

#define AV_DISPOSITION_COMMENT (1 << 3)

The stream is a commentary track.

Definition at line 635 of file avformat.h.

## AV_DISPOSITION_LYRICS

#define AV_DISPOSITION_LYRICS (1 << 4)

The stream contains song lyrics.

Definition at line 639 of file avformat.h.

## AV_DISPOSITION_KARAOKE

#define AV_DISPOSITION_KARAOKE (1 << 5)

The stream contains karaoke audio.

Definition at line 643 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 650 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 654 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 658 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 662 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 670 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 675 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 682 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 688 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 694 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 699 of file avformat.h.

## AV_DISPOSITION_DEPENDENT

#define AV_DISPOSITION_DEPENDENT (1 << 19)

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

Used for example to signal the stream contains an image part of a HEIF grid, or for mix_type=0 in mpegts.

Definition at line 705 of file avformat.h.

## AV_DISPOSITION_STILL_IMAGE

#define AV_DISPOSITION_STILL_IMAGE (1 << 20)

The video stream contains still images.

Definition at line 709 of file avformat.h.

## AV_DISPOSITION_MULTILAYER

#define AV_DISPOSITION_MULTILAYER (1 << 21)

The video stream contains multiple layers, e.g.

stereoscopic views (cf. H.264 Annex G/H, or HEVC Annex F).

Definition at line 714 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 733 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 734 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 735 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 862 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 868 of file avformat.h.

## AV_PROGRAM_RUNNING

#define AV_PROGRAM_RUNNING 1

Definition at line 1179 of file avformat.h.

## AVFMTCTX_NOHEADER

#define AVFMTCTX_NOHEADER 0x0001

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

Definition at line 1214 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 1216 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 1415 of file avformat.h.

## AVFMT_FLAG_IGNIDX

#define AVFMT_FLAG_IGNIDX 0x0002

Ignore index.

Definition at line 1416 of file avformat.h.

## AVFMT_FLAG_NONBLOCK

#define AVFMT_FLAG_NONBLOCK 0x0004

Do not block when reading packets from input.

Definition at line 1417 of file avformat.h.

## AVFMT_FLAG_IGNDTS

#define AVFMT_FLAG_IGNDTS 0x0008

Ignore DTS on frames that contain both DTS & PTS.

Definition at line 1418 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 1419 of file avformat.h.

## AVFMT_FLAG_NOPARSE

#define AVFMT_FLAG_NOPARSE 0x0020

Do not use AVParsers, you also must set AVFMT_FLAG_NOFILLIN as the filling 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.

Definition at line 1420 of file avformat.h.

## AVFMT_FLAG_NOBUFFER

#define AVFMT_FLAG_NOBUFFER 0x0040

Do not buffer frames when possible.

Definition at line 1421 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 1422 of file avformat.h.

## AVFMT_FLAG_DISCARD_CORRUPT

#define AVFMT_FLAG_DISCARD_CORRUPT 0x0100

Discard frames marked corrupted.

Definition at line 1423 of file avformat.h.

## AVFMT_FLAG_FLUSH_PACKETS

#define AVFMT_FLAG_FLUSH_PACKETS 0x0200

Flush the AVIOContext every packet.

Definition at line 1424 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 1431 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 1432 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 1433 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 1434 of file avformat.h.

## FF_FDEBUG_TS

#define FF_FDEBUG_TS 0x0001

Definition at line 1539 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 1637 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 1648 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 1649 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 1650 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 1651 of file avformat.h.

## AVSEEK_FLAG_BACKWARD

#define AVSEEK_FLAG_BACKWARD 1

seek backward

Definition at line 2473 of file avformat.h.

## AVSEEK_FLAG_BYTE

#define AVSEEK_FLAG_BYTE 2

seeking based on position in bytes

Definition at line 2474 of file avformat.h.

## AVSEEK_FLAG_ANY

#define AVSEEK_FLAG_ANY 4

seek to any frame, even non-keyframes

Definition at line 2475 of file avformat.h.

## AVSEEK_FLAG_FRAME

#define AVSEEK_FLAG_FRAME 8

seeking based on frame number

Definition at line 2476 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 1233 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 1236 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 587 of file avformat.h.

## AVStreamGroupParamsType

enum AVStreamGroupParamsType

Enumerator
AV_STREAM_GROUP_PARAMS_NONE |
AV_STREAM_GROUP_PARAMS_IAMF_AUDIO_ELEMENT |
AV_STREAM_GROUP_PARAMS_IAMF_MIX_PRESENTATION |
AV_STREAM_GROUP_PARAMS_TILE_GRID |
AV_STREAM_GROUP_PARAMS_LCEVC |

Definition at line 1086 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 1243 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

## 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.

## 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.

## 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.

## av_stream_get_parser()

struct AVCodecParserContext * av_stream_get_parser | ( | const AVStream * | s | ) |

## 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 | pointee 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
  mux.c, qsv_transcode.c, remux.c, transcode.c, and vaapi_transcode.c.

Referenced by main(), and open_output_file().