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