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