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