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