FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Macros | Typedefs | Enumerations | Functions
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  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_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_SHOW_IDS   0x0008
 Show format stream IDs numbers. More...
 
#define AVFMT_RAWPICTURE   0x0020
 Format wants AVPicture structure for raw picture data. 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   0x8020000
 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 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. More...
 
#define AV_DISPOSITION_HEARING_IMPAIRED   0x0080
 stream for hearing impaired audiences More...
 
#define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100
 stream for visual impaired audiences More...
 
#define AV_DISPOSITION_CLEAN_EFFECTS   0x0200
 stream without voice More...
 
#define AV_DISPOSITION_ATTACHED_PIC   0x0400
 The stream is stored in the file as an attached picture/"cover art" (e.g. More...
 
#define AV_DISPOSITION_CAPTIONS   0x10000
 To specify text track kind (different from subtitles default). More...
 
#define AV_DISPOSITION_DESCRIPTIONS   0x20000
 
#define AV_DISPOSITION_METADATA   0x40000
 
#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
 The call resulted in updated metadata. More...
 
#define MAX_STD_TIMEBASES   (30*12+7+6)
 Stream information used internally by av_find_stream_info() More...
 
#define MAX_REORDER_DELAY   16
 
#define AV_PROGRAM_RUNNING   1
 
#define AVFMTCTX_NOHEADER   0x0001
 signal that no header is present (streams are added dynamically) 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_MP4A_LATM   0x8000
 Enable RTP MP4A-LATM payload. 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_PRIV_OPT   0x20000
 Enable use of private options by delaying codec open (this could be made default once all code is converted) More...
 
#define AVFMT_FLAG_KEEP_SIDE_DATA   0x40000
 Don't merge side data but keep it separate. More...
 
#define AVFMT_FLAG_FAST_SEEK   0x80000
 Enable fast, but inaccurate seeks for some formats. More...
 
#define FF_FDEBUG_TS   0x0001
 
#define AVFMT_EVENT_FLAG_METADATA_UPDATED   0x0001
 The call resulted in updated metadata. More...
 
#define AVFMT_AVOID_NEG_TS_AUTO   -1
 Enabled when required by target format. 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...
 

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 =MKTAG(0,'R','A','W')
}
 
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...
 

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...
 
AVRational av_stream_get_r_frame_rate (const AVStream *s)
 
void av_stream_set_r_frame_rate (AVStream *s, AVRational r)
 
struct AVCodecParserContextav_stream_get_parser (const AVStream *s)
 
char * av_stream_get_recommended_encoder_configuration (const AVStream *s)
 
void av_stream_set_recommended_encoder_configuration (AVStream *s, char *configuration)
 
int64_t av_stream_get_end_pts (const AVStream *st)
 Returns the pts of the last muxed packet + its duration. More...
 
int av_format_get_probe_score (const AVFormatContext *s)
 
AVCodecav_format_get_video_codec (const AVFormatContext *s)
 
void av_format_set_video_codec (AVFormatContext *s, AVCodec *c)
 
AVCodecav_format_get_audio_codec (const AVFormatContext *s)
 
void av_format_set_audio_codec (AVFormatContext *s, AVCodec *c)
 
AVCodecav_format_get_subtitle_codec (const AVFormatContext *s)
 
void av_format_set_subtitle_codec (AVFormatContext *s, AVCodec *c)
 
AVCodecav_format_get_data_codec (const AVFormatContext *s)
 
void av_format_set_data_codec (AVFormatContext *s, AVCodec *c)
 
int av_format_get_metadata_header_padding (const AVFormatContext *s)
 
void av_format_set_metadata_header_padding (AVFormatContext *s, int c)
 
voidav_format_get_opaque (const AVFormatContext *s)
 
void av_format_set_opaque (AVFormatContext *s, void *opaque)
 
av_format_control_message av_format_get_control_message_cb (const AVFormatContext *s)
 
void av_format_set_control_message_cb (AVFormatContext *s, av_format_control_message callback)
 
AVOpenCallback av_format_get_open_cb (const AVFormatContext *s)
 
void av_format_set_open_cb (AVFormatContext *s, AVOpenCallback callback)
 
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...
 
void av_register_all (void)
 Initialize libavformat and register all the muxers, demuxers and protocols. More...
 
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. More...
 
int avformat_network_deinit (void)
 Undo the initialization done by avformat_network_init. More...
 
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. More...
 
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. More...
 
AVFormatContextavformat_alloc_context (void)
 Allocate an AVFormatContext. More...
 
void avformat_free_context (AVFormatContext *s)
 Free an AVFormatContext and all its streams. More...
 
const AVClassavformat_get_class (void)
 Get the AVClass for AVFormatContext. More...
 
AVStreamavformat_new_stream (AVFormatContext *s, const AVCodec *c)
 Add a new stream to a media file. More...
 
uint8_tav_stream_get_side_data (AVStream *stream, enum AVPacketSideDataType type, int *size)
 Get side information from stream. More...
 
AVProgramav_new_program (AVFormatContext *s, int id)
 
int avformat_alloc_output_context2 (AVFormatContext **ctx, AVOutputFormat *oformat, const char *format_name, const char *filename)
 Allocate an AVFormatContext for an output format. More...
 
AVInputFormatav_find_input_format (const char *short_name)
 Find AVInputFormat based on the short name of the input format. More...
 
AVInputFormatav_probe_input_format (AVProbeData *pd, int is_opened)
 Guess the file format. More...
 
AVInputFormatav_probe_input_format2 (AVProbeData *pd, int is_opened, int *score_max)
 Guess the file format. More...
 
AVInputFormatav_probe_input_format3 (AVProbeData *pd, int is_opened, int *score_ret)
 Guess the file format. More...
 
int av_probe_input_buffer2 (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. More...
 
int av_probe_input_buffer (AVIOContext *pb, AVInputFormat **fmt, const char *filename, 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 *filename, AVInputFormat *fmt, AVDictionary **options)
 Open an input stream and read the header. More...
 
attribute_deprecated int av_demuxer_open (AVFormatContext *ic)
 
int avformat_find_stream_info (AVFormatContext *ic, AVDictionary **options)
 Read packets of a media file to get stream information. More...
 
AVProgramav_find_program_from_stream (AVFormatContext *ic, AVProgram *last, int s)
 Find the programs which belong to a given stream. More...
 
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. 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...
 
int avformat_write_header (AVFormatContext *s, AVDictionary **options)
 Allocate the stream private data and write the stream header to an output media file. 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 a uncoded frame to an output media file. More...
 
int av_interleaved_write_uncoded_frame (AVFormatContext *s, int stream_index, AVFrame *frame)
 Write a 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...
 
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. More...
 
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. 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 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_filename (char *buf, int buf_size, const char *path, int number)
 Return in 'buf' the path with 'd' replaced by a number. More...
 
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 AVCodecTagavformat_get_riff_video_tags (void)
 
const struct AVCodecTagavformat_get_riff_audio_tags (void)
 
const struct AVCodecTagavformat_get_mov_video_tags (void)
 
const struct AVCodecTagavformat_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)
 

Detailed Description

Main libavformat public API header.

Definition in file avformat.h.

Macro Definition Documentation

#define AVPROBE_SCORE_RETRY   (AVPROBE_SCORE_MAX/4)

Definition at line 455 of file avformat.h.

Referenced by av_probe_input_buffer2(), init_input(), and sup_probe().

#define AVPROBE_SCORE_STREAM_RETRY   (AVPROBE_SCORE_MAX/4-1)

Definition at line 456 of file avformat.h.

Referenced by mpegts_set_stream_info(), and probe_codec().

#define AVPROBE_SCORE_EXTENSION   50
#define AVPROBE_SCORE_MIME   75

score for file mime type

Definition at line 459 of file avformat.h.

Referenced by av_probe_input_format3().

#define AVPROBE_SCORE_MAX   100

maximum score

Definition at line 460 of file avformat.h.

Referenced by aa_probe(), adp_probe(), aea_read_probe(), aiff_probe(), alias_pix_read_probe(), amr_probe(), apc_probe(), ape_probe(), apng_probe(), asf_probe(), ass_probe(), ast_probe(), avi_probe(), bfi_probe(), brender_read_probe(), cdata_probe(), cin_probe(), cine_read_probe(), concat_probe(), dds_probe(), dfa_probe(), dirac_probe(), dnxhd_probe(), dsf_probe(), dss_probe(), dtshd_probe(), dv_probe(), dxa_probe(), ea_probe(), epaf_probe(), ff_spdif_probe(), ffm_probe(), film_probe(), flic_probe(), fourxm_probe(), frm_read_probe(), gif_probe(), gxf_probe(), hls_probe(), hnm_probe(), iff_probe(), ilbc_probe(), img_read_probe(), ipmovie_probe(), ircam_probe(), iss_probe(), lmlm4_probe(), lvf_probe(), lxf_probe(), matroska_probe(), microdvd_probe(), mmf_probe(), mov_probe(), mpc8_probe(), mpc_probe(), mpegts_probe(), mpjpeg_read_probe(), mpl2_probe(), msnwc_tcp_probe(), mtv_probe(), mv_probe(), mxf_probe(), nc_probe(), nist_probe(), nsv_probe(), nut_probe(), nuv_probe(), ogg_probe(), oma_read_probe(), pjs_probe(), pmp_probe(), png_probe(), probe(), probe_bfstm(), probe_gme(), pva_probe(), pvf_probe(), qcp_probe(), qdraw_probe(), r3d_probe(), read_probe(), redspark_probe(), rl2_probe(), rm_probe(), roq_probe(), rpl_probe(), rsd_probe(), rtsp_probe(), sami_probe(), sap_probe(), sbg_read_probe(), seq_probe(), siff_probe(), smacker_probe(), smjpeg_probe(), smush_read_probe(), sol_probe(), sox_probe(), srt_probe(), stl_probe(), subviewer_probe(), sup_probe(), swf_probe(), tedcaptions_read_probe(), thp_probe(), tmv_probe(), txd_probe(), v4l2_read_probe(), vid_probe(), vivo_probe(), voc_probe(), vplayer_probe(), vqf_probe(), wc3_probe(), webp_probe(), webvtt_probe(), wsvqa_probe(), wv_probe(), xmv_probe(), xwma_probe(), yop_probe(), and yuv4_probe().

#define AVPROBE_PADDING_SIZE   32

extra allocated bytes at the end of the probe buffer

Definition at line 462 of file avformat.h.

Referenced by av_probe_input_buffer2(), av_probe_input_format3(), ff_img_read_header(), ff_img_read_packet(), main(), probe_codec(), and read_gab2_sub().

#define AVFMT_NOFILE   0x0001
#define AVFMT_NEEDNUMBER   0x0002

Needs 'd' in filename.

Definition at line 466 of file avformat.h.

Referenced by avformat_open_input(), and open_output_file().

#define AVFMT_SHOW_IDS   0x0008

Show format stream IDs numbers.

Definition at line 467 of file avformat.h.

Referenced by dump_stream_format(), and show_stream().

#define AVFMT_RAWPICTURE   0x0020

Format wants AVPicture structure for raw picture data.

Examples:
muxing.c.

Definition at line 468 of file avformat.h.

Referenced by do_video_out(), flush_encoders(), and write_video_frame().

#define AVFMT_GLOBALHEADER   0x0040

Format wants global header.

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

Definition at line 471 of file avformat.h.

Referenced by add_stream(), init_muxer(), main(), new_output_stream(), and open_output_file().

#define AVFMT_NOTIMESTAMPS   0x0080

Format does not need / have any timestamps.

Definition at line 472 of file avformat.h.

Referenced by av_interleaved_write_frame(), av_write_frame(), avformat_find_stream_info(), avformat_write_header(), do_video_out(), and write_frame().

#define AVFMT_GENERIC_INDEX   0x0100

Use generic index building code.

Definition at line 473 of file avformat.h.

Referenced by av_read_frame(), and read_frame_internal().

#define AVFMT_TS_DISCONT   0x0200

Format allows timestamp discontinuities.

Note, muxers always require valid (monotone) timestamps

Definition at line 474 of file avformat.h.

Referenced by process_input(), and read_thread().

#define AVFMT_VARIABLE_FPS   0x0400

Format allows variable fps.

Definition at line 475 of file avformat.h.

Referenced by do_video_out(), and transcode_init().

#define AVFMT_NODIMENSIONS   0x0800

Format does not need width/height.

Definition at line 476 of file avformat.h.

Referenced by init_muxer().

#define AVFMT_NOSTREAMS   0x1000

Format does not require any streams.

Definition at line 477 of file avformat.h.

Referenced by init_muxer(), and open_output_file().

#define AVFMT_NOBINSEARCH   0x2000

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

Definition at line 478 of file avformat.h.

Referenced by seek_frame_internal(), and stream_component_open().

#define AVFMT_NOGENSEARCH   0x4000

Format does not allow to fall back on generic search.

Definition at line 479 of file avformat.h.

Referenced by seek_frame_internal(), and stream_component_open().

#define AVFMT_NO_BYTE_SEEK   0x8000

Format does not allow seeking by bytes.

Definition at line 480 of file avformat.h.

Referenced by seek_frame_internal(), and stream_component_open().

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

Referenced by av_write_frame().

#define AVFMT_TS_NONSTRICT   0x8020000

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

Definition at line 483 of file avformat.h.

Referenced by compute_pkt_fields2(), and write_frame().

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

Referenced by avformat_write_header().

#define AVFMT_SEEK_TO_PTS   0x4000000

Seeking is based on PTS.

Definition at line 506 of file avformat.h.

Referenced by open_input_file().

#define AVINDEX_KEYFRAME   0x0001
#define AV_DISPOSITION_DEFAULT   0x0001
#define AV_DISPOSITION_DUB   0x0002

Definition at line 798 of file avformat.h.

Referenced by dump_stream_format().

#define AV_DISPOSITION_ORIGINAL   0x0004

Definition at line 799 of file avformat.h.

Referenced by dump_stream_format().

#define AV_DISPOSITION_COMMENT   0x0008

Definition at line 800 of file avformat.h.

Referenced by avformat_find_stream_info(), and dump_stream_format().

#define AV_DISPOSITION_LYRICS   0x0010

Definition at line 801 of file avformat.h.

Referenced by dump_stream_format().

#define AV_DISPOSITION_KARAOKE   0x0020

Definition at line 802 of file avformat.h.

Referenced by avformat_find_stream_info(), and dump_stream_format().

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

Referenced by dump_stream_format(), matroska_parse_tracks(), mkv_write_track(), and new_rendition().

#define AV_DISPOSITION_HEARING_IMPAIRED   0x0080
#define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100
#define AV_DISPOSITION_CLEAN_EFFECTS   0x0200

stream without voice

Definition at line 812 of file avformat.h.

Referenced by avformat_find_stream_info(), dump_stream_format(), ff_parse_mpeg2_descriptor(), and mpegts_write_pmt().

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

Referenced by ape_tag_read_field(), asf_read_picture(), av_find_default_stream_index(), avformat_find_stream_info(), avformat_match_stream_specifier(), avformat_queue_attached_pictures(), ff_flac_parse_picture(), ff_id3v2_parse_apic(), get_attachment(), matroska_read_header(), mov_read_covr(), open_output_file(), read_thread(), and select_reference_stream().

#define AV_DISPOSITION_CAPTIONS   0x10000

To specify text track kind (different from subtitles default).

Definition at line 824 of file avformat.h.

Referenced by mkv_write_track().

#define AV_DISPOSITION_DESCRIPTIONS   0x20000

Definition at line 825 of file avformat.h.

Referenced by mkv_write_track().

#define AV_DISPOSITION_METADATA   0x40000

Definition at line 826 of file avformat.h.

Referenced by mkv_write_track().

#define AV_PTS_WRAP_IGNORE   0

Options for behavior on timestamp wrap detection.

ignore the wrap

Definition at line 831 of file avformat.h.

Referenced by av_new_program(), avformat_new_stream(), and wrap_timestamp().

#define AV_PTS_WRAP_ADD_OFFSET   1

add the format specific offset on wrap detection

Definition at line 832 of file avformat.h.

Referenced by update_wrap_reference(), and wrap_timestamp().

#define AV_PTS_WRAP_SUB_OFFSET   -1

subtract the format specific offset on wrap detection

Definition at line 833 of file avformat.h.

Referenced by ff_read_packet(), update_wrap_reference(), and wrap_timestamp().

#define AVSTREAM_EVENT_FLAG_METADATA_UPDATED   0x0001

The call resulted in updated metadata.

Definition at line 966 of file avformat.h.

Referenced by decode_info_header(), ff_vorbis_stream_comment(), and flv_write_packet().

#define MAX_STD_TIMEBASES   (30*12+7+6)

Stream information used internally by av_find_stream_info()

Definition at line 979 of file avformat.h.

Referenced by avformat_find_stream_info(), ff_rfps_add_frame(), and ff_rfps_calculate().

#define MAX_REORDER_DELAY   16
#define AV_PROGRAM_RUNNING   1

Definition at line 1198 of file avformat.h.

#define AVFMTCTX_NOHEADER   0x0001
#define AVFMT_FLAG_GENPTS   0x0001

Generate missing pts even if it requires parsing future frames.

Definition at line 1385 of file avformat.h.

Referenced by av_read_frame(), open_input_stream(), and read_thread().

#define AVFMT_FLAG_IGNIDX   0x0002
#define AVFMT_FLAG_NONBLOCK   0x0004
#define AVFMT_FLAG_IGNDTS   0x0008

Ignore DTS on frames that contain both DTS & PTS.

Definition at line 1388 of file avformat.h.

Referenced by compute_pkt_fields().

#define AVFMT_FLAG_NOFILLIN   0x0010

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

Definition at line 1389 of file avformat.h.

Referenced by compute_pkt_fields(), and extract_mpeg4_header().

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

Referenced by avformat_find_stream_info(), extract_mpeg4_header(), and read_frame_internal().

#define AVFMT_FLAG_NOBUFFER   0x0040

Do not buffer frames when possible.

Definition at line 1391 of file avformat.h.

Referenced by avformat_find_stream_info().

#define AVFMT_FLAG_CUSTOM_IO   0x0080

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

Definition at line 1392 of file avformat.h.

Referenced by avformat_close_input(), avformat_open_input(), ff_img_read_header(), hls_read_header(), and init_input().

#define AVFMT_FLAG_DISCARD_CORRUPT   0x0100

Discard frames marked corrupted.

Definition at line 1393 of file avformat.h.

Referenced by ff_read_packet().

#define AVFMT_FLAG_FLUSH_PACKETS   0x0200

Flush the AVIOContext every packet.

Definition at line 1394 of file avformat.h.

Referenced by av_write_frame(), avformat_write_header(), and write_packet().

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

Referenced by ff_framehash_write_header(), ff_rtp_chain_mux_open(), flac_write_header(), init_muxer(), lrc_write_header(), mkv_write_attachments(), mkv_write_header(), mov_write_ilst_tag(), mov_write_isml_manifest(), mov_write_uuidusmt_tag(), mxf_write_header(), mxf_write_identification(), ogg_write_header(), put_flac_codecpriv(), rtp_write_header(), set_encoder_id(), and write_sm_data().

#define AVFMT_FLAG_MP4A_LATM   0x8000

Enable RTP MP4A-LATM payload.

Definition at line 1402 of file avformat.h.

Referenced by ff_rtp_chain_mux_open().

#define AVFMT_FLAG_SORT_DTS   0x10000

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

Definition at line 1403 of file avformat.h.

Referenced by avi_read_header().

#define AVFMT_FLAG_PRIV_OPT   0x20000

Enable use of private options by delaying codec open (this could be made default once all code is converted)

Definition at line 1404 of file avformat.h.

Referenced by avformat_open_input().

#define AVFMT_FLAG_KEEP_SIDE_DATA   0x40000

Don't merge side data but keep it separate.

Definition at line 1405 of file avformat.h.

Referenced by read_frame_internal().

#define AVFMT_FLAG_FAST_SEEK   0x80000

Enable fast, but inaccurate seeks for some formats.

Definition at line 1406 of file avformat.h.

Referenced by mp3_read_header().

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

Definition at line 1577 of file avformat.h.

Referenced by avformat_write_header(), and mov_write_header().

#define AVFMT_AVOID_NEG_TS_MAKE_NON_NEGATIVE   1

Shift timestamps so they are non negative.

Definition at line 1578 of file avformat.h.

Referenced by avformat_write_header().

#define AVFMT_AVOID_NEG_TS_MAKE_ZERO   2

Shift timestamps so that they start at 0.

Definition at line 1579 of file avformat.h.

Referenced by dash_write_packet(), ff_mov_write_packet(), mov_write_header(), and write_packet().

#define AVSEEK_FLAG_BACKWARD   1
#define AVSEEK_FLAG_BYTE   2
#define AVSEEK_FLAG_ANY   4
#define AVSEEK_FLAG_FRAME   8

seeking based on frame number

Definition at line 2280 of file avformat.h.

Referenced by cine_read_seek(), concat_seek(), ff_subtitles_queue_seek(), mv_read_seek(), and read_seek().

Typedef Documentation

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

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

Definition at line 1250 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

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

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 1257 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

Definition at line 244 of file utils.c.

Referenced by adp_read_packet(), adx_read_packet(), aea_read_packet(), afc_read_packet(), aiff_read_packet(), apc_read_packet(), ape_tag_read_field(), asf_read_header(), asf_read_picture(), asf_read_subpayload(), ast_read_packet(), av_append_packet(), bfi_read_packet(), cdata_read_packet(), cdxl_read_packet(), cin_read_packet(), cine_read_packet(), daud_packet(), dfa_read_packet(), dsf_read_packet(), dxa_read_packet(), ea_read_packet(), 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(), g729_read_packet(), get_attachment(), gif_read_packet(), gsm_read_packet(), gxf_packet(), hnm_read_packet(), idcin_read_packet(), iff_read_packet(), ingenient_read_packet(), iss_read_packet(), lmlm4_read_packet(), load_ipmovie_packet(), lvf_read_packet(), mmf_read_packet(), mov_read_covr(), mov_read_packet(), mp3_read_packet(), mpc8_read_packet(), mpegps_read_packet(), mpjpeg_read_packet(), msnwc_tcp_read_packet(), mtv_read_packet(), mv_read_packet(), mxf_decrypt_triplet(), mxf_get_d10_aes3_packet(), mxf_read_packet(), mxf_read_packet_old(), nc_read_packet(), nsv_read_chunk(), nuv_packet(), oma_read_packet(), pmp_packet(), pva_read_packet(), qcp_read_packet(), r3d_read_reda(), r3d_read_redv(), raw_read_packet(), rawvideo_read_packet(), read_packet(), redspark_read_packet(), rl2_read_packet(), roq_read_packet(), rpl_read_packet(), rsd_read_packet(), sdr2_read_packet(), seq_read_packet(), siff_read_packet(), smjpeg_read_packet(), smush_read_packet(), sol_read_packet(), sup_read_packet(), swf_read_packet(), thp_read_packet(), tmv_read_packet(), tta_read_packet(), txd_read_packet(), vc1t_read_packet(), vid_read_packet(), vivo_read_packet(), wc3_read_packet(), wsaud_read_packet(), wsvqa_read_packet(), xa_read_packet(), xmv_fetch_audio_packet(), xmv_fetch_video_packet(), xwma_read_packet(), yop_read_packet(), and yuv4_read_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
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.

Definition at line 254 of file utils.c.

Referenced by apng_read_packet(), dfa_read_packet(), ea_read_packet(), read_packet(), sup_read_packet(), vivo_read_packet(), wc3_read_header(), and wc3_read_packet().

AVRational av_stream_get_r_frame_rate ( const AVStream s)
void av_stream_set_r_frame_rate ( AVStream s,
AVRational  r 
)
struct AVCodecParserContext* av_stream_get_parser ( const AVStream s)

Definition at line 125 of file utils.c.

Referenced by process_input_packet().

char* av_stream_get_recommended_encoder_configuration ( const AVStream s)
void av_stream_set_recommended_encoder_configuration ( AVStream s,
char *  configuration 
)

Referenced by add_av_stream(), and add_codec().

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 117 of file utils.c.

Referenced by do_video_stats(), and print_report().

int av_format_get_probe_score ( const AVFormatContext s)

Definition at line 173 of file utils.c.

Referenced by show_format().

AVCodec* av_format_get_video_codec ( const AVFormatContext s)
void av_format_set_video_codec ( AVFormatContext s,
AVCodec c 
)

Referenced by open_input_file().

AVCodec* av_format_get_audio_codec ( const AVFormatContext s)
void av_format_set_audio_codec ( AVFormatContext s,
AVCodec c 
)

Referenced by open_input_file().

AVCodec* av_format_get_subtitle_codec ( const AVFormatContext s)
void av_format_set_subtitle_codec ( AVFormatContext s,
AVCodec c 
)

Referenced by open_input_file().

AVCodec* av_format_get_data_codec ( const AVFormatContext s)
void av_format_set_data_codec ( AVFormatContext s,
AVCodec c 
)

Referenced by open_input_file().

int av_format_get_metadata_header_padding ( const AVFormatContext s)
void av_format_set_metadata_header_padding ( AVFormatContext s,
int  c 
)
void* av_format_get_opaque ( const AVFormatContext s)
void av_format_set_opaque ( AVFormatContext s,
void opaque 
)
av_format_control_message av_format_get_control_message_cb ( const AVFormatContext s)
void av_format_set_control_message_cb ( AVFormatContext s,
av_format_control_message  callback 
)
AVOpenCallback av_format_get_open_cb ( const AVFormatContext s)
void av_format_set_open_cb ( AVFormatContext s,
AVOpenCallback  callback 
)
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 130 of file utils.c.

Referenced by read_thread().

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 129 of file options.c.

int avformat_alloc_output_context2 ( AVFormatContext **  ctx,
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
*ctxis set to the created format context, or to NULL in case of failure
oformatformat to use for allocating the context, if NULL format_name and filename are used instead
format_namethe name of output format to use for allocating the context, if NULL filename is used instead
filenamethe 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, and transcoding.c.

Definition at line 148 of file mux.c.

Referenced by avdevice_list_output_sinks(), chunk_mux_init(), hls_mux_init(), main(), open_output_file(), open_slave(), segment_mux_init(), and write_packet().