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