Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 5c5b1731

History | View | Annotate | Download (38.1 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 19
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
    unsigned int mpeg2ts_raw:1;  /**< force raw MPEG2 transport stream output, if possible */
164
    unsigned int mpeg2ts_compute_pcr:1; /**< compute exact PCR for each transport
165
                                            stream packet (only meaningful if
166
                                            mpeg2ts_raw is TRUE) */
167
    unsigned int initial_pause:1;       /**< do not begin to play the stream
168
                                            immediately (RTSP only) */
169
    unsigned 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
    /**
189
     * Descriptive name for the format, meant to be more human-readable
190
     * than \p name. You \e should use the NULL_IF_CONFIG_SMALL() macro
191
     * to define it.
192
     */
193
    const char *long_name;
194
    const char *mime_type;
195
    const char *extensions; /**< comma separated filename extensions */
196
    /** size of private data so that it can be allocated in the wrapper */
197
    int priv_data_size;
198
    /* output support */
199
    enum CodecID audio_codec; /**< default audio codec */
200
    enum CodecID video_codec; /**< default video codec */
201
    int (*write_header)(struct AVFormatContext *);
202
    int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
203
    int (*write_trailer)(struct AVFormatContext *);
204
    /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
205
    int flags;
206
    /** currently only used to set pixel format if not YUV420P */
207
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
208
    int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
209

    
210
    /**
211
     * list of supported codec_id-codec_tag pairs, ordered by "better choice first"
212
     * the arrays are all CODEC_ID_NONE terminated
213
     */
214
    const struct AVCodecTag **codec_tag;
215

    
216
    enum CodecID subtitle_codec; /**< default subtitle codec */
217

    
218
    /* private fields */
219
    struct AVOutputFormat *next;
220
} AVOutputFormat;
221

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

    
276
    /** start/resume playing - only meaningful if using a network based format
277
       (RTSP) */
278
    int (*read_play)(struct AVFormatContext *);
279

    
280
    /** pause playing - only meaningful if using a network based format
281
       (RTSP) */
282
    int (*read_pause)(struct AVFormatContext *);
283

    
284
    const struct AVCodecTag **codec_tag;
285

    
286
    /* private fields */
287
    struct AVInputFormat *next;
288
} AVInputFormat;
289

    
290
enum AVStreamParseType {
291
    AVSTREAM_PARSE_NONE,
292
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
293
    AVSTREAM_PARSE_HEADERS,    /**< only parse headers, don't repack */
294
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on packet boundary */
295
};
296

    
297
typedef struct AVIndexEntry {
298
    int64_t pos;
299
    int64_t timestamp;
300
#define AVINDEX_KEYFRAME 0x0001
301
    int flags:2;
302
    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).
303
    int min_distance;         /**< min distance between this and the previous keyframe, used to avoid unneeded searching */
304
} AVIndexEntry;
305

    
306
#define AV_DISPOSITION_DEFAULT   0x0001
307
#define AV_DISPOSITION_DUB       0x0002
308
#define AV_DISPOSITION_ORIGINAL  0x0004
309
#define AV_DISPOSITION_COMMENT   0x0008
310
#define AV_DISPOSITION_LYRICS    0x0010
311
#define AV_DISPOSITION_KARAOKE   0x0020
312

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

    
335
    /* internal data used in av_find_stream_info() */
336
    int64_t first_dts;
337
    /** encoding: PTS generation when outputing stream */
338
    struct AVFrac pts;
339

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

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

    
373
    /* av_read_frame() support */
374
    enum AVStreamParseType need_parsing;
375
    struct AVCodecParserContext *parser;
376

    
377
    int64_t cur_dts;
378
    int last_IP_duration;
379
    int64_t last_IP_pts;
380
    /* av_seek_frame() support */
381
    AVIndexEntry *index_entries; /**< only used if the format does not
382
                                    support seeking natively */
383
    int nb_index_entries;
384
    unsigned int index_entries_allocated_size;
385

    
386
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
387

    
388
#define MAX_REORDER_DELAY 4
389
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
390

    
391
    char *filename; /**< source filename of the stream */
392

    
393
    int disposition; /**< AV_DISPOSITION_* bitfield */
394

    
395
    AVProbeData probe_data;
396
} AVStream;
397

    
398
#define AV_PROGRAM_RUNNING 1
399

    
400
/**
401
 * New fields can be added to the end with minor version bumps.
402
 * Removal, reordering and changes to existing fields require a major
403
 * version bump.
404
 * sizeof(AVProgram) must not be used outside libav*.
405
 */
406
typedef struct AVProgram {
407
    int            id;
408
    char           *provider_name; ///< Network name for DVB streams
409
    char           *name;          ///< Service name for DVB streams
410
    int            flags;
411
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
412
    unsigned int   *stream_index;
413
    unsigned int   nb_stream_indexes;
414
} AVProgram;
415

    
416
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
417
                                         (streams are added dynamically) */
418

    
419
typedef struct AVChapter {
420
    int id;                 ///< Unique id to identify the chapter
421
    AVRational time_base;   ///< Timebase in which the start/end timestamps are specified
422
    int64_t start, end;     ///< chapter start/end time in time_base units
423
    char *title;            ///< chapter title
424
} AVChapter;
425

    
426
#define MAX_STREAMS 20
427

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

    
456
    int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
457
    /* private data for pts handling (do not modify directly) */
458
    /** This buffer is only needed when packets were already buffered but
459
       not decoded, for example to get the codec parameters in mpeg
460
       streams */
461
    struct AVPacketList *packet_buffer;
462

    
463
    /** decoding: position of the first frame of the component, in
464
       AV_TIME_BASE fractional seconds. NEVER set this value directly:
465
       it is deduced from the AVStream values.  */
466
    int64_t start_time;
467
    /** decoding: duration of the stream, in AV_TIME_BASE fractional
468
       seconds. NEVER set this value directly: it is deduced from the
469
       AVStream values.  */
470
    int64_t duration;
471
    /** decoding: total file size. 0 if unknown */
472
    int64_t file_size;
473
    /** decoding: total stream bitrate in bit/s, 0 if not
474
       available. Never set it directly if the file_size and the
475
       duration are known as ffmpeg can compute it automatically. */
476
    int bit_rate;
477

    
478
    /* av_read_frame() support */
479
    AVStream *cur_st;
480
    const uint8_t *cur_ptr;
481
    int cur_len;
482
    AVPacket cur_pkt;
483

    
484
    /* av_seek_frame() support */
485
    int64_t data_offset; /** offset of the first packet */
486
    int index_built;
487

    
488
    int mux_rate;
489
    int packet_size;
490
    int preload;
491
    int max_delay;
492

    
493
#define AVFMT_NOOUTPUTLOOP -1
494
#define AVFMT_INFINITEOUTPUTLOOP 0
495
    /** number of times to loop output in formats that support it */
496
    int loop_output;
497

    
498
    int flags;
499
#define AVFMT_FLAG_GENPTS       0x0001 ///< generate pts if missing even if it requires parsing future frames
500
#define AVFMT_FLAG_IGNIDX       0x0002 ///< ignore index
501
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< do not block when reading packets from input
502

    
503
    int loop_input;
504
    /** decoding: size of data to probe; encoding unused */
505
    unsigned int probesize;
506

    
507
    /**
508
     * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
509
     */
510
    int max_analyze_duration;
511

    
512
    const uint8_t *key;
513
    int keylen;
514

    
515
    unsigned int nb_programs;
516
    AVProgram **programs;
517

    
518
    /**
519
     * Forced video codec_id.
520
     * demuxing: set by user
521
     */
522
    enum CodecID video_codec_id;
523
    /**
524
     * Forced audio codec_id.
525
     * demuxing: set by user
526
     */
527
    enum CodecID audio_codec_id;
528
    /**
529
     * Forced subtitle codec_id.
530
     * demuxing: set by user
531
     */
532
    enum CodecID subtitle_codec_id;
533

    
534
    /**
535
     * Maximum amount of memory in bytes to use per stream for the index.
536
     * If the needed index exceeds this size entries will be discarded as
537
     * needed to maintain a smaller size. This can lead to slower or less
538
     * accurate seeking (depends on demuxer).
539
     * Demuxers for which a full in memory index is mandatory will ignore
540
     * this.
541
     * muxing  : unused
542
     * demuxing: set by user
543
     */
544
    unsigned int max_index_size;
545

    
546
    /**
547
     * Maximum amount of memory in bytes to use for buffering frames
548
     * obtained from real-time capture devices.
549
     */
550
    unsigned int max_picture_buffer;
551

    
552
    unsigned int nb_chapters;
553
    AVChapter **chapters;
554

    
555
    /**
556
     * Flags to enable debuging.
557
     */
558
    int debug;
559
#define FF_FDEBUG_TS        0x0001
560

    
561
    /**
562
     * raw packets from the demuxer, prior to parsing and decoding.
563
     * This buffer is used for buffering packets until the codec can
564
     * be identified, as parsing cannot be done without knowing the
565
     * codec.
566
     */
567
    struct AVPacketList *raw_packet_buffer;
568
    struct AVPacketList *raw_packet_buffer_end;
569

    
570
    struct AVPacketList *packet_buffer_end;
571
} AVFormatContext;
572

    
573
typedef struct AVPacketList {
574
    AVPacket pkt;
575
    struct AVPacketList *next;
576
} AVPacketList;
577

    
578
#if LIBAVFORMAT_VERSION_INT < (53<<16)
579
extern AVInputFormat *first_iformat;
580
extern AVOutputFormat *first_oformat;
581
#endif
582

    
583
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
584
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
585

    
586
enum CodecID av_guess_image2_codec(const char *filename);
587

    
588
/* XXX: use automatic init with either ELF sections or C file parser */
589
/* modules */
590

    
591
/* utils.c */
592
void av_register_input_format(AVInputFormat *format);
593
void av_register_output_format(AVOutputFormat *format);
594
AVOutputFormat *guess_stream_format(const char *short_name,
595
                                    const char *filename, const char *mime_type);
596
AVOutputFormat *guess_format(const char *short_name,
597
                             const char *filename, const char *mime_type);
598

    
599
/**
600
 * Guesses the codec id based upon muxer and filename.
601
 */
602
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
603
                            const char *filename, const char *mime_type, enum CodecType type);
604

    
605
/**
606
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
607
 *
608
 * @param f The file stream pointer where the dump should be sent to.
609
 * @param buf buffer
610
 * @param size buffer size
611
 *
612
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
613
 */
614
void av_hex_dump(FILE *f, uint8_t *buf, int size);
615

    
616
/**
617
 * Send a nice hexadecimal dump of a buffer to the log.
618
 *
619
 * @param avcl A pointer to an arbitrary struct of which the first field is a
620
 * pointer to an AVClass struct.
621
 * @param level The importance level of the message, lower values signifying
622
 * higher importance.
623
 * @param buf buffer
624
 * @param size buffer size
625
 *
626
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
627
 */
628
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
629

    
630
/**
631
 * Send a nice dump of a packet to the specified file stream.
632
 *
633
 * @param f The file stream pointer where the dump should be sent to.
634
 * @param pkt packet to dump
635
 * @param dump_payload true if the payload must be displayed too
636
 */
637
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
638

    
639
/**
640
 * Send a nice dump of a packet to the log.
641
 *
642
 * @param avcl A pointer to an arbitrary struct of which the first field is a
643
 * pointer to an AVClass struct.
644
 * @param level The importance level of the message, lower values signifying
645
 * higher importance.
646
 * @param pkt packet to dump
647
 * @param dump_payload true if the payload must be displayed too
648
 */
649
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
650

    
651
void av_register_all(void);
652

    
653
/** codec tag <-> codec id */
654
enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
655
unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
656

    
657
/* media file input */
658

    
659
/**
660
 * finds AVInputFormat based on input format's short name.
661
 */
662
AVInputFormat *av_find_input_format(const char *short_name);
663

    
664
/**
665
 * Guess file format.
666
 *
667
 * @param is_opened whether the file is already opened, determines whether
668
 *                  demuxers with or without AVFMT_NOFILE are probed
669
 */
670
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
671

    
672
/**
673
 * Allocates all the structures needed to read an input stream.
674
 *        This does not open the needed codecs for decoding the stream[s].
675
 */
676
int av_open_input_stream(AVFormatContext **ic_ptr,
677
                         ByteIOContext *pb, const char *filename,
678
                         AVInputFormat *fmt, AVFormatParameters *ap);
679

    
680
/**
681
 * Open a media file as input. The codecs are not opened. Only the file
682
 * header (if present) is read.
683
 *
684
 * @param ic_ptr the opened media file handle is put here
685
 * @param filename filename to open.
686
 * @param fmt if non NULL, force the file format to use
687
 * @param buf_size optional buffer size (zero if default is OK)
688
 * @param ap additional parameters needed when opening the file (NULL if default)
689
 * @return 0 if OK. AVERROR_xxx otherwise.
690
 */
691
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
692
                       AVInputFormat *fmt,
693
                       int buf_size,
694
                       AVFormatParameters *ap);
695
/**
696
 * Allocate an AVFormatContext.
697
 * Can be freed with av_free() but do not forget to free everything you
698
 * explicitly allocated as well!
699
 */
700
AVFormatContext *av_alloc_format_context(void);
701

    
702
/**
703
 * Read packets of a media file to get stream information. This
704
 * is useful for file formats with no headers such as MPEG. This
705
 * function also computes the real frame rate in case of mpeg2 repeat
706
 * frame mode.
707
 * The logical file position is not changed by this function;
708
 * examined packets may be buffered for later processing.
709
 *
710
 * @param ic media file handle
711
 * @return >=0 if OK. AVERROR_xxx if error.
712
 * @todo Let user decide somehow what information is needed so we do not waste time getting stuff the user does not need.
713
 */
714
int av_find_stream_info(AVFormatContext *ic);
715

    
716
/**
717
 * Read a transport packet from a media file.
718
 *
719
 * This function is obsolete and should never be used.
720
 * Use av_read_frame() instead.
721
 *
722
 * @param s media file handle
723
 * @param pkt is filled
724
 * @return 0 if OK. AVERROR_xxx if error.
725
 */
726
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
727

    
728
/**
729
 * Return the next frame of a stream.
730
 *
731
 * The returned packet is valid
732
 * until the next av_read_frame() or until av_close_input_file() and
733
 * must be freed with av_free_packet. For video, the packet contains
734
 * exactly one frame. For audio, it contains an integer number of
735
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
736
 * data). If the audio frames have a variable size (e.g. MPEG audio),
737
 * then it contains one frame.
738
 *
739
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
740
 * values in AVStream.timebase units (and guessed if the format cannot
741
 * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
742
 * has B frames, so it is better to rely on pkt->dts if you do not
743
 * decompress the payload.
744
 *
745
 * @return 0 if OK, < 0 if error or end of file.
746
 */
747
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
748

    
749
/**
750
 * Seek to the key frame at timestamp.
751
 * 'timestamp' in 'stream_index'.
752
 * @param stream_index If stream_index is (-1), a default
753
 * stream is selected, and timestamp is automatically converted
754
 * from AV_TIME_BASE units to the stream specific time_base.
755
 * @param timestamp timestamp in AVStream.time_base units
756
 *        or if there is no stream specified then in AV_TIME_BASE units
757
 * @param flags flags which select direction and seeking mode
758
 * @return >= 0 on success
759
 */
760
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
761

    
762
/**
763
 * start playing a network based stream (e.g. RTSP stream) at the
764
 * current position
765
 */
766
int av_read_play(AVFormatContext *s);
767

    
768
/**
769
 * Pause a network based stream (e.g. RTSP stream).
770
 *
771
 * Use av_read_play() to resume it.
772
 */
773
int av_read_pause(AVFormatContext *s);
774

    
775
/**
776
 * Free a AVFormatContext allocated by av_open_input_stream.
777
 * @param s context to free
778
 */
779
void av_close_input_stream(AVFormatContext *s);
780

    
781
/**
782
 * Close a media file (but not its codecs).
783
 *
784
 * @param s media file handle
785
 */
786
void av_close_input_file(AVFormatContext *s);
787

    
788
/**
789
 * Add a new stream to a media file.
790
 *
791
 * Can only be called in the read_header() function. If the flag
792
 * AVFMTCTX_NOHEADER is in the format context, then new streams
793
 * can be added in read_packet too.
794
 *
795
 * @param s media file handle
796
 * @param id file format dependent stream id
797
 */
798
AVStream *av_new_stream(AVFormatContext *s, int id);
799
AVProgram *av_new_program(AVFormatContext *s, int id);
800

    
801
/**
802
 * Add a new chapter.
803
 * This function is NOT part of the public API
804
 * and should be ONLY used by demuxers.
805
 *
806
 * @param s media file handle
807
 * @param id unique id for this chapter
808
 * @param start chapter start time in time_base units
809
 * @param end chapter end time in time_base units
810
 * @param title chapter title
811
 *
812
 * @return AVChapter or NULL if error.
813
 */
814
AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base, int64_t start, int64_t end, const char *title);
815

    
816
/**
817
 * Set the pts for a given stream.
818
 *
819
 * @param s stream
820
 * @param pts_wrap_bits number of bits effectively used by the pts
821
 *        (used for wrap control, 33 is the value for MPEG)
822
 * @param pts_num numerator to convert to seconds (MPEG: 1)
823
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
824
 */
825
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
826
                     int pts_num, int pts_den);
827

    
828
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
829
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
830
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non keyframes
831

    
832
int av_find_default_stream_index(AVFormatContext *s);
833

    
834
/**
835
 * Gets the index for a specific timestamp.
836
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
837
 *                 the timestamp which is <= the requested one, if backward is 0
838
 *                 then it will be >=
839
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
840
 * @return < 0 if no such timestamp could be found
841
 */
842
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
843

    
844
/**
845
 * Ensures the index uses less memory than the maximum specified in
846
 * AVFormatContext.max_index_size, by discarding entries if it grows
847
 * too large.
848
 * This function is not part of the public API and should only be called
849
 * by demuxers.
850
 */
851
void ff_reduce_index(AVFormatContext *s, int stream_index);
852

    
853
/**
854
 * Add a index entry into a sorted list updateing if it is already there.
855
 *
856
 * @param timestamp timestamp in the timebase of the given stream
857
 */
858
int av_add_index_entry(AVStream *st,
859
                       int64_t pos, int64_t timestamp, int size, int distance, int flags);
860

    
861
/**
862
 * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
863
 * This is not supposed to be called directly by a user application, but by demuxers.
864
 * @param target_ts target timestamp in the time base of the given stream
865
 * @param stream_index stream number
866
 */
867
int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
868

    
869
/**
870
 * Updates cur_dts of all streams based on given timestamp and AVStream.
871
 *
872
 * Stream ref_st unchanged, others set cur_dts in their native timebase
873
 * only needed for timestamp wrapping or if (dts not set and pts!=dts).
874
 * @param timestamp new dts expressed in time_base of param ref_st
875
 * @param ref_st reference stream giving time_base of param timestamp
876
 */
877
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
878

    
879
/**
880
 * Does a binary search using read_timestamp().
881
 * This is not supposed to be called directly by a user application, but by demuxers.
882
 * @param target_ts target timestamp in the time base of the given stream
883
 * @param stream_index stream number
884
 */
885
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 ));
886

    
887
/** media file output */
888
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
889

    
890
/**
891
 * Allocate the stream private data and write the stream header to an
892
 * output media file.
893
 *
894
 * @param s media file handle
895
 * @return 0 if OK. AVERROR_xxx if error.
896
 */
897
int av_write_header(AVFormatContext *s);
898

    
899
/**
900
 * Write a packet to an output media file.
901
 *
902
 * The packet shall contain one audio or video frame.
903
 * The packet must be correctly interleaved according to the container specification,
904
 * if not then av_interleaved_write_frame must be used
905
 *
906
 * @param s media file handle
907
 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
908
 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
909
 */
910
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
911

    
912
/**
913
 * Writes a packet to an output media file ensuring correct interleaving.
914
 *
915
 * The packet must contain one audio or video frame.
916
 * If the packets are already correctly interleaved the application should
917
 * call av_write_frame() instead as it is slightly faster. It is also important
918
 * to keep in mind that completely non-interleaved input will need huge amounts
919
 * of memory to interleave with this, so it is preferable to interleave at the
920
 * demuxer level.
921
 *
922
 * @param s media file handle
923
 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
924
 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
925
 */
926
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
927

    
928
/**
929
 * Interleave a packet per DTS in an output media file.
930
 *
931
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this function,
932
 * so they cannot be used after it, note calling av_free_packet() on them is still safe.
933
 *
934
 * @param s media file handle
935
 * @param out the interleaved packet will be output here
936
 * @param in the input packet
937
 * @param flush 1 if no further packets are available as input and all
938
 *              remaining packets should be output
939
 * @return 1 if a packet was output, 0 if no packet could be output,
940
 *         < 0 if an error occurred
941
 */
942
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
943

    
944
/**
945
 * @brief Write the stream trailer to an output media file and
946
 *        free the file private data.
947
 *
948
 * @param s media file handle
949
 * @return 0 if OK. AVERROR_xxx if error.
950
 */
951
int av_write_trailer(AVFormatContext *s);
952

    
953
void dump_format(AVFormatContext *ic,
954
                 int index,
955
                 const char *url,
956
                 int is_output);
957

    
958
/**
959
 * parses width and height out of string str.
960
 * @deprecated Use av_parse_video_frame_size instead.
961
 */
962
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
963

    
964
/**
965
 * Converts frame rate from string to a fraction.
966
 * @deprecated Use av_parse_video_frame_rate instead.
967
 */
968
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
969

    
970
/**
971
 * Parses \p datestr and returns a corresponding number of microseconds.
972
 * @param datestr String representing a date or a duration.
973
 * - If a date the syntax is:
974
 * @code
975
 *  [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
976
 * @endcode
977
 * Time is localtime unless Z is appended, in which case it is
978
 * interpreted as UTC.
979
 * If the year-month-day part isn't specified it takes the current
980
 * year-month-day.
981
 * Returns the number of microseconds since 1st of January, 1970 up to
982
 * the time of the parsed date or INT64_MIN if \p datestr cannot be
983
 * successfully parsed.
984
 * - If a duration the syntax is:
985
 * @code
986
 *  [-]HH[:MM[:SS[.m...]]]
987
 *  [-]S+[.m...]
988
 * @endcode
989
 * Returns the number of microseconds contained in a time interval
990
 * with the specified duration or INT64_MIN if \p datestr cannot be
991
 * successfully parsed.
992
 * @param duration Flag which tells how to interpret \p datestr, if
993
 * not zero \p datestr is interpreted as a duration, otherwise as a
994
 * date.
995
 */
996
int64_t parse_date(const char *datestr, int duration);
997

    
998
int64_t av_gettime(void);
999

    
1000
/* ffm specific for ffserver */
1001
#define FFM_PACKET_SIZE 4096
1002
offset_t ffm_read_write_index(int fd);
1003
void ffm_write_write_index(int fd, offset_t pos);
1004
void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
1005

    
1006
/**
1007
 * Attempts to find a specific tag in a URL.
1008
 *
1009
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1010
 * Return 1 if found.
1011
 */
1012
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1013

    
1014
/**
1015
 * Returns in 'buf' the path with '%d' replaced by number.
1016

1017
 * Also handles the '%0nd' format where 'n' is the total number
1018
 * of digits and '%%'.
1019
 *
1020
 * @param buf destination buffer
1021
 * @param buf_size destination buffer size
1022
 * @param path numbered sequence string
1023
 * @param number frame number
1024
 * @return 0 if OK, -1 if format error.
1025
 */
1026
int av_get_frame_filename(char *buf, int buf_size,
1027
                          const char *path, int number);
1028

    
1029
/**
1030
 * Check whether filename actually is a numbered sequence generator.
1031
 *
1032
 * @param filename possible numbered sequence string
1033
 * @return 1 if a valid numbered sequence string, 0 otherwise.
1034
 */
1035
int av_filename_number_test(const char *filename);
1036

    
1037
/**
1038
 * Generate an SDP for an RTP session.
1039
 *
1040
 * @param ac array of AVFormatContexts describing the RTP streams. If the
1041
 *           array is composed by only one context, such context can contain
1042
 *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1043
 *           all the contexts in the array (an AVCodecContext per RTP stream)
1044
 *           must contain only one AVStream
1045
 * @param n_files number of AVCodecContexts contained in ac
1046
 * @param buff buffer where the SDP will be stored (must be allocated by
1047
 *             the caller
1048
 * @param size the size of the buffer
1049
 * @return 0 if OK. AVERROR_xxx if error.
1050
 */
1051
int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1052

    
1053
#ifdef HAVE_AV_CONFIG_H
1054

    
1055
void ff_dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
1056

    
1057
#ifdef __GNUC__
1058
#define dynarray_add(tab, nb_ptr, elem)\
1059
do {\
1060
    typeof(tab) _tab = (tab);\
1061
    typeof(elem) _elem = (elem);\
1062
    (void)sizeof(**_tab == _elem); /* check that types are compatible */\
1063
    ff_dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
1064
} while(0)
1065
#else
1066
#define dynarray_add(tab, nb_ptr, elem)\
1067
do {\
1068
    ff_dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
1069
} while(0)
1070
#endif
1071

    
1072
time_t mktimegm(struct tm *tm);
1073
struct tm *brktimegm(time_t secs, struct tm *tm);
1074
const char *small_strptime(const char *p, const char *fmt,
1075
                           struct tm *dt);
1076

    
1077
struct in_addr;
1078
int resolve_host(struct in_addr *sin_addr, const char *hostname);
1079

    
1080
void url_split(char *proto, int proto_size,
1081
               char *authorization, int authorization_size,
1082
               char *hostname, int hostname_size,
1083
               int *port_ptr,
1084
               char *path, int path_size,
1085
               const char *url);
1086

    
1087
int match_ext(const char *filename, const char *extensions);
1088

    
1089
#endif /* HAVE_AV_CONFIG_H */
1090

    
1091
#endif /* FFMPEG_AVFORMAT_H */