avformat.h 53.3 KB
Newer Older
1 2 3
/*
 * copyright (c) 2001 Fabrice Bellard
 *
4
 * This file is part of Libav.
5
 *
6
 * Libav is free software; you can redistribute it and/or
7 8
 * modify it under the terms of the GNU Lesser General Public
 * 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
 * Libav is distributed in the hope that it will be useful,
12 13 14 15 16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with Libav; if not, write to the Free Software
18 19 20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

21 22
#ifndef AVFORMAT_AVFORMAT_H
#define AVFORMAT_AVFORMAT_H
F
Fabrice Bellard 已提交
23

24

S
Stefano Sabatini 已提交
25
/**
26
 * Return the LIBAVFORMAT_VERSION_INT constant.
S
Stefano Sabatini 已提交
27 28 29
 */
unsigned avformat_version(void);

30
/**
31
 * Return the libavformat build-time configuration.
32
 */
33
const char *avformat_configuration(void);
34 35

/**
36
 * Return the libavformat license.
37
 */
38
const char *avformat_license(void);
39

40
#include <time.h>
Z
Zdenek Kabelac 已提交
41
#include <stdio.h>  /* FILE */
42
#include "libavcodec/avcodec.h"
43
#include "libavutil/dict.h"
F
Fabrice Bellard 已提交
44 45

#include "avio.h"
46
#include "libavformat/version.h"
F
Fabrice Bellard 已提交
47

A
Aurelien Jacobs 已提交
48 49
struct AVFormatContext;

50 51

/*
52 53
 * Public Metadata API.
 * The metadata API allows libavformat to export metadata tags to a client
54
 * application using a sequence of key/value pairs. Like all strings in Libav,
55 56
 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
57 58 59 60 61 62 63 64 65
 * Important concepts to keep in mind:
 * 1. Keys are unique; there can never be 2 tags with the same key. This is
 *    also meant semantically, i.e., a demuxer should not knowingly produce
 *    several keys that are literally different but semantically identical.
 *    E.g., key=Author5, key=Author6. In this example, all authors must be
 *    placed in the same tag.
 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
 *    want to store, e.g., the email address of the child of producer Alice
 *    and actor Bob, that could have key=alice_and_bobs_childs_email_address.
66 67 68 69 70 71 72 73 74 75 76 77
 * 3. Several modifiers can be applied to the tag name. This is done by
 *    appending a dash character ('-') and the modifier name in the order
 *    they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
 *    a) language -- a tag whose value is localized for a particular language
 *       is appended with the ISO 639-2/B 3-letter language code.
 *       For example: Author-ger=Michael, Author-eng=Mike
 *       The original/default language is in the unqualified "Author" tag.
 *       A demuxer should set a default if it sets any translated tag.
 *    b) sorting  -- a modified version of a tag that should be used for
 *       sorting will have '-sort' appended. E.g. artist="The Beatles",
 *       artist-sort="Beatles, The".
 *
78 79 80
 * 4. Demuxers attempt to export metadata in a generic format, however tags
 *    with no generic equivalents are left as they are stored in the container.
 *    Follows a list of generic tag names:
81 82 83 84 85 86 87 88
 *
 * album        -- name of the set this work belongs to
 * album_artist -- main creator of the set/album, if different from artist.
 *                 e.g. "Various Artists" for compilation albums.
 * artist       -- main creator of the work
 * comment      -- any additional description of the file.
 * composer     -- who composed the work, if different from artist.
 * copyright    -- name of copyright holder.
89
 * creation_time-- date when the file was created, preferably in ISO 8601.
90 91 92 93 94 95 96
 * date         -- date when the work was created, preferably in ISO 8601.
 * disc         -- number of a subset, e.g. disc in a multi-disc collection.
 * encoder      -- name/settings of the software/hardware that produced the file.
 * encoded_by   -- person/group who created the file.
 * filename     -- original name of the file.
 * genre        -- <self-evident>.
 * language     -- main language in which the work is performed, preferably
97 98
 *                 in ISO 639-2 format. Multiple languages can be specified by
 *                 separating them with commas.
99 100 101 102
 * performer    -- artist who performed the work, if different from artist.
 *                 E.g for "Also sprach Zarathustra", artist would be "Richard
 *                 Strauss" and performer "London Philharmonic Orchestra".
 * publisher    -- name of the label/publisher.
103 104
 * service_name     -- name of the service in broadcasting (channel name).
 * service_provider -- name of the service provider in broadcasting.
105 106
 * title        -- name of the work.
 * track        -- number of this work in the set, can be in form current/total.
107
 * variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
108 109
 */

110 111 112 113 114 115 116
#if FF_API_OLD_METADATA2
/**
 * @defgroup old_metadata Old metadata API
 * The following functions are deprecated, use
 * their equivalents from libavutil/dict.h instead.
 * @{
 */
117

118 119 120 121 122 123 124 125
#define AV_METADATA_MATCH_CASE      AV_DICT_MATCH_CASE
#define AV_METADATA_IGNORE_SUFFIX   AV_DICT_IGNORE_SUFFIX
#define AV_METADATA_DONT_STRDUP_KEY AV_DICT_DONT_STRDUP_KEY
#define AV_METADATA_DONT_STRDUP_VAL AV_DICT_DONT_STRDUP_VAL
#define AV_METADATA_DONT_OVERWRITE  AV_DICT_DONT_OVERWRITE

typedef attribute_deprecated AVDictionary AVMetadata;
typedef attribute_deprecated AVDictionaryEntry  AVMetadataTag;
126

A
Aurelien Jacobs 已提交
127
typedef struct AVMetadataConv AVMetadataConv;
128 129

/**
130
 * Get a metadata element with matching key.
131
 *
132
 * @param prev Set to the previous matching element to find the next.
133
 *             If set to NULL the first matching element is returned.
134 135
 * @param flags Allows case as well as suffix-insensitive comparisons.
 * @return Found tag or NULL, changing key or value leads to undefined behavior.
136
 */
137 138
attribute_deprecated AVDictionaryEntry *
av_metadata_get(AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags);
139

140
/**
141
 * Set the given tag in *pm, overwriting an existing tag.
142
 *
143 144
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
 * a metadata struct is allocated and put in *pm.
145 146
 * @param key tag key to add to *pm (will be av_strduped depending on flags)
 * @param value tag value to add to *pm (will be av_strduped depending on flags).
147
 *        Passing a NULL value will cause an existing tag to be deleted.
148 149
 * @return >= 0 on success otherwise an error code <0
 */
150
attribute_deprecated int av_metadata_set2(AVDictionary **pm, const char *key, const char *value, int flags);
151

A
Aurelien Jacobs 已提交
152
/**
153
 * This function is provided for compatibility reason and currently does nothing.
A
Aurelien Jacobs 已提交
154
 */
155 156
attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
                                                                        const AVMetadataConv *s_conv);
A
Aurelien Jacobs 已提交
157

158
/**
159 160
 * Copy metadata from one AVDictionary struct into another.
 * @param dst pointer to a pointer to a AVDictionary struct. If *dst is NULL,
161
 *            this function will allocate a struct for you and put it in *dst
162
 * @param src pointer to source AVDictionary struct
163
 * @param flags flags to use when setting metadata in *dst
164
 * @note metadata is read using the AV_DICT_IGNORE_SUFFIX flag
165
 */
166
attribute_deprecated void av_metadata_copy(AVDictionary **dst, AVDictionary *src, int flags);
167

168
/**
169
 * Free all the memory allocated for an AVDictionary struct.
170
 */
171 172 173 174 175
attribute_deprecated void av_metadata_free(AVDictionary **m);
/**
 * @}
 */
#endif
176

177

F
Fabrice Bellard 已提交
178 179
/* packet functions */

180 181

/**
182
 * Allocate and read the payload of a packet and initialize its
183
 * fields with default values.
184 185
 *
 * @param pkt packet
D
Diego Biurrun 已提交
186 187
 * @param size desired payload size
 * @return >0 (read size) if OK, AVERROR_xxx otherwise
188
 */
189
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
190

F
Fabrice Bellard 已提交
191

192
/**
R
Reimar Döffinger 已提交
193 194
 * Read data and append it to the current content of the AVPacket.
 * If pkt->size is 0 this is identical to av_get_packet.
195 196 197 198 199 200 201 202 203 204
 * Note that this uses av_grow_packet and thus involves a realloc
 * which is inefficient. Thus this function should only be used
 * when there is no reasonable way to know (an upper bound of)
 * the final size.
 *
 * @param pkt packet
 * @param size amount of data to read
 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
 *         will not be lost even if an error occurs.
 */
205
int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
206

F
Fabrice Bellard 已提交
207 208 209
/*************************************************/
/* fractional numbers for exact pts handling */

210
/**
D
Diego Biurrun 已提交
211 212
 * The exact value of the fractional number is: 'val + num / den'.
 * num is assumed to be 0 <= num < den.
213
 */
F
Fabrice Bellard 已提交
214
typedef struct AVFrac {
215
    int64_t val, num, den;
216
} AVFrac;
F
Fabrice Bellard 已提交
217

F
Fabrice Bellard 已提交
218
/*************************************************/
219
/* input/output formats */
F
Fabrice Bellard 已提交
220

221 222
struct AVCodecTag;

223 224 225
/**
 * This structure contains the data a format has to probe a file.
 */
226
typedef struct AVProbeData {
227
    const char *filename;
228 229
    unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
    int buf_size;       /**< Size of buf except extra allocated bytes */
230 231
} AVProbeData;

232
#define AVPROBE_SCORE_MAX 100               ///< maximum score, half of that is used for file-extension-based detection
233
#define AVPROBE_PADDING_SIZE 32             ///< extra allocated bytes at the end of the probe buffer
F
Fabrice Bellard 已提交
234 235

typedef struct AVFormatParameters {
236
#if FF_API_FORMAT_PARAMETERS
237
    attribute_deprecated AVRational time_base;
238 239
    attribute_deprecated int sample_rate;
    attribute_deprecated int channels;
240 241
    attribute_deprecated int width;
    attribute_deprecated int height;
242
    attribute_deprecated enum PixelFormat pix_fmt;
243
    attribute_deprecated int channel; /**< Used to select DV channel. */
244
    attribute_deprecated const char *standard; /**< deprecated, use demuxer-specific options instead. */
245
    attribute_deprecated unsigned int mpeg2ts_raw:1;  /**< deprecated, use mpegtsraw demuxer */
A
Anton Khirnov 已提交
246 247
    /**< deprecated, use mpegtsraw demuxer-specific options instead */
    attribute_deprecated unsigned int mpeg2ts_compute_pcr:1;
248 249
    attribute_deprecated unsigned int initial_pause:1;       /**< Do not begin to play the stream
                                                                  immediately (RTSP only). */
A
Anton Khirnov 已提交
250
#endif
251
    unsigned int prealloced_context:1;
F
Fabrice Bellard 已提交
252 253
} AVFormatParameters;

254
//! Demuxer will use avio_open, no opened file should be provided by the caller.
255
#define AVFMT_NOFILE        0x0001
D
Diego Biurrun 已提交
256 257 258 259 260 261 262
#define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
#define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
#define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
                                      raw picture data. */
#define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
#define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
263
#define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
264
#define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
265
#define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
266
#define AVFMT_NOSTREAMS     0x1000 /**< Format does not require any streams */
267 268
#define AVFMT_NOBINSEARCH   0x2000 /**< Format does not allow to fallback to binary search via read_timestamp */
#define AVFMT_NOGENSEARCH   0x4000 /**< Format does not allow to fallback to generic search */
269 270

typedef struct AVOutputFormat {
F
Fabrice Bellard 已提交
271
    const char *name;
272 273
    /**
     * Descriptive name for the format, meant to be more human-readable
274
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
275 276
     * to define it.
     */
F
Fabrice Bellard 已提交
277 278
    const char *long_name;
    const char *mime_type;
D
Diego Biurrun 已提交
279
    const char *extensions; /**< comma-separated filename extensions */
280 281 282
    /**
     * size of private data so that it can be allocated in the wrapper
     */
283
    int priv_data_size;
F
Fabrice Bellard 已提交
284
    /* output support */
285 286
    enum CodecID audio_codec; /**< default audio codec */
    enum CodecID video_codec; /**< default video codec */
F
Fabrice Bellard 已提交
287
    int (*write_header)(struct AVFormatContext *);
288
    int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
F
Fabrice Bellard 已提交
289
    int (*write_trailer)(struct AVFormatContext *);
290
    /**
291 292 293
     * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
     * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
     * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS
294
     */
295
    int flags;
296 297 298
    /**
     * Currently only used to set pixel format if not YUV420P.
     */
299
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
300 301
    int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
                             AVPacket *in, int flush);
302 303

    /**
304
     * List of supported codec_id-codec_tag pairs, ordered by "better
305
     * choice first". The arrays are all terminated by CODEC_ID_NONE.
306
     */
307
    const struct AVCodecTag * const *codec_tag;
308

309 310
    enum CodecID subtitle_codec; /**< default subtitle codec */

311
#if FF_API_OLD_METADATA2
312
    const AVMetadataConv *metadata_conv;
313
#endif
A
Aurelien Jacobs 已提交
314

A
Anssi Hannula 已提交
315 316
    const AVClass *priv_class; ///< AVClass for the private context

317 318 319
    /* private fields */
    struct AVOutputFormat *next;
} AVOutputFormat;
F
Fabrice Bellard 已提交
320

321
typedef struct AVInputFormat {
322 323
    /**
     * A comma separated list of short names for the format. New names
324 325
     * may be appended with a minor bump.
     */
326
    const char *name;
327

328 329
    /**
     * Descriptive name for the format, meant to be more human-readable
330
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
331 332
     * to define it.
     */
333
    const char *long_name;
334 335 336 337

    /**
     * Size of private data so that it can be allocated in the wrapper.
     */
338
    int priv_data_size;
339

340
    /**
341
     * Tell if a given file has a chance of being parsed as this format.
D
Diego Biurrun 已提交
342 343
     * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
     * big so you do not have to check for that unless you need more.
344
     */
345
    int (*read_probe)(AVProbeData *);
346 347 348 349 350 351 352

    /**
     * Read the format header and initialize the AVFormatContext
     * structure. Return 0 if OK. 'ap' if non-NULL contains
     * additional parameters. Only used in raw format right
     * now. 'av_new_stream' should be called to create new streams.
     */
F
Fabrice Bellard 已提交
353 354
    int (*read_header)(struct AVFormatContext *,
                       AVFormatParameters *ap);
355 356 357 358

    /**
     * Read one packet and put it in 'pkt'. pts and flags are also
     * set. 'av_new_stream' can be called only if the flag
359 360
     * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
     * background thread).
361 362 363 364
     * @return 0 on success, < 0 on error.
     *         When returning an error, pkt must not have been allocated
     *         or must be freed before returning
     */
F
Fabrice Bellard 已提交
365
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
366 367 368 369 370

    /**
     * Close the stream. The AVFormatContext and AVStreams are not
     * freed by this function
     */
F
Fabrice Bellard 已提交
371
    int (*read_close)(struct AVFormatContext *);
M
Michael Niedermayer 已提交
372

373
#if FF_API_READ_SEEK
374
    /**
D
Diego Biurrun 已提交
375 376
     * Seek to a given timestamp relative to the frames in
     * stream component stream_index.
377 378 379
     * @param stream_index Must not be -1.
     * @param flags Selects which direction should be preferred if no exact
     *              match is available.
380
     * @return >= 0 on success (but not necessarily the new offset)
381
     */
A
Anton Khirnov 已提交
382 383
    attribute_deprecated int (*read_seek)(struct AVFormatContext *,
                                          int stream_index, int64_t timestamp, int flags);
M
Michael Niedermayer 已提交
384
#endif
385
    /**
D
Diego Biurrun 已提交
386
     * Gets the next timestamp in stream[stream_index].time_base units.
D
Diego Biurrun 已提交
387
     * @return the timestamp or AV_NOPTS_VALUE if an error occurred
388 389 390
     */
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
                              int64_t *pos, int64_t pos_limit);
391 392 393 394

    /**
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
     */
F
Fabrice Bellard 已提交
395
    int flags;
396 397 398 399 400 401

    /**
     * If extensions are defined, then no probe is done. You should
     * usually not use extension format guessing because it is not
     * reliable enough
     */
402
    const char *extensions;
403 404 405 406

    /**
     * General purpose read-only value that the format can use.
     */
407
    int value;
408

409 410 411 412
    /**
     * Start/resume playing - only meaningful if using a network-based format
     * (RTSP).
     */
413 414
    int (*read_play)(struct AVFormatContext *);

415 416 417 418
    /**
     * Pause playing - only meaningful if using a network-based format
     * (RTSP).
     */
419 420
    int (*read_pause)(struct AVFormatContext *);

421
    const struct AVCodecTag * const *codec_tag;
422

M
Michael Niedermayer 已提交
423
    /**
424
     * Seek to timestamp ts.
M
Michael Niedermayer 已提交
425 426 427 428
     * Seeking will be done so that the point from which all active streams
     * can be presented successfully will be closest to ts and within min/max_ts.
     * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
     */
M
untypo  
Michael Niedermayer 已提交
429
    int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
M
Michael Niedermayer 已提交
430

431
#if FF_API_OLD_METADATA2
432
    const AVMetadataConv *metadata_conv;
433
#endif
A
Aurelien Jacobs 已提交
434

435 436
    const AVClass *priv_class; ///< AVClass for the private context

437 438 439
    /* private fields */
    struct AVInputFormat *next;
} AVInputFormat;
F
Fabrice Bellard 已提交
440

A
Aurelien Jacobs 已提交
441 442 443
enum AVStreamParseType {
    AVSTREAM_PARSE_NONE,
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
D
Diego Biurrun 已提交
444
    AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
445
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
446
    AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
A
Aurelien Jacobs 已提交
447 448
};

449 450 451 452
typedef struct AVIndexEntry {
    int64_t pos;
    int64_t timestamp;
#define AVINDEX_KEYFRAME 0x0001
M
Michael Niedermayer 已提交
453
    int flags:2;
D
Diego Biurrun 已提交
454 455
    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).
    int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
456 457
} AVIndexEntry;

458 459 460 461 462 463
#define AV_DISPOSITION_DEFAULT   0x0001
#define AV_DISPOSITION_DUB       0x0002
#define AV_DISPOSITION_ORIGINAL  0x0004
#define AV_DISPOSITION_COMMENT   0x0008
#define AV_DISPOSITION_LYRICS    0x0010
#define AV_DISPOSITION_KARAOKE   0x0020
464 465 466 467 468 469

/**
 * Track should be used during playback by default.
 * Useful for subtitle track that should be displayed
 * even when user did not explicitly ask for subtitles.
 */
470
#define AV_DISPOSITION_FORCED    0x0040
471 472
#define AV_DISPOSITION_HEARING_IMPAIRED  0x0080  /**< stream for hearing impaired audiences */
#define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100  /**< stream for visual impaired audiences */
473
#define AV_DISPOSITION_CLEAN_EFFECTS     0x0200  /**< stream without voice */
474

475 476 477
/**
 * Stream structure.
 * New fields can be added to the end with minor version bumps.
D
Diego Biurrun 已提交
478
 * Removal, reordering and changes to existing fields require a major
479
 * version bump.
D
Diego Biurrun 已提交
480
 * sizeof(AVStream) must not be used outside libav*.
481
 */
F
Fabrice Bellard 已提交
482
typedef struct AVStream {
483
    int index;    /**< stream index in AVFormatContext */
D
Diego Biurrun 已提交
484
    int id;       /**< format-specific stream ID */
485
    AVCodecContext *codec; /**< codec context */
486
    /**
487 488
     * Real base framerate of the stream.
     * This is the lowest framerate with which all timestamps can be
R
Typos  
Ramiro Polla 已提交
489
     * represented accurately (it is the least common multiple of all
490 491
     * framerates in the stream). Note, this value is just a guess!
     * For example, if the time base is 1/90000 and all frames have either
D
Diego Biurrun 已提交
492
     * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
493 494
     */
    AVRational r_frame_rate;
F
Fabrice Bellard 已提交
495
    void *priv_data;
496

497
    /* internal data used in av_find_stream_info() */
498
    int64_t first_dts;
499 500 501 502

    /**
     * encoding: pts generation when outputting stream
     */
503
    struct AVFrac pts;
504 505

    /**
D
Diego Biurrun 已提交
506 507
     * This is the fundamental unit of time (in seconds) in terms
     * of which frame timestamps are represented. For fixed-fps content,
508
     * time base should be 1/framerate and timestamp increments should be 1.
509 510
     * decoding: set by libavformat
     * encoding: set by libavformat in av_write_header
511
     */
512
    AVRational time_base;
513
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
F
Fabrice Bellard 已提交
514
    /* ffmpeg.c private use */
D
Diego Biurrun 已提交
515 516
    int stream_copy; /**< If set, just copy stream. */
    enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
517

518
    //FIXME move stuff to a flags field?
519 520 521 522
    /**
     * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
     * MN: dunno if that is the right place for it
     */
523
    float quality;
524

525
    /**
D
Diego Biurrun 已提交
526 527 528
     * Decoding: pts of the first frame of the stream, in stream time base.
     * Only set this if you are absolutely 100% sure that the value you set
     * it to really is the pts of the first frame.
529
     * This may be undefined (AV_NOPTS_VALUE).
530
     */
531
    int64_t start_time;
532

533
    /**
D
Diego Biurrun 已提交
534
     * Decoding: duration of the stream, in stream time base.
535
     * If a source file does not specify a duration, but does specify
D
Diego Biurrun 已提交
536
     * a bitrate, this value will be estimated from bitrate and file size.
537
     */
538
    int64_t duration;
539 540

    /* av_read_frame() support */
A
Aurelien Jacobs 已提交
541
    enum AVStreamParseType need_parsing;
542
    struct AVCodecParserContext *parser;
543

544
    int64_t cur_dts;
M
Michael Niedermayer 已提交
545 546
    int last_IP_duration;
    int64_t last_IP_pts;
547
    /* av_seek_frame() support */
D
Diego Biurrun 已提交
548 549
    AVIndexEntry *index_entries; /**< Only used if the format does not
                                    support seeking natively. */
550
    int nb_index_entries;
M
Måns Rullgård 已提交
551
    unsigned int index_entries_allocated_size;
552

553
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
554

D
Diego Biurrun 已提交
555
    int disposition; /**< AV_DISPOSITION_* bit field */
556 557

    AVProbeData probe_data;
558 559
#define MAX_REORDER_DELAY 16
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
560 561 562 563 564 565 566

    /**
     * sample aspect ratio (0 if unknown)
     * - encoding: Set by user.
     * - decoding: Set by libavformat.
     */
    AVRational sample_aspect_ratio;
567

568
    AVDictionary *metadata;
569

570 571
    /* Intended mostly for av_read_frame() support. Not supposed to be used by */
    /* external applications; try to use something else if at all possible.    */
572 573 574
    const uint8_t *cur_ptr;
    int cur_len;
    AVPacket cur_pkt;
575 576 577 578 579 580 581 582 583 584

    // Timestamp generation support:
    /**
     * Timestamp corresponding to the last dts sync point.
     *
     * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
     * a DTS is received from the underlying container. Otherwise set to
     * AV_NOPTS_VALUE by default.
     */
    int64_t reference_dts;
585 586 587 588 589

    /**
     * Number of packets to buffer for codec probing
     * NOT PART OF PUBLIC API
     */
590
#define MAX_PROBE_PACKETS 2500
591
    int probe_packets;
592 593

    /**
594
     * last packet in packet_buffer for this stream when muxing.
595 596
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
     */
597
    struct AVPacketList *last_in_packet_buffer;
M
Michael Niedermayer 已提交
598 599 600 601 602

    /**
     * Average framerate
     */
    AVRational avg_frame_rate;
603 604 605 606 607

    /**
     * Number of frames that have been demuxed during av_find_stream_info()
     */
    int codec_info_nb_frames;
608 609 610 611 612 613 614 615 616 617 618 619

    /**
     * Stream informations used internally by av_find_stream_info()
     */
#define MAX_STD_TIMEBASES (60*12+5)
    struct {
        int64_t last_dts;
        int64_t duration_gcd;
        int duration_count;
        double duration_error[MAX_STD_TIMEBASES];
        int64_t codec_info_duration;
    } *info;
F
Fabrice Bellard 已提交
620 621
} AVStream;

622 623
#define AV_PROGRAM_RUNNING 1

624 625
/**
 * New fields can be added to the end with minor version bumps.
D
Diego Biurrun 已提交
626
 * Removal, reordering and changes to existing fields require a major
627
 * version bump.
D
Diego Biurrun 已提交
628
 * sizeof(AVProgram) must not be used outside libav*.
629
 */
630 631 632 633
typedef struct AVProgram {
    int            id;
    int            flags;
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
634 635
    unsigned int   *stream_index;
    unsigned int   nb_stream_indexes;
636
    AVDictionary *metadata;
637 638
} AVProgram;

639
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
640 641
                                         (streams are added dynamically) */

642
typedef struct AVChapter {
D
Diego Biurrun 已提交
643 644
    int id;                 ///< unique ID to identify the chapter
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
M
Michael Niedermayer 已提交
645
    int64_t start, end;     ///< chapter start/end time in time_base units
646
    AVDictionary *metadata;
647 648
} AVChapter;

649
/**
D
Diego Biurrun 已提交
650
 * Format I/O context.
651
 * New fields can be added to the end with minor version bumps.
D
Diego Biurrun 已提交
652
 * Removal, reordering and changes to existing fields require a major
653
 * version bump.
D
Diego Biurrun 已提交
654
 * sizeof(AVFormatContext) must not be used outside libav*.
655
 */
F
Fabrice Bellard 已提交
656
typedef struct AVFormatContext {
657
    const AVClass *av_class; /**< Set by avformat_alloc_context. */
D
Diego Biurrun 已提交
658
    /* Can only be iformat or oformat, not both at the same time. */
659 660
    struct AVInputFormat *iformat;
    struct AVOutputFormat *oformat;
F
Fabrice Bellard 已提交
661
    void *priv_data;
662
    AVIOContext *pb;
663
    unsigned int nb_streams;
664
    AVStream **streams;
665
    char filename[1024]; /**< input or output filename */
F
Fabrice Bellard 已提交
666
    /* stream info */
667
    int64_t timestamp;
668

D
Diego Biurrun 已提交
669 670
    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
    /* private data for pts handling (do not modify directly). */
671 672 673 674 675
    /**
     * This buffer is only needed when packets were already buffered but
     * not decoded, for example to get the codec parameters in MPEG
     * streams.
     */
676 677
    struct AVPacketList *packet_buffer;

678 679 680 681 682
    /**
     * Decoding: position of the first frame of the component, in
     * AV_TIME_BASE fractional seconds. NEVER set this value directly:
     * It is deduced from the AVStream values.
     */
683
    int64_t start_time;
684 685 686 687 688 689 690

    /**
     * Decoding: duration of the stream, in AV_TIME_BASE fractional
     * seconds. Only set this value if you know none of the individual stream
     * durations and also dont set any of them. This is deduced from the
     * AVStream values if not set.
     */
691
    int64_t duration;
692 693 694 695

    /**
     * decoding: total file size, 0 if unknown
     */
696
    int64_t file_size;
697 698 699 700

    /**
     * Decoding: total stream bitrate in bit/s, 0 if not
     * available. Never set it directly if the file_size and the
701
     * duration are known as Libav can compute it automatically.
702
     */
703
    int bit_rate;
704 705 706 707 708

    /* av_read_frame() support */
    AVStream *cur_st;

    /* av_seek_frame() support */
709
    int64_t data_offset; /**< offset of the first packet */
710

711
    int mux_rate;
712
    unsigned int packet_size;
713 714
    int preload;
    int max_delay;
715

716 717
#define AVFMT_NOOUTPUTLOOP -1
#define AVFMT_INFINITEOUTPUTLOOP 0
718 719 720
    /**
     * number of times to loop output in formats that support it
     */
721
    int loop_output;
722

723
    int flags;
724
#define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
D
Diego Biurrun 已提交
725 726
#define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
727
#define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
728 729
#define AVFMT_FLAG_NOFILLIN     0x0010 ///< Do not infer any values from other values, just return what is stored in the container
#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
730 731 732
#if FF_API_FLAG_RTP_HINT
#define AVFMT_FLAG_RTP_HINT     0x0040 ///< Deprecated, use the -movflags rtphint muxer specific AVOption instead
#endif
733 734

    int loop_input;
735 736 737 738

    /**
     * decoding: size of data to probe; encoding: unused.
     */
739
    unsigned int probesize;
740 741

    /**
D
Diego Biurrun 已提交
742 743
     * Maximum time (in AV_TIME_BASE units) during which the input should
     * be analyzed in av_find_stream_info().
744 745
     */
    int max_analyze_duration;
746 747 748

    const uint8_t *key;
    int keylen;
749 750 751

    unsigned int nb_programs;
    AVProgram **programs;
M
Michael Niedermayer 已提交
752 753 754

    /**
     * Forced video codec_id.
D
Diego Biurrun 已提交
755
     * Demuxing: Set by user.
M
Michael Niedermayer 已提交
756 757
     */
    enum CodecID video_codec_id;
758

M
Michael Niedermayer 已提交
759 760
    /**
     * Forced audio codec_id.
D
Diego Biurrun 已提交
761
     * Demuxing: Set by user.
M
Michael Niedermayer 已提交
762 763
     */
    enum CodecID audio_codec_id;
764

M
Michael Niedermayer 已提交
765 766
    /**
     * Forced subtitle codec_id.
D
Diego Biurrun 已提交
767
     * Demuxing: Set by user.
M
Michael Niedermayer 已提交
768 769
     */
    enum CodecID subtitle_codec_id;
770 771

    /**
772 773
     * Maximum amount of memory in bytes to use for the index of each stream.
     * If the index exceeds this size, entries will be discarded as
774 775
     * needed to maintain a smaller size. This can lead to slower or less
     * accurate seeking (depends on demuxer).
D
Diego Biurrun 已提交
776
     * Demuxers for which a full in-memory index is mandatory will ignore
777 778 779 780 781
     * this.
     * muxing  : unused
     * demuxing: set by user
     */
    unsigned int max_index_size;
782 783

    /**
R
Ramiro Polla 已提交
784
     * Maximum amount of memory in bytes to use for buffering frames
D
Diego Biurrun 已提交
785
     * obtained from realtime capture devices.
786 787
     */
    unsigned int max_picture_buffer;
788

789
    unsigned int nb_chapters;
790
    AVChapter **chapters;
791 792

    /**
D
Diego Biurrun 已提交
793
     * Flags to enable debugging.
794 795 796
     */
    int debug;
#define FF_FDEBUG_TS        0x0001
797 798

    /**
D
Diego Biurrun 已提交
799
     * Raw packets from the demuxer, prior to parsing and decoding.
800 801 802 803 804
     * This buffer is used for buffering packets until the codec can
     * be identified, as parsing cannot be done without knowing the
     * codec.
     */
    struct AVPacketList *raw_packet_buffer;
805 806 807
    struct AVPacketList *raw_packet_buffer_end;

    struct AVPacketList *packet_buffer_end;
M
Michael Niedermayer 已提交
808

809
    AVDictionary *metadata;
810 811 812 813 814

    /**
     * Remaining size available for raw_packet_buffer, in bytes.
     * NOT PART OF PUBLIC API
     */
815
#define RAW_PACKET_BUFFER_SIZE 2500000
816
    int raw_packet_buffer_remaining_size;
817 818 819 820 821 822 823 824 825

    /**
     * Start time of the stream in real world time, in microseconds
     * since the unix epoch (00:00 1st January 1970). That is, pts=0
     * in the stream was captured at this real world time.
     * - encoding: Set by user.
     * - decoding: Unused.
     */
    int64_t start_time_realtime;
826 827 828 829 830

    /**
     * decoding: number of frames used to probe fps
     */
    int fps_probe_size;
F
Fabrice Bellard 已提交
831 832 833 834 835 836 837
} AVFormatContext;

typedef struct AVPacketList {
    AVPacket pkt;
    struct AVPacketList *next;
} AVPacketList;

838 839
/**
 * If f is NULL, returns the first registered input format,
840
 * if f is non-NULL, returns the next registered input format after f
841 842
 * or NULL if f is the last one.
 */
843
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
844 845 846

/**
 * If f is NULL, returns the first registered output format,
847
 * if f is non-NULL, returns the next registered output format after f
848 849
 * or NULL if f is the last one.
 */
850
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
F
Fabrice Bellard 已提交
851

852 853 854
#if FF_API_GUESS_IMG2_CODEC
attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
#endif
855

856 857
/* XXX: Use automatic init with either ELF sections or C file parser */
/* modules. */
F
Fabrice Bellard 已提交
858

859 860 861
/* utils.c */
void av_register_input_format(AVInputFormat *format);
void av_register_output_format(AVOutputFormat *format);
S
Stefano Sabatini 已提交
862 863

/**
864 865
 * Return the output format in the list of registered output formats
 * which best matches the provided parameters, or return NULL if
S
Stefano Sabatini 已提交
866 867 868 869 870 871 872 873 874
 * there is no match.
 *
 * @param short_name if non-NULL checks if short_name matches with the
 * names of the registered formats
 * @param filename if non-NULL checks if filename terminates with the
 * extensions of the registered formats
 * @param mime_type if non-NULL checks if mime_type matches with the
 * MIME type of the registered formats
 */
875
AVOutputFormat *av_guess_format(const char *short_name,
S
Stefano Sabatini 已提交
876 877
                                const char *filename,
                                const char *mime_type);
878 879

/**
880
 * Guess the codec ID based upon muxer and filename.
881
 */
882
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
883
                            const char *filename, const char *mime_type,
884
                            enum AVMediaType type);
F
Fabrice Bellard 已提交
885

886
/**
887
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
888 889
 *
 * @param f The file stream pointer where the dump should be sent to.
890 891
 * @param buf buffer
 * @param size buffer size
892
 *
893
 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
894
 */
895
void av_hex_dump(FILE *f, uint8_t *buf, int size);
896 897

/**
898
 * Send a nice hexadecimal dump of a buffer to the log.
899 900 901 902 903 904 905 906
 *
 * @param avcl A pointer to an arbitrary struct of which the first field is a
 * pointer to an AVClass struct.
 * @param level The importance level of the message, lower values signifying
 * higher importance.
 * @param buf buffer
 * @param size buffer size
 *
907
 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
908 909 910 911
 */
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);

/**
912
 * Send a nice dump of a packet to the specified file stream.
913 914
 *
 * @param f The file stream pointer where the dump should be sent to.
915
 * @param pkt packet to dump
D
Diego Biurrun 已提交
916
 * @param dump_payload True if the payload must be displayed, too.
917
 * @param st AVStream that the packet belongs to
918
 */
919 920
void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);

F
Fabrice Bellard 已提交
921

922
/**
923
 * Send a nice dump of a packet to the log.
924 925 926 927 928 929
 *
 * @param avcl A pointer to an arbitrary struct of which the first field is a
 * pointer to an AVClass struct.
 * @param level The importance level of the message, lower values signifying
 * higher importance.
 * @param pkt packet to dump
D
Diego Biurrun 已提交
930
 * @param dump_payload True if the payload must be displayed, too.
931
 * @param st AVStream that the packet belongs to
932
 */
933 934 935
void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
                      AVStream *st);

936 937
#if FF_API_PKT_DUMP
attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
938 939
attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
                                          int dump_payload);
940
#endif
941

942
/**
943
 * Initialize libavformat and register all the muxers, demuxers and
944 945 946 947 948
 * protocols. If you do not call this function, then you can select
 * exactly which formats you want to support.
 *
 * @see av_register_input_format()
 * @see av_register_output_format()
949
 * @see av_register_protocol()
950
 */
F
Fabrice Bellard 已提交
951
void av_register_all(void);
F
Fabrice Bellard 已提交
952

953
/**
954
 * Get the CodecID for the given codec tag tag.
955 956 957 958 959
 * If no codec id is found returns CODEC_ID_NONE.
 *
 * @param tags list of supported codec_id-codec_tag pairs, as stored
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
 */
960
enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
961 962

/**
963
 * Get the codec tag for the given codec id id.
964 965 966 967 968
 * If no codec tag is found returns 0.
 *
 * @param tags list of supported codec_id-codec_tag pairs, as stored
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
 */
969
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
970

971
/* media file input */
972 973

/**
974
 * Find AVInputFormat based on the short name of the input format.
975
 */
976
AVInputFormat *av_find_input_format(const char *short_name);
977 978

/**
979
 * Guess the file format.
980
 *
D
Diego Biurrun 已提交
981 982
 * @param is_opened Whether the file is already opened; determines whether
 *                  demuxers with or without AVFMT_NOFILE are probed.
983
 */
F
Fabrice Bellard 已提交
984
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
985

986
/**
987
 * Guess the file format.
988 989 990
 *
 * @param is_opened Whether the file is already opened; determines whether
 *                  demuxers with or without AVFMT_NOFILE are probed.
991 992 993 994
 * @param score_max A probe score larger that this is required to accept a
 *                  detection, the variable is set to the actual detection
 *                  score afterwards.
 *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
995 996 997 998
 *                  to retry with a larger probe buffer.
 */
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);

999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
/**
 * Probe a bytestream to determine the input format. Each time a probe returns
 * with a score that is too low, the probe buffer size is increased and another
 * attempt is made. When the maximum probe size is reached, the input format
 * with the highest score is returned.
 *
 * @param pb the bytestream to probe
 * @param fmt the input format is put here
 * @param filename the filename of the stream
 * @param logctx the log context
 * @param offset the offset within the bytestream to probe from
 * @param max_probe_size the maximum probe buffer size (zero for default)
 * @return 0 in case of success, a negative value corresponding to an
 * AVERROR code otherwise
 */
1014
int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1015 1016 1017
                          const char *filename, void *logctx,
                          unsigned int offset, unsigned int max_probe_size);

1018
/**
1019
 * Allocate all the structures needed to read an input stream.
1020 1021
 *        This does not open the needed codecs for decoding the stream[s].
 */
1022
int av_open_input_stream(AVFormatContext **ic_ptr,
1023
                         AVIOContext *pb, const char *filename,
1024
                         AVInputFormat *fmt, AVFormatParameters *ap);
1025 1026

/**
1027
 * Open a media file as input. The codecs are not opened. Only the file
1028 1029
 * header (if present) is read.
 *
D
Diego Biurrun 已提交
1030 1031 1032
 * @param ic_ptr The opened media file handle is put here.
 * @param filename filename to open
 * @param fmt If non-NULL, force the file format to use.
1033
 * @param buf_size optional buffer size (zero if default is OK)
1034 1035
 * @param ap Additional parameters needed when opening the file
 *           (NULL if default).
D
Diego Biurrun 已提交
1036
 * @return 0 if OK, AVERROR_xxx otherwise
1037
 */
1038
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1039 1040 1041
                       AVInputFormat *fmt,
                       int buf_size,
                       AVFormatParameters *ap);
1042

1043
/**
1044
 * Allocate an AVFormatContext.
1045 1046
 * avformat_free_context() can be used to free the context and everything
 * allocated by the framework within it.
1047
 */
1048
AVFormatContext *avformat_alloc_context(void);
1049

1050
/**
1051
 * Read packets of a media file to get stream information. This
1052
 * is useful for file formats with no headers such as MPEG. This
1053
 * function also computes the real framerate in case of MPEG-2 repeat
1054 1055 1056 1057 1058
 * frame mode.
 * The logical file position is not changed by this function;
 * examined packets may be buffered for later processing.
 *
 * @param ic media file handle
D
Diego Biurrun 已提交
1059 1060 1061
 * @return >=0 if OK, AVERROR_xxx on error
 * @todo Let the user decide somehow what information is needed so that
 *       we do not waste time getting stuff the user does not need.
1062
 */
1063
int av_find_stream_info(AVFormatContext *ic);
1064

N
Nicolas George 已提交
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
/**
 * Find the "best" stream in the file.
 * The best stream is determined according to various heuristics as the most
 * likely to be what the user expects.
 * If the decoder parameter is non-NULL, av_find_best_stream will find the
 * default decoder for the stream's codec; streams for which no decoder can
 * be found are ignored.
 *
 * @param ic                media file handle
 * @param type              stream type: video, audio, subtitles, etc.
 * @param wanted_stream_nb  user-requested stream number,
 *                          or -1 for automatic selection
 * @param related_stream    try to find a stream related (eg. in the same
 *                          program) to this one, or -1 if none
 * @param decoder_ret       if non-NULL, returns the decoder for the
 *                          selected stream
 * @param flags             flags; none are currently defined
 * @return  the non-negative stream number in case of success,
 *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
 *          could be found,
 *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
 * @note  If av_find_best_stream returns successfully and decoder_ret is not
 *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
 */
int av_find_best_stream(AVFormatContext *ic,
                        enum AVMediaType type,
                        int wanted_stream_nb,
                        int related_stream,
                        AVCodec **decoder_ret,
                        int flags);

1096
/**
1097
 * Read a transport packet from a media file.
1098
 *
R
Typos  
Ramiro Polla 已提交
1099
 * This function is obsolete and should never be used.
1100 1101 1102 1103
 * Use av_read_frame() instead.
 *
 * @param s media file handle
 * @param pkt is filled
D
Diego Biurrun 已提交
1104
 * @return 0 if OK, AVERROR_xxx on error
1105
 */
F
Fabrice Bellard 已提交
1106
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1107 1108

/**
1109
 * Return the next frame of a stream.
1110 1111 1112 1113 1114
 * This function returns what is stored in the file, and does not validate
 * that what is there are valid frames for the decoder. It will split what is
 * stored in the file into frames and return one for each call. It will not
 * omit invalid data between valid frames so as to give the decoder the maximum
 * information possible for decoding.
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
 *
 * The returned packet is valid
 * until the next av_read_frame() or until av_close_input_file() and
 * must be freed with av_free_packet. For video, the packet contains
 * exactly one frame. For audio, it contains an integer number of
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
 * data). If the audio frames have a variable size (e.g. MPEG audio),
 * then it contains one frame.
 *
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1125
 * values in AVStream.time_base units (and guessed if the format cannot
D
Diego Biurrun 已提交
1126 1127
 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
 * has B-frames, so it is better to rely on pkt->dts if you do not
1128 1129
 * decompress the payload.
 *
D
Diego Biurrun 已提交
1130
 * @return 0 if OK, < 0 on error or end of file
1131
 */
1132
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1133 1134

/**
1135
 * Seek to the keyframe at timestamp.
1136 1137 1138 1139
 * 'timestamp' in 'stream_index'.
 * @param stream_index If stream_index is (-1), a default
 * stream is selected, and timestamp is automatically converted
 * from AV_TIME_BASE units to the stream specific time_base.
D
Diego Biurrun 已提交
1140 1141
 * @param timestamp Timestamp in AVStream.time_base units
 *        or, if no stream is specified, in AV_TIME_BASE units.
1142 1143 1144
 * @param flags flags which select direction and seeking mode
 * @return >= 0 on success
 */
1145 1146
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
                  int flags);
1147

1148
/**
1149
 * Seek to timestamp ts.
1150 1151 1152 1153
 * Seeking will be done so that the point from which all active streams
 * can be presented successfully will be closest to ts and within min/max_ts.
 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
 *
1154
 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1155
 * are the file position (this may not be supported by all demuxers).
1156
 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1157
 * in the stream with stream_index (this may not be supported by all demuxers).
1158 1159 1160
 * Otherwise all timestamps are in units of the stream selected by stream_index
 * or if stream_index is -1, in AV_TIME_BASE units.
 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1161 1162
 * keyframes (this may not be supported by all demuxers).
 *
1163
 * @param stream_index index of the stream which is used as time base reference
1164 1165 1166 1167
 * @param min_ts smallest acceptable timestamp
 * @param ts target timestamp
 * @param max_ts largest acceptable timestamp
 * @param flags flags
B
Benoit Fouet 已提交
1168
 * @return >=0 on success, error code otherwise
1169
 *
1170
 * @note This is part of the new seek API which is still under construction.
1171 1172
 *       Thus do not use this yet. It may change at any time, do not expect
 *       ABI compatibility yet!
1173 1174 1175
 */
int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);

1176
/**
1177
 * Start playing a network-based stream (e.g. RTSP stream) at the
D
Diego Biurrun 已提交
1178
 * current position.
1179
 */
1180
int av_read_play(AVFormatContext *s);
1181 1182

/**
1183
 * Pause a network-based stream (e.g. RTSP stream).
1184 1185 1186
 *
 * Use av_read_play() to resume it.
 */
1187
int av_read_pause(AVFormatContext *s);
1188

1189
/**
1190
 * Free a AVFormatContext allocated by av_open_input_stream.
1191 1192 1193 1194
 * @param s context to free
 */
void av_close_input_stream(AVFormatContext *s);

1195
/**
1196
 * Close a media file (but not its codecs).
1197 1198 1199
 *
 * @param s media file handle
 */
F
Fabrice Bellard 已提交
1200
void av_close_input_file(AVFormatContext *s);
1201

1202 1203 1204 1205 1206 1207
/**
 * Free an AVFormatContext and all its streams.
 * @param s context to free
 */
void avformat_free_context(AVFormatContext *s);

1208
/**
1209
 * Add a new stream to a media file.
1210 1211 1212 1213 1214 1215
 *
 * Can only be called in the read_header() function. If the flag
 * AVFMTCTX_NOHEADER is in the format context, then new streams
 * can be added in read_packet too.
 *
 * @param s media file handle
D
Diego Biurrun 已提交
1216
 * @param id file-format-dependent stream ID
1217
 */
1218
AVStream *av_new_stream(AVFormatContext *s, int id);
1219
AVProgram *av_new_program(AVFormatContext *s, int id);
1220 1221

/**
1222 1223
 * Set the pts for a given stream. If the new values would be invalid
 * (<= 0), it leaves the AVStream unchanged.
1224 1225 1226 1227 1228 1229 1230
 *
 * @param s stream
 * @param pts_wrap_bits number of bits effectively used by the pts
 *        (used for wrap control, 33 is the value for MPEG)
 * @param pts_num numerator to convert to seconds (MPEG: 1)
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
 */
1231
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1232
                     unsigned int pts_num, unsigned int pts_den);
F
Fabrice Bellard 已提交
1233

1234 1235
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
D
Diego Biurrun 已提交
1236
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1237
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1238

1239
int av_find_default_stream_index(AVFormatContext *s);
1240 1241

/**
1242
 * Get the index for a specific timestamp.
D
Diego Biurrun 已提交
1243 1244 1245
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
 *                 to the timestamp which is <= the requested one, if backward
 *                 is 0, then it will be >=
1246 1247 1248
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
 * @return < 0 if no such timestamp could be found
 */
1249
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1250 1251

/**
1252
 * Add an index entry into a sorted list. Update the entry if the list
D
Diego Biurrun 已提交
1253
 * already contains it.
1254
 *
D
Diego Biurrun 已提交
1255
 * @param timestamp timestamp in the time base of the given stream
1256
 */
1257 1258
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
                       int size, int distance, int flags);
1259 1260

/**
1261
 * Perform a binary search using av_index_search_timestamp() and
1262
 * AVInputFormat.read_timestamp().
1263 1264
 * This is not supposed to be called directly by a user application,
 * but by demuxers.
1265 1266 1267
 * @param target_ts target timestamp in the time base of the given stream
 * @param stream_index stream number
 */
1268 1269
int av_seek_frame_binary(AVFormatContext *s, int stream_index,
                         int64_t target_ts, int flags);
1270 1271

/**
1272
 * Update cur_dts of all streams based on the given timestamp and AVStream.
1273
 *
D
Diego Biurrun 已提交
1274 1275
 * Stream ref_st unchanged, others set cur_dts in their native time base.
 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1276 1277 1278
 * @param timestamp new dts expressed in time_base of param ref_st
 * @param ref_st reference stream giving time_base of param timestamp
 */
1279
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1280 1281

/**
1282
 * Perform a binary search using read_timestamp().
1283 1284
 * This is not supposed to be called directly by a user application,
 * but by demuxers.
1285 1286 1287
 * @param target_ts target timestamp in the time base of the given stream
 * @param stream_index stream number
 */
1288 1289 1290 1291 1292 1293
int64_t av_gen_search(AVFormatContext *s, int stream_index,
                      int64_t target_ts, int64_t pos_min,
                      int64_t pos_max, int64_t pos_limit,
                      int64_t ts_min, int64_t ts_max,
                      int flags, int64_t *ts_ret,
                      int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1294

1295 1296 1297
/**
 * media file output
 */
1298
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1299

M
Måns Rullgård 已提交
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
/**
 * Split a URL string into components.
 *
 * The pointers to buffers for storing individual components may be null,
 * in order to ignore that component. Buffers for components not found are
 * set to empty strings. If the port is not found, it is set to a negative
 * value.
 *
 * @param proto the buffer for the protocol
 * @param proto_size the size of the proto buffer
 * @param authorization the buffer for the authorization
 * @param authorization_size the size of the authorization buffer
 * @param hostname the buffer for the host name
 * @param hostname_size the size of the hostname buffer
 * @param port_ptr a pointer to store the port number in
 * @param path the buffer for the path
 * @param path_size the size of the path buffer
 * @param url the URL to split
 */
void av_url_split(char *proto,         int proto_size,
                  char *authorization, int authorization_size,
                  char *hostname,      int hostname_size,
                  int *port_ptr,
                  char *path,          int path_size,
                  const char *url);

1326
/**
1327
 * Allocate the stream private data and write the stream header to an
D
Diego Biurrun 已提交
1328
 * output media file.
1329 1330
 * @note: this sets stream time-bases, if possible to stream->codec->time_base
 * but for some formats it might also be some other time base
1331 1332
 *
 * @param s media file handle
D
Diego Biurrun 已提交
1333
 * @return 0 if OK, AVERROR_xxx on error
1334
 */
1335
int av_write_header(AVFormatContext *s);
1336 1337

/**
1338
 * Write a packet to an output media file.
1339 1340
 *
 * The packet shall contain one audio or video frame.
1341 1342
 * The packet must be correctly interleaved according to the container
 * specification, if not then av_interleaved_write_frame must be used.
1343 1344
 *
 * @param s media file handle
1345 1346
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
              dts/pts, ...
D
Diego Biurrun 已提交
1347
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1348
 */
1349
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1350 1351

/**
1352
 * Write a packet to an output media file ensuring correct interleaving.
1353 1354
 *
 * The packet must contain one audio or video frame.
1355
 * If the packets are already correctly interleaved, the application should
D
Diego Biurrun 已提交
1356 1357 1358 1359
 * call av_write_frame() instead as it is slightly faster. It is also important
 * to keep in mind that completely non-interleaved input will need huge amounts
 * of memory to interleave with this, so it is preferable to interleave at the
 * demuxer level.
1360 1361
 *
 * @param s media file handle
1362 1363
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
              dts/pts, ...
D
Diego Biurrun 已提交
1364
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1365
 */
1366
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1367 1368

/**
1369
 * Interleave a packet per dts in an output media file.
1370
 *
1371
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1372
 * function, so they cannot be used after it. Note that calling av_free_packet()
1373
 * on them is still safe.
1374 1375 1376
 *
 * @param s media file handle
 * @param out the interleaved packet will be output here
1377
 * @param pkt the input packet
1378 1379 1380
 * @param flush 1 if no further packets are available as input and all
 *              remaining packets should be output
 * @return 1 if a packet was output, 0 if no packet could be output,
D
Diego Biurrun 已提交
1381
 *         < 0 if an error occurred
1382
 */
1383 1384
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
                                 AVPacket *pkt, int flush);
1385

1386
/**
1387
 * Write the stream trailer to an output media file and free the
1388
 * file private data.
1389
 *
1390 1391
 * May only be called after a successful call to av_write_header.
 *
1392
 * @param s media file handle
D
Diego Biurrun 已提交
1393
 * @return 0 if OK, AVERROR_xxx on error
1394
 */
1395
int av_write_trailer(AVFormatContext *s);
F
Fabrice Bellard 已提交
1396

1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407
#if FF_API_DUMP_FORMAT
attribute_deprecated void dump_format(AVFormatContext *ic,
                                      int index,
                                      const char *url,
                                      int is_output);
#endif

void av_dump_format(AVFormatContext *ic,
                    int index,
                    const char *url,
                    int is_output);
1408

1409
#if FF_API_PARSE_DATE
1410
/**
1411
 * Parse datestr and return a corresponding number of microseconds.
1412
 *
1413
 * @param datestr String representing a date or a duration.
1414 1415
 * See av_parse_time() for the syntax of the provided string.
 * @deprecated in favor of av_parse_time()
1416
 */
1417
attribute_deprecated
1418
int64_t parse_date(const char *datestr, int duration);
1419
#endif
F
Fabrice Bellard 已提交
1420

1421 1422 1423
/**
 * Get the current time in microseconds.
 */
1424
int64_t av_gettime(void);
F
Fabrice Bellard 已提交
1425

1426
#if FF_API_FIND_INFO_TAG
1427
/**
1428
 * @deprecated use av_find_info_tag in libavutil instead.
1429
 */
1430 1431
attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
#endif
F
Fabrice Bellard 已提交
1432

1433
/**
1434
 * Return in 'buf' the path with '%d' replaced by a number.
D
Diego Biurrun 已提交
1435
 *
1436 1437 1438 1439 1440 1441
 * Also handles the '%0nd' format where 'n' is the total number
 * of digits and '%%'.
 *
 * @param buf destination buffer
 * @param buf_size destination buffer size
 * @param path numbered sequence string
P
Panagiotis Issaris 已提交
1442
 * @param number frame number
D
Diego Biurrun 已提交
1443
 * @return 0 if OK, -1 on format error
1444
 */
1445 1446
int av_get_frame_filename(char *buf, int buf_size,
                          const char *path, int number);
1447 1448

/**
1449
 * Check whether filename actually is a numbered sequence generator.
1450 1451
 *
 * @param filename possible numbered sequence string
D
Diego Biurrun 已提交
1452
 * @return 1 if a valid numbered sequence string, 0 otherwise
1453
 */
1454
int av_filename_number_test(const char *filename);
1455

L
Luca Abeni 已提交
1456
/**
1457
 * Generate an SDP for an RTP session.
L
Luca Abeni 已提交
1458 1459 1460 1461 1462
 *
 * @param ac array of AVFormatContexts describing the RTP streams. If the
 *           array is composed by only one context, such context can contain
 *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
 *           all the contexts in the array (an AVCodecContext per RTP stream)
D
Diego Biurrun 已提交
1463
 *           must contain only one AVStream.
1464
 * @param n_files number of AVCodecContexts contained in ac
1465 1466
 * @param buf buffer where the SDP will be stored (must be allocated by
 *            the caller)
1467
 * @param size the size of the buffer
D
Diego Biurrun 已提交
1468
 * @return 0 if OK, AVERROR_xxx on error
L
Luca Abeni 已提交
1469
 */
1470
int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1471 1472 1473 1474

#if FF_API_SDP_CREATE
attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
#endif
L
Luca Abeni 已提交
1475

1476
/**
1477
 * Return a positive value if the given filename has one of the given
1478 1479 1480 1481 1482 1483
 * extensions, 0 otherwise.
 *
 * @param extensions a comma-separated list of filename extensions
 */
int av_match_ext(const char *filename, const char *extensions);

1484
#endif /* AVFORMAT_AVFORMAT_H */