Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ cb631737

History | View | Annotate | Download (30.6 KB)

1
/*
2
 * copyright (c) 2001 Fabrice Bellard
3
 *
4
 * This file is part of FFmpeg.
5
 *
6
 * FFmpeg is free software; you can redistribute it and/or
7
 * modify it under the terms of the GNU Lesser General Public
8
 * License as published by the Free Software Foundation; either
9
 * version 2.1 of the License, or (at your option) any later version.
10
 *
11
 * FFmpeg is distributed in the hope that it will be useful,
12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
 * Lesser General Public License for more details.
15
 *
16
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with FFmpeg; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
 */
20

    
21
#ifndef AVFORMAT_H
22
#define AVFORMAT_H
23

    
24
#ifdef __cplusplus
25
extern "C" {
26
#endif
27

    
28
#define LIBAVFORMAT_VERSION_INT ((51<<16)+(12<<8)+1)
29
#define LIBAVFORMAT_VERSION     51.12.1
30
#define LIBAVFORMAT_BUILD       LIBAVFORMAT_VERSION_INT
31

    
32
#define LIBAVFORMAT_IDENT       "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
33

    
34
#include <time.h>
35
#include <stdio.h>  /* FILE */
36
#include "avcodec.h"
37

    
38
#include "avio.h"
39

    
40
/* packet functions */
41

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

    
56
void av_destruct_packet_nofree(AVPacket *pkt);
57

    
58
/**
59
 * Default packet destructor.
60
 */
61
void av_destruct_packet(AVPacket *pkt);
62

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

    
75
/**
76
 * Allocate the payload of a packet and intialized its fields to default values.
77
 *
78
 * @param pkt packet
79
 * @param size wanted payload size
80
 * @return 0 if OK. AVERROR_xxx otherwise.
81
 */
82
int av_new_packet(AVPacket *pkt, int size);
83

    
84
/**
85
 * Allocate and read the payload of a packet and intialized its fields to default values.
86
 *
87
 * @param pkt packet
88
 * @param size wanted payload size
89
 * @return >0 (read size) if OK. AVERROR_xxx otherwise.
90
 */
91
int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
92

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

    
99
/**
100
 * Free a packet
101
 *
102
 * @param pkt packet to free
103
 */
104
static inline void av_free_packet(AVPacket *pkt)
105
{
106
    if (pkt && pkt->destruct) {
107
        pkt->destruct(pkt);
108
    }
109
}
110

    
111
/*************************************************/
112
/* fractional numbers for exact pts handling */
113

    
114
/**
115
 * the exact value of the fractional number is: 'val + num / den'.
116
 * num is assumed to be such as 0 <= num < den
117
 * @deprecated Use AVRational instead
118
*/
119
typedef struct AVFrac {
120
    int64_t val, num, den;
121
} AVFrac attribute_deprecated;
122

    
123
/*************************************************/
124
/* input/output formats */
125

    
126
struct AVCodecTag;
127

    
128
struct AVFormatContext;
129

    
130
/** this structure contains the data a format has to probe a file */
131
typedef struct AVProbeData {
132
    const char *filename;
133
    unsigned char *buf;
134
    int buf_size;
135
} AVProbeData;
136

    
137
#define AVPROBE_SCORE_MAX 100               ///< max score, half of that is used for file extension based detection
138
#define AVPROBE_PADDING_SIZE 32             ///< extra allocated bytes at the end of the probe buffer
139

    
140
typedef struct AVFormatParameters {
141
    AVRational time_base;
142
    int sample_rate;
143
    int channels;
144
    int width;
145
    int height;
146
    enum PixelFormat pix_fmt;
147
    int channel; /**< used to select dv channel */
148
#if LIBAVFORMAT_VERSION_INT < (52<<16)
149
    const char *device; /**< video, audio or DV device */
150
#endif
151
    const char *standard; /**< tv standard, NTSC, PAL, SECAM */
152
    int mpeg2ts_raw:1;  /**< force raw MPEG2 transport stream output, if possible */
153
    int mpeg2ts_compute_pcr:1; /**< compute exact PCR for each transport
154
                                  stream packet (only meaningful if
155
                                  mpeg2ts_raw is TRUE */
156
    int initial_pause:1;       /**< do not begin to play the stream
157
                                  immediately (RTSP only) */
158
    int prealloced_context:1;
159
    enum CodecID video_codec_id;
160
    enum CodecID audio_codec_id;
161
} AVFormatParameters;
162

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

    
173
typedef struct AVOutputFormat {
174
    const char *name;
175
    const char *long_name;
176
    const char *mime_type;
177
    const char *extensions; /**< comma separated filename extensions */
178
    /** size of private data so that it can be allocated in the wrapper */
179
    int priv_data_size;
180
    /* output support */
181
    enum CodecID audio_codec; /**< default audio codec */
182
    enum CodecID video_codec; /**< default video codec */
183
    int (*write_header)(struct AVFormatContext *);
184
    int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
185
    int (*write_trailer)(struct AVFormatContext *);
186
    /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
187
    int flags;
188
    /** currently only used to set pixel format if not YUV420P */
189
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
190
    int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
191

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

    
198
    /* private fields */
199
    struct AVOutputFormat *next;
200
} AVOutputFormat;
201

    
202
typedef struct AVInputFormat {
203
    const char *name;
204
    const char *long_name;
205
    /** size of private data so that it can be allocated in the wrapper */
206
    int priv_data_size;
207
    /** tell if a given file has a chance of being parsing by this format */
208
    int (*read_probe)(AVProbeData *);
209
    /** read the format header and initialize the AVFormatContext
210
       structure. Return 0 if OK. 'ap' if non NULL contains
211
       additional paramters. Only used in raw format right
212
       now. 'av_new_stream' should be called to create new streams.  */
213
    int (*read_header)(struct AVFormatContext *,
214
                       AVFormatParameters *ap);
215
    /** read one packet and put it in 'pkt'. pts and flags are also
216
       set. 'av_new_stream' can be called only if the flag
217
       AVFMTCTX_NOHEADER is used. */
218
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
219
    /** close the stream. The AVFormatContext and AVStreams are not
220
       freed by this function */
221
    int (*read_close)(struct AVFormatContext *);
222
    /**
223
     * seek to a given timestamp relative to the frames in
224
     * stream component stream_index
225
     * @param stream_index must not be -1
226
     * @param flags selects which direction should be preferred if no exact
227
     *              match is available
228
     */
229
    int (*read_seek)(struct AVFormatContext *,
230
                     int stream_index, int64_t timestamp, int flags);
231
    /**
232
     * gets the next timestamp in AV_TIME_BASE units.
233
     */
234
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
235
                              int64_t *pos, int64_t pos_limit);
236
    /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
237
    int flags;
238
    /** if extensions are defined, then no probe is done. You should
239
       usually not use extension format guessing because it is not
240
       reliable enough */
241
    const char *extensions;
242
    /** general purpose read only value that the format can use */
243
    int value;
244

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

    
249
    /** pause playing - only meaningful if using a network based format
250
       (RTSP) */
251
    int (*read_pause)(struct AVFormatContext *);
252

    
253
    const struct AVCodecTag **codec_tag;
254

    
255
    /* private fields */
256
    struct AVInputFormat *next;
257
} AVInputFormat;
258

    
259
enum AVStreamParseType {
260
    AVSTREAM_PARSE_NONE,
261
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
262
    AVSTREAM_PARSE_HEADERS,    /**< only parse headers, don't repack */
263
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on packet boundary */
264
};
265

    
266
typedef struct AVIndexEntry {
267
    int64_t pos;
268
    int64_t timestamp;
269
#define AVINDEX_KEYFRAME 0x0001
270
    int flags:2;
271
    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)
272
    int min_distance;         /**< min distance between this and the previous keyframe, used to avoid unneeded searching */
273
} AVIndexEntry;
274

    
275
typedef struct AVStream {
276
    int index;    /**< stream index in AVFormatContext */
277
    int id;       /**< format specific stream id */
278
    AVCodecContext *codec; /**< codec context */
279
    /**
280
     * real base frame rate of the stream.
281
     * this is the lowest framerate with which all timestamps can be
282
     * represented accurately (its the least common multiple of all
283
     * framerates in the stream), Note, this value is just a guess!
284
     * for example if the timebase is 1/90000 and all frames have either
285
     * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1
286
     */
287
    AVRational r_frame_rate;
288
    void *priv_data;
289
#if LIBAVFORMAT_VERSION_INT < (52<<16)
290
    /* internal data used in av_find_stream_info() */
291
    int64_t codec_info_duration;
292
    int codec_info_nb_frames;
293
#endif
294
    /** encoding: PTS generation when outputing stream */
295
    AVFrac pts;
296

    
297
    /**
298
     * this is the fundamental unit of time (in seconds) in terms
299
     * of which frame timestamps are represented. for fixed-fps content,
300
     * timebase should be 1/framerate and timestamp increments should be
301
     * identically 1.
302
     */
303
    AVRational time_base;
304
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
305
    /* ffmpeg.c private use */
306
    int stream_copy; /**< if set, just copy stream */
307
    enum AVDiscard discard; ///< selects which packets can be discarded at will and dont need to be demuxed
308
    //FIXME move stuff to a flags field?
309
    /** quality, as it has been removed from AVCodecContext and put in AVVideoFrame
310
     * MN:dunno if thats the right place, for it */
311
    float quality;
312
    /** decoding: pts of the first frame of the stream, in stream time base. */
313
    int64_t start_time;
314
    /** decoding: duration of the stream, in stream time base. */
315
    int64_t duration;
316

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

    
319
    /* av_read_frame() support */
320
    enum AVStreamParseType need_parsing;
321
    struct AVCodecParserContext *parser;
322

    
323
    int64_t cur_dts;
324
    int last_IP_duration;
325
    int64_t last_IP_pts;
326
    /* av_seek_frame() support */
327
    AVIndexEntry *index_entries; /**< only used if the format does not
328
                                    support seeking natively */
329
    int nb_index_entries;
330
    unsigned int index_entries_allocated_size;
331

    
332
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
333

    
334
#define MAX_REORDER_DELAY 4
335
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
336
} AVStream;
337

    
338
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
339
                                         (streams are added dynamically) */
340

    
341
#define MAX_STREAMS 20
342

    
343
/* format I/O context */
344
typedef struct AVFormatContext {
345
    const AVClass *av_class; /**< set by av_alloc_format_context */
346
    /* can only be iformat or oformat, not both at the same time */
347
    struct AVInputFormat *iformat;
348
    struct AVOutputFormat *oformat;
349
    void *priv_data;
350
    ByteIOContext pb;
351
    unsigned int nb_streams;
352
    AVStream *streams[MAX_STREAMS];
353
    char filename[1024]; /**< input or output filename */
354
    /* stream info */
355
    int64_t timestamp;
356
    char title[512];
357
    char author[512];
358
    char copyright[512];
359
    char comment[512];
360
    char album[512];
361
    int year;  /**< ID3 year, 0 if none */
362
    int track; /**< track number, 0 if none */
363
    char genre[32]; /**< ID3 genre */
364

    
365
    int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
366
    /* private data for pts handling (do not modify directly) */
367
    /** This buffer is only needed when packets were already buffered but
368
       not decoded, for example to get the codec parameters in mpeg
369
       streams */
370
    struct AVPacketList *packet_buffer;
371

    
372
    /** decoding: position of the first frame of the component, in
373
       AV_TIME_BASE fractional seconds. NEVER set this value directly:
374
       it is deduced from the AVStream values.  */
375
    int64_t start_time;
376
    /** decoding: duration of the stream, in AV_TIME_BASE fractional
377
       seconds. NEVER set this value directly: it is deduced from the
378
       AVStream values.  */
379
    int64_t duration;
380
    /** decoding: total file size. 0 if unknown */
381
    int64_t file_size;
382
    /** decoding: total stream bitrate in bit/s, 0 if not
383
       available. Never set it directly if the file_size and the
384
       duration are known as ffmpeg can compute it automatically. */
385
    int bit_rate;
386

    
387
    /* av_read_frame() support */
388
    AVStream *cur_st;
389
    const uint8_t *cur_ptr;
390
    int cur_len;
391
    AVPacket cur_pkt;
392

    
393
    /* av_seek_frame() support */
394
    int64_t data_offset; /** offset of the first packet */
395
    int index_built;
396

    
397
    int mux_rate;
398
    int packet_size;
399
    int preload;
400
    int max_delay;
401

    
402
#define AVFMT_NOOUTPUTLOOP -1
403
#define AVFMT_INFINITEOUTPUTLOOP 0
404
    /** number of times to loop output in formats that support it */
405
    int loop_output;
406

    
407
    int flags;
408
#define AVFMT_FLAG_GENPTS       0x0001 ///< generate pts if missing even if it requires parsing future frames
409
#define AVFMT_FLAG_IGNIDX       0x0002 ///< ignore index
410

    
411
    int loop_input;
412
    /** decoding: size of data to probe; encoding unused */
413
    unsigned int probesize;
414

    
415
    /**
416
     * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
417
     */
418
    int max_analyze_duration;
419

    
420
    const uint8_t *key;
421
    int keylen;
422
} AVFormatContext;
423

    
424
typedef struct AVPacketList {
425
    AVPacket pkt;
426
    struct AVPacketList *next;
427
} AVPacketList;
428

    
429
extern AVInputFormat *first_iformat;
430
extern AVOutputFormat *first_oformat;
431

    
432
enum CodecID av_guess_image2_codec(const char *filename);
433

    
434
/* XXX: use automatic init with either ELF sections or C file parser */
435
/* modules */
436

    
437
#include "rtp.h"
438

    
439
#include "rtsp.h"
440

    
441
/* utils.c */
442
void av_register_input_format(AVInputFormat *format);
443
void av_register_output_format(AVOutputFormat *format);
444
AVOutputFormat *guess_stream_format(const char *short_name,
445
                                    const char *filename, const char *mime_type);
446
AVOutputFormat *guess_format(const char *short_name,
447
                             const char *filename, const char *mime_type);
448

    
449
/**
450
 * Guesses the codec id based upon muxer and filename.
451
 */
452
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
453
                            const char *filename, const char *mime_type, enum CodecType type);
454

    
455
/**
456
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
457
 *
458
 * @param f The file stream pointer where the dump should be sent to.
459
 * @param buf buffer
460
 * @param size buffer size
461
 *
462
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
463
 */
464
void av_hex_dump(FILE *f, uint8_t *buf, int size);
465

    
466
/**
467
 * Send a nice hexadecimal dump of a buffer to the log.
468
 *
469
 * @param avcl A pointer to an arbitrary struct of which the first field is a
470
 * pointer to an AVClass struct.
471
 * @param level The importance level of the message, lower values signifying
472
 * higher importance.
473
 * @param buf buffer
474
 * @param size buffer size
475
 *
476
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
477
 */
478
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
479

    
480
/**
481
 * Send a nice dump of a packet to the specified file stream.
482
 *
483
 * @param f The file stream pointer where the dump should be sent to.
484
 * @param pkt packet to dump
485
 * @param dump_payload true if the payload must be displayed too
486
 */
487
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
488

    
489
/**
490
 * Send a nice dump of a packet to the log.
491
 *
492
 * @param avcl A pointer to an arbitrary struct of which the first field is a
493
 * pointer to an AVClass struct.
494
 * @param level The importance level of the message, lower values signifying
495
 * higher importance.
496
 * @param pkt packet to dump
497
 * @param dump_payload true if the payload must be displayed too
498
 */
499
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
500

    
501
void av_register_all(void);
502

    
503
/** codec tag <-> codec id */
504
enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
505
unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
506

    
507
/* media file input */
508

    
509
/**
510
 * finds AVInputFormat based on input format's short name.
511
 */
512
AVInputFormat *av_find_input_format(const char *short_name);
513

    
514
/**
515
 * Guess file format.
516
 *
517
 * @param is_opened whether the file is already opened, determines whether
518
 *                  demuxers with or without AVFMT_NOFILE are probed
519
 */
520
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
521

    
522
/**
523
 * Allocates all the structures needed to read an input stream.
524
 *        This does not open the needed codecs for decoding the stream[s].
525
 */
526
int av_open_input_stream(AVFormatContext **ic_ptr,
527
                         ByteIOContext *pb, const char *filename,
528
                         AVInputFormat *fmt, AVFormatParameters *ap);
529

    
530
/**
531
 * Open a media file as input. The codec are not opened. Only the file
532
 * header (if present) is read.
533
 *
534
 * @param ic_ptr the opened media file handle is put here
535
 * @param filename filename to open.
536
 * @param fmt if non NULL, force the file format to use
537
 * @param buf_size optional buffer size (zero if default is OK)
538
 * @param ap additional parameters needed when opening the file (NULL if default)
539
 * @return 0 if OK. AVERROR_xxx otherwise.
540
 */
541
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
542
                       AVInputFormat *fmt,
543
                       int buf_size,
544
                       AVFormatParameters *ap);
545
/** no av_open for output, so applications will need this: */
546
AVFormatContext *av_alloc_format_context(void);
547

    
548
/**
549
 * Read packets of a media file to get stream information. This
550
 * is useful for file formats with no headers such as MPEG. This
551
 * function also computes the real frame rate in case of mpeg2 repeat
552
 * frame mode.
553
 * The logical file position is not changed by this function;
554
 * examined packets may be buffered for later processing.
555
 *
556
 * @param ic media file handle
557
 * @return >=0 if OK. AVERROR_xxx if error.
558
 * @todo let user decide somehow what information is needed so we dont waste time geting stuff the user doesnt need
559
 */
560
int av_find_stream_info(AVFormatContext *ic);
561

    
562
/**
563
 * Read a transport packet from a media file.
564
 *
565
 * This function is absolete and should never be used.
566
 * Use av_read_frame() instead.
567
 *
568
 * @param s media file handle
569
 * @param pkt is filled
570
 * @return 0 if OK. AVERROR_xxx if error.
571
 */
572
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
573

    
574
/**
575
 * Return the next frame of a stream.
576
 *
577
 * The returned packet is valid
578
 * until the next av_read_frame() or until av_close_input_file() and
579
 * must be freed with av_free_packet. For video, the packet contains
580
 * exactly one frame. For audio, it contains an integer number of
581
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
582
 * data). If the audio frames have a variable size (e.g. MPEG audio),
583
 * then it contains one frame.
584
 *
585
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
586
 * values in AVStream.timebase units (and guessed if the format cannot
587
 * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
588
 * has B frames, so it is better to rely on pkt->dts if you do not
589
 * decompress the payload.
590
 *
591
 * @return 0 if OK, < 0 if error or end of file.
592
 */
593
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
594

    
595
/**
596
 * Seek to the key frame at timestamp.
597
 * 'timestamp' in 'stream_index'.
598
 * @param stream_index If stream_index is (-1), a default
599
 * stream is selected, and timestamp is automatically converted
600
 * from AV_TIME_BASE units to the stream specific time_base.
601
 * @param timestamp timestamp in AVStream.time_base units
602
 *        or if there is no stream specified then in AV_TIME_BASE units
603
 * @param flags flags which select direction and seeking mode
604
 * @return >= 0 on success
605
 */
606
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
607

    
608
/**
609
 * start playing a network based stream (e.g. RTSP stream) at the
610
 * current position
611
 */
612
int av_read_play(AVFormatContext *s);
613

    
614
/**
615
 * Pause a network based stream (e.g. RTSP stream).
616
 *
617
 * Use av_read_play() to resume it.
618
 */
619
int av_read_pause(AVFormatContext *s);
620

    
621
/**
622
 * Close a media file (but not its codecs).
623
 *
624
 * @param s media file handle
625
 */
626
void av_close_input_file(AVFormatContext *s);
627

    
628
/**
629
 * Add a new stream to a media file.
630
 *
631
 * Can only be called in the read_header() function. If the flag
632
 * AVFMTCTX_NOHEADER is in the format context, then new streams
633
 * can be added in read_packet too.
634
 *
635
 * @param s media file handle
636
 * @param id file format dependent stream id
637
 */
638
AVStream *av_new_stream(AVFormatContext *s, int id);
639

    
640
/**
641
 * Set the pts for a given stream.
642
 *
643
 * @param s stream
644
 * @param pts_wrap_bits number of bits effectively used by the pts
645
 *        (used for wrap control, 33 is the value for MPEG)
646
 * @param pts_num numerator to convert to seconds (MPEG: 1)
647
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
648
 */
649
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
650
                     int pts_num, int pts_den);
651

    
652
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
653
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
654
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non keyframes
655

    
656
int av_find_default_stream_index(AVFormatContext *s);
657

    
658
/**
659
 * Gets the index for a specific timestamp.
660
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
661
 *                 the timestamp which is <= the requested one, if backward is 0
662
 *                 then it will be >=
663
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
664
 * @return < 0 if no such timestamp could be found
665
 */
666
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
667

    
668
/**
669
 * Add a index entry into a sorted list updateing if it is already there.
670
 *
671
 * @param timestamp timestamp in the timebase of the given stream
672
 */
673
int av_add_index_entry(AVStream *st,
674
                       int64_t pos, int64_t timestamp, int size, int distance, int flags);
675

    
676
/**
677
 * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
678
 * this isnt supposed to be called directly by a user application, but by demuxers
679
 * @param target_ts target timestamp in the time base of the given stream
680
 * @param stream_index stream number
681
 */
682
int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
683

    
684
/**
685
 * Updates cur_dts of all streams based on given timestamp and AVStream.
686
 *
687
 * Stream ref_st unchanged, others set cur_dts in their native timebase
688
 * only needed for timestamp wrapping or if (dts not set and pts!=dts)
689
 * @param timestamp new dts expressed in time_base of param ref_st
690
 * @param ref_st reference stream giving time_base of param timestamp
691
 */
692
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
693

    
694
/**
695
 * Does a binary search using read_timestamp().
696
 * this isnt supposed to be called directly by a user application, but by demuxers
697
 * @param target_ts target timestamp in the time base of the given stream
698
 * @param stream_index stream number
699
 */
700
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 ));
701

    
702
/** media file output */
703
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
704

    
705
/**
706
 * allocate the stream private data and write the stream header to an
707
 * output media file
708
 *
709
 * @param s media file handle
710
 * @return 0 if OK. AVERROR_xxx if error.
711
 */
712
int av_write_header(AVFormatContext *s);
713

    
714
/**
715
 * Write a packet to an output media file.
716
 *
717
 * The packet shall contain one audio or video frame.
718
 * The packet must be correctly interleaved according to the container specification,
719
 * if not then av_interleaved_write_frame must be used
720
 *
721
 * @param s media file handle
722
 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
723
 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
724
 */
725
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
726

    
727
/**
728
 * Writes a packet to an output media file ensuring correct interleaving.
729
 *
730
 * The packet must contain one audio or video frame.
731
 * If the packets are already correctly interleaved the application should
732
 * call av_write_frame() instead as its slightly faster, its also important
733
 * to keep in mind that completly non interleaved input will need huge amounts
734
 * of memory to interleave with this, so its prefereable to interleave at the
735
 * demuxer level
736
 *
737
 * @param s media file handle
738
 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
739
 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
740
 */
741
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
742

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

    
759
/**
760
 * @brief Write the stream trailer to an output media file and
761
 *        free the file private data.
762
 *
763
 * @param s media file handle
764
 * @return 0 if OK. AVERROR_xxx if error.
765
 */
766
int av_write_trailer(AVFormatContext *s);
767

    
768
void dump_format(AVFormatContext *ic,
769
                 int index,
770
                 const char *url,
771
                 int is_output);
772

    
773
/**
774
 * parses width and height out of string str.
775
 */
776
int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
777

    
778
/**
779
 * Converts frame rate from string to a fraction.
780
 */
781
int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
782

    
783
/**
784
 * Converts date string to number of seconds since Jan 1st, 1970.
785
 *
786
 * @code
787
 * Syntax:
788
 * - If not a duration:
789
 *  [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
790
 * Time is localtime unless Z is suffixed to the end. In this case GMT
791
 * Return the date in micro seconds since 1970
792
 *
793
 * - If a duration:
794
 *  HH[:MM[:SS[.m...]]]
795
 *  S+[.m...]
796
 * @endcode
797
 */
798
int64_t parse_date(const char *datestr, int duration);
799

    
800
int64_t av_gettime(void);
801

    
802
/* ffm specific for ffserver */
803
#define FFM_PACKET_SIZE 4096
804
offset_t ffm_read_write_index(int fd);
805
void ffm_write_write_index(int fd, offset_t pos);
806
void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
807

    
808
/**
809
 * Attempts to find a specific tag in a URL.
810
 *
811
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
812
 * Return 1 if found.
813
 */
814
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
815

    
816
/**
817
 * Returns in 'buf' the path with '%d' replaced by number.
818

819
 * Also handles the '%0nd' format where 'n' is the total number
820
 * of digits and '%%'.
821
 *
822
 * @param buf destination buffer
823
 * @param buf_size destination buffer size
824
 * @param path numbered sequence string
825
 * @number frame number
826
 * @return 0 if OK, -1 if format error.
827
 */
828
int av_get_frame_filename(char *buf, int buf_size,
829
                          const char *path, int number);
830

    
831
/**
832
 * Check whether filename actually is a numbered sequence generator.
833
 *
834
 * @param filename possible numbered sequence string
835
 * @return 1 if a valid numbered sequence string, 0 otherwise.
836
 */
837
int av_filename_number_test(const char *filename);
838

    
839
/* grab specific */
840
int video_grab_init(void);
841
int audio_init(void);
842

    
843
/* DV1394 */
844
int dv1394_init(void);
845
int dc1394_init(void);
846

    
847
#ifdef HAVE_AV_CONFIG_H
848

    
849
#include "os_support.h"
850

    
851
int strstart(const char *str, const char *val, const char **ptr);
852
int stristart(const char *str, const char *val, const char **ptr);
853
void pstrcpy(char *buf, int buf_size, const char *str);
854
char *pstrcat(char *buf, int buf_size, const char *s);
855

    
856
void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
857

    
858
#ifdef __GNUC__
859
#define dynarray_add(tab, nb_ptr, elem)\
860
do {\
861
    typeof(tab) _tab = (tab);\
862
    typeof(elem) _elem = (elem);\
863
    (void)sizeof(**_tab == _elem); /* check that types are compatible */\
864
    __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
865
} while(0)
866
#else
867
#define dynarray_add(tab, nb_ptr, elem)\
868
do {\
869
    __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
870
} while(0)
871
#endif
872

    
873
time_t mktimegm(struct tm *tm);
874
struct tm *brktimegm(time_t secs, struct tm *tm);
875
const char *small_strptime(const char *p, const char *fmt,
876
                           struct tm *dt);
877

    
878
struct in_addr;
879
int resolve_host(struct in_addr *sin_addr, const char *hostname);
880

    
881
void url_split(char *proto, int proto_size,
882
               char *authorization, int authorization_size,
883
               char *hostname, int hostname_size,
884
               int *port_ptr,
885
               char *path, int path_size,
886
               const char *url);
887

    
888
int match_ext(const char *filename, const char *extensions);
889

    
890
#endif /* HAVE_AV_CONFIG_H */
891

    
892
#ifdef __cplusplus
893
}
894
#endif
895

    
896
#endif /* AVFORMAT_H */
897