ef7149a73385af5d5a504567a065fbc6038c49d9
[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 /// Demuxer will use avio_open, no opened file should be provided by the caller.
281 #define AVFMT_NOFILE        0x0001
282 #define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
283 #define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
284 #define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
285                                       raw picture data. */
286 #define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
287 #define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
288 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
289 #define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
290 #define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
291 #define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
292 #define AVFMT_NOSTREAMS     0x1000 /**< Format does not require any streams */
293 #define AVFMT_NOBINSEARCH   0x2000 /**< Format does not allow to fallback to binary search via read_timestamp */
294 #define AVFMT_NOGENSEARCH   0x4000 /**< Format does not allow to fallback to generic search */
295 #define AVFMT_NO_BYTE_SEEK  0x8000 /**< Format does not allow seeking by bytes */
296 #define AVFMT_ALLOW_FLUSH  0x10000 /**< Format allows flushing. If not set, the muxer will not receive a NULL packet in the write_packet function. */
297
298 /**
299  * @addtogroup lavf_encoding
300  * @{
301  */
302 typedef struct AVOutputFormat {
303     const char *name;
304     /**
305      * Descriptive name for the format, meant to be more human-readable
306      * than name. You should use the NULL_IF_CONFIG_SMALL() macro
307      * to define it.
308      */
309     const char *long_name;
310     const char *mime_type;
311     const char *extensions; /**< comma-separated filename extensions */
312     /**
313      * size of private data so that it can be allocated in the wrapper
314      */
315     int priv_data_size;
316     /* output support */
317     enum CodecID audio_codec; /**< default audio codec */
318     enum CodecID video_codec; /**< default video codec */
319     int (*write_header)(struct AVFormatContext *);
320     /**
321      * Write a packet. If AVFMT_ALLOW_FLUSH is set in flags,
322      * pkt can be NULL in order to flush data buffered in the muxer.
323      * When flushing, return 0 if there still is more data to flush,
324      * or 1 if everything was flushed and there is no more buffered
325      * data.
326      */
327     int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
328     int (*write_trailer)(struct AVFormatContext *);
329     /**
330      * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
331      * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
332      * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS, AVFMT_ALLOW_FLUSH
333      */
334     int flags;
335     /**
336      * Currently only used to set pixel format if not YUV420P.
337      */
338     int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
339                              AVPacket *in, int flush);
340
341     /**
342      * List of supported codec_id-codec_tag pairs, ordered by "better
343      * choice first". The arrays are all terminated by CODEC_ID_NONE.
344      */
345     const struct AVCodecTag * const *codec_tag;
346
347     enum CodecID subtitle_codec; /**< default subtitle codec */
348
349     const AVClass *priv_class; ///< AVClass for the private context
350
351     /**
352      * Test if the given codec can be stored in this container.
353      *
354      * @return 1 if the codec is supported, 0 if it is not.
355      *         A negative number if unknown.
356      */
357     int (*query_codec)(enum CodecID id, int std_compliance);
358
359     /* private fields */
360     struct AVOutputFormat *next;
361 } AVOutputFormat;
362 /**
363  * @}
364  */
365
366 /**
367  * @addtogroup lavf_decoding
368  * @{
369  */
370 typedef struct AVInputFormat {
371     /**
372      * A comma separated list of short names for the format. New names
373      * may be appended with a minor bump.
374      */
375     const char *name;
376
377     /**
378      * Descriptive name for the format, meant to be more human-readable
379      * than name. You should use the NULL_IF_CONFIG_SMALL() macro
380      * to define it.
381      */
382     const char *long_name;
383
384     /**
385      * Size of private data so that it can be allocated in the wrapper.
386      */
387     int priv_data_size;
388
389     /**
390      * Tell if a given file has a chance of being parsed as this format.
391      * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
392      * big so you do not have to check for that unless you need more.
393      */
394     int (*read_probe)(AVProbeData *);
395
396     /**
397      * Read the format header and initialize the AVFormatContext
398      * structure. Return 0 if OK. 'ap' if non-NULL contains
399      * additional parameters. Only used in raw format right
400      * now. 'av_new_stream' should be called to create new streams.
401      */
402     int (*read_header)(struct AVFormatContext *);
403
404     /**
405      * Read one packet and put it in 'pkt'. pts and flags are also
406      * set. 'av_new_stream' can be called only if the flag
407      * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
408      * background thread).
409      * @return 0 on success, < 0 on error.
410      *         When returning an error, pkt must not have been allocated
411      *         or must be freed before returning
412      */
413     int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
414
415     /**
416      * Close the stream. The AVFormatContext and AVStreams are not
417      * freed by this function
418      */
419     int (*read_close)(struct AVFormatContext *);
420
421     /**
422      * Seek to a given timestamp relative to the frames in
423      * stream component stream_index.
424      * @param stream_index Must not be -1.
425      * @param flags Selects which direction should be preferred if no exact
426      *              match is available.
427      * @return >= 0 on success (but not necessarily the new offset)
428      */
429     int (*read_seek)(struct AVFormatContext *,
430                      int stream_index, int64_t timestamp, int flags);
431
432     /**
433      * Get the next timestamp in stream[stream_index].time_base units.
434      * @return the timestamp or AV_NOPTS_VALUE if an error occurred
435      */
436     int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
437                               int64_t *pos, int64_t pos_limit);
438
439     /**
440      * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
441      * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
442      * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK.
443      */
444     int flags;
445
446     /**
447      * If extensions are defined, then no probe is done. You should
448      * usually not use extension format guessing because it is not
449      * reliable enough
450      */
451     const char *extensions;
452
453     /**
454      * General purpose read-only value that the format can use.
455      */
456     int value;
457
458     /**
459      * Start/resume playing - only meaningful if using a network-based format
460      * (RTSP).
461      */
462     int (*read_play)(struct AVFormatContext *);
463
464     /**
465      * Pause playing - only meaningful if using a network-based format
466      * (RTSP).
467      */
468     int (*read_pause)(struct AVFormatContext *);
469
470     const struct AVCodecTag * const *codec_tag;
471
472     /**
473      * Seek to timestamp ts.
474      * Seeking will be done so that the point from which all active streams
475      * can be presented successfully will be closest to ts and within min/max_ts.
476      * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
477      */
478     int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
479
480     const AVClass *priv_class; ///< AVClass for the private context
481
482     /* private fields */
483     struct AVInputFormat *next;
484 } AVInputFormat;
485 /**
486  * @}
487  */
488
489 enum AVStreamParseType {
490     AVSTREAM_PARSE_NONE,
491     AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
492     AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
493     AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
494     AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
495 };
496
497 typedef struct AVIndexEntry {
498     int64_t pos;
499     int64_t timestamp;
500 #define AVINDEX_KEYFRAME 0x0001
501     int flags:2;
502     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).
503     int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
504 } AVIndexEntry;
505
506 #define AV_DISPOSITION_DEFAULT   0x0001
507 #define AV_DISPOSITION_DUB       0x0002
508 #define AV_DISPOSITION_ORIGINAL  0x0004
509 #define AV_DISPOSITION_COMMENT   0x0008
510 #define AV_DISPOSITION_LYRICS    0x0010
511 #define AV_DISPOSITION_KARAOKE   0x0020
512
513 /**
514  * Track should be used during playback by default.
515  * Useful for subtitle track that should be displayed
516  * even when user did not explicitly ask for subtitles.
517  */
518 #define AV_DISPOSITION_FORCED    0x0040
519 #define AV_DISPOSITION_HEARING_IMPAIRED  0x0080  /**< stream for hearing impaired audiences */
520 #define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100  /**< stream for visual impaired audiences */
521 #define AV_DISPOSITION_CLEAN_EFFECTS     0x0200  /**< stream without voice */
522
523 /**
524  * Stream structure.
525  * New fields can be added to the end with minor version bumps.
526  * Removal, reordering and changes to existing fields require a major
527  * version bump.
528  * sizeof(AVStream) must not be used outside libav*.
529  */
530 typedef struct AVStream {
531     int index;    /**< stream index in AVFormatContext */
532     int id;       /**< format-specific stream ID */
533     AVCodecContext *codec; /**< codec context */
534     /**
535      * Real base framerate of the stream.
536      * This is the lowest framerate with which all timestamps can be
537      * represented accurately (it is the least common multiple of all
538      * framerates in the stream). Note, this value is just a guess!
539      * For example, if the time base is 1/90000 and all frames have either
540      * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
541      */
542     AVRational r_frame_rate;
543     void *priv_data;
544
545 #if FF_API_REORDER_PRIVATE
546     /* internal data used in av_find_stream_info() */
547     int64_t first_dts;
548 #endif
549
550     /**
551      * encoding: pts generation when outputting stream
552      */
553     struct AVFrac pts;
554
555     /**
556      * This is the fundamental unit of time (in seconds) in terms
557      * of which frame timestamps are represented. For fixed-fps content,
558      * time base should be 1/framerate and timestamp increments should be 1.
559      * decoding: set by libavformat
560      * encoding: set by libavformat in av_write_header
561      */
562     AVRational time_base;
563 #if FF_API_REORDER_PRIVATE
564     int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
565 #endif
566     enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
567
568     /**
569      * Decoding: pts of the first frame of the stream, in stream time base.
570      * Only set this if you are absolutely 100% sure that the value you set
571      * it to really is the pts of the first frame.
572      * This may be undefined (AV_NOPTS_VALUE).
573      */
574     int64_t start_time;
575
576     /**
577      * Decoding: duration of the stream, in stream time base.
578      * If a source file does not specify a duration, but does specify
579      * a bitrate, this value will be estimated from bitrate and file size.
580      */
581     int64_t duration;
582
583 #if FF_API_REORDER_PRIVATE
584     /* av_read_frame() support */
585     enum AVStreamParseType need_parsing;
586     struct AVCodecParserContext *parser;
587
588     int64_t cur_dts;
589     int last_IP_duration;
590     int64_t last_IP_pts;
591     /* av_seek_frame() support */
592     AVIndexEntry *index_entries; /**< Only used if the format does not
593                                     support seeking natively. */
594     int nb_index_entries;
595     unsigned int index_entries_allocated_size;
596 #endif
597
598     int64_t nb_frames;                 ///< number of frames in this stream if known or 0
599
600     int disposition; /**< AV_DISPOSITION_* bit field */
601
602 #if FF_API_REORDER_PRIVATE
603     AVProbeData probe_data;
604 #define MAX_REORDER_DELAY 16
605     int64_t pts_buffer[MAX_REORDER_DELAY+1];
606 #endif
607
608     /**
609      * sample aspect ratio (0 if unknown)
610      * - encoding: Set by user.
611      * - decoding: Set by libavformat.
612      */
613     AVRational sample_aspect_ratio;
614
615     AVDictionary *metadata;
616
617 #if FF_API_REORDER_PRIVATE
618     /* Intended mostly for av_read_frame() support. Not supposed to be used by */
619     /* external applications; try to use something else if at all possible.    */
620     const uint8_t *cur_ptr;
621     int cur_len;
622     AVPacket cur_pkt;
623
624     // Timestamp generation support:
625     /**
626      * Timestamp corresponding to the last dts sync point.
627      *
628      * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
629      * a DTS is received from the underlying container. Otherwise set to
630      * AV_NOPTS_VALUE by default.
631      */
632     int64_t reference_dts;
633
634     /**
635      * Number of packets to buffer for codec probing
636      * NOT PART OF PUBLIC API
637      */
638 #define MAX_PROBE_PACKETS 2500
639     int probe_packets;
640
641     /**
642      * last packet in packet_buffer for this stream when muxing.
643      * Used internally, NOT PART OF PUBLIC API, do not read or
644      * write from outside of libav*
645      */
646     struct AVPacketList *last_in_packet_buffer;
647 #endif
648
649     /**
650      * Average framerate
651      */
652     AVRational avg_frame_rate;
653
654     /*****************************************************************
655      * All fields below this line are not part of the public API. They
656      * may not be used outside of libavformat and can be changed and
657      * removed at will.
658      * New public fields should be added right above.
659      *****************************************************************
660      */
661
662     /**
663      * Number of frames that have been demuxed during av_find_stream_info()
664      */
665     int codec_info_nb_frames;
666
667     /**
668      * Stream information used internally by av_find_stream_info()
669      */
670 #define MAX_STD_TIMEBASES (60*12+5)
671     struct {
672         int64_t last_dts;
673         int64_t duration_gcd;
674         int duration_count;
675         double duration_error[MAX_STD_TIMEBASES];
676         int64_t codec_info_duration;
677         int nb_decoded_frames;
678     } *info;
679 #if !FF_API_REORDER_PRIVATE
680     const uint8_t *cur_ptr;
681     int cur_len;
682     AVPacket cur_pkt;
683
684     // Timestamp generation support:
685     /**
686      * Timestamp corresponding to the last dts sync point.
687      *
688      * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
689      * a DTS is received from the underlying container. Otherwise set to
690      * AV_NOPTS_VALUE by default.
691      */
692     int64_t reference_dts;
693     int64_t first_dts;
694     int64_t cur_dts;
695     int last_IP_duration;
696     int64_t last_IP_pts;
697
698     /**
699      * Number of packets to buffer for codec probing
700      */
701 #define MAX_PROBE_PACKETS 2500
702     int probe_packets;
703
704     /**
705      * last packet in packet_buffer for this stream when muxing.
706      */
707     struct AVPacketList *last_in_packet_buffer;
708     AVProbeData probe_data;
709 #define MAX_REORDER_DELAY 16
710     int64_t pts_buffer[MAX_REORDER_DELAY+1];
711     /* av_read_frame() support */
712     enum AVStreamParseType need_parsing;
713     struct AVCodecParserContext *parser;
714
715     AVIndexEntry *index_entries; /**< Only used if the format does not
716                                     support seeking natively. */
717     int nb_index_entries;
718     unsigned int index_entries_allocated_size;
719
720     int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
721 #endif
722 } AVStream;
723
724 #define AV_PROGRAM_RUNNING 1
725
726 /**
727  * New fields can be added to the end with minor version bumps.
728  * Removal, reordering and changes to existing fields require a major
729  * version bump.
730  * sizeof(AVProgram) must not be used outside libav*.
731  */
732 typedef struct AVProgram {
733     int            id;
734     int            flags;
735     enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
736     unsigned int   *stream_index;
737     unsigned int   nb_stream_indexes;
738     AVDictionary *metadata;
739 } AVProgram;
740
741 #define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
742                                          (streams are added dynamically) */
743
744 typedef struct AVChapter {
745     int id;                 ///< unique ID to identify the chapter
746     AVRational time_base;   ///< time base in which the start/end timestamps are specified
747     int64_t start, end;     ///< chapter start/end time in time_base units
748     AVDictionary *metadata;
749 } AVChapter;
750
751 /**
752  * Format I/O context.
753  * New fields can be added to the end with minor version bumps.
754  * Removal, reordering and changes to existing fields require a major
755  * version bump.
756  * sizeof(AVFormatContext) must not be used outside libav*, use
757  * avformat_alloc_context() to create an AVFormatContext.
758  */
759 typedef struct AVFormatContext {
760     /**
761      * A class for logging and AVOptions. Set by avformat_alloc_context().
762      * Exports (de)muxer private options if they exist.
763      */
764     const AVClass *av_class;
765
766     /**
767      * Can only be iformat or oformat, not both at the same time.
768      *
769      * decoding: set by avformat_open_input().
770      * encoding: set by the user.
771      */
772     struct AVInputFormat *iformat;
773     struct AVOutputFormat *oformat;
774
775     /**
776      * Format private data. This is an AVOptions-enabled struct
777      * if and only if iformat/oformat.priv_class is not NULL.
778      */
779     void *priv_data;
780
781     /*
782      * I/O context.
783      *
784      * decoding: either set by the user before avformat_open_input() (then
785      * the user must close it manually) or set by avformat_open_input().
786      * encoding: set by the user.
787      *
788      * Do NOT set this field if AVFMT_NOFILE flag is set in
789      * iformat/oformat.flags. In such a case, the (de)muxer will handle
790      * I/O in some other way and this field will be NULL.
791      */
792     AVIOContext *pb;
793
794     /**
795      * A list of all streams in the file. New streams are created with
796      * avformat_new_stream().
797      *
798      * decoding: streams are created by libavformat in avformat_open_input().
799      * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
800      * appear in av_read_frame().
801      * encoding: streams are created by the user before avformat_write_header().
802      */
803     unsigned int nb_streams;
804     AVStream **streams;
805
806     char filename[1024]; /**< input or output filename */
807     /* stream info */
808     int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
809 #if FF_API_REORDER_PRIVATE
810     /* private data for pts handling (do not modify directly). */
811     /**
812      * This buffer is only needed when packets were already buffered but
813      * not decoded, for example to get the codec parameters in MPEG
814      * streams.
815      */
816     struct AVPacketList *packet_buffer;
817 #endif
818
819     /**
820      * Decoding: position of the first frame of the component, in
821      * AV_TIME_BASE fractional seconds. NEVER set this value directly:
822      * It is deduced from the AVStream values.
823      */
824     int64_t start_time;
825
826     /**
827      * Decoding: duration of the stream, in AV_TIME_BASE fractional
828      * seconds. Only set this value if you know none of the individual stream
829      * durations and also do not set any of them. This is deduced from the
830      * AVStream values if not set.
831      */
832     int64_t duration;
833
834     /**
835      * Decoding: total stream bitrate in bit/s, 0 if not
836      * available. Never set it directly if the file_size and the
837      * duration are known as Libav can compute it automatically.
838      */
839     int bit_rate;
840
841 #if FF_API_REORDER_PRIVATE
842     /* av_read_frame() support */
843     AVStream *cur_st;
844
845     /* av_seek_frame() support */
846     int64_t data_offset; /**< offset of the first packet */
847 #endif
848
849     unsigned int packet_size;
850     int max_delay;
851
852     int flags;
853 #define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
854 #define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
855 #define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
856 #define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
857 #define AVFMT_FLAG_NOFILLIN     0x0010 ///< Do not infer any values from other values, just return what is stored in the container
858 #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
859 #define AVFMT_FLAG_CUSTOM_IO    0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
860 #define AVFMT_FLAG_DISCARD_CORRUPT  0x0100 ///< Discard frames marked corrupted
861
862     /**
863      * decoding: size of data to probe; encoding: unused.
864      */
865     unsigned int probesize;
866
867     /**
868      * decoding: maximum time (in AV_TIME_BASE units) during which the input should
869      * be analyzed in avformat_find_stream_info().
870      */
871     int max_analyze_duration;
872
873     const uint8_t *key;
874     int keylen;
875
876     unsigned int nb_programs;
877     AVProgram **programs;
878
879     /**
880      * Forced video codec_id.
881      * Demuxing: Set by user.
882      */
883     enum CodecID video_codec_id;
884
885     /**
886      * Forced audio codec_id.
887      * Demuxing: Set by user.
888      */
889     enum CodecID audio_codec_id;
890
891     /**
892      * Forced subtitle codec_id.
893      * Demuxing: Set by user.
894      */
895     enum CodecID subtitle_codec_id;
896
897     /**
898      * Maximum amount of memory in bytes to use for the index of each stream.
899      * If the index exceeds this size, entries will be discarded as
900      * needed to maintain a smaller size. This can lead to slower or less
901      * accurate seeking (depends on demuxer).
902      * Demuxers for which a full in-memory index is mandatory will ignore
903      * this.
904      * muxing  : unused
905      * demuxing: set by user
906      */
907     unsigned int max_index_size;
908
909     /**
910      * Maximum amount of memory in bytes to use for buffering frames
911      * obtained from realtime capture devices.
912      */
913     unsigned int max_picture_buffer;
914
915     unsigned int nb_chapters;
916     AVChapter **chapters;
917
918     /**
919      * Flags to enable debugging.
920      */
921     int debug;
922 #define FF_FDEBUG_TS        0x0001
923
924 #if FF_API_REORDER_PRIVATE
925     /**
926      * Raw packets from the demuxer, prior to parsing and decoding.
927      * This buffer is used for buffering packets until the codec can
928      * be identified, as parsing cannot be done without knowing the
929      * codec.
930      */
931     struct AVPacketList *raw_packet_buffer;
932     struct AVPacketList *raw_packet_buffer_end;
933
934     struct AVPacketList *packet_buffer_end;
935 #endif
936
937     AVDictionary *metadata;
938
939 #if FF_API_REORDER_PRIVATE
940     /**
941      * Remaining size available for raw_packet_buffer, in bytes.
942      * NOT PART OF PUBLIC API
943      */
944 #define RAW_PACKET_BUFFER_SIZE 2500000
945     int raw_packet_buffer_remaining_size;
946 #endif
947
948     /**
949      * Start time of the stream in real world time, in microseconds
950      * since the unix epoch (00:00 1st January 1970). That is, pts=0
951      * in the stream was captured at this real world time.
952      * - encoding: Set by user.
953      * - decoding: Unused.
954      */
955     int64_t start_time_realtime;
956
957     /**
958      * decoding: number of frames used to probe fps
959      */
960     int fps_probe_size;
961
962     /**
963      * Error recognition; higher values will detect more errors but may
964      * misdetect some more or less valid parts as errors.
965      * - encoding: unused
966      * - decoding: Set by user.
967      */
968     int error_recognition;
969
970     /**
971      * Custom interrupt callbacks for the I/O layer.
972      *
973      * decoding: set by the user before avformat_open_input().
974      * encoding: set by the user before avformat_write_header()
975      * (mainly useful for AVFMT_NOFILE formats). The callback
976      * should also be passed to avio_open2() if it's used to
977      * open the file.
978      */
979     AVIOInterruptCB interrupt_callback;
980
981     /*****************************************************************
982      * All fields below this line are not part of the public API. They
983      * may not be used outside of libavformat and can be changed and
984      * removed at will.
985      * New public fields should be added right above.
986      *****************************************************************
987      */
988 #if !FF_API_REORDER_PRIVATE
989     /**
990      * Raw packets from the demuxer, prior to parsing and decoding.
991      * This buffer is used for buffering packets until the codec can
992      * be identified, as parsing cannot be done without knowing the
993      * codec.
994      */
995     struct AVPacketList *raw_packet_buffer;
996     struct AVPacketList *raw_packet_buffer_end;
997     /**
998      * Remaining size available for raw_packet_buffer, in bytes.
999      */
1000 #define RAW_PACKET_BUFFER_SIZE 2500000
1001     int raw_packet_buffer_remaining_size;
1002
1003     /**
1004      * This buffer is only needed when packets were already buffered but
1005      * not decoded, for example to get the codec parameters in MPEG
1006      * streams.
1007      */
1008     struct AVPacketList *packet_buffer;
1009     struct AVPacketList *packet_buffer_end;
1010
1011     /* av_read_frame() support */
1012     AVStream *cur_st;
1013
1014     /* av_seek_frame() support */
1015     int64_t data_offset; /**< offset of the first packet */
1016 #endif
1017 } AVFormatContext;
1018
1019 typedef struct AVPacketList {
1020     AVPacket pkt;
1021     struct AVPacketList *next;
1022 } AVPacketList;
1023
1024
1025 /**
1026  * @defgroup lavf_core Core functions
1027  * @ingroup libavf
1028  *
1029  * Functions for querying libavformat capabilities, allocating core structures,
1030  * etc.
1031  * @{
1032  */
1033
1034 /**
1035  * Return the LIBAVFORMAT_VERSION_INT constant.
1036  */
1037 unsigned avformat_version(void);
1038
1039 /**
1040  * Return the libavformat build-time configuration.
1041  */
1042 const char *avformat_configuration(void);
1043
1044 /**
1045  * Return the libavformat license.
1046  */
1047 const char *avformat_license(void);
1048
1049 /**
1050  * Initialize libavformat and register all the muxers, demuxers and
1051  * protocols. If you do not call this function, then you can select
1052  * exactly which formats you want to support.
1053  *
1054  * @see av_register_input_format()
1055  * @see av_register_output_format()
1056  * @see av_register_protocol()
1057  */
1058 void av_register_all(void);
1059
1060 void av_register_input_format(AVInputFormat *format);
1061 void av_register_output_format(AVOutputFormat *format);
1062
1063 /**
1064  * Do global initialization of network components. This is optional,
1065  * but recommended, since it avoids the overhead of implicitly
1066  * doing the setup for each session.
1067  *
1068  * Calling this function will become mandatory if using network
1069  * protocols at some major version bump.
1070  */
1071 int avformat_network_init(void);
1072
1073 /**
1074  * Undo the initialization done by avformat_network_init.
1075  */
1076 int avformat_network_deinit(void);
1077
1078 /**
1079  * If f is NULL, returns the first registered input format,
1080  * if f is non-NULL, returns the next registered input format after f
1081  * or NULL if f is the last one.
1082  */
1083 AVInputFormat  *av_iformat_next(AVInputFormat  *f);
1084
1085 /**
1086  * If f is NULL, returns the first registered output format,
1087  * if f is non-NULL, returns the next registered output format after f
1088  * or NULL if f is the last one.
1089  */
1090 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
1091
1092 /**
1093  * Allocate an AVFormatContext.
1094  * avformat_free_context() can be used to free the context and everything
1095  * allocated by the framework within it.
1096  */
1097 AVFormatContext *avformat_alloc_context(void);
1098
1099 /**
1100  * Free an AVFormatContext and all its streams.
1101  * @param s context to free
1102  */
1103 void avformat_free_context(AVFormatContext *s);
1104
1105 /**
1106  * Get the AVClass for AVFormatContext. It can be used in combination with
1107  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1108  *
1109  * @see av_opt_find().
1110  */
1111 const AVClass *avformat_get_class(void);
1112
1113 /**
1114  * Add a new stream to a media file.
1115  *
1116  * When demuxing, it is called by the demuxer in read_header(). If the
1117  * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1118  * be called in read_packet().
1119  *
1120  * When muxing, should be called by the user before avformat_write_header().
1121  *
1122  * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1123  * will be initialized to use this codec. This is needed for e.g. codec-specific
1124  * defaults to be set, so codec should be provided if it is known.
1125  *
1126  * @return newly created stream or NULL on error.
1127  */
1128 AVStream *avformat_new_stream(AVFormatContext *s, AVCodec *c);
1129
1130 AVProgram *av_new_program(AVFormatContext *s, int id);
1131
1132 /**
1133  * @}
1134  */
1135
1136
1137 /**
1138  * @addtogroup lavf_decoding
1139  * @{
1140  */
1141
1142 /**
1143  * Find AVInputFormat based on the short name of the input format.
1144  */
1145 AVInputFormat *av_find_input_format(const char *short_name);
1146
1147 /**
1148  * Guess the file format.
1149  *
1150  * @param is_opened Whether the file is already opened; determines whether
1151  *                  demuxers with or without AVFMT_NOFILE are probed.
1152  */
1153 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1154
1155 /**
1156  * Guess the file format.
1157  *
1158  * @param is_opened Whether the file is already opened; determines whether
1159  *                  demuxers with or without AVFMT_NOFILE are probed.
1160  * @param score_max A probe score larger that this is required to accept a
1161  *                  detection, the variable is set to the actual detection
1162  *                  score afterwards.
1163  *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1164  *                  to retry with a larger probe buffer.
1165  */
1166 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1167
1168 /**
1169  * Probe a bytestream to determine the input format. Each time a probe returns
1170  * with a score that is too low, the probe buffer size is increased and another
1171  * attempt is made. When the maximum probe size is reached, the input format
1172  * with the highest score is returned.
1173  *
1174  * @param pb the bytestream to probe
1175  * @param fmt the input format is put here
1176  * @param filename the filename of the stream
1177  * @param logctx the log context
1178  * @param offset the offset within the bytestream to probe from
1179  * @param max_probe_size the maximum probe buffer size (zero for default)
1180  * @return 0 in case of success, a negative value corresponding to an
1181  * AVERROR code otherwise
1182  */
1183 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1184                           const char *filename, void *logctx,
1185                           unsigned int offset, unsigned int max_probe_size);
1186
1187 /**
1188  * Open an input stream and read the header. The codecs are not opened.
1189  * The stream must be closed with av_close_input_file().
1190  *
1191  * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1192  *           May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1193  *           function and written into ps.
1194  *           Note that a user-supplied AVFormatContext will be freed on failure.
1195  * @param filename Name of the stream to open.
1196  * @param fmt If non-NULL, this parameter forces a specific input format.
1197  *            Otherwise the format is autodetected.
1198  * @param options  A dictionary filled with AVFormatContext and demuxer-private options.
1199  *                 On return this parameter will be destroyed and replaced with a dict containing
1200  *                 options that were not found. May be NULL.
1201  *
1202  * @return 0 on success, a negative AVERROR on failure.
1203  *
1204  * @note If you want to use custom IO, preallocate the format context and set its pb field.
1205  */
1206 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1207
1208 /**
1209  * Read packets of a media file to get stream information. This
1210  * is useful for file formats with no headers such as MPEG. This
1211  * function also computes the real framerate in case of MPEG-2 repeat
1212  * frame mode.
1213  * The logical file position is not changed by this function;
1214  * examined packets may be buffered for later processing.
1215  *
1216  * @param ic media file handle
1217  * @param options  If non-NULL, an ic.nb_streams long array of pointers to
1218  *                 dictionaries, where i-th member contains options for
1219  *                 codec corresponding to i-th stream.
1220  *                 On return each dictionary will be filled with options that were not found.
1221  * @return >=0 if OK, AVERROR_xxx on error
1222  *
1223  * @note this function isn't guaranteed to open all the codecs, so
1224  *       options being non-empty at return is a perfectly normal behavior.
1225  *
1226  * @todo Let the user decide somehow what information is needed so that
1227  *       we do not waste time getting stuff the user does not need.
1228  */
1229 int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
1230
1231 /**
1232  * Find the "best" stream in the file.
1233  * The best stream is determined according to various heuristics as the most
1234  * likely to be what the user expects.
1235  * If the decoder parameter is non-NULL, av_find_best_stream will find the
1236  * default decoder for the stream's codec; streams for which no decoder can
1237  * be found are ignored.
1238  *
1239  * @param ic                media file handle
1240  * @param type              stream type: video, audio, subtitles, etc.
1241  * @param wanted_stream_nb  user-requested stream number,
1242  *                          or -1 for automatic selection
1243  * @param related_stream    try to find a stream related (eg. in the same
1244  *                          program) to this one, or -1 if none
1245  * @param decoder_ret       if non-NULL, returns the decoder for the
1246  *                          selected stream
1247  * @param flags             flags; none are currently defined
1248  * @return  the non-negative stream number in case of success,
1249  *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1250  *          could be found,
1251  *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1252  * @note  If av_find_best_stream returns successfully and decoder_ret is not
1253  *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1254  */
1255 int av_find_best_stream(AVFormatContext *ic,
1256                         enum AVMediaType type,
1257                         int wanted_stream_nb,
1258                         int related_stream,
1259                         AVCodec **decoder_ret,
1260                         int flags);
1261
1262 /**
1263  * Read a transport packet from a media file.
1264  *
1265  * This function is obsolete and should never be used.
1266  * Use av_read_frame() instead.
1267  *
1268  * @param s media file handle
1269  * @param pkt is filled
1270  * @return 0 if OK, AVERROR_xxx on error
1271  */
1272 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1273
1274 /**
1275  * Return the next frame of a stream.
1276  * This function returns what is stored in the file, and does not validate
1277  * that what is there are valid frames for the decoder. It will split what is
1278  * stored in the file into frames and return one for each call. It will not
1279  * omit invalid data between valid frames so as to give the decoder the maximum
1280  * information possible for decoding.
1281  *
1282  * The returned packet is valid
1283  * until the next av_read_frame() or until av_close_input_file() and
1284  * must be freed with av_free_packet. For video, the packet contains
1285  * exactly one frame. For audio, it contains an integer number of
1286  * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1287  * data). If the audio frames have a variable size (e.g. MPEG audio),
1288  * then it contains one frame.
1289  *
1290  * pkt->pts, pkt->dts and pkt->duration are always set to correct
1291  * values in AVStream.time_base units (and guessed if the format cannot
1292  * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1293  * has B-frames, so it is better to rely on pkt->dts if you do not
1294  * decompress the payload.
1295  *
1296  * @return 0 if OK, < 0 on error or end of file
1297  */
1298 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1299
1300 /**
1301  * Seek to the keyframe at timestamp.
1302  * 'timestamp' in 'stream_index'.
1303  * @param stream_index If stream_index is (-1), a default
1304  * stream is selected, and timestamp is automatically converted
1305  * from AV_TIME_BASE units to the stream specific time_base.
1306  * @param timestamp Timestamp in AVStream.time_base units
1307  *        or, if no stream is specified, in AV_TIME_BASE units.
1308  * @param flags flags which select direction and seeking mode
1309  * @return >= 0 on success
1310  */
1311 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1312                   int flags);
1313
1314 /**
1315  * Seek to timestamp ts.
1316  * Seeking will be done so that the point from which all active streams
1317  * can be presented successfully will be closest to ts and within min/max_ts.
1318  * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1319  *
1320  * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1321  * are the file position (this may not be supported by all demuxers).
1322  * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1323  * in the stream with stream_index (this may not be supported by all demuxers).
1324  * Otherwise all timestamps are in units of the stream selected by stream_index
1325  * or if stream_index is -1, in AV_TIME_BASE units.
1326  * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1327  * keyframes (this may not be supported by all demuxers).
1328  *
1329  * @param stream_index index of the stream which is used as time base reference
1330  * @param min_ts smallest acceptable timestamp
1331  * @param ts target timestamp
1332  * @param max_ts largest acceptable timestamp
1333  * @param flags flags
1334  * @return >=0 on success, error code otherwise
1335  *
1336  * @note This is part of the new seek API which is still under construction.
1337  *       Thus do not use this yet. It may change at any time, do not expect
1338  *       ABI compatibility yet!
1339  */
1340 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1341
1342 /**
1343  * Start playing a network-based stream (e.g. RTSP stream) at the
1344  * current position.
1345  */
1346 int av_read_play(AVFormatContext *s);
1347
1348 /**
1349  * Pause a network-based stream (e.g. RTSP stream).
1350  *
1351  * Use av_read_play() to resume it.
1352  */
1353 int av_read_pause(AVFormatContext *s);
1354
1355 #if FF_API_CLOSE_INPUT_FILE
1356 /**
1357  * @deprecated use avformat_close_input()
1358  * Close a media file (but not its codecs).
1359  *
1360  * @param s media file handle
1361  */
1362 attribute_deprecated
1363 void av_close_input_file(AVFormatContext *s);
1364 #endif
1365
1366 /**
1367  * Close an opened input AVFormatContext. Free it and all its contents
1368  * and set *s to NULL.
1369  */
1370 void avformat_close_input(AVFormatContext **s);
1371 /**
1372  * @}
1373  */
1374
1375 #if FF_API_SET_PTS_INFO
1376 /**
1377  * @deprecated this function is not supposed to be called outside of lavf
1378  */
1379 attribute_deprecated
1380 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1381                      unsigned int pts_num, unsigned int pts_den);
1382 #endif
1383
1384 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1385 #define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1386 #define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1387 #define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1388
1389 /**
1390  * @addtogroup lavf_encoding
1391  * @{
1392  */
1393 /**
1394  * Allocate the stream private data and write the stream header to
1395  * an output media file.
1396  *
1397  * @param s Media file handle, must be allocated with avformat_alloc_context().
1398  *          Its oformat field must be set to the desired output format;
1399  *          Its pb field must be set to an already openened AVIOContext.
1400  * @param options  An AVDictionary filled with AVFormatContext and muxer-private options.
1401  *                 On return this parameter will be destroyed and replaced with a dict containing
1402  *                 options that were not found. May be NULL.
1403  *
1404  * @return 0 on success, negative AVERROR on failure.
1405  *
1406  * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1407  */
1408 int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1409
1410 /**
1411  * Write a packet to an output media file.
1412  *
1413  * The packet shall contain one audio or video frame.
1414  * The packet must be correctly interleaved according to the container
1415  * specification, if not then av_interleaved_write_frame must be used.
1416  *
1417  * @param s media file handle
1418  * @param pkt The packet, which contains the stream_index, buf/buf_size,
1419  *            dts/pts, ...
1420  *            This can be NULL (at any time, not just at the end), in
1421  *            order to immediately flush data buffered within the muxer,
1422  *            for muxers that buffer up data internally before writing it
1423  *            to the output.
1424  * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush
1425  */
1426 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1427
1428 /**
1429  * Write a packet to an output media file ensuring correct interleaving.
1430  *
1431  * The packet must contain one audio or video frame.
1432  * If the packets are already correctly interleaved, the application should
1433  * call av_write_frame() instead as it is slightly faster. It is also important
1434  * to keep in mind that completely non-interleaved input will need huge amounts
1435  * of memory to interleave with this, so it is preferable to interleave at the
1436  * demuxer level.
1437  *
1438  * @param s media file handle
1439  * @param pkt The packet containing the data to be written. Libavformat takes
1440  * ownership of the data and will free it when it sees fit using the packet's
1441  * @ref AVPacket.destruct "destruct" field. The caller must not access the data
1442  * after this function returns, as it may already be freed.
1443  * Packet's @ref AVPacket.stream_index "stream_index" field must be set to the
1444  * index of the corresponding stream in @ref AVFormatContext.streams
1445  * "s.streams".
1446  * It is very strongly recommended that timing information (@ref AVPacket.pts
1447  * "pts", @ref AVPacket.dts "dts" @ref AVPacket.duration "duration") is set to
1448  * correct values.
1449  *
1450  * @return 0 on success, a negative AVERROR on error.
1451  */
1452 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1453
1454 /**
1455  * Interleave a packet per dts in an output media file.
1456  *
1457  * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1458  * function, so they cannot be used after it. Note that calling av_free_packet()
1459  * on them is still safe.
1460  *
1461  * @param s media file handle
1462  * @param out the interleaved packet will be output here
1463  * @param pkt the input packet
1464  * @param flush 1 if no further packets are available as input and all
1465  *              remaining packets should be output
1466  * @return 1 if a packet was output, 0 if no packet could be output,
1467  *         < 0 if an error occurred
1468  */
1469 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1470                                  AVPacket *pkt, int flush);
1471
1472 /**
1473  * Write the stream trailer to an output media file and free the
1474  * file private data.
1475  *
1476  * May only be called after a successful call to av_write_header.
1477  *
1478  * @param s media file handle
1479  * @return 0 if OK, AVERROR_xxx on error
1480  */
1481 int av_write_trailer(AVFormatContext *s);
1482
1483 /**
1484  * Return the output format in the list of registered output formats
1485  * which best matches the provided parameters, or return NULL if
1486  * there is no match.
1487  *
1488  * @param short_name if non-NULL checks if short_name matches with the
1489  * names of the registered formats
1490  * @param filename if non-NULL checks if filename terminates with the
1491  * extensions of the registered formats
1492  * @param mime_type if non-NULL checks if mime_type matches with the
1493  * MIME type of the registered formats
1494  */
1495 AVOutputFormat *av_guess_format(const char *short_name,
1496                                 const char *filename,
1497                                 const char *mime_type);
1498
1499 /**
1500  * Guess the codec ID based upon muxer and filename.
1501  */
1502 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
1503                             const char *filename, const char *mime_type,
1504                             enum AVMediaType type);
1505
1506 /**
1507  * @}
1508  */
1509
1510
1511 /**
1512  * @defgroup lavf_misc Utility functions
1513  * @ingroup libavf
1514  * @{
1515  *
1516  * Miscelaneous utility functions related to both muxing and demuxing
1517  * (or neither).
1518  */
1519
1520 /**
1521  * Send a nice hexadecimal dump of a buffer to the specified file stream.
1522  *
1523  * @param f The file stream pointer where the dump should be sent to.
1524  * @param buf buffer
1525  * @param size buffer size
1526  *
1527  * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
1528  */
1529 void av_hex_dump(FILE *f, uint8_t *buf, int size);
1530
1531 /**
1532  * Send a nice hexadecimal dump of a buffer to the log.
1533  *
1534  * @param avcl A pointer to an arbitrary struct of which the first field is a
1535  * pointer to an AVClass struct.
1536  * @param level The importance level of the message, lower values signifying
1537  * higher importance.
1538  * @param buf buffer
1539  * @param size buffer size
1540  *
1541  * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
1542  */
1543 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
1544
1545 /**
1546  * Send a nice dump of a packet to the specified file stream.
1547  *
1548  * @param f The file stream pointer where the dump should be sent to.
1549  * @param pkt packet to dump
1550  * @param dump_payload True if the payload must be displayed, too.
1551  * @param st AVStream that the packet belongs to
1552  */
1553 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
1554
1555
1556 /**
1557  * Send a nice dump of a packet to the log.
1558  *
1559  * @param avcl A pointer to an arbitrary struct of which the first field is a
1560  * pointer to an AVClass struct.
1561  * @param level The importance level of the message, lower values signifying
1562  * higher importance.
1563  * @param pkt packet to dump
1564  * @param dump_payload True if the payload must be displayed, too.
1565  * @param st AVStream that the packet belongs to
1566  */
1567 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
1568                       AVStream *st);
1569
1570 /**
1571  * Get the CodecID for the given codec tag tag.
1572  * If no codec id is found returns CODEC_ID_NONE.
1573  *
1574  * @param tags list of supported codec_id-codec_tag pairs, as stored
1575  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1576  */
1577 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1578
1579 /**
1580  * Get the codec tag for the given codec id id.
1581  * If no codec tag is found returns 0.
1582  *
1583  * @param tags list of supported codec_id-codec_tag pairs, as stored
1584  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1585  */
1586 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1587
1588 int av_find_default_stream_index(AVFormatContext *s);
1589
1590 /**
1591  * Get the index for a specific timestamp.
1592  * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1593  *                 to the timestamp which is <= the requested one, if backward
1594  *                 is 0, then it will be >=
1595  *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1596  * @return < 0 if no such timestamp could be found
1597  */
1598 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1599
1600 /**
1601  * Add an index entry into a sorted list. Update the entry if the list
1602  * already contains it.
1603  *
1604  * @param timestamp timestamp in the time base of the given stream
1605  */
1606 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1607                        int size, int distance, int flags);
1608
1609
1610 /**
1611  * Split a URL string into components.
1612  *
1613  * The pointers to buffers for storing individual components may be null,
1614  * in order to ignore that component. Buffers for components not found are
1615  * set to empty strings. If the port is not found, it is set to a negative
1616  * value.
1617  *
1618  * @param proto the buffer for the protocol
1619  * @param proto_size the size of the proto buffer
1620  * @param authorization the buffer for the authorization
1621  * @param authorization_size the size of the authorization buffer
1622  * @param hostname the buffer for the host name
1623  * @param hostname_size the size of the hostname buffer
1624  * @param port_ptr a pointer to store the port number in
1625  * @param path the buffer for the path
1626  * @param path_size the size of the path buffer
1627  * @param url the URL to split
1628  */
1629 void av_url_split(char *proto,         int proto_size,
1630                   char *authorization, int authorization_size,
1631                   char *hostname,      int hostname_size,
1632                   int *port_ptr,
1633                   char *path,          int path_size,
1634                   const char *url);
1635
1636
1637 void av_dump_format(AVFormatContext *ic,
1638                     int index,
1639                     const char *url,
1640                     int is_output);
1641
1642 /**
1643  * Get the current time in microseconds.
1644  */
1645 int64_t av_gettime(void);
1646
1647 /**
1648  * Return in 'buf' the path with '%d' replaced by a number.
1649  *
1650  * Also handles the '%0nd' format where 'n' is the total number
1651  * of digits and '%%'.
1652  *
1653  * @param buf destination buffer
1654  * @param buf_size destination buffer size
1655  * @param path numbered sequence string
1656  * @param number frame number
1657  * @return 0 if OK, -1 on format error
1658  */
1659 int av_get_frame_filename(char *buf, int buf_size,
1660                           const char *path, int number);
1661
1662 /**
1663  * Check whether filename actually is a numbered sequence generator.
1664  *
1665  * @param filename possible numbered sequence string
1666  * @return 1 if a valid numbered sequence string, 0 otherwise
1667  */
1668 int av_filename_number_test(const char *filename);
1669
1670 /**
1671  * Generate an SDP for an RTP session.
1672  *
1673  * @param ac array of AVFormatContexts describing the RTP streams. If the
1674  *           array is composed by only one context, such context can contain
1675  *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1676  *           all the contexts in the array (an AVCodecContext per RTP stream)
1677  *           must contain only one AVStream.
1678  * @param n_files number of AVCodecContexts contained in ac
1679  * @param buf buffer where the SDP will be stored (must be allocated by
1680  *            the caller)
1681  * @param size the size of the buffer
1682  * @return 0 if OK, AVERROR_xxx on error
1683  */
1684 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1685
1686 /**
1687  * Return a positive value if the given filename has one of the given
1688  * extensions, 0 otherwise.
1689  *
1690  * @param extensions a comma-separated list of filename extensions
1691  */
1692 int av_match_ext(const char *filename, const char *extensions);
1693
1694 /**
1695  * Test if the given container can store a codec.
1696  *
1697  * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
1698  *
1699  * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
1700  *         A negative number if this information is not available.
1701  */
1702 int avformat_query_codec(AVOutputFormat *ofmt, enum CodecID codec_id, int std_compliance);
1703
1704 /**
1705  * @}
1706  */
1707
1708 #endif /* AVFORMAT_AVFORMAT_H */