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