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