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