2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVFORMAT_AVFORMAT_H
22 #define AVFORMAT_AVFORMAT_H
26 * Return the LIBAVFORMAT_VERSION_INT constant.
28 unsigned avformat_version(void);
31 * Return the libavformat build-time configuration.
33 const char *avformat_configuration(void);
36 * Return the libavformat license.
38 const char *avformat_license(void);
41 #include <stdio.h> /* FILE */
42 #include "libavcodec/avcodec.h"
43 #include "libavutil/dict.h"
46 #include "libavformat/version.h"
48 struct AVFormatContext;
52 * @defgroup metadata_api Public Metadata API
54 * The metadata API allows libavformat to export metadata tags to a client
55 * application using a sequence of key/value pairs. Like all strings in FFmpeg,
56 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
57 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
58 * Important concepts to keep in mind:
59 * - Keys are unique; there can never be 2 tags with the same key. This is
60 * also meant semantically, i.e., a demuxer should not knowingly produce
61 * several keys that are literally different but semantically identical.
62 * E.g., key=Author5, key=Author6. In this example, all authors must be
63 * placed in the same tag.
64 * - Metadata is flat, not hierarchical; there are no subtags. If you
65 * want to store, e.g., the email address of the child of producer Alice
66 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
67 * - Several modifiers can be applied to the tag name. This is done by
68 * appending a dash character ('-') and the modifier name in the order
69 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
70 * - language -- a tag whose value is localized for a particular language
71 * is appended with the ISO 639-2/B 3-letter language code.
72 * For example: Author-ger=Michael, Author-eng=Mike
73 * The original/default language is in the unqualified "Author" tag.
74 * A demuxer should set a default if it sets any translated tag.
75 * - sorting -- a modified version of a tag that should be used for
76 * sorting will have '-sort' appended. E.g. artist="The Beatles",
77 * artist-sort="Beatles, The".
79 * - Demuxers attempt to export metadata in a generic format, however tags
80 * with no generic equivalents are left as they are stored in the container.
81 * Follows a list of generic tag names:
84 album -- name of the set this work belongs to
85 album_artist -- main creator of the set/album, if different from artist.
86 e.g. "Various Artists" for compilation albums.
87 artist -- main creator of the work
88 comment -- any additional description of the file.
89 composer -- who composed the work, if different from artist.
90 copyright -- name of copyright holder.
91 creation_time-- date when the file was created, preferably in ISO 8601.
92 date -- date when the work was created, preferably in ISO 8601.
93 disc -- number of a subset, e.g. disc in a multi-disc collection.
94 encoder -- name/settings of the software/hardware that produced the file.
95 encoded_by -- person/group who created the file.
96 filename -- original name of the file.
97 genre -- <self-evident>.
98 language -- main language in which the work is performed, preferably
99 in ISO 639-2 format. Multiple languages can be specified by
100 separating them with commas.
101 performer -- artist who performed the work, if different from artist.
102 E.g for "Also sprach Zarathustra", artist would be "Richard
103 Strauss" and performer "London Philharmonic Orchestra".
104 publisher -- name of the label/publisher.
105 service_name -- name of the service in broadcasting (channel name).
106 service_provider -- name of the service provider in broadcasting.
107 title -- name of the work.
108 track -- number of this work in the set, can be in form current/total.
109 variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
112 * Look in the examples section for an application example how to use the Metadata API.
117 #if FF_API_OLD_METADATA2
119 * @defgroup old_metadata Old metadata API
120 * The following functions are deprecated, use
121 * their equivalents from libavutil/dict.h instead.
125 #define AV_METADATA_MATCH_CASE AV_DICT_MATCH_CASE
126 #define AV_METADATA_IGNORE_SUFFIX AV_DICT_IGNORE_SUFFIX
127 #define AV_METADATA_DONT_STRDUP_KEY AV_DICT_DONT_STRDUP_KEY
128 #define AV_METADATA_DONT_STRDUP_VAL AV_DICT_DONT_STRDUP_VAL
129 #define AV_METADATA_DONT_OVERWRITE AV_DICT_DONT_OVERWRITE
131 typedef attribute_deprecated AVDictionary AVMetadata;
132 typedef attribute_deprecated AVDictionaryEntry AVMetadataTag;
134 typedef struct AVMetadataConv AVMetadataConv;
137 * Get a metadata element with matching key.
139 * @param prev Set to the previous matching element to find the next.
140 * If set to NULL the first matching element is returned.
141 * @param flags Allows case as well as suffix-insensitive comparisons.
142 * @return Found tag or NULL, changing key or value leads to undefined behavior.
144 attribute_deprecated AVDictionaryEntry *
145 av_metadata_get(AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags);
148 * Set the given tag in *pm, overwriting an existing tag.
150 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
151 * a metadata struct is allocated and put in *pm.
152 * @param key tag key to add to *pm (will be av_strduped depending on flags)
153 * @param value tag value to add to *pm (will be av_strduped depending on flags).
154 * Passing a NULL value will cause an existing tag to be deleted.
155 * @return >= 0 on success otherwise an error code <0
157 attribute_deprecated int av_metadata_set2(AVDictionary **pm, const char *key, const char *value, int flags);
160 * This function is provided for compatibility reason and currently does nothing.
162 attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
163 const AVMetadataConv *s_conv);
166 * Copy metadata from one AVDictionary struct into another.
167 * @param dst pointer to a pointer to a AVDictionary struct. If *dst is NULL,
168 * this function will allocate a struct for you and put it in *dst
169 * @param src pointer to source AVDictionary struct
170 * @param flags flags to use when setting metadata in *dst
171 * @note metadata is read using the AV_DICT_IGNORE_SUFFIX flag
173 attribute_deprecated void av_metadata_copy(AVDictionary **dst, AVDictionary *src, int flags);
176 * Free all the memory allocated for an AVDictionary struct.
178 attribute_deprecated void av_metadata_free(AVDictionary **m);
185 /* packet functions */
189 * Allocate and read the payload of a packet and initialize its
190 * fields with default values.
193 * @param size desired payload size
194 * @return >0 (read size) if OK, AVERROR_xxx otherwise
196 int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
200 * Read data and append it to the current content of the AVPacket.
201 * If pkt->size is 0 this is identical to av_get_packet.
202 * Note that this uses av_grow_packet and thus involves a realloc
203 * which is inefficient. Thus this function should only be used
204 * when there is no reasonable way to know (an upper bound of)
208 * @param size amount of data to read
209 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
210 * will not be lost even if an error occurs.
212 int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
214 /*************************************************/
215 /* fractional numbers for exact pts handling */
218 * The exact value of the fractional number is: 'val + num / den'.
219 * num is assumed to be 0 <= num < den.
221 typedef struct AVFrac {
222 int64_t val, num, den;
225 /*************************************************/
226 /* input/output formats */
231 * This structure contains the data a format has to probe a file.
233 typedef struct AVProbeData {
234 const char *filename;
235 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
236 int buf_size; /**< Size of buf except extra allocated bytes */
239 #define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
240 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
242 typedef struct AVFormatParameters {
243 #if FF_API_FORMAT_PARAMETERS
244 attribute_deprecated AVRational time_base;
245 attribute_deprecated int sample_rate;
246 attribute_deprecated int channels;
247 attribute_deprecated int width;
248 attribute_deprecated int height;
249 attribute_deprecated enum PixelFormat pix_fmt;
250 attribute_deprecated int channel; /**< Used to select DV channel. */
251 attribute_deprecated const char *standard; /**< deprecated, use demuxer-specific options instead. */
252 attribute_deprecated unsigned int mpeg2ts_raw:1; /**< deprecated, use mpegtsraw demuxer */
253 /**< deprecated, use mpegtsraw demuxer-specific options instead */
254 attribute_deprecated unsigned int mpeg2ts_compute_pcr:1;
255 attribute_deprecated unsigned int initial_pause:1; /**< Do not begin to play the stream
256 immediately (RTSP only). */
257 attribute_deprecated unsigned int prealloced_context:1;
259 } AVFormatParameters;
261 //! Demuxer will use avio_open, no opened file should be provided by the caller.
262 #define AVFMT_NOFILE 0x0001
263 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
264 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
265 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
267 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
268 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
269 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
270 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
271 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
272 #define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
273 #define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */
274 #define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fallback to binary search via read_timestamp */
275 #define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fallback to generic search */
276 #define AVFMT_TS_NONSTRICT 0x8000 /**< Format does not require strictly
277 increasing timestamps, but they must
278 still be monotonic */
280 typedef struct AVOutputFormat {
283 * Descriptive name for the format, meant to be more human-readable
284 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
287 const char *long_name;
288 const char *mime_type;
289 const char *extensions; /**< comma-separated filename extensions */
291 * size of private data so that it can be allocated in the wrapper
295 enum CodecID audio_codec; /**< default audio codec */
296 enum CodecID video_codec; /**< default video codec */
297 int (*write_header)(struct AVFormatContext *);
298 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
299 int (*write_trailer)(struct AVFormatContext *);
301 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
302 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
303 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS
309 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
310 AVPacket *in, int flush);
313 * List of supported codec_id-codec_tag pairs, ordered by "better
314 * choice first". The arrays are all terminated by CODEC_ID_NONE.
316 const struct AVCodecTag * const *codec_tag;
318 enum CodecID subtitle_codec; /**< default subtitle codec */
320 #if FF_API_OLD_METADATA2
321 const AVMetadataConv *metadata_conv;
324 const AVClass *priv_class; ///< AVClass for the private context
326 void (*get_output_timestamp)(struct AVFormatContext *s, int stream,
327 int64_t *dts, int64_t *wall);
330 struct AVOutputFormat *next;
333 typedef struct AVInputFormat {
335 * A comma separated list of short names for the format. New names
336 * may be appended with a minor bump.
341 * Descriptive name for the format, meant to be more human-readable
342 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
345 const char *long_name;
348 * Size of private data so that it can be allocated in the wrapper.
353 * Tell if a given file has a chance of being parsed as this format.
354 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
355 * big so you do not have to check for that unless you need more.
357 int (*read_probe)(AVProbeData *);
360 * Read the format header and initialize the AVFormatContext
361 * structure. Return 0 if OK. 'ap' if non-NULL contains
362 * additional parameters. Only used in raw format right
363 * now. 'av_new_stream' should be called to create new streams.
365 int (*read_header)(struct AVFormatContext *,
366 AVFormatParameters *ap);
369 * Read one packet and put it in 'pkt'. pts and flags are also
370 * set. 'av_new_stream' can be called only if the flag
371 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
372 * background thread).
373 * @return 0 on success, < 0 on error.
374 * When returning an error, pkt must not have been allocated
375 * or must be freed before returning
377 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
380 * Close the stream. The AVFormatContext and AVStreams are not
381 * freed by this function
383 int (*read_close)(struct AVFormatContext *);
387 * Seek to a given timestamp relative to the frames in
388 * stream component stream_index.
389 * @param stream_index Must not be -1.
390 * @param flags Selects which direction should be preferred if no exact
391 * match is available.
392 * @return >= 0 on success (but not necessarily the new offset)
394 attribute_deprecated int (*read_seek)(struct AVFormatContext *,
395 int stream_index, int64_t timestamp, int flags);
398 * Gets the next timestamp in stream[stream_index].time_base units.
399 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
401 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
402 int64_t *pos, int64_t pos_limit);
405 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
410 * If extensions are defined, then no probe is done. You should
411 * usually not use extension format guessing because it is not
414 const char *extensions;
417 * General purpose read-only value that the format can use.
422 * Start/resume playing - only meaningful if using a network-based format
425 int (*read_play)(struct AVFormatContext *);
428 * Pause playing - only meaningful if using a network-based format
431 int (*read_pause)(struct AVFormatContext *);
433 const struct AVCodecTag * const *codec_tag;
436 * Seek to timestamp ts.
437 * Seeking will be done so that the point from which all active streams
438 * can be presented successfully will be closest to ts and within min/max_ts.
439 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
441 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
443 #if FF_API_OLD_METADATA2
444 const AVMetadataConv *metadata_conv;
447 const AVClass *priv_class; ///< AVClass for the private context
450 struct AVInputFormat *next;
453 enum AVStreamParseType {
455 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
456 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
457 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
458 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
461 typedef struct AVIndexEntry {
464 #define AVINDEX_KEYFRAME 0x0001
466 int size:30; //Yeah, trying to keep the size of this small to reduce memory requirements (it is 24 vs. 32 bytes due to possible 8-byte alignment).
467 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
470 #define AV_DISPOSITION_DEFAULT 0x0001
471 #define AV_DISPOSITION_DUB 0x0002
472 #define AV_DISPOSITION_ORIGINAL 0x0004
473 #define AV_DISPOSITION_COMMENT 0x0008
474 #define AV_DISPOSITION_LYRICS 0x0010
475 #define AV_DISPOSITION_KARAOKE 0x0020
478 * Track should be used during playback by default.
479 * Useful for subtitle track that should be displayed
480 * even when user did not explicitly ask for subtitles.
482 #define AV_DISPOSITION_FORCED 0x0040
483 #define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */
484 #define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */
485 #define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */
489 * New fields can be added to the end with minor version bumps.
490 * Removal, reordering and changes to existing fields require a major
492 * sizeof(AVStream) must not be used outside libav*.
494 typedef struct AVStream {
495 int index; /**< stream index in AVFormatContext */
496 int id; /**< format-specific stream ID */
497 AVCodecContext *codec; /**< codec context */
499 * Real base framerate of the stream.
500 * This is the lowest framerate with which all timestamps can be
501 * represented accurately (it is the least common multiple of all
502 * framerates in the stream). Note, this value is just a guess!
503 * For example, if the time base is 1/90000 and all frames have either
504 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
506 AVRational r_frame_rate;
509 /* internal data used in av_find_stream_info() */
513 * encoding: pts generation when outputting stream
518 * This is the fundamental unit of time (in seconds) in terms
519 * of which frame timestamps are represented. For fixed-fps content,
520 * time base should be 1/framerate and timestamp increments should be 1.
521 * decoding: set by libavformat
522 * encoding: set by libavformat in av_write_header
524 AVRational time_base;
525 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
526 /* ffmpeg.c private use */
527 int stream_copy; /**< If set, just copy stream. */
528 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
530 //FIXME move stuff to a flags field?
532 * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
533 * MN: dunno if that is the right place for it
538 * Decoding: pts of the first frame of the stream, in stream time base.
539 * Only set this if you are absolutely 100% sure that the value you set
540 * it to really is the pts of the first frame.
541 * This may be undefined (AV_NOPTS_VALUE).
542 * @note The ASF header does NOT contain a correct start_time the ASF
543 * demuxer must NOT set this.
548 * Decoding: duration of the stream, in stream time base.
549 * If a source file does not specify a duration, but does specify
550 * a bitrate, this value will be estimated from bitrate and file size.
554 /* av_read_frame() support */
555 enum AVStreamParseType need_parsing;
556 struct AVCodecParserContext *parser;
559 int last_IP_duration;
561 /* av_seek_frame() support */
562 AVIndexEntry *index_entries; /**< Only used if the format does not
563 support seeking natively. */
564 int nb_index_entries;
565 unsigned int index_entries_allocated_size;
567 int64_t nb_frames; ///< number of frames in this stream if known or 0
569 int disposition; /**< AV_DISPOSITION_* bit field */
571 AVProbeData probe_data;
572 #define MAX_REORDER_DELAY 16
573 int64_t pts_buffer[MAX_REORDER_DELAY+1];
576 * sample aspect ratio (0 if unknown)
577 * - encoding: Set by user.
578 * - decoding: Set by libavformat.
580 AVRational sample_aspect_ratio;
582 AVDictionary *metadata;
584 /* Intended mostly for av_read_frame() support. Not supposed to be used by */
585 /* external applications; try to use something else if at all possible. */
586 const uint8_t *cur_ptr;
590 // Timestamp generation support:
592 * Timestamp corresponding to the last dts sync point.
594 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
595 * a DTS is received from the underlying container. Otherwise set to
596 * AV_NOPTS_VALUE by default.
598 int64_t reference_dts;
601 * Number of packets to buffer for codec probing
602 * NOT PART OF PUBLIC API
604 #define MAX_PROBE_PACKETS 2500
608 * last packet in packet_buffer for this stream when muxing.
609 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
611 struct AVPacketList *last_in_packet_buffer;
616 AVRational avg_frame_rate;
619 * Number of frames that have been demuxed during av_find_stream_info()
621 int codec_info_nb_frames;
625 * This is the MPEG-TS stream identifier +1
628 int stream_identifier;
631 * Stream informations used internally by av_find_stream_info()
633 #define MAX_STD_TIMEBASES (60*12+5)
636 int64_t duration_gcd;
638 double duration_error[MAX_STD_TIMEBASES];
639 int64_t codec_info_duration;
643 * flag to indicate that probing is requested
644 * NOT PART OF PUBLIC API
649 #define AV_PROGRAM_RUNNING 1
652 * New fields can be added to the end with minor version bumps.
653 * Removal, reordering and changes to existing fields require a major
655 * sizeof(AVProgram) must not be used outside libav*.
657 typedef struct AVProgram {
660 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
661 unsigned int *stream_index;
662 unsigned int nb_stream_indexes;
663 AVDictionary *metadata;
670 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
671 (streams are added dynamically) */
673 typedef struct AVChapter {
674 int id; ///< unique ID to identify the chapter
675 AVRational time_base; ///< time base in which the start/end timestamps are specified
676 int64_t start, end; ///< chapter start/end time in time_base units
677 AVDictionary *metadata;
681 * Format I/O context.
682 * New fields can be added to the end with minor version bumps.
683 * Removal, reordering and changes to existing fields require a major
685 * sizeof(AVFormatContext) must not be used outside libav*.
687 typedef struct AVFormatContext {
688 const AVClass *av_class; /**< Set by avformat_alloc_context. */
689 /* Can only be iformat or oformat, not both at the same time. */
690 struct AVInputFormat *iformat;
691 struct AVOutputFormat *oformat;
694 unsigned int nb_streams;
696 char filename[1024]; /**< input or output filename */
700 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
701 /* private data for pts handling (do not modify directly). */
703 * This buffer is only needed when packets were already buffered but
704 * not decoded, for example to get the codec parameters in MPEG
707 struct AVPacketList *packet_buffer;
710 * Decoding: position of the first frame of the component, in
711 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
712 * It is deduced from the AVStream values.
717 * Decoding: duration of the stream, in AV_TIME_BASE fractional
718 * seconds. Only set this value if you know none of the individual stream
719 * durations and also dont set any of them. This is deduced from the
720 * AVStream values if not set.
725 * decoding: total file size, 0 if unknown
730 * Decoding: total stream bitrate in bit/s, 0 if not
731 * available. Never set it directly if the file_size and the
732 * duration are known as FFmpeg can compute it automatically.
736 /* av_read_frame() support */
739 /* av_seek_frame() support */
740 int64_t data_offset; /**< offset of the first packet */
743 unsigned int packet_size;
747 #define AVFMT_NOOUTPUTLOOP -1
748 #define AVFMT_INFINITEOUTPUTLOOP 0
750 * number of times to loop output in formats that support it
755 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
756 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
757 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
758 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
759 #define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
760 #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
761 #if FF_API_FLAG_RTP_HINT
762 #define AVFMT_FLAG_RTP_HINT 0x0040 ///< Deprecated, use the -movflags rtphint muxer specific AVOption instead
764 #define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
765 #define AVFMT_FLAG_MP4A_LATM 0x8000 ///< Enable RTP MP4A-LATM payload
766 #define AVFMT_FLAG_SORT_DTS 0x10000 ///< try to interleave outputted packets by dts (using this flag can slow demuxing down)
767 #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)
768 #define AVFMT_FLAG_KEEP_SIDE_DATA 0x40000 ///< Dont merge side data but keep it seperate.
773 * decoding: size of data to probe; encoding: unused.
775 unsigned int probesize;
778 * Maximum time (in AV_TIME_BASE units) during which the input should
779 * be analyzed in av_find_stream_info().
781 int max_analyze_duration;
786 unsigned int nb_programs;
787 AVProgram **programs;
790 * Forced video codec_id.
791 * Demuxing: Set by user.
793 enum CodecID video_codec_id;
796 * Forced audio codec_id.
797 * Demuxing: Set by user.
799 enum CodecID audio_codec_id;
802 * Forced subtitle codec_id.
803 * Demuxing: Set by user.
805 enum CodecID subtitle_codec_id;
808 * Maximum amount of memory in bytes to use for the index of each stream.
809 * If the index exceeds this size, entries will be discarded as
810 * needed to maintain a smaller size. This can lead to slower or less
811 * accurate seeking (depends on demuxer).
812 * Demuxers for which a full in-memory index is mandatory will ignore
815 * demuxing: set by user
817 unsigned int max_index_size;
820 * Maximum amount of memory in bytes to use for buffering frames
821 * obtained from realtime capture devices.
823 unsigned int max_picture_buffer;
825 unsigned int nb_chapters;
826 AVChapter **chapters;
829 * Flags to enable debugging.
832 #define FF_FDEBUG_TS 0x0001
835 * Raw packets from the demuxer, prior to parsing and decoding.
836 * This buffer is used for buffering packets until the codec can
837 * be identified, as parsing cannot be done without knowing the
840 struct AVPacketList *raw_packet_buffer;
841 struct AVPacketList *raw_packet_buffer_end;
843 struct AVPacketList *packet_buffer_end;
845 AVDictionary *metadata;
848 * Remaining size available for raw_packet_buffer, in bytes.
849 * NOT PART OF PUBLIC API
851 #define RAW_PACKET_BUFFER_SIZE 2500000
852 int raw_packet_buffer_remaining_size;
855 * Start time of the stream in real world time, in microseconds
856 * since the unix epoch (00:00 1st January 1970). That is, pts=0
857 * in the stream was captured at this real world time.
858 * - encoding: Set by user.
859 * - decoding: Unused.
861 int64_t start_time_realtime;
864 * decoding: number of frames used to probe fps
869 * Transport stream id.
870 * This will be moved into demuxer private options. Thus no API/ABI compatibility
875 typedef struct AVPacketList {
877 struct AVPacketList *next;
881 * If f is NULL, returns the first registered input format,
882 * if f is non-NULL, returns the next registered input format after f
883 * or NULL if f is the last one.
885 AVInputFormat *av_iformat_next(AVInputFormat *f);
888 * If f is NULL, returns the first registered output format,
889 * if f is non-NULL, returns the next registered output format after f
890 * or NULL if f is the last one.
892 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
894 #if FF_API_GUESS_IMG2_CODEC
895 attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
898 /* XXX: Use automatic init with either ELF sections or C file parser */
902 void av_register_input_format(AVInputFormat *format);
903 void av_register_output_format(AVOutputFormat *format);
906 * Return the output format in the list of registered output formats
907 * which best matches the provided parameters, or return NULL if
910 * @param short_name if non-NULL checks if short_name matches with the
911 * names of the registered formats
912 * @param filename if non-NULL checks if filename terminates with the
913 * extensions of the registered formats
914 * @param mime_type if non-NULL checks if mime_type matches with the
915 * MIME type of the registered formats
917 AVOutputFormat *av_guess_format(const char *short_name,
918 const char *filename,
919 const char *mime_type);
922 * Guess the codec ID based upon muxer and filename.
924 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
925 const char *filename, const char *mime_type,
926 enum AVMediaType type);
929 * Send a nice hexadecimal dump of a buffer to the specified file stream.
931 * @param f The file stream pointer where the dump should be sent to.
933 * @param size buffer size
935 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
937 void av_hex_dump(FILE *f, uint8_t *buf, int size);
940 * Send a nice hexadecimal dump of a buffer to the log.
942 * @param avcl A pointer to an arbitrary struct of which the first field is a
943 * pointer to an AVClass struct.
944 * @param level The importance level of the message, lower values signifying
947 * @param size buffer size
949 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
951 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
954 * Send a nice dump of a packet to the specified file stream.
956 * @param f The file stream pointer where the dump should be sent to.
957 * @param pkt packet to dump
958 * @param dump_payload True if the payload must be displayed, too.
959 * @param st AVStream that the packet belongs to
961 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
965 * Send a nice dump of a packet to the log.
967 * @param avcl A pointer to an arbitrary struct of which the first field is a
968 * pointer to an AVClass struct.
969 * @param level The importance level of the message, lower values signifying
971 * @param pkt packet to dump
972 * @param dump_payload True if the payload must be displayed, too.
973 * @param st AVStream that the packet belongs to
975 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
979 attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
980 attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
985 * Initialize libavformat and register all the muxers, demuxers and
986 * protocols. If you do not call this function, then you can select
987 * exactly which formats you want to support.
989 * @see av_register_input_format()
990 * @see av_register_output_format()
991 * @see av_register_protocol()
993 void av_register_all(void);
996 * Get the CodecID for the given codec tag tag.
997 * If no codec id is found returns CODEC_ID_NONE.
999 * @param tags list of supported codec_id-codec_tag pairs, as stored
1000 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1002 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1005 * Get the codec tag for the given codec id id.
1006 * If no codec tag is found returns 0.
1008 * @param tags list of supported codec_id-codec_tag pairs, as stored
1009 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1011 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1013 /* media file input */
1016 * Find AVInputFormat based on the short name of the input format.
1018 AVInputFormat *av_find_input_format(const char *short_name);
1021 * Guess the file format.
1023 * @param is_opened Whether the file is already opened; determines whether
1024 * demuxers with or without AVFMT_NOFILE are probed.
1026 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1029 * Guess the file format.
1031 * @param is_opened Whether the file is already opened; determines whether
1032 * demuxers with or without AVFMT_NOFILE are probed.
1033 * @param score_max A probe score larger that this is required to accept a
1034 * detection, the variable is set to the actual detection
1036 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1037 * to retry with a larger probe buffer.
1039 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1042 * Guess the file format.
1044 * @param is_opened Whether the file is already opened; determines whether
1045 * demuxers with or without AVFMT_NOFILE are probed.
1046 * @param score_ret The score of the best detection.
1048 AVInputFormat *av_probe_input_format3(AVProbeData *pd, int is_opened, int *score_ret);
1051 * Probe a bytestream to determine the input format. Each time a probe returns
1052 * with a score that is too low, the probe buffer size is increased and another
1053 * attempt is made. When the maximum probe size is reached, the input format
1054 * with the highest score is returned.
1056 * @param pb the bytestream to probe
1057 * @param fmt the input format is put here
1058 * @param filename the filename of the stream
1059 * @param logctx the log context
1060 * @param offset the offset within the bytestream to probe from
1061 * @param max_probe_size the maximum probe buffer size (zero for default)
1062 * @return 0 in case of success, a negative value corresponding to an
1063 * AVERROR code otherwise
1065 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1066 const char *filename, void *logctx,
1067 unsigned int offset, unsigned int max_probe_size);
1069 #if FF_API_FORMAT_PARAMETERS
1071 * Allocate all the structures needed to read an input stream.
1072 * This does not open the needed codecs for decoding the stream[s].
1073 * @deprecated use avformat_open_input instead.
1075 attribute_deprecated int av_open_input_stream(AVFormatContext **ic_ptr,
1076 AVIOContext *pb, const char *filename,
1077 AVInputFormat *fmt, AVFormatParameters *ap);
1080 * Open a media file as input. The codecs are not opened. Only the file
1081 * header (if present) is read.
1083 * @param ic_ptr The opened media file handle is put here.
1084 * @param filename filename to open
1085 * @param fmt If non-NULL, force the file format to use.
1086 * @param buf_size optional buffer size (zero if default is OK)
1087 * @param ap Additional parameters needed when opening the file
1088 * (NULL if default).
1089 * @return 0 if OK, AVERROR_xxx otherwise
1091 * @deprecated use avformat_open_input instead.
1093 attribute_deprecated int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1096 AVFormatParameters *ap);
1100 * Open an input stream and read the header. The codecs are not opened.
1101 * The stream must be closed with av_close_input_file().
1103 * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1104 * May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1105 * function and written into ps.
1106 * Note that a user-supplied AVFormatContext will be freed on failure.
1107 * @param filename Name of the stream to open.
1108 * @param fmt If non-NULL, this parameter forces a specific input format.
1109 * Otherwise the format is autodetected.
1110 * @param options A dictionary filled with AVFormatContext and demuxer-private options.
1111 * On return this parameter will be destroyed and replaced with a dict containing
1112 * options that were not found. May be NULL.
1114 * @return 0 on success, a negative AVERROR on failure.
1116 * @note If you want to use custom IO, preallocate the format context and set its pb field.
1118 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1120 int av_demuxer_open(AVFormatContext *ic, AVFormatParameters *ap);
1123 * Allocate an AVFormatContext.
1124 * avformat_free_context() can be used to free the context and everything
1125 * allocated by the framework within it.
1127 AVFormatContext *avformat_alloc_context(void);
1129 #if FF_API_ALLOC_OUTPUT_CONTEXT
1131 * @deprecated deprecated in favor of avformat_alloc_output_context2()
1133 attribute_deprecated
1134 AVFormatContext *avformat_alloc_output_context(const char *format,
1135 AVOutputFormat *oformat,
1136 const char *filename);
1140 * Allocate an AVFormatContext for an output format.
1141 * avformat_free_context() can be used to free the context and
1142 * everything allocated by the framework within it.
1144 * @param *ctx is set to the created format context, or to NULL in
1146 * @param oformat format to use for allocating the context, if NULL
1147 * format_name and filename are used instead
1148 * @param format_name the name of output format to use for allocating the
1149 * context, if NULL filename is used instead
1150 * @param filename the name of the filename to use for allocating the
1151 * context, may be NULL
1152 * @return >= 0 in case of success, a negative AVERROR code in case of
1155 int avformat_alloc_output_context2(AVFormatContext **ctx, AVOutputFormat *oformat,
1156 const char *format_name, const char *filename);
1159 * Read packets of a media file to get stream information. This
1160 * is useful for file formats with no headers such as MPEG. This
1161 * function also computes the real framerate in case of MPEG-2 repeat
1163 * The logical file position is not changed by this function;
1164 * examined packets may be buffered for later processing.
1166 * @param ic media file handle
1167 * @return >=0 if OK, AVERROR_xxx on error
1168 * @todo Let the user decide somehow what information is needed so that
1169 * we do not waste time getting stuff the user does not need.
1171 int av_find_stream_info(AVFormatContext *ic);
1174 * Find the "best" stream in the file.
1175 * The best stream is determined according to various heuristics as the most
1176 * likely to be what the user expects.
1177 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1178 * default decoder for the stream's codec; streams for which no decoder can
1179 * be found are ignored.
1181 * @param ic media file handle
1182 * @param type stream type: video, audio, subtitles, etc.
1183 * @param wanted_stream_nb user-requested stream number,
1184 * or -1 for automatic selection
1185 * @param related_stream try to find a stream related (eg. in the same
1186 * program) to this one, or -1 if none
1187 * @param decoder_ret if non-NULL, returns the decoder for the
1189 * @param flags flags; none are currently defined
1190 * @return the non-negative stream number in case of success,
1191 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1193 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1194 * @note If av_find_best_stream returns successfully and decoder_ret is not
1195 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1197 int av_find_best_stream(AVFormatContext *ic,
1198 enum AVMediaType type,
1199 int wanted_stream_nb,
1201 AVCodec **decoder_ret,
1205 * Read a transport packet from a media file.
1207 * This function is obsolete and should never be used.
1208 * Use av_read_frame() instead.
1210 * @param s media file handle
1211 * @param pkt is filled
1212 * @return 0 if OK, AVERROR_xxx on error
1214 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1217 * Return the next frame of a stream.
1218 * This function returns what is stored in the file, and does not validate
1219 * that what is there are valid frames for the decoder. It will split what is
1220 * stored in the file into frames and return one for each call. It will not
1221 * omit invalid data between valid frames so as to give the decoder the maximum
1222 * information possible for decoding.
1224 * The returned packet is valid
1225 * until the next av_read_frame() or until av_close_input_file() and
1226 * must be freed with av_free_packet. For video, the packet contains
1227 * exactly one frame. For audio, it contains an integer number of
1228 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1229 * data). If the audio frames have a variable size (e.g. MPEG audio),
1230 * then it contains one frame.
1232 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1233 * values in AVStream.time_base units (and guessed if the format cannot
1234 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1235 * has B-frames, so it is better to rely on pkt->dts if you do not
1236 * decompress the payload.
1238 * @return 0 if OK, < 0 on error or end of file
1240 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1243 * Seek to the keyframe at timestamp.
1244 * 'timestamp' in 'stream_index'.
1245 * @param stream_index If stream_index is (-1), a default
1246 * stream is selected, and timestamp is automatically converted
1247 * from AV_TIME_BASE units to the stream specific time_base.
1248 * @param timestamp Timestamp in AVStream.time_base units
1249 * or, if no stream is specified, in AV_TIME_BASE units.
1250 * @param flags flags which select direction and seeking mode
1251 * @return >= 0 on success
1253 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1257 * Seek to timestamp ts.
1258 * Seeking will be done so that the point from which all active streams
1259 * can be presented successfully will be closest to ts and within min/max_ts.
1260 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1262 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1263 * are the file position (this may not be supported by all demuxers).
1264 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1265 * in the stream with stream_index (this may not be supported by all demuxers).
1266 * Otherwise all timestamps are in units of the stream selected by stream_index
1267 * or if stream_index is -1, in AV_TIME_BASE units.
1268 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1269 * keyframes (this may not be supported by all demuxers).
1271 * @param stream_index index of the stream which is used as time base reference
1272 * @param min_ts smallest acceptable timestamp
1273 * @param ts target timestamp
1274 * @param max_ts largest acceptable timestamp
1275 * @param flags flags
1276 * @return >=0 on success, error code otherwise
1278 * @note This is part of the new seek API which is still under construction.
1279 * Thus do not use this yet. It may change at any time, do not expect
1280 * ABI compatibility yet!
1282 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1285 * Start playing a network-based stream (e.g. RTSP stream) at the
1288 int av_read_play(AVFormatContext *s);
1291 * Pause a network-based stream (e.g. RTSP stream).
1293 * Use av_read_play() to resume it.
1295 int av_read_pause(AVFormatContext *s);
1298 * Free a AVFormatContext allocated by av_open_input_stream.
1299 * @param s context to free
1301 void av_close_input_stream(AVFormatContext *s);
1304 * Close a media file (but not its codecs).
1306 * @param s media file handle
1308 void av_close_input_file(AVFormatContext *s);
1311 * Free an AVFormatContext and all its streams.
1312 * @param s context to free
1314 void avformat_free_context(AVFormatContext *s);
1317 * Add a new stream to a media file.
1319 * Can only be called in the read_header() function. If the flag
1320 * AVFMTCTX_NOHEADER is in the format context, then new streams
1321 * can be added in read_packet too.
1323 * @param s media file handle
1324 * @param id file-format-dependent stream ID
1326 AVStream *av_new_stream(AVFormatContext *s, int id);
1327 AVProgram *av_new_program(AVFormatContext *s, int id);
1330 * Set the pts for a given stream. If the new values would be invalid
1331 * (<= 0), it leaves the AVStream unchanged.
1334 * @param pts_wrap_bits number of bits effectively used by the pts
1335 * (used for wrap control, 33 is the value for MPEG)
1336 * @param pts_num numerator to convert to seconds (MPEG: 1)
1337 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1339 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1340 unsigned int pts_num, unsigned int pts_den);
1342 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1343 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
1344 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
1345 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
1347 int av_find_default_stream_index(AVFormatContext *s);
1350 * Get the index for a specific timestamp.
1351 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1352 * to the timestamp which is <= the requested one, if backward
1353 * is 0, then it will be >=
1354 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1355 * @return < 0 if no such timestamp could be found
1357 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1360 * Add an index entry into a sorted list. Update the entry if the list
1361 * already contains it.
1363 * @param timestamp timestamp in the time base of the given stream
1365 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1366 int size, int distance, int flags);
1369 * Perform a binary search using av_index_search_timestamp() and
1370 * AVInputFormat.read_timestamp().
1371 * This is not supposed to be called directly by a user application,
1373 * @param target_ts target timestamp in the time base of the given stream
1374 * @param stream_index stream number
1376 int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1377 int64_t target_ts, int flags);
1380 * Update cur_dts of all streams based on the given timestamp and AVStream.
1382 * Stream ref_st unchanged, others set cur_dts in their native time base.
1383 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1384 * @param timestamp new dts expressed in time_base of param ref_st
1385 * @param ref_st reference stream giving time_base of param timestamp
1387 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1390 * Perform a binary search using read_timestamp().
1391 * This is not supposed to be called directly by a user application,
1393 * @param target_ts target timestamp in the time base of the given stream
1394 * @param stream_index stream number
1396 int64_t av_gen_search(AVFormatContext *s, int stream_index,
1397 int64_t target_ts, int64_t pos_min,
1398 int64_t pos_max, int64_t pos_limit,
1399 int64_t ts_min, int64_t ts_max,
1400 int flags, int64_t *ts_ret,
1401 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1406 #if FF_API_FORMAT_PARAMETERS
1408 * @deprecated pass the options to avformat_write_header directly.
1410 attribute_deprecated int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1414 * Split a URL string into components.
1416 * The pointers to buffers for storing individual components may be null,
1417 * in order to ignore that component. Buffers for components not found are
1418 * set to empty strings. If the port is not found, it is set to a negative
1421 * @param proto the buffer for the protocol
1422 * @param proto_size the size of the proto buffer
1423 * @param authorization the buffer for the authorization
1424 * @param authorization_size the size of the authorization buffer
1425 * @param hostname the buffer for the host name
1426 * @param hostname_size the size of the hostname buffer
1427 * @param port_ptr a pointer to store the port number in
1428 * @param path the buffer for the path
1429 * @param path_size the size of the path buffer
1430 * @param url the URL to split
1432 void av_url_split(char *proto, int proto_size,
1433 char *authorization, int authorization_size,
1434 char *hostname, int hostname_size,
1436 char *path, int path_size,
1440 * Allocate the stream private data and write the stream header to
1441 * an output media file.
1443 * @param s Media file handle, must be allocated with avformat_alloc_context().
1444 * Its oformat field must be set to the desired output format;
1445 * Its pb field must be set to an already openened AVIOContext.
1446 * @param options An AVDictionary filled with AVFormatContext and muxer-private options.
1447 * On return this parameter will be destroyed and replaced with a dict containing
1448 * options that were not found. May be NULL.
1450 * @return 0 on success, negative AVERROR on failure.
1452 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1454 int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1456 #if FF_API_FORMAT_PARAMETERS
1458 * Allocate the stream private data and write the stream header to an
1459 * output media file.
1460 * @note: this sets stream time-bases, if possible to stream->codec->time_base
1461 * but for some formats it might also be some other time base
1463 * @param s media file handle
1464 * @return 0 if OK, AVERROR_xxx on error
1466 * @deprecated use avformat_write_header.
1468 attribute_deprecated int av_write_header(AVFormatContext *s);
1472 * Write a packet to an output media file.
1474 * The packet shall contain one audio or video frame.
1475 * The packet must be correctly interleaved according to the container
1476 * specification, if not then av_interleaved_write_frame must be used.
1478 * @param s media file handle
1479 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1481 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1483 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1486 * Write a packet to an output media file ensuring correct interleaving.
1488 * The packet must contain one audio or video frame.
1489 * If the packets are already correctly interleaved, the application should
1490 * call av_write_frame() instead as it is slightly faster. It is also important
1491 * to keep in mind that completely non-interleaved input will need huge amounts
1492 * of memory to interleave with this, so it is preferable to interleave at the
1495 * @param s media file handle
1496 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1498 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1500 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1503 * Interleave a packet per dts in an output media file.
1505 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1506 * function, so they cannot be used after it. Note that calling av_free_packet()
1507 * on them is still safe.
1509 * @param s media file handle
1510 * @param out the interleaved packet will be output here
1511 * @param pkt the input packet
1512 * @param flush 1 if no further packets are available as input and all
1513 * remaining packets should be output
1514 * @return 1 if a packet was output, 0 if no packet could be output,
1515 * < 0 if an error occurred
1517 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1518 AVPacket *pkt, int flush);
1521 * Write the stream trailer to an output media file and free the
1522 * file private data.
1524 * May only be called after a successful call to av_write_header.
1526 * @param s media file handle
1527 * @return 0 if OK, AVERROR_xxx on error
1529 int av_write_trailer(AVFormatContext *s);
1532 * Get timing information for the data currently output.
1533 * The exact meaning of "currently output" depends on the format.
1534 * It is mostly relevant for devices that have an internal buffer and/or
1535 * work in real time.
1536 * @param s media file handle
1537 * @param stream stream in the media file
1538 * @param dts[out] DTS of the last packet output for the stream, in stream
1540 * @param wall[out] absolute time when that packet whas output,
1542 * @return 0 if OK, AVERROR(ENOSYS) if the format does not support it
1543 * Note: some formats or devices may not allow to measure dts and wall
1546 int av_get_output_timestamp(struct AVFormatContext *s, int stream,
1547 int64_t *dts, int64_t *wall);
1549 #if FF_API_DUMP_FORMAT
1551 * @deprecated Deprecated in favor of av_dump_format().
1553 attribute_deprecated void dump_format(AVFormatContext *ic,
1559 void av_dump_format(AVFormatContext *ic,
1564 #if FF_API_PARSE_DATE
1566 * Parse datestr and return a corresponding number of microseconds.
1568 * @param datestr String representing a date or a duration.
1569 * See av_parse_time() for the syntax of the provided string.
1570 * @deprecated in favor of av_parse_time()
1572 attribute_deprecated
1573 int64_t parse_date(const char *datestr, int duration);
1577 * Get the current time in microseconds.
1579 int64_t av_gettime(void);
1581 #if FF_API_FIND_INFO_TAG
1583 * @deprecated use av_find_info_tag in libavutil instead.
1585 attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1589 * Return in 'buf' the path with '%d' replaced by a number.
1591 * Also handles the '%0nd' format where 'n' is the total number
1592 * of digits and '%%'.
1594 * @param buf destination buffer
1595 * @param buf_size destination buffer size
1596 * @param path numbered sequence string
1597 * @param number frame number
1598 * @return 0 if OK, -1 on format error
1600 int av_get_frame_filename(char *buf, int buf_size,
1601 const char *path, int number);
1604 * Check whether filename actually is a numbered sequence generator.
1606 * @param filename possible numbered sequence string
1607 * @return 1 if a valid numbered sequence string, 0 otherwise
1609 int av_filename_number_test(const char *filename);
1612 * Generate an SDP for an RTP session.
1614 * @param ac array of AVFormatContexts describing the RTP streams. If the
1615 * array is composed by only one context, such context can contain
1616 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1617 * all the contexts in the array (an AVCodecContext per RTP stream)
1618 * must contain only one AVStream.
1619 * @param n_files number of AVCodecContexts contained in ac
1620 * @param buf buffer where the SDP will be stored (must be allocated by
1622 * @param size the size of the buffer
1623 * @return 0 if OK, AVERROR_xxx on error
1625 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1627 #if FF_API_SDP_CREATE
1628 attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1632 * Return a positive value if the given filename has one of the given
1633 * extensions, 0 otherwise.
1635 * @param extensions a comma-separated list of filename extensions
1637 int av_match_ext(const char *filename, const char *extensions);
1639 #endif /* AVFORMAT_AVFORMAT_H */