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