258501abcd2eb56911b676a4625b8bd5fc732bcf
[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 58
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. NEVER set this value directly: it is deduced from the
615        AVStream values.  */
616     int64_t duration;
617     /** decoding: total file size, 0 if unknown */
618     int64_t file_size;
619     /** Decoding: total stream bitrate in bit/s, 0 if not
620        available. Never set it directly if the file_size and the
621        duration are known as FFmpeg can compute it automatically. */
622     int bit_rate;
623
624     /* av_read_frame() support */
625     AVStream *cur_st;
626 #if LIBAVFORMAT_VERSION_INT < (53<<16)
627     const uint8_t *cur_ptr_deprecated;
628     int cur_len_deprecated;
629     AVPacket cur_pkt_deprecated;
630 #endif
631
632     /* av_seek_frame() support */
633     int64_t data_offset; /** offset of the first packet */
634     int index_built;
635
636     int mux_rate;
637     unsigned int packet_size;
638     int preload;
639     int max_delay;
640
641 #define AVFMT_NOOUTPUTLOOP -1
642 #define AVFMT_INFINITEOUTPUTLOOP 0
643     /** number of times to loop output in formats that support it */
644     int loop_output;
645
646     int flags;
647 #define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
648 #define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
649 #define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
650 #define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
651
652     int loop_input;
653     /** decoding: size of data to probe; encoding: unused. */
654     unsigned int probesize;
655
656     /**
657      * Maximum time (in AV_TIME_BASE units) during which the input should
658      * be analyzed in av_find_stream_info().
659      */
660     int max_analyze_duration;
661
662     const uint8_t *key;
663     int keylen;
664
665     unsigned int nb_programs;
666     AVProgram **programs;
667
668     /**
669      * Forced video codec_id.
670      * Demuxing: Set by user.
671      */
672     enum CodecID video_codec_id;
673     /**
674      * Forced audio codec_id.
675      * Demuxing: Set by user.
676      */
677     enum CodecID audio_codec_id;
678     /**
679      * Forced subtitle codec_id.
680      * Demuxing: Set by user.
681      */
682     enum CodecID subtitle_codec_id;
683
684     /**
685      * Maximum amount of memory in bytes to use for the index of each stream.
686      * If the index exceeds this size, entries will be discarded as
687      * needed to maintain a smaller size. This can lead to slower or less
688      * accurate seeking (depends on demuxer).
689      * Demuxers for which a full in-memory index is mandatory will ignore
690      * this.
691      * muxing  : unused
692      * demuxing: set by user
693      */
694     unsigned int max_index_size;
695
696     /**
697      * Maximum amount of memory in bytes to use for buffering frames
698      * obtained from realtime capture devices.
699      */
700     unsigned int max_picture_buffer;
701
702     unsigned int nb_chapters;
703     AVChapter **chapters;
704
705     /**
706      * Flags to enable debugging.
707      */
708     int debug;
709 #define FF_FDEBUG_TS        0x0001
710
711     /**
712      * Raw packets from the demuxer, prior to parsing and decoding.
713      * This buffer is used for buffering packets until the codec can
714      * be identified, as parsing cannot be done without knowing the
715      * codec.
716      */
717     struct AVPacketList *raw_packet_buffer;
718     struct AVPacketList *raw_packet_buffer_end;
719
720     struct AVPacketList *packet_buffer_end;
721
722     AVMetadata *metadata;
723
724     /**
725      * Remaining size available for raw_packet_buffer, in bytes.
726      * NOT PART OF PUBLIC API
727      */
728 #define RAW_PACKET_BUFFER_SIZE 2500000
729     int raw_packet_buffer_remaining_size;
730
731     /**
732      * Start time of the stream in real world time, in microseconds
733      * since the unix epoch (00:00 1st January 1970). That is, pts=0
734      * in the stream was captured at this real world time.
735      * - encoding: Set by user.
736      * - decoding: Unused.
737      */
738     int64_t start_time_realtime;
739 } AVFormatContext;
740
741 typedef struct AVPacketList {
742     AVPacket pkt;
743     struct AVPacketList *next;
744 } AVPacketList;
745
746 #if LIBAVFORMAT_VERSION_INT < (53<<16)
747 extern AVInputFormat *first_iformat;
748 extern AVOutputFormat *first_oformat;
749 #endif
750
751 /**
752  * If f is NULL, returns the first registered input format,
753  * if f is non-NULL, returns the next registered input format after f
754  * or NULL if f is the last one.
755  */
756 AVInputFormat  *av_iformat_next(AVInputFormat  *f);
757
758 /**
759  * If f is NULL, returns the first registered output format,
760  * if f is non-NULL, returns the next registered output format after f
761  * or NULL if f is the last one.
762  */
763 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
764
765 enum CodecID av_guess_image2_codec(const char *filename);
766
767 /* XXX: Use automatic init with either ELF sections or C file parser */
768 /* modules. */
769
770 /* utils.c */
771 void av_register_input_format(AVInputFormat *format);
772 void av_register_output_format(AVOutputFormat *format);
773 #if LIBAVFORMAT_VERSION_MAJOR < 53
774 attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
775                                     const char *filename,
776                                     const char *mime_type);
777
778 /**
779  * @deprecated Use av_guess_format() instead.
780  */
781 attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
782                                                   const char *filename,
783                                                   const char *mime_type);
784 #endif
785
786 /**
787  * Returns the output format in the list of registered output formats
788  * which best matches the provided parameters, or returns NULL if
789  * there is no match.
790  *
791  * @param short_name if non-NULL checks if short_name matches with the
792  * names of the registered formats
793  * @param filename if non-NULL checks if filename terminates with the
794  * extensions of the registered formats
795  * @param mime_type if non-NULL checks if mime_type matches with the
796  * MIME type of the registered formats
797  */
798 AVOutputFormat *av_guess_format(const char *short_name,
799                                 const char *filename,
800                                 const char *mime_type);
801
802 /**
803  * Guesses the codec ID based upon muxer and filename.
804  */
805 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
806                             const char *filename, const char *mime_type,
807                             enum CodecType type);
808
809 /**
810  * Sends a nice hexadecimal dump of a buffer to the specified file stream.
811  *
812  * @param f The file stream pointer where the dump should be sent to.
813  * @param buf buffer
814  * @param size buffer size
815  *
816  * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
817  */
818 void av_hex_dump(FILE *f, uint8_t *buf, int size);
819
820 /**
821  * Sends a nice hexadecimal dump of a buffer to the log.
822  *
823  * @param avcl A pointer to an arbitrary struct of which the first field is a
824  * pointer to an AVClass struct.
825  * @param level The importance level of the message, lower values signifying
826  * higher importance.
827  * @param buf buffer
828  * @param size buffer size
829  *
830  * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
831  */
832 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
833
834 /**
835  * Sends a nice dump of a packet to the specified file stream.
836  *
837  * @param f The file stream pointer where the dump should be sent to.
838  * @param pkt packet to dump
839  * @param dump_payload True if the payload must be displayed, too.
840  */
841 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
842
843 /**
844  * Sends a nice dump of a packet to the log.
845  *
846  * @param avcl A pointer to an arbitrary struct of which the first field is a
847  * pointer to an AVClass struct.
848  * @param level The importance level of the message, lower values signifying
849  * higher importance.
850  * @param pkt packet to dump
851  * @param dump_payload True if the payload must be displayed, too.
852  */
853 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
854
855 /**
856  * Initializes libavformat and registers all the muxers, demuxers and
857  * protocols. If you do not call this function, then you can select
858  * exactly which formats you want to support.
859  *
860  * @see av_register_input_format()
861  * @see av_register_output_format()
862  * @see av_register_protocol()
863  */
864 void av_register_all(void);
865
866 /** codec tag <-> codec id */
867 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
868 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
869
870 /* media file input */
871
872 /**
873  * Finds AVInputFormat based on the short name of the input format.
874  */
875 AVInputFormat *av_find_input_format(const char *short_name);
876
877 /**
878  * Guesses the file format.
879  *
880  * @param is_opened Whether the file is already opened; determines whether
881  *                  demuxers with or without AVFMT_NOFILE are probed.
882  */
883 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
884
885 /**
886  * Allocates all the structures needed to read an input stream.
887  *        This does not open the needed codecs for decoding the stream[s].
888  */
889 int av_open_input_stream(AVFormatContext **ic_ptr,
890                          ByteIOContext *pb, const char *filename,
891                          AVInputFormat *fmt, AVFormatParameters *ap);
892
893 /**
894  * Opens a media file as input. The codecs are not opened. Only the file
895  * header (if present) is read.
896  *
897  * @param ic_ptr The opened media file handle is put here.
898  * @param filename filename to open
899  * @param fmt If non-NULL, force the file format to use.
900  * @param buf_size optional buffer size (zero if default is OK)
901  * @param ap Additional parameters needed when opening the file
902  *           (NULL if default).
903  * @return 0 if OK, AVERROR_xxx otherwise
904  */
905 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
906                        AVInputFormat *fmt,
907                        int buf_size,
908                        AVFormatParameters *ap);
909
910 #if LIBAVFORMAT_VERSION_MAJOR < 53
911 /**
912  * @deprecated Use avformat_alloc_context() instead.
913  */
914 attribute_deprecated AVFormatContext *av_alloc_format_context(void);
915 #endif
916
917 /**
918  * Allocates an AVFormatContext.
919  * Can be freed with av_free() but do not forget to free everything you
920  * explicitly allocated as well!
921  */
922 AVFormatContext *avformat_alloc_context(void);
923
924 /**
925  * Reads packets of a media file to get stream information. This
926  * is useful for file formats with no headers such as MPEG. This
927  * function also computes the real framerate in case of MPEG-2 repeat
928  * frame mode.
929  * The logical file position is not changed by this function;
930  * examined packets may be buffered for later processing.
931  *
932  * @param ic media file handle
933  * @return >=0 if OK, AVERROR_xxx on error
934  * @todo Let the user decide somehow what information is needed so that
935  *       we do not waste time getting stuff the user does not need.
936  */
937 int av_find_stream_info(AVFormatContext *ic);
938
939 /**
940  * Reads a transport packet from a media file.
941  *
942  * This function is obsolete and should never be used.
943  * Use av_read_frame() instead.
944  *
945  * @param s media file handle
946  * @param pkt is filled
947  * @return 0 if OK, AVERROR_xxx on error
948  */
949 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
950
951 /**
952  * Returns the next frame of a stream.
953  *
954  * The returned packet is valid
955  * until the next av_read_frame() or until av_close_input_file() and
956  * must be freed with av_free_packet. For video, the packet contains
957  * exactly one frame. For audio, it contains an integer number of
958  * frames if each frame has a known fixed size (e.g. PCM or ADPCM
959  * data). If the audio frames have a variable size (e.g. MPEG audio),
960  * then it contains one frame.
961  *
962  * pkt->pts, pkt->dts and pkt->duration are always set to correct
963  * values in AVStream.time_base units (and guessed if the format cannot
964  * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
965  * has B-frames, so it is better to rely on pkt->dts if you do not
966  * decompress the payload.
967  *
968  * @return 0 if OK, < 0 on error or end of file
969  */
970 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
971
972 /**
973  * Seeks to the keyframe at timestamp.
974  * 'timestamp' in 'stream_index'.
975  * @param stream_index If stream_index is (-1), a default
976  * stream is selected, and timestamp is automatically converted
977  * from AV_TIME_BASE units to the stream specific time_base.
978  * @param timestamp Timestamp in AVStream.time_base units
979  *        or, if no stream is specified, in AV_TIME_BASE units.
980  * @param flags flags which select direction and seeking mode
981  * @return >= 0 on success
982  */
983 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
984                   int flags);
985
986 /**
987  * Seeks to timestamp ts.
988  * Seeking will be done so that the point from which all active streams
989  * can be presented successfully will be closest to ts and within min/max_ts.
990  * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
991  *
992  * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
993  * are the file position (this may not be supported by all demuxers).
994  * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
995  * in the stream with stream_index (this may not be supported by all demuxers).
996  * Otherwise all timestamps are in units of the stream selected by stream_index
997  * or if stream_index is -1, in AV_TIME_BASE units.
998  * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
999  * keyframes (this may not be supported by all demuxers).
1000  *
1001  * @param stream_index index of the stream which is used as time base reference
1002  * @param min_ts smallest acceptable timestamp
1003  * @param ts target timestamp
1004  * @param max_ts largest acceptable timestamp
1005  * @param flags flags
1006  * @returns >=0 on success, error code otherwise
1007  *
1008  * @NOTE This is part of the new seek API which is still under construction.
1009  *       Thus do not use this yet. It may change at any time, do not expect
1010  *       ABI compatibility yet!
1011  */
1012 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1013
1014 /**
1015  * Starts playing a network-based stream (e.g. RTSP stream) at the
1016  * current position.
1017  */
1018 int av_read_play(AVFormatContext *s);
1019
1020 /**
1021  * Pauses a network-based stream (e.g. RTSP stream).
1022  *
1023  * Use av_read_play() to resume it.
1024  */
1025 int av_read_pause(AVFormatContext *s);
1026
1027 /**
1028  * Frees a AVFormatContext allocated by av_open_input_stream.
1029  * @param s context to free
1030  */
1031 void av_close_input_stream(AVFormatContext *s);
1032
1033 /**
1034  * Closes a media file (but not its codecs).
1035  *
1036  * @param s media file handle
1037  */
1038 void av_close_input_file(AVFormatContext *s);
1039
1040 /**
1041  * Adds a new stream to a media file.
1042  *
1043  * Can only be called in the read_header() function. If the flag
1044  * AVFMTCTX_NOHEADER is in the format context, then new streams
1045  * can be added in read_packet too.
1046  *
1047  * @param s media file handle
1048  * @param id file-format-dependent stream ID
1049  */
1050 AVStream *av_new_stream(AVFormatContext *s, int id);
1051 AVProgram *av_new_program(AVFormatContext *s, int id);
1052
1053 /**
1054  * Adds a new chapter.
1055  * This function is NOT part of the public API
1056  * and should ONLY be used by demuxers.
1057  *
1058  * @param s media file handle
1059  * @param id unique ID for this chapter
1060  * @param start chapter start time in time_base units
1061  * @param end chapter end time in time_base units
1062  * @param title chapter title
1063  *
1064  * @return AVChapter or NULL on error
1065  */
1066 AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1067                           int64_t start, int64_t end, const char *title);
1068
1069 /**
1070  * Sets the pts for a given stream.
1071  *
1072  * @param s stream
1073  * @param pts_wrap_bits number of bits effectively used by the pts
1074  *        (used for wrap control, 33 is the value for MPEG)
1075  * @param pts_num numerator to convert to seconds (MPEG: 1)
1076  * @param pts_den denominator to convert to seconds (MPEG: 90000)
1077  */
1078 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1079                      unsigned int pts_num, unsigned int pts_den);
1080
1081 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1082 #define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1083 #define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1084 #define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1085
1086 int av_find_default_stream_index(AVFormatContext *s);
1087
1088 /**
1089  * Gets the index for a specific timestamp.
1090  * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1091  *                 to the timestamp which is <= the requested one, if backward
1092  *                 is 0, then it will be >=
1093  *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1094  * @return < 0 if no such timestamp could be found
1095  */
1096 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1097
1098 /**
1099  * Ensures the index uses less memory than the maximum specified in
1100  * AVFormatContext.max_index_size by discarding entries if it grows
1101  * too large.
1102  * This function is not part of the public API and should only be called
1103  * by demuxers.
1104  */
1105 void ff_reduce_index(AVFormatContext *s, int stream_index);
1106
1107 /**
1108  * Adds an index entry into a sorted list. Updates the entry if the list
1109  * already contains it.
1110  *
1111  * @param timestamp timestamp in the time base of the given stream
1112  */
1113 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1114                        int size, int distance, int flags);
1115
1116 /**
1117  * Does a binary search using av_index_search_timestamp() and
1118  * AVCodec.read_timestamp().
1119  * This is not supposed to be called directly by a user application,
1120  * but by demuxers.
1121  * @param target_ts target timestamp in the time base of the given stream
1122  * @param stream_index stream number
1123  */
1124 int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1125                          int64_t target_ts, int flags);
1126
1127 /**
1128  * Updates cur_dts of all streams based on the given timestamp and AVStream.
1129  *
1130  * Stream ref_st unchanged, others set cur_dts in their native time base.
1131  * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1132  * @param timestamp new dts expressed in time_base of param ref_st
1133  * @param ref_st reference stream giving time_base of param timestamp
1134  */
1135 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1136
1137 /**
1138  * Does a binary search using read_timestamp().
1139  * This is not supposed to be called directly by a user application,
1140  * but by demuxers.
1141  * @param target_ts target timestamp in the time base of the given stream
1142  * @param stream_index stream number
1143  */
1144 int64_t av_gen_search(AVFormatContext *s, int stream_index,
1145                       int64_t target_ts, int64_t pos_min,
1146                       int64_t pos_max, int64_t pos_limit,
1147                       int64_t ts_min, int64_t ts_max,
1148                       int flags, int64_t *ts_ret,
1149                       int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1150
1151 /** media file output */
1152 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1153
1154 /**
1155  * Allocates the stream private data and writes the stream header to an
1156  * output media file.
1157  *
1158  * @param s media file handle
1159  * @return 0 if OK, AVERROR_xxx on error
1160  */
1161 int av_write_header(AVFormatContext *s);
1162
1163 /**
1164  * Writes a packet to an output media file.
1165  *
1166  * The packet shall contain one audio or video frame.
1167  * The packet must be correctly interleaved according to the container
1168  * specification, if not then av_interleaved_write_frame must be used.
1169  *
1170  * @param s media file handle
1171  * @param pkt The packet, which contains the stream_index, buf/buf_size,
1172               dts/pts, ...
1173  * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1174  */
1175 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1176
1177 /**
1178  * Writes a packet to an output media file ensuring correct interleaving.
1179  *
1180  * The packet must contain one audio or video frame.
1181  * If the packets are already correctly interleaved, the application should
1182  * call av_write_frame() instead as it is slightly faster. It is also important
1183  * to keep in mind that completely non-interleaved input will need huge amounts
1184  * of memory to interleave with this, so it is preferable to interleave at the
1185  * demuxer level.
1186  *
1187  * @param s media file handle
1188  * @param pkt The packet, which contains the stream_index, buf/buf_size,
1189               dts/pts, ...
1190  * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1191  */
1192 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1193
1194 /**
1195  * Interleaves a packet per dts in an output media file.
1196  *
1197  * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1198  * function, so they cannot be used after it. Note that calling av_free_packet()
1199  * on them is still safe.
1200  *
1201  * @param s media file handle
1202  * @param out the interleaved packet will be output here
1203  * @param in the input packet
1204  * @param flush 1 if no further packets are available as input and all
1205  *              remaining packets should be output
1206  * @return 1 if a packet was output, 0 if no packet could be output,
1207  *         < 0 if an error occurred
1208  */
1209 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1210                                  AVPacket *pkt, int flush);
1211
1212 /**
1213  * Writes the stream trailer to an output media file and frees the
1214  * file private data.
1215  *
1216  * May only be called after a successful call to av_write_header.
1217  *
1218  * @param s media file handle
1219  * @return 0 if OK, AVERROR_xxx on error
1220  */
1221 int av_write_trailer(AVFormatContext *s);
1222
1223 void dump_format(AVFormatContext *ic,
1224                  int index,
1225                  const char *url,
1226                  int is_output);
1227
1228 #if LIBAVFORMAT_VERSION_MAJOR < 53
1229 /**
1230  * Parses width and height out of string str.
1231  * @deprecated Use av_parse_video_frame_size instead.
1232  */
1233 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1234                                           const char *str);
1235
1236 /**
1237  * Converts framerate from a string to a fraction.
1238  * @deprecated Use av_parse_video_frame_rate instead.
1239  */
1240 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1241                                           const char *arg);
1242 #endif
1243
1244 /**
1245  * Parses datestr and returns a corresponding number of microseconds.
1246  * @param datestr String representing a date or a duration.
1247  * - If a date the syntax is:
1248  * @code
1249  *  [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
1250  * @endcode
1251  * Time is local time unless Z is appended, in which case it is
1252  * interpreted as UTC.
1253  * If the year-month-day part is not specified it takes the current
1254  * year-month-day.
1255  * Returns the number of microseconds since 1st of January, 1970 up to
1256  * the time of the parsed date or INT64_MIN if datestr cannot be
1257  * successfully parsed.
1258  * - If a duration the syntax is:
1259  * @code
1260  *  [-]HH[:MM[:SS[.m...]]]
1261  *  [-]S+[.m...]
1262  * @endcode
1263  * Returns the number of microseconds contained in a time interval
1264  * with the specified duration or INT64_MIN if datestr cannot be
1265  * successfully parsed.
1266  * @param duration Flag which tells how to interpret datestr, if
1267  * not zero datestr is interpreted as a duration, otherwise as a
1268  * date.
1269  */
1270 int64_t parse_date(const char *datestr, int duration);
1271
1272 /** Gets the current time in microseconds. */
1273 int64_t av_gettime(void);
1274
1275 /* ffm-specific for ffserver */
1276 #define FFM_PACKET_SIZE 4096
1277 int64_t ffm_read_write_index(int fd);
1278 int ffm_write_write_index(int fd, int64_t pos);
1279 void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1280
1281 /**
1282  * Attempts to find a specific tag in a URL.
1283  *
1284  * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1285  * Return 1 if found.
1286  */
1287 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1288
1289 /**
1290  * Returns in 'buf' the path with '%d' replaced by a number.
1291  *
1292  * Also handles the '%0nd' format where 'n' is the total number
1293  * of digits and '%%'.
1294  *
1295  * @param buf destination buffer
1296  * @param buf_size destination buffer size
1297  * @param path numbered sequence string
1298  * @param number frame number
1299  * @return 0 if OK, -1 on format error
1300  */
1301 int av_get_frame_filename(char *buf, int buf_size,
1302                           const char *path, int number);
1303
1304 /**
1305  * Checks whether filename actually is a numbered sequence generator.
1306  *
1307  * @param filename possible numbered sequence string
1308  * @return 1 if a valid numbered sequence string, 0 otherwise
1309  */
1310 int av_filename_number_test(const char *filename);
1311
1312 /**
1313  * Generates an SDP for an RTP session.
1314  *
1315  * @param ac array of AVFormatContexts describing the RTP streams. If the
1316  *           array is composed by only one context, such context can contain
1317  *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1318  *           all the contexts in the array (an AVCodecContext per RTP stream)
1319  *           must contain only one AVStream.
1320  * @param n_files number of AVCodecContexts contained in ac
1321  * @param buff buffer where the SDP will be stored (must be allocated by
1322  *             the caller)
1323  * @param size the size of the buffer
1324  * @return 0 if OK, AVERROR_xxx on error
1325  */
1326 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1327
1328 #ifdef HAVE_AV_CONFIG_H
1329
1330 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
1331
1332 #ifdef __GNUC__
1333 #define dynarray_add(tab, nb_ptr, elem)\
1334 do {\
1335     __typeof__(tab) _tab = (tab);\
1336     __typeof__(elem) _elem = (elem);\
1337     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
1338     ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
1339 } while(0)
1340 #else
1341 #define dynarray_add(tab, nb_ptr, elem)\
1342 do {\
1343     ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
1344 } while(0)
1345 #endif
1346
1347 time_t mktimegm(struct tm *tm);
1348 struct tm *brktimegm(time_t secs, struct tm *tm);
1349 const char *small_strptime(const char *p, const char *fmt,
1350                            struct tm *dt);
1351
1352 /**
1353  * Returns a positive value if the given filename has one of the given
1354  * extensions, 0 otherwise.
1355  *
1356  * @param extensions a comma-separated list of filename extensions
1357  */
1358 int av_match_ext(const char *filename, const char *extensions);
1359
1360 #endif /* HAVE_AV_CONFIG_H */
1361
1362 #endif /* AVFORMAT_AVFORMAT_H */