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