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