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