Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 4647c0ec

History | View | Annotate | Download (19.1 KB)

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_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
    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
     * for example if the timebase is 1/90000 and all frames have either
240
     * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1
241
     */
242
    AVRational r_frame_rate;
243
    void *priv_data;
244
    /* internal data used in av_find_stream_info() */
245
    int64_t codec_info_duration;
246
    int codec_info_nb_frames;
247
    /* encoding: PTS generation when outputing stream */
248
    AVFrac pts;
249

    
250
    /**
251
     * this is the fundamental unit of time (in seconds) in terms
252
     * of which frame timestamps are represented. for fixed-fps content,
253
     * timebase should be 1/framerate and timestamp increments should be
254
     * identically 1.
255
     */
256
    AVRational time_base;
257
    int pts_wrap_bits; /* number of bits in pts (used for wrapping control) */
258
    /* ffmpeg.c private use */
259
    int stream_copy; /* if TRUE, just copy stream */
260
    enum AVDiscard discard; ///< selects which packets can be discarded at will and dont need to be demuxed
261
    //FIXME move stuff to a flags field?
262
    /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
263
     * MN:dunno if thats the right place, for it */
264
    float quality;
265
    /* decoding: position of the first frame of the component, in
266
       AV_TIME_BASE fractional seconds. */
267
    int64_t start_time;
268
    /* decoding: duration of the stream, in AV_TIME_BASE fractional
269
       seconds. */
270
    int64_t duration;
271

    
272
    char language[4]; /* ISO 639 3-letter language code (empty string if undefined) */
273

    
274
    /* av_read_frame() support */
275
    int need_parsing;                  ///< 1->full parsing needed, 2->only parse headers dont repack
276
    struct AVCodecParserContext *parser;
277

    
278
    int64_t cur_dts;
279
    int last_IP_duration;
280
    int64_t last_IP_pts;
281
    /* av_seek_frame() support */
282
    AVIndexEntry *index_entries; /* only used if the format does not
283
                                    support seeking natively */
284
    int nb_index_entries;
285
    unsigned int index_entries_allocated_size;
286

    
287
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
288

    
289
#define MAX_REORDER_DELAY 4
290
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
291
} AVStream;
292

    
293
#define AVFMTCTX_NOHEADER      0x0001 /* signal that no header is present
294
                                         (streams are added dynamically) */
295

    
296
#define MAX_STREAMS 20
297

    
298
/* format I/O context */
299
typedef struct AVFormatContext {
300
    const AVClass *av_class; /* set by av_alloc_format_context */
301
    /* can only be iformat or oformat, not both at the same time */
302
    struct AVInputFormat *iformat;
303
    struct AVOutputFormat *oformat;
304
    void *priv_data;
305
    ByteIOContext pb;
306
    int nb_streams;
307
    AVStream *streams[MAX_STREAMS];
308
    char filename[1024]; /* input or output filename */
309
    /* stream info */
310
    int64_t timestamp;
311
    char title[512];
312
    char author[512];
313
    char copyright[512];
314
    char comment[512];
315
    char album[512];
316
    int year;  /* ID3 year, 0 if none */
317
    int track; /* track number, 0 if none */
318
    char genre[32]; /* ID3 genre */
319

    
320
    int ctx_flags; /* format specific flags, see AVFMTCTX_xx */
321
    /* private data for pts handling (do not modify directly) */
322
    /* This buffer is only needed when packets were already buffered but
323
       not decoded, for example to get the codec parameters in mpeg
324
       streams */
325
    struct AVPacketList *packet_buffer;
326

    
327
    /* decoding: position of the first frame of the component, in
328
       AV_TIME_BASE fractional seconds. NEVER set this value directly:
329
       it is deduced from the AVStream values.  */
330
    int64_t start_time;
331
    /* decoding: duration of the stream, in AV_TIME_BASE fractional
332
       seconds. NEVER set this value directly: it is deduced from the
333
       AVStream values.  */
334
    int64_t duration;
335
    /* decoding: total file size. 0 if unknown */
336
    int64_t file_size;
337
    /* decoding: total stream bitrate in bit/s, 0 if not
338
       available. Never set it directly if the file_size and the
339
       duration are known as ffmpeg can compute it automatically. */
340
    int bit_rate;
341

    
342
    /* av_read_frame() support */
343
    AVStream *cur_st;
344
    const uint8_t *cur_ptr;
345
    int cur_len;
346
    AVPacket cur_pkt;
347

    
348
    /* av_seek_frame() support */
349
    int64_t data_offset; /* offset of the first packet */
350
    int index_built;
351

    
352
    int mux_rate;
353
    int packet_size;
354
    int preload;
355
    int max_delay;
356

    
357
#define AVFMT_NOOUTPUTLOOP -1
358
#define AVFMT_INFINITEOUTPUTLOOP 0
359
    /* number of times to loop output in formats that support it */
360
    int loop_output;
361

    
362
    int flags;
363
#define AVFMT_FLAG_GENPTS       0x0001 ///< generate pts if missing even if it requires parsing future frames
364
#define AVFMT_FLAG_IGNIDX       0x0002 ///< ignore index
365

    
366
    int loop_input;
367
    /* decoding: size of data to probe; encoding unused */
368
    unsigned int probesize;
369
} AVFormatContext;
370

    
371
typedef struct AVPacketList {
372
    AVPacket pkt;
373
    struct AVPacketList *next;
374
} AVPacketList;
375

    
376
extern AVInputFormat *first_iformat;
377
extern AVOutputFormat *first_oformat;
378

    
379
enum CodecID av_guess_image2_codec(const char *filename);
380

    
381
/* XXX: use automatic init with either ELF sections or C file parser */
382
/* modules */
383

    
384
#include "rtp.h"
385

    
386
#include "rtsp.h"
387

    
388
/* utils.c */
389
void av_register_input_format(AVInputFormat *format);
390
void av_register_output_format(AVOutputFormat *format);
391
AVOutputFormat *guess_stream_format(const char *short_name,
392
                                    const char *filename, const char *mime_type);
393
AVOutputFormat *guess_format(const char *short_name,
394
                             const char *filename, const char *mime_type);
395
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
396
                            const char *filename, const char *mime_type, enum CodecType type);
397

    
398
void av_hex_dump(FILE *f, uint8_t *buf, int size);
399
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
400

    
401
void av_register_all(void);
402

    
403
/* media file input */
404
AVInputFormat *av_find_input_format(const char *short_name);
405
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
406
int av_open_input_stream(AVFormatContext **ic_ptr,
407
                         ByteIOContext *pb, const char *filename,
408
                         AVInputFormat *fmt, AVFormatParameters *ap);
409
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
410
                       AVInputFormat *fmt,
411
                       int buf_size,
412
                       AVFormatParameters *ap);
413
/* no av_open for output, so applications will need this: */
414
AVFormatContext *av_alloc_format_context(void);
415

    
416
#define AVERROR_UNKNOWN     (-1)  /* unknown error */
417
#define AVERROR_IO          (-2)  /* i/o error */
418
#define AVERROR_NUMEXPECTED (-3)  /* number syntax expected in filename */
419
#define AVERROR_INVALIDDATA (-4)  /* invalid data found */
420
#define AVERROR_NOMEM       (-5)  /* not enough memory */
421
#define AVERROR_NOFMT       (-6)  /* unknown format */
422
#define AVERROR_NOTSUPP     (-7)  /* operation not supported */
423

    
424
int av_find_stream_info(AVFormatContext *ic);
425
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
426
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
427
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
428
int av_read_play(AVFormatContext *s);
429
int av_read_pause(AVFormatContext *s);
430
void av_close_input_file(AVFormatContext *s);
431
AVStream *av_new_stream(AVFormatContext *s, int id);
432
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
433
                     int pts_num, int pts_den);
434

    
435
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
436
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
437
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non keyframes
438

    
439
int av_find_default_stream_index(AVFormatContext *s);
440
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
441
int av_add_index_entry(AVStream *st,
442
                       int64_t pos, int64_t timestamp, int size, int distance, int flags);
443
int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
444
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
445

    
446
/* media file output */
447
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
448
int av_write_header(AVFormatContext *s);
449
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
450
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
451
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
452

    
453
int av_write_trailer(AVFormatContext *s);
454

    
455
void dump_format(AVFormatContext *ic,
456
                 int index,
457
                 const char *url,
458
                 int is_output);
459
int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
460
int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
461
int64_t parse_date(const char *datestr, int duration);
462

    
463
int64_t av_gettime(void);
464

    
465
/* ffm specific for ffserver */
466
#define FFM_PACKET_SIZE 4096
467
offset_t ffm_read_write_index(int fd);
468
void ffm_write_write_index(int fd, offset_t pos);
469
void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
470

    
471
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
472

    
473
int av_get_frame_filename(char *buf, int buf_size,
474
                          const char *path, int number);
475
int av_filename_number_test(const char *filename);
476

    
477
/* grab specific */
478
int video_grab_init(void);
479
int audio_init(void);
480

    
481
/* DV1394 */
482
int dv1394_init(void);
483
int dc1394_init(void);
484

    
485
#ifdef HAVE_AV_CONFIG_H
486

    
487
#include "os_support.h"
488

    
489
int strstart(const char *str, const char *val, const char **ptr);
490
int stristart(const char *str, const char *val, const char **ptr);
491
void pstrcpy(char *buf, int buf_size, const char *str);
492
char *pstrcat(char *buf, int buf_size, const char *s);
493

    
494
void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
495

    
496
#ifdef __GNUC__
497
#define dynarray_add(tab, nb_ptr, elem)\
498
do {\
499
    typeof(tab) _tab = (tab);\
500
    typeof(elem) _elem = (elem);\
501
    (void)sizeof(**_tab == _elem); /* check that types are compatible */\
502
    __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
503
} while(0)
504
#else
505
#define dynarray_add(tab, nb_ptr, elem)\
506
do {\
507
    __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
508
} while(0)
509
#endif
510

    
511
time_t mktimegm(struct tm *tm);
512
struct tm *brktimegm(time_t secs, struct tm *tm);
513
const char *small_strptime(const char *p, const char *fmt,
514
                           struct tm *dt);
515

    
516
struct in_addr;
517
int resolve_host(struct in_addr *sin_addr, const char *hostname);
518

    
519
void url_split(char *proto, int proto_size,
520
               char *authorization, int authorization_size,
521
               char *hostname, int hostname_size,
522
               int *port_ptr,
523
               char *path, int path_size,
524
               const char *url);
525

    
526
int match_ext(const char *filename, const char *extensions);
527

    
528
#endif /* HAVE_AV_CONFIG_H */
529

    
530
#ifdef __cplusplus
531
}
532
#endif
533

    
534
#endif /* AVFORMAT_H */
535