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