Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 8bfb108b

History | View | Annotate | Download (34 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 FFMPEG_AVFORMAT_H
22
#define FFMPEG_AVFORMAT_H
23

    
24
#define LIBAVFORMAT_VERSION_INT ((52<<16)+(3<<8)+0)
25
#define LIBAVFORMAT_VERSION     52.3.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
    const char *standard; /**< tv standard, NTSC, PAL, SECAM */
140
    int mpeg2ts_raw:1;  /**< force raw MPEG2 transport stream output, if possible */
141
    int mpeg2ts_compute_pcr:1; /**< compute exact PCR for each transport
142
                                  stream packet (only meaningful if
143
                                  mpeg2ts_raw is TRUE) */
144
    int initial_pause:1;       /**< do not begin to play the stream
145
                                  immediately (RTSP only) */
146
    int prealloced_context:1;
147
#if LIBAVFORMAT_VERSION_INT < (53<<16)
148
    enum CodecID video_codec_id;
149
    enum CodecID audio_codec_id;
150
#endif
151
} AVFormatParameters;
152

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

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

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

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

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

    
194
typedef struct AVInputFormat {
195
    const char *name;
196
    const char *long_name;
197
    /** size of private data so that it can be allocated in the wrapper */
198
    int priv_data_size;
199
    /**
200
     * Tell if a given file has a chance of being parsed by this format.
201
     * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
202
     * big so you do not have to check for that unless you need more.
203
     */
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
       additional 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
     * @return >= 0 on success (but not necessarily the new offset)
225
     */
226
    int (*read_seek)(struct AVFormatContext *,
227
                     int stream_index, int64_t timestamp, int flags);
228
    /**
229
     * gets the next timestamp in AV_TIME_BASE units.
230
     */
231
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
232
                              int64_t *pos, int64_t pos_limit);
233
    /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
234
    int flags;
235
    /** if extensions are defined, then no probe is done. You should
236
       usually not use extension format guessing because it is not
237
       reliable enough */
238
    const char *extensions;
239
    /** general purpose read only value that the format can use */
240
    int value;
241

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

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

    
250
    const struct AVCodecTag **codec_tag;
251

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

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

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

    
272
/**
273
 * Stream structure.
274
 * New fields can be added to the end with minor version bumps.
275
 * Removal, reordering and changes to existing fields require a major
276
 * version bump.
277
 * sizeof(AVStream) must not be used outside libav*.
278
 */
279
typedef struct AVStream {
280
    int index;    /**< stream index in AVFormatContext */
281
    int id;       /**< format specific stream id */
282
    AVCodecContext *codec; /**< codec context */
283
    /**
284
     * Real base frame rate of the stream.
285
     * This is the lowest frame rate with which all timestamps can be
286
     * represented accurately (it is the least common multiple of all
287
     * frame rates in the stream), Note, this value is just a guess!
288
     * For example if the timebase is 1/90000 and all frames have either
289
     * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1.
290
     */
291
    AVRational r_frame_rate;
292
    void *priv_data;
293

    
294
    /* internal data used in av_find_stream_info() */
295
    int64_t first_dts;
296
    /** encoding: PTS generation when outputing stream */
297
    struct AVFrac pts;
298

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

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

    
332
    /* av_read_frame() support */
333
    enum AVStreamParseType need_parsing;
334
    struct AVCodecParserContext *parser;
335

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

    
345
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
346

    
347
#define MAX_REORDER_DELAY 4
348
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
349
} AVStream;
350

    
351
#define AV_PROGRAM_RUNNING 1
352

    
353
/**
354
 * New fields can be added to the end with minor version bumps.
355
 * Removal, reordering and changes to existing fields require a major
356
 * version bump.
357
 * sizeof(AVProgram) must not be used outside libav*.
358
 */
359
typedef struct AVProgram {
360
    int            id;
361
    char           *provider_name; ///< Network name for DVB streams
362
    char           *name;          ///< Service name for DVB streams
363
    int            flags;
364
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
365
    unsigned int   *stream_index;
366
    unsigned int   nb_stream_indexes;
367
} AVProgram;
368

    
369
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
370
                                         (streams are added dynamically) */
371

    
372
#define MAX_STREAMS 20
373

    
374
/**
375
 * format I/O context.
376
 * New fields can be added to the end with minor version bumps.
377
 * Removal, reordering and changes to existing fields require a major
378
 * version bump.
379
 * sizeof(AVFormatContext) must not be used outside libav*.
380
 */
381
typedef struct AVFormatContext {
382
    const AVClass *av_class; /**< set by av_alloc_format_context */
383
    /* can only be iformat or oformat, not both at the same time */
384
    struct AVInputFormat *iformat;
385
    struct AVOutputFormat *oformat;
386
    void *priv_data;
387
    ByteIOContext *pb;
388
    unsigned int nb_streams;
389
    AVStream *streams[MAX_STREAMS];
390
    char filename[1024]; /**< input or output filename */
391
    /* stream info */
392
    int64_t timestamp;
393
    char title[512];
394
    char author[512];
395
    char copyright[512];
396
    char comment[512];
397
    char album[512];
398
    int year;  /**< ID3 year, 0 if none */
399
    int track; /**< track number, 0 if none */
400
    char genre[32]; /**< ID3 genre */
401

    
402
    int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
403
    /* private data for pts handling (do not modify directly) */
404
    /** This buffer is only needed when packets were already buffered but
405
       not decoded, for example to get the codec parameters in mpeg
406
       streams */
407
    struct AVPacketList *packet_buffer;
408

    
409
    /** decoding: position of the first frame of the component, in
410
       AV_TIME_BASE fractional seconds. NEVER set this value directly:
411
       it is deduced from the AVStream values.  */
412
    int64_t start_time;
413
    /** decoding: duration of the stream, in AV_TIME_BASE fractional
414
       seconds. NEVER set this value directly: it is deduced from the
415
       AVStream values.  */
416
    int64_t duration;
417
    /** decoding: total file size. 0 if unknown */
418
    int64_t file_size;
419
    /** decoding: total stream bitrate in bit/s, 0 if not
420
       available. Never set it directly if the file_size and the
421
       duration are known as ffmpeg can compute it automatically. */
422
    int bit_rate;
423

    
424
    /* av_read_frame() support */
425
    AVStream *cur_st;
426
    const uint8_t *cur_ptr;
427
    int cur_len;
428
    AVPacket cur_pkt;
429

    
430
    /* av_seek_frame() support */
431
    int64_t data_offset; /** offset of the first packet */
432
    int index_built;
433

    
434
    int mux_rate;
435
    int packet_size;
436
    int preload;
437
    int max_delay;
438

    
439
#define AVFMT_NOOUTPUTLOOP -1
440
#define AVFMT_INFINITEOUTPUTLOOP 0
441
    /** number of times to loop output in formats that support it */
442
    int loop_output;
443

    
444
    int flags;
445
#define AVFMT_FLAG_GENPTS       0x0001 ///< generate pts if missing even if it requires parsing future frames
446
#define AVFMT_FLAG_IGNIDX       0x0002 ///< ignore index
447
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< do not block when reading packets from input
448

    
449
    int loop_input;
450
    /** decoding: size of data to probe; encoding unused */
451
    unsigned int probesize;
452

    
453
    /**
454
     * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
455
     */
456
    int max_analyze_duration;
457

    
458
    const uint8_t *key;
459
    int keylen;
460

    
461
    unsigned int nb_programs;
462
    AVProgram **programs;
463

    
464
    /**
465
     * Forced video codec_id.
466
     * demuxing: set by user
467
     */
468
    enum CodecID video_codec_id;
469
    /**
470
     * Forced audio codec_id.
471
     * demuxing: set by user
472
     */
473
    enum CodecID audio_codec_id;
474
    /**
475
     * Forced subtitle codec_id.
476
     * demuxing: set by user
477
     */
478
    enum CodecID subtitle_codec_id;
479
} AVFormatContext;
480

    
481
typedef struct AVPacketList {
482
    AVPacket pkt;
483
    struct AVPacketList *next;
484
} AVPacketList;
485

    
486
#if LIBAVFORMAT_VERSION_INT < (53<<16)
487
extern AVInputFormat *first_iformat;
488
extern AVOutputFormat *first_oformat;
489
#endif
490

    
491
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
492
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
493

    
494
enum CodecID av_guess_image2_codec(const char *filename);
495

    
496
/* XXX: use automatic init with either ELF sections or C file parser */
497
/* modules */
498

    
499
/* utils.c */
500
void av_register_input_format(AVInputFormat *format);
501
void av_register_output_format(AVOutputFormat *format);
502
AVOutputFormat *guess_stream_format(const char *short_name,
503
                                    const char *filename, const char *mime_type);
504
AVOutputFormat *guess_format(const char *short_name,
505
                             const char *filename, const char *mime_type);
506

    
507
/**
508
 * Guesses the codec id based upon muxer and filename.
509
 */
510
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
511
                            const char *filename, const char *mime_type, enum CodecType type);
512

    
513
/**
514
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
515
 *
516
 * @param f The file stream pointer where the dump should be sent to.
517
 * @param buf buffer
518
 * @param size buffer size
519
 *
520
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
521
 */
522
void av_hex_dump(FILE *f, uint8_t *buf, int size);
523

    
524
/**
525
 * Send a nice hexadecimal dump of a buffer to the log.
526
 *
527
 * @param avcl A pointer to an arbitrary struct of which the first field is a
528
 * pointer to an AVClass struct.
529
 * @param level The importance level of the message, lower values signifying
530
 * higher importance.
531
 * @param buf buffer
532
 * @param size buffer size
533
 *
534
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
535
 */
536
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
537

    
538
/**
539
 * Send a nice dump of a packet to the specified file stream.
540
 *
541
 * @param f The file stream pointer where the dump should be sent to.
542
 * @param pkt packet to dump
543
 * @param dump_payload true if the payload must be displayed too
544
 */
545
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
546

    
547
/**
548
 * Send a nice dump of a packet to the log.
549
 *
550
 * @param avcl A pointer to an arbitrary struct of which the first field is a
551
 * pointer to an AVClass struct.
552
 * @param level The importance level of the message, lower values signifying
553
 * higher importance.
554
 * @param pkt packet to dump
555
 * @param dump_payload true if the payload must be displayed too
556
 */
557
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
558

    
559
void av_register_all(void);
560

    
561
/** codec tag <-> codec id */
562
enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
563
unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
564

    
565
/* media file input */
566

    
567
/**
568
 * finds AVInputFormat based on input format's short name.
569
 */
570
AVInputFormat *av_find_input_format(const char *short_name);
571

    
572
/**
573
 * Guess file format.
574
 *
575
 * @param is_opened whether the file is already opened, determines whether
576
 *                  demuxers with or without AVFMT_NOFILE are probed
577
 */
578
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
579

    
580
/**
581
 * Allocates all the structures needed to read an input stream.
582
 *        This does not open the needed codecs for decoding the stream[s].
583
 */
584
int av_open_input_stream(AVFormatContext **ic_ptr,
585
                         ByteIOContext *pb, const char *filename,
586
                         AVInputFormat *fmt, AVFormatParameters *ap);
587

    
588
/**
589
 * Open a media file as input. The codecs are not opened. Only the file
590
 * header (if present) is read.
591
 *
592
 * @param ic_ptr the opened media file handle is put here
593
 * @param filename filename to open.
594
 * @param fmt if non NULL, force the file format to use
595
 * @param buf_size optional buffer size (zero if default is OK)
596
 * @param ap additional parameters needed when opening the file (NULL if default)
597
 * @return 0 if OK. AVERROR_xxx otherwise.
598
 */
599
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
600
                       AVInputFormat *fmt,
601
                       int buf_size,
602
                       AVFormatParameters *ap);
603
/**
604
 * Allocate an AVFormatContext.
605
 * Can be freed with av_free() but do not forget to free everything you
606
 * explicitly allocated as well!
607
 */
608
AVFormatContext *av_alloc_format_context(void);
609

    
610
/**
611
 * Read packets of a media file to get stream information. This
612
 * is useful for file formats with no headers such as MPEG. This
613
 * function also computes the real frame rate in case of mpeg2 repeat
614
 * frame mode.
615
 * The logical file position is not changed by this function;
616
 * examined packets may be buffered for later processing.
617
 *
618
 * @param ic media file handle
619
 * @return >=0 if OK. AVERROR_xxx if error.
620
 * @todo Let user decide somehow what information is needed so we do not waste time getting stuff the user does not need.
621
 */
622
int av_find_stream_info(AVFormatContext *ic);
623

    
624
/**
625
 * Read a transport packet from a media file.
626
 *
627
 * This function is obsolete and should never be used.
628
 * Use av_read_frame() instead.
629
 *
630
 * @param s media file handle
631
 * @param pkt is filled
632
 * @return 0 if OK. AVERROR_xxx if error.
633
 */
634
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
635

    
636
/**
637
 * Return the next frame of a stream.
638
 *
639
 * The returned packet is valid
640
 * until the next av_read_frame() or until av_close_input_file() and
641
 * must be freed with av_free_packet. For video, the packet contains
642
 * exactly one frame. For audio, it contains an integer number of
643
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
644
 * data). If the audio frames have a variable size (e.g. MPEG audio),
645
 * then it contains one frame.
646
 *
647
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
648
 * values in AVStream.timebase units (and guessed if the format cannot
649
 * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
650
 * has B frames, so it is better to rely on pkt->dts if you do not
651
 * decompress the payload.
652
 *
653
 * @return 0 if OK, < 0 if error or end of file.
654
 */
655
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
656

    
657
/**
658
 * Seek to the key frame at timestamp.
659
 * 'timestamp' in 'stream_index'.
660
 * @param stream_index If stream_index is (-1), a default
661
 * stream is selected, and timestamp is automatically converted
662
 * from AV_TIME_BASE units to the stream specific time_base.
663
 * @param timestamp timestamp in AVStream.time_base units
664
 *        or if there is no stream specified then in AV_TIME_BASE units
665
 * @param flags flags which select direction and seeking mode
666
 * @return >= 0 on success
667
 */
668
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
669

    
670
/**
671
 * start playing a network based stream (e.g. RTSP stream) at the
672
 * current position
673
 */
674
int av_read_play(AVFormatContext *s);
675

    
676
/**
677
 * Pause a network based stream (e.g. RTSP stream).
678
 *
679
 * Use av_read_play() to resume it.
680
 */
681
int av_read_pause(AVFormatContext *s);
682

    
683
/**
684
 * Free a AVFormatContext allocated by av_open_input_stream.
685
 * @param s context to free
686
 */
687
void av_close_input_stream(AVFormatContext *s);
688

    
689
/**
690
 * Close a media file (but not its codecs).
691
 *
692
 * @param s media file handle
693
 */
694
void av_close_input_file(AVFormatContext *s);
695

    
696
/**
697
 * Add a new stream to a media file.
698
 *
699
 * Can only be called in the read_header() function. If the flag
700
 * AVFMTCTX_NOHEADER is in the format context, then new streams
701
 * can be added in read_packet too.
702
 *
703
 * @param s media file handle
704
 * @param id file format dependent stream id
705
 */
706
AVStream *av_new_stream(AVFormatContext *s, int id);
707
AVProgram *av_new_program(AVFormatContext *s, int id);
708

    
709
/**
710
 * Set the pts for a given stream.
711
 *
712
 * @param s stream
713
 * @param pts_wrap_bits number of bits effectively used by the pts
714
 *        (used for wrap control, 33 is the value for MPEG)
715
 * @param pts_num numerator to convert to seconds (MPEG: 1)
716
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
717
 */
718
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
719
                     int pts_num, int pts_den);
720

    
721
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
722
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
723
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non keyframes
724

    
725
int av_find_default_stream_index(AVFormatContext *s);
726

    
727
/**
728
 * Gets the index for a specific timestamp.
729
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
730
 *                 the timestamp which is <= the requested one, if backward is 0
731
 *                 then it will be >=
732
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
733
 * @return < 0 if no such timestamp could be found
734
 */
735
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
736

    
737
/**
738
 * Add a index entry into a sorted list updateing if it is already there.
739
 *
740
 * @param timestamp timestamp in the timebase of the given stream
741
 */
742
int av_add_index_entry(AVStream *st,
743
                       int64_t pos, int64_t timestamp, int size, int distance, int flags);
744

    
745
/**
746
 * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
747
 * This is not supposed to be called directly by a user application, but by demuxers.
748
 * @param target_ts target timestamp in the time base of the given stream
749
 * @param stream_index stream number
750
 */
751
int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
752

    
753
/**
754
 * Updates cur_dts of all streams based on given timestamp and AVStream.
755
 *
756
 * Stream ref_st unchanged, others set cur_dts in their native timebase
757
 * only needed for timestamp wrapping or if (dts not set and pts!=dts).
758
 * @param timestamp new dts expressed in time_base of param ref_st
759
 * @param ref_st reference stream giving time_base of param timestamp
760
 */
761
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
762

    
763
/**
764
 * Does a binary search using read_timestamp().
765
 * This is not supposed to be called directly by a user application, but by demuxers.
766
 * @param target_ts target timestamp in the time base of the given stream
767
 * @param stream_index stream number
768
 */
769
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 ));
770

    
771
/** media file output */
772
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
773

    
774
/**
775
 * Allocate the stream private data and write the stream header to an
776
 * output media file.
777
 *
778
 * @param s media file handle
779
 * @return 0 if OK. AVERROR_xxx if error.
780
 */
781
int av_write_header(AVFormatContext *s);
782

    
783
/**
784
 * Write a packet to an output media file.
785
 *
786
 * The packet shall contain one audio or video frame.
787
 * The packet must be correctly interleaved according to the container specification,
788
 * if not then av_interleaved_write_frame must be used
789
 *
790
 * @param s media file handle
791
 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
792
 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
793
 */
794
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
795

    
796
/**
797
 * Writes a packet to an output media file ensuring correct interleaving.
798
 *
799
 * The packet must contain one audio or video frame.
800
 * If the packets are already correctly interleaved the application should
801
 * call av_write_frame() instead as it is slightly faster. It is also important
802
 * to keep in mind that completely non-interleaved input will need huge amounts
803
 * of memory to interleave with this, so it is preferable to interleave at the
804
 * demuxer level.
805
 *
806
 * @param s media file handle
807
 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
808
 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
809
 */
810
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
811

    
812
/**
813
 * Interleave a packet per DTS in an output media file.
814
 *
815
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this function,
816
 * so they cannot be used after it, note calling av_free_packet() on them is still safe.
817
 *
818
 * @param s media file handle
819
 * @param out the interleaved packet will be output here
820
 * @param in the input packet
821
 * @param flush 1 if no further packets are available as input and all
822
 *              remaining packets should be output
823
 * @return 1 if a packet was output, 0 if no packet could be output,
824
 *         < 0 if an error occured
825
 */
826
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
827

    
828
/**
829
 * @brief Write the stream trailer to an output media file and
830
 *        free the file private data.
831
 *
832
 * @param s media file handle
833
 * @return 0 if OK. AVERROR_xxx if error.
834
 */
835
int av_write_trailer(AVFormatContext *s);
836

    
837
void dump_format(AVFormatContext *ic,
838
                 int index,
839
                 const char *url,
840
                 int is_output);
841

    
842
/**
843
 * parses width and height out of string str.
844
 * @deprecated Use av_parse_video_frame_size instead.
845
 */
846
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
847

    
848
/**
849
 * Converts frame rate from string to a fraction.
850
 * @deprecated Use av_parse_video_frame_rate instead.
851
 */
852
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
853

    
854
/**
855
 * Parses \p datestr and returns a corresponding number of microseconds.
856
 * @param datestr String representing a date or a duration.
857
 * - If a date the syntax is:
858
 * @code
859
 *  [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
860
 * @endcode
861
 * Time is localtime unless Z is appended, in which case it is
862
 * interpreted as UTC.
863
 * If the year-month-day part isn't specified it takes the current
864
 * year-month-day.
865
 * Returns the number of microseconds since 1st of January, 1970 up to
866
 * the time of the parsed date or INT64_MIN if \p datestr cannot be
867
 * successfully parsed.
868
 * - If a duration the syntax is:
869
 * @code
870
 *  [-]HH[:MM[:SS[.m...]]]
871
 *  [-]S+[.m...]
872
 * @endcode
873
 * Returns the number of microseconds contained in a time interval
874
 * with the specified duration or INT64_MIN if \p datestr cannot be
875
 * successfully parsed.
876
 * @param duration Flag which tells how to interpret \p datestr, if
877
 * not zero \p datestr is interpreted as a duration, otherwise as a
878
 * date.
879
 */
880
int64_t parse_date(const char *datestr, int duration);
881

    
882
int64_t av_gettime(void);
883

    
884
/* ffm specific for ffserver */
885
#define FFM_PACKET_SIZE 4096
886
offset_t ffm_read_write_index(int fd);
887
void ffm_write_write_index(int fd, offset_t pos);
888
void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
889

    
890
/**
891
 * Attempts to find a specific tag in a URL.
892
 *
893
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
894
 * Return 1 if found.
895
 */
896
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
897

    
898
/**
899
 * Returns in 'buf' the path with '%d' replaced by number.
900

901
 * Also handles the '%0nd' format where 'n' is the total number
902
 * of digits and '%%'.
903
 *
904
 * @param buf destination buffer
905
 * @param buf_size destination buffer size
906
 * @param path numbered sequence string
907
 * @param number frame number
908
 * @return 0 if OK, -1 if format error.
909
 */
910
int av_get_frame_filename(char *buf, int buf_size,
911
                          const char *path, int number);
912

    
913
/**
914
 * Check whether filename actually is a numbered sequence generator.
915
 *
916
 * @param filename possible numbered sequence string
917
 * @return 1 if a valid numbered sequence string, 0 otherwise.
918
 */
919
int av_filename_number_test(const char *filename);
920

    
921
/**
922
 * Generate an SDP for an RTP session.
923
 *
924
 * @param ac array of AVFormatContexts describing the RTP streams. If the
925
 *           array is composed by only one context, such context can contain
926
 *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
927
 *           all the contexts in the array (an AVCodecContext per RTP stream)
928
 *           must contain only one AVStream
929
 * @param n_files number of AVCodecContexts contained in ac
930
 * @param buff buffer where the SDP will be stored (must be allocated by
931
 *             the caller
932
 * @param size the size of the buffer
933
 * @return 0 if OK. AVERROR_xxx if error.
934
 */
935
int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
936

    
937
#ifdef HAVE_AV_CONFIG_H
938

    
939
void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
940

    
941
#ifdef __GNUC__
942
#define dynarray_add(tab, nb_ptr, elem)\
943
do {\
944
    typeof(tab) _tab = (tab);\
945
    typeof(elem) _elem = (elem);\
946
    (void)sizeof(**_tab == _elem); /* check that types are compatible */\
947
    __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
948
} while(0)
949
#else
950
#define dynarray_add(tab, nb_ptr, elem)\
951
do {\
952
    __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
953
} while(0)
954
#endif
955

    
956
time_t mktimegm(struct tm *tm);
957
struct tm *brktimegm(time_t secs, struct tm *tm);
958
const char *small_strptime(const char *p, const char *fmt,
959
                           struct tm *dt);
960

    
961
struct in_addr;
962
int resolve_host(struct in_addr *sin_addr, const char *hostname);
963

    
964
void url_split(char *proto, int proto_size,
965
               char *authorization, int authorization_size,
966
               char *hostname, int hostname_size,
967
               int *port_ptr,
968
               char *path, int path_size,
969
               const char *url);
970

    
971
int match_ext(const char *filename, const char *extensions);
972

    
973
#endif /* HAVE_AV_CONFIG_H */
974

    
975
#endif /* FFMPEG_AVFORMAT_H */