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