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