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