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