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