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