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