* fixing a few of gcc 'clean-code' warnings
[ffmpeg.git] / libavformat / avformat.h
1 #ifndef AVFORMAT_H
2 #define AVFORMAT_H
3
4 #ifdef __cplusplus
5 extern "C" {
6 #endif
7
8 #define LIBAVFORMAT_BUILD       4617
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 void av_destruct_packet_nofree(AVPacket *pkt);
46
47 /* initialize optional fields of a packet */
48 static inline void av_init_packet(AVPacket *pkt)
49 {
50     pkt->pts   = AV_NOPTS_VALUE;
51     pkt->dts   = AV_NOPTS_VALUE;
52     pkt->duration = 0;
53     pkt->flags = 0;
54     pkt->stream_index = 0;
55     pkt->destruct= av_destruct_packet_nofree;
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 *, AVPacket *pkt);
138     int (*write_trailer)(struct AVFormatContext *);
139     /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
140     int flags;
141     /* currently only used to set pixel format if not YUV420P */
142     int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
143     int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
144     /* private fields */
145     struct AVOutputFormat *next;
146 } AVOutputFormat;
147
148 typedef struct AVInputFormat {
149     const char *name;
150     const char *long_name;
151     /* size of private data so that it can be allocated in the wrapper */
152     int priv_data_size;
153     /* tell if a given file has a chance of being parsing by this format */
154     int (*read_probe)(AVProbeData *);
155     /* read the format header and initialize the AVFormatContext
156        structure. Return 0 if OK. 'ap' if non NULL contains
157        additionnal paramters. Only used in raw format right
158        now. 'av_new_stream' should be called to create new streams.  */
159     int (*read_header)(struct AVFormatContext *,
160                        AVFormatParameters *ap);
161     /* read one packet and put it in 'pkt'. pts and flags are also
162        set. 'av_new_stream' can be called only if the flag
163        AVFMTCTX_NOHEADER is used. */
164     int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
165     /* close the stream. The AVFormatContext and AVStreams are not
166        freed by this function */
167     int (*read_close)(struct AVFormatContext *);
168     /* seek at or before a given timestamp (given in AV_TIME_BASE
169        units) relative to the frames in stream component stream_index */
170     int (*read_seek)(struct AVFormatContext *, 
171                      int stream_index, int64_t timestamp);
172     /**
173      * gets the next timestamp in AV_TIME_BASE units.
174      */
175     int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
176                               int64_t *pos, int64_t pos_limit);
177     /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
178     int flags;
179     /* if extensions are defined, then no probe is done. You should
180        usually not use extension format guessing because it is not
181        reliable enough */
182     const char *extensions;
183     /* general purpose read only value that the format can use */
184     int value;
185
186     /* start/resume playing - only meaningful if using a network based format
187        (RTSP) */
188     int (*read_play)(struct AVFormatContext *);
189
190     /* pause playing - only meaningful if using a network based format
191        (RTSP) */
192     int (*read_pause)(struct AVFormatContext *);
193
194     /* private fields */
195     struct AVInputFormat *next;
196 } AVInputFormat;
197
198 typedef struct AVIndexEntry {
199     int64_t pos;
200     int64_t timestamp;
201 #define AVINDEX_KEYFRAME 0x0001
202 /* the following 2 flags indicate that the next/prev keyframe is known, and scaning for it isnt needed */
203     int flags;
204     int min_distance;         /* min distance between this and the previous keyframe, used to avoid unneeded searching */
205 } AVIndexEntry;
206
207 typedef struct AVStream {
208     int index;    /* stream index in AVFormatContext */
209     int id;       /* format specific stream id */
210     AVCodecContext codec; /* codec context */
211     int r_frame_rate;     /* real frame rate of the stream */
212     int r_frame_rate_base;/* real frame rate base of the stream */
213     void *priv_data;
214     /* internal data used in av_find_stream_info() */
215     int64_t codec_info_duration;     
216     int codec_info_nb_frames;
217     /* encoding: PTS generation when outputing stream */
218     AVFrac pts;
219     AVRational time_base;
220     int pts_wrap_bits; /* number of bits in pts (used for wrapping control) */
221     /* ffmpeg.c private use */
222     int stream_copy; /* if TRUE, just copy stream */
223     /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
224      * MN:dunno if thats the right place, for it */
225     float quality; 
226     /* decoding: position of the first frame of the component, in
227        AV_TIME_BASE fractional seconds. */
228     int64_t start_time; 
229     /* decoding: duration of the stream, in AV_TIME_BASE fractional
230        seconds. */
231     int64_t duration;
232
233     /* av_read_frame() support */
234     int need_parsing;
235     struct AVCodecParserContext *parser;
236
237     int64_t cur_dts;
238     int last_IP_duration;
239     int64_t last_IP_pts;
240     /* av_seek_frame() support */
241     AVIndexEntry *index_entries; /* only used if the format does not
242                                     support seeking natively */
243     int nb_index_entries;
244     int index_entries_allocated_size;
245 } AVStream;
246
247 #define AVFMTCTX_NOHEADER      0x0001 /* signal that no header is present
248                                          (streams are added dynamically) */
249
250 #define MAX_STREAMS 20
251
252 /* format I/O context */
253 typedef struct AVFormatContext {
254     const AVClass *av_class; /* set by av_alloc_format_context */
255     /* can only be iformat or oformat, not both at the same time */
256     struct AVInputFormat *iformat;
257     struct AVOutputFormat *oformat;
258     void *priv_data;
259     ByteIOContext pb;
260     int nb_streams;
261     AVStream *streams[MAX_STREAMS];
262     char filename[1024]; /* input or output filename */
263     /* stream info */
264     int64_t timestamp;
265     char title[512];
266     char author[512];
267     char copyright[512];
268     char comment[512];
269     char album[512];
270     int year;  /* ID3 year, 0 if none */
271     int track; /* track number, 0 if none */
272     char genre[32]; /* ID3 genre */
273
274     int ctx_flags; /* format specific flags, see AVFMTCTX_xx */
275     /* private data for pts handling (do not modify directly) */
276     /* This buffer is only needed when packets were already buffered but
277        not decoded, for example to get the codec parameters in mpeg
278        streams */
279     struct AVPacketList *packet_buffer;
280
281     /* decoding: position of the first frame of the component, in
282        AV_TIME_BASE fractional seconds. NEVER set this value directly:
283        it is deduced from the AVStream values.  */
284     int64_t start_time; 
285     /* decoding: duration of the stream, in AV_TIME_BASE fractional
286        seconds. NEVER set this value directly: it is deduced from the
287        AVStream values.  */
288     int64_t duration;
289     /* decoding: total file size. 0 if unknown */
290     int64_t file_size;
291     /* decoding: total stream bitrate in bit/s, 0 if not
292        available. Never set it directly if the file_size and the
293        duration are known as ffmpeg can compute it automatically. */
294     int bit_rate;
295
296     /* av_read_frame() support */
297     AVStream *cur_st;
298     const uint8_t *cur_ptr;
299     int cur_len;
300     AVPacket cur_pkt;
301
302     /* av_seek_frame() support */
303     int64_t data_offset; /* offset of the first packet */
304     int index_built;
305 } AVFormatContext;
306
307 typedef struct AVPacketList {
308     AVPacket pkt;
309     struct AVPacketList *next;
310 } AVPacketList;
311
312 extern AVInputFormat *first_iformat;
313 extern AVOutputFormat *first_oformat;
314
315 /* still image support */
316 struct AVInputImageContext;
317 typedef struct AVInputImageContext AVInputImageContext;
318
319 typedef struct AVImageInfo {
320     enum PixelFormat pix_fmt; /* requested pixel format */
321     int width; /* requested width */
322     int height; /* requested height */
323     int interleaved; /* image is interleaved (e.g. interleaved GIF) */
324     AVPicture pict; /* returned allocated image */
325 } AVImageInfo;
326
327 /* AVImageFormat.flags field constants */
328 #define AVIMAGE_INTERLEAVED 0x0001 /* image format support interleaved output */
329
330 typedef struct AVImageFormat {
331     const char *name;
332     const char *extensions;
333     /* tell if a given file has a chance of being parsing by this format */
334     int (*img_probe)(AVProbeData *);
335     /* read a whole image. 'alloc_cb' is called when the image size is
336        known so that the caller can allocate the image. If 'allo_cb'
337        returns non zero, then the parsing is aborted. Return '0' if
338        OK. */
339     int (*img_read)(ByteIOContext *, 
340                     int (*alloc_cb)(void *, AVImageInfo *info), void *);
341     /* write the image */
342     int supported_pixel_formats; /* mask of supported formats for output */
343     int (*img_write)(ByteIOContext *, AVImageInfo *);
344     int flags;
345     struct AVImageFormat *next;
346 } AVImageFormat;
347
348 void av_register_image_format(AVImageFormat *img_fmt);
349 AVImageFormat *av_probe_image_format(AVProbeData *pd);
350 AVImageFormat *guess_image_format(const char *filename);
351 int av_read_image(ByteIOContext *pb, const char *filename,
352                   AVImageFormat *fmt,
353                   int (*alloc_cb)(void *, AVImageInfo *info), void *opaque);
354 int av_write_image(ByteIOContext *pb, AVImageFormat *fmt, AVImageInfo *img);
355
356 extern AVImageFormat *first_image_format;
357
358 extern AVImageFormat pnm_image_format;
359 extern AVImageFormat pbm_image_format;
360 extern AVImageFormat pgm_image_format;
361 extern AVImageFormat ppm_image_format;
362 extern AVImageFormat pam_image_format;
363 extern AVImageFormat pgmyuv_image_format;
364 extern AVImageFormat yuv_image_format;
365 #ifdef CONFIG_ZLIB
366 extern AVImageFormat png_image_format;
367 #endif
368 extern AVImageFormat jpeg_image_format;
369 extern AVImageFormat gif_image_format;
370 extern AVImageFormat sgi_image_format;
371
372 /* XXX: use automatic init with either ELF sections or C file parser */
373 /* modules */
374
375 /* mpeg.c */
376 extern AVInputFormat mpegps_demux;
377 int mpegps_init(void);
378
379 /* mpegts.c */
380 extern AVInputFormat mpegts_demux;
381 int mpegts_init(void);
382
383 /* rm.c */
384 int rm_init(void);
385
386 /* crc.c */
387 int crc_init(void);
388
389 /* img.c */
390 int img_init(void);
391
392 /* img2.c */
393 int img2_init(void);
394
395 /* asf.c */
396 int asf_init(void);
397
398 /* avienc.c */
399 int avienc_init(void);
400
401 /* avidec.c */
402 int avidec_init(void);
403
404 /* swf.c */
405 int swf_init(void);
406
407 /* mov.c */
408 int mov_init(void);
409
410 /* movenc.c */
411 int movenc_init(void);
412
413 /* flvenc.c */
414 int flvenc_init(void);
415
416 /* flvdec.c */
417 int flvdec_init(void);
418
419 /* jpeg.c */
420 int jpeg_init(void);
421
422 /* gif.c */
423 int gif_init(void);
424
425 /* au.c */
426 int au_init(void);
427
428 /* amr.c */
429 int amr_init(void);
430
431 /* wav.c */
432 int ff_wav_init(void);
433
434 /* raw.c */
435 int pcm_read_seek(AVFormatContext *s, 
436                   int stream_index, int64_t timestamp);
437 int raw_init(void);
438
439 /* mp3.c */
440 int mp3_init(void);
441
442 /* yuv4mpeg.c */
443 int yuv4mpeg_init(void);
444
445 /* ogg.c */
446 int ogg_init(void);
447
448 /* dv.c */
449 int ff_dv_init(void);
450
451 /* ffm.c */
452 int ffm_init(void);
453
454 /* rtsp.c */
455 extern AVInputFormat redir_demux;
456 int redir_open(AVFormatContext **ic_ptr, ByteIOContext *f);
457
458 /* 4xm.c */
459 int fourxm_init(void);
460
461 /* psxstr.c */
462 int str_init(void);
463
464 /* idroq.c */
465 int roq_init(void);
466
467 /* ipmovie.c */
468 int ipmovie_init(void);
469
470 /* nut.c */
471 int nut_init(void);
472
473 /* wc3movie.c */
474 int wc3_init(void);
475
476 /* westwood.c */
477 int westwood_init(void);
478
479 /* segafilm.c */
480 int film_init(void);
481
482 /* idcin.c */
483 int idcin_init(void);
484
485 /* flic.c */
486 int flic_init(void);
487
488 /* sierravmd.c */
489 int vmd_init(void);
490
491 /* matroska.c */
492 int matroska_init(void);
493
494 /* sol.c */
495 int sol_init(void);
496
497 #include "rtp.h"
498
499 #include "rtsp.h"
500
501 /* yuv4mpeg.c */
502 extern AVOutputFormat yuv4mpegpipe_oformat;
503
504 /* utils.c */
505 void av_register_input_format(AVInputFormat *format);
506 void av_register_output_format(AVOutputFormat *format);
507 AVOutputFormat *guess_stream_format(const char *short_name, 
508                                     const char *filename, const char *mime_type);
509 AVOutputFormat *guess_format(const char *short_name, 
510                              const char *filename, const char *mime_type);
511
512 void av_hex_dump(FILE *f, uint8_t *buf, int size);
513 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
514
515 void av_register_all(void);
516
517 typedef struct FifoBuffer {
518     uint8_t *buffer;
519     uint8_t *rptr, *wptr, *end;
520 } FifoBuffer;
521
522 int fifo_init(FifoBuffer *f, int size);
523 void fifo_free(FifoBuffer *f);
524 int fifo_size(FifoBuffer *f, uint8_t *rptr);
525 int fifo_read(FifoBuffer *f, uint8_t *buf, int buf_size, uint8_t **rptr_ptr);
526 void fifo_write(FifoBuffer *f, uint8_t *buf, int size, uint8_t **wptr_ptr);
527 int put_fifo(ByteIOContext *pb, FifoBuffer *f, int buf_size, uint8_t **rptr_ptr);
528
529 /* media file input */
530 AVInputFormat *av_find_input_format(const char *short_name);
531 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
532 int av_open_input_stream(AVFormatContext **ic_ptr, 
533                          ByteIOContext *pb, const char *filename, 
534                          AVInputFormat *fmt, AVFormatParameters *ap);
535 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename, 
536                        AVInputFormat *fmt,
537                        int buf_size,
538                        AVFormatParameters *ap);
539 /* no av_open for output, so applications will need this: */
540 AVFormatContext *av_alloc_format_context(void);
541
542 #define AVERROR_UNKNOWN     (-1)  /* unknown error */
543 #define AVERROR_IO          (-2)  /* i/o error */
544 #define AVERROR_NUMEXPECTED (-3)  /* number syntax expected in filename */
545 #define AVERROR_INVALIDDATA (-4)  /* invalid data found */
546 #define AVERROR_NOMEM       (-5)  /* not enough memory */
547 #define AVERROR_NOFMT       (-6)  /* unknown format */
548 #define AVERROR_NOTSUPP     (-7)  /* operation not supported */
549  
550 int av_find_stream_info(AVFormatContext *ic);
551 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
552 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
553 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp);
554 int av_read_play(AVFormatContext *s);
555 int av_read_pause(AVFormatContext *s);
556 void av_close_input_file(AVFormatContext *s);
557 AVStream *av_new_stream(AVFormatContext *s, int id);
558 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
559                      int pts_num, int pts_den);
560
561 int av_find_default_stream_index(AVFormatContext *s);
562 int av_index_search_timestamp(AVStream *st, int timestamp);
563 int av_add_index_entry(AVStream *st,
564                        int64_t pos, int64_t timestamp, int distance, int flags);
565 int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts);
566
567 /* media file output */
568 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
569 int av_write_header(AVFormatContext *s);
570 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
571 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
572
573 int av_write_trailer(AVFormatContext *s);
574
575 void dump_format(AVFormatContext *ic,
576                  int index, 
577                  const char *url,
578                  int is_output);
579 int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
580 int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
581 int64_t parse_date(const char *datestr, int duration);
582
583 int64_t av_gettime(void);
584
585 /* ffm specific for ffserver */
586 #define FFM_PACKET_SIZE 4096
587 offset_t ffm_read_write_index(int fd);
588 void ffm_write_write_index(int fd, offset_t pos);
589 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
590
591 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
592
593 int get_frame_filename(char *buf, int buf_size,
594                        const char *path, int number);
595 int filename_number_test(const char *filename);
596
597 /* grab specific */
598 int video_grab_init(void);
599 int audio_init(void);
600
601 /* DV1394 */
602 int dv1394_init(void);
603
604 #ifdef HAVE_AV_CONFIG_H
605
606 #include "os_support.h"
607
608 int strstart(const char *str, const char *val, const char **ptr);
609 int stristart(const char *str, const char *val, const char **ptr);
610 void pstrcpy(char *buf, int buf_size, const char *str);
611 char *pstrcat(char *buf, int buf_size, const char *s);
612
613 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
614
615 #ifdef __GNUC__
616 #define dynarray_add(tab, nb_ptr, elem)\
617 do {\
618     typeof(tab) _tab = (tab);\
619     typeof(elem) _elem = (elem);\
620     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
621     __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
622 } while(0)
623 #else
624 #define dynarray_add(tab, nb_ptr, elem)\
625 do {\
626     __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
627 } while(0)
628 #endif
629
630 time_t mktimegm(struct tm *tm);
631 struct tm *brktimegm(time_t secs, struct tm *tm);
632 const char *small_strptime(const char *p, const char *fmt, 
633                            struct tm *dt);
634
635 struct in_addr;
636 int resolve_host(struct in_addr *sin_addr, const char *hostname);
637
638 void url_split(char *proto, int proto_size,
639                char *authorization, int authorization_size,
640                char *hostname, int hostname_size,
641                int *port_ptr,
642                char *path, int path_size,
643                const char *url);
644
645 int match_ext(const char *filename, const char *extensions);
646
647 #endif /* HAVE_AV_CONFIG_H */
648
649 #ifdef __cplusplus
650 }
651 #endif
652
653 #endif /* AVFORMAT_H */