Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 0a5790d1

History | View | Annotate | Download (31 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
#define LIBAVFORMAT_VERSION_INT ((51<<16)+(12<<8)+1)
25
#define LIBAVFORMAT_VERSION     51.12.1
26
#define LIBAVFORMAT_BUILD       LIBAVFORMAT_VERSION_INT
27

    
28
#define LIBAVFORMAT_IDENT       "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
29

    
30
#include <time.h>
31
#include <stdio.h>  /* FILE */
32
#include "avcodec.h"
33

    
34
#include "avio.h"
35

    
36
/* packet functions */
37

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

    
52
void av_destruct_packet_nofree(AVPacket *pkt);
53

    
54
/**
55
 * Default packet destructor.
56
 */
57
void av_destruct_packet(AVPacket *pkt);
58

    
59
/**
60
 * Initialize optional fields of a packet to default values.
61
 *
62
 * @param pkt packet
63
 */
64
void av_init_packet(AVPacket *pkt);
65

    
66
/**
67
 * Allocate the payload of a packet and initialize its fields to default values.
68
 *
69
 * @param pkt packet
70
 * @param size wanted payload size
71
 * @return 0 if OK. AVERROR_xxx otherwise.
72
 */
73
int av_new_packet(AVPacket *pkt, int size);
74

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

    
84
/**
85
 * @warning This is a hack - the packet memory allocation stuff is broken. The
86
 * packet is allocated if it was not really allocated
87
 */
88
int av_dup_packet(AVPacket *pkt);
89

    
90
/**
91
 * Free a packet
92
 *
93
 * @param pkt packet to free
94
 */
95
static inline void av_free_packet(AVPacket *pkt)
96
{
97
    if (pkt && pkt->destruct) {
98
        pkt->destruct(pkt);
99
    }
100
}
101

    
102
/*************************************************/
103
/* fractional numbers for exact pts handling */
104

    
105
/**
106
 * the exact value of the fractional number is: 'val + num / den'.
107
 * num is assumed to be such as 0 <= num < den
108
 * @deprecated Use AVRational instead
109
*/
110
typedef struct AVFrac {
111
    int64_t val, num, den;
112
} AVFrac attribute_deprecated;
113

    
114
/*************************************************/
115
/* input/output formats */
116

    
117
struct AVCodecTag;
118

    
119
struct AVFormatContext;
120

    
121
/** this structure contains the data a format has to probe a file */
122
typedef struct AVProbeData {
123
    const char *filename;
124
    unsigned char *buf;
125
    int buf_size;
126
} AVProbeData;
127

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

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

    
154
//! demuxer will use url_fopen, no opened file should be provided by the caller
155
#define AVFMT_NOFILE        0x0001
156
#define AVFMT_NEEDNUMBER    0x0002 /**< needs '%d' in filename */
157
#define AVFMT_SHOW_IDS      0x0008 /**< show format stream IDs numbers */
158
#define AVFMT_RAWPICTURE    0x0020 /**< format wants AVPicture structure for
159
                                      raw picture data */
160
#define AVFMT_GLOBALHEADER  0x0040 /**< format wants global header */
161
#define AVFMT_NOTIMESTAMPS  0x0080 /**< format does not need / have any timestamps */
162
#define AVFMT_GENERIC_INDEX 0x0100 /**< use generic index building code */
163

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

    
183
    /**
184
     * list of supported codec_id-codec_tag pairs, ordered by "better choice first"
185
     * the arrays are all CODEC_ID_NONE terminated
186
     */
187
    const struct AVCodecTag **codec_tag;
188

    
189
    enum CodecID subtitle_codec; /**< default subtitle codec */
190

    
191
    /* private fields */
192
    struct AVOutputFormat *next;
193
} AVOutputFormat;
194

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

    
239
    /** start/resume playing - only meaningful if using a network based format
240
       (RTSP) */
241
    int (*read_play)(struct AVFormatContext *);
242

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

    
247
    const struct AVCodecTag **codec_tag;
248

    
249
    /* private fields */
250
    struct AVInputFormat *next;
251
} AVInputFormat;
252

    
253
enum AVStreamParseType {
254
    AVSTREAM_PARSE_NONE,
255
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
256
    AVSTREAM_PARSE_HEADERS,    /**< only parse headers, don't repack */
257
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on packet boundary */
258
};
259

    
260
typedef struct AVIndexEntry {
261
    int64_t pos;
262
    int64_t timestamp;
263
#define AVINDEX_KEYFRAME 0x0001
264
    int flags:2;
265
    int size:30; //Yeah, trying to keep the size of this small to reduce memory requirements (it is 24 vs 32 byte due to possible 8byte align).
266
    int min_distance;         /**< min distance between this and the previous keyframe, used to avoid unneeded searching */
267
} AVIndexEntry;
268

    
269
typedef struct AVStream {
270
    int index;    /**< stream index in AVFormatContext */
271
    int id;       /**< format specific stream id */
272
    AVCodecContext *codec; /**< codec context */
273
    /**
274
     * real base frame rate of the stream.
275
     * this is the lowest framerate with which all timestamps can be
276
     * represented accurately (it is the least common multiple of all
277
     * framerates in the stream), Note, this value is just a guess!
278
     * for example if the timebase is 1/90000 and all frames have either
279
     * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1
280
     */
281
    AVRational r_frame_rate;
282
    void *priv_data;
283

    
284
    /* internal data used in av_find_stream_info() */
285
    int64_t first_dts;
286
#if LIBAVFORMAT_VERSION_INT < (52<<16)
287
    int codec_info_nb_frames;
288
#endif
289
    /** encoding: PTS generation when outputing stream */
290
    struct AVFrac pts;
291

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

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

    
314
    /* av_read_frame() support */
315
    enum AVStreamParseType need_parsing;
316
    struct AVCodecParserContext *parser;
317

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

    
327
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
328

    
329
#define MAX_REORDER_DELAY 4
330
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
331
} AVStream;
332

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

    
336
#define MAX_STREAMS 20
337

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

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

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

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

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

    
392
    int mux_rate;
393
    int packet_size;
394
    int preload;
395
    int max_delay;
396

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

    
402
    int flags;
403
#define AVFMT_FLAG_GENPTS       0x0001 ///< generate pts if missing even if it requires parsing future frames
404
#define AVFMT_FLAG_IGNIDX       0x0002 ///< ignore index
405
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< do not block when reading packets from input
406

    
407
    int loop_input;
408
    /** decoding: size of data to probe; encoding unused */
409
    unsigned int probesize;
410

    
411
    /**
412
     * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
413
     */
414
    int max_analyze_duration;
415

    
416
    const uint8_t *key;
417
    int keylen;
418
} AVFormatContext;
419

    
420
typedef struct AVPacketList {
421
    AVPacket pkt;
422
    struct AVPacketList *next;
423
} AVPacketList;
424

    
425
extern AVInputFormat *first_iformat;
426
extern AVOutputFormat *first_oformat;
427

    
428
enum CodecID av_guess_image2_codec(const char *filename);
429

    
430
/* XXX: use automatic init with either ELF sections or C file parser */
431
/* modules */
432

    
433
#include "rtp.h"
434

    
435
#include "rtsp.h"
436

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

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

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

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

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

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

    
497
void av_register_all(void);
498

    
499
/** codec tag <-> codec id */
500
enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
501
unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
502

    
503
/* media file input */
504

    
505
/**
506
 * finds AVInputFormat based on input format's short name.
507
 */
508
AVInputFormat *av_find_input_format(const char *short_name);
509

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

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

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

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

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

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

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

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

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

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

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

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

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

    
652
int av_find_default_stream_index(AVFormatContext *s);
653

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

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

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

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

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

    
698
/** media file output */
699
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
700

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

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

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

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

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

    
764
void dump_format(AVFormatContext *ic,
765
                 int index,
766
                 const char *url,
767
                 int is_output);
768

    
769
/**
770
 * parses width and height out of string str.
771
 * @deprecated Use av_parse_video_frame_size instead.
772
 */
773
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
774

    
775
/**
776
 * Converts frame rate from string to a fraction.
777
 * @deprecated Use av_parse_video_frame_rate instead.
778
 */
779
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
780

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

    
798
int64_t av_gettime(void);
799

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

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

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

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

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

    
837
/**
838
 * Generate an SDP for an RTP session.
839
 *
840
 * @param ac array of AVFormatContexts describing the RTP streams. If the
841
 *           array is composed by only one context, such context can contain
842
 *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
843
 *           all the contexts in the array (an AVCodecContext per RTP stream)
844
 *           must contain only one AVStream
845
 * @param n_files number of AVCodecContexts contained in ac
846
 * @param buff buffer where the SDP will be stored (must be allocated by
847
 *             the caller
848
 * @param size the size of the buffer
849
 * @return 0 if OK. AVERROR_xxx if error.
850
 */
851
int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
852

    
853
#ifdef HAVE_AV_CONFIG_H
854

    
855
#include "os_support.h"
856

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

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

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

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

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

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

    
891
#endif /* HAVE_AV_CONFIG_H */
892

    
893
#endif /* AVFORMAT_H */
894