avformat.h File Reference

Main libavformat public API header. More...

#include <time.h>
#include <stdio.h>
#include "libavcodec/avcodec.h"
#include "libavutil/dict.h"
#include "libavutil/log.h"
#include "avio.h"
#include "libavformat/version.h"

Go to the source code of this file.

Data Structures

struct  AVFrac
 The exact value of the fractional number is: 'val + num / den'. More...
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...
struct  AVPacketList

Macros

#define AVPROBE_SCORE_EXTENSION   50
 score for file extension
#define AVPROBE_SCORE_MIME   75
 score for file 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_SHOW_IDS   0x0008
 Show format stream IDs numbers.
#define AVFMT_RAWPICTURE   0x0020
 Format wants AVPicture structure for raw picture data.
#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_ALLOW_FLUSH   0x10000
 Format allows flushing.
#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 AVINDEX_KEYFRAME   0x0001
#define AV_DISPOSITION_DEFAULT   0x0001
#define AV_DISPOSITION_DUB   0x0002
#define AV_DISPOSITION_ORIGINAL   0x0004
#define AV_DISPOSITION_COMMENT   0x0008
#define AV_DISPOSITION_LYRICS   0x0010
#define AV_DISPOSITION_KARAOKE   0x0020
#define AV_DISPOSITION_FORCED   0x0040
 Track should be used during playback by default.
#define AV_DISPOSITION_HEARING_IMPAIRED   0x0080
 stream for hearing impaired audiences
#define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100
 stream for visual impaired audiences
#define AV_DISPOSITION_CLEAN_EFFECTS   0x0200
 stream without voice
#define AV_DISPOSITION_ATTACHED_PIC   0x0400
 The stream is stored in the file as an attached picture/"cover art" (e.g.
#define AVSTREAM_EVENT_FLAG_METADATA_UPDATED   0x0001
 The call resulted in updated metadata.
#define MAX_STD_TIMEBASES   (60*12+5)
 Stream information used internally by av_find_stream_info()
#define MAX_PROBE_PACKETS   2500
 Number of packets to buffer for codec probing.
#define MAX_REORDER_DELAY   16
#define AV_PROGRAM_RUNNING   1
#define AVFMTCTX_NOHEADER   0x0001
 signal that no header is present (streams are added dynamically)
#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 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.
#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 FF_FDEBUG_TS   0x0001
#define AVFMT_EVENT_FLAG_METADATA_UPDATED   0x0001
 The call resulted in updated metadata.
#define RAW_PACKET_BUFFER_SIZE   2500000
 Remaining size available for raw_packet_buffer, in bytes.
#define AVSEEK_FLAG_BACKWARD   1
#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

Typedefs

typedef struct AVFormatInternal AVFormatInternal

Enumerations

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

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.
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.
void av_register_all (void)
 Initialize libavformat and register all the muxers, demuxers and protocols.
void av_register_input_format (AVInputFormat *format)
void av_register_output_format (AVOutputFormat *format)
int avformat_network_init (void)
 Do global initialization of network components.
int avformat_network_deinit (void)
 Undo the initialization done by avformat_network_init.
AVInputFormatav_iformat_next (const AVInputFormat *f)
 If f is NULL, returns the first registered input format, if f is non-NULL, returns the next registered input format after f or NULL if f is the last one.
AVOutputFormatav_oformat_next (const AVOutputFormat *f)
 If f is NULL, returns the first registered output format, if f is non-NULL, returns the next registered output format after f or NULL if f is the last one.
AVFormatContextavformat_alloc_context (void)
 Allocate an AVFormatContext.
void avformat_free_context (AVFormatContext *s)
 Free an AVFormatContext and all its streams.
const AVClassavformat_get_class (void)
 Get the AVClass for AVFormatContext.
AVStreamavformat_new_stream (AVFormatContext *s, const AVCodec *c)
 Add a new stream to a media file.
uint8_t * av_stream_get_side_data (AVStream *stream, enum AVPacketSideDataType type, int *size)
 Get side information from stream.
AVProgramav_new_program (AVFormatContext *s, int id)
AVInputFormatav_find_input_format (const char *short_name)
 Find AVInputFormat based on the short name of the input format.
AVInputFormatav_probe_input_format (AVProbeData *pd, int is_opened)
 Guess the file format.
AVInputFormatav_probe_input_format2 (AVProbeData *pd, int is_opened, int *score_max)
 Guess the file format.
int av_probe_input_buffer (AVIOContext *pb, AVInputFormat **fmt, const char *filename, void *logctx, unsigned int offset, unsigned int max_probe_size)
 Probe a bytestream to determine the input format.
int avformat_open_input (AVFormatContext **ps, const char *filename, 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.
int av_find_best_stream (AVFormatContext *ic, enum AVMediaType type, int wanted_stream_nb, int related_stream, 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 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.
void avformat_close_input (AVFormatContext **s)
 Close an opened input AVFormatContext.
int avformat_write_header (AVFormatContext *s, AVDictionary **options)
 Allocate the stream private data and write the stream header to an output media file.
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_trailer (AVFormatContext *s)
 Write the stream trailer to an output media file and free the file private data.
AVOutputFormatav_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 (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.
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, AVPacket *pkt, int dump_payload, AVStream *st)
 Send a nice dump of a packet to the specified file stream.
void av_pkt_dump_log2 (void *avcl, int level, AVPacket *pkt, int dump_payload, 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_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 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_filename (char *buf, int buf_size, const char *path, int number)
 Return in 'buf' the path with 'd' replaced by a 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.
struct AVCodecTag * avformat_get_riff_video_tags (void)
struct AVCodecTag * avformat_get_riff_audio_tags (void)

Detailed Description

Main libavformat public API header.

Definition in file avformat.h.

Macro Definition Documentation

#define AVPROBE_SCORE_EXTENSION   50

score for file extension

Definition at line 402 of file avformat.h.

#define AVPROBE_SCORE_MIME   75

score for file mime type

Definition at line 403 of file avformat.h.

#define AVPROBE_SCORE_MAX   100

maximum score

Definition at line 404 of file avformat.h.

#define AVPROBE_PADDING_SIZE   32

extra allocated bytes at the end of the probe buffer

Definition at line 406 of file avformat.h.

#define AVFMT_NOFILE   0x0001

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

Examples:
output.c.

Definition at line 409 of file avformat.h.

Referenced by main().

#define AVFMT_NEEDNUMBER   0x0002

Needs 'd' in filename.

Definition at line 410 of file avformat.h.

#define AVFMT_SHOW_IDS   0x0008

Show format stream IDs numbers.

Definition at line 411 of file avformat.h.

#define AVFMT_RAWPICTURE   0x0020

Format wants AVPicture structure for raw picture data.

Examples:
output.c.

Definition at line 412 of file avformat.h.

Referenced by write_video_frame().

#define AVFMT_GLOBALHEADER   0x0040

Format wants global header.

Examples:
output.c, and transcode_aac.c.

Definition at line 414 of file avformat.h.

Referenced by add_audio_stream(), add_video_stream(), and open_output_file().

#define AVFMT_NOTIMESTAMPS   0x0080

Format does not need / have any timestamps.

Definition at line 415 of file avformat.h.

#define AVFMT_GENERIC_INDEX   0x0100

Use generic index building code.

Definition at line 416 of file avformat.h.

#define AVFMT_TS_DISCONT   0x0200

Format allows timestamp discontinuities.

Note, muxers always require valid (monotone) timestamps

Definition at line 417 of file avformat.h.

#define AVFMT_VARIABLE_FPS   0x0400

Format allows variable fps.

Definition at line 418 of file avformat.h.

#define AVFMT_NODIMENSIONS   0x0800

Format does not need width/height.

Definition at line 419 of file avformat.h.

#define AVFMT_NOSTREAMS   0x1000

Format does not require any streams.

Definition at line 420 of file avformat.h.

#define AVFMT_NOBINSEARCH   0x2000

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

Definition at line 421 of file avformat.h.

#define AVFMT_NOGENSEARCH   0x4000

Format does not allow to fall back on generic search.

Definition at line 422 of file avformat.h.

#define AVFMT_NO_BYTE_SEEK   0x8000

Format does not allow seeking by bytes.

Definition at line 423 of file avformat.h.

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

#define AVFMT_TS_NONSTRICT   0x20000

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

Definition at line 425 of file avformat.h.

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

Definition at line 428 of file avformat.h.

#define AVINDEX_KEYFRAME   0x0001

Definition at line 655 of file avformat.h.

#define AV_DISPOSITION_DEFAULT   0x0001

Definition at line 661 of file avformat.h.

#define AV_DISPOSITION_DUB   0x0002

Definition at line 662 of file avformat.h.

#define AV_DISPOSITION_ORIGINAL   0x0004

Definition at line 663 of file avformat.h.

#define AV_DISPOSITION_COMMENT   0x0008

Definition at line 664 of file avformat.h.

#define AV_DISPOSITION_LYRICS   0x0010

Definition at line 665 of file avformat.h.

#define AV_DISPOSITION_KARAOKE   0x0020

Definition at line 666 of file avformat.h.

#define AV_DISPOSITION_FORCED   0x0040

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

#define AV_DISPOSITION_HEARING_IMPAIRED   0x0080

stream for hearing impaired audiences

Definition at line 674 of file avformat.h.

#define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100

stream for visual impaired audiences

Definition at line 675 of file avformat.h.

#define AV_DISPOSITION_CLEAN_EFFECTS   0x0200

stream without voice

Definition at line 676 of file avformat.h.

#define AV_DISPOSITION_ATTACHED_PIC   0x0400

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

APIC frame in ID3v2). The single 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 683 of file avformat.h.

#define AVSTREAM_EVENT_FLAG_METADATA_UPDATED   0x0001

The call resulted in updated metadata.

Definition at line 812 of file avformat.h.

#define MAX_STD_TIMEBASES   (60*12+5)

Stream information used internally by av_find_stream_info()

Definition at line 825 of file avformat.h.

#define MAX_PROBE_PACKETS   2500

Number of packets to buffer for codec probing.

Definition at line 851 of file avformat.h.

#define MAX_REORDER_DELAY   16

Definition at line 868 of file avformat.h.

#define AV_PROGRAM_RUNNING   1

Definition at line 877 of file avformat.h.

#define AVFMTCTX_NOHEADER   0x0001

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

Definition at line 894 of file avformat.h.

#define AVFMT_FLAG_GENPTS   0x0001

Generate missing pts even if it requires parsing future frames.

Definition at line 1026 of file avformat.h.

#define AVFMT_FLAG_IGNIDX   0x0002

Ignore index.

Definition at line 1027 of file avformat.h.

#define AVFMT_FLAG_NONBLOCK   0x0004

Do not block when reading packets from input.

Definition at line 1028 of file avformat.h.

#define AVFMT_FLAG_IGNDTS   0x0008

Ignore DTS on frames that contain both DTS & PTS.

Definition at line 1029 of file avformat.h.

#define AVFMT_FLAG_NOFILLIN   0x0010

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

Definition at line 1030 of file avformat.h.

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

Definition at line 1031 of file avformat.h.

#define AVFMT_FLAG_NOBUFFER   0x0040

Do not buffer frames when possible.

Definition at line 1032 of file avformat.h.

#define AVFMT_FLAG_CUSTOM_IO   0x0080

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

Definition at line 1033 of file avformat.h.

#define AVFMT_FLAG_DISCARD_CORRUPT   0x0100

Discard frames marked corrupted.

Definition at line 1034 of file avformat.h.

#define AVFMT_FLAG_FLUSH_PACKETS   0x0200

Flush the AVIOContext every packet.

Definition at line 1035 of file avformat.h.

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

#define FF_FDEBUG_TS   0x0001

Definition at line 1161 of file avformat.h.

#define AVFMT_EVENT_FLAG_METADATA_UPDATED   0x0001

The call resulted in updated metadata.

Definition at line 1193 of file avformat.h.

#define RAW_PACKET_BUFFER_SIZE   2500000

Remaining size available for raw_packet_buffer, in bytes.

Definition at line 1236 of file avformat.h.

#define AVSEEK_FLAG_BACKWARD   1

seek backward

Definition at line 1607 of file avformat.h.

#define AVSEEK_FLAG_BYTE   2

seeking based on position in bytes

Definition at line 1608 of file avformat.h.

#define AVSEEK_FLAG_ANY   4

seek to any frame, even non-keyframes

Definition at line 1609 of file avformat.h.

#define AVSEEK_FLAG_FRAME   8

seeking based on frame number

Definition at line 1610 of file avformat.h.

Typedef Documentation

Definition at line 904 of file avformat.h.

Enumeration Type Documentation

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

Definition at line 644 of file avformat.h.

Function Documentation

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
sassociated IO context
pktpacket
sizedesired payload size
Returns
>0 (read size) if OK, AVERROR_xxx otherwise
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
sassociated IO context
pktpacket
sizeamount of data to read
Returns
>0 (read size) if OK, AVERROR_xxx otherwise, previous data will not be lost even if an error occurs.