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