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