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