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