mention that start_time maybe AV_NOPTS_VALUE (from patch by neilb suse de)
[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      * This may be undefined (AV_NOPTS_VALUE).
316      * @note the ASF header does NOT contain a correct start_time the ASF
317      * demuxer must NOT set this
318      */
319     int64_t start_time;
320     /** decoding: duration of the stream, in stream time base. */
321     int64_t duration;
322
323     char language[4]; /** ISO 639 3-letter language code (empty string if undefined) */
324
325     /* av_read_frame() support */
326     enum AVStreamParseType need_parsing;
327     struct AVCodecParserContext *parser;
328
329     int64_t cur_dts;
330     int last_IP_duration;
331     int64_t last_IP_pts;
332     /* av_seek_frame() support */
333     AVIndexEntry *index_entries; /**< only used if the format does not
334                                     support seeking natively */
335     int nb_index_entries;
336     unsigned int index_entries_allocated_size;
337
338     int64_t nb_frames;                 ///< number of frames in this stream if known or 0
339
340 #define MAX_REORDER_DELAY 4
341     int64_t pts_buffer[MAX_REORDER_DELAY+1];
342 } AVStream;
343
344 #define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
345                                          (streams are added dynamically) */
346
347 #define MAX_STREAMS 20
348
349 /* format I/O context */
350 typedef struct AVFormatContext {
351     const AVClass *av_class; /**< set by av_alloc_format_context */
352     /* can only be iformat or oformat, not both at the same time */
353     struct AVInputFormat *iformat;
354     struct AVOutputFormat *oformat;
355     void *priv_data;
356     ByteIOContext pb;
357     unsigned int nb_streams;
358     AVStream *streams[MAX_STREAMS];
359     char filename[1024]; /**< input or output filename */
360     /* stream info */
361     int64_t timestamp;
362     char title[512];
363     char author[512];
364     char copyright[512];
365     char comment[512];
366     char album[512];
367     int year;  /**< ID3 year, 0 if none */
368     int track; /**< track number, 0 if none */
369     char genre[32]; /**< ID3 genre */
370
371     int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
372     /* private data for pts handling (do not modify directly) */
373     /** This buffer is only needed when packets were already buffered but
374        not decoded, for example to get the codec parameters in mpeg
375        streams */
376     struct AVPacketList *packet_buffer;
377
378     /** decoding: position of the first frame of the component, in
379        AV_TIME_BASE fractional seconds. NEVER set this value directly:
380        it is deduced from the AVStream values.  */
381     int64_t start_time;
382     /** decoding: duration of the stream, in AV_TIME_BASE fractional
383        seconds. NEVER set this value directly: it is deduced from the
384        AVStream values.  */
385     int64_t duration;
386     /** decoding: total file size. 0 if unknown */
387     int64_t file_size;
388     /** decoding: total stream bitrate in bit/s, 0 if not
389        available. Never set it directly if the file_size and the
390        duration are known as ffmpeg can compute it automatically. */
391     int bit_rate;
392
393     /* av_read_frame() support */
394     AVStream *cur_st;
395     const uint8_t *cur_ptr;
396     int cur_len;
397     AVPacket cur_pkt;
398
399     /* av_seek_frame() support */
400     int64_t data_offset; /** offset of the first packet */
401     int index_built;
402
403     int mux_rate;
404     int packet_size;
405     int preload;
406     int max_delay;
407
408 #define AVFMT_NOOUTPUTLOOP -1
409 #define AVFMT_INFINITEOUTPUTLOOP 0
410     /** number of times to loop output in formats that support it */
411     int loop_output;
412
413     int flags;
414 #define AVFMT_FLAG_GENPTS       0x0001 ///< generate pts if missing even if it requires parsing future frames
415 #define AVFMT_FLAG_IGNIDX       0x0002 ///< ignore index
416 #define AVFMT_FLAG_NONBLOCK     0x0004 ///< do not block when reading packets from input
417
418     int loop_input;
419     /** decoding: size of data to probe; encoding unused */
420     unsigned int probesize;
421
422     /**
423      * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
424      */
425     int max_analyze_duration;
426
427     const uint8_t *key;
428     int keylen;
429 } AVFormatContext;
430
431 typedef struct AVPacketList {
432     AVPacket pkt;
433     struct AVPacketList *next;
434 } AVPacketList;
435
436 extern AVInputFormat *first_iformat;
437 extern AVOutputFormat *first_oformat;
438
439 enum CodecID av_guess_image2_codec(const char *filename);
440
441 /* XXX: use automatic init with either ELF sections or C file parser */
442 /* modules */
443
444 #include "rtp.h"
445
446 #include "rtsp.h"
447
448 /* utils.c */
449 void av_register_input_format(AVInputFormat *format);
450 void av_register_output_format(AVOutputFormat *format);
451 AVOutputFormat *guess_stream_format(const char *short_name,
452                                     const char *filename, const char *mime_type);
453 AVOutputFormat *guess_format(const char *short_name,
454                              const char *filename, const char *mime_type);
455
456 /**
457  * Guesses the codec id based upon muxer and filename.
458  */
459 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
460                             const char *filename, const char *mime_type, enum CodecType type);
461
462 /**
463  * Send a nice hexadecimal dump of a buffer to the specified file stream.
464  *
465  * @param f The file stream pointer where the dump should be sent to.
466  * @param buf buffer
467  * @param size buffer size
468  *
469  * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
470  */
471 void av_hex_dump(FILE *f, uint8_t *buf, int size);
472
473 /**
474  * Send a nice hexadecimal dump of a buffer to the log.
475  *
476  * @param avcl A pointer to an arbitrary struct of which the first field is a
477  * pointer to an AVClass struct.
478  * @param level The importance level of the message, lower values signifying
479  * higher importance.
480  * @param buf buffer
481  * @param size buffer size
482  *
483  * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
484  */
485 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
486
487 /**
488  * Send a nice dump of a packet to the specified file stream.
489  *
490  * @param f The file stream pointer where the dump should be sent to.
491  * @param pkt packet to dump
492  * @param dump_payload true if the payload must be displayed too
493  */
494 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
495
496 /**
497  * Send a nice dump of a packet to the log.
498  *
499  * @param avcl A pointer to an arbitrary struct of which the first field is a
500  * pointer to an AVClass struct.
501  * @param level The importance level of the message, lower values signifying
502  * higher importance.
503  * @param pkt packet to dump
504  * @param dump_payload true if the payload must be displayed too
505  */
506 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
507
508 void av_register_all(void);
509
510 /** codec tag <-> codec id */
511 enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
512 unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
513
514 /* media file input */
515
516 /**
517  * finds AVInputFormat based on input format's short name.
518  */
519 AVInputFormat *av_find_input_format(const char *short_name);
520
521 /**
522  * Guess file format.
523  *
524  * @param is_opened whether the file is already opened, determines whether
525  *                  demuxers with or without AVFMT_NOFILE are probed
526  */
527 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
528
529 /**
530  * Allocates all the structures needed to read an input stream.
531  *        This does not open the needed codecs for decoding the stream[s].
532  */
533 int av_open_input_stream(AVFormatContext **ic_ptr,
534                          ByteIOContext *pb, const char *filename,
535                          AVInputFormat *fmt, AVFormatParameters *ap);
536
537 /**
538  * Open a media file as input. The codecs are not opened. Only the file
539  * header (if present) is read.
540  *
541  * @param ic_ptr the opened media file handle is put here
542  * @param filename filename to open.
543  * @param fmt if non NULL, force the file format to use
544  * @param buf_size optional buffer size (zero if default is OK)
545  * @param ap additional parameters needed when opening the file (NULL if default)
546  * @return 0 if OK. AVERROR_xxx otherwise.
547  */
548 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
549                        AVInputFormat *fmt,
550                        int buf_size,
551                        AVFormatParameters *ap);
552 /** no av_open for output, so applications will need this: */
553 AVFormatContext *av_alloc_format_context(void);
554
555 /**
556  * Read packets of a media file to get stream information. This
557  * is useful for file formats with no headers such as MPEG. This
558  * function also computes the real frame rate in case of mpeg2 repeat
559  * frame mode.
560  * The logical file position is not changed by this function;
561  * examined packets may be buffered for later processing.
562  *
563  * @param ic media file handle
564  * @return >=0 if OK. AVERROR_xxx if error.
565  * @todo Let user decide somehow what information is needed so we do not waste time geting stuff the user does not need.
566  */
567 int av_find_stream_info(AVFormatContext *ic);
568
569 /**
570  * Read a transport packet from a media file.
571  *
572  * This function is obsolete and should never be used.
573  * Use av_read_frame() instead.
574  *
575  * @param s media file handle
576  * @param pkt is filled
577  * @return 0 if OK. AVERROR_xxx if error.
578  */
579 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
580
581 /**
582  * Return the next frame of a stream.
583  *
584  * The returned packet is valid
585  * until the next av_read_frame() or until av_close_input_file() and
586  * must be freed with av_free_packet. For video, the packet contains
587  * exactly one frame. For audio, it contains an integer number of
588  * frames if each frame has a known fixed size (e.g. PCM or ADPCM
589  * data). If the audio frames have a variable size (e.g. MPEG audio),
590  * then it contains one frame.
591  *
592  * pkt->pts, pkt->dts and pkt->duration are always set to correct
593  * values in AVStream.timebase units (and guessed if the format cannot
594  * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
595  * has B frames, so it is better to rely on pkt->dts if you do not
596  * decompress the payload.
597  *
598  * @return 0 if OK, < 0 if error or end of file.
599  */
600 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
601
602 /**
603  * Seek to the key frame at timestamp.
604  * 'timestamp' in 'stream_index'.
605  * @param stream_index If stream_index is (-1), a default
606  * stream is selected, and timestamp is automatically converted
607  * from AV_TIME_BASE units to the stream specific time_base.
608  * @param timestamp timestamp in AVStream.time_base units
609  *        or if there is no stream specified then in AV_TIME_BASE units
610  * @param flags flags which select direction and seeking mode
611  * @return >= 0 on success
612  */
613 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
614
615 /**
616  * start playing a network based stream (e.g. RTSP stream) at the
617  * current position
618  */
619 int av_read_play(AVFormatContext *s);
620
621 /**
622  * Pause a network based stream (e.g. RTSP stream).
623  *
624  * Use av_read_play() to resume it.
625  */
626 int av_read_pause(AVFormatContext *s);
627
628 /**
629  * Close a media file (but not its codecs).
630  *
631  * @param s media file handle
632  */
633 void av_close_input_file(AVFormatContext *s);
634
635 /**
636  * Add a new stream to a media file.
637  *
638  * Can only be called in the read_header() function. If the flag
639  * AVFMTCTX_NOHEADER is in the format context, then new streams
640  * can be added in read_packet too.
641  *
642  * @param s media file handle
643  * @param id file format dependent stream id
644  */
645 AVStream *av_new_stream(AVFormatContext *s, int id);
646
647 /**
648  * Set the pts for a given stream.
649  *
650  * @param s stream
651  * @param pts_wrap_bits number of bits effectively used by the pts
652  *        (used for wrap control, 33 is the value for MPEG)
653  * @param pts_num numerator to convert to seconds (MPEG: 1)
654  * @param pts_den denominator to convert to seconds (MPEG: 90000)
655  */
656 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
657                      int pts_num, int pts_den);
658
659 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
660 #define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
661 #define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non keyframes
662
663 int av_find_default_stream_index(AVFormatContext *s);
664
665 /**
666  * Gets the index for a specific timestamp.
667  * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
668  *                 the timestamp which is <= the requested one, if backward is 0
669  *                 then it will be >=
670  *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
671  * @return < 0 if no such timestamp could be found
672  */
673 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
674
675 /**
676  * Add a index entry into a sorted list updateing if it is already there.
677  *
678  * @param timestamp timestamp in the timebase of the given stream
679  */
680 int av_add_index_entry(AVStream *st,
681                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
682
683 /**
684  * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
685  * This is not supposed to be called directly by a user application, but by demuxers.
686  * @param target_ts target timestamp in the time base of the given stream
687  * @param stream_index stream number
688  */
689 int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
690
691 /**
692  * Updates cur_dts of all streams based on given timestamp and AVStream.
693  *
694  * Stream ref_st unchanged, others set cur_dts in their native timebase
695  * only needed for timestamp wrapping or if (dts not set and pts!=dts).
696  * @param timestamp new dts expressed in time_base of param ref_st
697  * @param ref_st reference stream giving time_base of param timestamp
698  */
699 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
700
701 /**
702  * Does a binary search using read_timestamp().
703  * This is not supposed to be called directly by a user application, but by demuxers.
704  * @param target_ts target timestamp in the time base of the given stream
705  * @param stream_index stream number
706  */
707 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 ));
708
709 /** media file output */
710 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
711
712 /**
713  * Allocate the stream private data and write the stream header to an
714  * output media file.
715  *
716  * @param s media file handle
717  * @return 0 if OK. AVERROR_xxx if error.
718  */
719 int av_write_header(AVFormatContext *s);
720
721 /**
722  * Write a packet to an output media file.
723  *
724  * The packet shall contain one audio or video frame.
725  * The packet must be correctly interleaved according to the container specification,
726  * if not then av_interleaved_write_frame must be used
727  *
728  * @param s media file handle
729  * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
730  * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
731  */
732 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
733
734 /**
735  * Writes a packet to an output media file ensuring correct interleaving.
736  *
737  * The packet must contain one audio or video frame.
738  * If the packets are already correctly interleaved the application should
739  * call av_write_frame() instead as it is slightly faster. It is also important
740  * to keep in mind that completely non-interleaved input will need huge amounts
741  * of memory to interleave with this, so it is preferable to interleave at the
742  * demuxer level.
743  *
744  * @param s media file handle
745  * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
746  * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
747  */
748 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
749
750 /**
751  * Interleave a packet per DTS in an output media file.
752  *
753  * Packets with pkt->destruct == av_destruct_packet will be freed inside this function,
754  * so they cannot be used after it, note calling av_free_packet() on them is still safe.
755  *
756  * @param s media file handle
757  * @param out the interleaved packet will be output here
758  * @param in the input packet
759  * @param flush 1 if no further packets are available as input and all
760  *              remaining packets should be output
761  * @return 1 if a packet was output, 0 if no packet could be output,
762  *         < 0 if an error occured
763  */
764 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
765
766 /**
767  * @brief Write the stream trailer to an output media file and
768  *        free the file private data.
769  *
770  * @param s media file handle
771  * @return 0 if OK. AVERROR_xxx if error.
772  */
773 int av_write_trailer(AVFormatContext *s);
774
775 void dump_format(AVFormatContext *ic,
776                  int index,
777                  const char *url,
778                  int is_output);
779
780 /**
781  * parses width and height out of string str.
782  * @deprecated Use av_parse_video_frame_size instead.
783  */
784 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
785
786 /**
787  * Converts frame rate from string to a fraction.
788  * @deprecated Use av_parse_video_frame_rate instead.
789  */
790 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
791
792 /**
793  * Converts date string to number of seconds since Jan 1st, 1970.
794  *
795  * @code
796  * Syntax:
797  * - If not a duration:
798  *  [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
799  * Time is localtime unless Z is suffixed to the end. In this case GMT
800  * Return the date in micro seconds since 1970
801  *
802  * - If a duration:
803  *  HH[:MM[:SS[.m...]]]
804  *  S+[.m...]
805  * @endcode
806  */
807 int64_t parse_date(const char *datestr, int duration);
808
809 int64_t av_gettime(void);
810
811 /* ffm specific for ffserver */
812 #define FFM_PACKET_SIZE 4096
813 offset_t ffm_read_write_index(int fd);
814 void ffm_write_write_index(int fd, offset_t pos);
815 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
816
817 /**
818  * Attempts to find a specific tag in a URL.
819  *
820  * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
821  * Return 1 if found.
822  */
823 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
824
825 /**
826  * Returns in 'buf' the path with '%d' replaced by number.
827
828  * Also handles the '%0nd' format where 'n' is the total number
829  * of digits and '%%'.
830  *
831  * @param buf destination buffer
832  * @param buf_size destination buffer size
833  * @param path numbered sequence string
834  * @number frame number
835  * @return 0 if OK, -1 if format error.
836  */
837 int av_get_frame_filename(char *buf, int buf_size,
838                           const char *path, int number);
839
840 /**
841  * Check whether filename actually is a numbered sequence generator.
842  *
843  * @param filename possible numbered sequence string
844  * @return 1 if a valid numbered sequence string, 0 otherwise.
845  */
846 int av_filename_number_test(const char *filename);
847
848 /**
849  * Generate an SDP for an RTP session.
850  *
851  * @param ac array of AVFormatContexts describing the RTP streams. If the
852  *           array is composed by only one context, such context can contain
853  *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
854  *           all the contexts in the array (an AVCodecContext per RTP stream)
855  *           must contain only one AVStream
856  * @param n_files number of AVCodecContexts contained in ac
857  * @param buff buffer where the SDP will be stored (must be allocated by
858  *             the caller
859  * @param size the size of the buffer
860  * @return 0 if OK. AVERROR_xxx if error.
861  */
862 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
863
864 #ifdef HAVE_AV_CONFIG_H
865
866 #include "os_support.h"
867
868 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
869
870 #ifdef __GNUC__
871 #define dynarray_add(tab, nb_ptr, elem)\
872 do {\
873     typeof(tab) _tab = (tab);\
874     typeof(elem) _elem = (elem);\
875     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
876     __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
877 } while(0)
878 #else
879 #define dynarray_add(tab, nb_ptr, elem)\
880 do {\
881     __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
882 } while(0)
883 #endif
884
885 time_t mktimegm(struct tm *tm);
886 struct tm *brktimegm(time_t secs, struct tm *tm);
887 const char *small_strptime(const char *p, const char *fmt,
888                            struct tm *dt);
889
890 struct in_addr;
891 int resolve_host(struct in_addr *sin_addr, const char *hostname);
892
893 void url_split(char *proto, int proto_size,
894                char *authorization, int authorization_size,
895                char *hostname, int hostname_size,
896                int *port_ptr,
897                char *path, int path_size,
898                const char *url);
899
900 int match_ext(const char *filename, const char *extensions);
901
902 #endif /* HAVE_AV_CONFIG_H */
903
904 #endif /* AVFORMAT_H */
905