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