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
24 #define LIBAVFORMAT_VERSION_MAJOR 52
25 #define LIBAVFORMAT_VERSION_MINOR 92
26 #define LIBAVFORMAT_VERSION_MICRO 0
28 #define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \
29 LIBAVFORMAT_VERSION_MINOR, \
30 LIBAVFORMAT_VERSION_MICRO)
31 #define LIBAVFORMAT_VERSION AV_VERSION(LIBAVFORMAT_VERSION_MAJOR, \
32 LIBAVFORMAT_VERSION_MINOR, \
33 LIBAVFORMAT_VERSION_MICRO)
34 #define LIBAVFORMAT_BUILD LIBAVFORMAT_VERSION_INT
36 #define LIBAVFORMAT_IDENT "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
39 * Those FF_API_* defines are not part of public API.
40 * They may change, break or disappear at any time.
42 #ifndef FF_API_MAX_STREAMS
43 #define FF_API_MAX_STREAMS (LIBAVFORMAT_VERSION_MAJOR < 53)
45 #ifndef FF_API_OLD_METADATA
46 #define FF_API_OLD_METADATA (LIBAVFORMAT_VERSION_MAJOR < 53)
48 #ifndef FF_API_URL_CLASS
49 #define FF_API_URL_CLASS (LIBAVFORMAT_VERSION_MAJOR >= 53)
51 #ifndef FF_API_URL_RESETBUF
52 #define FF_API_URL_RESETBUF (LIBAVFORMAT_VERSION_MAJOR < 53)
54 #ifndef FF_API_REGISTER_PROTOCOL
55 #define FF_API_REGISTER_PROTOCOL (LIBAVFORMAT_VERSION_MAJOR < 53)
57 #ifndef FF_API_GUESS_FORMAT
58 #define FF_API_GUESS_FORMAT (LIBAVFORMAT_VERSION_MAJOR < 53)
60 #ifndef FF_API_UDP_GET_FILE
61 #define FF_API_UDP_GET_FILE (LIBAVFORMAT_VERSION_MAJOR < 53)
63 #ifndef FF_API_URL_SPLIT
64 #define FF_API_URL_SPLIT (LIBAVFORMAT_VERSION_MAJOR < 53)
66 #ifndef FF_API_ALLOC_FORMAT_CONTEXT
67 #define FF_API_ALLOC_FORMAT_CONTEXT (LIBAVFORMAT_VERSION_MAJOR < 53)
69 #ifndef FF_API_PARSE_FRAME_PARAM
70 #define FF_API_PARSE_FRAME_PARAM (LIBAVFORMAT_VERSION_MAJOR < 53)
72 #ifndef FF_API_READ_SEEK
73 #define FF_API_READ_SEEK (LIBAVFORMAT_VERSION_MAJOR < 54)
75 #ifndef FF_API_LAVF_UNUSED
76 #define FF_API_LAVF_UNUSED (LIBAVFORMAT_VERSION_MAJOR < 53)
78 #ifndef FF_API_PARAMETERS_CODEC_ID
79 #define FF_API_PARAMETERS_CODEC_ID (LIBAVFORMAT_VERSION_MAJOR < 53)
81 #ifndef FF_API_FIRST_FORMAT
82 #define FF_API_FIRST_FORMAT (LIBAVFORMAT_VERSION_MAJOR < 53)
85 #define FF_API_SYMVER (LIBAVFORMAT_VERSION_MAJOR < 53)
89 * I return the LIBAVFORMAT_VERSION_INT constant. You got
90 * a fucking problem with that, douchebag?
92 unsigned avformat_version(void);
95 * Return the libavformat build-time configuration.
97 const char *avformat_configuration(void);
100 * Return the libavformat license.
102 const char *avformat_license(void);
105 #include <stdio.h> /* FILE */
106 #include "libavcodec/avcodec.h"
110 struct AVFormatContext;
114 * Public Metadata API.
115 * The metadata API allows libavformat to export metadata tags to a client
116 * application using a sequence of key/value pairs. Like all strings in FFmpeg,
117 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
118 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
119 * Important concepts to keep in mind:
120 * 1. Keys are unique; there can never be 2 tags with the same key. This is
121 * also meant semantically, i.e., a demuxer should not knowingly produce
122 * several keys that are literally different but semantically identical.
123 * E.g., key=Author5, key=Author6. In this example, all authors must be
124 * placed in the same tag.
125 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
126 * want to store, e.g., the email address of the child of producer Alice
127 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
128 * 3. Several modifiers can be applied to the tag name. This is done by
129 * appending a dash character ('-') and the modifier name in the order
130 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
131 * a) language -- a tag whose value is localized for a particular language
132 * is appended with the ISO 639-2/B 3-letter language code.
133 * For example: Author-ger=Michael, Author-eng=Mike
134 * The original/default language is in the unqualified "Author" tag.
135 * A demuxer should set a default if it sets any translated tag.
136 * b) sorting -- a modified version of a tag that should be used for
137 * sorting will have '-sort' appended. E.g. artist="The Beatles",
138 * artist-sort="Beatles, The".
140 * 4. Demuxers attempt to export metadata in a generic format, however tags
141 * with no generic equivalents are left as they are stored in the container.
142 * Follows a list of generic tag names:
144 * album -- name of the set this work belongs to
145 * album_artist -- main creator of the set/album, if different from artist.
146 * e.g. "Various Artists" for compilation albums.
147 * artist -- main creator of the work
148 * comment -- any additional description of the file.
149 * composer -- who composed the work, if different from artist.
150 * copyright -- name of copyright holder.
151 * creation_time-- date when the file was created, preferably in ISO 8601.
152 * date -- date when the work was created, preferably in ISO 8601.
153 * disc -- number of a subset, e.g. disc in a multi-disc collection.
154 * encoder -- name/settings of the software/hardware that produced the file.
155 * encoded_by -- person/group who created the file.
156 * filename -- original name of the file.
157 * genre -- <self-evident>.
158 * language -- main language in which the work is performed, preferably
159 * in ISO 639-2 format.
160 * performer -- artist who performed the work, if different from artist.
161 * E.g for "Also sprach Zarathustra", artist would be "Richard
162 * Strauss" and performer "London Philharmonic Orchestra".
163 * publisher -- name of the label/publisher.
164 * title -- name of the work.
165 * track -- number of this work in the set, can be in form current/total.
168 #define AV_METADATA_MATCH_CASE 1
169 #define AV_METADATA_IGNORE_SUFFIX 2
170 #define AV_METADATA_DONT_STRDUP_KEY 4
171 #define AV_METADATA_DONT_STRDUP_VAL 8
172 #define AV_METADATA_DONT_OVERWRITE 16 ///< Don't overwrite existing tags.
179 typedef struct AVMetadata AVMetadata;
180 #if FF_API_OLD_METADATA
181 typedef struct AVMetadataConv AVMetadataConv;
185 * Get a metadata element with matching key.
187 * @param prev Set to the previous matching element to find the next.
188 * If set to NULL the first matching element is returned.
189 * @param flags Allows case as well as suffix-insensitive comparisons.
190 * @return Found tag or NULL, changing key or value leads to undefined behavior.
193 av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
195 #if FF_API_OLD_METADATA
197 * Set the given tag in *pm, overwriting an existing tag.
199 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
200 * a metadata struct is allocated and put in *pm.
201 * @param key tag key to add to *pm (will be av_strduped)
202 * @param value tag value to add to *pm (will be av_strduped)
203 * @return >= 0 on success otherwise an error code <0
204 * @deprecated Use av_metadata_set2() instead.
206 attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
210 * Set the given tag in *pm, overwriting an existing tag.
212 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
213 * a metadata struct is allocated and put in *pm.
214 * @param key tag key to add to *pm (will be av_strduped depending on flags)
215 * @param value tag value to add to *pm (will be av_strduped depending on flags).
216 * Passing a NULL value will cause an existing tag to be deleted.
217 * @return >= 0 on success otherwise an error code <0
219 int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
221 #if FF_API_OLD_METADATA
223 * This function is provided for compatibility reason and currently does nothing.
225 attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
226 const AVMetadataConv *s_conv);
230 * Free all the memory allocated for an AVMetadata struct.
232 void av_metadata_free(AVMetadata **m);
235 /* packet functions */
239 * Allocate and read the payload of a packet and initialize its
240 * fields with default values.
243 * @param size desired payload size
244 * @return >0 (read size) if OK, AVERROR_xxx otherwise
246 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
250 * Read data and append it to the current content of the AVPacket.
251 * If pkt->size is 0 this is identical to av_get_packet.
252 * Note that this uses av_grow_packet and thus involves a realloc
253 * which is inefficient. Thus this function should only be used
254 * when there is no reasonable way to know (an upper bound of)
258 * @param size amount of data to read
259 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
260 * will not be lost even if an error occurs.
262 int av_append_packet(ByteIOContext *s, AVPacket *pkt, int size);
264 /*************************************************/
265 /* fractional numbers for exact pts handling */
268 * The exact value of the fractional number is: 'val + num / den'.
269 * num is assumed to be 0 <= num < den.
271 typedef struct AVFrac {
272 int64_t val, num, den;
275 /*************************************************/
276 /* input/output formats */
281 * This structure contains the data a format has to probe a file.
283 typedef struct AVProbeData {
284 const char *filename;
285 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
286 int buf_size; /**< Size of buf except extra allocated bytes */
289 #define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
290 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
292 typedef struct AVFormatParameters {
293 AVRational time_base;
298 enum PixelFormat pix_fmt;
299 int channel; /**< Used to select DV channel. */
300 const char *standard; /**< TV standard, NTSC, PAL, SECAM */
301 unsigned int mpeg2ts_raw:1; /**< Force raw MPEG-2 transport stream output, if possible. */
302 unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
303 stream packet (only meaningful if
304 mpeg2ts_raw is TRUE). */
305 unsigned int initial_pause:1; /**< Do not begin to play the stream
306 immediately (RTSP only). */
307 unsigned int prealloced_context:1;
308 #if FF_API_PARAMETERS_CODEC_ID
309 attribute_deprecated enum CodecID video_codec_id;
310 attribute_deprecated enum CodecID audio_codec_id;
312 } AVFormatParameters;
314 //! Demuxer will use url_fopen, no opened file should be provided by the caller.
315 #define AVFMT_NOFILE 0x0001
316 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
317 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
318 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
320 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
321 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
322 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
323 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
324 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
325 #define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
326 #define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */
328 typedef struct AVOutputFormat {
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;
336 const char *mime_type;
337 const char *extensions; /**< comma-separated filename extensions */
339 * size of private data so that it can be allocated in the wrapper
343 enum CodecID audio_codec; /**< default audio codec */
344 enum CodecID video_codec; /**< default video codec */
345 int (*write_header)(struct AVFormatContext *);
346 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
347 int (*write_trailer)(struct AVFormatContext *);
349 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER
353 * Currently only used to set pixel format if not YUV420P.
355 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
356 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
357 AVPacket *in, int flush);
360 * List of supported codec_id-codec_tag pairs, ordered by "better
361 * choice first". The arrays are all terminated by CODEC_ID_NONE.
363 const struct AVCodecTag * const *codec_tag;
365 enum CodecID subtitle_codec; /**< default subtitle codec */
367 #if FF_API_OLD_METADATA
368 const AVMetadataConv *metadata_conv;
371 const AVClass *priv_class; ///< AVClass for the private context
374 struct AVOutputFormat *next;
377 typedef struct AVInputFormat {
379 * A comma separated list of short names for the format. New names
380 * may be appended with a minor bump.
385 * Descriptive name for the format, meant to be more human-readable
386 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
389 const char *long_name;
392 * Size of private data so that it can be allocated in the wrapper.
397 * Tell if a given file has a chance of being parsed as this format.
398 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
399 * big so you do not have to check for that unless you need more.
401 int (*read_probe)(AVProbeData *);
404 * Read the format header and initialize the AVFormatContext
405 * structure. Return 0 if OK. 'ap' if non-NULL contains
406 * additional parameters. Only used in raw format right
407 * now. 'av_new_stream' should be called to create new streams.
409 int (*read_header)(struct AVFormatContext *,
410 AVFormatParameters *ap);
413 * Read one packet and put it in 'pkt'. pts and flags are also
414 * set. 'av_new_stream' can be called only if the flag
415 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
416 * background thread).
417 * @return 0 on success, < 0 on error.
418 * When returning an error, pkt must not have been allocated
419 * or must be freed before returning
421 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
424 * Close the stream. The AVFormatContext and AVStreams are not
425 * freed by this function
427 int (*read_close)(struct AVFormatContext *);
431 * Seek to a given timestamp relative to the frames in
432 * stream component stream_index.
433 * @param stream_index Must not be -1.
434 * @param flags Selects which direction should be preferred if no exact
435 * match is available.
436 * @return >= 0 on success (but not necessarily the new offset)
438 attribute_deprecated int (*read_seek)(struct AVFormatContext *,
439 int stream_index, int64_t timestamp, int flags);
442 * Gets the next timestamp in stream[stream_index].time_base units.
443 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
445 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
446 int64_t *pos, int64_t pos_limit);
449 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
454 * If extensions are defined, then no probe is done. You should
455 * usually not use extension format guessing because it is not
458 const char *extensions;
461 * General purpose read-only value that the format can use.
466 * Start/resume playing - only meaningful if using a network-based format
469 int (*read_play)(struct AVFormatContext *);
472 * Pause playing - only meaningful if using a network-based format
475 int (*read_pause)(struct AVFormatContext *);
477 const struct AVCodecTag * const *codec_tag;
480 * Seek to timestamp ts.
481 * Seeking will be done so that the point from which all active streams
482 * can be presented successfully will be closest to ts and within min/max_ts.
483 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
485 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
487 #if FF_API_OLD_METADATA
488 const AVMetadataConv *metadata_conv;
492 struct AVInputFormat *next;
495 enum AVStreamParseType {
497 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
498 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
499 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
500 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
503 typedef struct AVIndexEntry {
506 #define AVINDEX_KEYFRAME 0x0001
508 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).
509 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
512 #define AV_DISPOSITION_DEFAULT 0x0001
513 #define AV_DISPOSITION_DUB 0x0002
514 #define AV_DISPOSITION_ORIGINAL 0x0004
515 #define AV_DISPOSITION_COMMENT 0x0008
516 #define AV_DISPOSITION_LYRICS 0x0010
517 #define AV_DISPOSITION_KARAOKE 0x0020
520 * Track should be used during playback by default.
521 * Useful for subtitle track that should be displayed
522 * even when user did not explicitly ask for subtitles.
524 #define AV_DISPOSITION_FORCED 0x0040
528 * New fields can be added to the end with minor version bumps.
529 * Removal, reordering and changes to existing fields require a major
531 * sizeof(AVStream) must not be used outside libav*.
533 typedef struct AVStream {
534 int index; /**< stream index in AVFormatContext */
535 int id; /**< format-specific stream ID */
536 AVCodecContext *codec; /**< codec context */
538 * Real base framerate of the stream.
539 * This is the lowest framerate with which all timestamps can be
540 * represented accurately (it is the least common multiple of all
541 * framerates in the stream). Note, this value is just a guess!
542 * For example, if the time base is 1/90000 and all frames have either
543 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
545 AVRational r_frame_rate;
548 /* internal data used in av_find_stream_info() */
552 * encoding: pts generation when outputting stream
557 * This is the fundamental unit of time (in seconds) in terms
558 * of which frame timestamps are represented. For fixed-fps content,
559 * time base should be 1/framerate and timestamp increments should be 1.
561 AVRational time_base;
562 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
563 /* ffmpeg.c private use */
564 int stream_copy; /**< If set, just copy stream. */
565 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
567 //FIXME move stuff to a flags field?
569 * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
570 * MN: dunno if that is the right place for it
575 * Decoding: pts of the first frame of the stream, in stream time base.
576 * Only set this if you are absolutely 100% sure that the value you set
577 * it to really is the pts of the first frame.
578 * This may be undefined (AV_NOPTS_VALUE).
579 * @note The ASF header does NOT contain a correct start_time the ASF
580 * demuxer must NOT set this.
585 * Decoding: duration of the stream, in stream time base.
586 * If a source file does not specify a duration, but does specify
587 * a bitrate, this value will be estimated from bitrate and file size.
591 #if FF_API_OLD_METADATA
592 attribute_deprecated char language[4]; /**< ISO 639-2/B 3-letter language code (empty string if undefined) */
595 /* av_read_frame() support */
596 enum AVStreamParseType need_parsing;
597 struct AVCodecParserContext *parser;
600 int last_IP_duration;
602 /* av_seek_frame() support */
603 AVIndexEntry *index_entries; /**< Only used if the format does not
604 support seeking natively. */
605 int nb_index_entries;
606 unsigned int index_entries_allocated_size;
608 int64_t nb_frames; ///< number of frames in this stream if known or 0
610 #if FF_API_LAVF_UNUSED
611 attribute_deprecated int64_t unused[4+1];
614 #if FF_API_OLD_METADATA
615 attribute_deprecated char *filename; /**< source filename of the stream */
618 int disposition; /**< AV_DISPOSITION_* bit field */
620 AVProbeData probe_data;
621 #define MAX_REORDER_DELAY 16
622 int64_t pts_buffer[MAX_REORDER_DELAY+1];
625 * sample aspect ratio (0 if unknown)
626 * - encoding: Set by user.
627 * - decoding: Set by libavformat.
629 AVRational sample_aspect_ratio;
631 AVMetadata *metadata;
633 /* Intended mostly for av_read_frame() support. Not supposed to be used by */
634 /* external applications; try to use something else if at all possible. */
635 const uint8_t *cur_ptr;
639 // Timestamp generation support:
641 * Timestamp corresponding to the last dts sync point.
643 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
644 * a DTS is received from the underlying container. Otherwise set to
645 * AV_NOPTS_VALUE by default.
647 int64_t reference_dts;
650 * Number of packets to buffer for codec probing
651 * NOT PART OF PUBLIC API
653 #define MAX_PROBE_PACKETS 2500
657 * last packet in packet_buffer for this stream when muxing.
658 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
660 struct AVPacketList *last_in_packet_buffer;
665 AVRational avg_frame_rate;
668 * Number of frames that have been demuxed during av_find_stream_info()
670 int codec_info_nb_frames;
673 * Stream informations used internally by av_find_stream_info()
675 #define MAX_STD_TIMEBASES (60*12+5)
678 int64_t duration_gcd;
680 double duration_error[MAX_STD_TIMEBASES];
681 int64_t codec_info_duration;
685 #define AV_PROGRAM_RUNNING 1
688 * New fields can be added to the end with minor version bumps.
689 * Removal, reordering and changes to existing fields require a major
691 * sizeof(AVProgram) must not be used outside libav*.
693 typedef struct AVProgram {
695 #if FF_API_OLD_METADATA
696 attribute_deprecated char *provider_name; ///< network name for DVB streams
697 attribute_deprecated char *name; ///< service name for DVB streams
700 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
701 unsigned int *stream_index;
702 unsigned int nb_stream_indexes;
703 AVMetadata *metadata;
706 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
707 (streams are added dynamically) */
709 typedef struct AVChapter {
710 int id; ///< unique ID to identify the chapter
711 AVRational time_base; ///< time base in which the start/end timestamps are specified
712 int64_t start, end; ///< chapter start/end time in time_base units
713 #if FF_API_OLD_METADATA
714 attribute_deprecated char *title; ///< chapter title
716 AVMetadata *metadata;
719 #if FF_API_MAX_STREAMS
720 #define MAX_STREAMS 20
724 * Format I/O context.
725 * New fields can be added to the end with minor version bumps.
726 * Removal, reordering and changes to existing fields require a major
728 * sizeof(AVFormatContext) must not be used outside libav*.
730 typedef struct AVFormatContext {
731 const AVClass *av_class; /**< Set by avformat_alloc_context. */
732 /* Can only be iformat or oformat, not both at the same time. */
733 struct AVInputFormat *iformat;
734 struct AVOutputFormat *oformat;
737 unsigned int nb_streams;
738 #if FF_API_MAX_STREAMS
739 AVStream *streams[MAX_STREAMS];
743 char filename[1024]; /**< input or output filename */
746 #if FF_API_OLD_METADATA
747 attribute_deprecated char title[512];
748 attribute_deprecated char author[512];
749 attribute_deprecated char copyright[512];
750 attribute_deprecated char comment[512];
751 attribute_deprecated char album[512];
752 attribute_deprecated int year; /**< ID3 year, 0 if none */
753 attribute_deprecated int track; /**< track number, 0 if none */
754 attribute_deprecated char genre[32]; /**< ID3 genre */
757 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
758 /* private data for pts handling (do not modify directly). */
760 * This buffer is only needed when packets were already buffered but
761 * not decoded, for example to get the codec parameters in MPEG
764 struct AVPacketList *packet_buffer;
767 * Decoding: position of the first frame of the component, in
768 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
769 * It is deduced from the AVStream values.
774 * Decoding: duration of the stream, in AV_TIME_BASE fractional
775 * seconds. Only set this value if you know none of the individual stream
776 * durations and also dont set any of them. This is deduced from the
777 * AVStream values if not set.
782 * decoding: total file size, 0 if unknown
787 * Decoding: total stream bitrate in bit/s, 0 if not
788 * available. Never set it directly if the file_size and the
789 * duration are known as FFmpeg can compute it automatically.
793 /* av_read_frame() support */
795 #if FF_API_LAVF_UNUSED
796 const uint8_t *cur_ptr_deprecated;
797 int cur_len_deprecated;
798 AVPacket cur_pkt_deprecated;
801 /* av_seek_frame() support */
802 int64_t data_offset; /**< offset of the first packet */
806 unsigned int packet_size;
810 #define AVFMT_NOOUTPUTLOOP -1
811 #define AVFMT_INFINITEOUTPUTLOOP 0
813 * number of times to loop output in formats that support it
818 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
819 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
820 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
821 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
822 #define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
823 #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
824 #define AVFMT_FLAG_RTP_HINT 0x0040 ///< Add RTP hinting to the output file
829 * decoding: size of data to probe; encoding: unused.
831 unsigned int probesize;
834 * Maximum time (in AV_TIME_BASE units) during which the input should
835 * be analyzed in av_find_stream_info().
837 int max_analyze_duration;
842 unsigned int nb_programs;
843 AVProgram **programs;
846 * Forced video codec_id.
847 * Demuxing: Set by user.
849 enum CodecID video_codec_id;
852 * Forced audio codec_id.
853 * Demuxing: Set by user.
855 enum CodecID audio_codec_id;
858 * Forced subtitle codec_id.
859 * Demuxing: Set by user.
861 enum CodecID subtitle_codec_id;
864 * Maximum amount of memory in bytes to use for the index of each stream.
865 * If the index exceeds this size, entries will be discarded as
866 * needed to maintain a smaller size. This can lead to slower or less
867 * accurate seeking (depends on demuxer).
868 * Demuxers for which a full in-memory index is mandatory will ignore
871 * demuxing: set by user
873 unsigned int max_index_size;
876 * Maximum amount of memory in bytes to use for buffering frames
877 * obtained from realtime capture devices.
879 unsigned int max_picture_buffer;
881 unsigned int nb_chapters;
882 AVChapter **chapters;
885 * Flags to enable debugging.
888 #define FF_FDEBUG_TS 0x0001
891 * Raw packets from the demuxer, prior to parsing and decoding.
892 * This buffer is used for buffering packets until the codec can
893 * be identified, as parsing cannot be done without knowing the
896 struct AVPacketList *raw_packet_buffer;
897 struct AVPacketList *raw_packet_buffer_end;
899 struct AVPacketList *packet_buffer_end;
901 AVMetadata *metadata;
904 * Remaining size available for raw_packet_buffer, in bytes.
905 * NOT PART OF PUBLIC API
907 #define RAW_PACKET_BUFFER_SIZE 2500000
908 int raw_packet_buffer_remaining_size;
911 * Start time of the stream in real world time, in microseconds
912 * since the unix epoch (00:00 1st January 1970). That is, pts=0
913 * in the stream was captured at this real world time.
914 * - encoding: Set by user.
915 * - decoding: Unused.
917 int64_t start_time_realtime;
920 typedef struct AVPacketList {
922 struct AVPacketList *next;
925 #if FF_API_FIRST_FORMAT
926 attribute_deprecated extern AVInputFormat *first_iformat;
927 attribute_deprecated extern AVOutputFormat *first_oformat;
931 * If f is NULL, returns the first registered input format,
932 * if f is non-NULL, returns the next registered input format after f
933 * or NULL if f is the last one.
935 AVInputFormat *av_iformat_next(AVInputFormat *f);
938 * If f is NULL, returns the first registered output format,
939 * if f is non-NULL, returns the next registered output format after f
940 * or NULL if f is the last one.
942 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
944 enum CodecID av_guess_image2_codec(const char *filename);
946 /* XXX: Use automatic init with either ELF sections or C file parser */
950 void av_register_input_format(AVInputFormat *format);
951 void av_register_output_format(AVOutputFormat *format);
952 #if FF_API_GUESS_FORMAT
953 attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
954 const char *filename,
955 const char *mime_type);
958 * @deprecated Use av_guess_format() instead.
960 attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
961 const char *filename,
962 const char *mime_type);
966 * Return the output format in the list of registered output formats
967 * which best matches the provided parameters, or return NULL if
970 * @param short_name if non-NULL checks if short_name matches with the
971 * names of the registered formats
972 * @param filename if non-NULL checks if filename terminates with the
973 * extensions of the registered formats
974 * @param mime_type if non-NULL checks if mime_type matches with the
975 * MIME type of the registered formats
977 AVOutputFormat *av_guess_format(const char *short_name,
978 const char *filename,
979 const char *mime_type);
982 * Guess the codec ID based upon muxer and filename.
984 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
985 const char *filename, const char *mime_type,
986 enum AVMediaType type);
989 * Send a nice hexadecimal dump of a buffer to the specified file stream.
991 * @param f The file stream pointer where the dump should be sent to.
993 * @param size buffer size
995 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
997 void av_hex_dump(FILE *f, uint8_t *buf, int size);
1000 * Send a nice hexadecimal dump of a buffer to the log.
1002 * @param avcl A pointer to an arbitrary struct of which the first field is a
1003 * pointer to an AVClass struct.
1004 * @param level The importance level of the message, lower values signifying
1005 * higher importance.
1007 * @param size buffer size
1009 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
1011 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
1014 * Send a nice dump of a packet to the specified file stream.
1016 * @param f The file stream pointer where the dump should be sent to.
1017 * @param pkt packet to dump
1018 * @param dump_payload True if the payload must be displayed, too.
1020 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
1023 * Send a nice dump of a packet to the log.
1025 * @param avcl A pointer to an arbitrary struct of which the first field is a
1026 * pointer to an AVClass struct.
1027 * @param level The importance level of the message, lower values signifying
1028 * higher importance.
1029 * @param pkt packet to dump
1030 * @param dump_payload True if the payload must be displayed, too.
1032 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
1035 * Initialize libavformat and register all the muxers, demuxers and
1036 * protocols. If you do not call this function, then you can select
1037 * exactly which formats you want to support.
1039 * @see av_register_input_format()
1040 * @see av_register_output_format()
1041 * @see av_register_protocol()
1043 void av_register_all(void);
1046 * Get the CodecID for the given codec tag tag.
1047 * If no codec id is found returns CODEC_ID_NONE.
1049 * @param tags list of supported codec_id-codec_tag pairs, as stored
1050 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1052 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1055 * Get the codec tag for the given codec id id.
1056 * If no codec tag is found returns 0.
1058 * @param tags list of supported codec_id-codec_tag pairs, as stored
1059 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1061 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1063 /* media file input */
1066 * Find AVInputFormat based on the short name of the input format.
1068 AVInputFormat *av_find_input_format(const char *short_name);
1071 * Guess the file format.
1073 * @param is_opened Whether the file is already opened; determines whether
1074 * demuxers with or without AVFMT_NOFILE are probed.
1076 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1079 * Guess the file format.
1081 * @param is_opened Whether the file is already opened; determines whether
1082 * demuxers with or without AVFMT_NOFILE are probed.
1083 * @param score_max A probe score larger that this is required to accept a
1084 * detection, the variable is set to the actual detection
1086 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1087 * to retry with a larger probe buffer.
1089 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1092 * Allocate all the structures needed to read an input stream.
1093 * This does not open the needed codecs for decoding the stream[s].
1095 int av_open_input_stream(AVFormatContext **ic_ptr,
1096 ByteIOContext *pb, const char *filename,
1097 AVInputFormat *fmt, AVFormatParameters *ap);
1100 * Open a media file as input. The codecs are not opened. Only the file
1101 * header (if present) is read.
1103 * @param ic_ptr The opened media file handle is put here.
1104 * @param filename filename to open
1105 * @param fmt If non-NULL, force the file format to use.
1106 * @param buf_size optional buffer size (zero if default is OK)
1107 * @param ap Additional parameters needed when opening the file
1108 * (NULL if default).
1109 * @return 0 if OK, AVERROR_xxx otherwise
1111 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1114 AVFormatParameters *ap);
1116 #if FF_API_ALLOC_FORMAT_CONTEXT
1118 * @deprecated Use avformat_alloc_context() instead.
1120 attribute_deprecated AVFormatContext *av_alloc_format_context(void);
1124 * Allocate an AVFormatContext.
1125 * Can be freed with av_free() but do not forget to free everything you
1126 * explicitly allocated as well!
1128 AVFormatContext *avformat_alloc_context(void);
1131 * Read packets of a media file to get stream information. This
1132 * is useful for file formats with no headers such as MPEG. This
1133 * function also computes the real framerate in case of MPEG-2 repeat
1135 * The logical file position is not changed by this function;
1136 * examined packets may be buffered for later processing.
1138 * @param ic media file handle
1139 * @return >=0 if OK, AVERROR_xxx on error
1140 * @todo Let the user decide somehow what information is needed so that
1141 * we do not waste time getting stuff the user does not need.
1143 int av_find_stream_info(AVFormatContext *ic);
1146 * Find the "best" stream in the file.
1147 * The best stream is determined according to various heuristics as the most
1148 * likely to be what the user expects.
1149 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1150 * default decoder for the stream's codec; streams for which no decoder can
1151 * be found are ignored.
1153 * @param ic media file handle
1154 * @param type stream type: video, audio, subtitles, etc.
1155 * @param wanted_stream_nb user-requested stream number,
1156 * or -1 for automatic selection
1157 * @param related_stream try to find a stream related (eg. in the same
1158 * program) to this one, or -1 if none
1159 * @param decoder_ret if non-NULL, returns the decoder for the
1161 * @param flags flags; none are currently defined
1162 * @return the non-negative stream number in case of success,
1163 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1165 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1166 * @note If av_find_best_stream returns successfully and decoder_ret is not
1167 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1169 int av_find_best_stream(AVFormatContext *ic,
1170 enum AVMediaType type,
1171 int wanted_stream_nb,
1173 AVCodec **decoder_ret,
1177 * Read a transport packet from a media file.
1179 * This function is obsolete and should never be used.
1180 * Use av_read_frame() instead.
1182 * @param s media file handle
1183 * @param pkt is filled
1184 * @return 0 if OK, AVERROR_xxx on error
1186 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1189 * Return the next frame of a stream.
1190 * This function returns what is stored in the file, and does not validate
1191 * that what is there are valid frames for the decoder. It will split what is
1192 * stored in the file into frames and return one for each call. It will not
1193 * omit invalid data between valid frames so as to give the decoder the maximum
1194 * information possible for decoding.
1196 * The returned packet is valid
1197 * until the next av_read_frame() or until av_close_input_file() and
1198 * must be freed with av_free_packet. For video, the packet contains
1199 * exactly one frame. For audio, it contains an integer number of
1200 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1201 * data). If the audio frames have a variable size (e.g. MPEG audio),
1202 * then it contains one frame.
1204 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1205 * values in AVStream.time_base units (and guessed if the format cannot
1206 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1207 * has B-frames, so it is better to rely on pkt->dts if you do not
1208 * decompress the payload.
1210 * @return 0 if OK, < 0 on error or end of file
1212 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1215 * Seek to the keyframe at timestamp.
1216 * 'timestamp' in 'stream_index'.
1217 * @param stream_index If stream_index is (-1), a default
1218 * stream is selected, and timestamp is automatically converted
1219 * from AV_TIME_BASE units to the stream specific time_base.
1220 * @param timestamp Timestamp in AVStream.time_base units
1221 * or, if no stream is specified, in AV_TIME_BASE units.
1222 * @param flags flags which select direction and seeking mode
1223 * @return >= 0 on success
1225 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1229 * Seek to timestamp ts.
1230 * Seeking will be done so that the point from which all active streams
1231 * can be presented successfully will be closest to ts and within min/max_ts.
1232 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1234 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1235 * are the file position (this may not be supported by all demuxers).
1236 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1237 * in the stream with stream_index (this may not be supported by all demuxers).
1238 * Otherwise all timestamps are in units of the stream selected by stream_index
1239 * or if stream_index is -1, in AV_TIME_BASE units.
1240 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1241 * keyframes (this may not be supported by all demuxers).
1243 * @param stream_index index of the stream which is used as time base reference
1244 * @param min_ts smallest acceptable timestamp
1245 * @param ts target timestamp
1246 * @param max_ts largest acceptable timestamp
1247 * @param flags flags
1248 * @return >=0 on success, error code otherwise
1250 * @note This is part of the new seek API which is still under construction.
1251 * Thus do not use this yet. It may change at any time, do not expect
1252 * ABI compatibility yet!
1254 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1257 * Start playing a network-based stream (e.g. RTSP stream) at the
1260 int av_read_play(AVFormatContext *s);
1263 * Pause a network-based stream (e.g. RTSP stream).
1265 * Use av_read_play() to resume it.
1267 int av_read_pause(AVFormatContext *s);
1270 * Free a AVFormatContext allocated by av_open_input_stream.
1271 * @param s context to free
1273 void av_close_input_stream(AVFormatContext *s);
1276 * Close a media file (but not its codecs).
1278 * @param s media file handle
1280 void av_close_input_file(AVFormatContext *s);
1283 * Add a new stream to a media file.
1285 * Can only be called in the read_header() function. If the flag
1286 * AVFMTCTX_NOHEADER is in the format context, then new streams
1287 * can be added in read_packet too.
1289 * @param s media file handle
1290 * @param id file-format-dependent stream ID
1292 AVStream *av_new_stream(AVFormatContext *s, int id);
1293 AVProgram *av_new_program(AVFormatContext *s, int id);
1296 * Add a new chapter.
1297 * This function is NOT part of the public API
1298 * and should ONLY be used by demuxers.
1300 * @param s media file handle
1301 * @param id unique ID for this chapter
1302 * @param start chapter start time in time_base units
1303 * @param end chapter end time in time_base units
1304 * @param title chapter title
1306 * @return AVChapter or NULL on error
1308 AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1309 int64_t start, int64_t end, const char *title);
1312 * Set the pts for a given stream.
1315 * @param pts_wrap_bits number of bits effectively used by the pts
1316 * (used for wrap control, 33 is the value for MPEG)
1317 * @param pts_num numerator to convert to seconds (MPEG: 1)
1318 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1320 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1321 unsigned int pts_num, unsigned int pts_den);
1323 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1324 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
1325 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
1326 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
1328 int av_find_default_stream_index(AVFormatContext *s);
1331 * Get the index for a specific timestamp.
1332 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1333 * to the timestamp which is <= the requested one, if backward
1334 * is 0, then it will be >=
1335 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1336 * @return < 0 if no such timestamp could be found
1338 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1341 * Ensure the index uses less memory than the maximum specified in
1342 * AVFormatContext.max_index_size by discarding entries if it grows
1344 * This function is not part of the public API and should only be called
1347 void ff_reduce_index(AVFormatContext *s, int stream_index);
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 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1399 * Split a URL string into components.
1401 * The pointers to buffers for storing individual components may be null,
1402 * in order to ignore that component. Buffers for components not found are
1403 * set to empty strings. If the port is not found, it is set to a negative
1406 * @param proto the buffer for the protocol
1407 * @param proto_size the size of the proto buffer
1408 * @param authorization the buffer for the authorization
1409 * @param authorization_size the size of the authorization buffer
1410 * @param hostname the buffer for the host name
1411 * @param hostname_size the size of the hostname buffer
1412 * @param port_ptr a pointer to store the port number in
1413 * @param path the buffer for the path
1414 * @param path_size the size of the path buffer
1415 * @param url the URL to split
1417 void av_url_split(char *proto, int proto_size,
1418 char *authorization, int authorization_size,
1419 char *hostname, int hostname_size,
1421 char *path, int path_size,
1425 * Allocate the stream private data and write the stream header to an
1426 * output media file.
1428 * @param s media file handle
1429 * @return 0 if OK, AVERROR_xxx on error
1431 int av_write_header(AVFormatContext *s);
1434 * Write a packet to an output media file.
1436 * The packet shall contain one audio or video frame.
1437 * The packet must be correctly interleaved according to the container
1438 * specification, if not then av_interleaved_write_frame must be used.
1440 * @param s media file handle
1441 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1443 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1445 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1448 * Write a packet to an output media file ensuring correct interleaving.
1450 * The packet must contain one audio or video frame.
1451 * If the packets are already correctly interleaved, the application should
1452 * call av_write_frame() instead as it is slightly faster. It is also important
1453 * to keep in mind that completely non-interleaved input will need huge amounts
1454 * of memory to interleave with this, so it is preferable to interleave at the
1457 * @param s media file handle
1458 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1460 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1462 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1465 * Interleave a packet per dts in an output media file.
1467 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1468 * function, so they cannot be used after it. Note that calling av_free_packet()
1469 * on them is still safe.
1471 * @param s media file handle
1472 * @param out the interleaved packet will be output here
1473 * @param pkt the input packet
1474 * @param flush 1 if no further packets are available as input and all
1475 * remaining packets should be output
1476 * @return 1 if a packet was output, 0 if no packet could be output,
1477 * < 0 if an error occurred
1479 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1480 AVPacket *pkt, int flush);
1483 * Write the stream trailer to an output media file and free the
1484 * file private data.
1486 * May only be called after a successful call to av_write_header.
1488 * @param s media file handle
1489 * @return 0 if OK, AVERROR_xxx on error
1491 int av_write_trailer(AVFormatContext *s);
1493 void dump_format(AVFormatContext *ic,
1498 #if FF_API_PARSE_FRAME_PARAM
1500 * Parse width and height out of string str.
1501 * @deprecated Use av_parse_video_frame_size instead.
1503 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1507 * Convert framerate from a string to a fraction.
1508 * @deprecated Use av_parse_video_frame_rate instead.
1510 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1515 * Parse datestr and return a corresponding number of microseconds.
1516 * @param datestr String representing a date or a duration.
1517 * - If a date the syntax is:
1519 * now|{[{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH[:MM[:SS[.m...]]]}|{HH[MM[SS[.m...]]]}}[Z|z]}
1521 * If the value is "now" it takes the current time.
1522 * Time is local time unless Z is appended, in which case it is
1523 * interpreted as UTC.
1524 * If the year-month-day part is not specified it takes the current
1526 * @return the number of microseconds since 1st of January, 1970 up to
1527 * the time of the parsed date or INT64_MIN if datestr cannot be
1528 * successfully parsed.
1529 * - If a duration the syntax is:
1531 * [-]HH[:MM[:SS[.m...]]]
1534 * @return the number of microseconds contained in a time interval
1535 * with the specified duration or INT64_MIN if datestr cannot be
1536 * successfully parsed.
1537 * @param duration Flag which tells how to interpret datestr, if
1538 * not zero datestr is interpreted as a duration, otherwise as a
1541 int64_t parse_date(const char *datestr, int duration);
1544 * Get the current time in microseconds.
1546 int64_t av_gettime(void);
1548 /* ffm-specific for ffserver */
1549 #define FFM_PACKET_SIZE 4096
1550 int64_t ffm_read_write_index(int fd);
1551 int ffm_write_write_index(int fd, int64_t pos);
1552 void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1555 * Attempt to find a specific tag in a URL.
1557 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1558 * Return 1 if found.
1560 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1563 * Return in 'buf' the path with '%d' replaced by a number.
1565 * Also handles the '%0nd' format where 'n' is the total number
1566 * of digits and '%%'.
1568 * @param buf destination buffer
1569 * @param buf_size destination buffer size
1570 * @param path numbered sequence string
1571 * @param number frame number
1572 * @return 0 if OK, -1 on format error
1574 int av_get_frame_filename(char *buf, int buf_size,
1575 const char *path, int number);
1578 * Check whether filename actually is a numbered sequence generator.
1580 * @param filename possible numbered sequence string
1581 * @return 1 if a valid numbered sequence string, 0 otherwise
1583 int av_filename_number_test(const char *filename);
1586 * Generate an SDP for an RTP session.
1588 * @param ac array of AVFormatContexts describing the RTP streams. If the
1589 * array is composed by only one context, such context can contain
1590 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1591 * all the contexts in the array (an AVCodecContext per RTP stream)
1592 * must contain only one AVStream.
1593 * @param n_files number of AVCodecContexts contained in ac
1594 * @param buff buffer where the SDP will be stored (must be allocated by
1596 * @param size the size of the buffer
1597 * @return 0 if OK, AVERROR_xxx on error
1599 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1602 * Return a positive value if the given filename has one of the given
1603 * extensions, 0 otherwise.
1605 * @param extensions a comma-separated list of filename extensions
1607 int av_match_ext(const char *filename, const char *extensions);
1609 #endif /* AVFORMAT_AVFORMAT_H */