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