Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ e19fbbec

History | View | Annotate | Download (30.2 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)+(11<<8)+0)
29
#define LIBAVFORMAT_VERSION     51.11.0
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

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

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

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

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

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

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

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

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

    
249
    const struct AVCodecTag **codec_tag;
250

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

    
255
typedef struct AVIndexEntry {
256
    int64_t pos;
257
    int64_t timestamp;
258
#define AVINDEX_KEYFRAME 0x0001
259
    int flags:2;
260
    int size:30; //yeah trying to keep the size of this small to reduce memory requirements (its 24 vs 32 byte due to possible 8byte align)
261
    int min_distance;         /**< min distance between this and the previous keyframe, used to avoid unneeded searching */
262
} AVIndexEntry;
263

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

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

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

    
310
    /* av_read_frame() support */
311
    int need_parsing;                  ///< 1->full parsing needed, 2->only parse headers dont repack
312
    struct AVCodecParserContext *parser;
313

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

    
323
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
324

    
325
#define MAX_REORDER_DELAY 4
326
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
327
} AVStream;
328

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

    
332
#define MAX_STREAMS 20
333

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

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

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

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

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

    
388
    int mux_rate;
389
    int packet_size;
390
    int preload;
391
    int max_delay;
392

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

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

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

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

    
411
    const uint8_t *key;
412
    int keylen;
413
} AVFormatContext;
414

    
415
typedef struct AVPacketList {
416
    AVPacket pkt;
417
    struct AVPacketList *next;
418
} AVPacketList;
419

    
420
extern AVInputFormat *first_iformat;
421
extern AVOutputFormat *first_oformat;
422

    
423
enum CodecID av_guess_image2_codec(const char *filename);
424

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

    
428
#include "rtp.h"
429

    
430
#include "rtsp.h"
431

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

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

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

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

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

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

    
492
void av_register_all(void);
493

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

    
498
/* media file input */
499

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
647
int av_find_default_stream_index(AVFormatContext *s);
648

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

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

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

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

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

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

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

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

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

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

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

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

    
764
/**
765
 * parses width and height out of string str.
766
 */
767
int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
768

    
769
/**
770
 * Converts frame rate from string to a fraction.
771
 */
772
int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
773

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

    
791
int64_t av_gettime(void);
792

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

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

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

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

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

    
830
/* grab specific */
831
int video_grab_init(void);
832
int audio_init(void);
833

    
834
/* DV1394 */
835
int dv1394_init(void);
836
int dc1394_init(void);
837

    
838
#ifdef HAVE_AV_CONFIG_H
839

    
840
#include "os_support.h"
841

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

    
847
void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
848

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

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

    
869
struct in_addr;
870
int resolve_host(struct in_addr *sin_addr, const char *hostname);
871

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

    
879
int match_ext(const char *filename, const char *extensions);
880

    
881
#endif /* HAVE_AV_CONFIG_H */
882

    
883
#ifdef __cplusplus
884
}
885
#endif
886

    
887
#endif /* AVFORMAT_H */
888