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