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