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