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