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