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 * Public Metadata API.
53 * The metadata API allows libavformat to export metadata tags to a client
54 * application using a sequence of key/value pairs. Like all strings in FFmpeg,
55 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
56 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
57 * Important concepts to keep in mind:
58 * 1. Keys are unique; there can never be 2 tags with the same key. This is
59 * also meant semantically, i.e., a demuxer should not knowingly produce
60 * several keys that are literally different but semantically identical.
61 * E.g., key=Author5, key=Author6. In this example, all authors must be
62 * placed in the same tag.
63 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
64 * want to store, e.g., the email address of the child of producer Alice
65 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
66 * 3. Several modifiers can be applied to the tag name. This is done by
67 * appending a dash character ('-') and the modifier name in the order
68 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
69 * a) language -- a tag whose value is localized for a particular language
70 * is appended with the ISO 639-2/B 3-letter language code.
71 * For example: Author-ger=Michael, Author-eng=Mike
72 * The original/default language is in the unqualified "Author" tag.
73 * A demuxer should set a default if it sets any translated tag.
74 * b) sorting -- a modified version of a tag that should be used for
75 * sorting will have '-sort' appended. E.g. artist="The Beatles",
76 * artist-sort="Beatles, The".
78 * 4. Demuxers attempt to export metadata in a generic format, however tags
79 * with no generic equivalents are left as they are stored in the container.
80 * Follows a list of generic tag names:
82 * album -- name of the set this work belongs to
83 * album_artist -- main creator of the set/album, if different from artist.
84 * e.g. "Various Artists" for compilation albums.
85 * artist -- main creator of the work
86 * comment -- any additional description of the file.
87 * composer -- who composed the work, if different from artist.
88 * copyright -- name of copyright holder.
89 * creation_time-- date when the file was created, preferably in ISO 8601.
90 * date -- date when the work was created, preferably in ISO 8601.
91 * disc -- number of a subset, e.g. disc in a multi-disc collection.
92 * encoder -- name/settings of the software/hardware that produced the file.
93 * encoded_by -- person/group who created the file.
94 * filename -- original name of the file.
95 * genre -- <self-evident>.
96 * language -- main language in which the work is performed, preferably
97 * in ISO 639-2 format. Multiple languages can be specified by
98 * separating them with commas.
99 * performer -- artist who performed the work, if different from artist.
100 * E.g for "Also sprach Zarathustra", artist would be "Richard
101 * Strauss" and performer "London Philharmonic Orchestra".
102 * publisher -- name of the label/publisher.
103 * service_name -- name of the service in broadcasting (channel name).
104 * service_provider -- name of the service provider in broadcasting.
105 * title -- name of the work.
106 * track -- number of this work in the set, can be in form current/total.
107 * variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
110 #if FF_API_OLD_METADATA2
112 * @defgroup old_metadata Old metadata API
113 * The following functions are deprecated, use
114 * their equivalents from libavutil/dict.h instead.
118 #define AV_METADATA_MATCH_CASE AV_DICT_MATCH_CASE
119 #define AV_METADATA_IGNORE_SUFFIX AV_DICT_IGNORE_SUFFIX
120 #define AV_METADATA_DONT_STRDUP_KEY AV_DICT_DONT_STRDUP_KEY
121 #define AV_METADATA_DONT_STRDUP_VAL AV_DICT_DONT_STRDUP_VAL
122 #define AV_METADATA_DONT_OVERWRITE AV_DICT_DONT_OVERWRITE
124 typedef attribute_deprecated AVDictionary AVMetadata;
125 typedef attribute_deprecated AVDictionaryEntry AVMetadataTag;
127 typedef struct AVMetadataConv AVMetadataConv;
130 * Get a metadata element with matching key.
132 * @param prev Set to the previous matching element to find the next.
133 * If set to NULL the first matching element is returned.
134 * @param flags Allows case as well as suffix-insensitive comparisons.
135 * @return Found tag or NULL, changing key or value leads to undefined behavior.
137 attribute_deprecated AVDictionaryEntry *
138 av_metadata_get(AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags);
141 * Set the given tag in *pm, overwriting an existing tag.
143 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
144 * a metadata struct is allocated and put in *pm.
145 * @param key tag key to add to *pm (will be av_strduped depending on flags)
146 * @param value tag value to add to *pm (will be av_strduped depending on flags).
147 * Passing a NULL value will cause an existing tag to be deleted.
148 * @return >= 0 on success otherwise an error code <0
150 attribute_deprecated int av_metadata_set2(AVDictionary **pm, const char *key, const char *value, int flags);
153 * This function is provided for compatibility reason and currently does nothing.
155 attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
156 const AVMetadataConv *s_conv);
159 * Copy metadata from one AVDictionary struct into another.
160 * @param dst pointer to a pointer to a AVDictionary struct. If *dst is NULL,
161 * this function will allocate a struct for you and put it in *dst
162 * @param src pointer to source AVDictionary struct
163 * @param flags flags to use when setting metadata in *dst
164 * @note metadata is read using the AV_DICT_IGNORE_SUFFIX flag
166 attribute_deprecated void av_metadata_copy(AVDictionary **dst, AVDictionary *src, int flags);
169 * Free all the memory allocated for an AVDictionary struct.
171 attribute_deprecated void av_metadata_free(AVDictionary **m);
178 /* packet functions */
182 * Allocate and read the payload of a packet and initialize its
183 * fields with default values.
186 * @param size desired payload size
187 * @return >0 (read size) if OK, AVERROR_xxx otherwise
189 int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
193 * Read data and append it to the current content of the AVPacket.
194 * If pkt->size is 0 this is identical to av_get_packet.
195 * Note that this uses av_grow_packet and thus involves a realloc
196 * which is inefficient. Thus this function should only be used
197 * when there is no reasonable way to know (an upper bound of)
201 * @param size amount of data to read
202 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
203 * will not be lost even if an error occurs.
205 int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
207 /*************************************************/
208 /* fractional numbers for exact pts handling */
211 * The exact value of the fractional number is: 'val + num / den'.
212 * num is assumed to be 0 <= num < den.
214 typedef struct AVFrac {
215 int64_t val, num, den;
218 /*************************************************/
219 /* input/output formats */
224 * This structure contains the data a format has to probe a file.
226 typedef struct AVProbeData {
227 const char *filename;
228 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
229 int buf_size; /**< Size of buf except extra allocated bytes */
232 #define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
233 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
235 typedef struct AVFormatParameters {
236 #if FF_API_FORMAT_PARAMETERS
237 attribute_deprecated AVRational time_base;
238 attribute_deprecated int sample_rate;
239 attribute_deprecated int channels;
240 attribute_deprecated int width;
241 attribute_deprecated int height;
242 attribute_deprecated enum PixelFormat pix_fmt;
243 attribute_deprecated int channel; /**< Used to select DV channel. */
244 attribute_deprecated const char *standard; /**< deprecated, use demuxer-specific options instead. */
245 attribute_deprecated unsigned int mpeg2ts_raw:1; /**< deprecated, use mpegtsraw demuxer */
246 /**< deprecated, use mpegtsraw demuxer-specific options instead */
247 attribute_deprecated unsigned int mpeg2ts_compute_pcr:1;
248 attribute_deprecated unsigned int initial_pause:1; /**< Do not begin to play the stream
249 immediately (RTSP only). */
250 attribute_deprecated unsigned int prealloced_context:1;
252 } AVFormatParameters;
254 //! Demuxer will use avio_open, no opened file should be provided by the caller.
255 #define AVFMT_NOFILE 0x0001
256 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
257 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
258 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
260 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
261 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
262 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
263 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
264 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
265 #define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
266 #define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */
267 #define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fallback to binary search via read_timestamp */
268 #define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fallback to generic search */
269 #define AVFMT_TS_NONSTRICT 0x8000 /**< Format does not require strictly
270 increasing timestamps, but they must
271 still be monotonic */
273 typedef struct AVOutputFormat {
276 * Descriptive name for the format, meant to be more human-readable
277 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
280 const char *long_name;
281 const char *mime_type;
282 const char *extensions; /**< comma-separated filename extensions */
284 * size of private data so that it can be allocated in the wrapper
288 enum CodecID audio_codec; /**< default audio codec */
289 enum CodecID video_codec; /**< default video codec */
290 int (*write_header)(struct AVFormatContext *);
291 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
292 int (*write_trailer)(struct AVFormatContext *);
294 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
295 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
296 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS
302 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
303 AVPacket *in, int flush);
306 * List of supported codec_id-codec_tag pairs, ordered by "better
307 * choice first". The arrays are all terminated by CODEC_ID_NONE.
309 const struct AVCodecTag * const *codec_tag;
311 enum CodecID subtitle_codec; /**< default subtitle codec */
313 #if FF_API_OLD_METADATA2
314 const AVMetadataConv *metadata_conv;
317 const AVClass *priv_class; ///< AVClass for the private context
320 struct AVOutputFormat *next;
323 typedef struct AVInputFormat {
325 * A comma separated list of short names for the format. New names
326 * may be appended with a minor bump.
331 * Descriptive name for the format, meant to be more human-readable
332 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
335 const char *long_name;
338 * Size of private data so that it can be allocated in the wrapper.
343 * Tell if a given file has a chance of being parsed as this format.
344 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
345 * big so you do not have to check for that unless you need more.
347 int (*read_probe)(AVProbeData *);
350 * Read the format header and initialize the AVFormatContext
351 * structure. Return 0 if OK. 'ap' if non-NULL contains
352 * additional parameters. Only used in raw format right
353 * now. 'av_new_stream' should be called to create new streams.
355 int (*read_header)(struct AVFormatContext *,
356 AVFormatParameters *ap);
359 * Read one packet and put it in 'pkt'. pts and flags are also
360 * set. 'av_new_stream' can be called only if the flag
361 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
362 * background thread).
363 * @return 0 on success, < 0 on error.
364 * When returning an error, pkt must not have been allocated
365 * or must be freed before returning
367 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
370 * Close the stream. The AVFormatContext and AVStreams are not
371 * freed by this function
373 int (*read_close)(struct AVFormatContext *);
377 * Seek to a given timestamp relative to the frames in
378 * stream component stream_index.
379 * @param stream_index Must not be -1.
380 * @param flags Selects which direction should be preferred if no exact
381 * match is available.
382 * @return >= 0 on success (but not necessarily the new offset)
384 attribute_deprecated int (*read_seek)(struct AVFormatContext *,
385 int stream_index, int64_t timestamp, int flags);
388 * Gets the next timestamp in stream[stream_index].time_base units.
389 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
391 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
392 int64_t *pos, int64_t pos_limit);
395 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
400 * If extensions are defined, then no probe is done. You should
401 * usually not use extension format guessing because it is not
404 const char *extensions;
407 * General purpose read-only value that the format can use.
412 * Start/resume playing - only meaningful if using a network-based format
415 int (*read_play)(struct AVFormatContext *);
418 * Pause playing - only meaningful if using a network-based format
421 int (*read_pause)(struct AVFormatContext *);
423 const struct AVCodecTag * const *codec_tag;
426 * Seek to timestamp ts.
427 * Seeking will be done so that the point from which all active streams
428 * can be presented successfully will be closest to ts and within min/max_ts.
429 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
431 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
433 #if FF_API_OLD_METADATA2
434 const AVMetadataConv *metadata_conv;
437 const AVClass *priv_class; ///< AVClass for the private context
440 struct AVInputFormat *next;
443 enum AVStreamParseType {
445 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
446 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
447 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
448 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
451 typedef struct AVIndexEntry {
454 #define AVINDEX_KEYFRAME 0x0001
456 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).
457 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
460 #define AV_DISPOSITION_DEFAULT 0x0001
461 #define AV_DISPOSITION_DUB 0x0002
462 #define AV_DISPOSITION_ORIGINAL 0x0004
463 #define AV_DISPOSITION_COMMENT 0x0008
464 #define AV_DISPOSITION_LYRICS 0x0010
465 #define AV_DISPOSITION_KARAOKE 0x0020
468 * Track should be used during playback by default.
469 * Useful for subtitle track that should be displayed
470 * even when user did not explicitly ask for subtitles.
472 #define AV_DISPOSITION_FORCED 0x0040
473 #define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */
474 #define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */
475 #define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */
479 * New fields can be added to the end with minor version bumps.
480 * Removal, reordering and changes to existing fields require a major
482 * sizeof(AVStream) must not be used outside libav*.
484 typedef struct AVStream {
485 int index; /**< stream index in AVFormatContext */
486 int id; /**< format-specific stream ID */
487 AVCodecContext *codec; /**< codec context */
489 * Real base framerate of the stream.
490 * This is the lowest framerate with which all timestamps can be
491 * represented accurately (it is the least common multiple of all
492 * framerates in the stream). Note, this value is just a guess!
493 * For example, if the time base is 1/90000 and all frames have either
494 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
496 AVRational r_frame_rate;
499 /* internal data used in av_find_stream_info() */
503 * encoding: pts generation when outputting stream
508 * This is the fundamental unit of time (in seconds) in terms
509 * of which frame timestamps are represented. For fixed-fps content,
510 * time base should be 1/framerate and timestamp increments should be 1.
511 * decoding: set by libavformat
512 * encoding: set by libavformat in av_write_header
514 AVRational time_base;
515 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
516 /* ffmpeg.c private use */
517 int stream_copy; /**< If set, just copy stream. */
518 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
520 //FIXME move stuff to a flags field?
522 * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
523 * MN: dunno if that is the right place for it
528 * Decoding: pts of the first frame of the stream, in stream time base.
529 * Only set this if you are absolutely 100% sure that the value you set
530 * it to really is the pts of the first frame.
531 * This may be undefined (AV_NOPTS_VALUE).
532 * @note The ASF header does NOT contain a correct start_time the ASF
533 * demuxer must NOT set this.
538 * Decoding: duration of the stream, in stream time base.
539 * If a source file does not specify a duration, but does specify
540 * a bitrate, this value will be estimated from bitrate and file size.
544 /* av_read_frame() support */
545 enum AVStreamParseType need_parsing;
546 struct AVCodecParserContext *parser;
549 int last_IP_duration;
551 /* av_seek_frame() support */
552 AVIndexEntry *index_entries; /**< Only used if the format does not
553 support seeking natively. */
554 int nb_index_entries;
555 unsigned int index_entries_allocated_size;
557 int64_t nb_frames; ///< number of frames in this stream if known or 0
559 int disposition; /**< AV_DISPOSITION_* bit field */
561 AVProbeData probe_data;
562 #define MAX_REORDER_DELAY 16
563 int64_t pts_buffer[MAX_REORDER_DELAY+1];
566 * sample aspect ratio (0 if unknown)
567 * - encoding: Set by user.
568 * - decoding: Set by libavformat.
570 AVRational sample_aspect_ratio;
572 AVDictionary *metadata;
574 /* Intended mostly for av_read_frame() support. Not supposed to be used by */
575 /* external applications; try to use something else if at all possible. */
576 const uint8_t *cur_ptr;
580 // Timestamp generation support:
582 * Timestamp corresponding to the last dts sync point.
584 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
585 * a DTS is received from the underlying container. Otherwise set to
586 * AV_NOPTS_VALUE by default.
588 int64_t reference_dts;
591 * Number of packets to buffer for codec probing
592 * NOT PART OF PUBLIC API
594 #define MAX_PROBE_PACKETS 2500
598 * last packet in packet_buffer for this stream when muxing.
599 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
601 struct AVPacketList *last_in_packet_buffer;
606 AVRational avg_frame_rate;
609 * Number of frames that have been demuxed during av_find_stream_info()
611 int codec_info_nb_frames;
615 * This is the MPEG-TS stream identifier +1
618 int stream_identifier;
621 * Stream informations used internally by av_find_stream_info()
623 #define MAX_STD_TIMEBASES (60*12+5)
626 int64_t duration_gcd;
628 double duration_error[MAX_STD_TIMEBASES];
629 int64_t codec_info_duration;
633 * flag to indicate that probing is requested
634 * NOT PART OF PUBLIC API
639 #define AV_PROGRAM_RUNNING 1
642 * New fields can be added to the end with minor version bumps.
643 * Removal, reordering and changes to existing fields require a major
645 * sizeof(AVProgram) must not be used outside libav*.
647 typedef struct AVProgram {
650 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
651 unsigned int *stream_index;
652 unsigned int nb_stream_indexes;
653 AVDictionary *metadata;
660 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
661 (streams are added dynamically) */
663 typedef struct AVChapter {
664 int id; ///< unique ID to identify the chapter
665 AVRational time_base; ///< time base in which the start/end timestamps are specified
666 int64_t start, end; ///< chapter start/end time in time_base units
667 AVDictionary *metadata;
671 * Format I/O context.
672 * New fields can be added to the end with minor version bumps.
673 * Removal, reordering and changes to existing fields require a major
675 * sizeof(AVFormatContext) must not be used outside libav*.
677 typedef struct AVFormatContext {
678 const AVClass *av_class; /**< Set by avformat_alloc_context. */
679 /* Can only be iformat or oformat, not both at the same time. */
680 struct AVInputFormat *iformat;
681 struct AVOutputFormat *oformat;
684 unsigned int nb_streams;
686 char filename[1024]; /**< input or output filename */
690 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
691 /* private data for pts handling (do not modify directly). */
693 * This buffer is only needed when packets were already buffered but
694 * not decoded, for example to get the codec parameters in MPEG
697 struct AVPacketList *packet_buffer;
700 * Decoding: position of the first frame of the component, in
701 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
702 * It is deduced from the AVStream values.
707 * Decoding: duration of the stream, in AV_TIME_BASE fractional
708 * seconds. Only set this value if you know none of the individual stream
709 * durations and also dont set any of them. This is deduced from the
710 * AVStream values if not set.
715 * decoding: total file size, 0 if unknown
720 * Decoding: total stream bitrate in bit/s, 0 if not
721 * available. Never set it directly if the file_size and the
722 * duration are known as FFmpeg can compute it automatically.
726 /* av_read_frame() support */
729 /* av_seek_frame() support */
730 int64_t data_offset; /**< offset of the first packet */
733 unsigned int packet_size;
737 #define AVFMT_NOOUTPUTLOOP -1
738 #define AVFMT_INFINITEOUTPUTLOOP 0
740 * number of times to loop output in formats that support it
745 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
746 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
747 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
748 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
749 #define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
750 #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
751 #if FF_API_FLAG_RTP_HINT
752 #define AVFMT_FLAG_RTP_HINT 0x0040 ///< Deprecated, use the -movflags rtphint muxer specific AVOption instead
754 #define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
755 #define AVFMT_FLAG_MP4A_LATM 0x8000 ///< Enable RTP MP4A-LATM payload
756 #define AVFMT_FLAG_SORT_DTS 0x10000 ///< try to interleave outputted packets by dts (using this flag can slow demuxing down)
757 #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)
758 #define AVFMT_FLAG_KEEP_SIDE_DATA 0x40000 ///< Dont merge side data but keep it seperate.
763 * decoding: size of data to probe; encoding: unused.
765 unsigned int probesize;
768 * Maximum time (in AV_TIME_BASE units) during which the input should
769 * be analyzed in av_find_stream_info().
771 int max_analyze_duration;
776 unsigned int nb_programs;
777 AVProgram **programs;
780 * Forced video codec_id.
781 * Demuxing: Set by user.
783 enum CodecID video_codec_id;
786 * Forced audio codec_id.
787 * Demuxing: Set by user.
789 enum CodecID audio_codec_id;
792 * Forced subtitle codec_id.
793 * Demuxing: Set by user.
795 enum CodecID subtitle_codec_id;
798 * Maximum amount of memory in bytes to use for the index of each stream.
799 * If the index exceeds this size, entries will be discarded as
800 * needed to maintain a smaller size. This can lead to slower or less
801 * accurate seeking (depends on demuxer).
802 * Demuxers for which a full in-memory index is mandatory will ignore
805 * demuxing: set by user
807 unsigned int max_index_size;
810 * Maximum amount of memory in bytes to use for buffering frames
811 * obtained from realtime capture devices.
813 unsigned int max_picture_buffer;
815 unsigned int nb_chapters;
816 AVChapter **chapters;
819 * Flags to enable debugging.
822 #define FF_FDEBUG_TS 0x0001
825 * Raw packets from the demuxer, prior to parsing and decoding.
826 * This buffer is used for buffering packets until the codec can
827 * be identified, as parsing cannot be done without knowing the
830 struct AVPacketList *raw_packet_buffer;
831 struct AVPacketList *raw_packet_buffer_end;
833 struct AVPacketList *packet_buffer_end;
835 AVDictionary *metadata;
838 * Remaining size available for raw_packet_buffer, in bytes.
839 * NOT PART OF PUBLIC API
841 #define RAW_PACKET_BUFFER_SIZE 2500000
842 int raw_packet_buffer_remaining_size;
845 * Start time of the stream in real world time, in microseconds
846 * since the unix epoch (00:00 1st January 1970). That is, pts=0
847 * in the stream was captured at this real world time.
848 * - encoding: Set by user.
849 * - decoding: Unused.
851 int64_t start_time_realtime;
854 * decoding: number of frames used to probe fps
859 * Transport stream id.
860 * This will be moved into demuxer private options. Thus no API/ABI compatibility
865 typedef struct AVPacketList {
867 struct AVPacketList *next;
871 * If f is NULL, returns the first registered input format,
872 * if f is non-NULL, returns the next registered input format after f
873 * or NULL if f is the last one.
875 AVInputFormat *av_iformat_next(AVInputFormat *f);
878 * If f is NULL, returns the first registered output format,
879 * if f is non-NULL, returns the next registered output format after f
880 * or NULL if f is the last one.
882 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
884 #if FF_API_GUESS_IMG2_CODEC
885 attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
888 /* XXX: Use automatic init with either ELF sections or C file parser */
892 void av_register_input_format(AVInputFormat *format);
893 void av_register_output_format(AVOutputFormat *format);
896 * Return the output format in the list of registered output formats
897 * which best matches the provided parameters, or return NULL if
900 * @param short_name if non-NULL checks if short_name matches with the
901 * names of the registered formats
902 * @param filename if non-NULL checks if filename terminates with the
903 * extensions of the registered formats
904 * @param mime_type if non-NULL checks if mime_type matches with the
905 * MIME type of the registered formats
907 AVOutputFormat *av_guess_format(const char *short_name,
908 const char *filename,
909 const char *mime_type);
912 * Guess the codec ID based upon muxer and filename.
914 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
915 const char *filename, const char *mime_type,
916 enum AVMediaType type);
919 * Send a nice hexadecimal dump of a buffer to the specified file stream.
921 * @param f The file stream pointer where the dump should be sent to.
923 * @param size buffer size
925 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
927 void av_hex_dump(FILE *f, uint8_t *buf, int size);
930 * Send a nice hexadecimal dump of a buffer to the log.
932 * @param avcl A pointer to an arbitrary struct of which the first field is a
933 * pointer to an AVClass struct.
934 * @param level The importance level of the message, lower values signifying
937 * @param size buffer size
939 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
941 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
944 * Send a nice dump of a packet to the specified file stream.
946 * @param f The file stream pointer where the dump should be sent to.
947 * @param pkt packet to dump
948 * @param dump_payload True if the payload must be displayed, too.
949 * @param st AVStream that the packet belongs to
951 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
955 * Send a nice dump of a packet to the log.
957 * @param avcl A pointer to an arbitrary struct of which the first field is a
958 * pointer to an AVClass struct.
959 * @param level The importance level of the message, lower values signifying
961 * @param pkt packet to dump
962 * @param dump_payload True if the payload must be displayed, too.
963 * @param st AVStream that the packet belongs to
965 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
969 attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
970 attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
975 * Initialize libavformat and register all the muxers, demuxers and
976 * protocols. If you do not call this function, then you can select
977 * exactly which formats you want to support.
979 * @see av_register_input_format()
980 * @see av_register_output_format()
981 * @see av_register_protocol()
983 void av_register_all(void);
986 * Get the CodecID for the given codec tag tag.
987 * If no codec id is found returns CODEC_ID_NONE.
989 * @param tags list of supported codec_id-codec_tag pairs, as stored
990 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
992 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
995 * Get the codec tag for the given codec id id.
996 * If no codec tag is found returns 0.
998 * @param tags list of supported codec_id-codec_tag pairs, as stored
999 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1001 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1003 /* media file input */
1006 * Find AVInputFormat based on the short name of the input format.
1008 AVInputFormat *av_find_input_format(const char *short_name);
1011 * Guess the file format.
1013 * @param is_opened Whether the file is already opened; determines whether
1014 * demuxers with or without AVFMT_NOFILE are probed.
1016 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1019 * Guess the file format.
1021 * @param is_opened Whether the file is already opened; determines whether
1022 * demuxers with or without AVFMT_NOFILE are probed.
1023 * @param score_max A probe score larger that this is required to accept a
1024 * detection, the variable is set to the actual detection
1026 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1027 * to retry with a larger probe buffer.
1029 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1032 * Guess the file format.
1034 * @param is_opened Whether the file is already opened; determines whether
1035 * demuxers with or without AVFMT_NOFILE are probed.
1036 * @param score_ret The score of the best detection.
1038 AVInputFormat *av_probe_input_format3(AVProbeData *pd, int is_opened, int *score_ret);
1041 * Probe a bytestream to determine the input format. Each time a probe returns
1042 * with a score that is too low, the probe buffer size is increased and another
1043 * attempt is made. When the maximum probe size is reached, the input format
1044 * with the highest score is returned.
1046 * @param pb the bytestream to probe
1047 * @param fmt the input format is put here
1048 * @param filename the filename of the stream
1049 * @param logctx the log context
1050 * @param offset the offset within the bytestream to probe from
1051 * @param max_probe_size the maximum probe buffer size (zero for default)
1052 * @return 0 in case of success, a negative value corresponding to an
1053 * AVERROR code otherwise
1055 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1056 const char *filename, void *logctx,
1057 unsigned int offset, unsigned int max_probe_size);
1059 #if FF_API_FORMAT_PARAMETERS
1061 * Allocate all the structures needed to read an input stream.
1062 * This does not open the needed codecs for decoding the stream[s].
1063 * @deprecated use avformat_open_input instead.
1065 attribute_deprecated int av_open_input_stream(AVFormatContext **ic_ptr,
1066 AVIOContext *pb, const char *filename,
1067 AVInputFormat *fmt, AVFormatParameters *ap);
1070 * Open a media file as input. The codecs are not opened. Only the file
1071 * header (if present) is read.
1073 * @param ic_ptr The opened media file handle is put here.
1074 * @param filename filename to open
1075 * @param fmt If non-NULL, force the file format to use.
1076 * @param buf_size optional buffer size (zero if default is OK)
1077 * @param ap Additional parameters needed when opening the file
1078 * (NULL if default).
1079 * @return 0 if OK, AVERROR_xxx otherwise
1081 * @deprecated use avformat_open_input instead.
1083 attribute_deprecated int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1086 AVFormatParameters *ap);
1090 * Open an input stream and read the header. The codecs are not opened.
1091 * The stream must be closed with av_close_input_file().
1093 * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1094 * May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1095 * function and written into ps.
1096 * Note that a user-supplied AVFormatContext will be freed on failure.
1097 * @param filename Name of the stream to open.
1098 * @param fmt If non-NULL, this parameter forces a specific input format.
1099 * Otherwise the format is autodetected.
1100 * @param options A dictionary filled with AVFormatContext and demuxer-private options.
1101 * On return this parameter will be destroyed and replaced with a dict containing
1102 * options that were not found. May be NULL.
1104 * @return 0 on success, a negative AVERROR on failure.
1106 * @note If you want to use custom IO, preallocate the format context and set its pb field.
1108 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1110 int av_demuxer_open(AVFormatContext *ic, AVFormatParameters *ap);
1113 * Allocate an AVFormatContext.
1114 * avformat_free_context() can be used to free the context and everything
1115 * allocated by the framework within it.
1117 AVFormatContext *avformat_alloc_context(void);
1119 #if FF_API_ALLOC_OUTPUT_CONTEXT
1121 * @deprecated deprecated in favor of avformat_alloc_output_context2()
1123 attribute_deprecated
1124 AVFormatContext *avformat_alloc_output_context(const char *format,
1125 AVOutputFormat *oformat,
1126 const char *filename);
1130 * Allocate an AVFormatContext for an output format.
1131 * avformat_free_context() can be used to free the context and
1132 * everything allocated by the framework within it.
1134 * @param *ctx is set to the created format context, or to NULL in
1136 * @param oformat format to use for allocating the context, if NULL
1137 * format_name and filename are used instead
1138 * @param format_name the name of output format to use for allocating the
1139 * context, if NULL filename is used instead
1140 * @param filename the name of the filename to use for allocating the
1141 * context, may be NULL
1142 * @return >= 0 in case of success, a negative AVERROR code in case of
1145 int avformat_alloc_output_context2(AVFormatContext **ctx, AVOutputFormat *oformat,
1146 const char *format_name, const char *filename);
1149 * Read packets of a media file to get stream information. This
1150 * is useful for file formats with no headers such as MPEG. This
1151 * function also computes the real framerate in case of MPEG-2 repeat
1153 * The logical file position is not changed by this function;
1154 * examined packets may be buffered for later processing.
1156 * @param ic media file handle
1157 * @return >=0 if OK, AVERROR_xxx on error
1158 * @todo Let the user decide somehow what information is needed so that
1159 * we do not waste time getting stuff the user does not need.
1161 int av_find_stream_info(AVFormatContext *ic);
1164 * Find the "best" stream in the file.
1165 * The best stream is determined according to various heuristics as the most
1166 * likely to be what the user expects.
1167 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1168 * default decoder for the stream's codec; streams for which no decoder can
1169 * be found are ignored.
1171 * @param ic media file handle
1172 * @param type stream type: video, audio, subtitles, etc.
1173 * @param wanted_stream_nb user-requested stream number,
1174 * or -1 for automatic selection
1175 * @param related_stream try to find a stream related (eg. in the same
1176 * program) to this one, or -1 if none
1177 * @param decoder_ret if non-NULL, returns the decoder for the
1179 * @param flags flags; none are currently defined
1180 * @return the non-negative stream number in case of success,
1181 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1183 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1184 * @note If av_find_best_stream returns successfully and decoder_ret is not
1185 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1187 int av_find_best_stream(AVFormatContext *ic,
1188 enum AVMediaType type,
1189 int wanted_stream_nb,
1191 AVCodec **decoder_ret,
1195 * Read a transport packet from a media file.
1197 * This function is obsolete and should never be used.
1198 * Use av_read_frame() instead.
1200 * @param s media file handle
1201 * @param pkt is filled
1202 * @return 0 if OK, AVERROR_xxx on error
1204 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1207 * Return the next frame of a stream.
1208 * This function returns what is stored in the file, and does not validate
1209 * that what is there are valid frames for the decoder. It will split what is
1210 * stored in the file into frames and return one for each call. It will not
1211 * omit invalid data between valid frames so as to give the decoder the maximum
1212 * information possible for decoding.
1214 * The returned packet is valid
1215 * until the next av_read_frame() or until av_close_input_file() and
1216 * must be freed with av_free_packet. For video, the packet contains
1217 * exactly one frame. For audio, it contains an integer number of
1218 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1219 * data). If the audio frames have a variable size (e.g. MPEG audio),
1220 * then it contains one frame.
1222 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1223 * values in AVStream.time_base units (and guessed if the format cannot
1224 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1225 * has B-frames, so it is better to rely on pkt->dts if you do not
1226 * decompress the payload.
1228 * @return 0 if OK, < 0 on error or end of file
1230 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1233 * Seek to the keyframe at timestamp.
1234 * 'timestamp' in 'stream_index'.
1235 * @param stream_index If stream_index is (-1), a default
1236 * stream is selected, and timestamp is automatically converted
1237 * from AV_TIME_BASE units to the stream specific time_base.
1238 * @param timestamp Timestamp in AVStream.time_base units
1239 * or, if no stream is specified, in AV_TIME_BASE units.
1240 * @param flags flags which select direction and seeking mode
1241 * @return >= 0 on success
1243 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1247 * Seek to timestamp ts.
1248 * Seeking will be done so that the point from which all active streams
1249 * can be presented successfully will be closest to ts and within min/max_ts.
1250 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1252 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1253 * are the file position (this may not be supported by all demuxers).
1254 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1255 * in the stream with stream_index (this may not be supported by all demuxers).
1256 * Otherwise all timestamps are in units of the stream selected by stream_index
1257 * or if stream_index is -1, in AV_TIME_BASE units.
1258 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1259 * keyframes (this may not be supported by all demuxers).
1261 * @param stream_index index of the stream which is used as time base reference
1262 * @param min_ts smallest acceptable timestamp
1263 * @param ts target timestamp
1264 * @param max_ts largest acceptable timestamp
1265 * @param flags flags
1266 * @return >=0 on success, error code otherwise
1268 * @note This is part of the new seek API which is still under construction.
1269 * Thus do not use this yet. It may change at any time, do not expect
1270 * ABI compatibility yet!
1272 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1275 * Start playing a network-based stream (e.g. RTSP stream) at the
1278 int av_read_play(AVFormatContext *s);
1281 * Pause a network-based stream (e.g. RTSP stream).
1283 * Use av_read_play() to resume it.
1285 int av_read_pause(AVFormatContext *s);
1288 * Free a AVFormatContext allocated by av_open_input_stream.
1289 * @param s context to free
1291 void av_close_input_stream(AVFormatContext *s);
1294 * Close a media file (but not its codecs).
1296 * @param s media file handle
1298 void av_close_input_file(AVFormatContext *s);
1301 * Free an AVFormatContext and all its streams.
1302 * @param s context to free
1304 void avformat_free_context(AVFormatContext *s);
1307 * Add a new stream to a media file.
1309 * Can only be called in the read_header() function. If the flag
1310 * AVFMTCTX_NOHEADER is in the format context, then new streams
1311 * can be added in read_packet too.
1313 * @param s media file handle
1314 * @param id file-format-dependent stream ID
1316 AVStream *av_new_stream(AVFormatContext *s, int id);
1317 AVProgram *av_new_program(AVFormatContext *s, int id);
1320 * Set the pts for a given stream. If the new values would be invalid
1321 * (<= 0), it leaves the AVStream unchanged.
1324 * @param pts_wrap_bits number of bits effectively used by the pts
1325 * (used for wrap control, 33 is the value for MPEG)
1326 * @param pts_num numerator to convert to seconds (MPEG: 1)
1327 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1329 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1330 unsigned int pts_num, unsigned int pts_den);
1332 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1333 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
1334 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
1335 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
1337 int av_find_default_stream_index(AVFormatContext *s);
1340 * Get the index for a specific timestamp.
1341 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1342 * to the timestamp which is <= the requested one, if backward
1343 * is 0, then it will be >=
1344 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1345 * @return < 0 if no such timestamp could be found
1347 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1350 * Add an index entry into a sorted list. Update the entry if the list
1351 * already contains it.
1353 * @param timestamp timestamp in the time base of the given stream
1355 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1356 int size, int distance, int flags);
1359 * Perform a binary search using av_index_search_timestamp() and
1360 * AVInputFormat.read_timestamp().
1361 * This is not supposed to be called directly by a user application,
1363 * @param target_ts target timestamp in the time base of the given stream
1364 * @param stream_index stream number
1366 int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1367 int64_t target_ts, int flags);
1370 * Update cur_dts of all streams based on the given timestamp and AVStream.
1372 * Stream ref_st unchanged, others set cur_dts in their native time base.
1373 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1374 * @param timestamp new dts expressed in time_base of param ref_st
1375 * @param ref_st reference stream giving time_base of param timestamp
1377 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1380 * Perform a binary search using read_timestamp().
1381 * This is not supposed to be called directly by a user application,
1383 * @param target_ts target timestamp in the time base of the given stream
1384 * @param stream_index stream number
1386 int64_t av_gen_search(AVFormatContext *s, int stream_index,
1387 int64_t target_ts, int64_t pos_min,
1388 int64_t pos_max, int64_t pos_limit,
1389 int64_t ts_min, int64_t ts_max,
1390 int flags, int64_t *ts_ret,
1391 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1396 #if FF_API_FORMAT_PARAMETERS
1398 * @deprecated pass the options to avformat_write_header directly.
1400 attribute_deprecated int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1404 * Split a URL string into components.
1406 * The pointers to buffers for storing individual components may be null,
1407 * in order to ignore that component. Buffers for components not found are
1408 * set to empty strings. If the port is not found, it is set to a negative
1411 * @param proto the buffer for the protocol
1412 * @param proto_size the size of the proto buffer
1413 * @param authorization the buffer for the authorization
1414 * @param authorization_size the size of the authorization buffer
1415 * @param hostname the buffer for the host name
1416 * @param hostname_size the size of the hostname buffer
1417 * @param port_ptr a pointer to store the port number in
1418 * @param path the buffer for the path
1419 * @param path_size the size of the path buffer
1420 * @param url the URL to split
1422 void av_url_split(char *proto, int proto_size,
1423 char *authorization, int authorization_size,
1424 char *hostname, int hostname_size,
1426 char *path, int path_size,
1430 * Allocate the stream private data and write the stream header to
1431 * an output media file.
1433 * @param s Media file handle, must be allocated with avformat_alloc_context().
1434 * Its oformat field must be set to the desired output format;
1435 * Its pb field must be set to an already openened AVIOContext.
1436 * @param options An AVDictionary filled with AVFormatContext and muxer-private options.
1437 * On return this parameter will be destroyed and replaced with a dict containing
1438 * options that were not found. May be NULL.
1440 * @return 0 on success, negative AVERROR on failure.
1442 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1444 int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1446 #if FF_API_FORMAT_PARAMETERS
1448 * Allocate the stream private data and write the stream header to an
1449 * output media file.
1450 * @note: this sets stream time-bases, if possible to stream->codec->time_base
1451 * but for some formats it might also be some other time base
1453 * @param s media file handle
1454 * @return 0 if OK, AVERROR_xxx on error
1456 * @deprecated use avformat_write_header.
1458 attribute_deprecated int av_write_header(AVFormatContext *s);
1462 * Write a packet to an output media file.
1464 * The packet shall contain one audio or video frame.
1465 * The packet must be correctly interleaved according to the container
1466 * specification, if not then av_interleaved_write_frame must be used.
1468 * @param s media file handle
1469 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1471 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1473 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1476 * Write a packet to an output media file ensuring correct interleaving.
1478 * The packet must contain one audio or video frame.
1479 * If the packets are already correctly interleaved, the application should
1480 * call av_write_frame() instead as it is slightly faster. It is also important
1481 * to keep in mind that completely non-interleaved input will need huge amounts
1482 * of memory to interleave with this, so it is preferable to interleave at the
1485 * @param s media file handle
1486 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1488 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1490 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1493 * Interleave a packet per dts in an output media file.
1495 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1496 * function, so they cannot be used after it. Note that calling av_free_packet()
1497 * on them is still safe.
1499 * @param s media file handle
1500 * @param out the interleaved packet will be output here
1501 * @param pkt the input packet
1502 * @param flush 1 if no further packets are available as input and all
1503 * remaining packets should be output
1504 * @return 1 if a packet was output, 0 if no packet could be output,
1505 * < 0 if an error occurred
1507 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1508 AVPacket *pkt, int flush);
1511 * Write the stream trailer to an output media file and free the
1512 * file private data.
1514 * May only be called after a successful call to av_write_header.
1516 * @param s media file handle
1517 * @return 0 if OK, AVERROR_xxx on error
1519 int av_write_trailer(AVFormatContext *s);
1521 #if FF_API_DUMP_FORMAT
1523 * @deprecated Deprecated in favor of av_dump_format().
1525 attribute_deprecated void dump_format(AVFormatContext *ic,
1531 void av_dump_format(AVFormatContext *ic,
1536 #if FF_API_PARSE_DATE
1538 * Parse datestr and return a corresponding number of microseconds.
1540 * @param datestr String representing a date or a duration.
1541 * See av_parse_time() for the syntax of the provided string.
1542 * @deprecated in favor of av_parse_time()
1544 attribute_deprecated
1545 int64_t parse_date(const char *datestr, int duration);
1549 * Get the current time in microseconds.
1551 int64_t av_gettime(void);
1553 #if FF_API_FIND_INFO_TAG
1555 * @deprecated use av_find_info_tag in libavutil instead.
1557 attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1561 * Return in 'buf' the path with '%d' replaced by a number.
1563 * Also handles the '%0nd' format where 'n' is the total number
1564 * of digits and '%%'.
1566 * @param buf destination buffer
1567 * @param buf_size destination buffer size
1568 * @param path numbered sequence string
1569 * @param number frame number
1570 * @return 0 if OK, -1 on format error
1572 int av_get_frame_filename(char *buf, int buf_size,
1573 const char *path, int number);
1576 * Check whether filename actually is a numbered sequence generator.
1578 * @param filename possible numbered sequence string
1579 * @return 1 if a valid numbered sequence string, 0 otherwise
1581 int av_filename_number_test(const char *filename);
1584 * Generate an SDP for an RTP session.
1586 * @param ac array of AVFormatContexts describing the RTP streams. If the
1587 * array is composed by only one context, such context can contain
1588 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1589 * all the contexts in the array (an AVCodecContext per RTP stream)
1590 * must contain only one AVStream.
1591 * @param n_files number of AVCodecContexts contained in ac
1592 * @param buf buffer where the SDP will be stored (must be allocated by
1594 * @param size the size of the buffer
1595 * @return 0 if OK, AVERROR_xxx on error
1597 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1599 #if FF_API_SDP_CREATE
1600 attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1604 * Return a positive value if the given filename has one of the given
1605 * extensions, 0 otherwise.
1607 * @param extensions a comma-separated list of filename extensions
1609 int av_match_ext(const char *filename, const char *extensions);
1611 #endif /* AVFORMAT_AVFORMAT_H */