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