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