Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ abd2256d

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

    
24
#define LIBAVFORMAT_VERSION_MAJOR 52
25
#define LIBAVFORMAT_VERSION_MINOR 14
26
#define LIBAVFORMAT_VERSION_MICRO  0
27

    
28
#define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \
29
                                               LIBAVFORMAT_VERSION_MINOR, \
30
                                               LIBAVFORMAT_VERSION_MICRO)
31
#define LIBAVFORMAT_VERSION     AV_VERSION(LIBAVFORMAT_VERSION_MAJOR,   \
32
                                           LIBAVFORMAT_VERSION_MINOR,   \
33
                                           LIBAVFORMAT_VERSION_MICRO)
34
#define LIBAVFORMAT_BUILD       LIBAVFORMAT_VERSION_INT
35

    
36
#define LIBAVFORMAT_IDENT       "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
37

    
38
#include <time.h>
39
#include <stdio.h>  /* FILE */
40
#include "libavcodec/avcodec.h"
41

    
42
#include "avio.h"
43

    
44
/* packet functions */
45

    
46
typedef struct AVPacket {
47
    /**
48
     * Presentation time stamp in time_base units.
49
     * This is the time at which the decompressed packet will be presented
50
     * to the user.
51
     * Can be AV_NOPTS_VALUE if it is not stored in the file.
52
     * pts MUST be larger or equal to dts as presentation can not happen before
53
     * decompression, unless one wants to view hex dumps. Some formats misuse
54
     * the terms dts and pts/cts to mean something different, these timestamps
55
     * must be converted to true pts/dts before they are stored in AVPacket.
56
     */
57
    int64_t pts;
58
    /**
59
     * Decompression time stamp in time_base units.
60
     * This is the time at which the packet is decompressed.
61
     * Can be AV_NOPTS_VALUE if it is not stored in the file.
62
     */
63
    int64_t dts;
64
    uint8_t *data;
65
    int   size;
66
    int   stream_index;
67
    int   flags;
68
    int   duration;                         ///< presentation duration in time_base units (0 if not available)
69
    void  (*destruct)(struct AVPacket *);
70
    void  *priv;
71
    int64_t pos;                            ///< byte position in stream, -1 if unknown
72
} AVPacket;
73
#define PKT_FLAG_KEY   0x0001
74

    
75
void av_destruct_packet_nofree(AVPacket *pkt);
76

    
77
/**
78
 * Default packet destructor.
79
 */
80
void av_destruct_packet(AVPacket *pkt);
81

    
82
/**
83
 * Initialize optional fields of a packet to default values.
84
 *
85
 * @param pkt packet
86
 */
87
void av_init_packet(AVPacket *pkt);
88

    
89
/**
90
 * Allocate the payload of a packet and initialize its fields to default values.
91
 *
92
 * @param pkt packet
93
 * @param size wanted payload size
94
 * @return 0 if OK. AVERROR_xxx otherwise.
95
 */
96
int av_new_packet(AVPacket *pkt, int size);
97

    
98
/**
99
 * Allocate and read the payload of a packet and initialize its fields to default values.
100
 *
101
 * @param pkt packet
102
 * @param size wanted payload size
103
 * @return >0 (read size) if OK. AVERROR_xxx otherwise.
104
 */
105
int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
106

    
107
/**
108
 * @warning This is a hack - the packet memory allocation stuff is broken. The
109
 * packet is allocated if it was not really allocated
110
 */
111
int av_dup_packet(AVPacket *pkt);
112

    
113
/**
114
 * Free a packet
115
 *
116
 * @param pkt packet to free
117
 */
118
static inline void av_free_packet(AVPacket *pkt)
119
{
120
    if (pkt && pkt->destruct) {
121
        pkt->destruct(pkt);
122
    }
123
}
124

    
125
/*************************************************/
126
/* fractional numbers for exact pts handling */
127

    
128
/**
129
 * the exact value of the fractional number is: 'val + num / den'.
130
 * num is assumed to be such as 0 <= num < den
131
 * @deprecated Use AVRational instead
132
*/
133
typedef struct AVFrac {
134
    int64_t val, num, den;
135
} AVFrac attribute_deprecated;
136

    
137
/*************************************************/
138
/* input/output formats */
139

    
140
struct AVCodecTag;
141

    
142
struct AVFormatContext;
143

    
144
/** this structure contains the data a format has to probe a file */
145
typedef struct AVProbeData {
146
    const char *filename;
147
    unsigned char *buf;
148
    int buf_size;
149
} AVProbeData;
150

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

    
154
typedef struct AVFormatParameters {
155
    AVRational time_base;
156
    int sample_rate;
157
    int channels;
158
    int width;
159
    int height;
160
    enum PixelFormat pix_fmt;
161
    int channel; /**< used to select dv channel */
162
    const char *standard; /**< tv standard, NTSC, PAL, SECAM */
163
    int mpeg2ts_raw:1;  /**< force raw MPEG2 transport stream output, if possible */
164
    int mpeg2ts_compute_pcr:1; /**< compute exact PCR for each transport
165
                                  stream packet (only meaningful if
166
                                  mpeg2ts_raw is TRUE) */
167
    int initial_pause:1;       /**< do not begin to play the stream
168
                                  immediately (RTSP only) */
169
    int prealloced_context:1;
170
#if LIBAVFORMAT_VERSION_INT < (53<<16)
171
    enum CodecID video_codec_id;
172
    enum CodecID audio_codec_id;
173
#endif
174
} AVFormatParameters;
175

    
176
//! demuxer will use url_fopen, no opened file should be provided by the caller
177
#define AVFMT_NOFILE        0x0001
178
#define AVFMT_NEEDNUMBER    0x0002 /**< needs '%d' in filename */
179
#define AVFMT_SHOW_IDS      0x0008 /**< show format stream IDs numbers */
180
#define AVFMT_RAWPICTURE    0x0020 /**< format wants AVPicture structure for
181
                                      raw picture data */
182
#define AVFMT_GLOBALHEADER  0x0040 /**< format wants global header */
183
#define AVFMT_NOTIMESTAMPS  0x0080 /**< format does not need / have any timestamps */
184
#define AVFMT_GENERIC_INDEX 0x0100 /**< use generic index building code */
185

    
186
typedef struct AVOutputFormat {
187
    const char *name;
188
    const char *long_name;
189
    const char *mime_type;
190
    const char *extensions; /**< comma separated filename extensions */
191
    /** size of private data so that it can be allocated in the wrapper */
192
    int priv_data_size;
193
    /* output support */
194
    enum CodecID audio_codec; /**< default audio codec */
195
    enum CodecID video_codec; /**< default video codec */
196
    int (*write_header)(struct AVFormatContext *);
197
    int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
198
    int (*write_trailer)(struct AVFormatContext *);
199
    /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
200
    int flags;
201
    /** currently only used to set pixel format if not YUV420P */
202
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
203
    int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
204

    
205
    /**
206
     * list of supported codec_id-codec_tag pairs, ordered by "better choice first"
207
     * the arrays are all CODEC_ID_NONE terminated
208
     */
209
    const struct AVCodecTag **codec_tag;
210

    
211
    enum CodecID subtitle_codec; /**< default subtitle codec */
212

    
213
    /* private fields */
214
    struct AVOutputFormat *next;
215
} AVOutputFormat;
216

    
217
typedef struct AVInputFormat {
218
    const char *name;
219
    const char *long_name;
220
    /** size of private data so that it can be allocated in the wrapper */
221
    int priv_data_size;
222
    /**
223
     * Tell if a given file has a chance of being parsed by this format.
224
     * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
225
     * big so you do not have to check for that unless you need more.
226
     */
227
    int (*read_probe)(AVProbeData *);
228
    /** read the format header and initialize the AVFormatContext
229
       structure. Return 0 if OK. 'ap' if non NULL contains
230
       additional paramters. Only used in raw format right
231
       now. 'av_new_stream' should be called to create new streams.  */
232
    int (*read_header)(struct AVFormatContext *,
233
                       AVFormatParameters *ap);
234
    /** read one packet and put it in 'pkt'. pts and flags are also
235
       set. 'av_new_stream' can be called only if the flag
236
       AVFMTCTX_NOHEADER is used. */
237
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
238
    /** close the stream. The AVFormatContext and AVStreams are not
239
       freed by this function */
240
    int (*read_close)(struct AVFormatContext *);
241
    /**
242
     * seek to a given timestamp relative to the frames in
243
     * stream component stream_index
244
     * @param stream_index must not be -1
245
     * @param flags selects which direction should be preferred if no exact
246
     *              match is available
247
     * @return >= 0 on success (but not necessarily the new offset)
248
     */
249
    int (*read_seek)(struct AVFormatContext *,
250
                     int stream_index, int64_t timestamp, int flags);
251
    /**
252
     * gets the next timestamp in stream[stream_index].time_base units.
253
     * @return the timestamp or AV_NOPTS_VALUE if an error occurred
254
     */
255
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
256
                              int64_t *pos, int64_t pos_limit);
257
    /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
258
    int flags;
259
    /** if extensions are defined, then no probe is done. You should
260
       usually not use extension format guessing because it is not
261
       reliable enough */
262
    const char *extensions;
263
    /** general purpose read only value that the format can use */
264
    int value;
265

    
266
    /** start/resume playing - only meaningful if using a network based format
267
       (RTSP) */
268
    int (*read_play)(struct AVFormatContext *);
269

    
270
    /** pause playing - only meaningful if using a network based format
271
       (RTSP) */
272
    int (*read_pause)(struct AVFormatContext *);
273

    
274
    const struct AVCodecTag **codec_tag;
275

    
276
    /* private fields */
277
    struct AVInputFormat *next;
278
} AVInputFormat;
279

    
280
enum AVStreamParseType {
281
    AVSTREAM_PARSE_NONE,
282
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
283
    AVSTREAM_PARSE_HEADERS,    /**< only parse headers, don't repack */
284
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on packet boundary */
285
};
286

    
287
typedef struct AVIndexEntry {
288
    int64_t pos;
289
    int64_t timestamp;
290
#define AVINDEX_KEYFRAME 0x0001
291
    int flags:2;
292
    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).
293
    int min_distance;         /**< min distance between this and the previous keyframe, used to avoid unneeded searching */
294
} AVIndexEntry;
295

    
296
#define AV_DISPOSITION_DEFAULT   0x0001
297
#define AV_DISPOSITION_DUB       0x0002
298
#define AV_DISPOSITION_ORIGINAL  0x0004
299
#define AV_DISPOSITION_COMMENT   0x0008
300
#define AV_DISPOSITION_LYRICS    0x0010
301
#define AV_DISPOSITION_KARAOKE   0x0020
302

    
303
/**
304
 * Stream structure.
305
 * New fields can be added to the end with minor version bumps.
306
 * Removal, reordering and changes to existing fields require a major
307
 * version bump.
308
 * sizeof(AVStream) must not be used outside libav*.
309
 */
310
typedef struct AVStream {
311
    int index;    /**< stream index in AVFormatContext */
312
    int id;       /**< format specific stream id */
313
    AVCodecContext *codec; /**< codec context */
314
    /**
315
     * Real base frame rate of the stream.
316
     * This is the lowest frame rate with which all timestamps can be
317
     * represented accurately (it is the least common multiple of all
318
     * frame rates in the stream), Note, this value is just a guess!
319
     * For example if the timebase is 1/90000 and all frames have either
320
     * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1.
321
     */
322
    AVRational r_frame_rate;
323
    void *priv_data;
324

    
325
    /* internal data used in av_find_stream_info() */
326
    int64_t first_dts;
327
    /** encoding: PTS generation when outputing stream */
328
    struct AVFrac pts;
329

    
330
    /**
331
     * This is the fundamental unit of time (in seconds) in terms
332
     * of which frame timestamps are represented. For fixed-fps content,
333
     * timebase should be 1/frame rate and timestamp increments should be
334
     * identically 1.
335
     */
336
    AVRational time_base;
337
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
338
    /* ffmpeg.c private use */
339
    int stream_copy; /**< if set, just copy stream */
340
    enum AVDiscard discard; ///< selects which packets can be discarded at will and do not need to be demuxed
341
    //FIXME move stuff to a flags field?
342
    /** quality, as it has been removed from AVCodecContext and put in AVVideoFrame
343
     * MN: dunno if that is the right place for it */
344
    float quality;
345
    /**
346
     * Decoding: pts of the first frame of the stream, in stream time base.
347
     * Only set this if you are absolutely 100% sure that the value you set
348
     * it to really is the pts of the first frame.
349
     * This may be undefined (AV_NOPTS_VALUE).
350
     * @note The ASF header does NOT contain a correct start_time the ASF
351
     * demuxer must NOT set this.
352
     */
353
    int64_t start_time;
354
    /**
355
     * Decoding: duration of the stream, in stream time base.
356
     * If a source file does not specify a duration, but does specify
357
     * a bitrate, this value will be estimates from bit rate and file size.
358
     */
359
    int64_t duration;
360

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

    
363
    /* av_read_frame() support */
364
    enum AVStreamParseType need_parsing;
365
    struct AVCodecParserContext *parser;
366

    
367
    int64_t cur_dts;
368
    int last_IP_duration;
369
    int64_t last_IP_pts;
370
    /* av_seek_frame() support */
371
    AVIndexEntry *index_entries; /**< only used if the format does not
372
                                    support seeking natively */
373
    int nb_index_entries;
374
    unsigned int index_entries_allocated_size;
375

    
376
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
377

    
378
#define MAX_REORDER_DELAY 4
379
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
380

    
381
    char *filename; /**< source filename of the stream */
382

    
383
    int disposition; /**< AV_DISPOSITION_* bitfield */
384
} AVStream;
385

    
386
#define AV_PROGRAM_RUNNING 1
387

    
388
/**
389
 * New fields can be added to the end with minor version bumps.
390
 * Removal, reordering and changes to existing fields require a major
391
 * version bump.
392
 * sizeof(AVProgram) must not be used outside libav*.
393
 */
394
typedef struct AVProgram {
395
    int            id;
396
    char           *provider_name; ///< Network name for DVB streams
397
    char           *name;          ///< Service name for DVB streams
398
    int            flags;
399
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
400
    unsigned int   *stream_index;
401
    unsigned int   nb_stream_indexes;
402
} AVProgram;
403

    
404
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
405
                                         (streams are added dynamically) */
406

    
407
typedef struct AVChapter {
408
    int id;                 ///< Unique id to identify the chapter
409
    AVRational time_base;   ///< Timebase in which the start/end timestamps are specified
410
    int64_t start, end;     ///< chapter start/end time in time_base units
411
    char *title;            ///< chapter title
412
} AVChapter;
413

    
414
#define MAX_STREAMS 20
415

    
416
/**
417
 * format I/O context.
418
 * New fields can be added to the end with minor version bumps.
419
 * Removal, reordering and changes to existing fields require a major
420
 * version bump.
421
 * sizeof(AVFormatContext) must not be used outside libav*.
422
 */
423
typedef struct AVFormatContext {
424
    const AVClass *av_class; /**< set by av_alloc_format_context */
425
    /* can only be iformat or oformat, not both at the same time */
426
    struct AVInputFormat *iformat;
427
    struct AVOutputFormat *oformat;
428
    void *priv_data;
429
    ByteIOContext *pb;
430
    unsigned int nb_streams;
431
    AVStream *streams[MAX_STREAMS];
432
    char filename[1024]; /**< input or output filename */
433
    /* stream info */
434
    int64_t timestamp;
435
    char title[512];
436
    char author[512];
437
    char copyright[512];
438
    char comment[512];
439
    char album[512];
440
    int year;  /**< ID3 year, 0 if none */
441
    int track; /**< track number, 0 if none */
442
    char genre[32]; /**< ID3 genre */
443

    
444
    int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
445
    /* private data for pts handling (do not modify directly) */
446
    /** This buffer is only needed when packets were already buffered but
447
       not decoded, for example to get the codec parameters in mpeg
448
       streams */
449
    struct AVPacketList *packet_buffer;
450

    
451
    /** decoding: position of the first frame of the component, in
452
       AV_TIME_BASE fractional seconds. NEVER set this value directly:
453
       it is deduced from the AVStream values.  */
454
    int64_t start_time;
455
    /** decoding: duration of the stream, in AV_TIME_BASE fractional
456
       seconds. NEVER set this value directly: it is deduced from the
457
       AVStream values.  */
458
    int64_t duration;
459
    /** decoding: total file size. 0 if unknown */
460
    int64_t file_size;
461
    /** decoding: total stream bitrate in bit/s, 0 if not
462
       available. Never set it directly if the file_size and the
463
       duration are known as ffmpeg can compute it automatically. */
464
    int bit_rate;
465

    
466
    /* av_read_frame() support */
467
    AVStream *cur_st;
468
    const uint8_t *cur_ptr;
469
    int cur_len;
470
    AVPacket cur_pkt;
471

    
472
    /* av_seek_frame() support */
473
    int64_t data_offset; /** offset of the first packet */
474
    int index_built;
475

    
476
    int mux_rate;
477
    int packet_size;
478
    int preload;
479
    int max_delay;
480

    
481
#define AVFMT_NOOUTPUTLOOP -1
482
#define AVFMT_INFINITEOUTPUTLOOP 0
483
    /** number of times to loop output in formats that support it */
484
    int loop_output;
485

    
486
    int flags;
487
#define AVFMT_FLAG_GENPTS       0x0001 ///< generate pts if missing even if it requires parsing future frames
488
#define AVFMT_FLAG_IGNIDX       0x0002 ///< ignore index
489
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< do not block when reading packets from input
490

    
491
    int loop_input;
492
    /** decoding: size of data to probe; encoding unused */
493
    unsigned int probesize;
494

    
495
    /**
496
     * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
497
     */
498
    int max_analyze_duration;
499

    
500
    const uint8_t *key;
501
    int keylen;
502

    
503
    unsigned int nb_programs;
504
    AVProgram **programs;
505

    
506
    /**
507
     * Forced video codec_id.
508
     * demuxing: set by user
509
     */
510
    enum CodecID video_codec_id;
511
    /**
512
     * Forced audio codec_id.
513
     * demuxing: set by user
514
     */
515
    enum CodecID audio_codec_id;
516
    /**
517
     * Forced subtitle codec_id.
518
     * demuxing: set by user
519
     */
520
    enum CodecID subtitle_codec_id;
521

    
522
    /**
523
     * Maximum amount of memory in bytes to use per stream for the index.
524
     * If the needed index exceeds this size entries will be discarded as
525
     * needed to maintain a smaller size. This can lead to slower or less
526
     * accurate seeking (depends on demuxer).
527
     * Demuxers for which a full in memory index is mandatory will ignore
528
     * this.
529
     * muxing  : unused
530
     * demuxing: set by user
531
     */
532
    unsigned int max_index_size;
533

    
534
    /**
535
     * Maximum amount of memory in bytes to use for buffering frames
536
     * obtained from real-time capture devices.
537
     */
538
    unsigned int max_picture_buffer;
539

    
540
    unsigned int nb_chapters;
541
    AVChapter **chapters;
542
} AVFormatContext;
543

    
544
typedef struct AVPacketList {
545
    AVPacket pkt;
546
    struct AVPacketList *next;
547
} AVPacketList;
548

    
549
#if LIBAVFORMAT_VERSION_INT < (53<<16)
550
extern AVInputFormat *first_iformat;
551
extern AVOutputFormat *first_oformat;
552
#endif
553

    
554
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
555
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
556

    
557
enum CodecID av_guess_image2_codec(const char *filename);
558

    
559
/* XXX: use automatic init with either ELF sections or C file parser */
560
/* modules */
561

    
562
/* utils.c */
563
void av_register_input_format(AVInputFormat *format);
564
void av_register_output_format(AVOutputFormat *format);
565
AVOutputFormat *guess_stream_format(const char *short_name,
566
                                    const char *filename, const char *mime_type);
567
AVOutputFormat *guess_format(const char *short_name,
568
                             const char *filename, const char *mime_type);
569

    
570
/**
571
 * Guesses the codec id based upon muxer and filename.
572
 */
573
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
574
                            const char *filename, const char *mime_type, enum CodecType type);
575

    
576
/**
577
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
578
 *
579
 * @param f The file stream pointer where the dump should be sent to.
580
 * @param buf buffer
581
 * @param size buffer size
582
 *
583
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
584
 */
585
void av_hex_dump(FILE *f, uint8_t *buf, int size);
586

    
587
/**
588
 * Send a nice hexadecimal dump of a buffer to the log.
589
 *
590
 * @param avcl A pointer to an arbitrary struct of which the first field is a
591
 * pointer to an AVClass struct.
592
 * @param level The importance level of the message, lower values signifying
593
 * higher importance.
594
 * @param buf buffer
595
 * @param size buffer size
596
 *
597
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
598
 */
599
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
600

    
601
/**
602
 * Send a nice dump of a packet to the specified file stream.
603
 *
604
 * @param f The file stream pointer where the dump should be sent to.
605
 * @param pkt packet to dump
606
 * @param dump_payload true if the payload must be displayed too
607
 */
608
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
609

    
610
/**
611
 * Send a nice dump of a packet to the log.
612
 *
613
 * @param avcl A pointer to an arbitrary struct of which the first field is a
614
 * pointer to an AVClass struct.
615
 * @param level The importance level of the message, lower values signifying
616
 * higher importance.
617
 * @param pkt packet to dump
618
 * @param dump_payload true if the payload must be displayed too
619
 */
620
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
621

    
622
void av_register_all(void);
623

    
624
/** codec tag <-> codec id */
625
enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
626
unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
627

    
628
/* media file input */
629

    
630
/**
631
 * finds AVInputFormat based on input format's short name.
632
 */
633
AVInputFormat *av_find_input_format(const char *short_name);
634

    
635
/**
636
 * Guess file format.
637
 *
638
 * @param is_opened whether the file is already opened, determines whether
639
 *                  demuxers with or without AVFMT_NOFILE are probed
640
 */
641
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
642

    
643
/**
644
 * Allocates all the structures needed to read an input stream.
645
 *        This does not open the needed codecs for decoding the stream[s].
646
 */
647
int av_open_input_stream(AVFormatContext **ic_ptr,
648
                         ByteIOContext *pb, const char *filename,
649
                         AVInputFormat *fmt, AVFormatParameters *ap);
650

    
651
/**
652
 * Open a media file as input. The codecs are not opened. Only the file
653
 * header (if present) is read.
654
 *
655
 * @param ic_ptr the opened media file handle is put here
656
 * @param filename filename to open.
657
 * @param fmt if non NULL, force the file format to use
658
 * @param buf_size optional buffer size (zero if default is OK)
659
 * @param ap additional parameters needed when opening the file (NULL if default)
660
 * @return 0 if OK. AVERROR_xxx otherwise.
661
 */
662
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
663
                       AVInputFormat *fmt,
664
                       int buf_size,
665
                       AVFormatParameters *ap);
666
/**
667
 * Allocate an AVFormatContext.
668
 * Can be freed with av_free() but do not forget to free everything you
669
 * explicitly allocated as well!
670
 */
671
AVFormatContext *av_alloc_format_context(void);
672

    
673
/**
674
 * Read packets of a media file to get stream information. This
675
 * is useful for file formats with no headers such as MPEG. This
676
 * function also computes the real frame rate in case of mpeg2 repeat
677
 * frame mode.
678
 * The logical file position is not changed by this function;
679
 * examined packets may be buffered for later processing.
680
 *
681
 * @param ic media file handle
682
 * @return >=0 if OK. AVERROR_xxx if error.
683
 * @todo Let user decide somehow what information is needed so we do not waste time getting stuff the user does not need.
684
 */
685
int av_find_stream_info(AVFormatContext *ic);
686

    
687
/**
688
 * Read a transport packet from a media file.
689
 *
690
 * This function is obsolete and should never be used.
691
 * Use av_read_frame() instead.
692
 *
693
 * @param s media file handle
694
 * @param pkt is filled
695
 * @return 0 if OK. AVERROR_xxx if error.
696
 */
697
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
698

    
699
/**
700
 * Return the next frame of a stream.
701
 *
702
 * The returned packet is valid
703
 * until the next av_read_frame() or until av_close_input_file() and
704
 * must be freed with av_free_packet. For video, the packet contains
705
 * exactly one frame. For audio, it contains an integer number of
706
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
707
 * data). If the audio frames have a variable size (e.g. MPEG audio),
708
 * then it contains one frame.
709
 *
710
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
711
 * values in AVStream.timebase units (and guessed if the format cannot
712
 * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
713
 * has B frames, so it is better to rely on pkt->dts if you do not
714
 * decompress the payload.
715
 *
716
 * @return 0 if OK, < 0 if error or end of file.
717
 */
718
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
719

    
720
/**
721
 * Seek to the key frame at timestamp.
722
 * 'timestamp' in 'stream_index'.
723
 * @param stream_index If stream_index is (-1), a default
724
 * stream is selected, and timestamp is automatically converted
725
 * from AV_TIME_BASE units to the stream specific time_base.
726
 * @param timestamp timestamp in AVStream.time_base units
727
 *        or if there is no stream specified then in AV_TIME_BASE units
728
 * @param flags flags which select direction and seeking mode
729
 * @return >= 0 on success
730
 */
731
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
732

    
733
/**
734
 * start playing a network based stream (e.g. RTSP stream) at the
735
 * current position
736
 */
737
int av_read_play(AVFormatContext *s);
738

    
739
/**
740
 * Pause a network based stream (e.g. RTSP stream).
741
 *
742
 * Use av_read_play() to resume it.
743
 */
744
int av_read_pause(AVFormatContext *s);
745

    
746
/**
747
 * Free a AVFormatContext allocated by av_open_input_stream.
748
 * @param s context to free
749
 */
750
void av_close_input_stream(AVFormatContext *s);
751

    
752
/**
753
 * Close a media file (but not its codecs).
754
 *
755
 * @param s media file handle
756
 */
757
void av_close_input_file(AVFormatContext *s);
758

    
759
/**
760
 * Add a new stream to a media file.
761
 *
762
 * Can only be called in the read_header() function. If the flag
763
 * AVFMTCTX_NOHEADER is in the format context, then new streams
764
 * can be added in read_packet too.
765
 *
766
 * @param s media file handle
767
 * @param id file format dependent stream id
768
 */
769
AVStream *av_new_stream(AVFormatContext *s, int id);
770
AVProgram *av_new_program(AVFormatContext *s, int id);
771

    
772
/**
773
 * Add a new chapter.
774
 * This function is NOT part of the public API
775
 * and should be ONLY used by demuxers.
776
 *
777
 * @param s media file handle
778
 * @param id unique id for this chapter
779
 * @param start chapter start time in time_base units
780
 * @param end chapter end time in time_base units
781
 * @param title chapter title
782
 *
783
 * @return AVChapter or NULL if error.
784
 */
785
AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base, int64_t start, int64_t end, const char *title);
786

    
787
/**
788
 * Set the pts for a given stream.
789
 *
790
 * @param s stream
791
 * @param pts_wrap_bits number of bits effectively used by the pts
792
 *        (used for wrap control, 33 is the value for MPEG)
793
 * @param pts_num numerator to convert to seconds (MPEG: 1)
794
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
795
 */
796
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
797
                     int pts_num, int pts_den);
798

    
799
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
800
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
801
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non keyframes
802

    
803
int av_find_default_stream_index(AVFormatContext *s);
804

    
805
/**
806
 * Gets the index for a specific timestamp.
807
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
808
 *                 the timestamp which is <= the requested one, if backward is 0
809
 *                 then it will be >=
810
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
811
 * @return < 0 if no such timestamp could be found
812
 */
813
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
814

    
815
/**
816
 * Ensures the index uses less memory than the maximum specified in
817
 * AVFormatContext.max_index_size, by discarding entries if it grows
818
 * too large.
819
 * This function is not part of the public API and should only be called
820
 * by demuxers.
821
 */
822
void ff_reduce_index(AVFormatContext *s, int stream_index);
823

    
824
/**
825
 * Add a index entry into a sorted list updateing if it is already there.
826
 *
827
 * @param timestamp timestamp in the timebase of the given stream
828
 */
829
int av_add_index_entry(AVStream *st,
830
                       int64_t pos, int64_t timestamp, int size, int distance, int flags);
831

    
832
/**
833
 * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
834
 * This is not supposed to be called directly by a user application, but by demuxers.
835
 * @param target_ts target timestamp in the time base of the given stream
836
 * @param stream_index stream number
837
 */
838
int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
839

    
840
/**
841
 * Updates cur_dts of all streams based on given timestamp and AVStream.
842
 *
843
 * Stream ref_st unchanged, others set cur_dts in their native timebase
844
 * only needed for timestamp wrapping or if (dts not set and pts!=dts).
845
 * @param timestamp new dts expressed in time_base of param ref_st
846
 * @param ref_st reference stream giving time_base of param timestamp
847
 */
848
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
849

    
850
/**
851
 * Does a binary search using read_timestamp().
852
 * This is not supposed to be called directly by a user application, but by demuxers.
853
 * @param target_ts target timestamp in the time base of the given stream
854
 * @param stream_index stream number
855
 */
856
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 ));
857

    
858
/** media file output */
859
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
860

    
861
/**
862
 * Allocate the stream private data and write the stream header to an
863
 * output media file.
864
 *
865
 * @param s media file handle
866
 * @return 0 if OK. AVERROR_xxx if error.
867
 */
868
int av_write_header(AVFormatContext *s);
869

    
870
/**
871
 * Write a packet to an output media file.
872
 *
873
 * The packet shall contain one audio or video frame.
874
 * The packet must be correctly interleaved according to the container specification,
875
 * if not then av_interleaved_write_frame must be used
876
 *
877
 * @param s media file handle
878
 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
879
 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
880
 */
881
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
882

    
883
/**
884
 * Writes a packet to an output media file ensuring correct interleaving.
885
 *
886
 * The packet must contain one audio or video frame.
887
 * If the packets are already correctly interleaved the application should
888
 * call av_write_frame() instead as it is slightly faster. It is also important
889
 * to keep in mind that completely non-interleaved input will need huge amounts
890
 * of memory to interleave with this, so it is preferable to interleave at the
891
 * demuxer level.
892
 *
893
 * @param s media file handle
894
 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
895
 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
896
 */
897
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
898

    
899
/**
900
 * Interleave a packet per DTS in an output media file.
901
 *
902
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this function,
903
 * so they cannot be used after it, note calling av_free_packet() on them is still safe.
904
 *
905
 * @param s media file handle
906
 * @param out the interleaved packet will be output here
907
 * @param in the input packet
908
 * @param flush 1 if no further packets are available as input and all
909
 *              remaining packets should be output
910
 * @return 1 if a packet was output, 0 if no packet could be output,
911
 *         < 0 if an error occurred
912
 */
913
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
914

    
915
/**
916
 * @brief Write the stream trailer to an output media file and
917
 *        free the file private data.
918
 *
919
 * @param s media file handle
920
 * @return 0 if OK. AVERROR_xxx if error.
921
 */
922
int av_write_trailer(AVFormatContext *s);
923

    
924
void dump_format(AVFormatContext *ic,
925
                 int index,
926
                 const char *url,
927
                 int is_output);
928

    
929
/**
930
 * parses width and height out of string str.
931
 * @deprecated Use av_parse_video_frame_size instead.
932
 */
933
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
934

    
935
/**
936
 * Converts frame rate from string to a fraction.
937
 * @deprecated Use av_parse_video_frame_rate instead.
938
 */
939
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
940

    
941
/**
942
 * Parses \p datestr and returns a corresponding number of microseconds.
943
 * @param datestr String representing a date or a duration.
944
 * - If a date the syntax is:
945
 * @code
946
 *  [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
947
 * @endcode
948
 * Time is localtime unless Z is appended, in which case it is
949
 * interpreted as UTC.
950
 * If the year-month-day part isn't specified it takes the current
951
 * year-month-day.
952
 * Returns the number of microseconds since 1st of January, 1970 up to
953
 * the time of the parsed date or INT64_MIN if \p datestr cannot be
954
 * successfully parsed.
955
 * - If a duration the syntax is:
956
 * @code
957
 *  [-]HH[:MM[:SS[.m...]]]
958
 *  [-]S+[.m...]
959
 * @endcode
960
 * Returns the number of microseconds contained in a time interval
961
 * with the specified duration or INT64_MIN if \p datestr cannot be
962
 * successfully parsed.
963
 * @param duration Flag which tells how to interpret \p datestr, if
964
 * not zero \p datestr is interpreted as a duration, otherwise as a
965
 * date.
966
 */
967
int64_t parse_date(const char *datestr, int duration);
968

    
969
int64_t av_gettime(void);
970

    
971
/* ffm specific for ffserver */
972
#define FFM_PACKET_SIZE 4096
973
offset_t ffm_read_write_index(int fd);
974
void ffm_write_write_index(int fd, offset_t pos);
975
void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
976

    
977
/**
978
 * Attempts to find a specific tag in a URL.
979
 *
980
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
981
 * Return 1 if found.
982
 */
983
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
984

    
985
/**
986
 * Returns in 'buf' the path with '%d' replaced by number.
987

988
 * Also handles the '%0nd' format where 'n' is the total number
989
 * of digits and '%%'.
990
 *
991
 * @param buf destination buffer
992
 * @param buf_size destination buffer size
993
 * @param path numbered sequence string
994
 * @param number frame number
995
 * @return 0 if OK, -1 if format error.
996
 */
997
int av_get_frame_filename(char *buf, int buf_size,
998
                          const char *path, int number);
999

    
1000
/**
1001
 * Check whether filename actually is a numbered sequence generator.
1002
 *
1003
 * @param filename possible numbered sequence string
1004
 * @return 1 if a valid numbered sequence string, 0 otherwise.
1005
 */
1006
int av_filename_number_test(const char *filename);
1007

    
1008
/**
1009
 * Generate an SDP for an RTP session.
1010
 *
1011
 * @param ac array of AVFormatContexts describing the RTP streams. If the
1012
 *           array is composed by only one context, such context can contain
1013
 *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1014
 *           all the contexts in the array (an AVCodecContext per RTP stream)
1015
 *           must contain only one AVStream
1016
 * @param n_files number of AVCodecContexts contained in ac
1017
 * @param buff buffer where the SDP will be stored (must be allocated by
1018
 *             the caller
1019
 * @param size the size of the buffer
1020
 * @return 0 if OK. AVERROR_xxx if error.
1021
 */
1022
int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1023

    
1024
#ifdef HAVE_AV_CONFIG_H
1025

    
1026
void ff_dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
1027

    
1028
#ifdef __GNUC__
1029
#define dynarray_add(tab, nb_ptr, elem)\
1030
do {\
1031
    typeof(tab) _tab = (tab);\
1032
    typeof(elem) _elem = (elem);\
1033
    (void)sizeof(**_tab == _elem); /* check that types are compatible */\
1034
    ff_dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
1035
} while(0)
1036
#else
1037
#define dynarray_add(tab, nb_ptr, elem)\
1038
do {\
1039
    ff_dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
1040
} while(0)
1041
#endif
1042

    
1043
time_t mktimegm(struct tm *tm);
1044
struct tm *brktimegm(time_t secs, struct tm *tm);
1045
const char *small_strptime(const char *p, const char *fmt,
1046
                           struct tm *dt);
1047

    
1048
struct in_addr;
1049
int resolve_host(struct in_addr *sin_addr, const char *hostname);
1050

    
1051
void url_split(char *proto, int proto_size,
1052
               char *authorization, int authorization_size,
1053
               char *hostname, int hostname_size,
1054
               int *port_ptr,
1055
               char *path, int path_size,
1056
               const char *url);
1057

    
1058
int match_ext(const char *filename, const char *extensions);
1059

    
1060
#endif /* HAVE_AV_CONFIG_H */
1061

    
1062
#endif /* FFMPEG_AVFORMAT_H */