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