avformat.h 29.1 KB
Newer Older
1 2 3
/*
 * copyright (c) 2001 Fabrice Bellard
 *
4 5 6
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
7 8
 * modify it under the terms of the GNU Lesser General Public
 * 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 13 14 15 16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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 19 20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

bellard's avatar
bellard committed
21 22
#ifndef AVFORMAT_H
#define AVFORMAT_H
glantau's avatar
glantau committed
23

kabi's avatar
kabi committed
24 25 26 27
#ifdef __cplusplus
extern "C" {
#endif

28 29
#define LIBAVFORMAT_VERSION_INT ((51<<16)+(10<<8)+0)
#define LIBAVFORMAT_VERSION     51.10.0
michael's avatar
michael committed
30
#define LIBAVFORMAT_BUILD       LIBAVFORMAT_VERSION_INT
al3x's avatar
al3x committed
31

michael's avatar
michael committed
32
#define LIBAVFORMAT_IDENT       "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
33

34
#include <time.h>
kabi's avatar
kabi committed
35
#include <stdio.h>  /* FILE */
glantau's avatar
glantau committed
36 37 38 39 40 41 42
#include "avcodec.h"

#include "avio.h"

/* packet functions */

typedef struct AVPacket {
michael's avatar
michael committed
43 44
    int64_t pts;                            ///< presentation time stamp in time_base units
    int64_t dts;                            ///< decompression time stamp in time_base units
kabi's avatar
kabi committed
45
    uint8_t *data;
46 47 48
    int   size;
    int   stream_index;
    int   flags;
michael's avatar
michael committed
49
    int   duration;                         ///< presentation duration in time_base units (0 if not available)
50 51
    void  (*destruct)(struct AVPacket *);
    void  *priv;
michael's avatar
michael committed
52
    int64_t pos;                            ///< byte position in stream, -1 if unknown
53
} AVPacket;
54 55
#define PKT_FLAG_KEY   0x0001

michael's avatar
michael committed
56
void av_destruct_packet_nofree(AVPacket *pkt);
57 58 59 60

/**
 * Default packet destructor.
 */
61
void av_destruct_packet(AVPacket *pkt);
michael's avatar
michael committed
62

63
/* initialize optional fields of a packet */
64 65 66
static inline void av_init_packet(AVPacket *pkt)
{
    pkt->pts   = AV_NOPTS_VALUE;
67
    pkt->dts   = AV_NOPTS_VALUE;
michael's avatar
michael committed
68
    pkt->pos   = -1;
69
    pkt->duration = 0;
70 71
    pkt->flags = 0;
    pkt->stream_index = 0;
michael's avatar
michael committed
72
    pkt->destruct= av_destruct_packet_nofree;
73
}
glantau's avatar
glantau committed
74

75 76 77 78 79 80 81
/**
 * Allocate the payload of a packet and intialized its fields to default values.
 *
 * @param pkt packet
 * @param size wanted payload size
 * @return 0 if OK. AVERROR_xxx otherwise.
 */
glantau's avatar
glantau committed
82
int av_new_packet(AVPacket *pkt, int size);
83 84 85 86 87 88 89 90

/**
 * Allocate and read the payload of a packet and intialized its fields to default values.
 *
 * @param pkt packet
 * @param size wanted payload size
 * @return >0 (read size) if OK. AVERROR_xxx otherwise.
 */
michael's avatar
michael committed
91
int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
92

93 94 95 96
/**
 * @warning This is a hack - the packet memory allocation stuff is broken. The
 * packet is allocated if it was not really allocated
 */
97
int av_dup_packet(AVPacket *pkt);
98 99 100 101 102 103 104 105

/**
 * Free a packet
 *
 * @param pkt packet to free
 */
static inline void av_free_packet(AVPacket *pkt)
{
106
    if (pkt && pkt->destruct) {
107
        pkt->destruct(pkt);
108
    }
109
}
glantau's avatar
glantau committed
110

bellard's avatar
bellard committed
111 112 113 114 115 116
/*************************************************/
/* fractional numbers for exact pts handling */

/* the exact value of the fractional number is: 'val + num / den'. num
   is assumed to be such as 0 <= num < den */
typedef struct AVFrac {
117
    int64_t val, num, den;
michael's avatar
michael committed
118
} AVFrac attribute_deprecated;
bellard's avatar
bellard committed
119

glantau's avatar
glantau committed
120
/*************************************************/
121
/* input/output formats */
glantau's avatar
glantau committed
122

123 124
struct AVCodecTag;

glantau's avatar
glantau committed
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 131 132 133
    unsigned char *buf;
    int buf_size;
} AVProbeData;

michael's avatar
michael committed
134
#define AVPROBE_SCORE_MAX 100               ///< max score, half of that is used for file extension based detection
glantau's avatar
glantau committed
135 136

typedef struct AVFormatParameters {
michael's avatar
michael committed
137
    AVRational time_base;
glantau's avatar
glantau committed
138 139 140 141
    int sample_rate;
    int channels;
    int width;
    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 148 149
    const char *standard; /**< tv standard, NTSC, PAL, SECAM */
    int mpeg2ts_raw:1;  /**< force raw MPEG2 transport stream output, if possible */
    int mpeg2ts_compute_pcr:1; /**< compute exact PCR for each transport
150 151
                                  stream packet (only meaningful if
                                  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 156
    enum CodecID video_codec_id;
    enum CodecID audio_codec_id;
glantau's avatar
glantau committed
157 158
} AVFormatParameters;

159 160
//! demuxer will use url_fopen, no opened file should be provided by the caller
#define AVFMT_NOFILE        0x0001
161 162 163
#define AVFMT_NEEDNUMBER    0x0002 /**< needs '%d' in filename */
#define AVFMT_SHOW_IDS      0x0008 /**< show format stream IDs numbers */
#define AVFMT_RAWPICTURE    0x0020 /**< format wants AVPicture structure for
bellard's avatar
bellard committed
164
                                      raw picture data */
165 166 167
#define AVFMT_GLOBALHEADER  0x0040 /**< format wants global header */
#define AVFMT_NOTIMESTAMPS  0x0080 /**< format doesnt need / has any timestamps */
#define AVFMT_GENERIC_INDEX 0x0100 /**< use generic index building code */
168 169

typedef struct AVOutputFormat {
glantau's avatar
glantau committed
170 171 172
    const char *name;
    const char *long_name;
    const char *mime_type;
173 174
    const char *extensions; /**< comma separated extensions */
    /** size of private data so that it can be allocated in the wrapper */
175
    int priv_data_size;
glantau's avatar
glantau committed
176
    /* output support */
177 178
    enum CodecID audio_codec; /**< default audio codec */
    enum CodecID video_codec; /**< default video codec */
glantau's avatar
glantau committed
179
    int (*write_header)(struct AVFormatContext *);
180
    int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
glantau's avatar
glantau committed
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 190 191

    /**
     * list of supported codec_id-codec_tag pairs, ordered by "better choice first"
     * the arrays are all CODEC_ID_NONE terminated
     */
192
    const struct AVCodecTag **codec_tag;
193

194 195 196
    /* private fields */
    struct AVOutputFormat *next;
} AVOutputFormat;
glantau's avatar
glantau committed
197

198 199 200
typedef struct AVInputFormat {
    const char *name;
    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
glantau's avatar
glantau committed
206
       structure. Return 0 if OK. 'ap' if non NULL contains
207 208
       additionnal paramters. Only used in raw format right
       now. 'av_new_stream' should be called to create new streams.  */
glantau's avatar
glantau committed
209 210
    int (*read_header)(struct AVFormatContext *,
                       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. */
glantau's avatar
glantau committed
214
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
215
    /** close the stream. The AVFormatContext and AVStreams are not
glantau's avatar
glantau committed
216 217
       freed by this function */
    int (*read_close)(struct AVFormatContext *);
218 219
    /**
     * seek to a given timestamp relative to the frames in
michael's avatar
michael committed
220 221
     * stream component stream_index
     * @param stream_index must not be -1
222
     * @param flags selects which direction should be preferred if no exact
michael's avatar
michael committed
223 224
     *              match is available
     */
225
    int (*read_seek)(struct AVFormatContext *,
michael's avatar
michael committed
226
                     int stream_index, int64_t timestamp, int flags);
227 228 229 230 231
    /**
     * gets the next timestamp in AV_TIME_BASE units.
     */
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
                              int64_t *pos, int64_t pos_limit);
232
    /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
glantau's avatar
glantau committed
233
    int flags;
234
    /** if extensions are defined, then no probe is done. You should
235 236 237
       usually not use extension format guessing because it is not
       reliable enough */
    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 243 244
       (RTSP) */
    int (*read_play)(struct AVFormatContext *);

245
    /** pause playing - only meaningful if using a network based format
246 247 248
       (RTSP) */
    int (*read_pause)(struct AVFormatContext *);

249
    const struct AVCodecTag **codec_tag;
250

251 252 253
    /* private fields */
    struct AVInputFormat *next;
} AVInputFormat;
glantau's avatar
glantau committed
254

255 256 257 258
typedef struct AVIndexEntry {
    int64_t pos;
    int64_t timestamp;
#define AVINDEX_KEYFRAME 0x0001
michael's avatar
michael committed
259 260
    int flags:2;
    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 263
} AVIndexEntry;

glantau's avatar
glantau committed
264
typedef struct AVStream {
265 266 267
    int index;    /**< stream index in AVFormatContext */
    int id;       /**< format specific stream id */
    AVCodecContext *codec; /**< codec context */
268 269
    /**
     * real base frame rate of the stream.
270 271 272
     * this is the lowest framerate with which all timestamps can be
     * represented accurately (its the least common multiple of all
     * 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 275 276
     * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1
     */
    AVRational r_frame_rate;
glantau's avatar
glantau committed
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 286 287 288 289

    /**
     * this is the fundamental unit of time (in seconds) in terms
     * of which frame timestamps are represented. for fixed-fps content,
     * timebase should be 1/framerate and timestamp increments should be
     * identically 1.
     */
290
    AVRational time_base;
291
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
bellard's avatar
bellard committed
292
    /* ffmpeg.c private use */
takis's avatar
takis committed
293
    int stream_copy; /**< if TRUE, 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
michaelni's avatar
michaelni committed
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 304
       seconds. */
    int64_t duration;
305

306
    char language[4]; /** ISO 639 3-letter language code (empty string if undefined) */
307

308
    /* av_read_frame() support */
michael's avatar
michael committed
309
    int need_parsing;                  ///< 1->full parsing needed, 2->only parse headers dont repack
310
    struct AVCodecParserContext *parser;
311

312 313
    int64_t cur_dts;
    int last_IP_duration;
michael's avatar
michael committed
314
    int64_t last_IP_pts;
315
    /* av_seek_frame() support */
316
    AVIndexEntry *index_entries; /**< only used if the format does not
317 318
                                    support seeking natively */
    int nb_index_entries;
mru's avatar
mru committed
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 324

#define MAX_REORDER_DELAY 4
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
glantau's avatar
glantau committed
325 326
} AVStream;

327
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
328 329
                                         (streams are added dynamically) */

glantau's avatar
glantau committed
330 331 332 333
#define MAX_STREAMS 20

/* format I/O context */
typedef struct AVFormatContext {
334
    const AVClass *av_class; /**< set by av_alloc_format_context */
335 336 337
    /* can only be iformat or oformat, not both at the same time */
    struct AVInputFormat *iformat;
    struct AVOutputFormat *oformat;
glantau's avatar
glantau committed
338 339
    void *priv_data;
    ByteIOContext pb;
340
    unsigned int nb_streams;
glantau's avatar
glantau committed
341
    AVStream *streams[MAX_STREAMS];
342
    char filename[1024]; /**< input or output filename */
glantau's avatar
glantau committed
343
    /* stream info */
romansh's avatar
 
romansh committed
344
    int64_t timestamp;
glantau's avatar
glantau committed
345 346 347 348
    char title[512];
    char author[512];
    char copyright[512];
    char comment[512];
349
    char album[512];
350 351 352
    int year;  /**< ID3 year, 0 if none */
    int track; /**< track number, 0 if none */
    char genre[32]; /**< ID3 genre */
353

354
    int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
bellard's avatar
bellard committed
355
    /* private data for pts handling (do not modify directly) */
356
    /** This buffer is only needed when packets were already buffered but
glantau's avatar
glantau committed
357 358
       not decoded, for example to get the codec parameters in mpeg
       streams */
359 360
    struct AVPacketList *packet_buffer;

361
    /** decoding: position of the first frame of the component, in
362 363
       AV_TIME_BASE fractional seconds. NEVER set this value directly:
       it is deduced from the AVStream values.  */
364
    int64_t start_time;
365
    /** decoding: duration of the stream, in AV_TIME_BASE fractional
366 367 368
       seconds. NEVER set this value directly: it is deduced from the
       AVStream values.  */
    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 373 374
       available. Never set it directly if the file_size and the
       duration are known as ffmpeg can compute it automatically. */
    int bit_rate;
375 376 377 378 379 380 381 382

    /* av_read_frame() support */
    AVStream *cur_st;
    const uint8_t *cur_ptr;
    int cur_len;
    AVPacket cur_pkt;

    /* av_seek_frame() support */
383
    int64_t data_offset; /** offset of the first packet */
384
    int index_built;
385

386 387
    int mux_rate;
    int packet_size;
388 389
    int preload;
    int max_delay;
390

391 392
#define AVFMT_NOOUTPUTLOOP -1
#define AVFMT_INFINITEOUTPUTLOOP 0
393
    /** number of times to loop output in formats that support it */
394
    int loop_output;
395

396 397
    int flags;
#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 406 407

    /**
     * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
     */
    int max_analyze_duration;
408 409 410

    const uint8_t *key;
    int keylen;
glantau's avatar
glantau committed
411 412 413 414 415 416 417
} AVFormatContext;

typedef struct AVPacketList {
    AVPacket pkt;
    struct AVPacketList *next;
} AVPacketList;

418 419
extern AVInputFormat *first_iformat;
extern AVOutputFormat *first_oformat;
glantau's avatar
glantau committed
420

421
enum CodecID av_guess_image2_codec(const char *filename);
422

423 424
/* XXX: use automatic init with either ELF sections or C file parser */
/* modules */
glantau's avatar
glantau committed
425

bellard's avatar
bellard committed
426 427 428 429
#include "rtp.h"

#include "rtsp.h"

430 431 432
/* utils.c */
void av_register_input_format(AVInputFormat *format);
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 440

/**
 * Guesses the codec id based upon muxer and filename.
 */
441
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
442
                            const char *filename, const char *mime_type, enum CodecType type);
glantau's avatar
glantau committed
443

444 445 446 447 448 449
/**
 * Print  nice hexa dump of a buffer
 * @param f stream for output
 * @param buf buffer
 * @param size buffer size
 */
450
void av_hex_dump(FILE *f, uint8_t *buf, int size);
451 452 453 454 455 456 457

/**
 * Print on 'f' a nice dump of a packet
 * @param f stream for output
 * @param pkt packet to dump
 * @param dump_payload true if the payload must be displayed too
 */
458
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
glantau's avatar
glantau committed
459

bellard's avatar
bellard committed
460
void av_register_all(void);
glantau's avatar
glantau committed
461

462
/** codec tag <-> codec id */
463 464
enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
465

466
/* media file input */
467 468 469 470

/**
 * finds AVInputFormat based on input format's short name.
 */
471
AVInputFormat *av_find_input_format(const char *short_name);
472 473 474 475 476 477 478

/**
 * Guess file format.
 *
 * @param is_opened whether the file is already opened, determines whether
 *                  demuxers with or without AVFMT_NOFILE are probed
 */
bellard's avatar
bellard committed
479
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
480 481 482 483 484

/**
 * Allocates all the structures needed to read an input stream.
 *        This does not open the needed codecs for decoding the stream[s].
 */
485 486
int av_open_input_stream(AVFormatContext **ic_ptr,
                         ByteIOContext *pb, const char *filename,
487
                         AVInputFormat *fmt, AVFormatParameters *ap);
488 489 490 491 492 493 494 495 496 497 498 499

/**
 * Open a media file as input. The codec are not opened. Only the file
 * header (if present) is read.
 *
 * @param ic_ptr the opened media file handle is put here
 * @param filename filename to open.
 * @param fmt if non NULL, force the file format to use
 * @param buf_size optional buffer size (zero if default is OK)
 * @param ap additionnal parameters needed when opening the file (NULL if default)
 * @return 0 if OK. AVERROR_xxx otherwise.
 */
500
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
501 502 503
                       AVInputFormat *fmt,
                       int buf_size,
                       AVFormatParameters *ap);
504
/** no av_open for output, so applications will need this: */
505
AVFormatContext *av_alloc_format_context(void);
506

507 508 509 510 511 512 513 514 515 516 517 518
/**
 * Read packets of a media file to get stream information. This
 * is useful for file formats with no headers such as MPEG. This
 * function also computes the real frame rate in case of mpeg2 repeat
 * frame mode.
 * The logical file position is not changed by this function;
 * examined packets may be buffered for later processing.
 *
 * @param ic media file handle
 * @return >=0 if OK. AVERROR_xxx if error.
 * @todo let user decide somehow what information is needed so we dont waste time geting stuff the user doesnt need
 */
519
int av_find_stream_info(AVFormatContext *ic);
520 521 522 523 524 525 526 527 528 529 530

/**
 * Read a transport packet from a media file.
 *
 * This function is absolete and should never be used.
 * Use av_read_frame() instead.
 *
 * @param s media file handle
 * @param pkt is filled
 * @return 0 if OK. AVERROR_xxx if error.
 */
glantau's avatar
glantau committed
531
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
532 533 534 535 536 537 538 539 540 541 542 543 544

/**
 * Return the next frame of a stream.
 *
 * The returned packet is valid
 * until the next av_read_frame() or until av_close_input_file() and
 * must be freed with av_free_packet. For video, the packet contains
 * exactly one frame. For audio, it contains an integer number of
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
 * data). If the audio frames have a variable size (e.g. MPEG audio),
 * then it contains one frame.
 *
 * 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 547 548 549 550 551
 * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
 * has B frames, so it is better to rely on pkt->dts if you do not
 * decompress the payload.
 *
 * @return 0 if OK, < 0 if error or end of file.
 */
552
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
553 554 555 556 557 558 559 560 561 562 563 564

/**
 * Seek to the key frame at timestamp.
 * 'timestamp' in 'stream_index'.
 * @param stream_index If stream_index is (-1), a default
 * stream is selected, and timestamp is automatically converted
 * from AV_TIME_BASE units to the stream specific time_base.
 * @param timestamp timestamp in AVStream.time_base units
 *        or if there is no stream specified then in AV_TIME_BASE units
 * @param flags flags which select direction and seeking mode
 * @return >= 0 on success
 */
michael's avatar
michael committed
565
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
566 567 568 569 570

/**
 * start playing a network based stream (e.g. RTSP stream) at the
 * current position
 */
571
int av_read_play(AVFormatContext *s);
572 573 574 575 576 577

/**
 * Pause a network based stream (e.g. RTSP stream).
 *
 * Use av_read_play() to resume it.
 */
578
int av_read_pause(AVFormatContext *s);
579 580 581 582 583 584

/**
 * Close a media file (but not its codecs).
 *
 * @param s media file handle
 */
glantau's avatar
glantau committed
585
void av_close_input_file(AVFormatContext *s);
586 587 588 589 590 591 592 593 594 595 596

/**
 * Add a new stream to a media file.
 *
 * Can only be called in the read_header() function. If the flag
 * AVFMTCTX_NOHEADER is in the format context, then new streams
 * can be added in read_packet too.
 *
 * @param s media file handle
 * @param id file format dependent stream id
 */
597
AVStream *av_new_stream(AVFormatContext *s, int id);
598 599 600 601 602 603 604 605 606 607

/**
 * Set the pts for a given stream.
 *
 * @param s stream
 * @param pts_wrap_bits number of bits effectively used by the pts
 *        (used for wrap control, 33 is the value for MPEG)
 * @param pts_num numerator to convert to seconds (MPEG: 1)
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
 */
608
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
bellard's avatar
bellard committed
609
                     int pts_num, int pts_den);
glantau's avatar
glantau committed
610

michael's avatar
michael committed
611 612
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
613
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non keyframes
michael's avatar
michael committed
614

615
int av_find_default_stream_index(AVFormatContext *s);
616 617 618 619 620 621 622 623 624

/**
 * Gets the index for a specific timestamp.
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
 *                 the timestamp which is <= the requested one, if backward is 0
 *                 then it will be >=
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
 * @return < 0 if no such timestamp could be found
 */
625
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
626 627 628 629 630 631

/**
 * Add a index entry into a sorted list updateing if it is already there.
 *
 * @param timestamp timestamp in the timebase of the given stream
 */
632
int av_add_index_entry(AVStream *st,
michael's avatar
michael committed
633
                       int64_t pos, int64_t timestamp, int size, int distance, int flags);
634 635 636 637 638 639 640

/**
 * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
 * this isnt supposed to be called directly by a user application, but by demuxers
 * @param target_ts target timestamp in the time base of the given stream
 * @param stream_index stream number
 */
michael's avatar
michael committed
641
int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
642 643 644 645 646 647 648 649 650

/**
 * Updates cur_dts of all streams based on given timestamp and AVStream.
 *
 * Stream ref_st unchanged, others set cur_dts in their native timebase
 * only needed for timestamp wrapping or if (dts not set and pts!=dts)
 * @param timestamp new dts expressed in time_base of param ref_st
 * @param ref_st reference stream giving time_base of param timestamp
 */
651
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
652 653 654 655 656 657 658

/**
 * Does a binary search using read_timestamp().
 * this isnt supposed to be called directly by a user application, but by demuxers
 * @param target_ts target timestamp in the time base of the given stream
 * @param stream_index stream number
 */
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 666 667 668 669 670

/**
 * allocate the stream private data and write the stream header to an
 * output media file
 *
 * @param s media file handle
 * @return 0 if OK. AVERROR_xxx if error.
 */
671
int av_write_header(AVFormatContext *s);
672 673 674 675 676 677 678 679 680 681 682 683

/**
 * Write a packet to an output media file.
 *
 * The packet shall contain one audio or video frame.
 * The packet must be correctly interleaved according to the container specification,
 * if not then av_interleaved_write_frame must be used
 *
 * @param s media file handle
 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
 */
684
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699

/**
 * Writes a packet to an output media file ensuring correct interleaving.
 *
 * The packet must contain one audio or video frame.
 * If the packets are already correctly interleaved the application should
 * call av_write_frame() instead as its slightly faster, its also important
 * to keep in mind that completly non interleaved input will need huge amounts
 * of memory to interleave with this, so its prefereable to interleave at the
 * demuxer level
 *
 * @param s media file handle
 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
 */
700
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715

/**
 * Interleave a packet per DTS in an output media file.
 *
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this function,
 * so they cannot be used after it, note calling av_free_packet() on them is still safe.
 *
 * @param s media file handle
 * @param out the interleaved packet will be output here
 * @param in the input packet
 * @param flush 1 if no further packets are available as input and all
 *              remaining packets should be output
 * @return 1 if a packet was output, 0 if no packet could be output,
 *         < 0 if an error occured
 */
716
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
717

718 719 720 721 722 723 724
/**
 * @brief Write the stream trailer to an output media file and
 *        free the file private data.
 *
 * @param s media file handle
 * @return 0 if OK. AVERROR_xxx if error.
 */
725
int av_write_trailer(AVFormatContext *s);
glantau's avatar
glantau committed
726 727

void dump_format(AVFormatContext *ic,
728
                 int index,
glantau's avatar
glantau committed
729 730
                 const char *url,
                 int is_output);
731 732 733 734

/**
 * parses width and height out of string str.
 */
glantau's avatar
glantau committed
735
int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
736 737 738 739

/**
 * Converts frame rate from string to a fraction.
 */
romansh's avatar
 
romansh committed
740
int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756

/**
 * Converts date string to number of seconds since Jan 1st, 1970.
 *
 * @code
 * Syntax:
 * - If not a duration:
 *  [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
 * Time is localtime unless Z is suffixed to the end. In this case GMT
 * Return the date in micro seconds since 1970
 *
 * - If a duration:
 *  HH[:MM[:SS[.m...]]]
 *  S+[.m...]
 * @endcode
 */
kabi's avatar
kabi committed
757
int64_t parse_date(const char *datestr, int duration);
glantau's avatar
glantau committed
758

kabi's avatar
kabi committed
759
int64_t av_gettime(void);
bellard's avatar
bellard committed
760

glantau's avatar
glantau committed
761 762 763 764 765 766
/* ffm specific for ffserver */
#define FFM_PACKET_SIZE 4096
offset_t ffm_read_write_index(int fd);
void ffm_write_write_index(int fd, offset_t pos);
void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);

767 768 769 770 771 772
/**
 * Attempts to find a specific tag in a URL.
 *
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
 * Return 1 if found.
 */
glantau's avatar
glantau committed
773 774
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);

775 776 777 778 779 780 781 782 783 784 785 786
/**
 * Returns in 'buf' the path with '%d' replaced by number.

 * Also handles the '%0nd' format where 'n' is the total number
 * of digits and '%%'.
 *
 * @param buf destination buffer
 * @param buf_size destination buffer size
 * @param path numbered sequence string
 * @number frame number
 * @return 0 if OK, -1 if format error.
 */
787 788
int av_get_frame_filename(char *buf, int buf_size,
                          const char *path, int number);
789 790 791 792 793 794 795

/**
 * Check whether filename actually is a numbered sequence generator.
 *
 * @param filename possible numbered sequence string
 * @return 1 if a valid numbered sequence string, 0 otherwise.
 */
796
int av_filename_number_test(const char *filename);
797

798 799 800
/* grab specific */
int video_grab_init(void);
int audio_init(void);
801

bellard's avatar
bellard committed
802 803
/* DV1394 */
int dv1394_init(void);
romansh's avatar
 
romansh committed
804
int dc1394_init(void);
bellard's avatar
bellard committed
805 806

#ifdef HAVE_AV_CONFIG_H
807 808 809

#include "os_support.h"

bellard's avatar
bellard committed
810 811 812 813 814
int strstart(const char *str, const char *val, const char **ptr);
int stristart(const char *str, const char *val, const char **ptr);
void pstrcpy(char *buf, int buf_size, const char *str);
char *pstrcat(char *buf, int buf_size, const char *s);

bellard's avatar
bellard committed
815 816
void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);

mellum's avatar
mellum committed
817
#ifdef __GNUC__
bellard's avatar
bellard committed
818 819 820 821 822 823 824
#define dynarray_add(tab, nb_ptr, elem)\
do {\
    typeof(tab) _tab = (tab);\
    typeof(elem) _elem = (elem);\
    (void)sizeof(**_tab == _elem); /* check that types are compatible */\
    __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
} while(0)
mellum's avatar
mellum committed
825 826 827 828 829 830
#else
#define dynarray_add(tab, nb_ptr, elem)\
do {\
    __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
} while(0)
#endif
bellard's avatar
bellard committed
831

832
time_t mktimegm(struct tm *tm);
romansh's avatar
 
romansh committed
833
struct tm *brktimegm(time_t secs, struct tm *tm);
834
const char *small_strptime(const char *p, const char *fmt,
835 836
                           struct tm *dt);

bellard's avatar
bellard committed
837 838 839 840
struct in_addr;
int resolve_host(struct in_addr *sin_addr, const char *hostname);

void url_split(char *proto, int proto_size,
841
               char *authorization, int authorization_size,
bellard's avatar
bellard committed
842 843 844 845 846
               char *hostname, int hostname_size,
               int *port_ptr,
               char *path, int path_size,
               const char *url);

bellard's avatar
bellard committed
847 848
int match_ext(const char *filename, const char *extensions);

bellard's avatar
bellard committed
849 850
#endif /* HAVE_AV_CONFIG_H */

kabi's avatar
kabi committed
851 852 853 854
#ifdef __cplusplus
}
#endif

bellard's avatar
bellard committed
855
#endif /* AVFORMAT_H */
856