Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ a7eb3c8d

History | View | Annotate | Download (19 KB)

1
#ifndef AVFORMAT_H
2
#define AVFORMAT_H
3

    
4
#ifdef __cplusplus
5
extern "C" {
6
#endif
7

    
8
#define LIBAVFORMAT_BUILD       4611
9

    
10
#define LIBAVFORMAT_VERSION_INT FFMPEG_VERSION_INT
11
#define LIBAVFORMAT_VERSION     FFMPEG_VERSION
12
#define LIBAVFORMAT_IDENT        "FFmpeg" FFMPEG_VERSION "b" AV_STRINGIFY(LIBAVFORMAT_BUILD)
13

    
14
#include <time.h>
15
#include <stdio.h>  /* FILE */
16
#include "avcodec.h"
17

    
18
#include "avio.h"
19

    
20
/* packet functions */
21

    
22
#ifndef MAXINT64
23
#define MAXINT64 int64_t_C(0x7fffffffffffffff)
24
#endif
25

    
26
#ifndef MININT64
27
#define MININT64 int64_t_C(0x8000000000000000)
28
#endif
29

    
30
#define AV_NOPTS_VALUE MININT64
31
#define AV_TIME_BASE 1000000
32

    
33
typedef struct AVPacket {
34
    int64_t pts; /* presentation time stamp in AV_TIME_BASE units (or
35
                    pts_den units in muxers or demuxers) */
36
    int64_t dts; /* decompression time stamp in AV_TIME_BASE units (or
37
                    pts_den units in muxers or demuxers) */
38
    uint8_t *data;
39
    int   size;
40
    int   stream_index;
41
    int   flags;
42
    int   duration; /* presentation duration (0 if not available) */
43
    void  (*destruct)(struct AVPacket *);
44
    void  *priv;
45
} AVPacket; 
46
#define PKT_FLAG_KEY   0x0001
47

    
48
/* initialize optional fields of a packet */
49
static inline void av_init_packet(AVPacket *pkt)
50
{
51
    pkt->pts   = AV_NOPTS_VALUE;
52
    pkt->dts   = AV_NOPTS_VALUE;
53
    pkt->duration = 0;
54
    pkt->flags = 0;
55
    pkt->stream_index = 0;
56
}
57

    
58
int av_new_packet(AVPacket *pkt, int size);
59
int av_dup_packet(AVPacket *pkt);
60

    
61
/**
62
 * Free a packet
63
 *
64
 * @param pkt packet to free
65
 */
66
static inline void av_free_packet(AVPacket *pkt)
67
{
68
    if (pkt && pkt->destruct) {
69
        pkt->destruct(pkt);
70
    }
71
}
72

    
73
/*************************************************/
74
/* fractional numbers for exact pts handling */
75

    
76
/* the exact value of the fractional number is: 'val + num / den'. num
77
   is assumed to be such as 0 <= num < den */
78
typedef struct AVFrac {
79
    int64_t val, num, den; 
80
} AVFrac;
81

    
82
void av_frac_init(AVFrac *f, int64_t val, int64_t num, int64_t den);
83
void av_frac_add(AVFrac *f, int64_t incr);
84
void av_frac_set(AVFrac *f, int64_t val);
85

    
86
/*************************************************/
87
/* input/output formats */
88

    
89
struct AVFormatContext;
90

    
91
/* this structure contains the data a format has to probe a file */
92
typedef struct AVProbeData {
93
    const char *filename;
94
    unsigned char *buf;
95
    int buf_size;
96
} AVProbeData;
97

    
98
#define AVPROBE_SCORE_MAX 100
99

    
100
typedef struct AVFormatParameters {
101
    int frame_rate;
102
    int frame_rate_base;
103
    int sample_rate;
104
    int channels;
105
    int width;
106
    int height;
107
    enum PixelFormat pix_fmt;
108
    struct AVImageFormat *image_format;
109
    int channel; /* used to select dv channel */
110
    const char *device; /* video4linux, audio or DV device */
111
    const char *standard; /* tv standard, NTSC, PAL, SECAM */
112
    int mpeg2ts_raw:1;  /* force raw MPEG2 transport stream output, if possible */
113
    int mpeg2ts_compute_pcr:1; /* compute exact PCR for each transport
114
                                  stream packet (only meaningful if
115
                                  mpeg2ts_raw is TRUE */
116
    int initial_pause:1;       /* do not begin to play the stream
117
                                  immediately (RTSP only) */
118
} AVFormatParameters;
119

    
120
#define AVFMT_NOFILE        0x0001 /* no file should be opened */
121
#define AVFMT_NEEDNUMBER    0x0002 /* needs '%d' in filename */ 
122
#define AVFMT_SHOW_IDS      0x0008 /* show format stream IDs numbers */
123
#define AVFMT_RAWPICTURE    0x0020 /* format wants AVPicture structure for
124
                                      raw picture data */
125

    
126
typedef struct AVOutputFormat {
127
    const char *name;
128
    const char *long_name;
129
    const char *mime_type;
130
    const char *extensions; /* comma separated extensions */
131
    /* size of private data so that it can be allocated in the wrapper */
132
    int priv_data_size;
133
    /* output support */
134
    enum CodecID audio_codec; /* default audio codec */
135
    enum CodecID video_codec; /* default video codec */
136
    int (*write_header)(struct AVFormatContext *);
137
    int (*write_packet)(struct AVFormatContext *, 
138
                        int stream_index,
139
                        const uint8_t *buf, int size, int64_t pts);
140
    int (*write_trailer)(struct AVFormatContext *);
141
    /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
142
    int flags;
143
    /* currently only used to set pixel format if not YUV420P */
144
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
145
    /* private fields */
146
    struct AVOutputFormat *next;
147
} AVOutputFormat;
148

    
149
typedef struct AVInputFormat {
150
    const char *name;
151
    const char *long_name;
152
    /* size of private data so that it can be allocated in the wrapper */
153
    int priv_data_size;
154
    /* tell if a given file has a chance of being parsing by this format */
155
    int (*read_probe)(AVProbeData *);
156
    /* read the format header and initialize the AVFormatContext
157
       structure. Return 0 if OK. 'ap' if non NULL contains
158
       additionnal paramters. Only used in raw format right
159
       now. 'av_new_stream' should be called to create new streams.  */
160
    int (*read_header)(struct AVFormatContext *,
161
                       AVFormatParameters *ap);
162
    /* read one packet and put it in 'pkt'. pts and flags are also
163
       set. 'av_new_stream' can be called only if the flag
164
       AVFMTCTX_NOHEADER is used. */
165
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
166
    /* close the stream. The AVFormatContext and AVStreams are not
167
       freed by this function */
168
    int (*read_close)(struct AVFormatContext *);
169
    /* seek at or before a given timestamp (given in AV_TIME_BASE
170
       units) relative to the frames in stream component stream_index */
171
    int (*read_seek)(struct AVFormatContext *, 
172
                     int stream_index, int64_t timestamp);
173
    /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
174
    int flags;
175
    /* if extensions are defined, then no probe is done. You should
176
       usually not use extension format guessing because it is not
177
       reliable enough */
178
    const char *extensions;
179
    /* general purpose read only value that the format can use */
180
    int value;
181

    
182
    /* start/resume playing - only meaningful if using a network based format
183
       (RTSP) */
184
    int (*read_play)(struct AVFormatContext *);
185

    
186
    /* pause playing - only meaningful if using a network based format
187
       (RTSP) */
188
    int (*read_pause)(struct AVFormatContext *);
189

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

    
194
typedef struct AVIndexEntry {
195
    int64_t pos;
196
    int64_t timestamp;
197
#define AVINDEX_KEYFRAME 0x0001
198
    int flags;
199
} AVIndexEntry;
200

    
201
typedef struct AVStream {
202
    int index;    /* stream index in AVFormatContext */
203
    int id;       /* format specific stream id */
204
    AVCodecContext codec; /* codec context */
205
    int r_frame_rate;     /* real frame rate of the stream */
206
    int r_frame_rate_base;/* real frame rate base of the stream */
207
    void *priv_data;
208
    /* internal data used in av_find_stream_info() */
209
    int64_t codec_info_duration;     
210
    int codec_info_nb_frames;
211
    /* encoding: PTS generation when outputing stream */
212
    AVFrac pts;
213
    /* ffmpeg.c private use */
214
    int stream_copy; /* if TRUE, just copy stream */
215
    /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
216
     * MN:dunno if thats the right place, for it */
217
    float quality; 
218
    /* decoding: position of the first frame of the component, in
219
       AV_TIME_BASE fractional seconds. */
220
    int64_t start_time; 
221
    /* decoding: duration of the stream, in AV_TIME_BASE fractional
222
       seconds. */
223
    int64_t duration;
224

    
225
    /* av_read_frame() support */
226
    int need_parsing;
227
    struct AVCodecParserContext *parser;
228

    
229
    int64_t cur_dts;
230
    int last_IP_duration;
231
    /* av_seek_frame() support */
232
    AVIndexEntry *index_entries; /* only used if the format does not
233
                                    support seeking natively */
234
    int nb_index_entries;
235
    int index_entries_allocated_size;
236
} AVStream;
237

    
238
#define AVFMTCTX_NOHEADER      0x0001 /* signal that no header is present
239
                                         (streams are added dynamically) */
240

    
241
#define MAX_STREAMS 20
242

    
243
/* format I/O context */
244
typedef struct AVFormatContext {
245
    /* can only be iformat or oformat, not both at the same time */
246
    struct AVInputFormat *iformat;
247
    struct AVOutputFormat *oformat;
248
    void *priv_data;
249
    ByteIOContext pb;
250
    int nb_streams;
251
    AVStream *streams[MAX_STREAMS];
252
    char filename[1024]; /* input or output filename */
253
    /* stream info */
254
    char title[512];
255
    char author[512];
256
    char copyright[512];
257
    char comment[512];
258
    char album[512];
259
    int year;  /* ID3 year, 0 if none */
260
    int track; /* track number, 0 if none */
261
    char genre[32]; /* ID3 genre */
262

    
263
    int ctx_flags; /* format specific flags, see AVFMTCTX_xx */
264
    /* private data for pts handling (do not modify directly) */
265
    int pts_wrap_bits; /* number of bits in pts (used for wrapping control) */
266
    int pts_num, pts_den; /* value to convert to seconds */
267
    /* This buffer is only needed when packets were already buffered but
268
       not decoded, for example to get the codec parameters in mpeg
269
       streams */
270
    struct AVPacketList *packet_buffer;
271

    
272
    /* decoding: position of the first frame of the component, in
273
       AV_TIME_BASE fractional seconds. NEVER set this value directly:
274
       it is deduced from the AVStream values.  */
275
    int64_t start_time; 
276
    /* decoding: duration of the stream, in AV_TIME_BASE fractional
277
       seconds. NEVER set this value directly: it is deduced from the
278
       AVStream values.  */
279
    int64_t duration;
280
    /* decoding: total file size. 0 if unknown */
281
    int64_t file_size;
282
    /* decoding: total stream bitrate in bit/s, 0 if not
283
       available. Never set it directly if the file_size and the
284
       duration are known as ffmpeg can compute it automatically. */
285
    int bit_rate;
286

    
287
    /* av_read_frame() support */
288
    AVStream *cur_st;
289
    const uint8_t *cur_ptr;
290
    int cur_len;
291
    AVPacket cur_pkt;
292

    
293
    /* the following are used for pts/dts unit conversion */
294
    int64_t last_pkt_stream_pts;
295
    int64_t last_pkt_stream_dts;
296
    int64_t last_pkt_pts;
297
    int64_t last_pkt_dts;
298
    int last_pkt_pts_frac;
299
    int last_pkt_dts_frac;
300

    
301
    /* av_seek_frame() support */
302
    int64_t data_offset; /* offset of the first packet */
303
    int index_built;
304
} AVFormatContext;
305

    
306
typedef struct AVPacketList {
307
    AVPacket pkt;
308
    struct AVPacketList *next;
309
} AVPacketList;
310

    
311
extern AVInputFormat *first_iformat;
312
extern AVOutputFormat *first_oformat;
313

    
314
/* still image support */
315
struct AVInputImageContext;
316
typedef struct AVInputImageContext AVInputImageContext;
317

    
318
typedef struct AVImageInfo {
319
    enum PixelFormat pix_fmt; /* requested pixel format */
320
    int width; /* requested width */
321
    int height; /* requested height */
322
    int interleaved; /* image is interleaved (e.g. interleaved GIF) */
323
    AVPicture pict; /* returned allocated image */
324
} AVImageInfo;
325

    
326
/* AVImageFormat.flags field constants */
327
#define AVIMAGE_INTERLEAVED 0x0001 /* image format support interleaved output */
328

    
329
typedef struct AVImageFormat {
330
    const char *name;
331
    const char *extensions;
332
    /* tell if a given file has a chance of being parsing by this format */
333
    int (*img_probe)(AVProbeData *);
334
    /* read a whole image. 'alloc_cb' is called when the image size is
335
       known so that the caller can allocate the image. If 'allo_cb'
336
       returns non zero, then the parsing is aborted. Return '0' if
337
       OK. */
338
    int (*img_read)(ByteIOContext *, 
339
                    int (*alloc_cb)(void *, AVImageInfo *info), void *);
340
    /* write the image */
341
    int supported_pixel_formats; /* mask of supported formats for output */
342
    int (*img_write)(ByteIOContext *, AVImageInfo *);
343
    int flags;
344
    struct AVImageFormat *next;
345
} AVImageFormat;
346

    
347
void av_register_image_format(AVImageFormat *img_fmt);
348
AVImageFormat *av_probe_image_format(AVProbeData *pd);
349
AVImageFormat *guess_image_format(const char *filename);
350
int av_read_image(ByteIOContext *pb, const char *filename,
351
                  AVImageFormat *fmt,
352
                  int (*alloc_cb)(void *, AVImageInfo *info), void *opaque);
353
int av_write_image(ByteIOContext *pb, AVImageFormat *fmt, AVImageInfo *img);
354

    
355
extern AVImageFormat *first_image_format;
356

    
357
extern AVImageFormat pnm_image_format;
358
extern AVImageFormat pbm_image_format;
359
extern AVImageFormat pgm_image_format;
360
extern AVImageFormat ppm_image_format;
361
extern AVImageFormat pam_image_format;
362
extern AVImageFormat pgmyuv_image_format;
363
extern AVImageFormat yuv_image_format;
364
#ifdef CONFIG_ZLIB
365
extern AVImageFormat png_image_format;
366
#endif
367
extern AVImageFormat jpeg_image_format;
368
extern AVImageFormat gif_image_format;
369

    
370
/* XXX: use automatic init with either ELF sections or C file parser */
371
/* modules */
372

    
373
/* mpeg.c */
374
extern AVInputFormat mpegps_demux;
375
int mpegps_init(void);
376

    
377
/* mpegts.c */
378
extern AVInputFormat mpegts_demux;
379
int mpegts_init(void);
380

    
381
/* rm.c */
382
int rm_init(void);
383

    
384
/* crc.c */
385
int crc_init(void);
386

    
387
/* img.c */
388
int img_init(void);
389

    
390
/* asf.c */
391
int asf_init(void);
392

    
393
/* avienc.c */
394
int avienc_init(void);
395

    
396
/* avidec.c */
397
int avidec_init(void);
398

    
399
/* swf.c */
400
int swf_init(void);
401

    
402
/* mov.c */
403
int mov_init(void);
404

    
405
/* movenc.c */
406
int movenc_init(void);
407

    
408
/* flvenc.c */
409
int flvenc_init(void);
410

    
411
/* flvdec.c */
412
int flvdec_init(void);
413

    
414
/* jpeg.c */
415
int jpeg_init(void);
416

    
417
/* gif.c */
418
int gif_init(void);
419

    
420
/* au.c */
421
int au_init(void);
422

    
423
/* amr.c */
424
int amr_init(void);
425

    
426
/* wav.c */
427
int wav_init(void);
428

    
429
/* raw.c */
430
int pcm_read_seek(AVFormatContext *s, 
431
                  int stream_index, int64_t timestamp);
432
int raw_init(void);
433

    
434
/* mp3.c */
435
int mp3_init(void);
436

    
437
/* yuv4mpeg.c */
438
int yuv4mpeg_init(void);
439

    
440
/* ogg.c */
441
int ogg_init(void);
442

    
443
/* dv.c */
444
int dv_init(void);
445

    
446
/* ffm.c */
447
int ffm_init(void);
448

    
449
/* rtsp.c */
450
extern AVInputFormat redir_demux;
451
int redir_open(AVFormatContext **ic_ptr, ByteIOContext *f);
452

    
453
/* 4xm.c */
454
int fourxm_init(void);
455

    
456
/* psxstr.c */
457
int str_init(void);
458

    
459
/* idroq.c */
460
int roq_init(void);
461

    
462
/* ipmovie.c */
463
int ipmovie_init(void);
464

    
465
/* nut.c */
466
int nut_init(void);
467

    
468
/* wc3movie.c */
469
int wc3_init(void);
470

    
471
/* westwood.c */
472
int westwood_init(void);
473

    
474
/* segafilm.c */
475
int film_init(void);
476

    
477
/* idcin.c */
478
int idcin_init(void);
479

    
480
/* flic.c */
481
int flic_init(void);
482

    
483
/* sierravmd.c */
484
int vmd_init(void);
485

    
486
#include "rtp.h"
487

    
488
#include "rtsp.h"
489

    
490
/* yuv4mpeg.c */
491
extern AVOutputFormat yuv4mpegpipe_oformat;
492

    
493
/* utils.c */
494
void av_register_input_format(AVInputFormat *format);
495
void av_register_output_format(AVOutputFormat *format);
496
AVOutputFormat *guess_stream_format(const char *short_name, 
497
                                    const char *filename, const char *mime_type);
498
AVOutputFormat *guess_format(const char *short_name, 
499
                             const char *filename, const char *mime_type);
500

    
501
void av_hex_dump(FILE *f, uint8_t *buf, int size);
502
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
503

    
504
void av_register_all(void);
505

    
506
typedef struct FifoBuffer {
507
    uint8_t *buffer;
508
    uint8_t *rptr, *wptr, *end;
509
} FifoBuffer;
510

    
511
int fifo_init(FifoBuffer *f, int size);
512
void fifo_free(FifoBuffer *f);
513
int fifo_size(FifoBuffer *f, uint8_t *rptr);
514
int fifo_read(FifoBuffer *f, uint8_t *buf, int buf_size, uint8_t **rptr_ptr);
515
void fifo_write(FifoBuffer *f, uint8_t *buf, int size, uint8_t **wptr_ptr);
516

    
517
/* media file input */
518
AVInputFormat *av_find_input_format(const char *short_name);
519
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
520
int av_open_input_stream(AVFormatContext **ic_ptr, 
521
                         ByteIOContext *pb, const char *filename, 
522
                         AVInputFormat *fmt, AVFormatParameters *ap);
523
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename, 
524
                       AVInputFormat *fmt,
525
                       int buf_size,
526
                       AVFormatParameters *ap);
527

    
528
#define AVERROR_UNKNOWN     (-1)  /* unknown error */
529
#define AVERROR_IO          (-2)  /* i/o error */
530
#define AVERROR_NUMEXPECTED (-3)  /* number syntax expected in filename */
531
#define AVERROR_INVALIDDATA (-4)  /* invalid data found */
532
#define AVERROR_NOMEM       (-5)  /* not enough memory */
533
#define AVERROR_NOFMT       (-6)  /* unknown format */
534
#define AVERROR_NOTSUPP     (-7)  /* operation not supported */
535
 
536
int av_find_stream_info(AVFormatContext *ic);
537
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
538
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
539
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp);
540
int av_read_play(AVFormatContext *s);
541
int av_read_pause(AVFormatContext *s);
542
void av_close_input_file(AVFormatContext *s);
543
AVStream *av_new_stream(AVFormatContext *s, int id);
544
void av_set_pts_info(AVFormatContext *s, int pts_wrap_bits,
545
                     int pts_num, int pts_den);
546

    
547
/* media file output */
548
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
549
int av_write_header(AVFormatContext *s);
550
int av_write_frame(AVFormatContext *s, int stream_index, const uint8_t *buf, 
551
                   int size);
552
int av_write_trailer(AVFormatContext *s);
553

    
554
void dump_format(AVFormatContext *ic,
555
                 int index, 
556
                 const char *url,
557
                 int is_output);
558
int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
559
int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
560
int64_t parse_date(const char *datestr, int duration);
561

    
562
int64_t av_gettime(void);
563

    
564
/* ffm specific for ffserver */
565
#define FFM_PACKET_SIZE 4096
566
offset_t ffm_read_write_index(int fd);
567
void ffm_write_write_index(int fd, offset_t pos);
568
void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
569

    
570
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
571

    
572
int get_frame_filename(char *buf, int buf_size,
573
                       const char *path, int number);
574
int filename_number_test(const char *filename);
575

    
576
/* grab specific */
577
int video_grab_init(void);
578
int audio_init(void);
579

    
580
/* DV1394 */
581
int dv1394_init(void);
582

    
583
#ifdef HAVE_AV_CONFIG_H
584

    
585
#include "os_support.h"
586

    
587
int strstart(const char *str, const char *val, const char **ptr);
588
int stristart(const char *str, const char *val, const char **ptr);
589
void pstrcpy(char *buf, int buf_size, const char *str);
590
char *pstrcat(char *buf, int buf_size, const char *s);
591

    
592
void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
593

    
594
#ifdef __GNUC__
595
#define dynarray_add(tab, nb_ptr, elem)\
596
do {\
597
    typeof(tab) _tab = (tab);\
598
    typeof(elem) _elem = (elem);\
599
    (void)sizeof(**_tab == _elem); /* check that types are compatible */\
600
    __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
601
} while(0)
602
#else
603
#define dynarray_add(tab, nb_ptr, elem)\
604
do {\
605
    __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
606
} while(0)
607
#endif
608

    
609
time_t mktimegm(struct tm *tm);
610
const char *small_strptime(const char *p, const char *fmt, 
611
                           struct tm *dt);
612

    
613
struct in_addr;
614
int resolve_host(struct in_addr *sin_addr, const char *hostname);
615

    
616
void url_split(char *proto, int proto_size,
617
               char *hostname, int hostname_size,
618
               int *port_ptr,
619
               char *path, int path_size,
620
               const char *url);
621

    
622
int match_ext(const char *filename, const char *extensions);
623

    
624
#endif /* HAVE_AV_CONFIG_H */
625

    
626
#ifdef __cplusplus
627
}
628
#endif
629

    
630
#endif /* AVFORMAT_H */