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