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