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