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