Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 54bc6403

History | View | Annotate | Download (57.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_AVFORMAT_H
22
#define AVFORMAT_AVFORMAT_H
23

    
24
#define LIBAVFORMAT_VERSION_MAJOR 52
25
#define LIBAVFORMAT_VERSION_MINOR 94
26
#define LIBAVFORMAT_VERSION_MICRO  0
27

    
28
#define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \
29
                                               LIBAVFORMAT_VERSION_MINOR, \
30
                                               LIBAVFORMAT_VERSION_MICRO)
31
#define LIBAVFORMAT_VERSION     AV_VERSION(LIBAVFORMAT_VERSION_MAJOR,   \
32
                                           LIBAVFORMAT_VERSION_MINOR,   \
33
                                           LIBAVFORMAT_VERSION_MICRO)
34
#define LIBAVFORMAT_BUILD       LIBAVFORMAT_VERSION_INT
35

    
36
#define LIBAVFORMAT_IDENT       "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
37

    
38
/**
39
 * Those FF_API_* defines are not part of public API.
40
 * They may change, break or disappear at any time.
41
 */
42
#ifndef FF_API_MAX_STREAMS
43
#define FF_API_MAX_STREAMS             (LIBAVFORMAT_VERSION_MAJOR < 53)
44
#endif
45
#ifndef FF_API_OLD_METADATA
46
#define FF_API_OLD_METADATA            (LIBAVFORMAT_VERSION_MAJOR < 53)
47
#endif
48
#ifndef FF_API_URL_CLASS
49
#define FF_API_URL_CLASS               (LIBAVFORMAT_VERSION_MAJOR >= 53)
50
#endif
51
#ifndef FF_API_URL_RESETBUF
52
#define FF_API_URL_RESETBUF            (LIBAVFORMAT_VERSION_MAJOR < 53)
53
#endif
54
#ifndef FF_API_REGISTER_PROTOCOL
55
#define FF_API_REGISTER_PROTOCOL       (LIBAVFORMAT_VERSION_MAJOR < 53)
56
#endif
57
#ifndef FF_API_GUESS_FORMAT
58
#define FF_API_GUESS_FORMAT            (LIBAVFORMAT_VERSION_MAJOR < 53)
59
#endif
60
#ifndef FF_API_UDP_GET_FILE
61
#define FF_API_UDP_GET_FILE            (LIBAVFORMAT_VERSION_MAJOR < 53)
62
#endif
63
#ifndef FF_API_URL_SPLIT
64
#define FF_API_URL_SPLIT               (LIBAVFORMAT_VERSION_MAJOR < 53)
65
#endif
66
#ifndef FF_API_ALLOC_FORMAT_CONTEXT
67
#define FF_API_ALLOC_FORMAT_CONTEXT    (LIBAVFORMAT_VERSION_MAJOR < 53)
68
#endif
69
#ifndef FF_API_PARSE_FRAME_PARAM
70
#define FF_API_PARSE_FRAME_PARAM       (LIBAVFORMAT_VERSION_MAJOR < 53)
71
#endif
72
#ifndef FF_API_READ_SEEK
73
#define FF_API_READ_SEEK               (LIBAVFORMAT_VERSION_MAJOR < 54)
74
#endif
75
#ifndef FF_API_LAVF_UNUSED
76
#define FF_API_LAVF_UNUSED             (LIBAVFORMAT_VERSION_MAJOR < 53)
77
#endif
78
#ifndef FF_API_PARAMETERS_CODEC_ID
79
#define FF_API_PARAMETERS_CODEC_ID     (LIBAVFORMAT_VERSION_MAJOR < 53)
80
#endif
81
#ifndef FF_API_FIRST_FORMAT
82
#define FF_API_FIRST_FORMAT            (LIBAVFORMAT_VERSION_MAJOR < 53)
83
#endif
84
#ifndef FF_API_SYMVER
85
#define FF_API_SYMVER                  (LIBAVFORMAT_VERSION_MAJOR < 53)
86
#endif
87

    
88
/**
89
 * I return the LIBAVFORMAT_VERSION_INT constant.  You got
90
 * a fucking problem with that, douchebag?
91
 */
92
unsigned avformat_version(void);
93

    
94
/**
95
 * Return the libavformat build-time configuration.
96
 */
97
const char *avformat_configuration(void);
98

    
99
/**
100
 * Return the libavformat license.
101
 */
102
const char *avformat_license(void);
103

    
104
#include <time.h>
105
#include <stdio.h>  /* FILE */
106
#include "libavcodec/avcodec.h"
107

    
108
#include "avio.h"
109

    
110
struct AVFormatContext;
111

    
112

    
113
/*
114
 * Public Metadata API.
115
 * The metadata API allows libavformat to export metadata tags to a client
116
 * application using a sequence of key/value pairs. Like all strings in FFmpeg,
117
 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
118
 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
119
 * Important concepts to keep in mind:
120
 * 1. Keys are unique; there can never be 2 tags with the same key. This is
121
 *    also meant semantically, i.e., a demuxer should not knowingly produce
122
 *    several keys that are literally different but semantically identical.
123
 *    E.g., key=Author5, key=Author6. In this example, all authors must be
124
 *    placed in the same tag.
125
 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
126
 *    want to store, e.g., the email address of the child of producer Alice
127
 *    and actor Bob, that could have key=alice_and_bobs_childs_email_address.
128
 * 3. Several modifiers can be applied to the tag name. This is done by
129
 *    appending a dash character ('-') and the modifier name in the order
130
 *    they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
131
 *    a) language -- a tag whose value is localized for a particular language
132
 *       is appended with the ISO 639-2/B 3-letter language code.
133
 *       For example: Author-ger=Michael, Author-eng=Mike
134
 *       The original/default language is in the unqualified "Author" tag.
135
 *       A demuxer should set a default if it sets any translated tag.
136
 *    b) sorting  -- a modified version of a tag that should be used for
137
 *       sorting will have '-sort' appended. E.g. artist="The Beatles",
138
 *       artist-sort="Beatles, The".
139
 *
140
 * 4. Demuxers attempt to export metadata in a generic format, however tags
141
 *    with no generic equivalents are left as they are stored in the container.
142
 *    Follows a list of generic tag names:
143
 *
144
 * album        -- name of the set this work belongs to
145
 * album_artist -- main creator of the set/album, if different from artist.
146
 *                 e.g. "Various Artists" for compilation albums.
147
 * artist       -- main creator of the work
148
 * comment      -- any additional description of the file.
149
 * composer     -- who composed the work, if different from artist.
150
 * copyright    -- name of copyright holder.
151
 * creation_time-- date when the file was created, preferably in ISO 8601.
152
 * date         -- date when the work was created, preferably in ISO 8601.
153
 * disc         -- number of a subset, e.g. disc in a multi-disc collection.
154
 * encoder      -- name/settings of the software/hardware that produced the file.
155
 * encoded_by   -- person/group who created the file.
156
 * filename     -- original name of the file.
157
 * genre        -- <self-evident>.
158
 * language     -- main language in which the work is performed, preferably
159
 *                 in ISO 639-2 format.
160
 * performer    -- artist who performed the work, if different from artist.
161
 *                 E.g for "Also sprach Zarathustra", artist would be "Richard
162
 *                 Strauss" and performer "London Philharmonic Orchestra".
163
 * publisher    -- name of the label/publisher.
164
 * title        -- name of the work.
165
 * track        -- number of this work in the set, can be in form current/total.
166
 */
167

    
168
#define AV_METADATA_MATCH_CASE      1
169
#define AV_METADATA_IGNORE_SUFFIX   2
170
#define AV_METADATA_DONT_STRDUP_KEY 4
171
#define AV_METADATA_DONT_STRDUP_VAL 8
172
#define AV_METADATA_DONT_OVERWRITE 16   ///< Don't overwrite existing tags.
173

    
174
typedef struct {
175
    char *key;
176
    char *value;
177
}AVMetadataTag;
178

    
179
typedef struct AVMetadata AVMetadata;
180
#if FF_API_OLD_METADATA
181
typedef struct AVMetadataConv AVMetadataConv;
182
#endif
183

    
184
/**
185
 * Get a metadata element with matching key.
186
 *
187
 * @param prev Set to the previous matching element to find the next.
188
 *             If set to NULL the first matching element is returned.
189
 * @param flags Allows case as well as suffix-insensitive comparisons.
190
 * @return Found tag or NULL, changing key or value leads to undefined behavior.
191
 */
192
AVMetadataTag *
193
av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
194

    
195
#if FF_API_OLD_METADATA
196
/**
197
 * Set the given tag in *pm, overwriting an existing tag.
198
 *
199
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
200
 * a metadata struct is allocated and put in *pm.
201
 * @param key tag key to add to *pm (will be av_strduped)
202
 * @param value tag value to add to *pm (will be av_strduped)
203
 * @return >= 0 on success otherwise an error code <0
204
 * @deprecated Use av_metadata_set2() instead.
205
 */
206
attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
207
#endif
208

    
209
/**
210
 * Set the given tag in *pm, overwriting an existing tag.
211
 *
212
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
213
 * a metadata struct is allocated and put in *pm.
214
 * @param key tag key to add to *pm (will be av_strduped depending on flags)
215
 * @param value tag value to add to *pm (will be av_strduped depending on flags).
216
 *        Passing a NULL value will cause an existing tag to be deleted.
217
 * @return >= 0 on success otherwise an error code <0
218
 */
219
int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
220

    
221
#if FF_API_OLD_METADATA
222
/**
223
 * This function is provided for compatibility reason and currently does nothing.
224
 */
225
attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
226
                                                                        const AVMetadataConv *s_conv);
227
#endif
228

    
229
/**
230
 * Copy metadata from one AVMetadata struct into another.
231
 * @param dst pointer to a pointer to a AVMetadata struct. If *dst is NULL,
232
 *            this function will allocate a struct for you and put it in *dst
233
 * @param src pointer to source AVMetadata struct
234
 * @param flags flags to use when setting metadata in *dst
235
 * @note metadata is read using the AV_METADATA_IGNORE_SUFFIX flag
236
 */
237
void av_metadata_copy(AVMetadata **dst, AVMetadata *src, int flags);
238

    
239
/**
240
 * Free all the memory allocated for an AVMetadata struct.
241
 */
242
void av_metadata_free(AVMetadata **m);
243

    
244

    
245
/* packet functions */
246

    
247

    
248
/**
249
 * Allocate and read the payload of a packet and initialize its
250
 * fields with default values.
251
 *
252
 * @param pkt packet
253
 * @param size desired payload size
254
 * @return >0 (read size) if OK, AVERROR_xxx otherwise
255
 */
256
int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
257

    
258

    
259
/**
260
 * Read data and append it to the current content of the AVPacket.
261
 * If pkt->size is 0 this is identical to av_get_packet.
262
 * Note that this uses av_grow_packet and thus involves a realloc
263
 * which is inefficient. Thus this function should only be used
264
 * when there is no reasonable way to know (an upper bound of)
265
 * the final size.
266
 *
267
 * @param pkt packet
268
 * @param size amount of data to read
269
 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
270
 *         will not be lost even if an error occurs.
271
 */
272
int av_append_packet(ByteIOContext *s, AVPacket *pkt, int size);
273

    
274
/*************************************************/
275
/* fractional numbers for exact pts handling */
276

    
277
/**
278
 * The exact value of the fractional number is: 'val + num / den'.
279
 * num is assumed to be 0 <= num < den.
280
 */
281
typedef struct AVFrac {
282
    int64_t val, num, den;
283
} AVFrac;
284

    
285
/*************************************************/
286
/* input/output formats */
287

    
288
struct AVCodecTag;
289

    
290
/**
291
 * This structure contains the data a format has to probe a file.
292
 */
293
typedef struct AVProbeData {
294
    const char *filename;
295
    unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
296
    int buf_size;       /**< Size of buf except extra allocated bytes */
297
} AVProbeData;
298

    
299
#define AVPROBE_SCORE_MAX 100               ///< maximum score, half of that is used for file-extension-based detection
300
#define AVPROBE_PADDING_SIZE 32             ///< extra allocated bytes at the end of the probe buffer
301

    
302
typedef struct AVFormatParameters {
303
    AVRational time_base;
304
    int sample_rate;
305
    int channels;
306
    int width;
307
    int height;
308
    enum PixelFormat pix_fmt;
309
    int channel; /**< Used to select DV channel. */
310
    const char *standard; /**< TV standard, NTSC, PAL, SECAM */
311
    unsigned int mpeg2ts_raw:1;  /**< Force raw MPEG-2 transport stream output, if possible. */
312
    unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
313
                                            stream packet (only meaningful if
314
                                            mpeg2ts_raw is TRUE). */
315
    unsigned int initial_pause:1;       /**< Do not begin to play the stream
316
                                            immediately (RTSP only). */
317
    unsigned int prealloced_context:1;
318
#if FF_API_PARAMETERS_CODEC_ID
319
    attribute_deprecated enum CodecID video_codec_id;
320
    attribute_deprecated enum CodecID audio_codec_id;
321
#endif
322
} AVFormatParameters;
323

    
324
//! Demuxer will use url_fopen, no opened file should be provided by the caller.
325
#define AVFMT_NOFILE        0x0001
326
#define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
327
#define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
328
#define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
329
                                      raw picture data. */
330
#define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
331
#define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
332
#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
333
#define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
334
#define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
335
#define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
336
#define AVFMT_NOSTREAMS     0x1000 /**< Format does not require any streams */
337

    
338
typedef struct AVOutputFormat {
339
    const char *name;
340
    /**
341
     * Descriptive name for the format, meant to be more human-readable
342
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
343
     * to define it.
344
     */
345
    const char *long_name;
346
    const char *mime_type;
347
    const char *extensions; /**< comma-separated filename extensions */
348
    /**
349
     * size of private data so that it can be allocated in the wrapper
350
     */
351
    int priv_data_size;
352
    /* output support */
353
    enum CodecID audio_codec; /**< default audio codec */
354
    enum CodecID video_codec; /**< default video codec */
355
    int (*write_header)(struct AVFormatContext *);
356
    int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
357
    int (*write_trailer)(struct AVFormatContext *);
358
    /**
359
     * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER
360
     */
361
    int flags;
362
    /**
363
     * Currently only used to set pixel format if not YUV420P.
364
     */
365
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
366
    int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
367
                             AVPacket *in, int flush);
368

    
369
    /**
370
     * List of supported codec_id-codec_tag pairs, ordered by "better
371
     * choice first". The arrays are all terminated by CODEC_ID_NONE.
372
     */
373
    const struct AVCodecTag * const *codec_tag;
374

    
375
    enum CodecID subtitle_codec; /**< default subtitle codec */
376

    
377
#if FF_API_OLD_METADATA
378
    const AVMetadataConv *metadata_conv;
379
#endif
380

    
381
    const AVClass *priv_class; ///< AVClass for the private context
382

    
383
    /* private fields */
384
    struct AVOutputFormat *next;
385
} AVOutputFormat;
386

    
387
typedef struct AVInputFormat {
388
    /**
389
     * A comma separated list of short names for the format. New names
390
     * may be appended with a minor bump.
391
     */
392
    const char *name;
393

    
394
    /**
395
     * Descriptive name for the format, meant to be more human-readable
396
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
397
     * to define it.
398
     */
399
    const char *long_name;
400

    
401
    /**
402
     * Size of private data so that it can be allocated in the wrapper.
403
     */
404
    int priv_data_size;
405

    
406
    /**
407
     * Tell if a given file has a chance of being parsed as this format.
408
     * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
409
     * big so you do not have to check for that unless you need more.
410
     */
411
    int (*read_probe)(AVProbeData *);
412

    
413
    /**
414
     * Read the format header and initialize the AVFormatContext
415
     * structure. Return 0 if OK. 'ap' if non-NULL contains
416
     * additional parameters. Only used in raw format right
417
     * now. 'av_new_stream' should be called to create new streams.
418
     */
419
    int (*read_header)(struct AVFormatContext *,
420
                       AVFormatParameters *ap);
421

    
422
    /**
423
     * Read one packet and put it in 'pkt'. pts and flags are also
424
     * set. 'av_new_stream' can be called only if the flag
425
     * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
426
     * background thread).
427
     * @return 0 on success, < 0 on error.
428
     *         When returning an error, pkt must not have been allocated
429
     *         or must be freed before returning
430
     */
431
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
432

    
433
    /**
434
     * Close the stream. The AVFormatContext and AVStreams are not
435
     * freed by this function
436
     */
437
    int (*read_close)(struct AVFormatContext *);
438

    
439
#if FF_API_READ_SEEK
440
    /**
441
     * Seek to a given timestamp relative to the frames in
442
     * stream component stream_index.
443
     * @param stream_index Must not be -1.
444
     * @param flags Selects which direction should be preferred if no exact
445
     *              match is available.
446
     * @return >= 0 on success (but not necessarily the new offset)
447
     */
448
    attribute_deprecated int (*read_seek)(struct AVFormatContext *,
449
                                          int stream_index, int64_t timestamp, int flags);
450
#endif
451
    /**
452
     * Gets the next timestamp in stream[stream_index].time_base units.
453
     * @return the timestamp or AV_NOPTS_VALUE if an error occurred
454
     */
455
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
456
                              int64_t *pos, int64_t pos_limit);
457

    
458
    /**
459
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
460
     */
461
    int flags;
462

    
463
    /**
464
     * If extensions are defined, then no probe is done. You should
465
     * usually not use extension format guessing because it is not
466
     * reliable enough
467
     */
468
    const char *extensions;
469

    
470
    /**
471
     * General purpose read-only value that the format can use.
472
     */
473
    int value;
474

    
475
    /**
476
     * Start/resume playing - only meaningful if using a network-based format
477
     * (RTSP).
478
     */
479
    int (*read_play)(struct AVFormatContext *);
480

    
481
    /**
482
     * Pause playing - only meaningful if using a network-based format
483
     * (RTSP).
484
     */
485
    int (*read_pause)(struct AVFormatContext *);
486

    
487
    const struct AVCodecTag * const *codec_tag;
488

    
489
    /**
490
     * Seek to timestamp ts.
491
     * Seeking will be done so that the point from which all active streams
492
     * can be presented successfully will be closest to ts and within min/max_ts.
493
     * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
494
     */
495
    int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
496

    
497
#if FF_API_OLD_METADATA
498
    const AVMetadataConv *metadata_conv;
499
#endif
500

    
501
    /* private fields */
502
    struct AVInputFormat *next;
503
} AVInputFormat;
504

    
505
enum AVStreamParseType {
506
    AVSTREAM_PARSE_NONE,
507
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
508
    AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
509
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
510
    AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
511
};
512

    
513
typedef struct AVIndexEntry {
514
    int64_t pos;
515
    int64_t timestamp;
516
#define AVINDEX_KEYFRAME 0x0001
517
    int flags:2;
518
    int size:30; //Yeah, trying to keep the size of this small to reduce memory requirements (it is 24 vs. 32 bytes due to possible 8-byte alignment).
519
    int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
520
} AVIndexEntry;
521

    
522
#define AV_DISPOSITION_DEFAULT   0x0001
523
#define AV_DISPOSITION_DUB       0x0002
524
#define AV_DISPOSITION_ORIGINAL  0x0004
525
#define AV_DISPOSITION_COMMENT   0x0008
526
#define AV_DISPOSITION_LYRICS    0x0010
527
#define AV_DISPOSITION_KARAOKE   0x0020
528

    
529
/**
530
 * Track should be used during playback by default.
531
 * Useful for subtitle track that should be displayed
532
 * even when user did not explicitly ask for subtitles.
533
 */
534
#define AV_DISPOSITION_FORCED    0x0040
535

    
536
/**
537
 * Stream structure.
538
 * New fields can be added to the end with minor version bumps.
539
 * Removal, reordering and changes to existing fields require a major
540
 * version bump.
541
 * sizeof(AVStream) must not be used outside libav*.
542
 */
543
typedef struct AVStream {
544
    int index;    /**< stream index in AVFormatContext */
545
    int id;       /**< format-specific stream ID */
546
    AVCodecContext *codec; /**< codec context */
547
    /**
548
     * Real base framerate of the stream.
549
     * This is the lowest framerate with which all timestamps can be
550
     * represented accurately (it is the least common multiple of all
551
     * framerates in the stream). Note, this value is just a guess!
552
     * For example, if the time base is 1/90000 and all frames have either
553
     * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
554
     */
555
    AVRational r_frame_rate;
556
    void *priv_data;
557

    
558
    /* internal data used in av_find_stream_info() */
559
    int64_t first_dts;
560

    
561
    /**
562
     * encoding: pts generation when outputting stream
563
     */
564
    struct AVFrac pts;
565

    
566
    /**
567
     * This is the fundamental unit of time (in seconds) in terms
568
     * of which frame timestamps are represented. For fixed-fps content,
569
     * time base should be 1/framerate and timestamp increments should be 1.
570
     */
571
    AVRational time_base;
572
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
573
    /* ffmpeg.c private use */
574
    int stream_copy; /**< If set, just copy stream. */
575
    enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
576

    
577
    //FIXME move stuff to a flags field?
578
    /**
579
     * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
580
     * MN: dunno if that is the right place for it
581
     */
582
    float quality;
583

    
584
    /**
585
     * Decoding: pts of the first frame of the stream, in stream time base.
586
     * Only set this if you are absolutely 100% sure that the value you set
587
     * it to really is the pts of the first frame.
588
     * This may be undefined (AV_NOPTS_VALUE).
589
     * @note The ASF header does NOT contain a correct start_time the ASF
590
     * demuxer must NOT set this.
591
     */
592
    int64_t start_time;
593

    
594
    /**
595
     * Decoding: duration of the stream, in stream time base.
596
     * If a source file does not specify a duration, but does specify
597
     * a bitrate, this value will be estimated from bitrate and file size.
598
     */
599
    int64_t duration;
600

    
601
#if FF_API_OLD_METADATA
602
    attribute_deprecated char language[4]; /**< ISO 639-2/B 3-letter language code (empty string if undefined) */
603
#endif
604

    
605
    /* av_read_frame() support */
606
    enum AVStreamParseType need_parsing;
607
    struct AVCodecParserContext *parser;
608

    
609
    int64_t cur_dts;
610
    int last_IP_duration;
611
    int64_t last_IP_pts;
612
    /* av_seek_frame() support */
613
    AVIndexEntry *index_entries; /**< Only used if the format does not
614
                                    support seeking natively. */
615
    int nb_index_entries;
616
    unsigned int index_entries_allocated_size;
617

    
618
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
619

    
620
#if FF_API_LAVF_UNUSED
621
    attribute_deprecated int64_t unused[4+1];
622
#endif
623

    
624
#if FF_API_OLD_METADATA
625
    attribute_deprecated char *filename; /**< source filename of the stream */
626
#endif
627

    
628
    int disposition; /**< AV_DISPOSITION_* bit field */
629

    
630
    AVProbeData probe_data;
631
#define MAX_REORDER_DELAY 16
632
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
633

    
634
    /**
635
     * sample aspect ratio (0 if unknown)
636
     * - encoding: Set by user.
637
     * - decoding: Set by libavformat.
638
     */
639
    AVRational sample_aspect_ratio;
640

    
641
    AVMetadata *metadata;
642

    
643
    /* Intended mostly for av_read_frame() support. Not supposed to be used by */
644
    /* external applications; try to use something else if at all possible.    */
645
    const uint8_t *cur_ptr;
646
    int cur_len;
647
    AVPacket cur_pkt;
648

    
649
    // Timestamp generation support:
650
    /**
651
     * Timestamp corresponding to the last dts sync point.
652
     *
653
     * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
654
     * a DTS is received from the underlying container. Otherwise set to
655
     * AV_NOPTS_VALUE by default.
656
     */
657
    int64_t reference_dts;
658

    
659
    /**
660
     * Number of packets to buffer for codec probing
661
     * NOT PART OF PUBLIC API
662
     */
663
#define MAX_PROBE_PACKETS 2500
664
    int probe_packets;
665

    
666
    /**
667
     * last packet in packet_buffer for this stream when muxing.
668
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
669
     */
670
    struct AVPacketList *last_in_packet_buffer;
671

    
672
    /**
673
     * Average framerate
674
     */
675
    AVRational avg_frame_rate;
676

    
677
    /**
678
     * Number of frames that have been demuxed during av_find_stream_info()
679
     */
680
    int codec_info_nb_frames;
681

    
682
    /**
683
     * Stream informations used internally by av_find_stream_info()
684
     */
685
#define MAX_STD_TIMEBASES (60*12+5)
686
    struct {
687
        int64_t last_dts;
688
        int64_t duration_gcd;
689
        int duration_count;
690
        double duration_error[MAX_STD_TIMEBASES];
691
        int64_t codec_info_duration;
692
    } *info;
693
} AVStream;
694

    
695
#define AV_PROGRAM_RUNNING 1
696

    
697
/**
698
 * New fields can be added to the end with minor version bumps.
699
 * Removal, reordering and changes to existing fields require a major
700
 * version bump.
701
 * sizeof(AVProgram) must not be used outside libav*.
702
 */
703
typedef struct AVProgram {
704
    int            id;
705
#if FF_API_OLD_METADATA
706
    attribute_deprecated char           *provider_name; ///< network name for DVB streams
707
    attribute_deprecated char           *name;          ///< service name for DVB streams
708
#endif
709
    int            flags;
710
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
711
    unsigned int   *stream_index;
712
    unsigned int   nb_stream_indexes;
713
    AVMetadata *metadata;
714
} AVProgram;
715

    
716
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
717
                                         (streams are added dynamically) */
718

    
719
typedef struct AVChapter {
720
    int id;                 ///< unique ID to identify the chapter
721
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
722
    int64_t start, end;     ///< chapter start/end time in time_base units
723
#if FF_API_OLD_METADATA
724
    attribute_deprecated char *title;            ///< chapter title
725
#endif
726
    AVMetadata *metadata;
727
} AVChapter;
728

    
729
#if FF_API_MAX_STREAMS
730
#define MAX_STREAMS 20
731
#endif
732

    
733
/**
734
 * Format I/O context.
735
 * New fields can be added to the end with minor version bumps.
736
 * Removal, reordering and changes to existing fields require a major
737
 * version bump.
738
 * sizeof(AVFormatContext) must not be used outside libav*.
739
 */
740
typedef struct AVFormatContext {
741
    const AVClass *av_class; /**< Set by avformat_alloc_context. */
742
    /* Can only be iformat or oformat, not both at the same time. */
743
    struct AVInputFormat *iformat;
744
    struct AVOutputFormat *oformat;
745
    void *priv_data;
746
    ByteIOContext *pb;
747
    unsigned int nb_streams;
748
#if FF_API_MAX_STREAMS
749
    AVStream *streams[MAX_STREAMS];
750
#else
751
    AVStream **streams;
752
#endif
753
    char filename[1024]; /**< input or output filename */
754
    /* stream info */
755
    int64_t timestamp;
756
#if FF_API_OLD_METADATA
757
    attribute_deprecated char title[512];
758
    attribute_deprecated char author[512];
759
    attribute_deprecated char copyright[512];
760
    attribute_deprecated char comment[512];
761
    attribute_deprecated char album[512];
762
    attribute_deprecated int year;  /**< ID3 year, 0 if none */
763
    attribute_deprecated int track; /**< track number, 0 if none */
764
    attribute_deprecated char genre[32]; /**< ID3 genre */
765
#endif
766

    
767
    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
768
    /* private data for pts handling (do not modify directly). */
769
    /**
770
     * This buffer is only needed when packets were already buffered but
771
     * not decoded, for example to get the codec parameters in MPEG
772
     * streams.
773
     */
774
    struct AVPacketList *packet_buffer;
775

    
776
    /**
777
     * Decoding: position of the first frame of the component, in
778
     * AV_TIME_BASE fractional seconds. NEVER set this value directly:
779
     * It is deduced from the AVStream values.
780
     */
781
    int64_t start_time;
782

    
783
    /**
784
     * Decoding: duration of the stream, in AV_TIME_BASE fractional
785
     * seconds. Only set this value if you know none of the individual stream
786
     * durations and also dont set any of them. This is deduced from the
787
     * AVStream values if not set.
788
     */
789
    int64_t duration;
790

    
791
    /**
792
     * decoding: total file size, 0 if unknown
793
     */
794
    int64_t file_size;
795

    
796
    /**
797
     * Decoding: total stream bitrate in bit/s, 0 if not
798
     * available. Never set it directly if the file_size and the
799
     * duration are known as FFmpeg can compute it automatically.
800
     */
801
    int bit_rate;
802

    
803
    /* av_read_frame() support */
804
    AVStream *cur_st;
805
#if FF_API_LAVF_UNUSED
806
    const uint8_t *cur_ptr_deprecated;
807
    int cur_len_deprecated;
808
    AVPacket cur_pkt_deprecated;
809
#endif
810

    
811
    /* av_seek_frame() support */
812
    int64_t data_offset; /**< offset of the first packet */
813
    int index_built;
814

    
815
    int mux_rate;
816
    unsigned int packet_size;
817
    int preload;
818
    int max_delay;
819

    
820
#define AVFMT_NOOUTPUTLOOP -1
821
#define AVFMT_INFINITEOUTPUTLOOP 0
822
    /**
823
     * number of times to loop output in formats that support it
824
     */
825
    int loop_output;
826

    
827
    int flags;
828
#define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
829
#define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
830
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
831
#define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
832
#define AVFMT_FLAG_NOFILLIN     0x0010 ///< Do not infer any values from other values, just return what is stored in the container
833
#define AVFMT_FLAG_NOPARSE      0x0020 ///< Do not use AVParsers, you also must set AVFMT_FLAG_NOFILLIN as the fillin code works on frames and no parsing -> no frames. Also seeking to frames can not work if parsing to find frame boundaries has been disabled
834
#define AVFMT_FLAG_RTP_HINT     0x0040 ///< Add RTP hinting to the output file
835

    
836
    int loop_input;
837

    
838
    /**
839
     * decoding: size of data to probe; encoding: unused.
840
     */
841
    unsigned int probesize;
842

    
843
    /**
844
     * Maximum time (in AV_TIME_BASE units) during which the input should
845
     * be analyzed in av_find_stream_info().
846
     */
847
    int max_analyze_duration;
848

    
849
    const uint8_t *key;
850
    int keylen;
851

    
852
    unsigned int nb_programs;
853
    AVProgram **programs;
854

    
855
    /**
856
     * Forced video codec_id.
857
     * Demuxing: Set by user.
858
     */
859
    enum CodecID video_codec_id;
860

    
861
    /**
862
     * Forced audio codec_id.
863
     * Demuxing: Set by user.
864
     */
865
    enum CodecID audio_codec_id;
866

    
867
    /**
868
     * Forced subtitle codec_id.
869
     * Demuxing: Set by user.
870
     */
871
    enum CodecID subtitle_codec_id;
872

    
873
    /**
874
     * Maximum amount of memory in bytes to use for the index of each stream.
875
     * If the index exceeds this size, entries will be discarded as
876
     * needed to maintain a smaller size. This can lead to slower or less
877
     * accurate seeking (depends on demuxer).
878
     * Demuxers for which a full in-memory index is mandatory will ignore
879
     * this.
880
     * muxing  : unused
881
     * demuxing: set by user
882
     */
883
    unsigned int max_index_size;
884

    
885
    /**
886
     * Maximum amount of memory in bytes to use for buffering frames
887
     * obtained from realtime capture devices.
888
     */
889
    unsigned int max_picture_buffer;
890

    
891
    unsigned int nb_chapters;
892
    AVChapter **chapters;
893

    
894
    /**
895
     * Flags to enable debugging.
896
     */
897
    int debug;
898
#define FF_FDEBUG_TS        0x0001
899

    
900
    /**
901
     * Raw packets from the demuxer, prior to parsing and decoding.
902
     * This buffer is used for buffering packets until the codec can
903
     * be identified, as parsing cannot be done without knowing the
904
     * codec.
905
     */
906
    struct AVPacketList *raw_packet_buffer;
907
    struct AVPacketList *raw_packet_buffer_end;
908

    
909
    struct AVPacketList *packet_buffer_end;
910

    
911
    AVMetadata *metadata;
912

    
913
    /**
914
     * Remaining size available for raw_packet_buffer, in bytes.
915
     * NOT PART OF PUBLIC API
916
     */
917
#define RAW_PACKET_BUFFER_SIZE 2500000
918
    int raw_packet_buffer_remaining_size;
919

    
920
    /**
921
     * Start time of the stream in real world time, in microseconds
922
     * since the unix epoch (00:00 1st January 1970). That is, pts=0
923
     * in the stream was captured at this real world time.
924
     * - encoding: Set by user.
925
     * - decoding: Unused.
926
     */
927
    int64_t start_time_realtime;
928
} AVFormatContext;
929

    
930
typedef struct AVPacketList {
931
    AVPacket pkt;
932
    struct AVPacketList *next;
933
} AVPacketList;
934

    
935
#if FF_API_FIRST_FORMAT
936
attribute_deprecated extern AVInputFormat *first_iformat;
937
attribute_deprecated extern AVOutputFormat *first_oformat;
938
#endif
939

    
940
/**
941
 * If f is NULL, returns the first registered input format,
942
 * if f is non-NULL, returns the next registered input format after f
943
 * or NULL if f is the last one.
944
 */
945
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
946

    
947
/**
948
 * If f is NULL, returns the first registered output format,
949
 * if f is non-NULL, returns the next registered output format after f
950
 * or NULL if f is the last one.
951
 */
952
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
953

    
954
enum CodecID av_guess_image2_codec(const char *filename);
955

    
956
/* XXX: Use automatic init with either ELF sections or C file parser */
957
/* modules. */
958

    
959
/* utils.c */
960
void av_register_input_format(AVInputFormat *format);
961
void av_register_output_format(AVOutputFormat *format);
962
#if FF_API_GUESS_FORMAT
963
attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
964
                                    const char *filename,
965
                                    const char *mime_type);
966

    
967
/**
968
 * @deprecated Use av_guess_format() instead.
969
 */
970
attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
971
                                                  const char *filename,
972
                                                  const char *mime_type);
973
#endif
974

    
975
/**
976
 * Return the output format in the list of registered output formats
977
 * which best matches the provided parameters, or return NULL if
978
 * there is no match.
979
 *
980
 * @param short_name if non-NULL checks if short_name matches with the
981
 * names of the registered formats
982
 * @param filename if non-NULL checks if filename terminates with the
983
 * extensions of the registered formats
984
 * @param mime_type if non-NULL checks if mime_type matches with the
985
 * MIME type of the registered formats
986
 */
987
AVOutputFormat *av_guess_format(const char *short_name,
988
                                const char *filename,
989
                                const char *mime_type);
990

    
991
/**
992
 * Guess the codec ID based upon muxer and filename.
993
 */
994
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
995
                            const char *filename, const char *mime_type,
996
                            enum AVMediaType type);
997

    
998
/**
999
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
1000
 *
1001
 * @param f The file stream pointer where the dump should be sent to.
1002
 * @param buf buffer
1003
 * @param size buffer size
1004
 *
1005
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
1006
 */
1007
void av_hex_dump(FILE *f, uint8_t *buf, int size);
1008

    
1009
/**
1010
 * Send a nice hexadecimal dump of a buffer to the log.
1011
 *
1012
 * @param avcl A pointer to an arbitrary struct of which the first field is a
1013
 * pointer to an AVClass struct.
1014
 * @param level The importance level of the message, lower values signifying
1015
 * higher importance.
1016
 * @param buf buffer
1017
 * @param size buffer size
1018
 *
1019
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
1020
 */
1021
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
1022

    
1023
/**
1024
 * Send a nice dump of a packet to the specified file stream.
1025
 *
1026
 * @param f The file stream pointer where the dump should be sent to.
1027
 * @param pkt packet to dump
1028
 * @param dump_payload True if the payload must be displayed, too.
1029
 */
1030
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
1031

    
1032
/**
1033
 * Send a nice dump of a packet to the log.
1034
 *
1035
 * @param avcl A pointer to an arbitrary struct of which the first field is a
1036
 * pointer to an AVClass struct.
1037
 * @param level The importance level of the message, lower values signifying
1038
 * higher importance.
1039
 * @param pkt packet to dump
1040
 * @param dump_payload True if the payload must be displayed, too.
1041
 */
1042
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
1043

    
1044
/**
1045
 * Initialize libavformat and register all the muxers, demuxers and
1046
 * protocols. If you do not call this function, then you can select
1047
 * exactly which formats you want to support.
1048
 *
1049
 * @see av_register_input_format()
1050
 * @see av_register_output_format()
1051
 * @see av_register_protocol()
1052
 */
1053
void av_register_all(void);
1054

    
1055
/**
1056
 * Get the CodecID for the given codec tag tag.
1057
 * If no codec id is found returns CODEC_ID_NONE.
1058
 *
1059
 * @param tags list of supported codec_id-codec_tag pairs, as stored
1060
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1061
 */
1062
enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1063

    
1064
/**
1065
 * Get the codec tag for the given codec id id.
1066
 * If no codec tag is found returns 0.
1067
 *
1068
 * @param tags list of supported codec_id-codec_tag pairs, as stored
1069
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1070
 */
1071
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1072

    
1073
/* media file input */
1074

    
1075
/**
1076
 * Find AVInputFormat based on the short name of the input format.
1077
 */
1078
AVInputFormat *av_find_input_format(const char *short_name);
1079

    
1080
/**
1081
 * Guess the file format.
1082
 *
1083
 * @param is_opened Whether the file is already opened; determines whether
1084
 *                  demuxers with or without AVFMT_NOFILE are probed.
1085
 */
1086
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1087

    
1088
/**
1089
 * Guess the file format.
1090
 *
1091
 * @param is_opened Whether the file is already opened; determines whether
1092
 *                  demuxers with or without AVFMT_NOFILE are probed.
1093
 * @param score_max A probe score larger that this is required to accept a
1094
 *                  detection, the variable is set to the actual detection
1095
 *                  score afterwards.
1096
 *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1097
 *                  to retry with a larger probe buffer.
1098
 */
1099
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1100

    
1101
/**
1102
 * Allocate all the structures needed to read an input stream.
1103
 *        This does not open the needed codecs for decoding the stream[s].
1104
 */
1105
int av_open_input_stream(AVFormatContext **ic_ptr,
1106
                         ByteIOContext *pb, const char *filename,
1107
                         AVInputFormat *fmt, AVFormatParameters *ap);
1108

    
1109
/**
1110
 * Open a media file as input. The codecs are not opened. Only the file
1111
 * header (if present) is read.
1112
 *
1113
 * @param ic_ptr The opened media file handle is put here.
1114
 * @param filename filename to open
1115
 * @param fmt If non-NULL, force the file format to use.
1116
 * @param buf_size optional buffer size (zero if default is OK)
1117
 * @param ap Additional parameters needed when opening the file
1118
 *           (NULL if default).
1119
 * @return 0 if OK, AVERROR_xxx otherwise
1120
 */
1121
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1122
                       AVInputFormat *fmt,
1123
                       int buf_size,
1124
                       AVFormatParameters *ap);
1125

    
1126
#if FF_API_ALLOC_FORMAT_CONTEXT
1127
/**
1128
 * @deprecated Use avformat_alloc_context() instead.
1129
 */
1130
attribute_deprecated AVFormatContext *av_alloc_format_context(void);
1131
#endif
1132

    
1133
/**
1134
 * Allocate an AVFormatContext.
1135
 * Can be freed with av_free() but do not forget to free everything you
1136
 * explicitly allocated as well!
1137
 */
1138
AVFormatContext *avformat_alloc_context(void);
1139

    
1140
/**
1141
 * Read packets of a media file to get stream information. This
1142
 * is useful for file formats with no headers such as MPEG. This
1143
 * function also computes the real framerate in case of MPEG-2 repeat
1144
 * frame mode.
1145
 * The logical file position is not changed by this function;
1146
 * examined packets may be buffered for later processing.
1147
 *
1148
 * @param ic media file handle
1149
 * @return >=0 if OK, AVERROR_xxx on error
1150
 * @todo Let the user decide somehow what information is needed so that
1151
 *       we do not waste time getting stuff the user does not need.
1152
 */
1153
int av_find_stream_info(AVFormatContext *ic);
1154

    
1155
/**
1156
 * Find the "best" stream in the file.
1157
 * The best stream is determined according to various heuristics as the most
1158
 * likely to be what the user expects.
1159
 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1160
 * default decoder for the stream's codec; streams for which no decoder can
1161
 * be found are ignored.
1162
 *
1163
 * @param ic                media file handle
1164
 * @param type              stream type: video, audio, subtitles, etc.
1165
 * @param wanted_stream_nb  user-requested stream number,
1166
 *                          or -1 for automatic selection
1167
 * @param related_stream    try to find a stream related (eg. in the same
1168
 *                          program) to this one, or -1 if none
1169
 * @param decoder_ret       if non-NULL, returns the decoder for the
1170
 *                          selected stream
1171
 * @param flags             flags; none are currently defined
1172
 * @return  the non-negative stream number in case of success,
1173
 *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1174
 *          could be found,
1175
 *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1176
 * @note  If av_find_best_stream returns successfully and decoder_ret is not
1177
 *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1178
 */
1179
int av_find_best_stream(AVFormatContext *ic,
1180
                        enum AVMediaType type,
1181
                        int wanted_stream_nb,
1182
                        int related_stream,
1183
                        AVCodec **decoder_ret,
1184
                        int flags);
1185

    
1186
/**
1187
 * Read a transport packet from a media file.
1188
 *
1189
 * This function is obsolete and should never be used.
1190
 * Use av_read_frame() instead.
1191
 *
1192
 * @param s media file handle
1193
 * @param pkt is filled
1194
 * @return 0 if OK, AVERROR_xxx on error
1195
 */
1196
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1197

    
1198
/**
1199
 * Return the next frame of a stream.
1200
 * This function returns what is stored in the file, and does not validate
1201
 * that what is there are valid frames for the decoder. It will split what is
1202
 * stored in the file into frames and return one for each call. It will not
1203
 * omit invalid data between valid frames so as to give the decoder the maximum
1204
 * information possible for decoding.
1205
 *
1206
 * The returned packet is valid
1207
 * until the next av_read_frame() or until av_close_input_file() and
1208
 * must be freed with av_free_packet. For video, the packet contains
1209
 * exactly one frame. For audio, it contains an integer number of
1210
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1211
 * data). If the audio frames have a variable size (e.g. MPEG audio),
1212
 * then it contains one frame.
1213
 *
1214
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1215
 * values in AVStream.time_base units (and guessed if the format cannot
1216
 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1217
 * has B-frames, so it is better to rely on pkt->dts if you do not
1218
 * decompress the payload.
1219
 *
1220
 * @return 0 if OK, < 0 on error or end of file
1221
 */
1222
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1223

    
1224
/**
1225
 * Seek to the keyframe at timestamp.
1226
 * 'timestamp' in 'stream_index'.
1227
 * @param stream_index If stream_index is (-1), a default
1228
 * stream is selected, and timestamp is automatically converted
1229
 * from AV_TIME_BASE units to the stream specific time_base.
1230
 * @param timestamp Timestamp in AVStream.time_base units
1231
 *        or, if no stream is specified, in AV_TIME_BASE units.
1232
 * @param flags flags which select direction and seeking mode
1233
 * @return >= 0 on success
1234
 */
1235
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1236
                  int flags);
1237

    
1238
/**
1239
 * Seek to timestamp ts.
1240
 * Seeking will be done so that the point from which all active streams
1241
 * can be presented successfully will be closest to ts and within min/max_ts.
1242
 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1243
 *
1244
 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1245
 * are the file position (this may not be supported by all demuxers).
1246
 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1247
 * in the stream with stream_index (this may not be supported by all demuxers).
1248
 * Otherwise all timestamps are in units of the stream selected by stream_index
1249
 * or if stream_index is -1, in AV_TIME_BASE units.
1250
 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1251
 * keyframes (this may not be supported by all demuxers).
1252
 *
1253
 * @param stream_index index of the stream which is used as time base reference
1254
 * @param min_ts smallest acceptable timestamp
1255
 * @param ts target timestamp
1256
 * @param max_ts largest acceptable timestamp
1257
 * @param flags flags
1258
 * @return >=0 on success, error code otherwise
1259
 *
1260
 * @note This is part of the new seek API which is still under construction.
1261
 *       Thus do not use this yet. It may change at any time, do not expect
1262
 *       ABI compatibility yet!
1263
 */
1264
int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1265

    
1266
/**
1267
 * Start playing a network-based stream (e.g. RTSP stream) at the
1268
 * current position.
1269
 */
1270
int av_read_play(AVFormatContext *s);
1271

    
1272
/**
1273
 * Pause a network-based stream (e.g. RTSP stream).
1274
 *
1275
 * Use av_read_play() to resume it.
1276
 */
1277
int av_read_pause(AVFormatContext *s);
1278

    
1279
/**
1280
 * Free a AVFormatContext allocated by av_open_input_stream.
1281
 * @param s context to free
1282
 */
1283
void av_close_input_stream(AVFormatContext *s);
1284

    
1285
/**
1286
 * Close a media file (but not its codecs).
1287
 *
1288
 * @param s media file handle
1289
 */
1290
void av_close_input_file(AVFormatContext *s);
1291

    
1292
/**
1293
 * Add a new stream to a media file.
1294
 *
1295
 * Can only be called in the read_header() function. If the flag
1296
 * AVFMTCTX_NOHEADER is in the format context, then new streams
1297
 * can be added in read_packet too.
1298
 *
1299
 * @param s media file handle
1300
 * @param id file-format-dependent stream ID
1301
 */
1302
AVStream *av_new_stream(AVFormatContext *s, int id);
1303
AVProgram *av_new_program(AVFormatContext *s, int id);
1304

    
1305
/**
1306
 * Add a new chapter.
1307
 * This function is NOT part of the public API
1308
 * and should ONLY be used by demuxers.
1309
 *
1310
 * @param s media file handle
1311
 * @param id unique ID for this chapter
1312
 * @param start chapter start time in time_base units
1313
 * @param end chapter end time in time_base units
1314
 * @param title chapter title
1315
 *
1316
 * @return AVChapter or NULL on error
1317
 */
1318
AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1319
                          int64_t start, int64_t end, const char *title);
1320

    
1321
/**
1322
 * Set the pts for a given stream.
1323
 *
1324
 * @param s stream
1325
 * @param pts_wrap_bits number of bits effectively used by the pts
1326
 *        (used for wrap control, 33 is the value for MPEG)
1327
 * @param pts_num numerator to convert to seconds (MPEG: 1)
1328
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1329
 */
1330
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1331
                     unsigned int pts_num, unsigned int pts_den);
1332

    
1333
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1334
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1335
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1336
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1337

    
1338
int av_find_default_stream_index(AVFormatContext *s);
1339

    
1340
/**
1341
 * Get the index for a specific timestamp.
1342
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1343
 *                 to the timestamp which is <= the requested one, if backward
1344
 *                 is 0, then it will be >=
1345
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1346
 * @return < 0 if no such timestamp could be found
1347
 */
1348
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1349

    
1350
/**
1351
 * Ensure the index uses less memory than the maximum specified in
1352
 * AVFormatContext.max_index_size by discarding entries if it grows
1353
 * too large.
1354
 * This function is not part of the public API and should only be called
1355
 * by demuxers.
1356
 */
1357
void ff_reduce_index(AVFormatContext *s, int stream_index);
1358

    
1359
/**
1360
 * Add an index entry into a sorted list. Update the entry if the list
1361
 * already contains it.
1362
 *
1363
 * @param timestamp timestamp in the time base of the given stream
1364
 */
1365
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1366
                       int size, int distance, int flags);
1367

    
1368
/**
1369
 * Perform a binary search using av_index_search_timestamp() and
1370
 * AVInputFormat.read_timestamp().
1371
 * This is not supposed to be called directly by a user application,
1372
 * but by demuxers.
1373
 * @param target_ts target timestamp in the time base of the given stream
1374
 * @param stream_index stream number
1375
 */
1376
int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1377
                         int64_t target_ts, int flags);
1378

    
1379
/**
1380
 * Update cur_dts of all streams based on the given timestamp and AVStream.
1381
 *
1382
 * Stream ref_st unchanged, others set cur_dts in their native time base.
1383
 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1384
 * @param timestamp new dts expressed in time_base of param ref_st
1385
 * @param ref_st reference stream giving time_base of param timestamp
1386
 */
1387
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1388

    
1389
/**
1390
 * Perform a binary search using read_timestamp().
1391
 * This is not supposed to be called directly by a user application,
1392
 * but by demuxers.
1393
 * @param target_ts target timestamp in the time base of the given stream
1394
 * @param stream_index stream number
1395
 */
1396
int64_t av_gen_search(AVFormatContext *s, int stream_index,
1397
                      int64_t target_ts, int64_t pos_min,
1398
                      int64_t pos_max, int64_t pos_limit,
1399
                      int64_t ts_min, int64_t ts_max,
1400
                      int flags, int64_t *ts_ret,
1401
                      int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1402

    
1403
/**
1404
 * media file output
1405
 */
1406
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1407

    
1408
/**
1409
 * Split a URL string into components.
1410
 *
1411
 * The pointers to buffers for storing individual components may be null,
1412
 * in order to ignore that component. Buffers for components not found are
1413
 * set to empty strings. If the port is not found, it is set to a negative
1414
 * value.
1415
 *
1416
 * @param proto the buffer for the protocol
1417
 * @param proto_size the size of the proto buffer
1418
 * @param authorization the buffer for the authorization
1419
 * @param authorization_size the size of the authorization buffer
1420
 * @param hostname the buffer for the host name
1421
 * @param hostname_size the size of the hostname buffer
1422
 * @param port_ptr a pointer to store the port number in
1423
 * @param path the buffer for the path
1424
 * @param path_size the size of the path buffer
1425
 * @param url the URL to split
1426
 */
1427
void av_url_split(char *proto,         int proto_size,
1428
                  char *authorization, int authorization_size,
1429
                  char *hostname,      int hostname_size,
1430
                  int *port_ptr,
1431
                  char *path,          int path_size,
1432
                  const char *url);
1433

    
1434
/**
1435
 * Allocate the stream private data and write the stream header to an
1436
 * output media file.
1437
 *
1438
 * @param s media file handle
1439
 * @return 0 if OK, AVERROR_xxx on error
1440
 */
1441
int av_write_header(AVFormatContext *s);
1442

    
1443
/**
1444
 * Write a packet to an output media file.
1445
 *
1446
 * The packet shall contain one audio or video frame.
1447
 * The packet must be correctly interleaved according to the container
1448
 * specification, if not then av_interleaved_write_frame must be used.
1449
 *
1450
 * @param s media file handle
1451
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1452
              dts/pts, ...
1453
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1454
 */
1455
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1456

    
1457
/**
1458
 * Write a packet to an output media file ensuring correct interleaving.
1459
 *
1460
 * The packet must contain one audio or video frame.
1461
 * If the packets are already correctly interleaved, the application should
1462
 * call av_write_frame() instead as it is slightly faster. It is also important
1463
 * to keep in mind that completely non-interleaved input will need huge amounts
1464
 * of memory to interleave with this, so it is preferable to interleave at the
1465
 * demuxer level.
1466
 *
1467
 * @param s media file handle
1468
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1469
              dts/pts, ...
1470
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1471
 */
1472
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1473

    
1474
/**
1475
 * Interleave a packet per dts in an output media file.
1476
 *
1477
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1478
 * function, so they cannot be used after it. Note that calling av_free_packet()
1479
 * on them is still safe.
1480
 *
1481
 * @param s media file handle
1482
 * @param out the interleaved packet will be output here
1483
 * @param pkt the input packet
1484
 * @param flush 1 if no further packets are available as input and all
1485
 *              remaining packets should be output
1486
 * @return 1 if a packet was output, 0 if no packet could be output,
1487
 *         < 0 if an error occurred
1488
 */
1489
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1490
                                 AVPacket *pkt, int flush);
1491

    
1492
/**
1493
 * Write the stream trailer to an output media file and free the
1494
 * file private data.
1495
 *
1496
 * May only be called after a successful call to av_write_header.
1497
 *
1498
 * @param s media file handle
1499
 * @return 0 if OK, AVERROR_xxx on error
1500
 */
1501
int av_write_trailer(AVFormatContext *s);
1502

    
1503
void dump_format(AVFormatContext *ic,
1504
                 int index,
1505
                 const char *url,
1506
                 int is_output);
1507

    
1508
#if FF_API_PARSE_FRAME_PARAM
1509
/**
1510
 * Parse width and height out of string str.
1511
 * @deprecated Use av_parse_video_frame_size instead.
1512
 */
1513
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1514
                                          const char *str);
1515

    
1516
/**
1517
 * Convert framerate from a string to a fraction.
1518
 * @deprecated Use av_parse_video_frame_rate instead.
1519
 */
1520
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1521
                                          const char *arg);
1522
#endif
1523

    
1524
/**
1525
 * Parse datestr and return a corresponding number of microseconds.
1526
 * @param datestr String representing a date or a duration.
1527
 * - If a date the syntax is:
1528
 * @code
1529
 *  now|{[{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH[:MM[:SS[.m...]]]}|{HH[MM[SS[.m...]]]}}[Z|z]}
1530
 * @endcode
1531
 * If the value is "now" it takes the current time.
1532
 * Time is local time unless Z is appended, in which case it is
1533
 * interpreted as UTC.
1534
 * If the year-month-day part is not specified it takes the current
1535
 * year-month-day.
1536
 * @return the number of microseconds since 1st of January, 1970 up to
1537
 * the time of the parsed date or INT64_MIN if datestr cannot be
1538
 * successfully parsed.
1539
 * - If a duration the syntax is:
1540
 * @code
1541
 *  [-]HH[:MM[:SS[.m...]]]
1542
 *  [-]S+[.m...]
1543
 * @endcode
1544
 * @return the number of microseconds contained in a time interval
1545
 * with the specified duration or INT64_MIN if datestr cannot be
1546
 * successfully parsed.
1547
 * @param duration Flag which tells how to interpret datestr, if
1548
 * not zero datestr is interpreted as a duration, otherwise as a
1549
 * date.
1550
 */
1551
int64_t parse_date(const char *datestr, int duration);
1552

    
1553
/**
1554
 * Get the current time in microseconds.
1555
 */
1556
int64_t av_gettime(void);
1557

    
1558
/* ffm-specific for ffserver */
1559
#define FFM_PACKET_SIZE 4096
1560
int64_t ffm_read_write_index(int fd);
1561
int ffm_write_write_index(int fd, int64_t pos);
1562
void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1563

    
1564
/**
1565
 * Attempt to find a specific tag in a URL.
1566
 *
1567
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1568
 * Return 1 if found.
1569
 */
1570
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1571

    
1572
/**
1573
 * Return in 'buf' the path with '%d' replaced by a number.
1574
 *
1575
 * Also handles the '%0nd' format where 'n' is the total number
1576
 * of digits and '%%'.
1577
 *
1578
 * @param buf destination buffer
1579
 * @param buf_size destination buffer size
1580
 * @param path numbered sequence string
1581
 * @param number frame number
1582
 * @return 0 if OK, -1 on format error
1583
 */
1584
int av_get_frame_filename(char *buf, int buf_size,
1585
                          const char *path, int number);
1586

    
1587
/**
1588
 * Check whether filename actually is a numbered sequence generator.
1589
 *
1590
 * @param filename possible numbered sequence string
1591
 * @return 1 if a valid numbered sequence string, 0 otherwise
1592
 */
1593
int av_filename_number_test(const char *filename);
1594

    
1595
/**
1596
 * Generate an SDP for an RTP session.
1597
 *
1598
 * @param ac array of AVFormatContexts describing the RTP streams. If the
1599
 *           array is composed by only one context, such context can contain
1600
 *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1601
 *           all the contexts in the array (an AVCodecContext per RTP stream)
1602
 *           must contain only one AVStream.
1603
 * @param n_files number of AVCodecContexts contained in ac
1604
 * @param buff buffer where the SDP will be stored (must be allocated by
1605
 *             the caller)
1606
 * @param size the size of the buffer
1607
 * @return 0 if OK, AVERROR_xxx on error
1608
 */
1609
int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1610

    
1611
/**
1612
 * Return a positive value if the given filename has one of the given
1613
 * extensions, 0 otherwise.
1614
 *
1615
 * @param extensions a comma-separated list of filename extensions
1616
 */
1617
int av_match_ext(const char *filename, const char *extensions);
1618

    
1619
#endif /* AVFORMAT_AVFORMAT_H */