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