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