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