chapter id and timebase
[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 FFMPEG_AVFORMAT_H
22 #define FFMPEG_AVFORMAT_H
23
24 #define LIBAVFORMAT_VERSION_MAJOR 52
25 #define LIBAVFORMAT_VERSION_MINOR 14
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 #include <time.h>
39 #include <stdio.h>  /* FILE */
40 #include "libavcodec/avcodec.h"
41
42 #include "avio.h"
43
44 /* packet functions */
45
46 typedef struct AVPacket {
47     int64_t pts;                            ///< presentation time stamp in time_base units
48     int64_t dts;                            ///< decompression time stamp in time_base units
49     uint8_t *data;
50     int   size;
51     int   stream_index;
52     int   flags;
53     int   duration;                         ///< presentation duration in time_base units (0 if not available)
54     void  (*destruct)(struct AVPacket *);
55     void  *priv;
56     int64_t pos;                            ///< byte position in stream, -1 if unknown
57 } AVPacket;
58 #define PKT_FLAG_KEY   0x0001
59
60 void av_destruct_packet_nofree(AVPacket *pkt);
61
62 /**
63  * Default packet destructor.
64  */
65 void av_destruct_packet(AVPacket *pkt);
66
67 /**
68  * Initialize optional fields of a packet to default values.
69  *
70  * @param pkt packet
71  */
72 void av_init_packet(AVPacket *pkt);
73
74 /**
75  * Allocate the payload of a packet and initialize its fields to default values.
76  *
77  * @param pkt packet
78  * @param size wanted payload size
79  * @return 0 if OK. AVERROR_xxx otherwise.
80  */
81 int av_new_packet(AVPacket *pkt, int size);
82
83 /**
84  * Allocate and read the payload of a packet and initialize its fields to default values.
85  *
86  * @param pkt packet
87  * @param size wanted payload size
88  * @return >0 (read size) if OK. AVERROR_xxx otherwise.
89  */
90 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
91
92 /**
93  * @warning This is a hack - the packet memory allocation stuff is broken. The
94  * packet is allocated if it was not really allocated
95  */
96 int av_dup_packet(AVPacket *pkt);
97
98 /**
99  * Free a packet
100  *
101  * @param pkt packet to free
102  */
103 static inline void av_free_packet(AVPacket *pkt)
104 {
105     if (pkt && pkt->destruct) {
106         pkt->destruct(pkt);
107     }
108 }
109
110 /*************************************************/
111 /* fractional numbers for exact pts handling */
112
113 /**
114  * the exact value of the fractional number is: 'val + num / den'.
115  * num is assumed to be such as 0 <= num < den
116  * @deprecated Use AVRational instead
117 */
118 typedef struct AVFrac {
119     int64_t val, num, den;
120 } AVFrac attribute_deprecated;
121
122 /*************************************************/
123 /* input/output formats */
124
125 struct AVCodecTag;
126
127 struct AVFormatContext;
128
129 /** this structure contains the data a format has to probe a file */
130 typedef struct AVProbeData {
131     const char *filename;
132     unsigned char *buf;
133     int buf_size;
134 } AVProbeData;
135
136 #define AVPROBE_SCORE_MAX 100               ///< max score, half of that is used for file extension based detection
137 #define AVPROBE_PADDING_SIZE 32             ///< extra allocated bytes at the end of the probe buffer
138
139 typedef struct AVFormatParameters {
140     AVRational time_base;
141     int sample_rate;
142     int channels;
143     int width;
144     int height;
145     enum PixelFormat pix_fmt;
146     int channel; /**< used to select dv channel */
147     const char *standard; /**< tv standard, NTSC, PAL, SECAM */
148     int mpeg2ts_raw:1;  /**< force raw MPEG2 transport stream output, if possible */
149     int mpeg2ts_compute_pcr:1; /**< compute exact PCR for each transport
150                                   stream packet (only meaningful if
151                                   mpeg2ts_raw is TRUE) */
152     int initial_pause:1;       /**< do not begin to play the stream
153                                   immediately (RTSP only) */
154     int prealloced_context:1;
155 #if LIBAVFORMAT_VERSION_INT < (53<<16)
156     enum CodecID video_codec_id;
157     enum CodecID audio_codec_id;
158 #endif
159 } AVFormatParameters;
160
161 //! demuxer will use url_fopen, no opened file should be provided by the caller
162 #define AVFMT_NOFILE        0x0001
163 #define AVFMT_NEEDNUMBER    0x0002 /**< needs '%d' in filename */
164 #define AVFMT_SHOW_IDS      0x0008 /**< show format stream IDs numbers */
165 #define AVFMT_RAWPICTURE    0x0020 /**< format wants AVPicture structure for
166                                       raw picture data */
167 #define AVFMT_GLOBALHEADER  0x0040 /**< format wants global header */
168 #define AVFMT_NOTIMESTAMPS  0x0080 /**< format does not need / have any timestamps */
169 #define AVFMT_GENERIC_INDEX 0x0100 /**< use generic index building code */
170
171 typedef struct AVOutputFormat {
172     const char *name;
173     const char *long_name;
174     const char *mime_type;
175     const char *extensions; /**< comma separated filename extensions */
176     /** size of private data so that it can be allocated in the wrapper */
177     int priv_data_size;
178     /* output support */
179     enum CodecID audio_codec; /**< default audio codec */
180     enum CodecID video_codec; /**< default video codec */
181     int (*write_header)(struct AVFormatContext *);
182     int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
183     int (*write_trailer)(struct AVFormatContext *);
184     /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
185     int flags;
186     /** currently only used to set pixel format if not YUV420P */
187     int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
188     int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
189
190     /**
191      * list of supported codec_id-codec_tag pairs, ordered by "better choice first"
192      * the arrays are all CODEC_ID_NONE terminated
193      */
194     const struct AVCodecTag **codec_tag;
195
196     enum CodecID subtitle_codec; /**< default subtitle codec */
197
198     /* private fields */
199     struct AVOutputFormat *next;
200 } AVOutputFormat;
201
202 typedef struct AVInputFormat {
203     const char *name;
204     const char *long_name;
205     /** size of private data so that it can be allocated in the wrapper */
206     int priv_data_size;
207     /**
208      * Tell if a given file has a chance of being parsed by this format.
209      * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
210      * big so you do not have to check for that unless you need more.
211      */
212     int (*read_probe)(AVProbeData *);
213     /** read the format header and initialize the AVFormatContext
214        structure. Return 0 if OK. 'ap' if non NULL contains
215        additional paramters. Only used in raw format right
216        now. 'av_new_stream' should be called to create new streams.  */
217     int (*read_header)(struct AVFormatContext *,
218                        AVFormatParameters *ap);
219     /** read one packet and put it in 'pkt'. pts and flags are also
220        set. 'av_new_stream' can be called only if the flag
221        AVFMTCTX_NOHEADER is used. */
222     int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
223     /** close the stream. The AVFormatContext and AVStreams are not
224        freed by this function */
225     int (*read_close)(struct AVFormatContext *);
226     /**
227      * seek to a given timestamp relative to the frames in
228      * stream component stream_index
229      * @param stream_index must not be -1
230      * @param flags selects which direction should be preferred if no exact
231      *              match is available
232      * @return >= 0 on success (but not necessarily the new offset)
233      */
234     int (*read_seek)(struct AVFormatContext *,
235                      int stream_index, int64_t timestamp, int flags);
236     /**
237      * gets the next timestamp in stream[stream_index].time_base units.
238      * @return the timestamp or AV_NOPTS_VALUE if an error occurred
239      */
240     int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
241                               int64_t *pos, int64_t pos_limit);
242     /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
243     int flags;
244     /** if extensions are defined, then no probe is done. You should
245        usually not use extension format guessing because it is not
246        reliable enough */
247     const char *extensions;
248     /** general purpose read only value that the format can use */
249     int value;
250
251     /** start/resume playing - only meaningful if using a network based format
252        (RTSP) */
253     int (*read_play)(struct AVFormatContext *);
254
255     /** pause playing - only meaningful if using a network based format
256        (RTSP) */
257     int (*read_pause)(struct AVFormatContext *);
258
259     const struct AVCodecTag **codec_tag;
260
261     /* private fields */
262     struct AVInputFormat *next;
263 } AVInputFormat;
264
265 enum AVStreamParseType {
266     AVSTREAM_PARSE_NONE,
267     AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
268     AVSTREAM_PARSE_HEADERS,    /**< only parse headers, don't repack */
269     AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on packet boundary */
270 };
271
272 typedef struct AVIndexEntry {
273     int64_t pos;
274     int64_t timestamp;
275 #define AVINDEX_KEYFRAME 0x0001
276     int flags:2;
277     int size:30; //Yeah, trying to keep the size of this small to reduce memory requirements (it is 24 vs 32 byte due to possible 8byte align).
278     int min_distance;         /**< min distance between this and the previous keyframe, used to avoid unneeded searching */
279 } AVIndexEntry;
280
281 #define AV_DISPOSITION_DEFAULT   0x0001
282 #define AV_DISPOSITION_DUB       0x0002
283 #define AV_DISPOSITION_ORIGINAL  0x0004
284 #define AV_DISPOSITION_COMMENT   0x0008
285 #define AV_DISPOSITION_LYRICS    0x0010
286 #define AV_DISPOSITION_KARAOKE   0x0020
287
288 /**
289  * Stream structure.
290  * New fields can be added to the end with minor version bumps.
291  * Removal, reordering and changes to existing fields require a major
292  * version bump.
293  * sizeof(AVStream) must not be used outside libav*.
294  */
295 typedef struct AVStream {
296     int index;    /**< stream index in AVFormatContext */
297     int id;       /**< format specific stream id */
298     AVCodecContext *codec; /**< codec context */
299     /**
300      * Real base frame rate of the stream.
301      * This is the lowest frame rate with which all timestamps can be
302      * represented accurately (it is the least common multiple of all
303      * frame rates in the stream), Note, this value is just a guess!
304      * For example if the timebase is 1/90000 and all frames have either
305      * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1.
306      */
307     AVRational r_frame_rate;
308     void *priv_data;
309
310     /* internal data used in av_find_stream_info() */
311     int64_t first_dts;
312     /** encoding: PTS generation when outputing stream */
313     struct AVFrac pts;
314
315     /**
316      * This is the fundamental unit of time (in seconds) in terms
317      * of which frame timestamps are represented. For fixed-fps content,
318      * timebase should be 1/frame rate and timestamp increments should be
319      * identically 1.
320      */
321     AVRational time_base;
322     int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
323     /* ffmpeg.c private use */
324     int stream_copy; /**< if set, just copy stream */
325     enum AVDiscard discard; ///< selects which packets can be discarded at will and do not need to be demuxed
326     //FIXME move stuff to a flags field?
327     /** quality, as it has been removed from AVCodecContext and put in AVVideoFrame
328      * MN: dunno if that is the right place for it */
329     float quality;
330     /**
331      * Decoding: pts of the first frame of the stream, in stream time base.
332      * Only set this if you are absolutely 100% sure that the value you set
333      * it to really is the pts of the first frame.
334      * This may be undefined (AV_NOPTS_VALUE).
335      * @note The ASF header does NOT contain a correct start_time the ASF
336      * demuxer must NOT set this.
337      */
338     int64_t start_time;
339     /**
340      * Decoding: duration of the stream, in stream time base.
341      * If a source file does not specify a duration, but does specify
342      * a bitrate, this value will be estimates from bit rate and file size.
343      */
344     int64_t duration;
345
346     char language[4]; /** ISO 639 3-letter language code (empty string if undefined) */
347
348     /* av_read_frame() support */
349     enum AVStreamParseType need_parsing;
350     struct AVCodecParserContext *parser;
351
352     int64_t cur_dts;
353     int last_IP_duration;
354     int64_t last_IP_pts;
355     /* av_seek_frame() support */
356     AVIndexEntry *index_entries; /**< only used if the format does not
357                                     support seeking natively */
358     int nb_index_entries;
359     unsigned int index_entries_allocated_size;
360
361     int64_t nb_frames;                 ///< number of frames in this stream if known or 0
362
363 #define MAX_REORDER_DELAY 4
364     int64_t pts_buffer[MAX_REORDER_DELAY+1];
365
366     char *filename; /**< source filename of the stream */
367
368     int disposition; /**< AV_DISPOSITION_* bitfield */
369 } AVStream;
370
371 #define AV_PROGRAM_RUNNING 1
372
373 /**
374  * New fields can be added to the end with minor version bumps.
375  * Removal, reordering and changes to existing fields require a major
376  * version bump.
377  * sizeof(AVProgram) must not be used outside libav*.
378  */
379 typedef struct AVProgram {
380     int            id;
381     char           *provider_name; ///< Network name for DVB streams
382     char           *name;          ///< Service name for DVB streams
383     int            flags;
384     enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
385     unsigned int   *stream_index;
386     unsigned int   nb_stream_indexes;
387 } AVProgram;
388
389 #define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
390                                          (streams are added dynamically) */
391
392 typedef struct AVChapter {
393     int id;                 ///< Unique id to identify the chapter
394     AVRational time_base;   ///< Timebase in which the start/end timestamps are specified
395     int64_t start, end; /**< chapter start/end time in AV_TIME_BASE units */
396     char *title; /**< chapter title */
397 } AVChapter;
398
399 #define MAX_STREAMS 20
400
401 /**
402  * format I/O context.
403  * New fields can be added to the end with minor version bumps.
404  * Removal, reordering and changes to existing fields require a major
405  * version bump.
406  * sizeof(AVFormatContext) must not be used outside libav*.
407  */
408 typedef struct AVFormatContext {
409     const AVClass *av_class; /**< set by av_alloc_format_context */
410     /* can only be iformat or oformat, not both at the same time */
411     struct AVInputFormat *iformat;
412     struct AVOutputFormat *oformat;
413     void *priv_data;
414     ByteIOContext *pb;
415     unsigned int nb_streams;
416     AVStream *streams[MAX_STREAMS];
417     char filename[1024]; /**< input or output filename */
418     /* stream info */
419     int64_t timestamp;
420     char title[512];
421     char author[512];
422     char copyright[512];
423     char comment[512];
424     char album[512];
425     int year;  /**< ID3 year, 0 if none */
426     int track; /**< track number, 0 if none */
427     char genre[32]; /**< ID3 genre */
428
429     int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
430     /* private data for pts handling (do not modify directly) */
431     /** This buffer is only needed when packets were already buffered but
432        not decoded, for example to get the codec parameters in mpeg
433        streams */
434     struct AVPacketList *packet_buffer;
435
436     /** decoding: position of the first frame of the component, in
437        AV_TIME_BASE fractional seconds. NEVER set this value directly:
438        it is deduced from the AVStream values.  */
439     int64_t start_time;
440     /** decoding: duration of the stream, in AV_TIME_BASE fractional
441        seconds. NEVER set this value directly: it is deduced from the
442        AVStream values.  */
443     int64_t duration;
444     /** decoding: total file size. 0 if unknown */
445     int64_t file_size;
446     /** decoding: total stream bitrate in bit/s, 0 if not
447        available. Never set it directly if the file_size and the
448        duration are known as ffmpeg can compute it automatically. */
449     int bit_rate;
450
451     /* av_read_frame() support */
452     AVStream *cur_st;
453     const uint8_t *cur_ptr;
454     int cur_len;
455     AVPacket cur_pkt;
456
457     /* av_seek_frame() support */
458     int64_t data_offset; /** offset of the first packet */
459     int index_built;
460
461     int mux_rate;
462     int packet_size;
463     int preload;
464     int max_delay;
465
466 #define AVFMT_NOOUTPUTLOOP -1
467 #define AVFMT_INFINITEOUTPUTLOOP 0
468     /** number of times to loop output in formats that support it */
469     int loop_output;
470
471     int flags;
472 #define AVFMT_FLAG_GENPTS       0x0001 ///< generate pts if missing even if it requires parsing future frames
473 #define AVFMT_FLAG_IGNIDX       0x0002 ///< ignore index
474 #define AVFMT_FLAG_NONBLOCK     0x0004 ///< do not block when reading packets from input
475
476     int loop_input;
477     /** decoding: size of data to probe; encoding unused */
478     unsigned int probesize;
479
480     /**
481      * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
482      */
483     int max_analyze_duration;
484
485     const uint8_t *key;
486     int keylen;
487
488     unsigned int nb_programs;
489     AVProgram **programs;
490
491     /**
492      * Forced video codec_id.
493      * demuxing: set by user
494      */
495     enum CodecID video_codec_id;
496     /**
497      * Forced audio codec_id.
498      * demuxing: set by user
499      */
500     enum CodecID audio_codec_id;
501     /**
502      * Forced subtitle codec_id.
503      * demuxing: set by user
504      */
505     enum CodecID subtitle_codec_id;
506
507     /**
508      * Maximum amount of memory in bytes to use per stream for the index.
509      * If the needed index exceeds this size entries will be discarded as
510      * needed to maintain a smaller size. This can lead to slower or less
511      * accurate seeking (depends on demuxer).
512      * Demuxers for which a full in memory index is mandatory will ignore
513      * this.
514      * muxing  : unused
515      * demuxing: set by user
516      */
517     unsigned int max_index_size;
518
519     /**
520      * Maximum amount of memory in bytes to use for buffering frames
521      * obtained from real-time capture devices.
522      */
523     unsigned int max_picture_buffer;
524
525     int num_chapters;
526     AVChapter **chapters;
527 } AVFormatContext;
528
529 typedef struct AVPacketList {
530     AVPacket pkt;
531     struct AVPacketList *next;
532 } AVPacketList;
533
534 #if LIBAVFORMAT_VERSION_INT < (53<<16)
535 extern AVInputFormat *first_iformat;
536 extern AVOutputFormat *first_oformat;
537 #endif
538
539 AVInputFormat  *av_iformat_next(AVInputFormat  *f);
540 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
541
542 enum CodecID av_guess_image2_codec(const char *filename);
543
544 /* XXX: use automatic init with either ELF sections or C file parser */
545 /* modules */
546
547 /* utils.c */
548 void av_register_input_format(AVInputFormat *format);
549 void av_register_output_format(AVOutputFormat *format);
550 AVOutputFormat *guess_stream_format(const char *short_name,
551                                     const char *filename, const char *mime_type);
552 AVOutputFormat *guess_format(const char *short_name,
553                              const char *filename, const char *mime_type);
554
555 /**
556  * Guesses the codec id based upon muxer and filename.
557  */
558 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
559                             const char *filename, const char *mime_type, enum CodecType type);
560
561 /**
562  * Send a nice hexadecimal dump of a buffer to the specified file stream.
563  *
564  * @param f The file stream pointer where the dump should be sent to.
565  * @param buf buffer
566  * @param size buffer size
567  *
568  * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
569  */
570 void av_hex_dump(FILE *f, uint8_t *buf, int size);
571
572 /**
573  * Send a nice hexadecimal dump of a buffer to the log.
574  *
575  * @param avcl A pointer to an arbitrary struct of which the first field is a
576  * pointer to an AVClass struct.
577  * @param level The importance level of the message, lower values signifying
578  * higher importance.
579  * @param buf buffer
580  * @param size buffer size
581  *
582  * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
583  */
584 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
585
586 /**
587  * Send a nice dump of a packet to the specified file stream.
588  *
589  * @param f The file stream pointer where the dump should be sent to.
590  * @param pkt packet to dump
591  * @param dump_payload true if the payload must be displayed too
592  */
593 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
594
595 /**
596  * Send a nice dump of a packet to the log.
597  *
598  * @param avcl A pointer to an arbitrary struct of which the first field is a
599  * pointer to an AVClass struct.
600  * @param level The importance level of the message, lower values signifying
601  * higher importance.
602  * @param pkt packet to dump
603  * @param dump_payload true if the payload must be displayed too
604  */
605 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
606
607 void av_register_all(void);
608
609 /** codec tag <-> codec id */
610 enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
611 unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
612
613 /* media file input */
614
615 /**
616  * finds AVInputFormat based on input format's short name.
617  */
618 AVInputFormat *av_find_input_format(const char *short_name);
619
620 /**
621  * Guess file format.
622  *
623  * @param is_opened whether the file is already opened, determines whether
624  *                  demuxers with or without AVFMT_NOFILE are probed
625  */
626 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
627
628 /**
629  * Allocates all the structures needed to read an input stream.
630  *        This does not open the needed codecs for decoding the stream[s].
631  */
632 int av_open_input_stream(AVFormatContext **ic_ptr,
633                          ByteIOContext *pb, const char *filename,
634                          AVInputFormat *fmt, AVFormatParameters *ap);
635
636 /**
637  * Open a media file as input. The codecs are not opened. Only the file
638  * header (if present) is read.
639  *
640  * @param ic_ptr the opened media file handle is put here
641  * @param filename filename to open.
642  * @param fmt if non NULL, force the file format to use
643  * @param buf_size optional buffer size (zero if default is OK)
644  * @param ap additional parameters needed when opening the file (NULL if default)
645  * @return 0 if OK. AVERROR_xxx otherwise.
646  */
647 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
648                        AVInputFormat *fmt,
649                        int buf_size,
650                        AVFormatParameters *ap);
651 /**
652  * Allocate an AVFormatContext.
653  * Can be freed with av_free() but do not forget to free everything you
654  * explicitly allocated as well!
655  */
656 AVFormatContext *av_alloc_format_context(void);
657
658 /**
659  * Read packets of a media file to get stream information. This
660  * is useful for file formats with no headers such as MPEG. This
661  * function also computes the real frame rate in case of mpeg2 repeat
662  * frame mode.
663  * The logical file position is not changed by this function;
664  * examined packets may be buffered for later processing.
665  *
666  * @param ic media file handle
667  * @return >=0 if OK. AVERROR_xxx if error.
668  * @todo Let user decide somehow what information is needed so we do not waste time getting stuff the user does not need.
669  */
670 int av_find_stream_info(AVFormatContext *ic);
671
672 /**
673  * Read a transport packet from a media file.
674  *
675  * This function is obsolete and should never be used.
676  * Use av_read_frame() instead.
677  *
678  * @param s media file handle
679  * @param pkt is filled
680  * @return 0 if OK. AVERROR_xxx if error.
681  */
682 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
683
684 /**
685  * Return the next frame of a stream.
686  *
687  * The returned packet is valid
688  * until the next av_read_frame() or until av_close_input_file() and
689  * must be freed with av_free_packet. For video, the packet contains
690  * exactly one frame. For audio, it contains an integer number of
691  * frames if each frame has a known fixed size (e.g. PCM or ADPCM
692  * data). If the audio frames have a variable size (e.g. MPEG audio),
693  * then it contains one frame.
694  *
695  * pkt->pts, pkt->dts and pkt->duration are always set to correct
696  * values in AVStream.timebase units (and guessed if the format cannot
697  * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
698  * has B frames, so it is better to rely on pkt->dts if you do not
699  * decompress the payload.
700  *
701  * @return 0 if OK, < 0 if error or end of file.
702  */
703 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
704
705 /**
706  * Seek to the key frame at timestamp.
707  * 'timestamp' in 'stream_index'.
708  * @param stream_index If stream_index is (-1), a default
709  * stream is selected, and timestamp is automatically converted
710  * from AV_TIME_BASE units to the stream specific time_base.
711  * @param timestamp timestamp in AVStream.time_base units
712  *        or if there is no stream specified then in AV_TIME_BASE units
713  * @param flags flags which select direction and seeking mode
714  * @return >= 0 on success
715  */
716 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
717
718 /**
719  * start playing a network based stream (e.g. RTSP stream) at the
720  * current position
721  */
722 int av_read_play(AVFormatContext *s);
723
724 /**
725  * Pause a network based stream (e.g. RTSP stream).
726  *
727  * Use av_read_play() to resume it.
728  */
729 int av_read_pause(AVFormatContext *s);
730
731 /**
732  * Free a AVFormatContext allocated by av_open_input_stream.
733  * @param s context to free
734  */
735 void av_close_input_stream(AVFormatContext *s);
736
737 /**
738  * Close a media file (but not its codecs).
739  *
740  * @param s media file handle
741  */
742 void av_close_input_file(AVFormatContext *s);
743
744 /**
745  * Add a new stream to a media file.
746  *
747  * Can only be called in the read_header() function. If the flag
748  * AVFMTCTX_NOHEADER is in the format context, then new streams
749  * can be added in read_packet too.
750  *
751  * @param s media file handle
752  * @param id file format dependent stream id
753  */
754 AVStream *av_new_stream(AVFormatContext *s, int id);
755 AVProgram *av_new_program(AVFormatContext *s, int id);
756
757 /**
758  * Add a new chapter.
759  * This function is NOT part of the public API
760  * and should be ONLY used by demuxers.
761  *
762  * @param s media file handle
763  * @param start chapter start time in AV_TIME_BASE units
764  * @param end chapter end time in AV_TIME_BASE units
765  * @param title chapter title
766  */
767 int ff_new_chapter(AVFormatContext *s, int64_t start, int64_t end, const char *title);
768
769 /**
770  * Set the pts for a given stream.
771  *
772  * @param s stream
773  * @param pts_wrap_bits number of bits effectively used by the pts
774  *        (used for wrap control, 33 is the value for MPEG)
775  * @param pts_num numerator to convert to seconds (MPEG: 1)
776  * @param pts_den denominator to convert to seconds (MPEG: 90000)
777  */
778 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
779                      int pts_num, int pts_den);
780
781 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
782 #define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
783 #define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non keyframes
784
785 int av_find_default_stream_index(AVFormatContext *s);
786
787 /**
788  * Gets the index for a specific timestamp.
789  * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
790  *                 the timestamp which is <= the requested one, if backward is 0
791  *                 then it will be >=
792  *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
793  * @return < 0 if no such timestamp could be found
794  */
795 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
796
797 /**
798  * Ensures the index uses less memory than the maximum specified in
799  * AVFormatContext.max_index_size, by discarding entries if it grows
800  * too large.
801  * This function is not part of the public API and should only be called
802  * by demuxers.
803  */
804 void ff_reduce_index(AVFormatContext *s, int stream_index);
805
806 /**
807  * Add a index entry into a sorted list updateing if it is already there.
808  *
809  * @param timestamp timestamp in the timebase of the given stream
810  */
811 int av_add_index_entry(AVStream *st,
812                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
813
814 /**
815  * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
816  * This is not supposed to be called directly by a user application, but by demuxers.
817  * @param target_ts target timestamp in the time base of the given stream
818  * @param stream_index stream number
819  */
820 int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
821
822 /**
823  * Updates cur_dts of all streams based on given timestamp and AVStream.
824  *
825  * Stream ref_st unchanged, others set cur_dts in their native timebase
826  * only needed for timestamp wrapping or if (dts not set and pts!=dts).
827  * @param timestamp new dts expressed in time_base of param ref_st
828  * @param ref_st reference stream giving time_base of param timestamp
829  */
830 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
831
832 /**
833  * Does a binary search using read_timestamp().
834  * This is not supposed to be called directly by a user application, but by demuxers.
835  * @param target_ts target timestamp in the time base of the given stream
836  * @param stream_index stream number
837  */
838 int64_t av_gen_search(AVFormatContext *s, int stream_index, int64_t target_ts, int64_t pos_min, int64_t pos_max, int64_t pos_limit, int64_t ts_min, int64_t ts_max, int flags, int64_t *ts_ret, int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
839
840 /** media file output */
841 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
842
843 /**
844  * Allocate the stream private data and write the stream header to an
845  * output media file.
846  *
847  * @param s media file handle
848  * @return 0 if OK. AVERROR_xxx if error.
849  */
850 int av_write_header(AVFormatContext *s);
851
852 /**
853  * Write a packet to an output media file.
854  *
855  * The packet shall contain one audio or video frame.
856  * The packet must be correctly interleaved according to the container specification,
857  * if not then av_interleaved_write_frame must be used
858  *
859  * @param s media file handle
860  * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
861  * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
862  */
863 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
864
865 /**
866  * Writes a packet to an output media file ensuring correct interleaving.
867  *
868  * The packet must contain one audio or video frame.
869  * If the packets are already correctly interleaved the application should
870  * call av_write_frame() instead as it is slightly faster. It is also important
871  * to keep in mind that completely non-interleaved input will need huge amounts
872  * of memory to interleave with this, so it is preferable to interleave at the
873  * demuxer level.
874  *
875  * @param s media file handle
876  * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
877  * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
878  */
879 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
880
881 /**
882  * Interleave a packet per DTS in an output media file.
883  *
884  * Packets with pkt->destruct == av_destruct_packet will be freed inside this function,
885  * so they cannot be used after it, note calling av_free_packet() on them is still safe.
886  *
887  * @param s media file handle
888  * @param out the interleaved packet will be output here
889  * @param in the input packet
890  * @param flush 1 if no further packets are available as input and all
891  *              remaining packets should be output
892  * @return 1 if a packet was output, 0 if no packet could be output,
893  *         < 0 if an error occurred
894  */
895 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
896
897 /**
898  * @brief Write the stream trailer to an output media file and
899  *        free the file private data.
900  *
901  * @param s media file handle
902  * @return 0 if OK. AVERROR_xxx if error.
903  */
904 int av_write_trailer(AVFormatContext *s);
905
906 void dump_format(AVFormatContext *ic,
907                  int index,
908                  const char *url,
909                  int is_output);
910
911 /**
912  * parses width and height out of string str.
913  * @deprecated Use av_parse_video_frame_size instead.
914  */
915 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
916
917 /**
918  * Converts frame rate from string to a fraction.
919  * @deprecated Use av_parse_video_frame_rate instead.
920  */
921 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
922
923 /**
924  * Parses \p datestr and returns a corresponding number of microseconds.
925  * @param datestr String representing a date or a duration.
926  * - If a date the syntax is:
927  * @code
928  *  [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
929  * @endcode
930  * Time is localtime unless Z is appended, in which case it is
931  * interpreted as UTC.
932  * If the year-month-day part isn't specified it takes the current
933  * year-month-day.
934  * Returns the number of microseconds since 1st of January, 1970 up to
935  * the time of the parsed date or INT64_MIN if \p datestr cannot be
936  * successfully parsed.
937  * - If a duration the syntax is:
938  * @code
939  *  [-]HH[:MM[:SS[.m...]]]
940  *  [-]S+[.m...]
941  * @endcode
942  * Returns the number of microseconds contained in a time interval
943  * with the specified duration or INT64_MIN if \p datestr cannot be
944  * successfully parsed.
945  * @param duration Flag which tells how to interpret \p datestr, if
946  * not zero \p datestr is interpreted as a duration, otherwise as a
947  * date.
948  */
949 int64_t parse_date(const char *datestr, int duration);
950
951 int64_t av_gettime(void);
952
953 /* ffm specific for ffserver */
954 #define FFM_PACKET_SIZE 4096
955 offset_t ffm_read_write_index(int fd);
956 void ffm_write_write_index(int fd, offset_t pos);
957 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
958
959 /**
960  * Attempts to find a specific tag in a URL.
961  *
962  * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
963  * Return 1 if found.
964  */
965 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
966
967 /**
968  * Returns in 'buf' the path with '%d' replaced by number.
969
970  * Also handles the '%0nd' format where 'n' is the total number
971  * of digits and '%%'.
972  *
973  * @param buf destination buffer
974  * @param buf_size destination buffer size
975  * @param path numbered sequence string
976  * @param number frame number
977  * @return 0 if OK, -1 if format error.
978  */
979 int av_get_frame_filename(char *buf, int buf_size,
980                           const char *path, int number);
981
982 /**
983  * Check whether filename actually is a numbered sequence generator.
984  *
985  * @param filename possible numbered sequence string
986  * @return 1 if a valid numbered sequence string, 0 otherwise.
987  */
988 int av_filename_number_test(const char *filename);
989
990 /**
991  * Generate an SDP for an RTP session.
992  *
993  * @param ac array of AVFormatContexts describing the RTP streams. If the
994  *           array is composed by only one context, such context can contain
995  *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
996  *           all the contexts in the array (an AVCodecContext per RTP stream)
997  *           must contain only one AVStream
998  * @param n_files number of AVCodecContexts contained in ac
999  * @param buff buffer where the SDP will be stored (must be allocated by
1000  *             the caller
1001  * @param size the size of the buffer
1002  * @return 0 if OK. AVERROR_xxx if error.
1003  */
1004 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1005
1006 #ifdef HAVE_AV_CONFIG_H
1007
1008 void ff_dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
1009
1010 #ifdef __GNUC__
1011 #define dynarray_add(tab, nb_ptr, elem)\
1012 do {\
1013     typeof(tab) _tab = (tab);\
1014     typeof(elem) _elem = (elem);\
1015     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
1016     ff_dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
1017 } while(0)
1018 #else
1019 #define dynarray_add(tab, nb_ptr, elem)\
1020 do {\
1021     ff_dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
1022 } while(0)
1023 #endif
1024
1025 time_t mktimegm(struct tm *tm);
1026 struct tm *brktimegm(time_t secs, struct tm *tm);
1027 const char *small_strptime(const char *p, const char *fmt,
1028                            struct tm *dt);
1029
1030 struct in_addr;
1031 int resolve_host(struct in_addr *sin_addr, const char *hostname);
1032
1033 void url_split(char *proto, int proto_size,
1034                char *authorization, int authorization_size,
1035                char *hostname, int hostname_size,
1036                int *port_ptr,
1037                char *path, int path_size,
1038                const char *url);
1039
1040 int match_ext(const char *filename, const char *extensions);
1041
1042 #endif /* HAVE_AV_CONFIG_H */
1043
1044 #endif /* FFMPEG_AVFORMAT_H */