2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav 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 * Libav 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 Libav; 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"
44 #include "libavutil/log.h"
47 #include "libavformat/version.h"
49 struct AVFormatContext;
53 * @defgroup metadata_api Public Metadata API
55 * The metadata API allows libavformat to export metadata tags to a client
56 * application using a sequence of key/value pairs. Like all strings in Libav,
57 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
58 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
59 * Important concepts to keep in mind:
60 * - Keys are unique; there can never be 2 tags with the same key. This is
61 * also meant semantically, i.e., a demuxer should not knowingly produce
62 * several keys that are literally different but semantically identical.
63 * E.g., key=Author5, key=Author6. In this example, all authors must be
64 * placed in the same tag.
65 * - Metadata is flat, not hierarchical; there are no subtags. If you
66 * want to store, e.g., the email address of the child of producer Alice
67 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
68 * - Several modifiers can be applied to the tag name. This is done by
69 * appending a dash character ('-') and the modifier name in the order
70 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
71 * - language -- a tag whose value is localized for a particular language
72 * is appended with the ISO 639-2/B 3-letter language code.
73 * For example: Author-ger=Michael, Author-eng=Mike
74 * The original/default language is in the unqualified "Author" tag.
75 * A demuxer should set a default if it sets any translated tag.
76 * - sorting -- a modified version of a tag that should be used for
77 * sorting will have '-sort' appended. E.g. artist="The Beatles",
78 * artist-sort="Beatles, The".
80 * - Demuxers attempt to export metadata in a generic format, however tags
81 * with no generic equivalents are left as they are stored in the container.
82 * Follows a list of generic tag names:
85 album -- name of the set this work belongs to
86 album_artist -- main creator of the set/album, if different from artist.
87 e.g. "Various Artists" for compilation albums.
88 artist -- main creator of the work
89 comment -- any additional description of the file.
90 composer -- who composed the work, if different from artist.
91 copyright -- name of copyright holder.
92 creation_time-- date when the file was created, preferably in ISO 8601.
93 date -- date when the work was created, preferably in ISO 8601.
94 disc -- number of a subset, e.g. disc in a multi-disc collection.
95 encoder -- name/settings of the software/hardware that produced the file.
96 encoded_by -- person/group who created the file.
97 filename -- original name of the file.
98 genre -- <self-evident>.
99 language -- main language in which the work is performed, preferably
100 in ISO 639-2 format. Multiple languages can be specified by
101 separating them with commas.
102 performer -- artist who performed the work, if different from artist.
103 E.g for "Also sprach Zarathustra", artist would be "Richard
104 Strauss" and performer "London Philharmonic Orchestra".
105 publisher -- name of the label/publisher.
106 service_name -- name of the service in broadcasting (channel name).
107 service_provider -- name of the service provider in broadcasting.
108 title -- name of the work.
109 track -- number of this work in the set, can be in form current/total.
110 variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
113 * Look in the examples section for an application example how to use the Metadata API.
118 #if FF_API_OLD_METADATA2
120 * @defgroup old_metadata Old metadata API
121 * The following functions are deprecated, use
122 * their equivalents from libavutil/dict.h instead.
126 #define AV_METADATA_MATCH_CASE AV_DICT_MATCH_CASE
127 #define AV_METADATA_IGNORE_SUFFIX AV_DICT_IGNORE_SUFFIX
128 #define AV_METADATA_DONT_STRDUP_KEY AV_DICT_DONT_STRDUP_KEY
129 #define AV_METADATA_DONT_STRDUP_VAL AV_DICT_DONT_STRDUP_VAL
130 #define AV_METADATA_DONT_OVERWRITE AV_DICT_DONT_OVERWRITE
132 typedef attribute_deprecated AVDictionary AVMetadata;
133 typedef attribute_deprecated AVDictionaryEntry AVMetadataTag;
135 typedef struct AVMetadataConv AVMetadataConv;
138 * Get a metadata element with matching key.
140 * @param prev Set to the previous matching element to find the next.
141 * If set to NULL the first matching element is returned.
142 * @param flags Allows case as well as suffix-insensitive comparisons.
143 * @return Found tag or NULL, changing key or value leads to undefined behavior.
145 attribute_deprecated AVDictionaryEntry *
146 av_metadata_get(AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags);
149 * Set the given tag in *pm, overwriting an existing tag.
151 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
152 * a metadata struct is allocated and put in *pm.
153 * @param key tag key to add to *pm (will be av_strduped depending on flags)
154 * @param value tag value to add to *pm (will be av_strduped depending on flags).
155 * Passing a NULL value will cause an existing tag to be deleted.
156 * @return >= 0 on success otherwise an error code <0
158 attribute_deprecated int av_metadata_set2(AVDictionary **pm, const char *key, const char *value, int flags);
161 * This function is provided for compatibility reason and currently does nothing.
163 attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
164 const AVMetadataConv *s_conv);
167 * Copy metadata from one AVDictionary struct into another.
168 * @param dst pointer to a pointer to a AVDictionary struct. If *dst is NULL,
169 * this function will allocate a struct for you and put it in *dst
170 * @param src pointer to source AVDictionary struct
171 * @param flags flags to use when setting metadata in *dst
172 * @note metadata is read using the AV_DICT_IGNORE_SUFFIX flag
174 attribute_deprecated void av_metadata_copy(AVDictionary **dst, AVDictionary *src, int flags);
177 * Free all the memory allocated for an AVDictionary struct.
179 attribute_deprecated void av_metadata_free(AVDictionary **m);
186 /* packet functions */
190 * Allocate and read the payload of a packet and initialize its
191 * fields with default values.
194 * @param size desired payload size
195 * @return >0 (read size) if OK, AVERROR_xxx otherwise
197 int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
201 * Read data and append it to the current content of the AVPacket.
202 * If pkt->size is 0 this is identical to av_get_packet.
203 * Note that this uses av_grow_packet and thus involves a realloc
204 * which is inefficient. Thus this function should only be used
205 * when there is no reasonable way to know (an upper bound of)
209 * @param size amount of data to read
210 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
211 * will not be lost even if an error occurs.
213 int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
215 /*************************************************/
216 /* fractional numbers for exact pts handling */
219 * The exact value of the fractional number is: 'val + num / den'.
220 * num is assumed to be 0 <= num < den.
222 typedef struct AVFrac {
223 int64_t val, num, den;
226 /*************************************************/
227 /* input/output formats */
232 * This structure contains the data a format has to probe a file.
234 typedef struct AVProbeData {
235 const char *filename;
236 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
237 int buf_size; /**< Size of buf except extra allocated bytes */
240 #define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
241 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
243 typedef struct AVFormatParameters {
244 #if FF_API_FORMAT_PARAMETERS
245 attribute_deprecated AVRational time_base;
246 attribute_deprecated int sample_rate;
247 attribute_deprecated int channels;
248 attribute_deprecated int width;
249 attribute_deprecated int height;
250 attribute_deprecated enum PixelFormat pix_fmt;
251 attribute_deprecated int channel; /**< Used to select DV channel. */
252 attribute_deprecated const char *standard; /**< deprecated, use demuxer-specific options instead. */
253 attribute_deprecated unsigned int mpeg2ts_raw:1; /**< deprecated, use mpegtsraw demuxer */
254 /**< deprecated, use mpegtsraw demuxer-specific options instead */
255 attribute_deprecated unsigned int mpeg2ts_compute_pcr:1;
256 attribute_deprecated unsigned int initial_pause:1; /**< Do not begin to play the stream
257 immediately (RTSP only). */
258 attribute_deprecated unsigned int prealloced_context:1;
260 } AVFormatParameters;
262 //! Demuxer will use avio_open, no opened file should be provided by the caller.
263 #define AVFMT_NOFILE 0x0001
264 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
265 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
266 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
268 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
269 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
270 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
271 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
272 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
273 #define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
274 #define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */
275 #define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fallback to binary search via read_timestamp */
276 #define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fallback to generic search */
277 #define AVFMT_NO_BYTE_SEEK 0x8000 /**< Format does not allow seeking by bytes */
279 typedef struct AVOutputFormat {
282 * Descriptive name for the format, meant to be more human-readable
283 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
286 const char *long_name;
287 const char *mime_type;
288 const char *extensions; /**< comma-separated filename extensions */
290 * size of private data so that it can be allocated in the wrapper
294 enum CodecID audio_codec; /**< default audio codec */
295 enum CodecID video_codec; /**< default video codec */
296 int (*write_header)(struct AVFormatContext *);
297 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
298 int (*write_trailer)(struct AVFormatContext *);
300 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
301 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
302 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS
306 * Currently only used to set pixel format if not YUV420P.
308 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
309 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
310 AVPacket *in, int flush);
313 * List of supported codec_id-codec_tag pairs, ordered by "better
314 * choice first". The arrays are all terminated by CODEC_ID_NONE.
316 const struct AVCodecTag * const *codec_tag;
318 enum CodecID subtitle_codec; /**< default subtitle codec */
320 #if FF_API_OLD_METADATA2
321 const AVMetadataConv *metadata_conv;
324 const AVClass *priv_class; ///< AVClass for the private context
327 * Test if the given codec can be stored in this container.
329 * @return 1 if the codec is supported, 0 if it is not.
330 * A negative number if unknown.
332 int (*query_codec)(enum CodecID id, int std_compliance);
335 struct AVOutputFormat *next;
338 typedef struct AVInputFormat {
340 * A comma separated list of short names for the format. New names
341 * may be appended with a minor bump.
346 * Descriptive name for the format, meant to be more human-readable
347 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
350 const char *long_name;
353 * Size of private data so that it can be allocated in the wrapper.
358 * Tell if a given file has a chance of being parsed as this format.
359 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
360 * big so you do not have to check for that unless you need more.
362 int (*read_probe)(AVProbeData *);
365 * Read the format header and initialize the AVFormatContext
366 * structure. Return 0 if OK. 'ap' if non-NULL contains
367 * additional parameters. Only used in raw format right
368 * now. 'av_new_stream' should be called to create new streams.
370 int (*read_header)(struct AVFormatContext *,
371 AVFormatParameters *ap);
374 * Read one packet and put it in 'pkt'. pts and flags are also
375 * set. 'av_new_stream' can be called only if the flag
376 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
377 * background thread).
378 * @return 0 on success, < 0 on error.
379 * When returning an error, pkt must not have been allocated
380 * or must be freed before returning
382 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
385 * Close the stream. The AVFormatContext and AVStreams are not
386 * freed by this function
388 int (*read_close)(struct AVFormatContext *);
392 * Seek to a given timestamp relative to the frames in
393 * stream component stream_index.
394 * @param stream_index Must not be -1.
395 * @param flags Selects which direction should be preferred if no exact
396 * match is available.
397 * @return >= 0 on success (but not necessarily the new offset)
399 attribute_deprecated int (*read_seek)(struct AVFormatContext *,
400 int stream_index, int64_t timestamp, int flags);
403 * Gets the next timestamp in stream[stream_index].time_base units.
404 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
406 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
407 int64_t *pos, int64_t pos_limit);
410 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
411 * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
412 * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK.
417 * If extensions are defined, then no probe is done. You should
418 * usually not use extension format guessing because it is not
421 const char *extensions;
424 * General purpose read-only value that the format can use.
429 * Start/resume playing - only meaningful if using a network-based format
432 int (*read_play)(struct AVFormatContext *);
435 * Pause playing - only meaningful if using a network-based format
438 int (*read_pause)(struct AVFormatContext *);
440 const struct AVCodecTag * const *codec_tag;
443 * Seek to timestamp ts.
444 * Seeking will be done so that the point from which all active streams
445 * can be presented successfully will be closest to ts and within min/max_ts.
446 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
448 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
450 #if FF_API_OLD_METADATA2
451 const AVMetadataConv *metadata_conv;
454 const AVClass *priv_class; ///< AVClass for the private context
457 struct AVInputFormat *next;
460 enum AVStreamParseType {
462 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
463 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
464 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
465 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
468 typedef struct AVIndexEntry {
471 #define AVINDEX_KEYFRAME 0x0001
473 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).
474 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
477 #define AV_DISPOSITION_DEFAULT 0x0001
478 #define AV_DISPOSITION_DUB 0x0002
479 #define AV_DISPOSITION_ORIGINAL 0x0004
480 #define AV_DISPOSITION_COMMENT 0x0008
481 #define AV_DISPOSITION_LYRICS 0x0010
482 #define AV_DISPOSITION_KARAOKE 0x0020
485 * Track should be used during playback by default.
486 * Useful for subtitle track that should be displayed
487 * even when user did not explicitly ask for subtitles.
489 #define AV_DISPOSITION_FORCED 0x0040
490 #define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */
491 #define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */
492 #define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */
496 * New fields can be added to the end with minor version bumps.
497 * Removal, reordering and changes to existing fields require a major
499 * sizeof(AVStream) must not be used outside libav*.
501 typedef struct AVStream {
502 int index; /**< stream index in AVFormatContext */
503 int id; /**< format-specific stream ID */
504 AVCodecContext *codec; /**< codec context */
506 * Real base framerate of the stream.
507 * This is the lowest framerate with which all timestamps can be
508 * represented accurately (it is the least common multiple of all
509 * framerates in the stream). Note, this value is just a guess!
510 * For example, if the time base is 1/90000 and all frames have either
511 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
513 AVRational r_frame_rate;
516 /* internal data used in av_find_stream_info() */
520 * encoding: pts generation when outputting stream
525 * This is the fundamental unit of time (in seconds) in terms
526 * of which frame timestamps are represented. For fixed-fps content,
527 * time base should be 1/framerate and timestamp increments should be 1.
528 * decoding: set by libavformat
529 * encoding: set by libavformat in av_write_header
531 AVRational time_base;
532 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
533 /* ffmpeg.c private use */
534 int stream_copy; /**< If set, just copy stream. */
535 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
537 #if FF_API_AVSTREAM_QUALITY
538 //FIXME move stuff to a flags field?
540 * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
541 * MN: dunno if that is the right place for it
543 attribute_deprecated float quality;
547 * Decoding: pts of the first frame of the stream, in stream time base.
548 * Only set this if you are absolutely 100% sure that the value you set
549 * it to really is the pts of the first frame.
550 * This may be undefined (AV_NOPTS_VALUE).
555 * Decoding: duration of the stream, in stream time base.
556 * If a source file does not specify a duration, but does specify
557 * a bitrate, this value will be estimated from bitrate and file size.
561 /* av_read_frame() support */
562 enum AVStreamParseType need_parsing;
563 struct AVCodecParserContext *parser;
566 int last_IP_duration;
568 /* av_seek_frame() support */
569 AVIndexEntry *index_entries; /**< Only used if the format does not
570 support seeking natively. */
571 int nb_index_entries;
572 unsigned int index_entries_allocated_size;
574 int64_t nb_frames; ///< number of frames in this stream if known or 0
576 int disposition; /**< AV_DISPOSITION_* bit field */
578 AVProbeData probe_data;
579 #define MAX_REORDER_DELAY 16
580 int64_t pts_buffer[MAX_REORDER_DELAY+1];
583 * sample aspect ratio (0 if unknown)
584 * - encoding: Set by user.
585 * - decoding: Set by libavformat.
587 AVRational sample_aspect_ratio;
589 AVDictionary *metadata;
591 /* Intended mostly for av_read_frame() support. Not supposed to be used by */
592 /* external applications; try to use something else if at all possible. */
593 const uint8_t *cur_ptr;
597 // Timestamp generation support:
599 * Timestamp corresponding to the last dts sync point.
601 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
602 * a DTS is received from the underlying container. Otherwise set to
603 * AV_NOPTS_VALUE by default.
605 int64_t reference_dts;
608 * Number of packets to buffer for codec probing
609 * NOT PART OF PUBLIC API
611 #define MAX_PROBE_PACKETS 2500
615 * last packet in packet_buffer for this stream when muxing.
616 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
618 struct AVPacketList *last_in_packet_buffer;
623 AVRational avg_frame_rate;
626 * Number of frames that have been demuxed during av_find_stream_info()
628 int codec_info_nb_frames;
631 * Stream informations used internally by av_find_stream_info()
633 #define MAX_STD_TIMEBASES (60*12+5)
636 int64_t duration_gcd;
638 double duration_error[MAX_STD_TIMEBASES];
639 int64_t codec_info_duration;
643 #define AV_PROGRAM_RUNNING 1
646 * New fields can be added to the end with minor version bumps.
647 * Removal, reordering and changes to existing fields require a major
649 * sizeof(AVProgram) must not be used outside libav*.
651 typedef struct AVProgram {
654 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
655 unsigned int *stream_index;
656 unsigned int nb_stream_indexes;
657 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 * @deprecated use 'creation_time' metadata tag instead
692 attribute_deprecated int64_t timestamp;
695 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
696 /* private data for pts handling (do not modify directly). */
698 * This buffer is only needed when packets were already buffered but
699 * not decoded, for example to get the codec parameters in MPEG
702 struct AVPacketList *packet_buffer;
705 * Decoding: position of the first frame of the component, in
706 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
707 * It is deduced from the AVStream values.
712 * Decoding: duration of the stream, in AV_TIME_BASE fractional
713 * seconds. Only set this value if you know none of the individual stream
714 * durations and also dont set any of them. This is deduced from the
715 * AVStream values if not set.
721 * decoding: total file size, 0 if unknown
723 attribute_deprecated int64_t file_size;
727 * Decoding: total stream bitrate in bit/s, 0 if not
728 * available. Never set it directly if the file_size and the
729 * duration are known as Libav can compute it automatically.
733 /* av_read_frame() support */
736 /* av_seek_frame() support */
737 int64_t data_offset; /**< offset of the first packet */
741 * use mpeg muxer private options instead
743 attribute_deprecated int mux_rate;
745 unsigned int packet_size;
747 attribute_deprecated int preload;
751 #if FF_API_LOOP_OUTPUT
752 #define AVFMT_NOOUTPUTLOOP -1
753 #define AVFMT_INFINITEOUTPUTLOOP 0
755 * number of times to loop output in formats that support it
757 * @deprecated use the 'loop' private option in the gif muxer.
759 attribute_deprecated int loop_output;
763 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
764 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
765 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
766 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
767 #define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
768 #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
769 #if FF_API_FLAG_RTP_HINT
770 #define AVFMT_FLAG_RTP_HINT 0x0040 ///< Deprecated, use the -movflags rtphint muxer specific AVOption instead
772 #define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
773 #define AVFMT_FLAG_DISCARD_CORRUPT 0x0100 ///< Discard frames marked corrupted
775 #if FF_API_LOOP_INPUT
777 * @deprecated, use the 'loop' img2 demuxer private option.
779 attribute_deprecated int loop_input;
783 * decoding: size of data to probe; encoding: unused.
785 unsigned int probesize;
788 * Maximum time (in AV_TIME_BASE units) during which the input should
789 * be analyzed in av_find_stream_info().
791 int max_analyze_duration;
796 unsigned int nb_programs;
797 AVProgram **programs;
800 * Forced video codec_id.
801 * Demuxing: Set by user.
803 enum CodecID video_codec_id;
806 * Forced audio codec_id.
807 * Demuxing: Set by user.
809 enum CodecID audio_codec_id;
812 * Forced subtitle codec_id.
813 * Demuxing: Set by user.
815 enum CodecID subtitle_codec_id;
818 * Maximum amount of memory in bytes to use for the index of each stream.
819 * If the index exceeds this size, entries will be discarded as
820 * needed to maintain a smaller size. This can lead to slower or less
821 * accurate seeking (depends on demuxer).
822 * Demuxers for which a full in-memory index is mandatory will ignore
825 * demuxing: set by user
827 unsigned int max_index_size;
830 * Maximum amount of memory in bytes to use for buffering frames
831 * obtained from realtime capture devices.
833 unsigned int max_picture_buffer;
835 unsigned int nb_chapters;
836 AVChapter **chapters;
839 * Flags to enable debugging.
842 #define FF_FDEBUG_TS 0x0001
845 * Raw packets from the demuxer, prior to parsing and decoding.
846 * This buffer is used for buffering packets until the codec can
847 * be identified, as parsing cannot be done without knowing the
850 struct AVPacketList *raw_packet_buffer;
851 struct AVPacketList *raw_packet_buffer_end;
853 struct AVPacketList *packet_buffer_end;
855 AVDictionary *metadata;
858 * Remaining size available for raw_packet_buffer, in bytes.
859 * NOT PART OF PUBLIC API
861 #define RAW_PACKET_BUFFER_SIZE 2500000
862 int raw_packet_buffer_remaining_size;
865 * Start time of the stream in real world time, in microseconds
866 * since the unix epoch (00:00 1st January 1970). That is, pts=0
867 * in the stream was captured at this real world time.
868 * - encoding: Set by user.
869 * - decoding: Unused.
871 int64_t start_time_realtime;
874 * decoding: number of frames used to probe fps
879 * Error recognition; higher values will detect more errors but may
880 * misdetect some more or less valid parts as errors.
882 * - decoding: Set by user.
884 int error_recognition;
887 typedef struct AVPacketList {
889 struct AVPacketList *next;
893 * If f is NULL, returns the first registered input format,
894 * if f is non-NULL, returns the next registered input format after f
895 * or NULL if f is the last one.
897 AVInputFormat *av_iformat_next(AVInputFormat *f);
900 * If f is NULL, returns the first registered output format,
901 * if f is non-NULL, returns the next registered output format after f
902 * or NULL if f is the last one.
904 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
906 #if FF_API_GUESS_IMG2_CODEC
907 attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
910 /* XXX: Use automatic init with either ELF sections or C file parser */
914 void av_register_input_format(AVInputFormat *format);
915 void av_register_output_format(AVOutputFormat *format);
918 * Return the output format in the list of registered output formats
919 * which best matches the provided parameters, or return NULL if
922 * @param short_name if non-NULL checks if short_name matches with the
923 * names of the registered formats
924 * @param filename if non-NULL checks if filename terminates with the
925 * extensions of the registered formats
926 * @param mime_type if non-NULL checks if mime_type matches with the
927 * MIME type of the registered formats
929 AVOutputFormat *av_guess_format(const char *short_name,
930 const char *filename,
931 const char *mime_type);
934 * Guess the codec ID based upon muxer and filename.
936 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
937 const char *filename, const char *mime_type,
938 enum AVMediaType type);
941 * Send a nice hexadecimal dump of a buffer to the specified file stream.
943 * @param f The file stream pointer where the dump should be sent to.
945 * @param size buffer size
947 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
949 void av_hex_dump(FILE *f, uint8_t *buf, int size);
952 * Send a nice hexadecimal dump of a buffer to the log.
954 * @param avcl A pointer to an arbitrary struct of which the first field is a
955 * pointer to an AVClass struct.
956 * @param level The importance level of the message, lower values signifying
959 * @param size buffer size
961 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
963 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
966 * Send a nice dump of a packet to the specified file stream.
968 * @param f The file stream pointer where the dump should be sent to.
969 * @param pkt packet to dump
970 * @param dump_payload True if the payload must be displayed, too.
971 * @param st AVStream that the packet belongs to
973 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
977 * Send a nice dump of a packet to the log.
979 * @param avcl A pointer to an arbitrary struct of which the first field is a
980 * pointer to an AVClass struct.
981 * @param level The importance level of the message, lower values signifying
983 * @param pkt packet to dump
984 * @param dump_payload True if the payload must be displayed, too.
985 * @param st AVStream that the packet belongs to
987 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
991 attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
992 attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
997 * Initialize libavformat and register all the muxers, demuxers and
998 * protocols. If you do not call this function, then you can select
999 * exactly which formats you want to support.
1001 * @see av_register_input_format()
1002 * @see av_register_output_format()
1003 * @see av_register_protocol()
1005 void av_register_all(void);
1008 * Get the CodecID for the given codec tag tag.
1009 * If no codec id is found returns CODEC_ID_NONE.
1011 * @param tags list of supported codec_id-codec_tag pairs, as stored
1012 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1014 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1017 * Get the codec tag for the given codec id id.
1018 * If no codec tag is found returns 0.
1020 * @param tags list of supported codec_id-codec_tag pairs, as stored
1021 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1023 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1025 /* media file input */
1028 * Find AVInputFormat based on the short name of the input format.
1030 AVInputFormat *av_find_input_format(const char *short_name);
1033 * Guess the file format.
1035 * @param is_opened Whether the file is already opened; determines whether
1036 * demuxers with or without AVFMT_NOFILE are probed.
1038 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1041 * Guess the file format.
1043 * @param is_opened Whether the file is already opened; determines whether
1044 * demuxers with or without AVFMT_NOFILE are probed.
1045 * @param score_max A probe score larger that this is required to accept a
1046 * detection, the variable is set to the actual detection
1048 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1049 * to retry with a larger probe buffer.
1051 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1054 * Probe a bytestream to determine the input format. Each time a probe returns
1055 * with a score that is too low, the probe buffer size is increased and another
1056 * attempt is made. When the maximum probe size is reached, the input format
1057 * with the highest score is returned.
1059 * @param pb the bytestream to probe
1060 * @param fmt the input format is put here
1061 * @param filename the filename of the stream
1062 * @param logctx the log context
1063 * @param offset the offset within the bytestream to probe from
1064 * @param max_probe_size the maximum probe buffer size (zero for default)
1065 * @return 0 in case of success, a negative value corresponding to an
1066 * AVERROR code otherwise
1068 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1069 const char *filename, void *logctx,
1070 unsigned int offset, unsigned int max_probe_size);
1072 #if FF_API_FORMAT_PARAMETERS
1074 * Allocate all the structures needed to read an input stream.
1075 * This does not open the needed codecs for decoding the stream[s].
1076 * @deprecated use avformat_open_input instead.
1078 attribute_deprecated int av_open_input_stream(AVFormatContext **ic_ptr,
1079 AVIOContext *pb, const char *filename,
1080 AVInputFormat *fmt, AVFormatParameters *ap);
1083 * Open a media file as input. The codecs are not opened. Only the file
1084 * header (if present) is read.
1086 * @param ic_ptr The opened media file handle is put here.
1087 * @param filename filename to open
1088 * @param fmt If non-NULL, force the file format to use.
1089 * @param buf_size optional buffer size (zero if default is OK)
1090 * @param ap Additional parameters needed when opening the file
1091 * (NULL if default).
1092 * @return 0 if OK, AVERROR_xxx otherwise
1094 * @deprecated use avformat_open_input instead.
1096 attribute_deprecated int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1099 AVFormatParameters *ap);
1103 * Open an input stream and read the header. The codecs are not opened.
1104 * The stream must be closed with av_close_input_file().
1106 * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1107 * May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1108 * function and written into ps.
1109 * Note that a user-supplied AVFormatContext will be freed on failure.
1110 * @param filename Name of the stream to open.
1111 * @param fmt If non-NULL, this parameter forces a specific input format.
1112 * Otherwise the format is autodetected.
1113 * @param options A dictionary filled with AVFormatContext and demuxer-private options.
1114 * On return this parameter will be destroyed and replaced with a dict containing
1115 * options that were not found. May be NULL.
1117 * @return 0 on success, a negative AVERROR on failure.
1119 * @note If you want to use custom IO, preallocate the format context and set its pb field.
1121 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1124 * Allocate an AVFormatContext.
1125 * avformat_free_context() can be used to free the context and everything
1126 * allocated by the framework within it.
1128 AVFormatContext *avformat_alloc_context(void);
1130 #if FF_API_FORMAT_PARAMETERS
1132 * Read packets of a media file to get stream information. This
1133 * is useful for file formats with no headers such as MPEG. This
1134 * function also computes the real framerate in case of MPEG-2 repeat
1136 * The logical file position is not changed by this function;
1137 * examined packets may be buffered for later processing.
1139 * @param ic media file handle
1140 * @return >=0 if OK, AVERROR_xxx on error
1141 * @todo Let the user decide somehow what information is needed so that
1142 * we do not waste time getting stuff the user does not need.
1144 * @deprecated use avformat_find_stream_info.
1146 attribute_deprecated
1147 int av_find_stream_info(AVFormatContext *ic);
1151 * Read packets of a media file to get stream information. This
1152 * is useful for file formats with no headers such as MPEG. This
1153 * function also computes the real framerate in case of MPEG-2 repeat
1155 * The logical file position is not changed by this function;
1156 * examined packets may be buffered for later processing.
1158 * @param ic media file handle
1159 * @param options If non-NULL, an ic.nb_streams long array of pointers to
1160 * dictionaries, where i-th member contains options for
1161 * codec corresponding to i-th stream.
1162 * On return each dictionary will be filled with options that were not found.
1163 * @return >=0 if OK, AVERROR_xxx on error
1165 * @note this function isn't guaranteed to open all the codecs, so
1166 * options being non-empty at return is a perfectly normal behavior.
1168 * @todo Let the user decide somehow what information is needed so that
1169 * we do not waste time getting stuff the user does not need.
1171 int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
1174 * Find the "best" stream in the file.
1175 * The best stream is determined according to various heuristics as the most
1176 * likely to be what the user expects.
1177 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1178 * default decoder for the stream's codec; streams for which no decoder can
1179 * be found are ignored.
1181 * @param ic media file handle
1182 * @param type stream type: video, audio, subtitles, etc.
1183 * @param wanted_stream_nb user-requested stream number,
1184 * or -1 for automatic selection
1185 * @param related_stream try to find a stream related (eg. in the same
1186 * program) to this one, or -1 if none
1187 * @param decoder_ret if non-NULL, returns the decoder for the
1189 * @param flags flags; none are currently defined
1190 * @return the non-negative stream number in case of success,
1191 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1193 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1194 * @note If av_find_best_stream returns successfully and decoder_ret is not
1195 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1197 int av_find_best_stream(AVFormatContext *ic,
1198 enum AVMediaType type,
1199 int wanted_stream_nb,
1201 AVCodec **decoder_ret,
1205 * Read a transport packet from a media file.
1207 * This function is obsolete and should never be used.
1208 * Use av_read_frame() instead.
1210 * @param s media file handle
1211 * @param pkt is filled
1212 * @return 0 if OK, AVERROR_xxx on error
1214 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1217 * Return the next frame of a stream.
1218 * This function returns what is stored in the file, and does not validate
1219 * that what is there are valid frames for the decoder. It will split what is
1220 * stored in the file into frames and return one for each call. It will not
1221 * omit invalid data between valid frames so as to give the decoder the maximum
1222 * information possible for decoding.
1224 * The returned packet is valid
1225 * until the next av_read_frame() or until av_close_input_file() and
1226 * must be freed with av_free_packet. For video, the packet contains
1227 * exactly one frame. For audio, it contains an integer number of
1228 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1229 * data). If the audio frames have a variable size (e.g. MPEG audio),
1230 * then it contains one frame.
1232 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1233 * values in AVStream.time_base units (and guessed if the format cannot
1234 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1235 * has B-frames, so it is better to rely on pkt->dts if you do not
1236 * decompress the payload.
1238 * @return 0 if OK, < 0 on error or end of file
1240 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1243 * Seek to the keyframe at timestamp.
1244 * 'timestamp' in 'stream_index'.
1245 * @param stream_index If stream_index is (-1), a default
1246 * stream is selected, and timestamp is automatically converted
1247 * from AV_TIME_BASE units to the stream specific time_base.
1248 * @param timestamp Timestamp in AVStream.time_base units
1249 * or, if no stream is specified, in AV_TIME_BASE units.
1250 * @param flags flags which select direction and seeking mode
1251 * @return >= 0 on success
1253 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1257 * Seek to timestamp ts.
1258 * Seeking will be done so that the point from which all active streams
1259 * can be presented successfully will be closest to ts and within min/max_ts.
1260 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1262 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1263 * are the file position (this may not be supported by all demuxers).
1264 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1265 * in the stream with stream_index (this may not be supported by all demuxers).
1266 * Otherwise all timestamps are in units of the stream selected by stream_index
1267 * or if stream_index is -1, in AV_TIME_BASE units.
1268 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1269 * keyframes (this may not be supported by all demuxers).
1271 * @param stream_index index of the stream which is used as time base reference
1272 * @param min_ts smallest acceptable timestamp
1273 * @param ts target timestamp
1274 * @param max_ts largest acceptable timestamp
1275 * @param flags flags
1276 * @return >=0 on success, error code otherwise
1278 * @note This is part of the new seek API which is still under construction.
1279 * Thus do not use this yet. It may change at any time, do not expect
1280 * ABI compatibility yet!
1282 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1285 * Start playing a network-based stream (e.g. RTSP stream) at the
1288 int av_read_play(AVFormatContext *s);
1291 * Pause a network-based stream (e.g. RTSP stream).
1293 * Use av_read_play() to resume it.
1295 int av_read_pause(AVFormatContext *s);
1298 * Free a AVFormatContext allocated by av_open_input_stream.
1299 * @param s context to free
1301 void av_close_input_stream(AVFormatContext *s);
1304 * Close a media file (but not its codecs).
1306 * @param s media file handle
1308 void av_close_input_file(AVFormatContext *s);
1311 * Free an AVFormatContext and all its streams.
1312 * @param s context to free
1314 void avformat_free_context(AVFormatContext *s);
1316 #if FF_API_NEW_STREAM
1318 * Add a new stream to a media file.
1320 * Can only be called in the read_header() function. If the flag
1321 * AVFMTCTX_NOHEADER is in the format context, then new streams
1322 * can be added in read_packet too.
1324 * @param s media file handle
1325 * @param id file-format-dependent stream ID
1327 attribute_deprecated
1328 AVStream *av_new_stream(AVFormatContext *s, int id);
1332 * Add a new stream to a media file.
1334 * When demuxing, it is called by the demuxer in read_header(). If the
1335 * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1336 * be called in read_packet().
1338 * When muxing, should be called by the user before avformat_write_header().
1340 * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1341 * will be initialized to use this codec. This is needed for e.g. codec-specific
1342 * defaults to be set, so codec should be provided if it is known.
1344 * @return newly created stream or NULL on error.
1346 AVStream *avformat_new_stream(AVFormatContext *s, AVCodec *c);
1348 AVProgram *av_new_program(AVFormatContext *s, int id);
1351 * Set the pts for a given stream. If the new values would be invalid
1352 * (<= 0), it leaves the AVStream unchanged.
1355 * @param pts_wrap_bits number of bits effectively used by the pts
1356 * (used for wrap control, 33 is the value for MPEG)
1357 * @param pts_num numerator to convert to seconds (MPEG: 1)
1358 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1360 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1361 unsigned int pts_num, unsigned int pts_den);
1363 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1364 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
1365 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
1366 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
1368 int av_find_default_stream_index(AVFormatContext *s);
1371 * Get the index for a specific timestamp.
1372 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1373 * to the timestamp which is <= the requested one, if backward
1374 * is 0, then it will be >=
1375 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1376 * @return < 0 if no such timestamp could be found
1378 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1381 * Add an index entry into a sorted list. Update the entry if the list
1382 * already contains it.
1384 * @param timestamp timestamp in the time base of the given stream
1386 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1387 int size, int distance, int flags);
1390 * Perform a binary search using av_index_search_timestamp() and
1391 * AVInputFormat.read_timestamp().
1392 * This is not supposed to be called directly by a user application,
1394 * @param target_ts target timestamp in the time base of the given stream
1395 * @param stream_index stream number
1397 int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1398 int64_t target_ts, int flags);
1401 * Update cur_dts of all streams based on the given timestamp and AVStream.
1403 * Stream ref_st unchanged, others set cur_dts in their native time base.
1404 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1405 * @param timestamp new dts expressed in time_base of param ref_st
1406 * @param ref_st reference stream giving time_base of param timestamp
1408 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1411 * Perform a binary search using read_timestamp().
1412 * This is not supposed to be called directly by a user application,
1414 * @param target_ts target timestamp in the time base of the given stream
1415 * @param stream_index stream number
1417 int64_t av_gen_search(AVFormatContext *s, int stream_index,
1418 int64_t target_ts, int64_t pos_min,
1419 int64_t pos_max, int64_t pos_limit,
1420 int64_t ts_min, int64_t ts_max,
1421 int flags, int64_t *ts_ret,
1422 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1427 #if FF_API_FORMAT_PARAMETERS
1429 * @deprecated pass the options to avformat_write_header directly.
1431 attribute_deprecated int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1435 * Split a URL string into components.
1437 * The pointers to buffers for storing individual components may be null,
1438 * in order to ignore that component. Buffers for components not found are
1439 * set to empty strings. If the port is not found, it is set to a negative
1442 * @param proto the buffer for the protocol
1443 * @param proto_size the size of the proto buffer
1444 * @param authorization the buffer for the authorization
1445 * @param authorization_size the size of the authorization buffer
1446 * @param hostname the buffer for the host name
1447 * @param hostname_size the size of the hostname buffer
1448 * @param port_ptr a pointer to store the port number in
1449 * @param path the buffer for the path
1450 * @param path_size the size of the path buffer
1451 * @param url the URL to split
1453 void av_url_split(char *proto, int proto_size,
1454 char *authorization, int authorization_size,
1455 char *hostname, int hostname_size,
1457 char *path, int path_size,
1461 * Allocate the stream private data and write the stream header to
1462 * an output media file.
1464 * @param s Media file handle, must be allocated with avformat_alloc_context().
1465 * Its oformat field must be set to the desired output format;
1466 * Its pb field must be set to an already openened AVIOContext.
1467 * @param options An AVDictionary filled with AVFormatContext and muxer-private options.
1468 * On return this parameter will be destroyed and replaced with a dict containing
1469 * options that were not found. May be NULL.
1471 * @return 0 on success, negative AVERROR on failure.
1473 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1475 int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1477 #if FF_API_FORMAT_PARAMETERS
1479 * Allocate the stream private data and write the stream header to an
1480 * output media file.
1481 * @note: this sets stream time-bases, if possible to stream->codec->time_base
1482 * but for some formats it might also be some other time base
1484 * @param s media file handle
1485 * @return 0 if OK, AVERROR_xxx on error
1487 * @deprecated use avformat_write_header.
1489 attribute_deprecated int av_write_header(AVFormatContext *s);
1493 * Write a packet to an output media file.
1495 * The packet shall contain one audio or video frame.
1496 * The packet must be correctly interleaved according to the container
1497 * specification, if not then av_interleaved_write_frame must be used.
1499 * @param s media file handle
1500 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1502 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1504 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1507 * Write a packet to an output media file ensuring correct interleaving.
1509 * The packet must contain one audio or video frame.
1510 * If the packets are already correctly interleaved, the application should
1511 * call av_write_frame() instead as it is slightly faster. It is also important
1512 * to keep in mind that completely non-interleaved input will need huge amounts
1513 * of memory to interleave with this, so it is preferable to interleave at the
1516 * @param s media file handle
1517 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1519 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1521 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1524 * Interleave a packet per dts in an output media file.
1526 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1527 * function, so they cannot be used after it. Note that calling av_free_packet()
1528 * on them is still safe.
1530 * @param s media file handle
1531 * @param out the interleaved packet will be output here
1532 * @param pkt the input packet
1533 * @param flush 1 if no further packets are available as input and all
1534 * remaining packets should be output
1535 * @return 1 if a packet was output, 0 if no packet could be output,
1536 * < 0 if an error occurred
1538 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1539 AVPacket *pkt, int flush);
1542 * Write the stream trailer to an output media file and free the
1543 * file private data.
1545 * May only be called after a successful call to av_write_header.
1547 * @param s media file handle
1548 * @return 0 if OK, AVERROR_xxx on error
1550 int av_write_trailer(AVFormatContext *s);
1552 #if FF_API_DUMP_FORMAT
1553 attribute_deprecated void dump_format(AVFormatContext *ic,
1559 void av_dump_format(AVFormatContext *ic,
1564 #if FF_API_PARSE_DATE
1566 * Parse datestr and return a corresponding number of microseconds.
1568 * @param datestr String representing a date or a duration.
1569 * See av_parse_time() for the syntax of the provided string.
1570 * @deprecated in favor of av_parse_time()
1572 attribute_deprecated
1573 int64_t parse_date(const char *datestr, int duration);
1577 * Get the current time in microseconds.
1579 int64_t av_gettime(void);
1581 #if FF_API_FIND_INFO_TAG
1583 * @deprecated use av_find_info_tag in libavutil instead.
1585 attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1589 * Return in 'buf' the path with '%d' replaced by a number.
1591 * Also handles the '%0nd' format where 'n' is the total number
1592 * of digits and '%%'.
1594 * @param buf destination buffer
1595 * @param buf_size destination buffer size
1596 * @param path numbered sequence string
1597 * @param number frame number
1598 * @return 0 if OK, -1 on format error
1600 int av_get_frame_filename(char *buf, int buf_size,
1601 const char *path, int number);
1604 * Check whether filename actually is a numbered sequence generator.
1606 * @param filename possible numbered sequence string
1607 * @return 1 if a valid numbered sequence string, 0 otherwise
1609 int av_filename_number_test(const char *filename);
1612 * Generate an SDP for an RTP session.
1614 * @param ac array of AVFormatContexts describing the RTP streams. If the
1615 * array is composed by only one context, such context can contain
1616 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1617 * all the contexts in the array (an AVCodecContext per RTP stream)
1618 * must contain only one AVStream.
1619 * @param n_files number of AVCodecContexts contained in ac
1620 * @param buf buffer where the SDP will be stored (must be allocated by
1622 * @param size the size of the buffer
1623 * @return 0 if OK, AVERROR_xxx on error
1625 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1627 #if FF_API_SDP_CREATE
1628 attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1632 * Return a positive value if the given filename has one of the given
1633 * extensions, 0 otherwise.
1635 * @param extensions a comma-separated list of filename extensions
1637 int av_match_ext(const char *filename, const char *extensions);
1640 * Test if the given container can store a codec.
1642 * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
1644 * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
1645 * A negative number if this information is not available.
1647 int avformat_query_codec(AVOutputFormat *ofmt, enum CodecID codec_id, int std_compliance);
1650 * Get the AVClass for AVFormatContext. It can be used in combination with
1651 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1653 * @see av_opt_find().
1655 const AVClass *avformat_get_class(void);
1657 #endif /* AVFORMAT_AVFORMAT_H */