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