* Moving FifoBuffer out of libavformat/avformat.h and
[ffmpeg.git] / libavformat / avformat.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 #ifndef AVFORMAT_H
20 #define AVFORMAT_H
21
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25
26 #define LIBAVFORMAT_VERSION_INT ((50<<16)+(5<<8)+0)
27 #define LIBAVFORMAT_VERSION     50.5.0
28 #define LIBAVFORMAT_BUILD       LIBAVFORMAT_VERSION_INT
29
30 #define LIBAVFORMAT_IDENT       "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
31
32 #include <time.h>
33 #include <stdio.h>  /* FILE */
34 #include "avcodec.h"
35
36 #include "avio.h"
37
38 /* packet functions */
39
40 #ifndef MAXINT64
41 #define MAXINT64 int64_t_C(0x7fffffffffffffff)
42 #endif
43
44 #ifndef MININT64
45 #define MININT64 int64_t_C(0x8000000000000000)
46 #endif
47
48 typedef struct AVPacket {
49     int64_t pts;                            ///< presentation time stamp in time_base units
50     int64_t dts;                            ///< decompression time stamp in time_base units
51     uint8_t *data;
52     int   size;
53     int   stream_index;
54     int   flags;
55     int   duration;                         ///< presentation duration in time_base units (0 if not available)
56     void  (*destruct)(struct AVPacket *);
57     void  *priv;
58     int64_t pos;                            ///< byte position in stream, -1 if unknown
59 } AVPacket;
60 #define PKT_FLAG_KEY   0x0001
61
62 void av_destruct_packet_nofree(AVPacket *pkt);
63 void av_destruct_packet(AVPacket *pkt);
64
65 /* initialize optional fields of a packet */
66 static inline void av_init_packet(AVPacket *pkt)
67 {
68     pkt->pts   = AV_NOPTS_VALUE;
69     pkt->dts   = AV_NOPTS_VALUE;
70     pkt->pos   = -1;
71     pkt->duration = 0;
72     pkt->flags = 0;
73     pkt->stream_index = 0;
74     pkt->destruct= av_destruct_packet_nofree;
75 }
76
77 int av_new_packet(AVPacket *pkt, int size);
78 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
79 int av_dup_packet(AVPacket *pkt);
80
81 /**
82  * Free a packet
83  *
84  * @param pkt packet to free
85  */
86 static inline void av_free_packet(AVPacket *pkt)
87 {
88     if (pkt && pkt->destruct) {
89         pkt->destruct(pkt);
90     }
91 }
92
93 /*************************************************/
94 /* fractional numbers for exact pts handling */
95
96 /* the exact value of the fractional number is: 'val + num / den'. num
97    is assumed to be such as 0 <= num < den */
98 typedef struct AVFrac {
99     int64_t val, num, den;
100 } AVFrac attribute_deprecated;
101
102 /*************************************************/
103 /* input/output formats */
104
105 struct AVFormatContext;
106
107 /* this structure contains the data a format has to probe a file */
108 typedef struct AVProbeData {
109     const char *filename;
110     unsigned char *buf;
111     int buf_size;
112 } AVProbeData;
113
114 #define AVPROBE_SCORE_MAX 100               ///< max score, half of that is used for file extension based detection
115
116 typedef struct AVFormatParameters {
117     AVRational time_base;
118     int sample_rate;
119     int channels;
120     int width;
121     int height;
122     enum PixelFormat pix_fmt;
123     struct AVImageFormat *image_format;
124     int channel; /* used to select dv channel */
125     const char *device; /* video, audio or DV device */
126     const char *standard; /* tv standard, NTSC, PAL, SECAM */
127     int mpeg2ts_raw:1;  /* force raw MPEG2 transport stream output, if possible */
128     int mpeg2ts_compute_pcr:1; /* compute exact PCR for each transport
129                                   stream packet (only meaningful if
130                                   mpeg2ts_raw is TRUE */
131     int initial_pause:1;       /* do not begin to play the stream
132                                   immediately (RTSP only) */
133     int prealloced_context:1;
134     enum CodecID video_codec_id;
135     enum CodecID audio_codec_id;
136 } AVFormatParameters;
137
138 #define AVFMT_NOFILE        0x0001 /* no file should be opened */
139 #define AVFMT_NEEDNUMBER    0x0002 /* needs '%d' in filename */
140 #define AVFMT_SHOW_IDS      0x0008 /* show format stream IDs numbers */
141 #define AVFMT_RAWPICTURE    0x0020 /* format wants AVPicture structure for
142                                       raw picture data */
143 #define AVFMT_GLOBALHEADER  0x0040 /* format wants global header */
144 #define AVFMT_NOTIMESTAMPS  0x0080 /* format doesnt need / has any timestamps */
145
146 typedef struct AVOutputFormat {
147     const char *name;
148     const char *long_name;
149     const char *mime_type;
150     const char *extensions; /* comma separated extensions */
151     /* size of private data so that it can be allocated in the wrapper */
152     int priv_data_size;
153     /* output support */
154     enum CodecID audio_codec; /* default audio codec */
155     enum CodecID video_codec; /* default video codec */
156     int (*write_header)(struct AVFormatContext *);
157     int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
158     int (*write_trailer)(struct AVFormatContext *);
159     /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
160     int flags;
161     /* currently only used to set pixel format if not YUV420P */
162     int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
163     int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
164     /* private fields */
165     struct AVOutputFormat *next;
166 } AVOutputFormat;
167
168 typedef struct AVInputFormat {
169     const char *name;
170     const char *long_name;
171     /* size of private data so that it can be allocated in the wrapper */
172     int priv_data_size;
173     /* tell if a given file has a chance of being parsing by this format */
174     int (*read_probe)(AVProbeData *);
175     /* read the format header and initialize the AVFormatContext
176        structure. Return 0 if OK. 'ap' if non NULL contains
177        additionnal paramters. Only used in raw format right
178        now. 'av_new_stream' should be called to create new streams.  */
179     int (*read_header)(struct AVFormatContext *,
180                        AVFormatParameters *ap);
181     /* read one packet and put it in 'pkt'. pts and flags are also
182        set. 'av_new_stream' can be called only if the flag
183        AVFMTCTX_NOHEADER is used. */
184     int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
185     /* close the stream. The AVFormatContext and AVStreams are not
186        freed by this function */
187     int (*read_close)(struct AVFormatContext *);
188     /**
189      * seek to a given timestamp relative to the frames in
190      * stream component stream_index
191      * @param stream_index must not be -1
192      * @param flags selects which direction should be preferred if no exact
193      *              match is available
194      */
195     int (*read_seek)(struct AVFormatContext *,
196                      int stream_index, int64_t timestamp, int flags);
197     /**
198      * gets the next timestamp in AV_TIME_BASE units.
199      */
200     int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
201                               int64_t *pos, int64_t pos_limit);
202     /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
203     int flags;
204     /* if extensions are defined, then no probe is done. You should
205        usually not use extension format guessing because it is not
206        reliable enough */
207     const char *extensions;
208     /* general purpose read only value that the format can use */
209     int value;
210
211     /* start/resume playing - only meaningful if using a network based format
212        (RTSP) */
213     int (*read_play)(struct AVFormatContext *);
214
215     /* pause playing - only meaningful if using a network based format
216        (RTSP) */
217     int (*read_pause)(struct AVFormatContext *);
218
219     /* private fields */
220     struct AVInputFormat *next;
221 } AVInputFormat;
222
223 typedef struct AVIndexEntry {
224     int64_t pos;
225     int64_t timestamp;
226 #define AVINDEX_KEYFRAME 0x0001
227     int flags:2;
228     int size:30; //yeah trying to keep the size of this small to reduce memory requirements (its 24 vs 32 byte due to possible 8byte align)
229     int min_distance;         /* min distance between this and the previous keyframe, used to avoid unneeded searching */
230 } AVIndexEntry;
231
232 typedef struct AVStream {
233     int index;    /* stream index in AVFormatContext */
234     int id;       /* format specific stream id */
235     AVCodecContext *codec; /* codec context */
236     /**
237      * real base frame rate of the stream.
238      * for example if the timebase is 1/90000 and all frames have either
239      * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1
240      */
241     AVRational r_frame_rate;
242     void *priv_data;
243     /* internal data used in av_find_stream_info() */
244     int64_t codec_info_duration;
245     int codec_info_nb_frames;
246     /* encoding: PTS generation when outputing stream */
247     AVFrac pts;
248
249     /**
250      * this is the fundamental unit of time (in seconds) in terms
251      * of which frame timestamps are represented. for fixed-fps content,
252      * timebase should be 1/framerate and timestamp increments should be
253      * identically 1.
254      */
255     AVRational time_base;
256     int pts_wrap_bits; /* number of bits in pts (used for wrapping control) */
257     /* ffmpeg.c private use */
258     int stream_copy; /* if TRUE, just copy stream */
259     enum AVDiscard discard; ///< selects which packets can be discarded at will and dont need to be demuxed
260     //FIXME move stuff to a flags field?
261     /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
262      * MN:dunno if thats the right place, for it */
263     float quality;
264     /* decoding: position of the first frame of the component, in
265        AV_TIME_BASE fractional seconds. */
266     int64_t start_time;
267     /* decoding: duration of the stream, in AV_TIME_BASE fractional
268        seconds. */
269     int64_t duration;
270
271     char language[4]; /* ISO 639 3-letter language code (empty string if undefined) */
272
273     /* av_read_frame() support */
274     int need_parsing;                  ///< 1->full parsing needed, 2->only parse headers dont repack
275     struct AVCodecParserContext *parser;
276
277     int64_t cur_dts;
278     int last_IP_duration;
279     int64_t last_IP_pts;
280     /* av_seek_frame() support */
281     AVIndexEntry *index_entries; /* only used if the format does not
282                                     support seeking natively */
283     int nb_index_entries;
284     int index_entries_allocated_size;
285
286     int64_t nb_frames;                 ///< number of frames in this stream if known or 0
287
288 #define MAX_REORDER_DELAY 4
289     int64_t pts_buffer[MAX_REORDER_DELAY+1];
290 } AVStream;
291
292 #define AVFMTCTX_NOHEADER      0x0001 /* signal that no header is present
293                                          (streams are added dynamically) */
294
295 #define MAX_STREAMS 20
296
297 /* format I/O context */
298 typedef struct AVFormatContext {
299     const AVClass *av_class; /* set by av_alloc_format_context */
300     /* can only be iformat or oformat, not both at the same time */
301     struct AVInputFormat *iformat;
302     struct AVOutputFormat *oformat;
303     void *priv_data;
304     ByteIOContext pb;
305     int nb_streams;
306     AVStream *streams[MAX_STREAMS];
307     char filename[1024]; /* input or output filename */
308     /* stream info */
309     int64_t timestamp;
310     char title[512];
311     char author[512];
312     char copyright[512];
313     char comment[512];
314     char album[512];
315     int year;  /* ID3 year, 0 if none */
316     int track; /* track number, 0 if none */
317     char genre[32]; /* ID3 genre */
318
319     int ctx_flags; /* format specific flags, see AVFMTCTX_xx */
320     /* private data for pts handling (do not modify directly) */
321     /* This buffer is only needed when packets were already buffered but
322        not decoded, for example to get the codec parameters in mpeg
323        streams */
324     struct AVPacketList *packet_buffer;
325
326     /* decoding: position of the first frame of the component, in
327        AV_TIME_BASE fractional seconds. NEVER set this value directly:
328        it is deduced from the AVStream values.  */
329     int64_t start_time;
330     /* decoding: duration of the stream, in AV_TIME_BASE fractional
331        seconds. NEVER set this value directly: it is deduced from the
332        AVStream values.  */
333     int64_t duration;
334     /* decoding: total file size. 0 if unknown */
335     int64_t file_size;
336     /* decoding: total stream bitrate in bit/s, 0 if not
337        available. Never set it directly if the file_size and the
338        duration are known as ffmpeg can compute it automatically. */
339     int bit_rate;
340
341     /* av_read_frame() support */
342     AVStream *cur_st;
343     const uint8_t *cur_ptr;
344     int cur_len;
345     AVPacket cur_pkt;
346
347     /* av_seek_frame() support */
348     int64_t data_offset; /* offset of the first packet */
349     int index_built;
350
351     int mux_rate;
352     int packet_size;
353     int preload;
354     int max_delay;
355
356 #define AVFMT_NOOUTPUTLOOP -1
357 #define AVFMT_INFINITEOUTPUTLOOP 0
358     /* number of times to loop output in formats that support it */
359     int loop_output;
360
361     int flags;
362 #define AVFMT_FLAG_GENPTS       0x0001 ///< generate pts if missing even if it requires parsing future frames
363 #define AVFMT_FLAG_IGNIDX       0x0002 ///< ignore index
364
365     int loop_input;
366     /* decoding: size of data to probe; encoding unused */
367     unsigned int probesize;
368 } AVFormatContext;
369
370 typedef struct AVPacketList {
371     AVPacket pkt;
372     struct AVPacketList *next;
373 } AVPacketList;
374
375 extern AVInputFormat *first_iformat;
376 extern AVOutputFormat *first_oformat;
377
378 /* still image support */
379 struct AVInputImageContext attribute_deprecated;
380 typedef struct AVInputImageContext AVInputImageContext attribute_deprecated;
381
382 typedef struct AVImageInfo {
383     enum PixelFormat pix_fmt; /* requested pixel format */
384     int width; /* requested width */
385     int height; /* requested height */
386     int interleaved; /* image is interleaved (e.g. interleaved GIF) */
387     AVPicture pict; /* returned allocated image */
388 } AVImageInfo attribute_deprecated;
389
390 /* AVImageFormat.flags field constants */
391 #define AVIMAGE_INTERLEAVED 0x0001 /* image format support interleaved output */
392
393 typedef struct AVImageFormat {
394     const char *name;
395     const char *extensions;
396     /* tell if a given file has a chance of being parsing by this format */
397     int (*img_probe)(AVProbeData *);
398     /* read a whole image. 'alloc_cb' is called when the image size is
399        known so that the caller can allocate the image. If 'allo_cb'
400        returns non zero, then the parsing is aborted. Return '0' if
401        OK. */
402     int (*img_read)(ByteIOContext *,
403                     int (*alloc_cb)(void *, AVImageInfo *info), void *);
404     /* write the image */
405     int supported_pixel_formats; /* mask of supported formats for output */
406     int (*img_write)(ByteIOContext *, AVImageInfo *);
407     int flags;
408     struct AVImageFormat *next;
409 } AVImageFormat attribute_deprecated;
410
411 void av_register_image_format(AVImageFormat *img_fmt) attribute_deprecated;
412 AVImageFormat *av_probe_image_format(AVProbeData *pd) attribute_deprecated;
413 AVImageFormat *guess_image_format(const char *filename) attribute_deprecated;
414 enum CodecID av_guess_image2_codec(const char *filename);
415 int av_read_image(ByteIOContext *pb, const char *filename,
416                   AVImageFormat *fmt,
417                   int (*alloc_cb)(void *, AVImageInfo *info), void *opaque) attribute_deprecated;
418 int av_write_image(ByteIOContext *pb, AVImageFormat *fmt, AVImageInfo *img) attribute_deprecated;
419
420 extern AVImageFormat *first_image_format attribute_deprecated;
421
422 /* XXX: use automatic init with either ELF sections or C file parser */
423 /* modules */
424
425 #include "rtp.h"
426
427 #include "rtsp.h"
428
429 /* utils.c */
430 void av_register_input_format(AVInputFormat *format);
431 void av_register_output_format(AVOutputFormat *format);
432 AVOutputFormat *guess_stream_format(const char *short_name,
433                                     const char *filename, const char *mime_type);
434 AVOutputFormat *guess_format(const char *short_name,
435                              const char *filename, const char *mime_type);
436 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
437                             const char *filename, const char *mime_type, enum CodecType type);
438
439 void av_hex_dump(FILE *f, uint8_t *buf, int size);
440 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
441
442 void av_register_all(void);
443
444 /* media file input */
445 AVInputFormat *av_find_input_format(const char *short_name);
446 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
447 int av_open_input_stream(AVFormatContext **ic_ptr,
448                          ByteIOContext *pb, const char *filename,
449                          AVInputFormat *fmt, AVFormatParameters *ap);
450 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
451                        AVInputFormat *fmt,
452                        int buf_size,
453                        AVFormatParameters *ap);
454 /* no av_open for output, so applications will need this: */
455 AVFormatContext *av_alloc_format_context(void);
456
457 #define AVERROR_UNKNOWN     (-1)  /* unknown error */
458 #define AVERROR_IO          (-2)  /* i/o error */
459 #define AVERROR_NUMEXPECTED (-3)  /* number syntax expected in filename */
460 #define AVERROR_INVALIDDATA (-4)  /* invalid data found */
461 #define AVERROR_NOMEM       (-5)  /* not enough memory */
462 #define AVERROR_NOFMT       (-6)  /* unknown format */
463 #define AVERROR_NOTSUPP     (-7)  /* operation not supported */
464
465 int av_find_stream_info(AVFormatContext *ic);
466 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
467 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
468 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
469 int av_read_play(AVFormatContext *s);
470 int av_read_pause(AVFormatContext *s);
471 void av_close_input_file(AVFormatContext *s);
472 AVStream *av_new_stream(AVFormatContext *s, int id);
473 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
474                      int pts_num, int pts_den);
475
476 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
477 #define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
478 #define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non keyframes
479
480 int av_find_default_stream_index(AVFormatContext *s);
481 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
482 int av_add_index_entry(AVStream *st,
483                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
484 int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
485 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
486
487 /* media file output */
488 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
489 int av_write_header(AVFormatContext *s);
490 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
491 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
492 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
493
494 int av_write_trailer(AVFormatContext *s);
495
496 void dump_format(AVFormatContext *ic,
497                  int index,
498                  const char *url,
499                  int is_output);
500 int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
501 int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
502 int64_t parse_date(const char *datestr, int duration);
503
504 int64_t av_gettime(void);
505
506 /* ffm specific for ffserver */
507 #define FFM_PACKET_SIZE 4096
508 offset_t ffm_read_write_index(int fd);
509 void ffm_write_write_index(int fd, offset_t pos);
510 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
511
512 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
513
514 int av_get_frame_filename(char *buf, int buf_size,
515                           const char *path, int number);
516 int av_filename_number_test(const char *filename);
517
518 /* grab specific */
519 int video_grab_init(void);
520 int audio_init(void);
521
522 /* DV1394 */
523 int dv1394_init(void);
524 int dc1394_init(void);
525
526 #ifdef HAVE_AV_CONFIG_H
527
528 #include "os_support.h"
529
530 int strstart(const char *str, const char *val, const char **ptr);
531 int stristart(const char *str, const char *val, const char **ptr);
532 void pstrcpy(char *buf, int buf_size, const char *str);
533 char *pstrcat(char *buf, int buf_size, const char *s);
534
535 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
536
537 #ifdef __GNUC__
538 #define dynarray_add(tab, nb_ptr, elem)\
539 do {\
540     typeof(tab) _tab = (tab);\
541     typeof(elem) _elem = (elem);\
542     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
543     __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
544 } while(0)
545 #else
546 #define dynarray_add(tab, nb_ptr, elem)\
547 do {\
548     __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
549 } while(0)
550 #endif
551
552 time_t mktimegm(struct tm *tm);
553 struct tm *brktimegm(time_t secs, struct tm *tm);
554 const char *small_strptime(const char *p, const char *fmt,
555                            struct tm *dt);
556
557 struct in_addr;
558 int resolve_host(struct in_addr *sin_addr, const char *hostname);
559
560 void url_split(char *proto, int proto_size,
561                char *authorization, int authorization_size,
562                char *hostname, int hostname_size,
563                int *port_ptr,
564                char *path, int path_size,
565                const char *url);
566
567 int match_ext(const char *filename, const char *extensions);
568
569 #endif /* HAVE_AV_CONFIG_H */
570
571 #ifdef __cplusplus
572 }
573 #endif
574
575 #endif /* AVFORMAT_H */
576