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