Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ c3775e54

History | View | Annotate | Download (19.6 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
typedef struct AVPacket {
31
    int64_t pts; /* presentation time stamp in AV_TIME_BASE units (or
32
                    pts_den units in muxers or demuxers) */
33
    int64_t dts; /* decompression time stamp in AV_TIME_BASE units (or
34
                    pts_den units in muxers or demuxers) */
35
    uint8_t *data;
36
    int   size;
37
    int   stream_index;
38
    int   flags;
39
    int   duration; /* presentation duration (0 if not available) */
40
    void  (*destruct)(struct AVPacket *);
41
    void  *priv;
42
} AVPacket; 
43
#define PKT_FLAG_KEY   0x0001
44

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

    
55
int av_new_packet(AVPacket *pkt, int size);
56
int av_dup_packet(AVPacket *pkt);
57

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

    
70
/*************************************************/
71
/* fractional numbers for exact pts handling */
72

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

    
79
void av_frac_init(AVFrac *f, int64_t val, int64_t num, int64_t den);
80
void av_frac_add(AVFrac *f, int64_t incr);
81
void av_frac_set(AVFrac *f, int64_t val);
82

    
83
/*************************************************/
84
/* input/output formats */
85

    
86
struct AVFormatContext;
87

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

    
95
#define AVPROBE_SCORE_MAX 100
96

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

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

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

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

    
179
    /* start/resume playing - only meaningful if using a network based format
180
       (RTSP) */
181
    int (*read_play)(struct AVFormatContext *);
182

    
183
    /* pause playing - only meaningful if using a network based format
184
       (RTSP) */
185
    int (*read_pause)(struct AVFormatContext *);
186

    
187
    /* private fields */
188
    struct AVInputFormat *next;
189
} AVInputFormat;
190

    
191
typedef struct AVIndexEntry {
192
    int64_t pos;
193
    int64_t timestamp;
194
#define AVINDEX_KEYFRAME 0x0001
195
/* the following 2 flags indicate that the next/prev keyframe is known, and scaning for it isnt needed */
196
    int flags;
197
    int min_distance;         /* min distance between this and the previous keyframe, used to avoid unneeded searching */
198
} AVIndexEntry;
199

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

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

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

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

    
240
#define MAX_STREAMS 20
241

    
242
/* format I/O context */
243
typedef struct AVFormatContext {
244
    AVClass *av_class; /* set by av_alloc_format_context */
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
extern AVImageFormat sgi_image_format;
370

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
427
/* wav.c */
428
int ff_wav_init(void);
429

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

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

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

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

    
444
/* dv.c */
445
int ff_dv_init(void);
446

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

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

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

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

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

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

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

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

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

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

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

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

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

    
487
/* matroska.c */
488
int matroska_init(void);
489

    
490
#include "rtp.h"
491

    
492
#include "rtsp.h"
493

    
494
/* yuv4mpeg.c */
495
extern AVOutputFormat yuv4mpegpipe_oformat;
496

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

    
505
void av_hex_dump(FILE *f, uint8_t *buf, int size);
506
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
507

    
508
void av_register_all(void);
509

    
510
typedef struct FifoBuffer {
511
    uint8_t *buffer;
512
    uint8_t *rptr, *wptr, *end;
513
} FifoBuffer;
514

    
515
int fifo_init(FifoBuffer *f, int size);
516
void fifo_free(FifoBuffer *f);
517
int fifo_size(FifoBuffer *f, uint8_t *rptr);
518
int fifo_read(FifoBuffer *f, uint8_t *buf, int buf_size, uint8_t **rptr_ptr);
519
void fifo_write(FifoBuffer *f, uint8_t *buf, int size, uint8_t **wptr_ptr);
520

    
521
/* media file input */
522
AVInputFormat *av_find_input_format(const char *short_name);
523
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
524
int av_open_input_stream(AVFormatContext **ic_ptr, 
525
                         ByteIOContext *pb, const char *filename, 
526
                         AVInputFormat *fmt, AVFormatParameters *ap);
527
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename, 
528
                       AVInputFormat *fmt,
529
                       int buf_size,
530
                       AVFormatParameters *ap);
531
/* no av_open for output, so applications will need this: */
532
AVFormatContext *av_alloc_format_context(void);
533

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

    
553
int av_find_default_stream_index(AVFormatContext *s);
554
int av_index_search_timestamp(AVStream *st, int timestamp);
555
int av_add_index_entry(AVStream *st,
556
                       int64_t pos, int64_t timestamp, int distance, int flags);
557

    
558
/* media file output */
559
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
560
int av_write_header(AVFormatContext *s);
561
int av_write_frame(AVFormatContext *s, int stream_index, const uint8_t *buf, 
562
                   int size);
563
int av_write_trailer(AVFormatContext *s);
564

    
565
void dump_format(AVFormatContext *ic,
566
                 int index, 
567
                 const char *url,
568
                 int is_output);
569
int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
570
int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
571
int64_t parse_date(const char *datestr, int duration);
572

    
573
int64_t av_gettime(void);
574

    
575
/* ffm specific for ffserver */
576
#define FFM_PACKET_SIZE 4096
577
offset_t ffm_read_write_index(int fd);
578
void ffm_write_write_index(int fd, offset_t pos);
579
void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
580

    
581
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
582

    
583
int get_frame_filename(char *buf, int buf_size,
584
                       const char *path, int number);
585
int filename_number_test(const char *filename);
586

    
587
/* grab specific */
588
int video_grab_init(void);
589
int audio_init(void);
590

    
591
/* DV1394 */
592
int dv1394_init(void);
593

    
594
#ifdef HAVE_AV_CONFIG_H
595

    
596
#include "os_support.h"
597

    
598
int strstart(const char *str, const char *val, const char **ptr);
599
int stristart(const char *str, const char *val, const char **ptr);
600
void pstrcpy(char *buf, int buf_size, const char *str);
601
char *pstrcat(char *buf, int buf_size, const char *s);
602

    
603
void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
604

    
605
#ifdef __GNUC__
606
#define dynarray_add(tab, nb_ptr, elem)\
607
do {\
608
    typeof(tab) _tab = (tab);\
609
    typeof(elem) _elem = (elem);\
610
    (void)sizeof(**_tab == _elem); /* check that types are compatible */\
611
    __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
612
} while(0)
613
#else
614
#define dynarray_add(tab, nb_ptr, elem)\
615
do {\
616
    __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
617
} while(0)
618
#endif
619

    
620
time_t mktimegm(struct tm *tm);
621
const char *small_strptime(const char *p, const char *fmt, 
622
                           struct tm *dt);
623

    
624
struct in_addr;
625
int resolve_host(struct in_addr *sin_addr, const char *hostname);
626

    
627
void url_split(char *proto, int proto_size,
628
               char *hostname, int hostname_size,
629
               int *port_ptr,
630
               char *path, int path_size,
631
               const char *url);
632

    
633
int match_ext(const char *filename, const char *extensions);
634

    
635
#endif /* HAVE_AV_CONFIG_H */
636

    
637
#ifdef __cplusplus
638
}
639
#endif
640

    
641
#endif /* AVFORMAT_H */