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