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