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 47
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 * I return the LIBAVFORMAT_VERSION_INT constant. You got
40 * a fucking problem with that, douchebag?
42 unsigned avformat_version(void);
45 * Returns the libavformat build-time configuration.
47 const char *avformat_configuration(void);
50 * Returns the libavformat license.
52 const char *avformat_license(void);
55 #include <stdio.h> /* FILE */
56 #include "libavcodec/avcodec.h"
60 struct AVFormatContext;
64 * Public Metadata API.
65 * The metadata API allows libavformat to export metadata tags to a client
66 * application using a sequence of key/value pairs.
67 * Important concepts to keep in mind:
68 * 1. Keys are unique; there can never be 2 tags with the same key. This is
69 * also meant semantically, i.e., a demuxer should not knowingly produce
70 * several keys that are literally different but semantically identical.
71 * E.g., key=Author5, key=Author6. In this example, all authors must be
72 * placed in the same tag.
73 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
74 * want to store, e.g., the email address of the child of producer Alice
75 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
76 * 3. A tag whose value is localized for a particular language is appended
77 * with a dash character ('-') and the ISO 639-2/B 3-letter language code.
78 * For example: Author-ger=Michael, Author-eng=Mike
79 * The original/default language is in the unqualified "Author" tag.
80 * A demuxer should set a default if it sets any translated tag.
83 #define AV_METADATA_MATCH_CASE 1
84 #define AV_METADATA_IGNORE_SUFFIX 2
85 #define AV_METADATA_DONT_STRDUP_KEY 4
86 #define AV_METADATA_DONT_STRDUP_VAL 8
93 typedef struct AVMetadata AVMetadata;
94 typedef struct AVMetadataConv AVMetadataConv;
97 * Gets a metadata element with matching key.
98 * @param prev Set to the previous matching element to find the next.
99 * @param flags Allows case as well as suffix-insensitive comparisons.
100 * @return Found tag or NULL, changing key or value leads to undefined behavior.
103 av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
105 #if LIBAVFORMAT_VERSION_MAJOR == 52
107 * Sets the given tag in m, overwriting an existing tag.
108 * @param key tag key to add to m (will be av_strduped)
109 * @param value tag value to add to m (will be av_strduped)
110 * @return >= 0 on success otherwise an error code <0
112 int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
116 * Sets the given tag in m, overwriting an existing tag.
117 * @param key tag key to add to m (will be av_strduped depending on flags)
118 * @param value tag value to add to m (will be av_strduped depending on flags)
119 * @return >= 0 on success otherwise an error code <0
121 int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
124 * Converts all the metadata sets from ctx according to the source and
125 * destination conversion tables.
126 * @param d_conv destination tags format conversion table
127 * @param s_conv source tags format conversion table
129 void av_metadata_conv(struct AVFormatContext *ctx,const AVMetadataConv *d_conv,
130 const AVMetadataConv *s_conv);
133 * Frees all the memory allocated for an AVMetadata struct.
135 void av_metadata_free(AVMetadata **m);
138 /* packet functions */
142 * Allocates and reads the payload of a packet and initializes its
143 * fields with default values.
146 * @param size desired payload size
147 * @return >0 (read size) if OK, AVERROR_xxx otherwise
149 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
152 /*************************************************/
153 /* fractional numbers for exact pts handling */
156 * The exact value of the fractional number is: 'val + num / den'.
157 * num is assumed to be 0 <= num < den.
159 typedef struct AVFrac {
160 int64_t val, num, den;
163 /*************************************************/
164 /* input/output formats */
168 /** This structure contains the data a format has to probe a file. */
169 typedef struct AVProbeData {
170 const char *filename;
171 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
172 int buf_size; /**< Size of buf except extra allocated bytes */
175 #define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
176 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
178 typedef struct AVFormatParameters {
179 AVRational time_base;
184 enum PixelFormat pix_fmt;
185 int channel; /**< Used to select DV channel. */
186 const char *standard; /**< TV standard, NTSC, PAL, SECAM */
187 unsigned int mpeg2ts_raw:1; /**< Force raw MPEG-2 transport stream output, if possible. */
188 unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
189 stream packet (only meaningful if
190 mpeg2ts_raw is TRUE). */
191 unsigned int initial_pause:1; /**< Do not begin to play the stream
192 immediately (RTSP only). */
193 unsigned int prealloced_context:1;
194 #if LIBAVFORMAT_VERSION_INT < (53<<16)
195 enum CodecID video_codec_id;
196 enum CodecID audio_codec_id;
198 } AVFormatParameters;
200 //! Demuxer will use url_fopen, no opened file should be provided by the caller.
201 #define AVFMT_NOFILE 0x0001
202 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
203 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
204 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
206 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
207 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
208 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
209 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. */
210 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
212 typedef struct AVOutputFormat {
215 * Descriptive name for the format, meant to be more human-readable
216 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
219 const char *long_name;
220 const char *mime_type;
221 const char *extensions; /**< comma-separated filename extensions */
222 /** size of private data so that it can be allocated in the wrapper */
225 enum CodecID audio_codec; /**< default audio codec */
226 enum CodecID video_codec; /**< default video codec */
227 int (*write_header)(struct AVFormatContext *);
228 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
229 int (*write_trailer)(struct AVFormatContext *);
230 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
232 /** Currently only used to set pixel format if not YUV420P. */
233 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
234 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
235 AVPacket *in, int flush);
238 * List of supported codec_id-codec_tag pairs, ordered by "better
239 * choice first". The arrays are all terminated by CODEC_ID_NONE.
241 const struct AVCodecTag * const *codec_tag;
243 enum CodecID subtitle_codec; /**< default subtitle codec */
245 const AVMetadataConv *metadata_conv;
248 struct AVOutputFormat *next;
251 typedef struct AVInputFormat {
254 * Descriptive name for the format, meant to be more human-readable
255 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
258 const char *long_name;
259 /** Size of private data so that it can be allocated in the wrapper. */
262 * Tell if a given file has a chance of being parsed as this format.
263 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
264 * big so you do not have to check for that unless you need more.
266 int (*read_probe)(AVProbeData *);
267 /** Read the format header and initialize the AVFormatContext
268 structure. Return 0 if OK. 'ap' if non-NULL contains
269 additional parameters. Only used in raw format right
270 now. 'av_new_stream' should be called to create new streams. */
271 int (*read_header)(struct AVFormatContext *,
272 AVFormatParameters *ap);
273 /** Read one packet and put it in 'pkt'. pts and flags are also
274 set. 'av_new_stream' can be called only if the flag
275 AVFMTCTX_NOHEADER is used.
276 @return 0 on success, < 0 on error.
277 When returning an error, pkt must not have been allocated
278 or must be freed before returning */
279 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
280 /** Close the stream. The AVFormatContext and AVStreams are not
281 freed by this function */
282 int (*read_close)(struct AVFormatContext *);
284 #if LIBAVFORMAT_VERSION_MAJOR < 53
286 * Seek to a given timestamp relative to the frames in
287 * stream component stream_index.
288 * @param stream_index Must not be -1.
289 * @param flags Selects which direction should be preferred if no exact
290 * match is available.
291 * @return >= 0 on success (but not necessarily the new offset)
293 int (*read_seek)(struct AVFormatContext *,
294 int stream_index, int64_t timestamp, int flags);
297 * Gets the next timestamp in stream[stream_index].time_base units.
298 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
300 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
301 int64_t *pos, int64_t pos_limit);
302 /** Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER. */
304 /** If extensions are defined, then no probe is done. You should
305 usually not use extension format guessing because it is not
307 const char *extensions;
308 /** General purpose read-only value that the format can use. */
311 /** Starts/resumes playing - only meaningful if using a network-based format
313 int (*read_play)(struct AVFormatContext *);
315 /** Pauses playing - only meaningful if using a network-based format
317 int (*read_pause)(struct AVFormatContext *);
319 const struct AVCodecTag * const *codec_tag;
322 * Seeks to timestamp ts.
323 * Seeking will be done so that the point from which all active streams
324 * can be presented successfully will be closest to ts and within min/max_ts.
325 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
327 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
329 const AVMetadataConv *metadata_conv;
332 struct AVInputFormat *next;
335 enum AVStreamParseType {
337 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
338 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
339 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
342 typedef struct AVIndexEntry {
345 #define AVINDEX_KEYFRAME 0x0001
347 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).
348 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
351 #define AV_DISPOSITION_DEFAULT 0x0001
352 #define AV_DISPOSITION_DUB 0x0002
353 #define AV_DISPOSITION_ORIGINAL 0x0004
354 #define AV_DISPOSITION_COMMENT 0x0008
355 #define AV_DISPOSITION_LYRICS 0x0010
356 #define AV_DISPOSITION_KARAOKE 0x0020
360 * New fields can be added to the end with minor version bumps.
361 * Removal, reordering and changes to existing fields require a major
363 * sizeof(AVStream) must not be used outside libav*.
365 typedef struct AVStream {
366 int index; /**< stream index in AVFormatContext */
367 int id; /**< format-specific stream ID */
368 AVCodecContext *codec; /**< codec context */
370 * Real base framerate of the stream.
371 * This is the lowest framerate with which all timestamps can be
372 * represented accurately (it is the least common multiple of all
373 * framerates in the stream). Note, this value is just a guess!
374 * For example, if the time base is 1/90000 and all frames have either
375 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
377 AVRational r_frame_rate;
380 /* internal data used in av_find_stream_info() */
382 /** encoding: pts generation when outputting stream */
386 * This is the fundamental unit of time (in seconds) in terms
387 * of which frame timestamps are represented. For fixed-fps content,
388 * time base should be 1/framerate and timestamp increments should be 1.
390 AVRational time_base;
391 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
392 /* ffmpeg.c private use */
393 int stream_copy; /**< If set, just copy stream. */
394 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
395 //FIXME move stuff to a flags field?
396 /** Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
397 * MN: dunno if that is the right place for it */
400 * Decoding: pts of the first frame of the stream, in stream time base.
401 * Only set this if you are absolutely 100% sure that the value you set
402 * it to really is the pts of the first frame.
403 * This may be undefined (AV_NOPTS_VALUE).
404 * @note The ASF header does NOT contain a correct start_time the ASF
405 * demuxer must NOT set this.
409 * Decoding: duration of the stream, in stream time base.
410 * If a source file does not specify a duration, but does specify
411 * a bitrate, this value will be estimated from bitrate and file size.
415 #if LIBAVFORMAT_VERSION_INT < (53<<16)
416 char language[4]; /** ISO 639-2/B 3-letter language code (empty string if undefined) */
419 /* av_read_frame() support */
420 enum AVStreamParseType need_parsing;
421 struct AVCodecParserContext *parser;
424 int last_IP_duration;
426 /* av_seek_frame() support */
427 AVIndexEntry *index_entries; /**< Only used if the format does not
428 support seeking natively. */
429 int nb_index_entries;
430 unsigned int index_entries_allocated_size;
432 int64_t nb_frames; ///< number of frames in this stream if known or 0
434 #if LIBAVFORMAT_VERSION_INT < (53<<16)
437 char *filename; /**< source filename of the stream */
440 int disposition; /**< AV_DISPOSITION_* bit field */
442 AVProbeData probe_data;
443 #define MAX_REORDER_DELAY 16
444 int64_t pts_buffer[MAX_REORDER_DELAY+1];
447 * sample aspect ratio (0 if unknown)
448 * - encoding: Set by user.
449 * - decoding: Set by libavformat.
451 AVRational sample_aspect_ratio;
453 AVMetadata *metadata;
455 /* av_read_frame() support */
456 const uint8_t *cur_ptr;
460 // Timestamp generation support:
462 * Timestamp corresponding to the last dts sync point.
464 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
465 * a DTS is received from the underlying container. Otherwise set to
466 * AV_NOPTS_VALUE by default.
468 int64_t reference_dts;
471 * Number of packets to buffer for codec probing
472 * NOT PART OF PUBLIC API
474 #define MAX_PROBE_PACKETS 2500
478 * last packet in packet_buffer for this stream when muxing.
479 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
481 struct AVPacketList *last_in_packet_buffer;
486 AVRational avg_frame_rate;
489 #define AV_PROGRAM_RUNNING 1
492 * New fields can be added to the end with minor version bumps.
493 * Removal, reordering and changes to existing fields require a major
495 * sizeof(AVProgram) must not be used outside libav*.
497 typedef struct AVProgram {
499 #if LIBAVFORMAT_VERSION_INT < (53<<16)
500 char *provider_name; ///< network name for DVB streams
501 char *name; ///< service name for DVB streams
504 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
505 unsigned int *stream_index;
506 unsigned int nb_stream_indexes;
507 AVMetadata *metadata;
510 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
511 (streams are added dynamically) */
513 typedef struct AVChapter {
514 int id; ///< unique ID to identify the chapter
515 AVRational time_base; ///< time base in which the start/end timestamps are specified
516 int64_t start, end; ///< chapter start/end time in time_base units
517 #if LIBAVFORMAT_VERSION_INT < (53<<16)
518 char *title; ///< chapter title
520 AVMetadata *metadata;
523 #if LIBAVFORMAT_VERSION_MAJOR < 53
524 #define MAX_STREAMS 20
526 #define MAX_STREAMS 100
530 * Format I/O context.
531 * New fields can be added to the end with minor version bumps.
532 * Removal, reordering and changes to existing fields require a major
534 * sizeof(AVFormatContext) must not be used outside libav*.
536 typedef struct AVFormatContext {
537 const AVClass *av_class; /**< Set by avformat_alloc_context. */
538 /* Can only be iformat or oformat, not both at the same time. */
539 struct AVInputFormat *iformat;
540 struct AVOutputFormat *oformat;
543 unsigned int nb_streams;
544 AVStream *streams[MAX_STREAMS];
545 char filename[1024]; /**< input or output filename */
548 #if LIBAVFORMAT_VERSION_INT < (53<<16)
554 int year; /**< ID3 year, 0 if none */
555 int track; /**< track number, 0 if none */
556 char genre[32]; /**< ID3 genre */
559 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
560 /* private data for pts handling (do not modify directly). */
561 /** This buffer is only needed when packets were already buffered but
562 not decoded, for example to get the codec parameters in MPEG
564 struct AVPacketList *packet_buffer;
566 /** Decoding: position of the first frame of the component, in
567 AV_TIME_BASE fractional seconds. NEVER set this value directly:
568 It is deduced from the AVStream values. */
570 /** Decoding: duration of the stream, in AV_TIME_BASE fractional
571 seconds. NEVER set this value directly: it is deduced from the
574 /** decoding: total file size, 0 if unknown */
576 /** Decoding: total stream bitrate in bit/s, 0 if not
577 available. Never set it directly if the file_size and the
578 duration are known as FFmpeg can compute it automatically. */
581 /* av_read_frame() support */
583 #if LIBAVFORMAT_VERSION_INT < (53<<16)
584 const uint8_t *cur_ptr_deprecated;
585 int cur_len_deprecated;
586 AVPacket cur_pkt_deprecated;
589 /* av_seek_frame() support */
590 int64_t data_offset; /** offset of the first packet */
594 unsigned int packet_size;
598 #define AVFMT_NOOUTPUTLOOP -1
599 #define AVFMT_INFINITEOUTPUTLOOP 0
600 /** number of times to loop output in formats that support it */
604 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
605 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
606 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
609 /** decoding: size of data to probe; encoding: unused. */
610 unsigned int probesize;
613 * Maximum time (in AV_TIME_BASE units) during which the input should
614 * be analyzed in av_find_stream_info().
616 int max_analyze_duration;
621 unsigned int nb_programs;
622 AVProgram **programs;
625 * Forced video codec_id.
626 * Demuxing: Set by user.
628 enum CodecID video_codec_id;
630 * Forced audio codec_id.
631 * Demuxing: Set by user.
633 enum CodecID audio_codec_id;
635 * Forced subtitle codec_id.
636 * Demuxing: Set by user.
638 enum CodecID subtitle_codec_id;
641 * Maximum amount of memory in bytes to use for the index of each stream.
642 * If the index exceeds this size, entries will be discarded as
643 * needed to maintain a smaller size. This can lead to slower or less
644 * accurate seeking (depends on demuxer).
645 * Demuxers for which a full in-memory index is mandatory will ignore
648 * demuxing: set by user
650 unsigned int max_index_size;
653 * Maximum amount of memory in bytes to use for buffering frames
654 * obtained from realtime capture devices.
656 unsigned int max_picture_buffer;
658 unsigned int nb_chapters;
659 AVChapter **chapters;
662 * Flags to enable debugging.
665 #define FF_FDEBUG_TS 0x0001
668 * Raw packets from the demuxer, prior to parsing and decoding.
669 * This buffer is used for buffering packets until the codec can
670 * be identified, as parsing cannot be done without knowing the
673 struct AVPacketList *raw_packet_buffer;
674 struct AVPacketList *raw_packet_buffer_end;
676 struct AVPacketList *packet_buffer_end;
678 AVMetadata *metadata;
681 * Remaining size available for raw_packet_buffer, in bytes.
682 * NOT PART OF PUBLIC API
684 #define RAW_PACKET_BUFFER_SIZE 2500000
685 int raw_packet_buffer_remaining_size;
688 typedef struct AVPacketList {
690 struct AVPacketList *next;
693 #if LIBAVFORMAT_VERSION_INT < (53<<16)
694 extern AVInputFormat *first_iformat;
695 extern AVOutputFormat *first_oformat;
699 * If f is NULL, returns the first registered input format,
700 * if f is non-NULL, returns the next registered input format after f
701 * or NULL if f is the last one.
703 AVInputFormat *av_iformat_next(AVInputFormat *f);
706 * If f is NULL, returns the first registered output format,
707 * if f is non-NULL, returns the next registered output format after f
708 * or NULL if f is the last one.
710 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
712 enum CodecID av_guess_image2_codec(const char *filename);
714 /* XXX: Use automatic init with either ELF sections or C file parser */
718 void av_register_input_format(AVInputFormat *format);
719 void av_register_output_format(AVOutputFormat *format);
720 #if LIBAVFORMAT_VERSION_MAJOR < 53
721 attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
722 const char *filename,
723 const char *mime_type);
726 * @deprecated Use av_guess_format() instead.
728 attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
729 const char *filename,
730 const char *mime_type);
734 * Returns the output format in the list of registered output formats
735 * which best matches the provided parameters, or returns NULL if
738 * @param short_name if non-NULL checks if short_name matches with the
739 * names of the registered formats
740 * @param filename if non-NULL checks if filename terminates with the
741 * extensions of the registered formats
742 * @param mime_type if non-NULL checks if mime_type matches with the
743 * MIME type of the registered formats
745 AVOutputFormat *av_guess_format(const char *short_name,
746 const char *filename,
747 const char *mime_type);
750 * Guesses the codec ID based upon muxer and filename.
752 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
753 const char *filename, const char *mime_type,
754 enum CodecType type);
757 * Sends a nice hexadecimal dump of a buffer to the specified file stream.
759 * @param f The file stream pointer where the dump should be sent to.
761 * @param size buffer size
763 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
765 void av_hex_dump(FILE *f, uint8_t *buf, int size);
768 * Sends a nice hexadecimal dump of a buffer to the log.
770 * @param avcl A pointer to an arbitrary struct of which the first field is a
771 * pointer to an AVClass struct.
772 * @param level The importance level of the message, lower values signifying
775 * @param size buffer size
777 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
779 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
782 * Sends a nice dump of a packet to the specified file stream.
784 * @param f The file stream pointer where the dump should be sent to.
785 * @param pkt packet to dump
786 * @param dump_payload True if the payload must be displayed, too.
788 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
791 * Sends a nice dump of a packet to the log.
793 * @param avcl A pointer to an arbitrary struct of which the first field is a
794 * pointer to an AVClass struct.
795 * @param level The importance level of the message, lower values signifying
797 * @param pkt packet to dump
798 * @param dump_payload True if the payload must be displayed, too.
800 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
803 * Initializes libavformat and registers all the muxers, demuxers and
804 * protocols. If you do not call this function, then you can select
805 * exactly which formats you want to support.
807 * @see av_register_input_format()
808 * @see av_register_output_format()
809 * @see av_register_protocol()
811 void av_register_all(void);
813 /** codec tag <-> codec id */
814 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
815 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
817 /* media file input */
820 * Finds AVInputFormat based on the short name of the input format.
822 AVInputFormat *av_find_input_format(const char *short_name);
825 * Guesses the file format.
827 * @param is_opened Whether the file is already opened; determines whether
828 * demuxers with or without AVFMT_NOFILE are probed.
830 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
833 * Allocates all the structures needed to read an input stream.
834 * This does not open the needed codecs for decoding the stream[s].
836 int av_open_input_stream(AVFormatContext **ic_ptr,
837 ByteIOContext *pb, const char *filename,
838 AVInputFormat *fmt, AVFormatParameters *ap);
841 * Opens a media file as input. The codecs are not opened. Only the file
842 * header (if present) is read.
844 * @param ic_ptr The opened media file handle is put here.
845 * @param filename filename to open
846 * @param fmt If non-NULL, force the file format to use.
847 * @param buf_size optional buffer size (zero if default is OK)
848 * @param ap Additional parameters needed when opening the file
850 * @return 0 if OK, AVERROR_xxx otherwise
852 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
855 AVFormatParameters *ap);
857 #if LIBAVFORMAT_VERSION_MAJOR < 53
859 * @deprecated Use avformat_alloc_context() instead.
861 attribute_deprecated AVFormatContext *av_alloc_format_context(void);
865 * Allocates an AVFormatContext.
866 * Can be freed with av_free() but do not forget to free everything you
867 * explicitly allocated as well!
869 AVFormatContext *avformat_alloc_context(void);
872 * Reads packets of a media file to get stream information. This
873 * is useful for file formats with no headers such as MPEG. This
874 * function also computes the real framerate in case of MPEG-2 repeat
876 * The logical file position is not changed by this function;
877 * examined packets may be buffered for later processing.
879 * @param ic media file handle
880 * @return >=0 if OK, AVERROR_xxx on error
881 * @todo Let the user decide somehow what information is needed so that
882 * we do not waste time getting stuff the user does not need.
884 int av_find_stream_info(AVFormatContext *ic);
887 * Reads a transport packet from a media file.
889 * This function is obsolete and should never be used.
890 * Use av_read_frame() instead.
892 * @param s media file handle
893 * @param pkt is filled
894 * @return 0 if OK, AVERROR_xxx on error
896 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
899 * Returns the next frame of a stream.
901 * The returned packet is valid
902 * until the next av_read_frame() or until av_close_input_file() and
903 * must be freed with av_free_packet. For video, the packet contains
904 * exactly one frame. For audio, it contains an integer number of
905 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
906 * data). If the audio frames have a variable size (e.g. MPEG audio),
907 * then it contains one frame.
909 * pkt->pts, pkt->dts and pkt->duration are always set to correct
910 * values in AVStream.time_base units (and guessed if the format cannot
911 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
912 * has B-frames, so it is better to rely on pkt->dts if you do not
913 * decompress the payload.
915 * @return 0 if OK, < 0 on error or end of file
917 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
920 * Seeks to the keyframe at timestamp.
921 * 'timestamp' in 'stream_index'.
922 * @param stream_index If stream_index is (-1), a default
923 * stream is selected, and timestamp is automatically converted
924 * from AV_TIME_BASE units to the stream specific time_base.
925 * @param timestamp Timestamp in AVStream.time_base units
926 * or, if no stream is specified, in AV_TIME_BASE units.
927 * @param flags flags which select direction and seeking mode
928 * @return >= 0 on success
930 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
934 * Seeks to timestamp ts.
935 * Seeking will be done so that the point from which all active streams
936 * can be presented successfully will be closest to ts and within min/max_ts.
937 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
939 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
940 * are the file position (this may not be supported by all demuxers).
941 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
942 * in the stream with stream_index (this may not be supported by all demuxers).
943 * Otherwise all timestamps are in units of the stream selected by stream_index
944 * or if stream_index is -1, in AV_TIME_BASE units.
945 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
946 * keyframes (this may not be supported by all demuxers).
948 * @param stream_index index of the stream which is used as time base reference
949 * @param min_ts smallest acceptable timestamp
950 * @param ts target timestamp
951 * @param max_ts largest acceptable timestamp
953 * @returns >=0 on success, error code otherwise
955 * @NOTE This is part of the new seek API which is still under construction.
956 * Thus do not use this yet. It may change at any time, do not expect
957 * ABI compatibility yet!
959 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
962 * Starts playing a network-based stream (e.g. RTSP stream) at the
965 int av_read_play(AVFormatContext *s);
968 * Pauses a network-based stream (e.g. RTSP stream).
970 * Use av_read_play() to resume it.
972 int av_read_pause(AVFormatContext *s);
975 * Frees a AVFormatContext allocated by av_open_input_stream.
976 * @param s context to free
978 void av_close_input_stream(AVFormatContext *s);
981 * Closes a media file (but not its codecs).
983 * @param s media file handle
985 void av_close_input_file(AVFormatContext *s);
988 * Adds a new stream to a media file.
990 * Can only be called in the read_header() function. If the flag
991 * AVFMTCTX_NOHEADER is in the format context, then new streams
992 * can be added in read_packet too.
994 * @param s media file handle
995 * @param id file-format-dependent stream ID
997 AVStream *av_new_stream(AVFormatContext *s, int id);
998 AVProgram *av_new_program(AVFormatContext *s, int id);
1001 * Adds a new chapter.
1002 * This function is NOT part of the public API
1003 * and should ONLY be used by demuxers.
1005 * @param s media file handle
1006 * @param id unique ID for this chapter
1007 * @param start chapter start time in time_base units
1008 * @param end chapter end time in time_base units
1009 * @param title chapter title
1011 * @return AVChapter or NULL on error
1013 AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1014 int64_t start, int64_t end, const char *title);
1017 * Sets the pts for a given stream.
1020 * @param pts_wrap_bits number of bits effectively used by the pts
1021 * (used for wrap control, 33 is the value for MPEG)
1022 * @param pts_num numerator to convert to seconds (MPEG: 1)
1023 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1025 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1026 unsigned int pts_num, unsigned int pts_den);
1028 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1029 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
1030 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
1031 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
1033 int av_find_default_stream_index(AVFormatContext *s);
1036 * Gets the index for a specific timestamp.
1037 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1038 * to the timestamp which is <= the requested one, if backward
1039 * is 0, then it will be >=
1040 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1041 * @return < 0 if no such timestamp could be found
1043 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1046 * Ensures the index uses less memory than the maximum specified in
1047 * AVFormatContext.max_index_size by discarding entries if it grows
1049 * This function is not part of the public API and should only be called
1052 void ff_reduce_index(AVFormatContext *s, int stream_index);
1055 * Adds an index entry into a sorted list. Updates the entry if the list
1056 * already contains it.
1058 * @param timestamp timestamp in the time base of the given stream
1060 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1061 int size, int distance, int flags);
1064 * Does a binary search using av_index_search_timestamp() and
1065 * AVCodec.read_timestamp().
1066 * This is not supposed to be called directly by a user application,
1068 * @param target_ts target timestamp in the time base of the given stream
1069 * @param stream_index stream number
1071 int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1072 int64_t target_ts, int flags);
1075 * Updates cur_dts of all streams based on the given timestamp and AVStream.
1077 * Stream ref_st unchanged, others set cur_dts in their native time base.
1078 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1079 * @param timestamp new dts expressed in time_base of param ref_st
1080 * @param ref_st reference stream giving time_base of param timestamp
1082 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1085 * Does a binary search using read_timestamp().
1086 * This is not supposed to be called directly by a user application,
1088 * @param target_ts target timestamp in the time base of the given stream
1089 * @param stream_index stream number
1091 int64_t av_gen_search(AVFormatContext *s, int stream_index,
1092 int64_t target_ts, int64_t pos_min,
1093 int64_t pos_max, int64_t pos_limit,
1094 int64_t ts_min, int64_t ts_max,
1095 int flags, int64_t *ts_ret,
1096 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1098 /** media file output */
1099 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1102 * Allocates the stream private data and writes the stream header to an
1103 * output media file.
1105 * @param s media file handle
1106 * @return 0 if OK, AVERROR_xxx on error
1108 int av_write_header(AVFormatContext *s);
1111 * Writes a packet to an output media file.
1113 * The packet shall contain one audio or video frame.
1114 * The packet must be correctly interleaved according to the container
1115 * specification, if not then av_interleaved_write_frame must be used.
1117 * @param s media file handle
1118 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1120 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1122 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1125 * Writes a packet to an output media file ensuring correct interleaving.
1127 * The packet must contain one audio or video frame.
1128 * If the packets are already correctly interleaved, the application should
1129 * call av_write_frame() instead as it is slightly faster. It is also important
1130 * to keep in mind that completely non-interleaved input will need huge amounts
1131 * of memory to interleave with this, so it is preferable to interleave at the
1134 * @param s media file handle
1135 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1137 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1139 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1142 * Interleaves a packet per dts in an output media file.
1144 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1145 * function, so they cannot be used after it. Note that calling av_free_packet()
1146 * on them is still safe.
1148 * @param s media file handle
1149 * @param out the interleaved packet will be output here
1150 * @param in the input packet
1151 * @param flush 1 if no further packets are available as input and all
1152 * remaining packets should be output
1153 * @return 1 if a packet was output, 0 if no packet could be output,
1154 * < 0 if an error occurred
1156 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1157 AVPacket *pkt, int flush);
1160 * Writes the stream trailer to an output media file and frees the
1161 * file private data.
1163 * May only be called after a successful call to av_write_header.
1165 * @param s media file handle
1166 * @return 0 if OK, AVERROR_xxx on error
1168 int av_write_trailer(AVFormatContext *s);
1170 void dump_format(AVFormatContext *ic,
1175 #if LIBAVFORMAT_VERSION_MAJOR < 53
1177 * Parses width and height out of string str.
1178 * @deprecated Use av_parse_video_frame_size instead.
1180 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1184 * Converts framerate from a string to a fraction.
1185 * @deprecated Use av_parse_video_frame_rate instead.
1187 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1192 * Parses datestr and returns a corresponding number of microseconds.
1193 * @param datestr String representing a date or a duration.
1194 * - If a date the syntax is:
1196 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
1198 * Time is local time unless Z is appended, in which case it is
1199 * interpreted as UTC.
1200 * If the year-month-day part is not specified it takes the current
1202 * Returns the number of microseconds since 1st of January, 1970 up to
1203 * the time of the parsed date or INT64_MIN if datestr cannot be
1204 * successfully parsed.
1205 * - If a duration the syntax is:
1207 * [-]HH[:MM[:SS[.m...]]]
1210 * Returns the number of microseconds contained in a time interval
1211 * with the specified duration or INT64_MIN if datestr cannot be
1212 * successfully parsed.
1213 * @param duration Flag which tells how to interpret datestr, if
1214 * not zero datestr is interpreted as a duration, otherwise as a
1217 int64_t parse_date(const char *datestr, int duration);
1219 /** Gets the current time in microseconds. */
1220 int64_t av_gettime(void);
1222 /* ffm-specific for ffserver */
1223 #define FFM_PACKET_SIZE 4096
1224 int64_t ffm_read_write_index(int fd);
1225 int ffm_write_write_index(int fd, int64_t pos);
1226 void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1229 * Attempts to find a specific tag in a URL.
1231 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1232 * Return 1 if found.
1234 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1237 * Returns in 'buf' the path with '%d' replaced by a number.
1239 * Also handles the '%0nd' format where 'n' is the total number
1240 * of digits and '%%'.
1242 * @param buf destination buffer
1243 * @param buf_size destination buffer size
1244 * @param path numbered sequence string
1245 * @param number frame number
1246 * @return 0 if OK, -1 on format error
1248 int av_get_frame_filename(char *buf, int buf_size,
1249 const char *path, int number);
1252 * Checks whether filename actually is a numbered sequence generator.
1254 * @param filename possible numbered sequence string
1255 * @return 1 if a valid numbered sequence string, 0 otherwise
1257 int av_filename_number_test(const char *filename);
1260 * Generates an SDP for an RTP session.
1262 * @param ac array of AVFormatContexts describing the RTP streams. If the
1263 * array is composed by only one context, such context can contain
1264 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1265 * all the contexts in the array (an AVCodecContext per RTP stream)
1266 * must contain only one AVStream.
1267 * @param n_files number of AVCodecContexts contained in ac
1268 * @param buff buffer where the SDP will be stored (must be allocated by
1270 * @param size the size of the buffer
1271 * @return 0 if OK, AVERROR_xxx on error
1273 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1275 #ifdef HAVE_AV_CONFIG_H
1277 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
1280 #define dynarray_add(tab, nb_ptr, elem)\
1282 __typeof__(tab) _tab = (tab);\
1283 __typeof__(elem) _elem = (elem);\
1284 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
1285 ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
1288 #define dynarray_add(tab, nb_ptr, elem)\
1290 ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
1294 time_t mktimegm(struct tm *tm);
1295 struct tm *brktimegm(time_t secs, struct tm *tm);
1296 const char *small_strptime(const char *p, const char *fmt,
1300 /* Deprecated, use getaddrinfo instead. */
1301 attribute_deprecated int resolve_host(struct in_addr *sin_addr, const char *hostname);
1303 void url_split(char *proto, int proto_size,
1304 char *authorization, int authorization_size,
1305 char *hostname, int hostname_size,
1307 char *path, int path_size,
1310 #if LIBAVFORMAT_VERSION_MAJOR < 53
1312 * @deprecated Use av_match_ext() instead.
1314 attribute_deprecated int match_ext(const char *filename, const char *extensions);
1318 * Returns a positive value if the given filename has one of the given
1319 * extensions, 0 otherwise.
1321 * @param extensions a comma-separated list of filename extensions
1323 int av_match_ext(const char *filename, const char *extensions);
1325 #endif /* HAVE_AV_CONFIG_H */
1327 #endif /* AVFORMAT_AVFORMAT_H */