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