Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ a74008a4

History | View | Annotate | Download (30.5 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
/* the exact value of the fractional number is: 'val + num / den'. num
115
   is assumed to be such as 0 <= num < den */
116
typedef struct AVFrac {
117
    int64_t val, num, den;
118
} AVFrac attribute_deprecated;
119

    
120
/*************************************************/
121
/* input/output formats */
122

    
123
struct AVCodecTag;
124

    
125
struct AVFormatContext;
126

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

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

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

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

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

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

    
195
    /* private fields */
196
    struct AVOutputFormat *next;
197
} AVOutputFormat;
198

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

    
242
    /** start/resume playing - only meaningful if using a network based format
243
       (RTSP) */
244
    int (*read_play)(struct AVFormatContext *);
245

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

    
250
    const struct AVCodecTag **codec_tag;
251

    
252
    /* private fields */
253
    struct AVInputFormat *next;
254
} AVInputFormat;
255

    
256
typedef struct AVIndexEntry {
257
    int64_t pos;
258
    int64_t timestamp;
259
#define AVINDEX_KEYFRAME 0x0001
260
    int flags:2;
261
    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)
262
    int min_distance;         /**< min distance between this and the previous keyframe, used to avoid unneeded searching */
263
} AVIndexEntry;
264

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

    
287
    /**
288
     * this is the fundamental unit of time (in seconds) in terms
289
     * of which frame timestamps are represented. for fixed-fps content,
290
     * timebase should be 1/framerate and timestamp increments should be
291
     * identically 1.
292
     */
293
    AVRational time_base;
294
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
295
    /* ffmpeg.c private use */
296
    int stream_copy; /**< if set, just copy stream */
297
    enum AVDiscard discard; ///< selects which packets can be discarded at will and dont need to be demuxed
298
    //FIXME move stuff to a flags field?
299
    /** quality, as it has been removed from AVCodecContext and put in AVVideoFrame
300
     * MN:dunno if thats the right place, for it */
301
    float quality;
302
    /** decoding: position of the first frame of the component, in
303
       AV_TIME_BASE fractional seconds. */
304
    int64_t start_time;
305
    /** decoding: duration of the stream, in AV_TIME_BASE fractional
306
       seconds. */
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
#define AVSTREAM_PARSE_TIMESTAMPS 3    /**< full parsing and interpolation of timestamps for frames not starting on packet boundary */
313
    int need_parsing;                  ///< 1->full parsing needed, 2->only parse headers dont repack, 3->full parsing and interpolate timestamps
314
    struct AVCodecParserContext *parser;
315

    
316
    int64_t cur_dts;
317
    int last_IP_duration;
318
    int64_t last_IP_pts;
319
    /* av_seek_frame() support */
320
    AVIndexEntry *index_entries; /**< only used if the format does not
321
                                    support seeking natively */
322
    int nb_index_entries;
323
    unsigned int index_entries_allocated_size;
324

    
325
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
326

    
327
#define MAX_REORDER_DELAY 4
328
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
329
} AVStream;
330

    
331
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
332
                                         (streams are added dynamically) */
333

    
334
#define MAX_STREAMS 20
335

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

    
358
    int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
359
    /* private data for pts handling (do not modify directly) */
360
    /** This buffer is only needed when packets were already buffered but
361
       not decoded, for example to get the codec parameters in mpeg
362
       streams */
363
    struct AVPacketList *packet_buffer;
364

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

    
380
    /* av_read_frame() support */
381
    AVStream *cur_st;
382
    const uint8_t *cur_ptr;
383
    int cur_len;
384
    AVPacket cur_pkt;
385

    
386
    /* av_seek_frame() support */
387
    int64_t data_offset; /** offset of the first packet */
388
    int index_built;
389

    
390
    int mux_rate;
391
    int packet_size;
392
    int preload;
393
    int max_delay;
394

    
395
#define AVFMT_NOOUTPUTLOOP -1
396
#define AVFMT_INFINITEOUTPUTLOOP 0
397
    /** number of times to loop output in formats that support it */
398
    int loop_output;
399

    
400
    int flags;
401
#define AVFMT_FLAG_GENPTS       0x0001 ///< generate pts if missing even if it requires parsing future frames
402
#define AVFMT_FLAG_IGNIDX       0x0002 ///< ignore index
403

    
404
    int loop_input;
405
    /** decoding: size of data to probe; encoding unused */
406
    unsigned int probesize;
407

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

    
413
    const uint8_t *key;
414
    int keylen;
415
} AVFormatContext;
416

    
417
typedef struct AVPacketList {
418
    AVPacket pkt;
419
    struct AVPacketList *next;
420
} AVPacketList;
421

    
422
extern AVInputFormat *first_iformat;
423
extern AVOutputFormat *first_oformat;
424

    
425
enum CodecID av_guess_image2_codec(const char *filename);
426

    
427
/* XXX: use automatic init with either ELF sections or C file parser */
428
/* modules */
429

    
430
#include "rtp.h"
431

    
432
#include "rtsp.h"
433

    
434
/* utils.c */
435
void av_register_input_format(AVInputFormat *format);
436
void av_register_output_format(AVOutputFormat *format);
437
AVOutputFormat *guess_stream_format(const char *short_name,
438
                                    const char *filename, const char *mime_type);
439
AVOutputFormat *guess_format(const char *short_name,
440
                             const char *filename, const char *mime_type);
441

    
442
/**
443
 * Guesses the codec id based upon muxer and filename.
444
 */
445
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
446
                            const char *filename, const char *mime_type, enum CodecType type);
447

    
448
/**
449
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
450
 *
451
 * @param f The file stream pointer where the dump should be sent to.
452
 * @param buf buffer
453
 * @param size buffer size
454
 *
455
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
456
 */
457
void av_hex_dump(FILE *f, uint8_t *buf, int size);
458

    
459
/**
460
 * Send a nice hexadecimal dump of a buffer to the log.
461
 *
462
 * @param avcl A pointer to an arbitrary struct of which the first field is a
463
 * pointer to an AVClass struct.
464
 * @param level The importance level of the message, lower values signifying
465
 * higher importance.
466
 * @param buf buffer
467
 * @param size buffer size
468
 *
469
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
470
 */
471
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
472

    
473
/**
474
 * Send a nice dump of a packet to the specified file stream.
475
 *
476
 * @param f The file stream pointer where the dump should be sent to.
477
 * @param pkt packet to dump
478
 * @param dump_payload true if the payload must be displayed too
479
 */
480
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
481

    
482
/**
483
 * Send a nice dump of a packet to the log.
484
 *
485
 * @param avcl A pointer to an arbitrary struct of which the first field is a
486
 * pointer to an AVClass struct.
487
 * @param level The importance level of the message, lower values signifying
488
 * higher importance.
489
 * @param pkt packet to dump
490
 * @param dump_payload true if the payload must be displayed too
491
 */
492
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
493

    
494
void av_register_all(void);
495

    
496
/** codec tag <-> codec id */
497
enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
498
unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
499

    
500
/* media file input */
501

    
502
/**
503
 * finds AVInputFormat based on input format's short name.
504
 */
505
AVInputFormat *av_find_input_format(const char *short_name);
506

    
507
/**
508
 * Guess file format.
509
 *
510
 * @param is_opened whether the file is already opened, determines whether
511
 *                  demuxers with or without AVFMT_NOFILE are probed
512
 */
513
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
514

    
515
/**
516
 * Allocates all the structures needed to read an input stream.
517
 *        This does not open the needed codecs for decoding the stream[s].
518
 */
519
int av_open_input_stream(AVFormatContext **ic_ptr,
520
                         ByteIOContext *pb, const char *filename,
521
                         AVInputFormat *fmt, AVFormatParameters *ap);
522

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

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

    
555
/**
556
 * Read a transport packet from a media file.
557
 *
558
 * This function is absolete and should never be used.
559
 * Use av_read_frame() instead.
560
 *
561
 * @param s media file handle
562
 * @param pkt is filled
563
 * @return 0 if OK. AVERROR_xxx if error.
564
 */
565
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
566

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

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

    
601
/**
602
 * start playing a network based stream (e.g. RTSP stream) at the
603
 * current position
604
 */
605
int av_read_play(AVFormatContext *s);
606

    
607
/**
608
 * Pause a network based stream (e.g. RTSP stream).
609
 *
610
 * Use av_read_play() to resume it.
611
 */
612
int av_read_pause(AVFormatContext *s);
613

    
614
/**
615
 * Close a media file (but not its codecs).
616
 *
617
 * @param s media file handle
618
 */
619
void av_close_input_file(AVFormatContext *s);
620

    
621
/**
622
 * Add a new stream to a media file.
623
 *
624
 * Can only be called in the read_header() function. If the flag
625
 * AVFMTCTX_NOHEADER is in the format context, then new streams
626
 * can be added in read_packet too.
627
 *
628
 * @param s media file handle
629
 * @param id file format dependent stream id
630
 */
631
AVStream *av_new_stream(AVFormatContext *s, int id);
632

    
633
/**
634
 * Set the pts for a given stream.
635
 *
636
 * @param s stream
637
 * @param pts_wrap_bits number of bits effectively used by the pts
638
 *        (used for wrap control, 33 is the value for MPEG)
639
 * @param pts_num numerator to convert to seconds (MPEG: 1)
640
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
641
 */
642
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
643
                     int pts_num, int pts_den);
644

    
645
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
646
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
647
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non keyframes
648

    
649
int av_find_default_stream_index(AVFormatContext *s);
650

    
651
/**
652
 * Gets the index for a specific timestamp.
653
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
654
 *                 the timestamp which is <= the requested one, if backward is 0
655
 *                 then it will be >=
656
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
657
 * @return < 0 if no such timestamp could be found
658
 */
659
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
660

    
661
/**
662
 * Add a index entry into a sorted list updateing if it is already there.
663
 *
664
 * @param timestamp timestamp in the timebase of the given stream
665
 */
666
int av_add_index_entry(AVStream *st,
667
                       int64_t pos, int64_t timestamp, int size, int distance, int flags);
668

    
669
/**
670
 * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
671
 * this isnt supposed to be called directly by a user application, but by demuxers
672
 * @param target_ts target timestamp in the time base of the given stream
673
 * @param stream_index stream number
674
 */
675
int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
676

    
677
/**
678
 * Updates cur_dts of all streams based on given timestamp and AVStream.
679
 *
680
 * Stream ref_st unchanged, others set cur_dts in their native timebase
681
 * only needed for timestamp wrapping or if (dts not set and pts!=dts)
682
 * @param timestamp new dts expressed in time_base of param ref_st
683
 * @param ref_st reference stream giving time_base of param timestamp
684
 */
685
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
686

    
687
/**
688
 * Does a binary search using read_timestamp().
689
 * this isnt supposed to be called directly by a user application, but by demuxers
690
 * @param target_ts target timestamp in the time base of the given stream
691
 * @param stream_index stream number
692
 */
693
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 ));
694

    
695
/** media file output */
696
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
697

    
698
/**
699
 * allocate the stream private data and write the stream header to an
700
 * output media file
701
 *
702
 * @param s media file handle
703
 * @return 0 if OK. AVERROR_xxx if error.
704
 */
705
int av_write_header(AVFormatContext *s);
706

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

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

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

    
752
/**
753
 * @brief Write the stream trailer to an output media file and
754
 *        free the file private data.
755
 *
756
 * @param s media file handle
757
 * @return 0 if OK. AVERROR_xxx if error.
758
 */
759
int av_write_trailer(AVFormatContext *s);
760

    
761
void dump_format(AVFormatContext *ic,
762
                 int index,
763
                 const char *url,
764
                 int is_output);
765

    
766
/**
767
 * parses width and height out of string str.
768
 */
769
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
 */
774
int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
775

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

    
793
int64_t av_gettime(void);
794

    
795
/* ffm specific for ffserver */
796
#define FFM_PACKET_SIZE 4096
797
offset_t ffm_read_write_index(int fd);
798
void ffm_write_write_index(int fd, offset_t pos);
799
void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
800

    
801
/**
802
 * Attempts to find a specific tag in a URL.
803
 *
804
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
805
 * Return 1 if found.
806
 */
807
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
808

    
809
/**
810
 * Returns in 'buf' the path with '%d' replaced by number.
811

812
 * Also handles the '%0nd' format where 'n' is the total number
813
 * of digits and '%%'.
814
 *
815
 * @param buf destination buffer
816
 * @param buf_size destination buffer size
817
 * @param path numbered sequence string
818
 * @number frame number
819
 * @return 0 if OK, -1 if format error.
820
 */
821
int av_get_frame_filename(char *buf, int buf_size,
822
                          const char *path, int number);
823

    
824
/**
825
 * Check whether filename actually is a numbered sequence generator.
826
 *
827
 * @param filename possible numbered sequence string
828
 * @return 1 if a valid numbered sequence string, 0 otherwise.
829
 */
830
int av_filename_number_test(const char *filename);
831

    
832
/* grab specific */
833
int video_grab_init(void);
834
int audio_init(void);
835

    
836
/* DV1394 */
837
int dv1394_init(void);
838
int dc1394_init(void);
839

    
840
#ifdef HAVE_AV_CONFIG_H
841

    
842
#include "os_support.h"
843

    
844
int strstart(const char *str, const char *val, const char **ptr);
845
int stristart(const char *str, const char *val, const char **ptr);
846
void pstrcpy(char *buf, int buf_size, const char *str);
847
char *pstrcat(char *buf, int buf_size, const char *s);
848

    
849
void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
850

    
851
#ifdef __GNUC__
852
#define dynarray_add(tab, nb_ptr, elem)\
853
do {\
854
    typeof(tab) _tab = (tab);\
855
    typeof(elem) _elem = (elem);\
856
    (void)sizeof(**_tab == _elem); /* check that types are compatible */\
857
    __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
858
} while(0)
859
#else
860
#define dynarray_add(tab, nb_ptr, elem)\
861
do {\
862
    __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
863
} while(0)
864
#endif
865

    
866
time_t mktimegm(struct tm *tm);
867
struct tm *brktimegm(time_t secs, struct tm *tm);
868
const char *small_strptime(const char *p, const char *fmt,
869
                           struct tm *dt);
870

    
871
struct in_addr;
872
int resolve_host(struct in_addr *sin_addr, const char *hostname);
873

    
874
void url_split(char *proto, int proto_size,
875
               char *authorization, int authorization_size,
876
               char *hostname, int hostname_size,
877
               int *port_ptr,
878
               char *path, int path_size,
879
               const char *url);
880

    
881
int match_ext(const char *filename, const char *extensions);
882

    
883
#endif /* HAVE_AV_CONFIG_H */
884

    
885
#ifdef __cplusplus
886
}
887
#endif
888

    
889
#endif /* AVFORMAT_H */
890