Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 15afa396

History | View | Annotate | Download (32.7 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)+(14<<8)+0)
25
#define LIBAVFORMAT_VERSION     51.14.0
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
    /**
201
     * tell if a given file has a chance of being parsed by this format.
202
     * The buffer provided is guranteed to be AVPROBE_PADDING_SIZE bytes big
203
     * so you dont have to check for that unless you need more.
204
     */
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
     * @return >= 0 on success (but not necessarily the new offset)
226
     */
227
    int (*read_seek)(struct AVFormatContext *,
228
                     int stream_index, int64_t timestamp, int flags);
229
    /**
230
     * gets the next timestamp in AV_TIME_BASE units.
231
     */
232
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
233
                              int64_t *pos, int64_t pos_limit);
234
    /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
235
    int flags;
236
    /** if extensions are defined, then no probe is done. You should
237
       usually not use extension format guessing because it is not
238
       reliable enough */
239
    const char *extensions;
240
    /** general purpose read only value that the format can use */
241
    int value;
242

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

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

    
251
    const struct AVCodecTag **codec_tag;
252

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

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

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

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

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

    
296
    /**
297
     * this is the fundamental unit of time (in seconds) in terms
298
     * of which frame timestamps are represented. for fixed-fps content,
299
     * timebase should be 1/framerate and timestamp increments should be
300
     * identically 1.
301
     */
302
    AVRational time_base;
303
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
304
    /* ffmpeg.c private use */
305
    int stream_copy; /**< if set, just copy stream */
306
    enum AVDiscard discard; ///< selects which packets can be discarded at will and do not need to be demuxed
307
    //FIXME move stuff to a flags field?
308
    /** quality, as it has been removed from AVCodecContext and put in AVVideoFrame
309
     * MN: dunno if that is the right place for it */
310
    float quality;
311
    /**
312
     * decoding: pts of the first frame of the stream, in stream time base.
313
     * only set this if you are absolutely 100% sure that the value you set
314
     * it to really is the pts of the first frame
315
     * This may be undefined (AV_NOPTS_VALUE).
316
     * @note the ASF header does NOT contain a correct start_time the ASF
317
     * demuxer must NOT set this
318
     */
319
    int64_t start_time;
320
    /**
321
     * decoding: duration of the stream, in stream time base.
322
     * If a source file does not specify a duration, but does specify
323
     * a bitrate, this value will be estimates from bit rate and file size.
324
     */
325
    int64_t duration;
326

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

    
329
    /* av_read_frame() support */
330
    enum AVStreamParseType need_parsing;
331
    struct AVCodecParserContext *parser;
332

    
333
    int64_t cur_dts;
334
    int last_IP_duration;
335
    int64_t last_IP_pts;
336
    /* av_seek_frame() support */
337
    AVIndexEntry *index_entries; /**< only used if the format does not
338
                                    support seeking natively */
339
    int nb_index_entries;
340
    unsigned int index_entries_allocated_size;
341

    
342
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
343

    
344
#define MAX_REORDER_DELAY 4
345
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
346
} AVStream;
347

    
348
#define AV_PROGRAM_RUNNING 1
349

    
350
typedef struct AVProgram {
351
    int            id;
352
    char           *provider_name; ///< Network name for DVB streams
353
    char           *name;          ///< Service name for DVB streams
354
    int            flags;
355
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
356
} AVProgram;
357

    
358
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
359
                                         (streams are added dynamically) */
360

    
361
#define MAX_STREAMS 20
362

    
363
/* format I/O context */
364
typedef struct AVFormatContext {
365
    const AVClass *av_class; /**< set by av_alloc_format_context */
366
    /* can only be iformat or oformat, not both at the same time */
367
    struct AVInputFormat *iformat;
368
    struct AVOutputFormat *oformat;
369
    void *priv_data;
370
    ByteIOContext pb;
371
    unsigned int nb_streams;
372
    AVStream *streams[MAX_STREAMS];
373
    char filename[1024]; /**< input or output filename */
374
    /* stream info */
375
    int64_t timestamp;
376
    char title[512];
377
    char author[512];
378
    char copyright[512];
379
    char comment[512];
380
    char album[512];
381
    int year;  /**< ID3 year, 0 if none */
382
    int track; /**< track number, 0 if none */
383
    char genre[32]; /**< ID3 genre */
384

    
385
    int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
386
    /* private data for pts handling (do not modify directly) */
387
    /** This buffer is only needed when packets were already buffered but
388
       not decoded, for example to get the codec parameters in mpeg
389
       streams */
390
    struct AVPacketList *packet_buffer;
391

    
392
    /** decoding: position of the first frame of the component, in
393
       AV_TIME_BASE fractional seconds. NEVER set this value directly:
394
       it is deduced from the AVStream values.  */
395
    int64_t start_time;
396
    /** decoding: duration of the stream, in AV_TIME_BASE fractional
397
       seconds. NEVER set this value directly: it is deduced from the
398
       AVStream values.  */
399
    int64_t duration;
400
    /** decoding: total file size. 0 if unknown */
401
    int64_t file_size;
402
    /** decoding: total stream bitrate in bit/s, 0 if not
403
       available. Never set it directly if the file_size and the
404
       duration are known as ffmpeg can compute it automatically. */
405
    int bit_rate;
406

    
407
    /* av_read_frame() support */
408
    AVStream *cur_st;
409
    const uint8_t *cur_ptr;
410
    int cur_len;
411
    AVPacket cur_pkt;
412

    
413
    /* av_seek_frame() support */
414
    int64_t data_offset; /** offset of the first packet */
415
    int index_built;
416

    
417
    int mux_rate;
418
    int packet_size;
419
    int preload;
420
    int max_delay;
421

    
422
#define AVFMT_NOOUTPUTLOOP -1
423
#define AVFMT_INFINITEOUTPUTLOOP 0
424
    /** number of times to loop output in formats that support it */
425
    int loop_output;
426

    
427
    int flags;
428
#define AVFMT_FLAG_GENPTS       0x0001 ///< generate pts if missing even if it requires parsing future frames
429
#define AVFMT_FLAG_IGNIDX       0x0002 ///< ignore index
430
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< do not block when reading packets from input
431

    
432
    int loop_input;
433
    /** decoding: size of data to probe; encoding unused */
434
    unsigned int probesize;
435

    
436
    /**
437
     * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
438
     */
439
    int max_analyze_duration;
440

    
441
    const uint8_t *key;
442
    int keylen;
443

    
444
    unsigned int nb_programs;
445
    AVProgram **programs;
446
} AVFormatContext;
447

    
448
typedef struct AVPacketList {
449
    AVPacket pkt;
450
    struct AVPacketList *next;
451
} AVPacketList;
452

    
453
extern AVInputFormat *first_iformat;
454
extern AVOutputFormat *first_oformat;
455

    
456
enum CodecID av_guess_image2_codec(const char *filename);
457

    
458
/* XXX: use automatic init with either ELF sections or C file parser */
459
/* modules */
460

    
461
#include "rtp.h"
462

    
463
#include "rtsp.h"
464

    
465
/* utils.c */
466
void av_register_input_format(AVInputFormat *format);
467
void av_register_output_format(AVOutputFormat *format);
468
AVOutputFormat *guess_stream_format(const char *short_name,
469
                                    const char *filename, const char *mime_type);
470
AVOutputFormat *guess_format(const char *short_name,
471
                             const char *filename, const char *mime_type);
472

    
473
/**
474
 * Guesses the codec id based upon muxer and filename.
475
 */
476
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
477
                            const char *filename, const char *mime_type, enum CodecType type);
478

    
479
/**
480
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
481
 *
482
 * @param f The file stream pointer where the dump should be sent to.
483
 * @param buf buffer
484
 * @param size buffer size
485
 *
486
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
487
 */
488
void av_hex_dump(FILE *f, uint8_t *buf, int size);
489

    
490
/**
491
 * Send a nice hexadecimal dump of a buffer to the log.
492
 *
493
 * @param avcl A pointer to an arbitrary struct of which the first field is a
494
 * pointer to an AVClass struct.
495
 * @param level The importance level of the message, lower values signifying
496
 * higher importance.
497
 * @param buf buffer
498
 * @param size buffer size
499
 *
500
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
501
 */
502
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
503

    
504
/**
505
 * Send a nice dump of a packet to the specified file stream.
506
 *
507
 * @param f The file stream pointer where the dump should be sent to.
508
 * @param pkt packet to dump
509
 * @param dump_payload true if the payload must be displayed too
510
 */
511
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
512

    
513
/**
514
 * Send a nice dump of a packet to the log.
515
 *
516
 * @param avcl A pointer to an arbitrary struct of which the first field is a
517
 * pointer to an AVClass struct.
518
 * @param level The importance level of the message, lower values signifying
519
 * higher importance.
520
 * @param pkt packet to dump
521
 * @param dump_payload true if the payload must be displayed too
522
 */
523
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
524

    
525
void av_register_all(void);
526

    
527
/** codec tag <-> codec id */
528
enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
529
unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
530

    
531
/* media file input */
532

    
533
/**
534
 * finds AVInputFormat based on input format's short name.
535
 */
536
AVInputFormat *av_find_input_format(const char *short_name);
537

    
538
/**
539
 * Guess file format.
540
 *
541
 * @param is_opened whether the file is already opened, determines whether
542
 *                  demuxers with or without AVFMT_NOFILE are probed
543
 */
544
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
545

    
546
/**
547
 * Allocates all the structures needed to read an input stream.
548
 *        This does not open the needed codecs for decoding the stream[s].
549
 */
550
int av_open_input_stream(AVFormatContext **ic_ptr,
551
                         ByteIOContext *pb, const char *filename,
552
                         AVInputFormat *fmt, AVFormatParameters *ap);
553

    
554
/**
555
 * Open a media file as input. The codecs are not opened. Only the file
556
 * header (if present) is read.
557
 *
558
 * @param ic_ptr the opened media file handle is put here
559
 * @param filename filename to open.
560
 * @param fmt if non NULL, force the file format to use
561
 * @param buf_size optional buffer size (zero if default is OK)
562
 * @param ap additional parameters needed when opening the file (NULL if default)
563
 * @return 0 if OK. AVERROR_xxx otherwise.
564
 */
565
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
566
                       AVInputFormat *fmt,
567
                       int buf_size,
568
                       AVFormatParameters *ap);
569
/** no av_open for output, so applications will need this: */
570
AVFormatContext *av_alloc_format_context(void);
571

    
572
/**
573
 * Read packets of a media file to get stream information. This
574
 * is useful for file formats with no headers such as MPEG. This
575
 * function also computes the real frame rate in case of mpeg2 repeat
576
 * frame mode.
577
 * The logical file position is not changed by this function;
578
 * examined packets may be buffered for later processing.
579
 *
580
 * @param ic media file handle
581
 * @return >=0 if OK. AVERROR_xxx if error.
582
 * @todo Let user decide somehow what information is needed so we do not waste time geting stuff the user does not need.
583
 */
584
int av_find_stream_info(AVFormatContext *ic);
585

    
586
/**
587
 * Read a transport packet from a media file.
588
 *
589
 * This function is obsolete and should never be used.
590
 * Use av_read_frame() instead.
591
 *
592
 * @param s media file handle
593
 * @param pkt is filled
594
 * @return 0 if OK. AVERROR_xxx if error.
595
 */
596
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
597

    
598
/**
599
 * Return the next frame of a stream.
600
 *
601
 * The returned packet is valid
602
 * until the next av_read_frame() or until av_close_input_file() and
603
 * must be freed with av_free_packet. For video, the packet contains
604
 * exactly one frame. For audio, it contains an integer number of
605
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
606
 * data). If the audio frames have a variable size (e.g. MPEG audio),
607
 * then it contains one frame.
608
 *
609
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
610
 * values in AVStream.timebase units (and guessed if the format cannot
611
 * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
612
 * has B frames, so it is better to rely on pkt->dts if you do not
613
 * decompress the payload.
614
 *
615
 * @return 0 if OK, < 0 if error or end of file.
616
 */
617
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
618

    
619
/**
620
 * Seek to the key frame at timestamp.
621
 * 'timestamp' in 'stream_index'.
622
 * @param stream_index If stream_index is (-1), a default
623
 * stream is selected, and timestamp is automatically converted
624
 * from AV_TIME_BASE units to the stream specific time_base.
625
 * @param timestamp timestamp in AVStream.time_base units
626
 *        or if there is no stream specified then in AV_TIME_BASE units
627
 * @param flags flags which select direction and seeking mode
628
 * @return >= 0 on success
629
 */
630
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
631

    
632
/**
633
 * start playing a network based stream (e.g. RTSP stream) at the
634
 * current position
635
 */
636
int av_read_play(AVFormatContext *s);
637

    
638
/**
639
 * Pause a network based stream (e.g. RTSP stream).
640
 *
641
 * Use av_read_play() to resume it.
642
 */
643
int av_read_pause(AVFormatContext *s);
644

    
645
/**
646
 * Close a media file (but not its codecs).
647
 *
648
 * @param s media file handle
649
 */
650
void av_close_input_file(AVFormatContext *s);
651

    
652
/**
653
 * Add a new stream to a media file.
654
 *
655
 * Can only be called in the read_header() function. If the flag
656
 * AVFMTCTX_NOHEADER is in the format context, then new streams
657
 * can be added in read_packet too.
658
 *
659
 * @param s media file handle
660
 * @param id file format dependent stream id
661
 */
662
AVStream *av_new_stream(AVFormatContext *s, int id);
663
AVProgram *av_new_program(AVFormatContext *s, int id);
664

    
665
/**
666
 * Set the pts for a given stream.
667
 *
668
 * @param s stream
669
 * @param pts_wrap_bits number of bits effectively used by the pts
670
 *        (used for wrap control, 33 is the value for MPEG)
671
 * @param pts_num numerator to convert to seconds (MPEG: 1)
672
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
673
 */
674
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
675
                     int pts_num, int pts_den);
676

    
677
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
678
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
679
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non keyframes
680

    
681
int av_find_default_stream_index(AVFormatContext *s);
682

    
683
/**
684
 * Gets the index for a specific timestamp.
685
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
686
 *                 the timestamp which is <= the requested one, if backward is 0
687
 *                 then it will be >=
688
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
689
 * @return < 0 if no such timestamp could be found
690
 */
691
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
692

    
693
/**
694
 * Add a index entry into a sorted list updateing if it is already there.
695
 *
696
 * @param timestamp timestamp in the timebase of the given stream
697
 */
698
int av_add_index_entry(AVStream *st,
699
                       int64_t pos, int64_t timestamp, int size, int distance, int flags);
700

    
701
/**
702
 * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
703
 * This is not supposed to be called directly by a user application, but by demuxers.
704
 * @param target_ts target timestamp in the time base of the given stream
705
 * @param stream_index stream number
706
 */
707
int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
708

    
709
/**
710
 * Updates cur_dts of all streams based on given timestamp and AVStream.
711
 *
712
 * Stream ref_st unchanged, others set cur_dts in their native timebase
713
 * only needed for timestamp wrapping or if (dts not set and pts!=dts).
714
 * @param timestamp new dts expressed in time_base of param ref_st
715
 * @param ref_st reference stream giving time_base of param timestamp
716
 */
717
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
718

    
719
/**
720
 * Does a binary search using read_timestamp().
721
 * This is not supposed to be called directly by a user application, but by demuxers.
722
 * @param target_ts target timestamp in the time base of the given stream
723
 * @param stream_index stream number
724
 */
725
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 ));
726

    
727
/** media file output */
728
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
729

    
730
/**
731
 * Allocate the stream private data and write the stream header to an
732
 * output media file.
733
 *
734
 * @param s media file handle
735
 * @return 0 if OK. AVERROR_xxx if error.
736
 */
737
int av_write_header(AVFormatContext *s);
738

    
739
/**
740
 * Write a packet to an output media file.
741
 *
742
 * The packet shall contain one audio or video frame.
743
 * The packet must be correctly interleaved according to the container specification,
744
 * if not then av_interleaved_write_frame must be used
745
 *
746
 * @param s media file handle
747
 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
748
 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
749
 */
750
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
751

    
752
/**
753
 * Writes a packet to an output media file ensuring correct interleaving.
754
 *
755
 * The packet must contain one audio or video frame.
756
 * If the packets are already correctly interleaved the application should
757
 * call av_write_frame() instead as it is slightly faster. It is also important
758
 * to keep in mind that completely non-interleaved input will need huge amounts
759
 * of memory to interleave with this, so it is preferable to interleave at the
760
 * demuxer level.
761
 *
762
 * @param s media file handle
763
 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
764
 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
765
 */
766
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
767

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

    
784
/**
785
 * @brief Write the stream trailer to an output media file and
786
 *        free the file private data.
787
 *
788
 * @param s media file handle
789
 * @return 0 if OK. AVERROR_xxx if error.
790
 */
791
int av_write_trailer(AVFormatContext *s);
792

    
793
void dump_format(AVFormatContext *ic,
794
                 int index,
795
                 const char *url,
796
                 int is_output);
797

    
798
/**
799
 * parses width and height out of string str.
800
 * @deprecated Use av_parse_video_frame_size instead.
801
 */
802
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
803

    
804
/**
805
 * Converts frame rate from string to a fraction.
806
 * @deprecated Use av_parse_video_frame_rate instead.
807
 */
808
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
809

    
810
/**
811
 * Parses \p datestr and returns a corresponding number of microseconds.
812
 * @param datestr String representing a date or a duration.
813
 * - If a date the syntax is:
814
 * @code
815
 *  [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
816
 * @endcode
817
 * Time is localtime unless Z is appended, in which case it is
818
 * interpreted as UTC.
819
 * If the year-month-day part isn't specified it takes the current
820
 * year-month-day.
821
 * Returns the number of microseconds since 1st of January, 1970 up to
822
 * the time of the parsed date or INT64_MIN if \p datestr cannot be
823
 * successfully parsed.
824
 * - If a duration the syntax is:
825
 * @code
826
 *  [-]HH[:MM[:SS[.m...]]]
827
 *  [-]S+[.m...]
828
 * @endcode
829
 * Returns the number of microseconds contained in a time interval
830
 * with the specified duration or INT64_MIN if \p datestr cannot be
831
 * succesfully parsed.
832
 * @param duration Flag which tells how to interpret \p datestr, if
833
 * not zero \p datestr is interpreted as a duration, otherwise as a
834
 * date.
835
 */
836
int64_t parse_date(const char *datestr, int duration);
837

    
838
int64_t av_gettime(void);
839

    
840
/* ffm specific for ffserver */
841
#define FFM_PACKET_SIZE 4096
842
offset_t ffm_read_write_index(int fd);
843
void ffm_write_write_index(int fd, offset_t pos);
844
void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
845

    
846
/**
847
 * Attempts to find a specific tag in a URL.
848
 *
849
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
850
 * Return 1 if found.
851
 */
852
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
853

    
854
/**
855
 * Returns in 'buf' the path with '%d' replaced by number.
856

857
 * Also handles the '%0nd' format where 'n' is the total number
858
 * of digits and '%%'.
859
 *
860
 * @param buf destination buffer
861
 * @param buf_size destination buffer size
862
 * @param path numbered sequence string
863
 * @number frame number
864
 * @return 0 if OK, -1 if format error.
865
 */
866
int av_get_frame_filename(char *buf, int buf_size,
867
                          const char *path, int number);
868

    
869
/**
870
 * Check whether filename actually is a numbered sequence generator.
871
 *
872
 * @param filename possible numbered sequence string
873
 * @return 1 if a valid numbered sequence string, 0 otherwise.
874
 */
875
int av_filename_number_test(const char *filename);
876

    
877
/**
878
 * Generate an SDP for an RTP session.
879
 *
880
 * @param ac array of AVFormatContexts describing the RTP streams. If the
881
 *           array is composed by only one context, such context can contain
882
 *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
883
 *           all the contexts in the array (an AVCodecContext per RTP stream)
884
 *           must contain only one AVStream
885
 * @param n_files number of AVCodecContexts contained in ac
886
 * @param buff buffer where the SDP will be stored (must be allocated by
887
 *             the caller
888
 * @param size the size of the buffer
889
 * @return 0 if OK. AVERROR_xxx if error.
890
 */
891
int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
892

    
893
#ifdef HAVE_AV_CONFIG_H
894

    
895
#include "os_support.h"
896

    
897
void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
898

    
899
#ifdef __GNUC__
900
#define dynarray_add(tab, nb_ptr, elem)\
901
do {\
902
    typeof(tab) _tab = (tab);\
903
    typeof(elem) _elem = (elem);\
904
    (void)sizeof(**_tab == _elem); /* check that types are compatible */\
905
    __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
906
} while(0)
907
#else
908
#define dynarray_add(tab, nb_ptr, elem)\
909
do {\
910
    __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
911
} while(0)
912
#endif
913

    
914
time_t mktimegm(struct tm *tm);
915
struct tm *brktimegm(time_t secs, struct tm *tm);
916
const char *small_strptime(const char *p, const char *fmt,
917
                           struct tm *dt);
918

    
919
struct in_addr;
920
int resolve_host(struct in_addr *sin_addr, const char *hostname);
921

    
922
void url_split(char *proto, int proto_size,
923
               char *authorization, int authorization_size,
924
               char *hostname, int hostname_size,
925
               int *port_ptr,
926
               char *path, int path_size,
927
               const char *url);
928

    
929
int match_ext(const char *filename, const char *extensions);
930

    
931
#endif /* HAVE_AV_CONFIG_H */
932

    
933
#endif /* AVFORMAT_H */
934