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