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