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