Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 03cfe134

History | View | Annotate | Download (19.7 KB)

1
#ifndef AVFORMAT_H
2
#define AVFORMAT_H
3

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

    
8
#define LIBAVFORMAT_BUILD       4616
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 *, AVPacket *pkt);
135
    int (*write_trailer)(struct AVFormatContext *);
136
    /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
137
    int flags;
138
    /* currently only used to set pixel format if not YUV420P */
139
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
140
    /* private fields */
141
    struct AVOutputFormat *next;
142
} AVOutputFormat;
143

    
144
typedef struct AVInputFormat {
145
    const char *name;
146
    const char *long_name;
147
    /* size of private data so that it can be allocated in the wrapper */
148
    int priv_data_size;
149
    /* tell if a given file has a chance of being parsing by this format */
150
    int (*read_probe)(AVProbeData *);
151
    /* read the format header and initialize the AVFormatContext
152
       structure. Return 0 if OK. 'ap' if non NULL contains
153
       additionnal paramters. Only used in raw format right
154
       now. 'av_new_stream' should be called to create new streams.  */
155
    int (*read_header)(struct AVFormatContext *,
156
                       AVFormatParameters *ap);
157
    /* read one packet and put it in 'pkt'. pts and flags are also
158
       set. 'av_new_stream' can be called only if the flag
159
       AVFMTCTX_NOHEADER is used. */
160
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
161
    /* close the stream. The AVFormatContext and AVStreams are not
162
       freed by this function */
163
    int (*read_close)(struct AVFormatContext *);
164
    /* seek at or before a given timestamp (given in AV_TIME_BASE
165
       units) relative to the frames in stream component stream_index */
166
    int (*read_seek)(struct AVFormatContext *, 
167
                     int stream_index, int64_t timestamp);
168
    /**
169
     * gets the next timestamp in AV_TIME_BASE units.
170
     */
171
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
172
                              int64_t *pos, int64_t pos_limit);
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
/* the following 2 flags indicate that the next/prev keyframe is known, and scaning for it isnt needed */
199
    int flags;
200
    int min_distance;         /* min distance between this and the previous keyframe, used to avoid unneeded searching */
201
} AVIndexEntry;
202

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

    
229
    /* av_read_frame() support */
230
    int need_parsing;
231
    struct AVCodecParserContext *parser;
232

    
233
    int64_t cur_dts;
234
    int last_IP_duration;
235
    int64_t last_IP_pts;
236
    /* av_seek_frame() support */
237
    AVIndexEntry *index_entries; /* only used if the format does not
238
                                    support seeking natively */
239
    int nb_index_entries;
240
    int index_entries_allocated_size;
241
} AVStream;
242

    
243
#define AVFMTCTX_NOHEADER      0x0001 /* signal that no header is present
244
                                         (streams are added dynamically) */
245

    
246
#define MAX_STREAMS 20
247

    
248
/* format I/O context */
249
typedef struct AVFormatContext {
250
    AVClass *av_class; /* set by av_alloc_format_context */
251
    /* can only be iformat or oformat, not both at the same time */
252
    struct AVInputFormat *iformat;
253
    struct AVOutputFormat *oformat;
254
    void *priv_data;
255
    ByteIOContext pb;
256
    int nb_streams;
257
    AVStream *streams[MAX_STREAMS];
258
    char filename[1024]; /* input or output filename */
259
    /* stream info */
260
    int64_t timestamp;
261
    char title[512];
262
    char author[512];
263
    char copyright[512];
264
    char comment[512];
265
    char album[512];
266
    int year;  /* ID3 year, 0 if none */
267
    int track; /* track number, 0 if none */
268
    char genre[32]; /* ID3 genre */
269

    
270
    int ctx_flags; /* format specific flags, see AVFMTCTX_xx */
271
    /* private data for pts handling (do not modify directly) */
272
    /* This buffer is only needed when packets were already buffered but
273
       not decoded, for example to get the codec parameters in mpeg
274
       streams */
275
    struct AVPacketList *packet_buffer;
276

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

    
292
    /* av_read_frame() support */
293
    AVStream *cur_st;
294
    const uint8_t *cur_ptr;
295
    int cur_len;
296
    AVPacket cur_pkt;
297

    
298
    /* av_seek_frame() support */
299
    int64_t data_offset; /* offset of the first packet */
300
    int index_built;
301
} AVFormatContext;
302

    
303
typedef struct AVPacketList {
304
    AVPacket pkt;
305
    struct AVPacketList *next;
306
} AVPacketList;
307

    
308
extern AVInputFormat *first_iformat;
309
extern AVOutputFormat *first_oformat;
310

    
311
/* still image support */
312
struct AVInputImageContext;
313
typedef struct AVInputImageContext AVInputImageContext;
314

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

    
323
/* AVImageFormat.flags field constants */
324
#define AVIMAGE_INTERLEAVED 0x0001 /* image format support interleaved output */
325

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

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

    
352
extern AVImageFormat *first_image_format;
353

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

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

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

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

    
379
/* rm.c */
380
int rm_init(void);
381

    
382
/* crc.c */
383
int crc_init(void);
384

    
385
/* img.c */
386
int img_init(void);
387

    
388
/* img2.c */
389
int img2_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(AVStream *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
int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts);
558

    
559
/* media file output */
560
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
561
int av_write_header(AVFormatContext *s);
562
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
563
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
564

    
565
int av_write_trailer(AVFormatContext *s);
566

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

    
575
int64_t av_gettime(void);
576

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

    
583
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
584

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

    
589
/* grab specific */
590
int video_grab_init(void);
591
int audio_init(void);
592

    
593
/* DV1394 */
594
int dv1394_init(void);
595

    
596
#ifdef HAVE_AV_CONFIG_H
597

    
598
#include "os_support.h"
599

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

    
605
void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
606

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

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

    
626
struct in_addr;
627
int resolve_host(struct in_addr *sin_addr, const char *hostname);
628

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

    
635
int match_ext(const char *filename, const char *extensions);
636

    
637
#endif /* HAVE_AV_CONFIG_H */
638

    
639
#ifdef __cplusplus
640
}
641
#endif
642

    
643
#endif /* AVFORMAT_H */