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 54
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. Several modifiers can be applied to the tag name. This is done by
77 * appending a dash character ('-') and the modifier name in the order
78 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
79 * a) language -- a tag whose value is localized for a particular language
80 * is appended with the ISO 639-2/B 3-letter language code.
81 * For example: Author-ger=Michael, Author-eng=Mike
82 * The original/default language is in the unqualified "Author" tag.
83 * A demuxer should set a default if it sets any translated tag.
84 * b) sorting -- a modified version of a tag that should be used for
85 * sorting will have '-sort' appended. E.g. artist="The Beatles",
86 * artist-sort="Beatles, The".
88 * 4. Tag names are normally exported exactly as stored in the container to
89 * allow lossless remuxing to the same format. For container-independent
90 * handling of metadata, av_metadata_conv() can convert it to ffmpeg generic
91 * format. Follows a list of generic tag names:
93 * album -- name of the set this work belongs to
94 * album_artist -- main creator of the set/album, if different from artist.
95 * e.g. "Various Artists" for compilation albums.
96 * artist -- main creator of the work
97 * comment -- any additional description of the file.
98 * composer -- who composed the work, if different from artist.
99 * copyright -- name of copyright holder.
100 * date -- date when the work was created, preferably in ISO 8601.
101 * disc -- number of a subset, e.g. disc in a multi-disc collection.
102 * encoder -- name/settings of the software/hardware that produced the file.
103 * encoded_by -- person/group who created the file.
104 * filename -- original name of the file.
105 * genre -- <self-evident>.
106 * language -- main language in which the work is performed, preferably
107 * in ISO 639-2 format.
108 * performer -- artist who performed the work, if different from artist.
109 * E.g for "Also sprach Zarathustra", artist would be "Richard
110 * Strauss" and performer "London Philharmonic Orchestra".
111 * publisher -- name of the label/publisher.
112 * title -- name of the work.
113 * track -- number of this work in the set, can be in form current/total.
116 #define AV_METADATA_MATCH_CASE 1
117 #define AV_METADATA_IGNORE_SUFFIX 2
118 #define AV_METADATA_DONT_STRDUP_KEY 4
119 #define AV_METADATA_DONT_STRDUP_VAL 8
126 typedef struct AVMetadata AVMetadata;
127 typedef struct AVMetadataConv AVMetadataConv;
130 * Gets a metadata element with matching key.
131 * @param prev Set to the previous matching element to find the next.
132 * @param flags Allows case as well as suffix-insensitive comparisons.
133 * @return Found tag or NULL, changing key or value leads to undefined behavior.
136 av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
138 #if LIBAVFORMAT_VERSION_MAJOR == 52
140 * Sets the given tag in m, overwriting an existing tag.
141 * @param key tag key to add to m (will be av_strduped)
142 * @param value tag value to add to m (will be av_strduped)
143 * @return >= 0 on success otherwise an error code <0
145 int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
149 * Sets the given tag in m, overwriting an existing tag.
150 * @param key tag key to add to m (will be av_strduped depending on flags)
151 * @param value tag value to add to m (will be av_strduped depending on flags)
152 * @return >= 0 on success otherwise an error code <0
154 int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
157 * Converts all the metadata sets from ctx according to the source and
158 * destination conversion tables. If one of the tables is NULL, then
159 * tags are converted to/from ffmpeg generic tag names.
160 * @param d_conv destination tags format conversion table
161 * @param s_conv source tags format conversion table
163 void av_metadata_conv(struct AVFormatContext *ctx,const AVMetadataConv *d_conv,
164 const AVMetadataConv *s_conv);
167 * Frees all the memory allocated for an AVMetadata struct.
169 void av_metadata_free(AVMetadata **m);
172 /* packet functions */
176 * Allocates and reads the payload of a packet and initializes its
177 * fields with default values.
180 * @param size desired payload size
181 * @return >0 (read size) if OK, AVERROR_xxx otherwise
183 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
186 /*************************************************/
187 /* fractional numbers for exact pts handling */
190 * The exact value of the fractional number is: 'val + num / den'.
191 * num is assumed to be 0 <= num < den.
193 typedef struct AVFrac {
194 int64_t val, num, den;
197 /*************************************************/
198 /* input/output formats */
202 /** This structure contains the data a format has to probe a file. */
203 typedef struct AVProbeData {
204 const char *filename;
205 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
206 int buf_size; /**< Size of buf except extra allocated bytes */
209 #define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
210 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
212 typedef struct AVFormatParameters {
213 AVRational time_base;
218 enum PixelFormat pix_fmt;
219 int channel; /**< Used to select DV channel. */
220 const char *standard; /**< TV standard, NTSC, PAL, SECAM */
221 unsigned int mpeg2ts_raw:1; /**< Force raw MPEG-2 transport stream output, if possible. */
222 unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
223 stream packet (only meaningful if
224 mpeg2ts_raw is TRUE). */
225 unsigned int initial_pause:1; /**< Do not begin to play the stream
226 immediately (RTSP only). */
227 unsigned int prealloced_context:1;
228 #if LIBAVFORMAT_VERSION_INT < (53<<16)
229 enum CodecID video_codec_id;
230 enum CodecID audio_codec_id;
232 } AVFormatParameters;
234 //! Demuxer will use url_fopen, no opened file should be provided by the caller.
235 #define AVFMT_NOFILE 0x0001
236 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
237 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
238 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
240 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
241 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
242 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
243 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. */
244 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
245 #define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
247 typedef struct AVOutputFormat {
250 * Descriptive name for the format, meant to be more human-readable
251 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
254 const char *long_name;
255 const char *mime_type;
256 const char *extensions; /**< comma-separated filename extensions */
257 /** size of private data so that it can be allocated in the wrapper */
260 enum CodecID audio_codec; /**< default audio codec */
261 enum CodecID video_codec; /**< default video codec */
262 int (*write_header)(struct AVFormatContext *);
263 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
264 int (*write_trailer)(struct AVFormatContext *);
265 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
267 /** Currently only used to set pixel format if not YUV420P. */
268 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
269 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
270 AVPacket *in, int flush);
273 * List of supported codec_id-codec_tag pairs, ordered by "better
274 * choice first". The arrays are all terminated by CODEC_ID_NONE.
276 const struct AVCodecTag * const *codec_tag;
278 enum CodecID subtitle_codec; /**< default subtitle codec */
280 const AVMetadataConv *metadata_conv;
283 struct AVOutputFormat *next;
286 typedef struct AVInputFormat {
289 * Descriptive name for the format, meant to be more human-readable
290 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
293 const char *long_name;
294 /** Size of private data so that it can be allocated in the wrapper. */
297 * Tell if a given file has a chance of being parsed as this format.
298 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
299 * big so you do not have to check for that unless you need more.
301 int (*read_probe)(AVProbeData *);
302 /** Read the format header and initialize the AVFormatContext
303 structure. Return 0 if OK. 'ap' if non-NULL contains
304 additional parameters. Only used in raw format right
305 now. 'av_new_stream' should be called to create new streams. */
306 int (*read_header)(struct AVFormatContext *,
307 AVFormatParameters *ap);
308 /** Read one packet and put it in 'pkt'. pts and flags are also
309 set. 'av_new_stream' can be called only if the flag
310 AVFMTCTX_NOHEADER is used.
311 @return 0 on success, < 0 on error.
312 When returning an error, pkt must not have been allocated
313 or must be freed before returning */
314 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
315 /** Close the stream. The AVFormatContext and AVStreams are not
316 freed by this function */
317 int (*read_close)(struct AVFormatContext *);
319 #if LIBAVFORMAT_VERSION_MAJOR < 53
321 * Seek to a given timestamp relative to the frames in
322 * stream component stream_index.
323 * @param stream_index Must not be -1.
324 * @param flags Selects which direction should be preferred if no exact
325 * match is available.
326 * @return >= 0 on success (but not necessarily the new offset)
328 int (*read_seek)(struct AVFormatContext *,
329 int stream_index, int64_t timestamp, int flags);
332 * Gets the next timestamp in stream[stream_index].time_base units.
333 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
335 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
336 int64_t *pos, int64_t pos_limit);
337 /** Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER. */
339 /** If extensions are defined, then no probe is done. You should
340 usually not use extension format guessing because it is not
342 const char *extensions;
343 /** General purpose read-only value that the format can use. */
346 /** Starts/resumes playing - only meaningful if using a network-based format
348 int (*read_play)(struct AVFormatContext *);
350 /** Pauses playing - only meaningful if using a network-based format
352 int (*read_pause)(struct AVFormatContext *);
354 const struct AVCodecTag * const *codec_tag;
357 * Seeks to timestamp ts.
358 * Seeking will be done so that the point from which all active streams
359 * can be presented successfully will be closest to ts and within min/max_ts.
360 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
362 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
364 const AVMetadataConv *metadata_conv;
367 struct AVInputFormat *next;
370 enum AVStreamParseType {
372 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
373 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
374 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
377 typedef struct AVIndexEntry {
380 #define AVINDEX_KEYFRAME 0x0001
382 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).
383 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
386 #define AV_DISPOSITION_DEFAULT 0x0001
387 #define AV_DISPOSITION_DUB 0x0002
388 #define AV_DISPOSITION_ORIGINAL 0x0004
389 #define AV_DISPOSITION_COMMENT 0x0008
390 #define AV_DISPOSITION_LYRICS 0x0010
391 #define AV_DISPOSITION_KARAOKE 0x0020
395 * New fields can be added to the end with minor version bumps.
396 * Removal, reordering and changes to existing fields require a major
398 * sizeof(AVStream) must not be used outside libav*.
400 typedef struct AVStream {
401 int index; /**< stream index in AVFormatContext */
402 int id; /**< format-specific stream ID */
403 AVCodecContext *codec; /**< codec context */
405 * Real base framerate of the stream.
406 * This is the lowest framerate with which all timestamps can be
407 * represented accurately (it is the least common multiple of all
408 * framerates in the stream). Note, this value is just a guess!
409 * For example, if the time base is 1/90000 and all frames have either
410 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
412 AVRational r_frame_rate;
415 /* internal data used in av_find_stream_info() */
417 /** encoding: pts generation when outputting stream */
421 * This is the fundamental unit of time (in seconds) in terms
422 * of which frame timestamps are represented. For fixed-fps content,
423 * time base should be 1/framerate and timestamp increments should be 1.
425 AVRational time_base;
426 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
427 /* ffmpeg.c private use */
428 int stream_copy; /**< If set, just copy stream. */
429 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
430 //FIXME move stuff to a flags field?
431 /** Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
432 * MN: dunno if that is the right place for it */
435 * Decoding: pts of the first frame of the stream, in stream time base.
436 * Only set this if you are absolutely 100% sure that the value you set
437 * it to really is the pts of the first frame.
438 * This may be undefined (AV_NOPTS_VALUE).
439 * @note The ASF header does NOT contain a correct start_time the ASF
440 * demuxer must NOT set this.
444 * Decoding: duration of the stream, in stream time base.
445 * If a source file does not specify a duration, but does specify
446 * a bitrate, this value will be estimated from bitrate and file size.
450 #if LIBAVFORMAT_VERSION_INT < (53<<16)
451 char language[4]; /** ISO 639-2/B 3-letter language code (empty string if undefined) */
454 /* av_read_frame() support */
455 enum AVStreamParseType need_parsing;
456 struct AVCodecParserContext *parser;
459 int last_IP_duration;
461 /* av_seek_frame() support */
462 AVIndexEntry *index_entries; /**< Only used if the format does not
463 support seeking natively. */
464 int nb_index_entries;
465 unsigned int index_entries_allocated_size;
467 int64_t nb_frames; ///< number of frames in this stream if known or 0
469 #if LIBAVFORMAT_VERSION_INT < (53<<16)
472 char *filename; /**< source filename of the stream */
475 int disposition; /**< AV_DISPOSITION_* bit field */
477 AVProbeData probe_data;
478 #define MAX_REORDER_DELAY 16
479 int64_t pts_buffer[MAX_REORDER_DELAY+1];
482 * sample aspect ratio (0 if unknown)
483 * - encoding: Set by user.
484 * - decoding: Set by libavformat.
486 AVRational sample_aspect_ratio;
488 AVMetadata *metadata;
490 /* av_read_frame() support */
491 const uint8_t *cur_ptr;
495 // Timestamp generation support:
497 * Timestamp corresponding to the last dts sync point.
499 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
500 * a DTS is received from the underlying container. Otherwise set to
501 * AV_NOPTS_VALUE by default.
503 int64_t reference_dts;
506 * Number of packets to buffer for codec probing
507 * NOT PART OF PUBLIC API
509 #define MAX_PROBE_PACKETS 2500
513 * last packet in packet_buffer for this stream when muxing.
514 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
516 struct AVPacketList *last_in_packet_buffer;
521 AVRational avg_frame_rate;
524 * Number of frames that have been demuxed during av_find_stream_info()
526 int codec_info_nb_frames;
529 #define AV_PROGRAM_RUNNING 1
532 * New fields can be added to the end with minor version bumps.
533 * Removal, reordering and changes to existing fields require a major
535 * sizeof(AVProgram) must not be used outside libav*.
537 typedef struct AVProgram {
539 #if LIBAVFORMAT_VERSION_INT < (53<<16)
540 char *provider_name; ///< network name for DVB streams
541 char *name; ///< service name for DVB streams
544 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
545 unsigned int *stream_index;
546 unsigned int nb_stream_indexes;
547 AVMetadata *metadata;
550 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
551 (streams are added dynamically) */
553 typedef struct AVChapter {
554 int id; ///< unique ID to identify the chapter
555 AVRational time_base; ///< time base in which the start/end timestamps are specified
556 int64_t start, end; ///< chapter start/end time in time_base units
557 #if LIBAVFORMAT_VERSION_INT < (53<<16)
558 char *title; ///< chapter title
560 AVMetadata *metadata;
563 #if LIBAVFORMAT_VERSION_MAJOR < 53
564 #define MAX_STREAMS 20
566 #define MAX_STREAMS 100
570 * Format I/O context.
571 * New fields can be added to the end with minor version bumps.
572 * Removal, reordering and changes to existing fields require a major
574 * sizeof(AVFormatContext) must not be used outside libav*.
576 typedef struct AVFormatContext {
577 const AVClass *av_class; /**< Set by avformat_alloc_context. */
578 /* Can only be iformat or oformat, not both at the same time. */
579 struct AVInputFormat *iformat;
580 struct AVOutputFormat *oformat;
583 unsigned int nb_streams;
584 AVStream *streams[MAX_STREAMS];
585 char filename[1024]; /**< input or output filename */
588 #if LIBAVFORMAT_VERSION_INT < (53<<16)
594 int year; /**< ID3 year, 0 if none */
595 int track; /**< track number, 0 if none */
596 char genre[32]; /**< ID3 genre */
599 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
600 /* private data for pts handling (do not modify directly). */
601 /** This buffer is only needed when packets were already buffered but
602 not decoded, for example to get the codec parameters in MPEG
604 struct AVPacketList *packet_buffer;
606 /** Decoding: position of the first frame of the component, in
607 AV_TIME_BASE fractional seconds. NEVER set this value directly:
608 It is deduced from the AVStream values. */
610 /** Decoding: duration of the stream, in AV_TIME_BASE fractional
611 seconds. NEVER set this value directly: it is deduced from the
614 /** decoding: total file size, 0 if unknown */
616 /** Decoding: total stream bitrate in bit/s, 0 if not
617 available. Never set it directly if the file_size and the
618 duration are known as FFmpeg can compute it automatically. */
621 /* av_read_frame() support */
623 #if LIBAVFORMAT_VERSION_INT < (53<<16)
624 const uint8_t *cur_ptr_deprecated;
625 int cur_len_deprecated;
626 AVPacket cur_pkt_deprecated;
629 /* av_seek_frame() support */
630 int64_t data_offset; /** offset of the first packet */
634 unsigned int packet_size;
638 #define AVFMT_NOOUTPUTLOOP -1
639 #define AVFMT_INFINITEOUTPUTLOOP 0
640 /** number of times to loop output in formats that support it */
644 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
645 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
646 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
647 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
650 /** decoding: size of data to probe; encoding: unused. */
651 unsigned int probesize;
654 * Maximum time (in AV_TIME_BASE units) during which the input should
655 * be analyzed in av_find_stream_info().
657 int max_analyze_duration;
662 unsigned int nb_programs;
663 AVProgram **programs;
666 * Forced video codec_id.
667 * Demuxing: Set by user.
669 enum CodecID video_codec_id;
671 * Forced audio codec_id.
672 * Demuxing: Set by user.
674 enum CodecID audio_codec_id;
676 * Forced subtitle codec_id.
677 * Demuxing: Set by user.
679 enum CodecID subtitle_codec_id;
682 * Maximum amount of memory in bytes to use for the index of each stream.
683 * If the index exceeds this size, entries will be discarded as
684 * needed to maintain a smaller size. This can lead to slower or less
685 * accurate seeking (depends on demuxer).
686 * Demuxers for which a full in-memory index is mandatory will ignore
689 * demuxing: set by user
691 unsigned int max_index_size;
694 * Maximum amount of memory in bytes to use for buffering frames
695 * obtained from realtime capture devices.
697 unsigned int max_picture_buffer;
699 unsigned int nb_chapters;
700 AVChapter **chapters;
703 * Flags to enable debugging.
706 #define FF_FDEBUG_TS 0x0001
709 * Raw packets from the demuxer, prior to parsing and decoding.
710 * This buffer is used for buffering packets until the codec can
711 * be identified, as parsing cannot be done without knowing the
714 struct AVPacketList *raw_packet_buffer;
715 struct AVPacketList *raw_packet_buffer_end;
717 struct AVPacketList *packet_buffer_end;
719 AVMetadata *metadata;
722 * Remaining size available for raw_packet_buffer, in bytes.
723 * NOT PART OF PUBLIC API
725 #define RAW_PACKET_BUFFER_SIZE 2500000
726 int raw_packet_buffer_remaining_size;
729 typedef struct AVPacketList {
731 struct AVPacketList *next;
734 #if LIBAVFORMAT_VERSION_INT < (53<<16)
735 extern AVInputFormat *first_iformat;
736 extern AVOutputFormat *first_oformat;
740 * If f is NULL, returns the first registered input format,
741 * if f is non-NULL, returns the next registered input format after f
742 * or NULL if f is the last one.
744 AVInputFormat *av_iformat_next(AVInputFormat *f);
747 * If f is NULL, returns the first registered output format,
748 * if f is non-NULL, returns the next registered output format after f
749 * or NULL if f is the last one.
751 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
753 enum CodecID av_guess_image2_codec(const char *filename);
755 /* XXX: Use automatic init with either ELF sections or C file parser */
759 void av_register_input_format(AVInputFormat *format);
760 void av_register_output_format(AVOutputFormat *format);
761 #if LIBAVFORMAT_VERSION_MAJOR < 53
762 attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
763 const char *filename,
764 const char *mime_type);
767 * @deprecated Use av_guess_format() instead.
769 attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
770 const char *filename,
771 const char *mime_type);
775 * Returns the output format in the list of registered output formats
776 * which best matches the provided parameters, or returns NULL if
779 * @param short_name if non-NULL checks if short_name matches with the
780 * names of the registered formats
781 * @param filename if non-NULL checks if filename terminates with the
782 * extensions of the registered formats
783 * @param mime_type if non-NULL checks if mime_type matches with the
784 * MIME type of the registered formats
786 AVOutputFormat *av_guess_format(const char *short_name,
787 const char *filename,
788 const char *mime_type);
791 * Guesses the codec ID based upon muxer and filename.
793 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
794 const char *filename, const char *mime_type,
795 enum CodecType type);
798 * Sends a nice hexadecimal dump of a buffer to the specified file stream.
800 * @param f The file stream pointer where the dump should be sent to.
802 * @param size buffer size
804 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
806 void av_hex_dump(FILE *f, uint8_t *buf, int size);
809 * Sends a nice hexadecimal dump of a buffer to the log.
811 * @param avcl A pointer to an arbitrary struct of which the first field is a
812 * pointer to an AVClass struct.
813 * @param level The importance level of the message, lower values signifying
816 * @param size buffer size
818 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
820 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
823 * Sends a nice dump of a packet to the specified file stream.
825 * @param f The file stream pointer where the dump should be sent to.
826 * @param pkt packet to dump
827 * @param dump_payload True if the payload must be displayed, too.
829 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
832 * Sends a nice dump of a packet to the log.
834 * @param avcl A pointer to an arbitrary struct of which the first field is a
835 * pointer to an AVClass struct.
836 * @param level The importance level of the message, lower values signifying
838 * @param pkt packet to dump
839 * @param dump_payload True if the payload must be displayed, too.
841 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
844 * Initializes libavformat and registers all the muxers, demuxers and
845 * protocols. If you do not call this function, then you can select
846 * exactly which formats you want to support.
848 * @see av_register_input_format()
849 * @see av_register_output_format()
850 * @see av_register_protocol()
852 void av_register_all(void);
854 /** codec tag <-> codec id */
855 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
856 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
858 /* media file input */
861 * Finds AVInputFormat based on the short name of the input format.
863 AVInputFormat *av_find_input_format(const char *short_name);
866 * Guesses the file format.
868 * @param is_opened Whether the file is already opened; determines whether
869 * demuxers with or without AVFMT_NOFILE are probed.
871 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
874 * Allocates all the structures needed to read an input stream.
875 * This does not open the needed codecs for decoding the stream[s].
877 int av_open_input_stream(AVFormatContext **ic_ptr,
878 ByteIOContext *pb, const char *filename,
879 AVInputFormat *fmt, AVFormatParameters *ap);
882 * Opens a media file as input. The codecs are not opened. Only the file
883 * header (if present) is read.
885 * @param ic_ptr The opened media file handle is put here.
886 * @param filename filename to open
887 * @param fmt If non-NULL, force the file format to use.
888 * @param buf_size optional buffer size (zero if default is OK)
889 * @param ap Additional parameters needed when opening the file
891 * @return 0 if OK, AVERROR_xxx otherwise
893 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
896 AVFormatParameters *ap);
898 #if LIBAVFORMAT_VERSION_MAJOR < 53
900 * @deprecated Use avformat_alloc_context() instead.
902 attribute_deprecated AVFormatContext *av_alloc_format_context(void);
906 * Allocates an AVFormatContext.
907 * Can be freed with av_free() but do not forget to free everything you
908 * explicitly allocated as well!
910 AVFormatContext *avformat_alloc_context(void);
913 * Reads packets of a media file to get stream information. This
914 * is useful for file formats with no headers such as MPEG. This
915 * function also computes the real framerate in case of MPEG-2 repeat
917 * The logical file position is not changed by this function;
918 * examined packets may be buffered for later processing.
920 * @param ic media file handle
921 * @return >=0 if OK, AVERROR_xxx on error
922 * @todo Let the user decide somehow what information is needed so that
923 * we do not waste time getting stuff the user does not need.
925 int av_find_stream_info(AVFormatContext *ic);
928 * Reads a transport packet from a media file.
930 * This function is obsolete and should never be used.
931 * Use av_read_frame() instead.
933 * @param s media file handle
934 * @param pkt is filled
935 * @return 0 if OK, AVERROR_xxx on error
937 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
940 * Returns the next frame of a stream.
942 * The returned packet is valid
943 * until the next av_read_frame() or until av_close_input_file() and
944 * must be freed with av_free_packet. For video, the packet contains
945 * exactly one frame. For audio, it contains an integer number of
946 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
947 * data). If the audio frames have a variable size (e.g. MPEG audio),
948 * then it contains one frame.
950 * pkt->pts, pkt->dts and pkt->duration are always set to correct
951 * values in AVStream.time_base units (and guessed if the format cannot
952 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
953 * has B-frames, so it is better to rely on pkt->dts if you do not
954 * decompress the payload.
956 * @return 0 if OK, < 0 on error or end of file
958 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
961 * Seeks to the keyframe at timestamp.
962 * 'timestamp' in 'stream_index'.
963 * @param stream_index If stream_index is (-1), a default
964 * stream is selected, and timestamp is automatically converted
965 * from AV_TIME_BASE units to the stream specific time_base.
966 * @param timestamp Timestamp in AVStream.time_base units
967 * or, if no stream is specified, in AV_TIME_BASE units.
968 * @param flags flags which select direction and seeking mode
969 * @return >= 0 on success
971 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
975 * Seeks to timestamp ts.
976 * Seeking will be done so that the point from which all active streams
977 * can be presented successfully will be closest to ts and within min/max_ts.
978 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
980 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
981 * are the file position (this may not be supported by all demuxers).
982 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
983 * in the stream with stream_index (this may not be supported by all demuxers).
984 * Otherwise all timestamps are in units of the stream selected by stream_index
985 * or if stream_index is -1, in AV_TIME_BASE units.
986 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
987 * keyframes (this may not be supported by all demuxers).
989 * @param stream_index index of the stream which is used as time base reference
990 * @param min_ts smallest acceptable timestamp
991 * @param ts target timestamp
992 * @param max_ts largest acceptable timestamp
994 * @returns >=0 on success, error code otherwise
996 * @NOTE This is part of the new seek API which is still under construction.
997 * Thus do not use this yet. It may change at any time, do not expect
998 * ABI compatibility yet!
1000 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1003 * Starts playing a network-based stream (e.g. RTSP stream) at the
1006 int av_read_play(AVFormatContext *s);
1009 * Pauses a network-based stream (e.g. RTSP stream).
1011 * Use av_read_play() to resume it.
1013 int av_read_pause(AVFormatContext *s);
1016 * Frees a AVFormatContext allocated by av_open_input_stream.
1017 * @param s context to free
1019 void av_close_input_stream(AVFormatContext *s);
1022 * Closes a media file (but not its codecs).
1024 * @param s media file handle
1026 void av_close_input_file(AVFormatContext *s);
1029 * Adds a new stream to a media file.
1031 * Can only be called in the read_header() function. If the flag
1032 * AVFMTCTX_NOHEADER is in the format context, then new streams
1033 * can be added in read_packet too.
1035 * @param s media file handle
1036 * @param id file-format-dependent stream ID
1038 AVStream *av_new_stream(AVFormatContext *s, int id);
1039 AVProgram *av_new_program(AVFormatContext *s, int id);
1042 * Adds a new chapter.
1043 * This function is NOT part of the public API
1044 * and should ONLY be used by demuxers.
1046 * @param s media file handle
1047 * @param id unique ID for this chapter
1048 * @param start chapter start time in time_base units
1049 * @param end chapter end time in time_base units
1050 * @param title chapter title
1052 * @return AVChapter or NULL on error
1054 AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1055 int64_t start, int64_t end, const char *title);
1058 * Sets the pts for a given stream.
1061 * @param pts_wrap_bits number of bits effectively used by the pts
1062 * (used for wrap control, 33 is the value for MPEG)
1063 * @param pts_num numerator to convert to seconds (MPEG: 1)
1064 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1066 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1067 unsigned int pts_num, unsigned int pts_den);
1069 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1070 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
1071 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
1072 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
1074 int av_find_default_stream_index(AVFormatContext *s);
1077 * Gets the index for a specific timestamp.
1078 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1079 * to the timestamp which is <= the requested one, if backward
1080 * is 0, then it will be >=
1081 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1082 * @return < 0 if no such timestamp could be found
1084 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1087 * Ensures the index uses less memory than the maximum specified in
1088 * AVFormatContext.max_index_size by discarding entries if it grows
1090 * This function is not part of the public API and should only be called
1093 void ff_reduce_index(AVFormatContext *s, int stream_index);
1096 * Adds an index entry into a sorted list. Updates the entry if the list
1097 * already contains it.
1099 * @param timestamp timestamp in the time base of the given stream
1101 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1102 int size, int distance, int flags);
1105 * Does a binary search using av_index_search_timestamp() and
1106 * AVCodec.read_timestamp().
1107 * This is not supposed to be called directly by a user application,
1109 * @param target_ts target timestamp in the time base of the given stream
1110 * @param stream_index stream number
1112 int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1113 int64_t target_ts, int flags);
1116 * Updates cur_dts of all streams based on the given timestamp and AVStream.
1118 * Stream ref_st unchanged, others set cur_dts in their native time base.
1119 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1120 * @param timestamp new dts expressed in time_base of param ref_st
1121 * @param ref_st reference stream giving time_base of param timestamp
1123 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1126 * Does a binary search using read_timestamp().
1127 * This is not supposed to be called directly by a user application,
1129 * @param target_ts target timestamp in the time base of the given stream
1130 * @param stream_index stream number
1132 int64_t av_gen_search(AVFormatContext *s, int stream_index,
1133 int64_t target_ts, int64_t pos_min,
1134 int64_t pos_max, int64_t pos_limit,
1135 int64_t ts_min, int64_t ts_max,
1136 int flags, int64_t *ts_ret,
1137 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1139 /** media file output */
1140 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1143 * Allocates the stream private data and writes the stream header to an
1144 * output media file.
1146 * @param s media file handle
1147 * @return 0 if OK, AVERROR_xxx on error
1149 int av_write_header(AVFormatContext *s);
1152 * Writes a packet to an output media file.
1154 * The packet shall contain one audio or video frame.
1155 * The packet must be correctly interleaved according to the container
1156 * specification, if not then av_interleaved_write_frame must be used.
1158 * @param s media file handle
1159 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1161 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1163 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1166 * Writes a packet to an output media file ensuring correct interleaving.
1168 * The packet must contain one audio or video frame.
1169 * If the packets are already correctly interleaved, the application should
1170 * call av_write_frame() instead as it is slightly faster. It is also important
1171 * to keep in mind that completely non-interleaved input will need huge amounts
1172 * of memory to interleave with this, so it is preferable to interleave at the
1175 * @param s media file handle
1176 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1178 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1180 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1183 * Interleaves a packet per dts in an output media file.
1185 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1186 * function, so they cannot be used after it. Note that calling av_free_packet()
1187 * on them is still safe.
1189 * @param s media file handle
1190 * @param out the interleaved packet will be output here
1191 * @param in the input packet
1192 * @param flush 1 if no further packets are available as input and all
1193 * remaining packets should be output
1194 * @return 1 if a packet was output, 0 if no packet could be output,
1195 * < 0 if an error occurred
1197 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1198 AVPacket *pkt, int flush);
1201 * Writes the stream trailer to an output media file and frees the
1202 * file private data.
1204 * May only be called after a successful call to av_write_header.
1206 * @param s media file handle
1207 * @return 0 if OK, AVERROR_xxx on error
1209 int av_write_trailer(AVFormatContext *s);
1211 void dump_format(AVFormatContext *ic,
1216 #if LIBAVFORMAT_VERSION_MAJOR < 53
1218 * Parses width and height out of string str.
1219 * @deprecated Use av_parse_video_frame_size instead.
1221 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1225 * Converts framerate from a string to a fraction.
1226 * @deprecated Use av_parse_video_frame_rate instead.
1228 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1233 * Parses datestr and returns a corresponding number of microseconds.
1234 * @param datestr String representing a date or a duration.
1235 * - If a date the syntax is:
1237 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
1239 * Time is local time unless Z is appended, in which case it is
1240 * interpreted as UTC.
1241 * If the year-month-day part is not specified it takes the current
1243 * Returns the number of microseconds since 1st of January, 1970 up to
1244 * the time of the parsed date or INT64_MIN if datestr cannot be
1245 * successfully parsed.
1246 * - If a duration the syntax is:
1248 * [-]HH[:MM[:SS[.m...]]]
1251 * Returns the number of microseconds contained in a time interval
1252 * with the specified duration or INT64_MIN if datestr cannot be
1253 * successfully parsed.
1254 * @param duration Flag which tells how to interpret datestr, if
1255 * not zero datestr is interpreted as a duration, otherwise as a
1258 int64_t parse_date(const char *datestr, int duration);
1260 /** Gets the current time in microseconds. */
1261 int64_t av_gettime(void);
1263 /* ffm-specific for ffserver */
1264 #define FFM_PACKET_SIZE 4096
1265 int64_t ffm_read_write_index(int fd);
1266 int ffm_write_write_index(int fd, int64_t pos);
1267 void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1270 * Attempts to find a specific tag in a URL.
1272 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1273 * Return 1 if found.
1275 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1278 * Returns in 'buf' the path with '%d' replaced by a number.
1280 * Also handles the '%0nd' format where 'n' is the total number
1281 * of digits and '%%'.
1283 * @param buf destination buffer
1284 * @param buf_size destination buffer size
1285 * @param path numbered sequence string
1286 * @param number frame number
1287 * @return 0 if OK, -1 on format error
1289 int av_get_frame_filename(char *buf, int buf_size,
1290 const char *path, int number);
1293 * Checks whether filename actually is a numbered sequence generator.
1295 * @param filename possible numbered sequence string
1296 * @return 1 if a valid numbered sequence string, 0 otherwise
1298 int av_filename_number_test(const char *filename);
1301 * Generates an SDP for an RTP session.
1303 * @param ac array of AVFormatContexts describing the RTP streams. If the
1304 * array is composed by only one context, such context can contain
1305 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1306 * all the contexts in the array (an AVCodecContext per RTP stream)
1307 * must contain only one AVStream.
1308 * @param n_files number of AVCodecContexts contained in ac
1309 * @param buff buffer where the SDP will be stored (must be allocated by
1311 * @param size the size of the buffer
1312 * @return 0 if OK, AVERROR_xxx on error
1314 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1316 #ifdef HAVE_AV_CONFIG_H
1318 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
1321 #define dynarray_add(tab, nb_ptr, elem)\
1323 __typeof__(tab) _tab = (tab);\
1324 __typeof__(elem) _elem = (elem);\
1325 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
1326 ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
1329 #define dynarray_add(tab, nb_ptr, elem)\
1331 ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
1335 time_t mktimegm(struct tm *tm);
1336 struct tm *brktimegm(time_t secs, struct tm *tm);
1337 const char *small_strptime(const char *p, const char *fmt,
1341 /* Deprecated, use getaddrinfo instead. */
1342 attribute_deprecated int resolve_host(struct in_addr *sin_addr, const char *hostname);
1344 void url_split(char *proto, int proto_size,
1345 char *authorization, int authorization_size,
1346 char *hostname, int hostname_size,
1348 char *path, int path_size,
1351 #if LIBAVFORMAT_VERSION_MAJOR < 53
1353 * @deprecated Use av_match_ext() instead.
1355 attribute_deprecated int match_ext(const char *filename, const char *extensions);
1359 * Returns a positive value if the given filename has one of the given
1360 * extensions, 0 otherwise.
1362 * @param extensions a comma-separated list of filename extensions
1364 int av_match_ext(const char *filename, const char *extensions);
1366 #endif /* HAVE_AV_CONFIG_H */
1368 #endif /* AVFORMAT_AVFORMAT_H */