matroskadec: Support webm doctype
[ffmpeg.git] / libavformat / avformat.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This file is part of FFmpeg.
5  *
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.
10  *
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.
15  *
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
19  */
20
21 #ifndef AVFORMAT_AVFORMAT_H
22 #define AVFORMAT_AVFORMAT_H
23
24 #define LIBAVFORMAT_VERSION_MAJOR 52
25 #define LIBAVFORMAT_VERSION_MINOR 64
26 #define LIBAVFORMAT_VERSION_MICRO  0
27
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
35
36 #define LIBAVFORMAT_IDENT       "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
37
38 /**
39  * I return the LIBAVFORMAT_VERSION_INT constant.  You got
40  * a fucking problem with that, douchebag?
41  */
42 unsigned avformat_version(void);
43
44 /**
45  * Returns the libavformat build-time configuration.
46  */
47 const char *avformat_configuration(void);
48
49 /**
50  * Returns the libavformat license.
51  */
52 const char *avformat_license(void);
53
54 #include <time.h>
55 #include <stdio.h>  /* FILE */
56 #include "libavcodec/avcodec.h"
57
58 #include "avio.h"
59
60 struct AVFormatContext;
61
62
63 /*
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. Like all strings in FFmpeg,
67  * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
68  * exported by demuxers isn't checked to be valid UTF-8 in most cases.
69  * Important concepts to keep in mind:
70  * 1. Keys are unique; there can never be 2 tags with the same key. This is
71  *    also meant semantically, i.e., a demuxer should not knowingly produce
72  *    several keys that are literally different but semantically identical.
73  *    E.g., key=Author5, key=Author6. In this example, all authors must be
74  *    placed in the same tag.
75  * 2. Metadata is flat, not hierarchical; there are no subtags. If you
76  *    want to store, e.g., the email address of the child of producer Alice
77  *    and actor Bob, that could have key=alice_and_bobs_childs_email_address.
78  * 3. Several modifiers can be applied to the tag name. This is done by
79  *    appending a dash character ('-') and the modifier name in the order
80  *    they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
81  *    a) language -- a tag whose value is localized for a particular language
82  *       is appended with the ISO 639-2/B 3-letter language code.
83  *       For example: Author-ger=Michael, Author-eng=Mike
84  *       The original/default language is in the unqualified "Author" tag.
85  *       A demuxer should set a default if it sets any translated tag.
86  *    b) sorting  -- a modified version of a tag that should be used for
87  *       sorting will have '-sort' appended. E.g. artist="The Beatles",
88  *       artist-sort="Beatles, The".
89  *
90  * 4. Tag names are normally exported exactly as stored in the container to
91  *    allow lossless remuxing to the same format. For container-independent
92  *    handling of metadata, av_metadata_conv() can convert it to ffmpeg generic
93  *    format. Follows a list of generic tag names:
94  *
95  * album        -- name of the set this work belongs to
96  * album_artist -- main creator of the set/album, if different from artist.
97  *                 e.g. "Various Artists" for compilation albums.
98  * artist       -- main creator of the work
99  * comment      -- any additional description of the file.
100  * composer     -- who composed the work, if different from artist.
101  * copyright    -- name of copyright holder.
102  * date         -- date when the work was created, preferably in ISO 8601.
103  * disc         -- number of a subset, e.g. disc in a multi-disc collection.
104  * encoder      -- name/settings of the software/hardware that produced the file.
105  * encoded_by   -- person/group who created the file.
106  * filename     -- original name of the file.
107  * genre        -- <self-evident>.
108  * language     -- main language in which the work is performed, preferably
109  *                 in ISO 639-2 format.
110  * performer    -- artist who performed the work, if different from artist.
111  *                 E.g for "Also sprach Zarathustra", artist would be "Richard
112  *                 Strauss" and performer "London Philharmonic Orchestra".
113  * publisher    -- name of the label/publisher.
114  * title        -- name of the work.
115  * track        -- number of this work in the set, can be in form current/total.
116  */
117
118 #define AV_METADATA_MATCH_CASE      1
119 #define AV_METADATA_IGNORE_SUFFIX   2
120 #define AV_METADATA_DONT_STRDUP_KEY 4
121 #define AV_METADATA_DONT_STRDUP_VAL 8
122 #define AV_METADATA_DONT_OVERWRITE 16   ///< Don't overwrite existing tags.
123
124 typedef struct {
125     char *key;
126     char *value;
127 }AVMetadataTag;
128
129 typedef struct AVMetadata AVMetadata;
130 typedef struct AVMetadataConv AVMetadataConv;
131
132 /**
133  * Gets a metadata element with matching key.
134  * @param prev Set to the previous matching element to find the next.
135  *             If set to NULL the first matching element is returned.
136  * @param flags Allows case as well as suffix-insensitive comparisons.
137  * @return Found tag or NULL, changing key or value leads to undefined behavior.
138  */
139 AVMetadataTag *
140 av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
141
142 #if LIBAVFORMAT_VERSION_MAJOR == 52
143 /**
144  * Sets the given tag in m, overwriting an existing tag.
145  * @param key tag key to add to m (will be av_strduped)
146  * @param value tag value to add to m (will be av_strduped)
147  * @return >= 0 on success otherwise an error code <0
148  * @deprecated Use av_metadata_set2() instead.
149  */
150 attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
151 #endif
152
153 /**
154  * Sets the given tag in m, overwriting an existing tag.
155  * @param key tag key to add to m (will be av_strduped depending on flags)
156  * @param value tag value to add to m (will be av_strduped depending on flags)
157  * @return >= 0 on success otherwise an error code <0
158  */
159 int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
160
161 /**
162  * Converts all the metadata sets from ctx according to the source and
163  * destination conversion tables. If one of the tables is NULL, then
164  * tags are converted to/from ffmpeg generic tag names.
165  * @param d_conv destination tags format conversion table
166  * @param s_conv source tags format conversion table
167  */
168 void av_metadata_conv(struct AVFormatContext *ctx,const AVMetadataConv *d_conv,
169                                                   const AVMetadataConv *s_conv);
170
171 /**
172  * Frees all the memory allocated for an AVMetadata struct.
173  */
174 void av_metadata_free(AVMetadata **m);
175
176
177 /* packet functions */
178
179
180 /**
181  * Allocates and reads the payload of a packet and initializes its
182  * fields with default values.
183  *
184  * @param pkt packet
185  * @param size desired payload size
186  * @return >0 (read size) if OK, AVERROR_xxx otherwise
187  */
188 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
189
190
191 /*************************************************/
192 /* fractional numbers for exact pts handling */
193
194 /**
195  * The exact value of the fractional number is: 'val + num / den'.
196  * num is assumed to be 0 <= num < den.
197  */
198 typedef struct AVFrac {
199     int64_t val, num, den;
200 } AVFrac;
201
202 /*************************************************/
203 /* input/output formats */
204
205 struct AVCodecTag;
206
207 /** This structure contains the data a format has to probe a file. */
208 typedef struct AVProbeData {
209     const char *filename;
210     unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
211     int buf_size;       /**< Size of buf except extra allocated bytes */
212 } AVProbeData;
213
214 #define AVPROBE_SCORE_MAX 100               ///< maximum score, half of that is used for file-extension-based detection
215 #define AVPROBE_PADDING_SIZE 32             ///< extra allocated bytes at the end of the probe buffer
216
217 typedef struct AVFormatParameters {
218     AVRational time_base;
219     int sample_rate;
220     int channels;
221     int width;
222     int height;
223     enum PixelFormat pix_fmt;
224     int channel; /**< Used to select DV channel. */
225     const char *standard; /**< TV standard, NTSC, PAL, SECAM */
226     unsigned int mpeg2ts_raw:1;  /**< Force raw MPEG-2 transport stream output, if possible. */
227     unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
228                                             stream packet (only meaningful if
229                                             mpeg2ts_raw is TRUE). */
230     unsigned int initial_pause:1;       /**< Do not begin to play the stream
231                                             immediately (RTSP only). */
232     unsigned int prealloced_context:1;
233 #if LIBAVFORMAT_VERSION_INT < (53<<16)
234     enum CodecID video_codec_id;
235     enum CodecID audio_codec_id;
236 #endif
237 } AVFormatParameters;
238
239 //! Demuxer will use url_fopen, no opened file should be provided by the caller.
240 #define AVFMT_NOFILE        0x0001
241 #define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
242 #define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
243 #define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
244                                       raw picture data. */
245 #define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
246 #define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
247 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
248 #define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. */
249 #define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
250 #define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
251
252 typedef struct AVOutputFormat {
253     const char *name;
254     /**
255      * Descriptive name for the format, meant to be more human-readable
256      * than name. You should use the NULL_IF_CONFIG_SMALL() macro
257      * to define it.
258      */
259     const char *long_name;
260     const char *mime_type;
261     const char *extensions; /**< comma-separated filename extensions */
262     /** size of private data so that it can be allocated in the wrapper */
263     int priv_data_size;
264     /* output support */
265     enum CodecID audio_codec; /**< default audio codec */
266     enum CodecID video_codec; /**< default video codec */
267     int (*write_header)(struct AVFormatContext *);
268     int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
269     int (*write_trailer)(struct AVFormatContext *);
270     /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
271     int flags;
272     /** Currently only used to set pixel format if not YUV420P. */
273     int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
274     int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
275                              AVPacket *in, int flush);
276
277     /**
278      * List of supported codec_id-codec_tag pairs, ordered by "better
279      * choice first". The arrays are all terminated by CODEC_ID_NONE.
280      */
281     const struct AVCodecTag * const *codec_tag;
282
283     enum CodecID subtitle_codec; /**< default subtitle codec */
284
285     const AVMetadataConv *metadata_conv;
286
287     /* private fields */
288     struct AVOutputFormat *next;
289 } AVOutputFormat;
290
291 typedef struct AVInputFormat {
292     const char *name;
293     /**
294      * Descriptive name for the format, meant to be more human-readable
295      * than name. You should use the NULL_IF_CONFIG_SMALL() macro
296      * to define it.
297      */
298     const char *long_name;
299     /** Size of private data so that it can be allocated in the wrapper. */
300     int priv_data_size;
301     /**
302      * Tell if a given file has a chance of being parsed as this format.
303      * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
304      * big so you do not have to check for that unless you need more.
305      */
306     int (*read_probe)(AVProbeData *);
307     /** Read the format header and initialize the AVFormatContext
308        structure. Return 0 if OK. 'ap' if non-NULL contains
309        additional parameters. Only used in raw format right
310        now. 'av_new_stream' should be called to create new streams.  */
311     int (*read_header)(struct AVFormatContext *,
312                        AVFormatParameters *ap);
313     /** Read one packet and put it in 'pkt'. pts and flags are also
314        set. 'av_new_stream' can be called only if the flag
315        AVFMTCTX_NOHEADER is used.
316        @return 0 on success, < 0 on error.
317                When returning an error, pkt must not have been allocated
318                or must be freed before returning */
319     int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
320     /** Close the stream. The AVFormatContext and AVStreams are not
321        freed by this function */
322     int (*read_close)(struct AVFormatContext *);
323
324 #if LIBAVFORMAT_VERSION_MAJOR < 53
325     /**
326      * Seek to a given timestamp relative to the frames in
327      * stream component stream_index.
328      * @param stream_index Must not be -1.
329      * @param flags Selects which direction should be preferred if no exact
330      *              match is available.
331      * @return >= 0 on success (but not necessarily the new offset)
332      */
333     int (*read_seek)(struct AVFormatContext *,
334                      int stream_index, int64_t timestamp, int flags);
335 #endif
336     /**
337      * Gets the next timestamp in stream[stream_index].time_base units.
338      * @return the timestamp or AV_NOPTS_VALUE if an error occurred
339      */
340     int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
341                               int64_t *pos, int64_t pos_limit);
342     /** Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER. */
343     int flags;
344     /** If extensions are defined, then no probe is done. You should
345        usually not use extension format guessing because it is not
346        reliable enough */
347     const char *extensions;
348     /** General purpose read-only value that the format can use. */
349     int value;
350
351     /** Starts/resumes playing - only meaningful if using a network-based format
352        (RTSP). */
353     int (*read_play)(struct AVFormatContext *);
354
355     /** Pauses playing - only meaningful if using a network-based format
356        (RTSP). */
357     int (*read_pause)(struct AVFormatContext *);
358
359     const struct AVCodecTag * const *codec_tag;
360
361     /**
362      * Seeks to timestamp ts.
363      * Seeking will be done so that the point from which all active streams
364      * can be presented successfully will be closest to ts and within min/max_ts.
365      * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
366      */
367     int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
368
369     const AVMetadataConv *metadata_conv;
370
371     /* private fields */
372     struct AVInputFormat *next;
373 } AVInputFormat;
374
375 enum AVStreamParseType {
376     AVSTREAM_PARSE_NONE,
377     AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
378     AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
379     AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
380 };
381
382 typedef struct AVIndexEntry {
383     int64_t pos;
384     int64_t timestamp;
385 #define AVINDEX_KEYFRAME 0x0001
386     int flags:2;
387     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).
388     int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
389 } AVIndexEntry;
390
391 #define AV_DISPOSITION_DEFAULT   0x0001
392 #define AV_DISPOSITION_DUB       0x0002
393 #define AV_DISPOSITION_ORIGINAL  0x0004
394 #define AV_DISPOSITION_COMMENT   0x0008
395 #define AV_DISPOSITION_LYRICS    0x0010
396 #define AV_DISPOSITION_KARAOKE   0x0020
397
398 /**
399  * Stream structure.
400  * New fields can be added to the end with minor version bumps.
401  * Removal, reordering and changes to existing fields require a major
402  * version bump.
403  * sizeof(AVStream) must not be used outside libav*.
404  */
405 typedef struct AVStream {
406     int index;    /**< stream index in AVFormatContext */
407     int id;       /**< format-specific stream ID */
408     AVCodecContext *codec; /**< codec context */
409     /**
410      * Real base framerate of the stream.
411      * This is the lowest framerate with which all timestamps can be
412      * represented accurately (it is the least common multiple of all
413      * framerates in the stream). Note, this value is just a guess!
414      * For example, if the time base is 1/90000 and all frames have either
415      * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
416      */
417     AVRational r_frame_rate;
418     void *priv_data;
419
420     /* internal data used in av_find_stream_info() */
421     int64_t first_dts;
422     /** encoding: pts generation when outputting stream */
423     struct AVFrac pts;
424
425     /**
426      * This is the fundamental unit of time (in seconds) in terms
427      * of which frame timestamps are represented. For fixed-fps content,
428      * time base should be 1/framerate and timestamp increments should be 1.
429      */
430     AVRational time_base;
431     int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
432     /* ffmpeg.c private use */
433     int stream_copy; /**< If set, just copy stream. */
434     enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
435     //FIXME move stuff to a flags field?
436     /** Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
437      * MN: dunno if that is the right place for it */
438     float quality;
439     /**
440      * Decoding: pts of the first frame of the stream, in stream time base.
441      * Only set this if you are absolutely 100% sure that the value you set
442      * it to really is the pts of the first frame.
443      * This may be undefined (AV_NOPTS_VALUE).
444      * @note The ASF header does NOT contain a correct start_time the ASF
445      * demuxer must NOT set this.
446      */
447     int64_t start_time;
448     /**
449      * Decoding: duration of the stream, in stream time base.
450      * If a source file does not specify a duration, but does specify
451      * a bitrate, this value will be estimated from bitrate and file size.
452      */
453     int64_t duration;
454
455 #if LIBAVFORMAT_VERSION_INT < (53<<16)
456     char language[4]; /** ISO 639-2/B 3-letter language code (empty string if undefined) */
457 #endif
458
459     /* av_read_frame() support */
460     enum AVStreamParseType need_parsing;
461     struct AVCodecParserContext *parser;
462
463     int64_t cur_dts;
464     int last_IP_duration;
465     int64_t last_IP_pts;
466     /* av_seek_frame() support */
467     AVIndexEntry *index_entries; /**< Only used if the format does not
468                                     support seeking natively. */
469     int nb_index_entries;
470     unsigned int index_entries_allocated_size;
471
472     int64_t nb_frames;                 ///< number of frames in this stream if known or 0
473
474 #if LIBAVFORMAT_VERSION_INT < (53<<16)
475     int64_t unused[4+1];
476
477     char *filename; /**< source filename of the stream */
478 #endif
479
480     int disposition; /**< AV_DISPOSITION_* bit field */
481
482     AVProbeData probe_data;
483 #define MAX_REORDER_DELAY 16
484     int64_t pts_buffer[MAX_REORDER_DELAY+1];
485
486     /**
487      * sample aspect ratio (0 if unknown)
488      * - encoding: Set by user.
489      * - decoding: Set by libavformat.
490      */
491     AVRational sample_aspect_ratio;
492
493     AVMetadata *metadata;
494
495     /* av_read_frame() support */
496     const uint8_t *cur_ptr;
497     int cur_len;
498     AVPacket cur_pkt;
499
500     // Timestamp generation support:
501     /**
502      * Timestamp corresponding to the last dts sync point.
503      *
504      * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
505      * a DTS is received from the underlying container. Otherwise set to
506      * AV_NOPTS_VALUE by default.
507      */
508     int64_t reference_dts;
509
510     /**
511      * Number of packets to buffer for codec probing
512      * NOT PART OF PUBLIC API
513      */
514 #define MAX_PROBE_PACKETS 2500
515     int probe_packets;
516
517     /**
518      * last packet in packet_buffer for this stream when muxing.
519      * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
520      */
521     struct AVPacketList *last_in_packet_buffer;
522
523     /**
524      * Average framerate
525      */
526     AVRational avg_frame_rate;
527
528     /**
529      * Number of frames that have been demuxed during av_find_stream_info()
530      */
531     int codec_info_nb_frames;
532 } AVStream;
533
534 #define AV_PROGRAM_RUNNING 1
535
536 /**
537  * New fields can be added to the end with minor version bumps.
538  * Removal, reordering and changes to existing fields require a major
539  * version bump.
540  * sizeof(AVProgram) must not be used outside libav*.
541  */
542 typedef struct AVProgram {
543     int            id;
544 #if LIBAVFORMAT_VERSION_INT < (53<<16)
545     char           *provider_name; ///< network name for DVB streams
546     char           *name;          ///< service name for DVB streams
547 #endif
548     int            flags;
549     enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
550     unsigned int   *stream_index;
551     unsigned int   nb_stream_indexes;
552     AVMetadata *metadata;
553 } AVProgram;
554
555 #define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
556                                          (streams are added dynamically) */
557
558 typedef struct AVChapter {
559     int id;                 ///< unique ID to identify the chapter
560     AVRational time_base;   ///< time base in which the start/end timestamps are specified
561     int64_t start, end;     ///< chapter start/end time in time_base units
562 #if LIBAVFORMAT_VERSION_INT < (53<<16)
563     char *title;            ///< chapter title
564 #endif
565     AVMetadata *metadata;
566 } AVChapter;
567
568 #if LIBAVFORMAT_VERSION_MAJOR < 53
569 #define MAX_STREAMS 20
570 #else
571 #define MAX_STREAMS 100
572 #endif
573
574 /**
575  * Format I/O context.
576  * New fields can be added to the end with minor version bumps.
577  * Removal, reordering and changes to existing fields require a major
578  * version bump.
579  * sizeof(AVFormatContext) must not be used outside libav*.
580  */
581 typedef struct AVFormatContext {
582     const AVClass *av_class; /**< Set by avformat_alloc_context. */
583     /* Can only be iformat or oformat, not both at the same time. */
584     struct AVInputFormat *iformat;
585     struct AVOutputFormat *oformat;
586     void *priv_data;
587     ByteIOContext *pb;
588     unsigned int nb_streams;
589     AVStream *streams[MAX_STREAMS];
590     char filename[1024]; /**< input or output filename */
591     /* stream info */
592     int64_t timestamp;
593 #if LIBAVFORMAT_VERSION_INT < (53<<16)
594     char title[512];
595     char author[512];
596     char copyright[512];
597     char comment[512];
598     char album[512];
599     int year;  /**< ID3 year, 0 if none */
600     int track; /**< track number, 0 if none */
601     char genre[32]; /**< ID3 genre */
602 #endif
603
604     int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
605     /* private data for pts handling (do not modify directly). */
606     /** This buffer is only needed when packets were already buffered but
607        not decoded, for example to get the codec parameters in MPEG
608        streams. */
609     struct AVPacketList *packet_buffer;
610
611     /** Decoding: position of the first frame of the component, in
612        AV_TIME_BASE fractional seconds. NEVER set this value directly:
613        It is deduced from the AVStream values.  */
614     int64_t start_time;
615     /** Decoding: duration of the stream, in AV_TIME_BASE fractional
616        seconds. Only set this value if you know none of the individual stream
617        durations and also dont set any of them. This is deduced from the
618        AVStream values if not set.  */
619     int64_t duration;
620     /** decoding: total file size, 0 if unknown */
621     int64_t file_size;
622     /** Decoding: total stream bitrate in bit/s, 0 if not
623        available. Never set it directly if the file_size and the
624        duration are known as FFmpeg can compute it automatically. */
625     int bit_rate;
626
627     /* av_read_frame() support */
628     AVStream *cur_st;
629 #if LIBAVFORMAT_VERSION_INT < (53<<16)
630     const uint8_t *cur_ptr_deprecated;
631     int cur_len_deprecated;
632     AVPacket cur_pkt_deprecated;
633 #endif
634
635     /* av_seek_frame() support */
636     int64_t data_offset; /** offset of the first packet */
637     int index_built;
638
639     int mux_rate;
640     unsigned int packet_size;
641     int preload;
642     int max_delay;
643
644 #define AVFMT_NOOUTPUTLOOP -1
645 #define AVFMT_INFINITEOUTPUTLOOP 0
646     /** number of times to loop output in formats that support it */
647     int loop_output;
648
649     int flags;
650 #define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
651 #define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
652 #define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
653 #define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
654 #define AVFMT_FLAG_NOFILLIN     0x0010 ///< Do not infer any values from other values, just return what is stored in the container
655 #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
656 #define AVFMT_FLAG_RTP_HINT     0x0040 ///< Add RTP hinting to the output file
657
658     int loop_input;
659     /** decoding: size of data to probe; encoding: unused. */
660     unsigned int probesize;
661
662     /**
663      * Maximum time (in AV_TIME_BASE units) during which the input should
664      * be analyzed in av_find_stream_info().
665      */
666     int max_analyze_duration;
667
668     const uint8_t *key;
669     int keylen;
670
671     unsigned int nb_programs;
672     AVProgram **programs;
673
674     /**
675      * Forced video codec_id.
676      * Demuxing: Set by user.
677      */
678     enum CodecID video_codec_id;
679     /**
680      * Forced audio codec_id.
681      * Demuxing: Set by user.
682      */
683     enum CodecID audio_codec_id;
684     /**
685      * Forced subtitle codec_id.
686      * Demuxing: Set by user.
687      */
688     enum CodecID subtitle_codec_id;
689
690     /**
691      * Maximum amount of memory in bytes to use for the index of each stream.
692      * If the index exceeds this size, entries will be discarded as
693      * needed to maintain a smaller size. This can lead to slower or less
694      * accurate seeking (depends on demuxer).
695      * Demuxers for which a full in-memory index is mandatory will ignore
696      * this.
697      * muxing  : unused
698      * demuxing: set by user
699      */
700     unsigned int max_index_size;
701
702     /**
703      * Maximum amount of memory in bytes to use for buffering frames
704      * obtained from realtime capture devices.
705      */
706     unsigned int max_picture_buffer;
707
708     unsigned int nb_chapters;
709     AVChapter **chapters;
710
711     /**
712      * Flags to enable debugging.
713      */
714     int debug;
715 #define FF_FDEBUG_TS        0x0001
716
717     /**
718      * Raw packets from the demuxer, prior to parsing and decoding.
719      * This buffer is used for buffering packets until the codec can
720      * be identified, as parsing cannot be done without knowing the
721      * codec.
722      */
723     struct AVPacketList *raw_packet_buffer;
724     struct AVPacketList *raw_packet_buffer_end;
725
726     struct AVPacketList *packet_buffer_end;
727
728     AVMetadata *metadata;
729
730     /**
731      * Remaining size available for raw_packet_buffer, in bytes.
732      * NOT PART OF PUBLIC API
733      */
734 #define RAW_PACKET_BUFFER_SIZE 2500000
735     int raw_packet_buffer_remaining_size;
736
737     /**
738      * Start time of the stream in real world time, in microseconds
739      * since the unix epoch (00:00 1st January 1970). That is, pts=0
740      * in the stream was captured at this real world time.
741      * - encoding: Set by user.
742      * - decoding: Unused.
743      */
744     int64_t start_time_realtime;
745 } AVFormatContext;
746
747 typedef struct AVPacketList {
748     AVPacket pkt;
749     struct AVPacketList *next;
750 } AVPacketList;
751
752 #if LIBAVFORMAT_VERSION_INT < (53<<16)
753 extern AVInputFormat *first_iformat;
754 extern AVOutputFormat *first_oformat;
755 #endif
756
757 /**
758  * If f is NULL, returns the first registered input format,
759  * if f is non-NULL, returns the next registered input format after f
760  * or NULL if f is the last one.
761  */
762 AVInputFormat  *av_iformat_next(AVInputFormat  *f);
763
764 /**
765  * If f is NULL, returns the first registered output format,
766  * if f is non-NULL, returns the next registered output format after f
767  * or NULL if f is the last one.
768  */
769 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
770
771 enum CodecID av_guess_image2_codec(const char *filename);
772
773 /* XXX: Use automatic init with either ELF sections or C file parser */
774 /* modules. */
775
776 /* utils.c */
777 void av_register_input_format(AVInputFormat *format);
778 void av_register_output_format(AVOutputFormat *format);
779 #if LIBAVFORMAT_VERSION_MAJOR < 53
780 attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
781                                     const char *filename,
782                                     const char *mime_type);
783
784 /**
785  * @deprecated Use av_guess_format() instead.
786  */
787 attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
788                                                   const char *filename,
789                                                   const char *mime_type);
790 #endif
791
792 /**
793  * Returns the output format in the list of registered output formats
794  * which best matches the provided parameters, or returns NULL if
795  * there is no match.
796  *
797  * @param short_name if non-NULL checks if short_name matches with the
798  * names of the registered formats
799  * @param filename if non-NULL checks if filename terminates with the
800  * extensions of the registered formats
801  * @param mime_type if non-NULL checks if mime_type matches with the
802  * MIME type of the registered formats
803  */
804 AVOutputFormat *av_guess_format(const char *short_name,
805                                 const char *filename,
806                                 const char *mime_type);
807
808 /**
809  * Guesses the codec ID based upon muxer and filename.
810  */
811 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
812                             const char *filename, const char *mime_type,
813                             enum AVMediaType type);
814
815 /**
816  * Sends a nice hexadecimal dump of a buffer to the specified file stream.
817  *
818  * @param f The file stream pointer where the dump should be sent to.
819  * @param buf buffer
820  * @param size buffer size
821  *
822  * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
823  */
824 void av_hex_dump(FILE *f, uint8_t *buf, int size);
825
826 /**
827  * Sends a nice hexadecimal dump of a buffer to the log.
828  *
829  * @param avcl A pointer to an arbitrary struct of which the first field is a
830  * pointer to an AVClass struct.
831  * @param level The importance level of the message, lower values signifying
832  * higher importance.
833  * @param buf buffer
834  * @param size buffer size
835  *
836  * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
837  */
838 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
839
840 /**
841  * Sends a nice dump of a packet to the specified file stream.
842  *
843  * @param f The file stream pointer where the dump should be sent to.
844  * @param pkt packet to dump
845  * @param dump_payload True if the payload must be displayed, too.
846  */
847 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
848
849 /**
850  * Sends a nice dump of a packet to the log.
851  *
852  * @param avcl A pointer to an arbitrary struct of which the first field is a
853  * pointer to an AVClass struct.
854  * @param level The importance level of the message, lower values signifying
855  * higher importance.
856  * @param pkt packet to dump
857  * @param dump_payload True if the payload must be displayed, too.
858  */
859 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
860
861 /**
862  * Initializes libavformat and registers all the muxers, demuxers and
863  * protocols. If you do not call this function, then you can select
864  * exactly which formats you want to support.
865  *
866  * @see av_register_input_format()
867  * @see av_register_output_format()
868  * @see av_register_protocol()
869  */
870 void av_register_all(void);
871
872 /**
873  * Gets the CodecID for the given codec tag tag.
874  * If no codec id is found returns CODEC_ID_NONE.
875  *
876  * @param tags list of supported codec_id-codec_tag pairs, as stored
877  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
878  */
879 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
880
881 /**
882  * Gets the codec tag for the given codec id id.
883  * If no codec tag is found returns 0.
884  *
885  * @param tags list of supported codec_id-codec_tag pairs, as stored
886  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
887  */
888 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
889
890 /* media file input */
891
892 /**
893  * Finds AVInputFormat based on the short name of the input format.
894  */
895 AVInputFormat *av_find_input_format(const char *short_name);
896
897 /**
898  * Guesses the file format.
899  *
900  * @param is_opened Whether the file is already opened; determines whether
901  *                  demuxers with or without AVFMT_NOFILE are probed.
902  */
903 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
904
905 /**
906  * Guesses the file format.
907  *
908  * @param is_opened Whether the file is already opened; determines whether
909  *                  demuxers with or without AVFMT_NOFILE are probed.
910  * @param score_max A probe score larger that this is required to accept a
911  *                  detection, the variable is set to the actual detection
912  *                  score afterwards.
913  *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
914  *                  to retry with a larger probe buffer.
915  */
916 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
917
918 /**
919  * Allocates all the structures needed to read an input stream.
920  *        This does not open the needed codecs for decoding the stream[s].
921  */
922 int av_open_input_stream(AVFormatContext **ic_ptr,
923                          ByteIOContext *pb, const char *filename,
924                          AVInputFormat *fmt, AVFormatParameters *ap);
925
926 /**
927  * Opens a media file as input. The codecs are not opened. Only the file
928  * header (if present) is read.
929  *
930  * @param ic_ptr The opened media file handle is put here.
931  * @param filename filename to open
932  * @param fmt If non-NULL, force the file format to use.
933  * @param buf_size optional buffer size (zero if default is OK)
934  * @param ap Additional parameters needed when opening the file
935  *           (NULL if default).
936  * @return 0 if OK, AVERROR_xxx otherwise
937  */
938 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
939                        AVInputFormat *fmt,
940                        int buf_size,
941                        AVFormatParameters *ap);
942
943 #if LIBAVFORMAT_VERSION_MAJOR < 53
944 /**
945  * @deprecated Use avformat_alloc_context() instead.
946  */
947 attribute_deprecated AVFormatContext *av_alloc_format_context(void);
948 #endif
949
950 /**
951  * Allocates an AVFormatContext.
952  * Can be freed with av_free() but do not forget to free everything you
953  * explicitly allocated as well!
954  */
955 AVFormatContext *avformat_alloc_context(void);
956
957 /**
958  * Reads packets of a media file to get stream information. This
959  * is useful for file formats with no headers such as MPEG. This
960  * function also computes the real framerate in case of MPEG-2 repeat
961  * frame mode.
962  * The logical file position is not changed by this function;
963  * examined packets may be buffered for later processing.
964  *
965  * @param ic media file handle
966  * @return >=0 if OK, AVERROR_xxx on error
967  * @todo Let the user decide somehow what information is needed so that
968  *       we do not waste time getting stuff the user does not need.
969  */
970 int av_find_stream_info(AVFormatContext *ic);
971
972 /**
973  * Reads a transport packet from a media file.
974  *
975  * This function is obsolete and should never be used.
976  * Use av_read_frame() instead.
977  *
978  * @param s media file handle
979  * @param pkt is filled
980  * @return 0 if OK, AVERROR_xxx on error
981  */
982 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
983
984 /**
985  * Returns the next frame of a stream.
986  *
987  * The returned packet is valid
988  * until the next av_read_frame() or until av_close_input_file() and
989  * must be freed with av_free_packet. For video, the packet contains
990  * exactly one frame. For audio, it contains an integer number of
991  * frames if each frame has a known fixed size (e.g. PCM or ADPCM
992  * data). If the audio frames have a variable size (e.g. MPEG audio),
993  * then it contains one frame.
994  *
995  * pkt->pts, pkt->dts and pkt->duration are always set to correct
996  * values in AVStream.time_base units (and guessed if the format cannot
997  * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
998  * has B-frames, so it is better to rely on pkt->dts if you do not
999  * decompress the payload.
1000  *
1001  * @return 0 if OK, < 0 on error or end of file
1002  */
1003 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1004
1005 /**
1006  * Seeks to the keyframe at timestamp.
1007  * 'timestamp' in 'stream_index'.
1008  * @param stream_index If stream_index is (-1), a default
1009  * stream is selected, and timestamp is automatically converted
1010  * from AV_TIME_BASE units to the stream specific time_base.
1011  * @param timestamp Timestamp in AVStream.time_base units
1012  *        or, if no stream is specified, in AV_TIME_BASE units.
1013  * @param flags flags which select direction and seeking mode
1014  * @return >= 0 on success
1015  */
1016 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1017                   int flags);
1018
1019 /**
1020  * Seeks to timestamp ts.
1021  * Seeking will be done so that the point from which all active streams
1022  * can be presented successfully will be closest to ts and within min/max_ts.
1023  * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1024  *
1025  * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1026  * are the file position (this may not be supported by all demuxers).
1027  * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1028  * in the stream with stream_index (this may not be supported by all demuxers).
1029  * Otherwise all timestamps are in units of the stream selected by stream_index
1030  * or if stream_index is -1, in AV_TIME_BASE units.
1031  * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1032  * keyframes (this may not be supported by all demuxers).
1033  *
1034  * @param stream_index index of the stream which is used as time base reference
1035  * @param min_ts smallest acceptable timestamp
1036  * @param ts target timestamp
1037  * @param max_ts largest acceptable timestamp
1038  * @param flags flags
1039  * @return >=0 on success, error code otherwise
1040  *
1041  * @NOTE This is part of the new seek API which is still under construction.
1042  *       Thus do not use this yet. It may change at any time, do not expect
1043  *       ABI compatibility yet!
1044  */
1045 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1046
1047 /**
1048  * Starts playing a network-based stream (e.g. RTSP stream) at the
1049  * current position.
1050  */
1051 int av_read_play(AVFormatContext *s);
1052
1053 /**
1054  * Pauses a network-based stream (e.g. RTSP stream).
1055  *
1056  * Use av_read_play() to resume it.
1057  */
1058 int av_read_pause(AVFormatContext *s);
1059
1060 /**
1061  * Frees a AVFormatContext allocated by av_open_input_stream.
1062  * @param s context to free
1063  */
1064 void av_close_input_stream(AVFormatContext *s);
1065
1066 /**
1067  * Closes a media file (but not its codecs).
1068  *
1069  * @param s media file handle
1070  */
1071 void av_close_input_file(AVFormatContext *s);
1072
1073 /**
1074  * Adds a new stream to a media file.
1075  *
1076  * Can only be called in the read_header() function. If the flag
1077  * AVFMTCTX_NOHEADER is in the format context, then new streams
1078  * can be added in read_packet too.
1079  *
1080  * @param s media file handle
1081  * @param id file-format-dependent stream ID
1082  */
1083 AVStream *av_new_stream(AVFormatContext *s, int id);
1084 AVProgram *av_new_program(AVFormatContext *s, int id);
1085
1086 /**
1087  * Adds a new chapter.
1088  * This function is NOT part of the public API
1089  * and should ONLY be used by demuxers.
1090  *
1091  * @param s media file handle
1092  * @param id unique ID for this chapter
1093  * @param start chapter start time in time_base units
1094  * @param end chapter end time in time_base units
1095  * @param title chapter title
1096  *
1097  * @return AVChapter or NULL on error
1098  */
1099 AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1100                           int64_t start, int64_t end, const char *title);
1101
1102 /**
1103  * Sets the pts for a given stream.
1104  *
1105  * @param s stream
1106  * @param pts_wrap_bits number of bits effectively used by the pts
1107  *        (used for wrap control, 33 is the value for MPEG)
1108  * @param pts_num numerator to convert to seconds (MPEG: 1)
1109  * @param pts_den denominator to convert to seconds (MPEG: 90000)
1110  */
1111 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1112                      unsigned int pts_num, unsigned int pts_den);
1113
1114 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1115 #define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1116 #define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1117 #define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1118
1119 int av_find_default_stream_index(AVFormatContext *s);
1120
1121 /**
1122  * Gets the index for a specific timestamp.
1123  * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1124  *                 to the timestamp which is <= the requested one, if backward
1125  *                 is 0, then it will be >=
1126  *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1127  * @return < 0 if no such timestamp could be found
1128  */
1129 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1130
1131 /**
1132  * Ensures the index uses less memory than the maximum specified in
1133  * AVFormatContext.max_index_size by discarding entries if it grows
1134  * too large.
1135  * This function is not part of the public API and should only be called
1136  * by demuxers.
1137  */
1138 void ff_reduce_index(AVFormatContext *s, int stream_index);
1139
1140 /**
1141  * Adds an index entry into a sorted list. Updates the entry if the list
1142  * already contains it.
1143  *
1144  * @param timestamp timestamp in the time base of the given stream
1145  */
1146 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1147                        int size, int distance, int flags);
1148
1149 /**
1150  * Does a binary search using av_index_search_timestamp() and
1151  * AVCodec.read_timestamp().
1152  * This is not supposed to be called directly by a user application,
1153  * but by demuxers.
1154  * @param target_ts target timestamp in the time base of the given stream
1155  * @param stream_index stream number
1156  */
1157 int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1158                          int64_t target_ts, int flags);
1159
1160 /**
1161  * Updates cur_dts of all streams based on the given timestamp and AVStream.
1162  *
1163  * Stream ref_st unchanged, others set cur_dts in their native time base.
1164  * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1165  * @param timestamp new dts expressed in time_base of param ref_st
1166  * @param ref_st reference stream giving time_base of param timestamp
1167  */
1168 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1169
1170 /**
1171  * Does a binary search using read_timestamp().
1172  * This is not supposed to be called directly by a user application,
1173  * but by demuxers.
1174  * @param target_ts target timestamp in the time base of the given stream
1175  * @param stream_index stream number
1176  */
1177 int64_t av_gen_search(AVFormatContext *s, int stream_index,
1178                       int64_t target_ts, int64_t pos_min,
1179                       int64_t pos_max, int64_t pos_limit,
1180                       int64_t ts_min, int64_t ts_max,
1181                       int flags, int64_t *ts_ret,
1182                       int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1183
1184 /** media file output */
1185 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1186
1187 /**
1188  * Allocates the stream private data and writes the stream header to an
1189  * output media file.
1190  *
1191  * @param s media file handle
1192  * @return 0 if OK, AVERROR_xxx on error
1193  */
1194 int av_write_header(AVFormatContext *s);
1195
1196 /**
1197  * Writes a packet to an output media file.
1198  *
1199  * The packet shall contain one audio or video frame.
1200  * The packet must be correctly interleaved according to the container
1201  * specification, if not then av_interleaved_write_frame must be used.
1202  *
1203  * @param s media file handle
1204  * @param pkt The packet, which contains the stream_index, buf/buf_size,
1205               dts/pts, ...
1206  * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1207  */
1208 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1209
1210 /**
1211  * Writes a packet to an output media file ensuring correct interleaving.
1212  *
1213  * The packet must contain one audio or video frame.
1214  * If the packets are already correctly interleaved, the application should
1215  * call av_write_frame() instead as it is slightly faster. It is also important
1216  * to keep in mind that completely non-interleaved input will need huge amounts
1217  * of memory to interleave with this, so it is preferable to interleave at the
1218  * demuxer level.
1219  *
1220  * @param s media file handle
1221  * @param pkt The packet, which contains the stream_index, buf/buf_size,
1222               dts/pts, ...
1223  * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1224  */
1225 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1226
1227 /**
1228  * Interleaves a packet per dts in an output media file.
1229  *
1230  * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1231  * function, so they cannot be used after it. Note that calling av_free_packet()
1232  * on them is still safe.
1233  *
1234  * @param s media file handle
1235  * @param out the interleaved packet will be output here
1236  * @param in the input packet
1237  * @param flush 1 if no further packets are available as input and all
1238  *              remaining packets should be output
1239  * @return 1 if a packet was output, 0 if no packet could be output,
1240  *         < 0 if an error occurred
1241  */
1242 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1243                                  AVPacket *pkt, int flush);
1244
1245 /**
1246  * Writes the stream trailer to an output media file and frees the
1247  * file private data.
1248  *
1249  * May only be called after a successful call to av_write_header.
1250  *
1251  * @param s media file handle
1252  * @return 0 if OK, AVERROR_xxx on error
1253  */
1254 int av_write_trailer(AVFormatContext *s);
1255
1256 void dump_format(AVFormatContext *ic,
1257                  int index,
1258                  const char *url,
1259                  int is_output);
1260
1261 #if LIBAVFORMAT_VERSION_MAJOR < 53
1262 /**
1263  * Parses width and height out of string str.
1264  * @deprecated Use av_parse_video_frame_size instead.
1265  */
1266 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1267                                           const char *str);
1268
1269 /**
1270  * Converts framerate from a string to a fraction.
1271  * @deprecated Use av_parse_video_frame_rate instead.
1272  */
1273 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1274                                           const char *arg);
1275 #endif
1276
1277 /**
1278  * Parses datestr and returns a corresponding number of microseconds.
1279  * @param datestr String representing a date or a duration.
1280  * - If a date the syntax is:
1281  * @code
1282  *  [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
1283  * @endcode
1284  * Time is local time unless Z is appended, in which case it is
1285  * interpreted as UTC.
1286  * If the year-month-day part is not specified it takes the current
1287  * year-month-day.
1288  * Returns the number of microseconds since 1st of January, 1970 up to
1289  * the time of the parsed date or INT64_MIN if datestr cannot be
1290  * successfully parsed.
1291  * - If a duration the syntax is:
1292  * @code
1293  *  [-]HH[:MM[:SS[.m...]]]
1294  *  [-]S+[.m...]
1295  * @endcode
1296  * Returns the number of microseconds contained in a time interval
1297  * with the specified duration or INT64_MIN if datestr cannot be
1298  * successfully parsed.
1299  * @param duration Flag which tells how to interpret datestr, if
1300  * not zero datestr is interpreted as a duration, otherwise as a
1301  * date.
1302  */
1303 int64_t parse_date(const char *datestr, int duration);
1304
1305 /** Gets the current time in microseconds. */
1306 int64_t av_gettime(void);
1307
1308 /* ffm-specific for ffserver */
1309 #define FFM_PACKET_SIZE 4096
1310 int64_t ffm_read_write_index(int fd);
1311 int ffm_write_write_index(int fd, int64_t pos);
1312 void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1313
1314 /**
1315  * Attempts to find a specific tag in a URL.
1316  *
1317  * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1318  * Return 1 if found.
1319  */
1320 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1321
1322 /**
1323  * Returns in 'buf' the path with '%d' replaced by a number.
1324  *
1325  * Also handles the '%0nd' format where 'n' is the total number
1326  * of digits and '%%'.
1327  *
1328  * @param buf destination buffer
1329  * @param buf_size destination buffer size
1330  * @param path numbered sequence string
1331  * @param number frame number
1332  * @return 0 if OK, -1 on format error
1333  */
1334 int av_get_frame_filename(char *buf, int buf_size,
1335                           const char *path, int number);
1336
1337 /**
1338  * Checks whether filename actually is a numbered sequence generator.
1339  *
1340  * @param filename possible numbered sequence string
1341  * @return 1 if a valid numbered sequence string, 0 otherwise
1342  */
1343 int av_filename_number_test(const char *filename);
1344
1345 /**
1346  * Generates an SDP for an RTP session.
1347  *
1348  * @param ac array of AVFormatContexts describing the RTP streams. If the
1349  *           array is composed by only one context, such context can contain
1350  *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1351  *           all the contexts in the array (an AVCodecContext per RTP stream)
1352  *           must contain only one AVStream.
1353  * @param n_files number of AVCodecContexts contained in ac
1354  * @param buff buffer where the SDP will be stored (must be allocated by
1355  *             the caller)
1356  * @param size the size of the buffer
1357  * @return 0 if OK, AVERROR_xxx on error
1358  */
1359 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1360
1361 /**
1362  * Returns a positive value if the given filename has one of the given
1363  * extensions, 0 otherwise.
1364  *
1365  * @param extensions a comma-separated list of filename extensions
1366  */
1367 int av_match_ext(const char *filename, const char *extensions);
1368
1369 #endif /* AVFORMAT_AVFORMAT_H */