lavf: remove disabled FF_API_FORMAT_PARAMETERS cruft
[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 #if FF_API_AVSTREAM_QUALITY
573     //FIXME move stuff to a flags field?
574     /**
575      * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
576      * MN: dunno if that is the right place for it
577      */
578     attribute_deprecated float quality;
579 #endif
580
581     /**
582      * Decoding: pts of the first frame of the stream, in stream time base.
583      * Only set this if you are absolutely 100% sure that the value you set
584      * it to really is the pts of the first frame.
585      * This may be undefined (AV_NOPTS_VALUE).
586      */
587     int64_t start_time;
588
589     /**
590      * Decoding: duration of the stream, in stream time base.
591      * If a source file does not specify a duration, but does specify
592      * a bitrate, this value will be estimated from bitrate and file size.
593      */
594     int64_t duration;
595
596 #if FF_API_REORDER_PRIVATE
597     /* av_read_frame() support */
598     enum AVStreamParseType need_parsing;
599     struct AVCodecParserContext *parser;
600
601     int64_t cur_dts;
602     int last_IP_duration;
603     int64_t last_IP_pts;
604     /* av_seek_frame() support */
605     AVIndexEntry *index_entries; /**< Only used if the format does not
606                                     support seeking natively. */
607     int nb_index_entries;
608     unsigned int index_entries_allocated_size;
609 #endif
610
611     int64_t nb_frames;                 ///< number of frames in this stream if known or 0
612
613     int disposition; /**< AV_DISPOSITION_* bit field */
614
615 #if FF_API_REORDER_PRIVATE
616     AVProbeData probe_data;
617 #define MAX_REORDER_DELAY 16
618     int64_t pts_buffer[MAX_REORDER_DELAY+1];
619 #endif
620
621     /**
622      * sample aspect ratio (0 if unknown)
623      * - encoding: Set by user.
624      * - decoding: Set by libavformat.
625      */
626     AVRational sample_aspect_ratio;
627
628     AVDictionary *metadata;
629
630 #if FF_API_REORDER_PRIVATE
631     /* Intended mostly for av_read_frame() support. Not supposed to be used by */
632     /* external applications; try to use something else if at all possible.    */
633     const uint8_t *cur_ptr;
634     int cur_len;
635     AVPacket cur_pkt;
636
637     // Timestamp generation support:
638     /**
639      * Timestamp corresponding to the last dts sync point.
640      *
641      * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
642      * a DTS is received from the underlying container. Otherwise set to
643      * AV_NOPTS_VALUE by default.
644      */
645     int64_t reference_dts;
646
647     /**
648      * Number of packets to buffer for codec probing
649      * NOT PART OF PUBLIC API
650      */
651 #define MAX_PROBE_PACKETS 2500
652     int probe_packets;
653
654     /**
655      * last packet in packet_buffer for this stream when muxing.
656      * Used internally, NOT PART OF PUBLIC API, do not read or
657      * write from outside of libav*
658      */
659     struct AVPacketList *last_in_packet_buffer;
660 #endif
661
662     /**
663      * Average framerate
664      */
665     AVRational avg_frame_rate;
666
667     /*****************************************************************
668      * All fields below this line are not part of the public API. They
669      * may not be used outside of libavformat and can be changed and
670      * removed at will.
671      * New public fields should be added right above.
672      *****************************************************************
673      */
674
675     /**
676      * Number of frames that have been demuxed during av_find_stream_info()
677      */
678     int codec_info_nb_frames;
679
680     /**
681      * Stream information used internally by av_find_stream_info()
682      */
683 #define MAX_STD_TIMEBASES (60*12+5)
684     struct {
685         int64_t last_dts;
686         int64_t duration_gcd;
687         int duration_count;
688         double duration_error[MAX_STD_TIMEBASES];
689         int64_t codec_info_duration;
690         int nb_decoded_frames;
691     } *info;
692 #if !FF_API_REORDER_PRIVATE
693     const uint8_t *cur_ptr;
694     int cur_len;
695     AVPacket cur_pkt;
696
697     // Timestamp generation support:
698     /**
699      * Timestamp corresponding to the last dts sync point.
700      *
701      * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
702      * a DTS is received from the underlying container. Otherwise set to
703      * AV_NOPTS_VALUE by default.
704      */
705     int64_t reference_dts;
706     int64_t first_dts;
707     int64_t cur_dts;
708     int last_IP_duration;
709     int64_t last_IP_pts;
710
711     /**
712      * Number of packets to buffer for codec probing
713      */
714 #define MAX_PROBE_PACKETS 2500
715     int probe_packets;
716
717     /**
718      * last packet in packet_buffer for this stream when muxing.
719      */
720     struct AVPacketList *last_in_packet_buffer;
721     AVProbeData probe_data;
722 #define MAX_REORDER_DELAY 16
723     int64_t pts_buffer[MAX_REORDER_DELAY+1];
724     /* av_read_frame() support */
725     enum AVStreamParseType need_parsing;
726     struct AVCodecParserContext *parser;
727
728     AVIndexEntry *index_entries; /**< Only used if the format does not
729                                     support seeking natively. */
730     int nb_index_entries;
731     unsigned int index_entries_allocated_size;
732
733     int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
734 #endif
735 } AVStream;
736
737 #define AV_PROGRAM_RUNNING 1
738
739 /**
740  * New fields can be added to the end with minor version bumps.
741  * Removal, reordering and changes to existing fields require a major
742  * version bump.
743  * sizeof(AVProgram) must not be used outside libav*.
744  */
745 typedef struct AVProgram {
746     int            id;
747     int            flags;
748     enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
749     unsigned int   *stream_index;
750     unsigned int   nb_stream_indexes;
751     AVDictionary *metadata;
752 } AVProgram;
753
754 #define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
755                                          (streams are added dynamically) */
756
757 typedef struct AVChapter {
758     int id;                 ///< unique ID to identify the chapter
759     AVRational time_base;   ///< time base in which the start/end timestamps are specified
760     int64_t start, end;     ///< chapter start/end time in time_base units
761     AVDictionary *metadata;
762 } AVChapter;
763
764 /**
765  * Format I/O context.
766  * New fields can be added to the end with minor version bumps.
767  * Removal, reordering and changes to existing fields require a major
768  * version bump.
769  * sizeof(AVFormatContext) must not be used outside libav*, use
770  * avformat_alloc_context() to create an AVFormatContext.
771  */
772 typedef struct AVFormatContext {
773     /**
774      * A class for logging and AVOptions. Set by avformat_alloc_context().
775      * Exports (de)muxer private options if they exist.
776      */
777     const AVClass *av_class;
778
779     /**
780      * Can only be iformat or oformat, not both at the same time.
781      *
782      * decoding: set by avformat_open_input().
783      * encoding: set by the user.
784      */
785     struct AVInputFormat *iformat;
786     struct AVOutputFormat *oformat;
787
788     /**
789      * Format private data. This is an AVOptions-enabled struct
790      * if and only if iformat/oformat.priv_class is not NULL.
791      */
792     void *priv_data;
793
794     /*
795      * I/O context.
796      *
797      * decoding: either set by the user before avformat_open_input() (then
798      * the user must close it manually) or set by avformat_open_input().
799      * encoding: set by the user.
800      *
801      * Do NOT set this field if AVFMT_NOFILE flag is set in
802      * iformat/oformat.flags. In such a case, the (de)muxer will handle
803      * I/O in some other way and this field will be NULL.
804      */
805     AVIOContext *pb;
806
807     /**
808      * A list of all streams in the file. New streams are created with
809      * avformat_new_stream().
810      *
811      * decoding: streams are created by libavformat in avformat_open_input().
812      * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
813      * appear in av_read_frame().
814      * encoding: streams are created by the user before avformat_write_header().
815      */
816     unsigned int nb_streams;
817     AVStream **streams;
818
819     char filename[1024]; /**< input or output filename */
820     /* stream info */
821 #if FF_API_TIMESTAMP
822     /**
823      * @deprecated use 'creation_time' metadata tag instead
824      */
825     attribute_deprecated int64_t timestamp;
826 #endif
827
828     int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
829 #if FF_API_REORDER_PRIVATE
830     /* private data for pts handling (do not modify directly). */
831     /**
832      * This buffer is only needed when packets were already buffered but
833      * not decoded, for example to get the codec parameters in MPEG
834      * streams.
835      */
836     struct AVPacketList *packet_buffer;
837 #endif
838
839     /**
840      * Decoding: position of the first frame of the component, in
841      * AV_TIME_BASE fractional seconds. NEVER set this value directly:
842      * It is deduced from the AVStream values.
843      */
844     int64_t start_time;
845
846     /**
847      * Decoding: duration of the stream, in AV_TIME_BASE fractional
848      * seconds. Only set this value if you know none of the individual stream
849      * durations and also do not set any of them. This is deduced from the
850      * AVStream values if not set.
851      */
852     int64_t duration;
853
854 #if FF_API_FILESIZE
855     /**
856      * decoding: total file size, 0 if unknown
857      */
858     attribute_deprecated int64_t file_size;
859 #endif
860
861     /**
862      * Decoding: total stream bitrate in bit/s, 0 if not
863      * available. Never set it directly if the file_size and the
864      * duration are known as Libav can compute it automatically.
865      */
866     int bit_rate;
867
868 #if FF_API_REORDER_PRIVATE
869     /* av_read_frame() support */
870     AVStream *cur_st;
871
872     /* av_seek_frame() support */
873     int64_t data_offset; /**< offset of the first packet */
874 #endif
875
876 #if FF_API_MUXRATE
877     /**
878      * use mpeg muxer private options instead
879      */
880     attribute_deprecated int mux_rate;
881 #endif
882     unsigned int packet_size;
883 #if FF_API_PRELOAD
884     attribute_deprecated int preload;
885 #endif
886     int max_delay;
887
888 #if FF_API_LOOP_OUTPUT
889 #define AVFMT_NOOUTPUTLOOP -1
890 #define AVFMT_INFINITEOUTPUTLOOP 0
891     /**
892      * number of times to loop output in formats that support it
893      *
894      * @deprecated use the 'loop' private option in the gif muxer.
895      */
896     attribute_deprecated int loop_output;
897 #endif
898
899     int flags;
900 #define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
901 #define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
902 #define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
903 #define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
904 #define AVFMT_FLAG_NOFILLIN     0x0010 ///< Do not infer any values from other values, just return what is stored in the container
905 #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
906 #if FF_API_FLAG_RTP_HINT
907 #define AVFMT_FLAG_RTP_HINT     0x0040 ///< Deprecated, use the -movflags rtphint muxer specific AVOption instead
908 #endif
909 #define AVFMT_FLAG_CUSTOM_IO    0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
910 #define AVFMT_FLAG_DISCARD_CORRUPT  0x0100 ///< Discard frames marked corrupted
911
912 #if FF_API_LOOP_INPUT
913     /**
914      * @deprecated, use the 'loop' img2 demuxer private option.
915      */
916     attribute_deprecated int loop_input;
917 #endif
918
919     /**
920      * decoding: size of data to probe; encoding: unused.
921      */
922     unsigned int probesize;
923
924     /**
925      * decoding: maximum time (in AV_TIME_BASE units) during which the input should
926      * be analyzed in avformat_find_stream_info().
927      */
928     int max_analyze_duration;
929
930     const uint8_t *key;
931     int keylen;
932
933     unsigned int nb_programs;
934     AVProgram **programs;
935
936     /**
937      * Forced video codec_id.
938      * Demuxing: Set by user.
939      */
940     enum CodecID video_codec_id;
941
942     /**
943      * Forced audio codec_id.
944      * Demuxing: Set by user.
945      */
946     enum CodecID audio_codec_id;
947
948     /**
949      * Forced subtitle codec_id.
950      * Demuxing: Set by user.
951      */
952     enum CodecID subtitle_codec_id;
953
954     /**
955      * Maximum amount of memory in bytes to use for the index of each stream.
956      * If the index exceeds this size, entries will be discarded as
957      * needed to maintain a smaller size. This can lead to slower or less
958      * accurate seeking (depends on demuxer).
959      * Demuxers for which a full in-memory index is mandatory will ignore
960      * this.
961      * muxing  : unused
962      * demuxing: set by user
963      */
964     unsigned int max_index_size;
965
966     /**
967      * Maximum amount of memory in bytes to use for buffering frames
968      * obtained from realtime capture devices.
969      */
970     unsigned int max_picture_buffer;
971
972     unsigned int nb_chapters;
973     AVChapter **chapters;
974
975     /**
976      * Flags to enable debugging.
977      */
978     int debug;
979 #define FF_FDEBUG_TS        0x0001
980
981 #if FF_API_REORDER_PRIVATE
982     /**
983      * Raw packets from the demuxer, prior to parsing and decoding.
984      * This buffer is used for buffering packets until the codec can
985      * be identified, as parsing cannot be done without knowing the
986      * codec.
987      */
988     struct AVPacketList *raw_packet_buffer;
989     struct AVPacketList *raw_packet_buffer_end;
990
991     struct AVPacketList *packet_buffer_end;
992 #endif
993
994     AVDictionary *metadata;
995
996 #if FF_API_REORDER_PRIVATE
997     /**
998      * Remaining size available for raw_packet_buffer, in bytes.
999      * NOT PART OF PUBLIC API
1000      */
1001 #define RAW_PACKET_BUFFER_SIZE 2500000
1002     int raw_packet_buffer_remaining_size;
1003 #endif
1004
1005     /**
1006      * Start time of the stream in real world time, in microseconds
1007      * since the unix epoch (00:00 1st January 1970). That is, pts=0
1008      * in the stream was captured at this real world time.
1009      * - encoding: Set by user.
1010      * - decoding: Unused.
1011      */
1012     int64_t start_time_realtime;
1013
1014     /**
1015      * decoding: number of frames used to probe fps
1016      */
1017     int fps_probe_size;
1018
1019     /**
1020      * Error recognition; higher values will detect more errors but may
1021      * misdetect some more or less valid parts as errors.
1022      * - encoding: unused
1023      * - decoding: Set by user.
1024      */
1025     int error_recognition;
1026
1027     /**
1028      * Custom interrupt callbacks for the I/O layer.
1029      *
1030      * decoding: set by the user before avformat_open_input().
1031      * encoding: set by the user before avformat_write_header()
1032      * (mainly useful for AVFMT_NOFILE formats). The callback
1033      * should also be passed to avio_open2() if it's used to
1034      * open the file.
1035      */
1036     AVIOInterruptCB interrupt_callback;
1037
1038     /*****************************************************************
1039      * All fields below this line are not part of the public API. They
1040      * may not be used outside of libavformat and can be changed and
1041      * removed at will.
1042      * New public fields should be added right above.
1043      *****************************************************************
1044      */
1045 #if !FF_API_REORDER_PRIVATE
1046     /**
1047      * Raw packets from the demuxer, prior to parsing and decoding.
1048      * This buffer is used for buffering packets until the codec can
1049      * be identified, as parsing cannot be done without knowing the
1050      * codec.
1051      */
1052     struct AVPacketList *raw_packet_buffer;
1053     struct AVPacketList *raw_packet_buffer_end;
1054     /**
1055      * Remaining size available for raw_packet_buffer, in bytes.
1056      */
1057 #define RAW_PACKET_BUFFER_SIZE 2500000
1058     int raw_packet_buffer_remaining_size;
1059
1060     /**
1061      * This buffer is only needed when packets were already buffered but
1062      * not decoded, for example to get the codec parameters in MPEG
1063      * streams.
1064      */
1065     struct AVPacketList *packet_buffer;
1066     struct AVPacketList *packet_buffer_end;
1067
1068     /* av_read_frame() support */
1069     AVStream *cur_st;
1070
1071     /* av_seek_frame() support */
1072     int64_t data_offset; /**< offset of the first packet */
1073 #endif
1074 } AVFormatContext;
1075
1076 typedef struct AVPacketList {
1077     AVPacket pkt;
1078     struct AVPacketList *next;
1079 } AVPacketList;
1080
1081
1082 /**
1083  * @defgroup lavf_core Core functions
1084  * @ingroup libavf
1085  *
1086  * Functions for querying libavformat capabilities, allocating core structures,
1087  * etc.
1088  * @{
1089  */
1090
1091 /**
1092  * Return the LIBAVFORMAT_VERSION_INT constant.
1093  */
1094 unsigned avformat_version(void);
1095
1096 /**
1097  * Return the libavformat build-time configuration.
1098  */
1099 const char *avformat_configuration(void);
1100
1101 /**
1102  * Return the libavformat license.
1103  */
1104 const char *avformat_license(void);
1105
1106 /**
1107  * Initialize libavformat and register all the muxers, demuxers and
1108  * protocols. If you do not call this function, then you can select
1109  * exactly which formats you want to support.
1110  *
1111  * @see av_register_input_format()
1112  * @see av_register_output_format()
1113  * @see av_register_protocol()
1114  */
1115 void av_register_all(void);
1116
1117 void av_register_input_format(AVInputFormat *format);
1118 void av_register_output_format(AVOutputFormat *format);
1119
1120 /**
1121  * Do global initialization of network components. This is optional,
1122  * but recommended, since it avoids the overhead of implicitly
1123  * doing the setup for each session.
1124  *
1125  * Calling this function will become mandatory if using network
1126  * protocols at some major version bump.
1127  */
1128 int avformat_network_init(void);
1129
1130 /**
1131  * Undo the initialization done by avformat_network_init.
1132  */
1133 int avformat_network_deinit(void);
1134
1135 /**
1136  * If f is NULL, returns the first registered input format,
1137  * if f is non-NULL, returns the next registered input format after f
1138  * or NULL if f is the last one.
1139  */
1140 AVInputFormat  *av_iformat_next(AVInputFormat  *f);
1141
1142 /**
1143  * If f is NULL, returns the first registered output format,
1144  * if f is non-NULL, returns the next registered output format after f
1145  * or NULL if f is the last one.
1146  */
1147 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
1148
1149 /**
1150  * Allocate an AVFormatContext.
1151  * avformat_free_context() can be used to free the context and everything
1152  * allocated by the framework within it.
1153  */
1154 AVFormatContext *avformat_alloc_context(void);
1155
1156 /**
1157  * Free an AVFormatContext and all its streams.
1158  * @param s context to free
1159  */
1160 void avformat_free_context(AVFormatContext *s);
1161
1162 /**
1163  * Get the AVClass for AVFormatContext. It can be used in combination with
1164  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1165  *
1166  * @see av_opt_find().
1167  */
1168 const AVClass *avformat_get_class(void);
1169
1170 /**
1171  * Add a new stream to a media file.
1172  *
1173  * When demuxing, it is called by the demuxer in read_header(). If the
1174  * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1175  * be called in read_packet().
1176  *
1177  * When muxing, should be called by the user before avformat_write_header().
1178  *
1179  * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1180  * will be initialized to use this codec. This is needed for e.g. codec-specific
1181  * defaults to be set, so codec should be provided if it is known.
1182  *
1183  * @return newly created stream or NULL on error.
1184  */
1185 AVStream *avformat_new_stream(AVFormatContext *s, AVCodec *c);
1186
1187 AVProgram *av_new_program(AVFormatContext *s, int id);
1188
1189 /**
1190  * @}
1191  */
1192
1193
1194 #if FF_API_GUESS_IMG2_CODEC
1195 attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
1196 #endif
1197
1198 #if FF_API_PKT_DUMP
1199 attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
1200 attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
1201                                           int dump_payload);
1202 #endif
1203
1204
1205 /**
1206  * @addtogroup lavf_decoding
1207  * @{
1208  */
1209
1210 /**
1211  * Find AVInputFormat based on the short name of the input format.
1212  */
1213 AVInputFormat *av_find_input_format(const char *short_name);
1214
1215 /**
1216  * Guess the file format.
1217  *
1218  * @param is_opened Whether the file is already opened; determines whether
1219  *                  demuxers with or without AVFMT_NOFILE are probed.
1220  */
1221 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1222
1223 /**
1224  * Guess the file format.
1225  *
1226  * @param is_opened Whether the file is already opened; determines whether
1227  *                  demuxers with or without AVFMT_NOFILE are probed.
1228  * @param score_max A probe score larger that this is required to accept a
1229  *                  detection, the variable is set to the actual detection
1230  *                  score afterwards.
1231  *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1232  *                  to retry with a larger probe buffer.
1233  */
1234 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1235
1236 /**
1237  * Probe a bytestream to determine the input format. Each time a probe returns
1238  * with a score that is too low, the probe buffer size is increased and another
1239  * attempt is made. When the maximum probe size is reached, the input format
1240  * with the highest score is returned.
1241  *
1242  * @param pb the bytestream to probe
1243  * @param fmt the input format is put here
1244  * @param filename the filename of the stream
1245  * @param logctx the log context
1246  * @param offset the offset within the bytestream to probe from
1247  * @param max_probe_size the maximum probe buffer size (zero for default)
1248  * @return 0 in case of success, a negative value corresponding to an
1249  * AVERROR code otherwise
1250  */
1251 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1252                           const char *filename, void *logctx,
1253                           unsigned int offset, unsigned int max_probe_size);
1254
1255 /**
1256  * Open an input stream and read the header. The codecs are not opened.
1257  * The stream must be closed with av_close_input_file().
1258  *
1259  * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1260  *           May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1261  *           function and written into ps.
1262  *           Note that a user-supplied AVFormatContext will be freed on failure.
1263  * @param filename Name of the stream to open.
1264  * @param fmt If non-NULL, this parameter forces a specific input format.
1265  *            Otherwise the format is autodetected.
1266  * @param options  A dictionary filled with AVFormatContext and demuxer-private options.
1267  *                 On return this parameter will be destroyed and replaced with a dict containing
1268  *                 options that were not found. May be NULL.
1269  *
1270  * @return 0 on success, a negative AVERROR on failure.
1271  *
1272  * @note If you want to use custom IO, preallocate the format context and set its pb field.
1273  */
1274 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1275
1276 /**
1277  * Read packets of a media file to get stream information. This
1278  * is useful for file formats with no headers such as MPEG. This
1279  * function also computes the real framerate in case of MPEG-2 repeat
1280  * frame mode.
1281  * The logical file position is not changed by this function;
1282  * examined packets may be buffered for later processing.
1283  *
1284  * @param ic media file handle
1285  * @param options  If non-NULL, an ic.nb_streams long array of pointers to
1286  *                 dictionaries, where i-th member contains options for
1287  *                 codec corresponding to i-th stream.
1288  *                 On return each dictionary will be filled with options that were not found.
1289  * @return >=0 if OK, AVERROR_xxx on error
1290  *
1291  * @note this function isn't guaranteed to open all the codecs, so
1292  *       options being non-empty at return is a perfectly normal behavior.
1293  *
1294  * @todo Let the user decide somehow what information is needed so that
1295  *       we do not waste time getting stuff the user does not need.
1296  */
1297 int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
1298
1299 /**
1300  * Find the "best" stream in the file.
1301  * The best stream is determined according to various heuristics as the most
1302  * likely to be what the user expects.
1303  * If the decoder parameter is non-NULL, av_find_best_stream will find the
1304  * default decoder for the stream's codec; streams for which no decoder can
1305  * be found are ignored.
1306  *
1307  * @param ic                media file handle
1308  * @param type              stream type: video, audio, subtitles, etc.
1309  * @param wanted_stream_nb  user-requested stream number,
1310  *                          or -1 for automatic selection
1311  * @param related_stream    try to find a stream related (eg. in the same
1312  *                          program) to this one, or -1 if none
1313  * @param decoder_ret       if non-NULL, returns the decoder for the
1314  *                          selected stream
1315  * @param flags             flags; none are currently defined
1316  * @return  the non-negative stream number in case of success,
1317  *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1318  *          could be found,
1319  *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1320  * @note  If av_find_best_stream returns successfully and decoder_ret is not
1321  *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1322  */
1323 int av_find_best_stream(AVFormatContext *ic,
1324                         enum AVMediaType type,
1325                         int wanted_stream_nb,
1326                         int related_stream,
1327                         AVCodec **decoder_ret,
1328                         int flags);
1329
1330 /**
1331  * Read a transport packet from a media file.
1332  *
1333  * This function is obsolete and should never be used.
1334  * Use av_read_frame() instead.
1335  *
1336  * @param s media file handle
1337  * @param pkt is filled
1338  * @return 0 if OK, AVERROR_xxx on error
1339  */
1340 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1341
1342 /**
1343  * Return the next frame of a stream.
1344  * This function returns what is stored in the file, and does not validate
1345  * that what is there are valid frames for the decoder. It will split what is
1346  * stored in the file into frames and return one for each call. It will not
1347  * omit invalid data between valid frames so as to give the decoder the maximum
1348  * information possible for decoding.
1349  *
1350  * The returned packet is valid
1351  * until the next av_read_frame() or until av_close_input_file() and
1352  * must be freed with av_free_packet. For video, the packet contains
1353  * exactly one frame. For audio, it contains an integer number of
1354  * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1355  * data). If the audio frames have a variable size (e.g. MPEG audio),
1356  * then it contains one frame.
1357  *
1358  * pkt->pts, pkt->dts and pkt->duration are always set to correct
1359  * values in AVStream.time_base units (and guessed if the format cannot
1360  * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1361  * has B-frames, so it is better to rely on pkt->dts if you do not
1362  * decompress the payload.
1363  *
1364  * @return 0 if OK, < 0 on error or end of file
1365  */
1366 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1367
1368 /**
1369  * Seek to the keyframe at timestamp.
1370  * 'timestamp' in 'stream_index'.
1371  * @param stream_index If stream_index is (-1), a default
1372  * stream is selected, and timestamp is automatically converted
1373  * from AV_TIME_BASE units to the stream specific time_base.
1374  * @param timestamp Timestamp in AVStream.time_base units
1375  *        or, if no stream is specified, in AV_TIME_BASE units.
1376  * @param flags flags which select direction and seeking mode
1377  * @return >= 0 on success
1378  */
1379 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1380                   int flags);
1381
1382 /**
1383  * Seek to timestamp ts.
1384  * Seeking will be done so that the point from which all active streams
1385  * can be presented successfully will be closest to ts and within min/max_ts.
1386  * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1387  *
1388  * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1389  * are the file position (this may not be supported by all demuxers).
1390  * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1391  * in the stream with stream_index (this may not be supported by all demuxers).
1392  * Otherwise all timestamps are in units of the stream selected by stream_index
1393  * or if stream_index is -1, in AV_TIME_BASE units.
1394  * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1395  * keyframes (this may not be supported by all demuxers).
1396  *
1397  * @param stream_index index of the stream which is used as time base reference
1398  * @param min_ts smallest acceptable timestamp
1399  * @param ts target timestamp
1400  * @param max_ts largest acceptable timestamp
1401  * @param flags flags
1402  * @return >=0 on success, error code otherwise
1403  *
1404  * @note This is part of the new seek API which is still under construction.
1405  *       Thus do not use this yet. It may change at any time, do not expect
1406  *       ABI compatibility yet!
1407  */
1408 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1409
1410 /**
1411  * Start playing a network-based stream (e.g. RTSP stream) at the
1412  * current position.
1413  */
1414 int av_read_play(AVFormatContext *s);
1415
1416 /**
1417  * Pause a network-based stream (e.g. RTSP stream).
1418  *
1419  * Use av_read_play() to resume it.
1420  */
1421 int av_read_pause(AVFormatContext *s);
1422
1423 #if FF_API_CLOSE_INPUT_FILE
1424 /**
1425  * @deprecated use avformat_close_input()
1426  * Close a media file (but not its codecs).
1427  *
1428  * @param s media file handle
1429  */
1430 attribute_deprecated
1431 void av_close_input_file(AVFormatContext *s);
1432 #endif
1433
1434 /**
1435  * Close an opened input AVFormatContext. Free it and all its contents
1436  * and set *s to NULL.
1437  */
1438 void avformat_close_input(AVFormatContext **s);
1439 /**
1440  * @}
1441  */
1442
1443 #if FF_API_NEW_STREAM
1444 /**
1445  * Add a new stream to a media file.
1446  *
1447  * Can only be called in the read_header() function. If the flag
1448  * AVFMTCTX_NOHEADER is in the format context, then new streams
1449  * can be added in read_packet too.
1450  *
1451  * @param s media file handle
1452  * @param id file-format-dependent stream ID
1453  */
1454 attribute_deprecated
1455 AVStream *av_new_stream(AVFormatContext *s, int id);
1456 #endif
1457
1458 #if FF_API_SET_PTS_INFO
1459 /**
1460  * @deprecated this function is not supposed to be called outside of lavf
1461  */
1462 attribute_deprecated
1463 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1464                      unsigned int pts_num, unsigned int pts_den);
1465 #endif
1466
1467 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1468 #define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1469 #define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1470 #define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1471
1472 #if FF_API_SEEK_PUBLIC
1473 attribute_deprecated
1474 int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1475                          int64_t target_ts, int flags);
1476 attribute_deprecated
1477 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1478 attribute_deprecated
1479 int64_t av_gen_search(AVFormatContext *s, int stream_index,
1480                       int64_t target_ts, int64_t pos_min,
1481                       int64_t pos_max, int64_t pos_limit,
1482                       int64_t ts_min, int64_t ts_max,
1483                       int flags, int64_t *ts_ret,
1484                       int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1485 #endif
1486
1487 /**
1488  * @addtogroup lavf_encoding
1489  * @{
1490  */
1491 /**
1492  * Allocate the stream private data and write the stream header to
1493  * an output media file.
1494  *
1495  * @param s Media file handle, must be allocated with avformat_alloc_context().
1496  *          Its oformat field must be set to the desired output format;
1497  *          Its pb field must be set to an already openened AVIOContext.
1498  * @param options  An AVDictionary filled with AVFormatContext and muxer-private options.
1499  *                 On return this parameter will be destroyed and replaced with a dict containing
1500  *                 options that were not found. May be NULL.
1501  *
1502  * @return 0 on success, negative AVERROR on failure.
1503  *
1504  * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1505  */
1506 int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1507
1508 /**
1509  * Write a packet to an output media file.
1510  *
1511  * The packet shall contain one audio or video frame.
1512  * The packet must be correctly interleaved according to the container
1513  * specification, if not then av_interleaved_write_frame must be used.
1514  *
1515  * @param s media file handle
1516  * @param pkt The packet, which contains the stream_index, buf/buf_size,
1517  *            dts/pts, ...
1518  *            This can be NULL (at any time, not just at the end), in
1519  *            order to immediately flush data buffered within the muxer,
1520  *            for muxers that buffer up data internally before writing it
1521  *            to the output.
1522  * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush
1523  */
1524 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1525
1526 /**
1527  * Write a packet to an output media file ensuring correct interleaving.
1528  *
1529  * The packet must contain one audio or video frame.
1530  * If the packets are already correctly interleaved, the application should
1531  * call av_write_frame() instead as it is slightly faster. It is also important
1532  * to keep in mind that completely non-interleaved input will need huge amounts
1533  * of memory to interleave with this, so it is preferable to interleave at the
1534  * demuxer level.
1535  *
1536  * @param s media file handle
1537  * @param pkt The packet containing the data to be written. Libavformat takes
1538  * ownership of the data and will free it when it sees fit using the packet's
1539  * @ref AVPacket.destruct "destruct" field. The caller must not access the data
1540  * after this function returns, as it may already be freed.
1541  * Packet's @ref AVPacket.stream_index "stream_index" field must be set to the
1542  * index of the corresponding stream in @ref AVFormatContext.streams
1543  * "s.streams".
1544  * It is very strongly recommended that timing information (@ref AVPacket.pts
1545  * "pts", @ref AVPacket.dts "dts" @ref AVPacket.duration "duration") is set to
1546  * correct values.
1547  *
1548  * @return 0 on success, a negative AVERROR on error.
1549  */
1550 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1551
1552 /**
1553  * Interleave a packet per dts in an output media file.
1554  *
1555  * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1556  * function, so they cannot be used after it. Note that calling av_free_packet()
1557  * on them is still safe.
1558  *
1559  * @param s media file handle
1560  * @param out the interleaved packet will be output here
1561  * @param pkt the input packet
1562  * @param flush 1 if no further packets are available as input and all
1563  *              remaining packets should be output
1564  * @return 1 if a packet was output, 0 if no packet could be output,
1565  *         < 0 if an error occurred
1566  */
1567 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1568                                  AVPacket *pkt, int flush);
1569
1570 /**
1571  * Write the stream trailer to an output media file and free the
1572  * file private data.
1573  *
1574  * May only be called after a successful call to av_write_header.
1575  *
1576  * @param s media file handle
1577  * @return 0 if OK, AVERROR_xxx on error
1578  */
1579 int av_write_trailer(AVFormatContext *s);
1580
1581 /**
1582  * Return the output format in the list of registered output formats
1583  * which best matches the provided parameters, or return NULL if
1584  * there is no match.
1585  *
1586  * @param short_name if non-NULL checks if short_name matches with the
1587  * names of the registered formats
1588  * @param filename if non-NULL checks if filename terminates with the
1589  * extensions of the registered formats
1590  * @param mime_type if non-NULL checks if mime_type matches with the
1591  * MIME type of the registered formats
1592  */
1593 AVOutputFormat *av_guess_format(const char *short_name,
1594                                 const char *filename,
1595                                 const char *mime_type);
1596
1597 /**
1598  * Guess the codec ID based upon muxer and filename.
1599  */
1600 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
1601                             const char *filename, const char *mime_type,
1602                             enum AVMediaType type);
1603
1604 /**
1605  * @}
1606  */
1607
1608
1609 /**
1610  * @defgroup lavf_misc Utility functions
1611  * @ingroup libavf
1612  * @{
1613  *
1614  * Miscelaneous utility functions related to both muxing and demuxing
1615  * (or neither).
1616  */
1617
1618 /**
1619  * Send a nice hexadecimal dump of a buffer to the specified file stream.
1620  *
1621  * @param f The file stream pointer where the dump should be sent to.
1622  * @param buf buffer
1623  * @param size buffer size
1624  *
1625  * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
1626  */
1627 void av_hex_dump(FILE *f, uint8_t *buf, int size);
1628
1629 /**
1630  * Send a nice hexadecimal dump of a buffer to the log.
1631  *
1632  * @param avcl A pointer to an arbitrary struct of which the first field is a
1633  * pointer to an AVClass struct.
1634  * @param level The importance level of the message, lower values signifying
1635  * higher importance.
1636  * @param buf buffer
1637  * @param size buffer size
1638  *
1639  * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
1640  */
1641 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
1642
1643 /**
1644  * Send a nice dump of a packet to the specified file stream.
1645  *
1646  * @param f The file stream pointer where the dump should be sent to.
1647  * @param pkt packet to dump
1648  * @param dump_payload True if the payload must be displayed, too.
1649  * @param st AVStream that the packet belongs to
1650  */
1651 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
1652
1653
1654 /**
1655  * Send a nice dump of a packet to the log.
1656  *
1657  * @param avcl A pointer to an arbitrary struct of which the first field is a
1658  * pointer to an AVClass struct.
1659  * @param level The importance level of the message, lower values signifying
1660  * higher importance.
1661  * @param pkt packet to dump
1662  * @param dump_payload True if the payload must be displayed, too.
1663  * @param st AVStream that the packet belongs to
1664  */
1665 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
1666                       AVStream *st);
1667
1668 /**
1669  * Get the CodecID for the given codec tag tag.
1670  * If no codec id is found returns CODEC_ID_NONE.
1671  *
1672  * @param tags list of supported codec_id-codec_tag pairs, as stored
1673  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1674  */
1675 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1676
1677 /**
1678  * Get the codec tag for the given codec id id.
1679  * If no codec tag is found returns 0.
1680  *
1681  * @param tags list of supported codec_id-codec_tag pairs, as stored
1682  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1683  */
1684 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1685
1686 int av_find_default_stream_index(AVFormatContext *s);
1687
1688 /**
1689  * Get the index for a specific timestamp.
1690  * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1691  *                 to the timestamp which is <= the requested one, if backward
1692  *                 is 0, then it will be >=
1693  *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1694  * @return < 0 if no such timestamp could be found
1695  */
1696 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1697
1698 /**
1699  * Add an index entry into a sorted list. Update the entry if the list
1700  * already contains it.
1701  *
1702  * @param timestamp timestamp in the time base of the given stream
1703  */
1704 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1705                        int size, int distance, int flags);
1706
1707
1708 /**
1709  * Split a URL string into components.
1710  *
1711  * The pointers to buffers for storing individual components may be null,
1712  * in order to ignore that component. Buffers for components not found are
1713  * set to empty strings. If the port is not found, it is set to a negative
1714  * value.
1715  *
1716  * @param proto the buffer for the protocol
1717  * @param proto_size the size of the proto buffer
1718  * @param authorization the buffer for the authorization
1719  * @param authorization_size the size of the authorization buffer
1720  * @param hostname the buffer for the host name
1721  * @param hostname_size the size of the hostname buffer
1722  * @param port_ptr a pointer to store the port number in
1723  * @param path the buffer for the path
1724  * @param path_size the size of the path buffer
1725  * @param url the URL to split
1726  */
1727 void av_url_split(char *proto,         int proto_size,
1728                   char *authorization, int authorization_size,
1729                   char *hostname,      int hostname_size,
1730                   int *port_ptr,
1731                   char *path,          int path_size,
1732                   const char *url);
1733
1734 #if FF_API_DUMP_FORMAT
1735 attribute_deprecated void dump_format(AVFormatContext *ic,
1736                                       int index,
1737                                       const char *url,
1738                                       int is_output);
1739 #endif
1740
1741 void av_dump_format(AVFormatContext *ic,
1742                     int index,
1743                     const char *url,
1744                     int is_output);
1745
1746 #if FF_API_PARSE_DATE
1747 /**
1748  * Parse datestr and return a corresponding number of microseconds.
1749  *
1750  * @param datestr String representing a date or a duration.
1751  * See av_parse_time() for the syntax of the provided string.
1752  * @deprecated in favor of av_parse_time()
1753  */
1754 attribute_deprecated
1755 int64_t parse_date(const char *datestr, int duration);
1756 #endif
1757
1758 /**
1759  * Get the current time in microseconds.
1760  */
1761 int64_t av_gettime(void);
1762
1763 #if FF_API_FIND_INFO_TAG
1764 /**
1765  * @deprecated use av_find_info_tag in libavutil instead.
1766  */
1767 attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1768 #endif
1769
1770 /**
1771  * Return in 'buf' the path with '%d' replaced by a number.
1772  *
1773  * Also handles the '%0nd' format where 'n' is the total number
1774  * of digits and '%%'.
1775  *
1776  * @param buf destination buffer
1777  * @param buf_size destination buffer size
1778  * @param path numbered sequence string
1779  * @param number frame number
1780  * @return 0 if OK, -1 on format error
1781  */
1782 int av_get_frame_filename(char *buf, int buf_size,
1783                           const char *path, int number);
1784
1785 /**
1786  * Check whether filename actually is a numbered sequence generator.
1787  *
1788  * @param filename possible numbered sequence string
1789  * @return 1 if a valid numbered sequence string, 0 otherwise
1790  */
1791 int av_filename_number_test(const char *filename);
1792
1793 /**
1794  * Generate an SDP for an RTP session.
1795  *
1796  * @param ac array of AVFormatContexts describing the RTP streams. If the
1797  *           array is composed by only one context, such context can contain
1798  *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1799  *           all the contexts in the array (an AVCodecContext per RTP stream)
1800  *           must contain only one AVStream.
1801  * @param n_files number of AVCodecContexts contained in ac
1802  * @param buf buffer where the SDP will be stored (must be allocated by
1803  *            the caller)
1804  * @param size the size of the buffer
1805  * @return 0 if OK, AVERROR_xxx on error
1806  */
1807 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1808
1809 #if FF_API_SDP_CREATE
1810 attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1811 #endif
1812
1813 /**
1814  * Return a positive value if the given filename has one of the given
1815  * extensions, 0 otherwise.
1816  *
1817  * @param extensions a comma-separated list of filename extensions
1818  */
1819 int av_match_ext(const char *filename, const char *extensions);
1820
1821 /**
1822  * Test if the given container can store a codec.
1823  *
1824  * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
1825  *
1826  * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
1827  *         A negative number if this information is not available.
1828  */
1829 int avformat_query_codec(AVOutputFormat *ofmt, enum CodecID codec_id, int std_compliance);
1830
1831 /**
1832  * @}
1833  */
1834
1835 #endif /* AVFORMAT_AVFORMAT_H */