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