fix AVStream documentation: clarify start_time, start_time and duration are actually...
[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: pts of the first frame of the stream, in stream time base. */
310     int64_t start_time;
311     /** decoding: duration of the stream, in stream time base. */
312     int64_t duration;
313
314     char language[4]; /** ISO 639 3-letter language code (empty string if undefined) */
315
316     /* av_read_frame() support */
317     enum AVStreamParseType need_parsing;
318     struct AVCodecParserContext *parser;
319
320     int64_t cur_dts;
321     int last_IP_duration;
322     int64_t last_IP_pts;
323     /* av_seek_frame() support */
324     AVIndexEntry *index_entries; /**< only used if the format does not
325                                     support seeking natively */
326     int nb_index_entries;
327     unsigned int index_entries_allocated_size;
328
329     int64_t nb_frames;                 ///< number of frames in this stream if known or 0
330
331 #define MAX_REORDER_DELAY 4
332     int64_t pts_buffer[MAX_REORDER_DELAY+1];
333 } AVStream;
334
335 #define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
336                                          (streams are added dynamically) */
337
338 #define MAX_STREAMS 20
339
340 /* format I/O context */
341 typedef struct AVFormatContext {
342     const AVClass *av_class; /**< set by av_alloc_format_context */
343     /* can only be iformat or oformat, not both at the same time */
344     struct AVInputFormat *iformat;
345     struct AVOutputFormat *oformat;
346     void *priv_data;
347     ByteIOContext pb;
348     unsigned int nb_streams;
349     AVStream *streams[MAX_STREAMS];
350     char filename[1024]; /**< input or output filename */
351     /* stream info */
352     int64_t timestamp;
353     char title[512];
354     char author[512];
355     char copyright[512];
356     char comment[512];
357     char album[512];
358     int year;  /**< ID3 year, 0 if none */
359     int track; /**< track number, 0 if none */
360     char genre[32]; /**< ID3 genre */
361
362     int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
363     /* private data for pts handling (do not modify directly) */
364     /** This buffer is only needed when packets were already buffered but
365        not decoded, for example to get the codec parameters in mpeg
366        streams */
367     struct AVPacketList *packet_buffer;
368
369     /** decoding: position of the first frame of the component, in
370        AV_TIME_BASE fractional seconds. NEVER set this value directly:
371        it is deduced from the AVStream values.  */
372     int64_t start_time;
373     /** decoding: duration of the stream, in AV_TIME_BASE fractional
374        seconds. NEVER set this value directly: it is deduced from the
375        AVStream values.  */
376     int64_t duration;
377     /** decoding: total file size. 0 if unknown */
378     int64_t file_size;
379     /** decoding: total stream bitrate in bit/s, 0 if not
380        available. Never set it directly if the file_size and the
381        duration are known as ffmpeg can compute it automatically. */
382     int bit_rate;
383
384     /* av_read_frame() support */
385     AVStream *cur_st;
386     const uint8_t *cur_ptr;
387     int cur_len;
388     AVPacket cur_pkt;
389
390     /* av_seek_frame() support */
391     int64_t data_offset; /** offset of the first packet */
392     int index_built;
393
394     int mux_rate;
395     int packet_size;
396     int preload;
397     int max_delay;
398
399 #define AVFMT_NOOUTPUTLOOP -1
400 #define AVFMT_INFINITEOUTPUTLOOP 0
401     /** number of times to loop output in formats that support it */
402     int loop_output;
403
404     int flags;
405 #define AVFMT_FLAG_GENPTS       0x0001 ///< generate pts if missing even if it requires parsing future frames
406 #define AVFMT_FLAG_IGNIDX       0x0002 ///< ignore index
407
408     int loop_input;
409     /** decoding: size of data to probe; encoding unused */
410     unsigned int probesize;
411
412     /**
413      * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
414      */
415     int max_analyze_duration;
416
417     const uint8_t *key;
418     int keylen;
419 } AVFormatContext;
420
421 typedef struct AVPacketList {
422     AVPacket pkt;
423     struct AVPacketList *next;
424 } AVPacketList;
425
426 extern AVInputFormat *first_iformat;
427 extern AVOutputFormat *first_oformat;
428
429 enum CodecID av_guess_image2_codec(const char *filename);
430
431 /* XXX: use automatic init with either ELF sections or C file parser */
432 /* modules */
433
434 #include "rtp.h"
435
436 #include "rtsp.h"
437
438 /* utils.c */
439 void av_register_input_format(AVInputFormat *format);
440 void av_register_output_format(AVOutputFormat *format);
441 AVOutputFormat *guess_stream_format(const char *short_name,
442                                     const char *filename, const char *mime_type);
443 AVOutputFormat *guess_format(const char *short_name,
444                              const char *filename, const char *mime_type);
445
446 /**
447  * Guesses the codec id based upon muxer and filename.
448  */
449 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
450                             const char *filename, const char *mime_type, enum CodecType type);
451
452 /**
453  * Send a nice hexadecimal dump of a buffer to the specified file stream.
454  *
455  * @param f The file stream pointer where the dump should be sent to.
456  * @param buf buffer
457  * @param size buffer size
458  *
459  * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
460  */
461 void av_hex_dump(FILE *f, uint8_t *buf, int size);
462
463 /**
464  * Send a nice hexadecimal dump of a buffer to the log.
465  *
466  * @param avcl A pointer to an arbitrary struct of which the first field is a
467  * pointer to an AVClass struct.
468  * @param level The importance level of the message, lower values signifying
469  * higher importance.
470  * @param buf buffer
471  * @param size buffer size
472  *
473  * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
474  */
475 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
476
477 /**
478  * Send a nice dump of a packet to the specified file stream.
479  *
480  * @param f The file stream pointer where the dump should be sent to.
481  * @param pkt packet to dump
482  * @param dump_payload true if the payload must be displayed too
483  */
484 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
485
486 /**
487  * Send a nice dump of a packet to the log.
488  *
489  * @param avcl A pointer to an arbitrary struct of which the first field is a
490  * pointer to an AVClass struct.
491  * @param level The importance level of the message, lower values signifying
492  * higher importance.
493  * @param pkt packet to dump
494  * @param dump_payload true if the payload must be displayed too
495  */
496 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
497
498 void av_register_all(void);
499
500 /** codec tag <-> codec id */
501 enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
502 unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
503
504 /* media file input */
505
506 /**
507  * finds AVInputFormat based on input format's short name.
508  */
509 AVInputFormat *av_find_input_format(const char *short_name);
510
511 /**
512  * Guess file format.
513  *
514  * @param is_opened whether the file is already opened, determines whether
515  *                  demuxers with or without AVFMT_NOFILE are probed
516  */
517 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
518
519 /**
520  * Allocates all the structures needed to read an input stream.
521  *        This does not open the needed codecs for decoding the stream[s].
522  */
523 int av_open_input_stream(AVFormatContext **ic_ptr,
524                          ByteIOContext *pb, const char *filename,
525                          AVInputFormat *fmt, AVFormatParameters *ap);
526
527 /**
528  * Open a media file as input. The codec are not opened. Only the file
529  * header (if present) is read.
530  *
531  * @param ic_ptr the opened media file handle is put here
532  * @param filename filename to open.
533  * @param fmt if non NULL, force the file format to use
534  * @param buf_size optional buffer size (zero if default is OK)
535  * @param ap additional parameters needed when opening the file (NULL if default)
536  * @return 0 if OK. AVERROR_xxx otherwise.
537  */
538 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
539                        AVInputFormat *fmt,
540                        int buf_size,
541                        AVFormatParameters *ap);
542 /** no av_open for output, so applications will need this: */
543 AVFormatContext *av_alloc_format_context(void);
544
545 /**
546  * Read packets of a media file to get stream information. This
547  * is useful for file formats with no headers such as MPEG. This
548  * function also computes the real frame rate in case of mpeg2 repeat
549  * frame mode.
550  * The logical file position is not changed by this function;
551  * examined packets may be buffered for later processing.
552  *
553  * @param ic media file handle
554  * @return >=0 if OK. AVERROR_xxx if error.
555  * @todo let user decide somehow what information is needed so we dont waste time geting stuff the user doesnt need
556  */
557 int av_find_stream_info(AVFormatContext *ic);
558
559 /**
560  * Read a transport packet from a media file.
561  *
562  * This function is absolete and should never be used.
563  * Use av_read_frame() instead.
564  *
565  * @param s media file handle
566  * @param pkt is filled
567  * @return 0 if OK. AVERROR_xxx if error.
568  */
569 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
570
571 /**
572  * Return the next frame of a stream.
573  *
574  * The returned packet is valid
575  * until the next av_read_frame() or until av_close_input_file() and
576  * must be freed with av_free_packet. For video, the packet contains
577  * exactly one frame. For audio, it contains an integer number of
578  * frames if each frame has a known fixed size (e.g. PCM or ADPCM
579  * data). If the audio frames have a variable size (e.g. MPEG audio),
580  * then it contains one frame.
581  *
582  * pkt->pts, pkt->dts and pkt->duration are always set to correct
583  * values in AVStream.timebase units (and guessed if the format cannot
584  * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
585  * has B frames, so it is better to rely on pkt->dts if you do not
586  * decompress the payload.
587  *
588  * @return 0 if OK, < 0 if error or end of file.
589  */
590 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
591
592 /**
593  * Seek to the key frame at timestamp.
594  * 'timestamp' in 'stream_index'.
595  * @param stream_index If stream_index is (-1), a default
596  * stream is selected, and timestamp is automatically converted
597  * from AV_TIME_BASE units to the stream specific time_base.
598  * @param timestamp timestamp in AVStream.time_base units
599  *        or if there is no stream specified then in AV_TIME_BASE units
600  * @param flags flags which select direction and seeking mode
601  * @return >= 0 on success
602  */
603 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
604
605 /**
606  * start playing a network based stream (e.g. RTSP stream) at the
607  * current position
608  */
609 int av_read_play(AVFormatContext *s);
610
611 /**
612  * Pause a network based stream (e.g. RTSP stream).
613  *
614  * Use av_read_play() to resume it.
615  */
616 int av_read_pause(AVFormatContext *s);
617
618 /**
619  * Close a media file (but not its codecs).
620  *
621  * @param s media file handle
622  */
623 void av_close_input_file(AVFormatContext *s);
624
625 /**
626  * Add a new stream to a media file.
627  *
628  * Can only be called in the read_header() function. If the flag
629  * AVFMTCTX_NOHEADER is in the format context, then new streams
630  * can be added in read_packet too.
631  *
632  * @param s media file handle
633  * @param id file format dependent stream id
634  */
635 AVStream *av_new_stream(AVFormatContext *s, int id);
636
637 /**
638  * Set the pts for a given stream.
639  *
640  * @param s stream
641  * @param pts_wrap_bits number of bits effectively used by the pts
642  *        (used for wrap control, 33 is the value for MPEG)
643  * @param pts_num numerator to convert to seconds (MPEG: 1)
644  * @param pts_den denominator to convert to seconds (MPEG: 90000)
645  */
646 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
647                      int pts_num, int pts_den);
648
649 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
650 #define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
651 #define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non keyframes
652
653 int av_find_default_stream_index(AVFormatContext *s);
654
655 /**
656  * Gets the index for a specific timestamp.
657  * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
658  *                 the timestamp which is <= the requested one, if backward is 0
659  *                 then it will be >=
660  *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
661  * @return < 0 if no such timestamp could be found
662  */
663 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
664
665 /**
666  * Add a index entry into a sorted list updateing if it is already there.
667  *
668  * @param timestamp timestamp in the timebase of the given stream
669  */
670 int av_add_index_entry(AVStream *st,
671                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
672
673 /**
674  * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
675  * this isnt supposed to be called directly by a user application, but by demuxers
676  * @param target_ts target timestamp in the time base of the given stream
677  * @param stream_index stream number
678  */
679 int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
680
681 /**
682  * Updates cur_dts of all streams based on given timestamp and AVStream.
683  *
684  * Stream ref_st unchanged, others set cur_dts in their native timebase
685  * only needed for timestamp wrapping or if (dts not set and pts!=dts)
686  * @param timestamp new dts expressed in time_base of param ref_st
687  * @param ref_st reference stream giving time_base of param timestamp
688  */
689 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
690
691 /**
692  * Does a binary search using read_timestamp().
693  * this isnt supposed to be called directly by a user application, but by demuxers
694  * @param target_ts target timestamp in the time base of the given stream
695  * @param stream_index stream number
696  */
697 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 ));
698
699 /** media file output */
700 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
701
702 /**
703  * allocate the stream private data and write the stream header to an
704  * output media file
705  *
706  * @param s media file handle
707  * @return 0 if OK. AVERROR_xxx if error.
708  */
709 int av_write_header(AVFormatContext *s);
710
711 /**
712  * Write a packet to an output media file.
713  *
714  * The packet shall contain one audio or video frame.
715  * The packet must be correctly interleaved according to the container specification,
716  * if not then av_interleaved_write_frame must be used
717  *
718  * @param s media file handle
719  * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
720  * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
721  */
722 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
723
724 /**
725  * Writes a packet to an output media file ensuring correct interleaving.
726  *
727  * The packet must contain one audio or video frame.
728  * If the packets are already correctly interleaved the application should
729  * call av_write_frame() instead as its slightly faster, its also important
730  * to keep in mind that completly non interleaved input will need huge amounts
731  * of memory to interleave with this, so its prefereable to interleave at the
732  * demuxer level
733  *
734  * @param s media file handle
735  * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
736  * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
737  */
738 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
739
740 /**
741  * Interleave a packet per DTS in an output media file.
742  *
743  * Packets with pkt->destruct == av_destruct_packet will be freed inside this function,
744  * so they cannot be used after it, note calling av_free_packet() on them is still safe.
745  *
746  * @param s media file handle
747  * @param out the interleaved packet will be output here
748  * @param in the input packet
749  * @param flush 1 if no further packets are available as input and all
750  *              remaining packets should be output
751  * @return 1 if a packet was output, 0 if no packet could be output,
752  *         < 0 if an error occured
753  */
754 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
755
756 /**
757  * @brief Write the stream trailer to an output media file and
758  *        free the file private data.
759  *
760  * @param s media file handle
761  * @return 0 if OK. AVERROR_xxx if error.
762  */
763 int av_write_trailer(AVFormatContext *s);
764
765 void dump_format(AVFormatContext *ic,
766                  int index,
767                  const char *url,
768                  int is_output);
769
770 /**
771  * parses width and height out of string str.
772  */
773 int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
774
775 /**
776  * Converts frame rate from string to a fraction.
777  */
778 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 /* grab specific */
837 int video_grab_init(void);
838 int audio_init(void);
839
840 /* DV1394 */
841 int dv1394_init(void);
842 int dc1394_init(void);
843
844 #ifdef HAVE_AV_CONFIG_H
845
846 #include "os_support.h"
847
848 int strstart(const char *str, const char *val, const char **ptr);
849 int stristart(const char *str, const char *val, const char **ptr);
850 void pstrcpy(char *buf, int buf_size, const char *str);
851 char *pstrcat(char *buf, int buf_size, const char *s);
852
853 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
854
855 #ifdef __GNUC__
856 #define dynarray_add(tab, nb_ptr, elem)\
857 do {\
858     typeof(tab) _tab = (tab);\
859     typeof(elem) _elem = (elem);\
860     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
861     __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
862 } while(0)
863 #else
864 #define dynarray_add(tab, nb_ptr, elem)\
865 do {\
866     __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
867 } while(0)
868 #endif
869
870 time_t mktimegm(struct tm *tm);
871 struct tm *brktimegm(time_t secs, struct tm *tm);
872 const char *small_strptime(const char *p, const char *fmt,
873                            struct tm *dt);
874
875 struct in_addr;
876 int resolve_host(struct in_addr *sin_addr, const char *hostname);
877
878 void url_split(char *proto, int proto_size,
879                char *authorization, int authorization_size,
880                char *hostname, int hostname_size,
881                int *port_ptr,
882                char *path, int path_size,
883                const char *url);
884
885 int match_ext(const char *filename, const char *extensions);
886
887 #endif /* HAVE_AV_CONFIG_H */
888
889 #ifdef __cplusplus
890 }
891 #endif
892
893 #endif /* AVFORMAT_H */
894