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