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