avformat.h 52.2 KB
Newer Older
1 2 3
/*
 * copyright (c) 2001 Fabrice Bellard
 *
4 5 6
 * This file is part of FFmpeg.
 *
 * FFmpeg 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
 * FFmpeg 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 FFmpeg; 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
#define LIBAVFORMAT_VERSION_MAJOR 52
25
#define LIBAVFORMAT_VERSION_MINOR 78
26
#define LIBAVFORMAT_VERSION_MICRO  5
27

28 29 30 31 32 33
#define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \
                                               LIBAVFORMAT_VERSION_MINOR, \
                                               LIBAVFORMAT_VERSION_MICRO)
#define LIBAVFORMAT_VERSION     AV_VERSION(LIBAVFORMAT_VERSION_MAJOR,   \
                                           LIBAVFORMAT_VERSION_MINOR,   \
                                           LIBAVFORMAT_VERSION_MICRO)
M
Michael Niedermayer 已提交
34
#define LIBAVFORMAT_BUILD       LIBAVFORMAT_VERSION_INT
A
Alex Beregszaszi 已提交
35

M
Michael Niedermayer 已提交
36
#define LIBAVFORMAT_IDENT       "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
37

38 39 40 41
/**
 * Those FF_API_* defines are not part of public API.
 * They may change, break or disappear at any time.
 */
42 43
#ifndef FF_API_MAX_STREAMS
#define FF_API_MAX_STREAMS   (LIBAVFORMAT_VERSION_MAJOR < 53)
44
#endif
45 46
#ifndef FF_API_OLD_METADATA
#define FF_API_OLD_METADATA  (LIBAVFORMAT_VERSION_MAJOR < 53)
47
#endif
48 49 50
#ifndef FF_API_URL_CLASS
#define FF_API_URL_CLASS     (LIBAVFORMAT_VERSION_MAJOR >= 53)
#endif
51 52 53
#ifndef FF_API_URL_RESETBUF
#define FF_API_URL_RESETBUF       (LIBAVFORMAT_VERSION_MAJOR < 53)
#endif
54 55 56
#ifndef FF_API_REGISTER_PROTOCOL
#define FF_API_REGISTER_PROTOCOL  (LIBAVFORMAT_VERSION_MAJOR < 53)
#endif
57

S
Stefano Sabatini 已提交
58
/**
A
Art Clarke 已提交
59 60
 * I return the LIBAVFORMAT_VERSION_INT constant.  You got
 * a fucking problem with that, douchebag?
S
Stefano Sabatini 已提交
61 62 63
 */
unsigned avformat_version(void);

64
/**
65
 * Return the libavformat build-time configuration.
66
 */
67
const char *avformat_configuration(void);
68 69

/**
70
 * Return the libavformat license.
71
 */
72
const char *avformat_license(void);
73

74
#include <time.h>
Z
Zdenek Kabelac 已提交
75
#include <stdio.h>  /* FILE */
76
#include "libavcodec/avcodec.h"
F
Fabrice Bellard 已提交
77 78 79

#include "avio.h"

A
Aurelien Jacobs 已提交
80 81
struct AVFormatContext;

82 83

/*
84 85
 * Public Metadata API.
 * The metadata API allows libavformat to export metadata tags to a client
86 87 88
 * application using a sequence of key/value pairs. Like all strings in FFmpeg,
 * 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.
89 90 91 92 93 94 95 96 97
 * 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.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
 * 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".
 *
 * 4. Tag names are normally exported exactly as stored in the container to
 *    allow lossless remuxing to the same format. For container-independent
 *    handling of metadata, av_metadata_conv() can convert it to ffmpeg generic
 *    format. Follows a list of generic tag names:
 *
 * 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.
 * 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
 *                 in ISO 639-2 format.
 * 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.
 * title        -- name of the work.
 * track        -- number of this work in the set, can be in form current/total.
136 137
 */

138
#define AV_METADATA_MATCH_CASE      1
139
#define AV_METADATA_IGNORE_SUFFIX   2
140 141
#define AV_METADATA_DONT_STRDUP_KEY 4
#define AV_METADATA_DONT_STRDUP_VAL 8
142
#define AV_METADATA_DONT_OVERWRITE 16   ///< Don't overwrite existing tags.
143 144 145 146

typedef struct {
    char *key;
    char *value;
147
}AVMetadataTag;
148

A
Aurelien Jacobs 已提交
149
typedef struct AVMetadata AVMetadata;
A
Aurelien Jacobs 已提交
150
typedef struct AVMetadataConv AVMetadataConv;
151 152

/**
153
 * Get a metadata element with matching key.
154
 *
155
 * @param prev Set to the previous matching element to find the next.
156
 *             If set to NULL the first matching element is returned.
157 158
 * @param flags Allows case as well as suffix-insensitive comparisons.
 * @return Found tag or NULL, changing key or value leads to undefined behavior.
159
 */
160
AVMetadataTag *
A
Aurelien Jacobs 已提交
161
av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
162

163
#if FF_API_OLD_METADATA
164
/**
165
 * Set the given tag in *pm, overwriting an existing tag.
166
 *
167 168
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
 * a metadata struct is allocated and put in *pm.
169 170
 * @param key tag key to add to *pm (will be av_strduped)
 * @param value tag value to add to *pm (will be av_strduped)
171
 * @return >= 0 on success otherwise an error code <0
172
 * @deprecated Use av_metadata_set2() instead.
173
 */
174
attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
175 176 177
#endif

/**
178
 * Set the given tag in *pm, overwriting an existing tag.
179
 *
180 181
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
 * a metadata struct is allocated and put in *pm.
182 183
 * @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).
184
 *        Passing a NULL value will cause an existing tag to be deleted.
185 186 187
 * @return >= 0 on success otherwise an error code <0
 */
int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
188

A
Aurelien Jacobs 已提交
189
/**
190
 * Convert all the metadata sets from ctx according to the source and
191 192
 * destination conversion tables. If one of the tables is NULL, then
 * tags are converted to/from ffmpeg generic tag names.
193
 *
A
Aurelien Jacobs 已提交
194 195 196
 * @param d_conv destination tags format conversion table
 * @param s_conv source tags format conversion table
 */
S
Stefano Sabatini 已提交
197 198
void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
                                                   const AVMetadataConv *s_conv);
A
Aurelien Jacobs 已提交
199

200
/**
201
 * Free all the memory allocated for an AVMetadata struct.
202 203 204
 */
void av_metadata_free(AVMetadata **m);

205

F
Fabrice Bellard 已提交
206 207
/* packet functions */

208 209

/**
210
 * Allocate and read the payload of a packet and initialize its
211
 * fields with default values.
212 213
 *
 * @param pkt packet
D
Diego Biurrun 已提交
214 215
 * @param size desired payload size
 * @return >0 (read size) if OK, AVERROR_xxx otherwise
216
 */
M
Michael Niedermayer 已提交
217
int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
218

F
Fabrice Bellard 已提交
219

F
Fabrice Bellard 已提交
220 221 222
/*************************************************/
/* fractional numbers for exact pts handling */

223
/**
D
Diego Biurrun 已提交
224 225
 * The exact value of the fractional number is: 'val + num / den'.
 * num is assumed to be 0 <= num < den.
226
 */
F
Fabrice Bellard 已提交
227
typedef struct AVFrac {
228
    int64_t val, num, den;
229
} AVFrac;
F
Fabrice Bellard 已提交
230

F
Fabrice Bellard 已提交
231
/*************************************************/
232
/* input/output formats */
F
Fabrice Bellard 已提交
233

234 235
struct AVCodecTag;

236 237 238
/**
 * This structure contains the data a format has to probe a file.
 */
239
typedef struct AVProbeData {
240
    const char *filename;
241 242
    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 */
243 244
} AVProbeData;

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

typedef struct AVFormatParameters {
249
    AVRational time_base;
F
Fabrice Bellard 已提交
250 251 252 253
    int sample_rate;
    int channels;
    int width;
    int height;
254
    enum PixelFormat pix_fmt;
D
Diego Biurrun 已提交
255 256 257 258
    int channel; /**< Used to select DV channel. */
    const char *standard; /**< TV standard, NTSC, PAL, SECAM */
    unsigned int mpeg2ts_raw:1;  /**< Force raw MPEG-2 transport stream output, if possible. */
    unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
259
                                            stream packet (only meaningful if
D
Diego Biurrun 已提交
260 261 262
                                            mpeg2ts_raw is TRUE). */
    unsigned int initial_pause:1;       /**< Do not begin to play the stream
                                            immediately (RTSP only). */
263
    unsigned int prealloced_context:1;
264
#if LIBAVFORMAT_VERSION_INT < (53<<16)
265 266
    enum CodecID video_codec_id;
    enum CodecID audio_codec_id;
267
#endif
F
Fabrice Bellard 已提交
268 269
} AVFormatParameters;

D
Diego Biurrun 已提交
270
//! Demuxer will use url_fopen, no opened file should be provided by the caller.
271
#define AVFMT_NOFILE        0x0001
D
Diego Biurrun 已提交
272 273 274 275 276 277 278 279
#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. */
#define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. */
280
#define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
281
#define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
282 283

typedef struct AVOutputFormat {
F
Fabrice Bellard 已提交
284
    const char *name;
285 286
    /**
     * Descriptive name for the format, meant to be more human-readable
287
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
288 289
     * to define it.
     */
F
Fabrice Bellard 已提交
290 291
    const char *long_name;
    const char *mime_type;
D
Diego Biurrun 已提交
292
    const char *extensions; /**< comma-separated filename extensions */
293 294 295
    /**
     * size of private data so that it can be allocated in the wrapper
     */
296
    int priv_data_size;
F
Fabrice Bellard 已提交
297
    /* output support */
298 299
    enum CodecID audio_codec; /**< default audio codec */
    enum CodecID video_codec; /**< default video codec */
F
Fabrice Bellard 已提交
300
    int (*write_header)(struct AVFormatContext *);
301
    int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
F
Fabrice Bellard 已提交
302
    int (*write_trailer)(struct AVFormatContext *);
303 304 305
    /**
     * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER
     */
306
    int flags;
307 308 309
    /**
     * Currently only used to set pixel format if not YUV420P.
     */
310
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
311 312
    int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
                             AVPacket *in, int flush);
313 314

    /**
315
     * List of supported codec_id-codec_tag pairs, ordered by "better
316
     * choice first". The arrays are all terminated by CODEC_ID_NONE.
317
     */
318
    const struct AVCodecTag * const *codec_tag;
319

320 321
    enum CodecID subtitle_codec; /**< default subtitle codec */

322
    const AVMetadataConv *metadata_conv;
A
Aurelien Jacobs 已提交
323

324 325 326
    /* private fields */
    struct AVOutputFormat *next;
} AVOutputFormat;
F
Fabrice Bellard 已提交
327

328
typedef struct AVInputFormat {
329 330
    /**
     * A comma separated list of short names for the format. New names
331 332
     * may be appended with a minor bump.
     */
333
    const char *name;
334

335 336
    /**
     * Descriptive name for the format, meant to be more human-readable
337
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
338 339
     * to define it.
     */
340
    const char *long_name;
341 342 343 344

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

347
    /**
348
     * Tell if a given file has a chance of being parsed as this format.
D
Diego Biurrun 已提交
349 350
     * 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.
351
     */
352
    int (*read_probe)(AVProbeData *);
353 354 355 356 357 358 359

    /**
     * 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 已提交
360 361
    int (*read_header)(struct AVFormatContext *,
                       AVFormatParameters *ap);
362 363 364 365 366 367 368 369 370

    /**
     * Read one packet and put it in 'pkt'. pts and flags are also
     * set. 'av_new_stream' can be called only if the flag
     * AVFMTCTX_NOHEADER is used.
     * @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 已提交
371
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
372 373 374 375 376

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

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

    /**
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
     */
F
Fabrice Bellard 已提交
401
    int flags;
402 403 404 405 406 407

    /**
     * If extensions are defined, then no probe is done. You should
     * usually not use extension format guessing because it is not
     * reliable enough
     */
408
    const char *extensions;
409 410 411 412

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

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

421 422 423 424
    /**
     * Pause playing - only meaningful if using a network-based format
     * (RTSP).
     */
425 426
    int (*read_pause)(struct AVFormatContext *);

427
    const struct AVCodecTag * const *codec_tag;
428

M
Michael Niedermayer 已提交
429
    /**
430
     * Seek to timestamp ts.
M
Michael Niedermayer 已提交
431 432 433 434
     * 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 已提交
435
    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 已提交
436

437
    const AVMetadataConv *metadata_conv;
A
Aurelien Jacobs 已提交
438

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

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

451 452 453 454
typedef struct AVIndexEntry {
    int64_t pos;
    int64_t timestamp;
#define AVINDEX_KEYFRAME 0x0001
M
Michael Niedermayer 已提交
455
    int flags:2;
D
Diego Biurrun 已提交
456 457
    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. */
458 459
} AVIndexEntry;

460 461 462 463 464 465
#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
466 467 468 469 470 471

/**
 * 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.
 */
472
#define AV_DISPOSITION_FORCED    0x0040
473

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

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

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

    /**
D
Diego Biurrun 已提交
505 506
     * This is the fundamental unit of time (in seconds) in terms
     * of which frame timestamps are represented. For fixed-fps content,
507
     * time base should be 1/framerate and timestamp increments should be 1.
508
     */
509
    AVRational time_base;
510
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
F
Fabrice Bellard 已提交
511
    /* ffmpeg.c private use */
D
Diego Biurrun 已提交
512 513
    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.
514

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

522
    /**
D
Diego Biurrun 已提交
523 524 525
     * 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.
526
     * This may be undefined (AV_NOPTS_VALUE).
D
Diego Biurrun 已提交
527 528
     * @note The ASF header does NOT contain a correct start_time the ASF
     * demuxer must NOT set this.
529
     */
530
    int64_t start_time;
531

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

539
#if FF_API_OLD_METADATA
540
    char language[4]; /**< ISO 639-2/B 3-letter language code (empty string if undefined) */
A
Aurelien Jacobs 已提交
541
#endif
542

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

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

556
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
557

558 559
#if LIBAVFORMAT_VERSION_INT < (53<<16)
    int64_t unused[4+1];
560
#endif
561

562
#if FF_API_OLD_METADATA
563
    char *filename; /**< source filename of the stream */
A
Aurelien Jacobs 已提交
564
#endif
565

D
Diego Biurrun 已提交
566
    int disposition; /**< AV_DISPOSITION_* bit field */
567 568

    AVProbeData probe_data;
569 570
#define MAX_REORDER_DELAY 16
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
571 572 573 574 575 576 577

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

A
Aurelien Jacobs 已提交
579
    AVMetadata *metadata;
580

581 582
    /* Intended mostly for av_read_frame() support. Not supposed to be used by */
    /* external applications; try to use something else if at all possible.    */
583 584 585
    const uint8_t *cur_ptr;
    int cur_len;
    AVPacket cur_pkt;
586 587 588 589 590 591 592 593 594 595

    // 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;
596 597 598 599 600

    /**
     * Number of packets to buffer for codec probing
     * NOT PART OF PUBLIC API
     */
601
#define MAX_PROBE_PACKETS 2500
602
    int probe_packets;
603 604

    /**
605
     * last packet in packet_buffer for this stream when muxing.
606 607
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
     */
608
    struct AVPacketList *last_in_packet_buffer;
M
Michael Niedermayer 已提交
609 610 611 612 613

    /**
     * Average framerate
     */
    AVRational avg_frame_rate;
614 615 616 617 618

    /**
     * Number of frames that have been demuxed during av_find_stream_info()
     */
    int codec_info_nb_frames;
F
Fabrice Bellard 已提交
619 620
} AVStream;

621 622
#define AV_PROGRAM_RUNNING 1

623 624
/**
 * New fields can be added to the end with minor version bumps.
D
Diego Biurrun 已提交
625
 * Removal, reordering and changes to existing fields require a major
626
 * version bump.
D
Diego Biurrun 已提交
627
 * sizeof(AVProgram) must not be used outside libav*.
628
 */
629 630
typedef struct AVProgram {
    int            id;
631
#if FF_API_OLD_METADATA
D
Diego Biurrun 已提交
632 633
    char           *provider_name; ///< network name for DVB streams
    char           *name;          ///< service name for DVB streams
A
Aurelien Jacobs 已提交
634
#endif
635 636
    int            flags;
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
637 638
    unsigned int   *stream_index;
    unsigned int   nb_stream_indexes;
A
Aurelien Jacobs 已提交
639
    AVMetadata *metadata;
640 641
} AVProgram;

642
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
643 644
                                         (streams are added dynamically) */

645
typedef struct AVChapter {
D
Diego Biurrun 已提交
646 647
    int id;                 ///< unique ID to identify the chapter
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
M
Michael Niedermayer 已提交
648
    int64_t start, end;     ///< chapter start/end time in time_base units
649
#if FF_API_OLD_METADATA
M
Michael Niedermayer 已提交
650
    char *title;            ///< chapter title
A
Aurelien Jacobs 已提交
651
#endif
A
Aurelien Jacobs 已提交
652
    AVMetadata *metadata;
653 654
} AVChapter;

655
#if FF_API_MAX_STREAMS
F
Fabrice Bellard 已提交
656
#define MAX_STREAMS 20
657
#endif
F
Fabrice Bellard 已提交
658

659
/**
D
Diego Biurrun 已提交
660
 * Format I/O context.
661
 * New fields can be added to the end with minor version bumps.
D
Diego Biurrun 已提交
662
 * Removal, reordering and changes to existing fields require a major
663
 * version bump.
D
Diego Biurrun 已提交
664
 * sizeof(AVFormatContext) must not be used outside libav*.
665
 */
F
Fabrice Bellard 已提交
666
typedef struct AVFormatContext {
667
    const AVClass *av_class; /**< Set by avformat_alloc_context. */
D
Diego Biurrun 已提交
668
    /* Can only be iformat or oformat, not both at the same time. */
669 670
    struct AVInputFormat *iformat;
    struct AVOutputFormat *oformat;
F
Fabrice Bellard 已提交
671
    void *priv_data;
672
    ByteIOContext *pb;
673
    unsigned int nb_streams;
F
Fabrice Bellard 已提交
674
    AVStream *streams[MAX_STREAMS];
675
    char filename[1024]; /**< input or output filename */
F
Fabrice Bellard 已提交
676
    /* stream info */
677
    int64_t timestamp;
678
#if FF_API_OLD_METADATA
F
Fabrice Bellard 已提交
679 680 681 682
    char title[512];
    char author[512];
    char copyright[512];
    char comment[512];
683
    char album[512];
684 685 686
    int year;  /**< ID3 year, 0 if none */
    int track; /**< track number, 0 if none */
    char genre[32]; /**< ID3 genre */
A
Aurelien Jacobs 已提交
687
#endif
688

D
Diego Biurrun 已提交
689 690
    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
    /* private data for pts handling (do not modify directly). */
691 692 693 694 695
    /**
     * This buffer is only needed when packets were already buffered but
     * not decoded, for example to get the codec parameters in MPEG
     * streams.
     */
696 697
    struct AVPacketList *packet_buffer;

698 699 700 701 702
    /**
     * 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.
     */
703
    int64_t start_time;
704 705 706 707 708 709 710

    /**
     * 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.
     */
711
    int64_t duration;
712 713 714 715

    /**
     * decoding: total file size, 0 if unknown
     */
716
    int64_t file_size;
717 718 719 720 721 722

    /**
     * Decoding: total stream bitrate in bit/s, 0 if not
     * available. Never set it directly if the file_size and the
     * duration are known as FFmpeg can compute it automatically.
     */
723
    int bit_rate;
724 725 726

    /* av_read_frame() support */
    AVStream *cur_st;
727 728 729 730 731
#if LIBAVFORMAT_VERSION_INT < (53<<16)
    const uint8_t *cur_ptr_deprecated;
    int cur_len_deprecated;
    AVPacket cur_pkt_deprecated;
#endif
732 733

    /* av_seek_frame() support */
734
    int64_t data_offset; /**< offset of the first packet */
735
    int index_built;
736

737
    int mux_rate;
738
    unsigned int packet_size;
739 740
    int preload;
    int max_delay;
741

742 743
#define AVFMT_NOOUTPUTLOOP -1
#define AVFMT_INFINITEOUTPUTLOOP 0
744 745 746
    /**
     * number of times to loop output in formats that support it
     */
747
    int loop_output;
748

749
    int flags;
750
#define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
D
Diego Biurrun 已提交
751 752
#define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
753
#define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
754 755
#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
756
#define AVFMT_FLAG_RTP_HINT     0x0040 ///< Add RTP hinting to the output file
757 758

    int loop_input;
759 760 761 762

    /**
     * decoding: size of data to probe; encoding: unused.
     */
763
    unsigned int probesize;
764 765

    /**
D
Diego Biurrun 已提交
766 767
     * Maximum time (in AV_TIME_BASE units) during which the input should
     * be analyzed in av_find_stream_info().
768 769
     */
    int max_analyze_duration;
770 771 772

    const uint8_t *key;
    int keylen;
773 774 775

    unsigned int nb_programs;
    AVProgram **programs;
M
Michael Niedermayer 已提交
776 777 778

    /**
     * Forced video codec_id.
D
Diego Biurrun 已提交
779
     * Demuxing: Set by user.
M
Michael Niedermayer 已提交
780 781
     */
    enum CodecID video_codec_id;
782

M
Michael Niedermayer 已提交
783 784
    /**
     * Forced audio codec_id.
D
Diego Biurrun 已提交
785
     * Demuxing: Set by user.
M
Michael Niedermayer 已提交
786 787
     */
    enum CodecID audio_codec_id;
788

M
Michael Niedermayer 已提交
789 790
    /**
     * Forced subtitle codec_id.
D
Diego Biurrun 已提交
791
     * Demuxing: Set by user.
M
Michael Niedermayer 已提交
792 793
     */
    enum CodecID subtitle_codec_id;
794 795

    /**
796 797
     * 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
798 799
     * needed to maintain a smaller size. This can lead to slower or less
     * accurate seeking (depends on demuxer).
D
Diego Biurrun 已提交
800
     * Demuxers for which a full in-memory index is mandatory will ignore
801 802 803 804 805
     * this.
     * muxing  : unused
     * demuxing: set by user
     */
    unsigned int max_index_size;
806 807

    /**
R
Ramiro Polla 已提交
808
     * Maximum amount of memory in bytes to use for buffering frames
D
Diego Biurrun 已提交
809
     * obtained from realtime capture devices.
810 811
     */
    unsigned int max_picture_buffer;
812

813
    unsigned int nb_chapters;
814
    AVChapter **chapters;
815 816

    /**
D
Diego Biurrun 已提交
817
     * Flags to enable debugging.
818 819 820
     */
    int debug;
#define FF_FDEBUG_TS        0x0001
821 822

    /**
D
Diego Biurrun 已提交
823
     * Raw packets from the demuxer, prior to parsing and decoding.
824 825 826 827 828
     * 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;
829 830 831
    struct AVPacketList *raw_packet_buffer_end;

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

A
Aurelien Jacobs 已提交
833
    AVMetadata *metadata;
834 835 836 837 838

    /**
     * Remaining size available for raw_packet_buffer, in bytes.
     * NOT PART OF PUBLIC API
     */
839
#define RAW_PACKET_BUFFER_SIZE 2500000
840
    int raw_packet_buffer_remaining_size;
841 842 843 844 845 846 847 848 849

    /**
     * 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;
F
Fabrice Bellard 已提交
850 851 852 853 854 855 856
} AVFormatContext;

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

857
#if LIBAVFORMAT_VERSION_INT < (53<<16)
858 859
extern AVInputFormat *first_iformat;
extern AVOutputFormat *first_oformat;
860 861
#endif

862 863
/**
 * If f is NULL, returns the first registered input format,
864
 * if f is non-NULL, returns the next registered input format after f
865 866
 * or NULL if f is the last one.
 */
867
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
868 869 870

/**
 * If f is NULL, returns the first registered output format,
871
 * if f is non-NULL, returns the next registered output format after f
872 873
 * or NULL if f is the last one.
 */
874
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
F
Fabrice Bellard 已提交
875

876
enum CodecID av_guess_image2_codec(const char *filename);
877

878 879
/* XXX: Use automatic init with either ELF sections or C file parser */
/* modules. */
F
Fabrice Bellard 已提交
880

881 882 883
/* utils.c */
void av_register_input_format(AVInputFormat *format);
void av_register_output_format(AVOutputFormat *format);
884 885
#if LIBAVFORMAT_VERSION_MAJOR < 53
attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
886 887
                                    const char *filename,
                                    const char *mime_type);
888 889 890 891 892 893 894

/**
 * @deprecated Use av_guess_format() instead.
 */
attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
                                                  const char *filename,
                                                  const char *mime_type);
895
#endif
S
Stefano Sabatini 已提交
896 897

/**
898 899
 * Return the output format in the list of registered output formats
 * which best matches the provided parameters, or return NULL if
S
Stefano Sabatini 已提交
900 901 902 903 904 905 906 907 908
 * 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
 */
909
AVOutputFormat *av_guess_format(const char *short_name,
S
Stefano Sabatini 已提交
910 911
                                const char *filename,
                                const char *mime_type);
912 913

/**
914
 * Guess the codec ID based upon muxer and filename.
915
 */
916
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
917
                            const char *filename, const char *mime_type,
918
                            enum AVMediaType type);
F
Fabrice Bellard 已提交
919

920
/**
921
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
922 923
 *
 * @param f The file stream pointer where the dump should be sent to.
924 925
 * @param buf buffer
 * @param size buffer size
926 927
 *
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
928
 */
929
void av_hex_dump(FILE *f, uint8_t *buf, int size);
930 931

/**
932
 * Send a nice hexadecimal dump of a buffer to the log.
933 934 935 936 937 938 939 940 941 942 943 944 945
 *
 * @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
 *
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
 */
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);

/**
946
 * Send a nice dump of a packet to the specified file stream.
947 948
 *
 * @param f The file stream pointer where the dump should be sent to.
949
 * @param pkt packet to dump
D
Diego Biurrun 已提交
950
 * @param dump_payload True if the payload must be displayed, too.
951
 */
952
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
F
Fabrice Bellard 已提交
953

954
/**
955
 * Send a nice dump of a packet to the log.
956 957 958 959 960 961
 *
 * @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 已提交
962
 * @param dump_payload True if the payload must be displayed, too.
963 964 965
 */
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);

966
/**
967
 * Initialize libavformat and register all the muxers, demuxers and
968 969 970 971 972
 * 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()
973
 * @see av_register_protocol()
974
 */
F
Fabrice Bellard 已提交
975
void av_register_all(void);
F
Fabrice Bellard 已提交
976

977
/**
978
 * Get the CodecID for the given codec tag tag.
979 980 981 982 983
 * 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
 */
984
enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
985 986

/**
987
 * Get the codec tag for the given codec id id.
988 989 990 991 992
 * 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
 */
993
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
994

995
/* media file input */
996 997

/**
998
 * Find AVInputFormat based on the short name of the input format.
999
 */
1000
AVInputFormat *av_find_input_format(const char *short_name);
1001 1002

/**
1003
 * Guess the file format.
1004
 *
D
Diego Biurrun 已提交
1005 1006
 * @param is_opened Whether the file is already opened; determines whether
 *                  demuxers with or without AVFMT_NOFILE are probed.
1007
 */
F
Fabrice Bellard 已提交
1008
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1009

1010
/**
1011
 * Guess the file format.
1012 1013 1014
 *
 * @param is_opened Whether the file is already opened; determines whether
 *                  demuxers with or without AVFMT_NOFILE are probed.
1015 1016 1017 1018
 * @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
1019 1020 1021 1022
 *                  to retry with a larger probe buffer.
 */
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);

1023
/**
1024
 * Allocate all the structures needed to read an input stream.
1025 1026
 *        This does not open the needed codecs for decoding the stream[s].
 */
1027 1028
int av_open_input_stream(AVFormatContext **ic_ptr,
                         ByteIOContext *pb, const char *filename,
1029
                         AVInputFormat *fmt, AVFormatParameters *ap);
1030 1031

/**
1032
 * Open a media file as input. The codecs are not opened. Only the file
1033 1034
 * header (if present) is read.
 *
D
Diego Biurrun 已提交
1035 1036 1037
 * @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.
1038
 * @param buf_size optional buffer size (zero if default is OK)
1039 1040
 * @param ap Additional parameters needed when opening the file
 *           (NULL if default).
D
Diego Biurrun 已提交
1041
 * @return 0 if OK, AVERROR_xxx otherwise
1042
 */
1043
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1044 1045 1046
                       AVInputFormat *fmt,
                       int buf_size,
                       AVFormatParameters *ap);
1047 1048 1049 1050 1051 1052 1053 1054

#if LIBAVFORMAT_VERSION_MAJOR < 53
/**
 * @deprecated Use avformat_alloc_context() instead.
 */
attribute_deprecated AVFormatContext *av_alloc_format_context(void);
#endif

1055
/**
1056
 * Allocate an AVFormatContext.
D
Diego Biurrun 已提交
1057
 * Can be freed with av_free() but do not forget to free everything you
1058 1059
 * explicitly allocated as well!
 */
1060
AVFormatContext *avformat_alloc_context(void);
1061

1062
/**
1063
 * Read packets of a media file to get stream information. This
1064
 * is useful for file formats with no headers such as MPEG. This
1065
 * function also computes the real framerate in case of MPEG-2 repeat
1066 1067 1068 1069 1070
 * 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 已提交
1071 1072 1073
 * @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.
1074
 */
1075
int av_find_stream_info(AVFormatContext *ic);
1076 1077

/**
1078
 * Read a transport packet from a media file.
1079
 *
R
Typos  
Ramiro Polla 已提交
1080
 * This function is obsolete and should never be used.
1081 1082 1083 1084
 * Use av_read_frame() instead.
 *
 * @param s media file handle
 * @param pkt is filled
D
Diego Biurrun 已提交
1085
 * @return 0 if OK, AVERROR_xxx on error
1086
 */
F
Fabrice Bellard 已提交
1087
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1088 1089

/**
1090
 * Return the next frame of a stream.
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
 *
 * 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
1101
 * values in AVStream.time_base units (and guessed if the format cannot
D
Diego Biurrun 已提交
1102 1103
 * 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
1104 1105
 * decompress the payload.
 *
D
Diego Biurrun 已提交
1106
 * @return 0 if OK, < 0 on error or end of file
1107
 */
1108
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1109 1110

/**
1111
 * Seek to the keyframe at timestamp.
1112 1113 1114 1115
 * '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 已提交
1116 1117
 * @param timestamp Timestamp in AVStream.time_base units
 *        or, if no stream is specified, in AV_TIME_BASE units.
1118 1119 1120
 * @param flags flags which select direction and seeking mode
 * @return >= 0 on success
 */
1121 1122
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
                  int flags);
1123

1124
/**
1125
 * Seek to timestamp ts.
1126 1127 1128 1129
 * 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.
 *
1130
 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1131
 * are the file position (this may not be supported by all demuxers).
1132
 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1133
 * in the stream with stream_index (this may not be supported by all demuxers).
1134 1135 1136
 * 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
1137 1138
 * keyframes (this may not be supported by all demuxers).
 *
1139
 * @param stream_index index of the stream which is used as time base reference
1140 1141 1142 1143
 * @param min_ts smallest acceptable timestamp
 * @param ts target timestamp
 * @param max_ts largest acceptable timestamp
 * @param flags flags
B
Benoit Fouet 已提交
1144
 * @return >=0 on success, error code otherwise
1145
 *
1146
 * @note This is part of the new seek API which is still under construction.
1147 1148
 *       Thus do not use this yet. It may change at any time, do not expect
 *       ABI compatibility yet!
1149 1150 1151
 */
int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);

1152
/**
1153
 * Start playing a network-based stream (e.g. RTSP stream) at the
D
Diego Biurrun 已提交
1154
 * current position.
1155
 */
1156
int av_read_play(AVFormatContext *s);
1157 1158

/**
1159
 * Pause a network-based stream (e.g. RTSP stream).
1160 1161 1162
 *
 * Use av_read_play() to resume it.
 */
1163
int av_read_pause(AVFormatContext *s);
1164

1165
/**
1166
 * Free a AVFormatContext allocated by av_open_input_stream.
1167 1168 1169 1170
 * @param s context to free
 */
void av_close_input_stream(AVFormatContext *s);

1171
/**
1172
 * Close a media file (but not its codecs).
1173 1174 1175
 *
 * @param s media file handle
 */
F
Fabrice Bellard 已提交
1176
void av_close_input_file(AVFormatContext *s);
1177 1178

/**
1179
 * Add a new stream to a media file.
1180 1181 1182 1183 1184 1185
 *
 * 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 已提交
1186
 * @param id file-format-dependent stream ID
1187
 */
1188
AVStream *av_new_stream(AVFormatContext *s, int id);
1189
AVProgram *av_new_program(AVFormatContext *s, int id);
1190

1191
/**
1192
 * Add a new chapter.
1193
 * This function is NOT part of the public API
D
Diego Biurrun 已提交
1194
 * and should ONLY be used by demuxers.
1195 1196
 *
 * @param s media file handle
D
Diego Biurrun 已提交
1197
 * @param id unique ID for this chapter
1198 1199
 * @param start chapter start time in time_base units
 * @param end chapter end time in time_base units
1200
 * @param title chapter title
1201
 *
D
Diego Biurrun 已提交
1202
 * @return AVChapter or NULL on error
1203
 */
1204 1205
AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
                          int64_t start, int64_t end, const char *title);
1206

1207
/**
1208
 * Set the pts for a given stream.
1209 1210 1211 1212 1213 1214 1215
 *
 * @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)
 */
1216
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1217
                     unsigned int pts_num, unsigned int pts_den);
F
Fabrice Bellard 已提交
1218

1219 1220
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
D
Diego Biurrun 已提交
1221
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1222
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1223

1224
int av_find_default_stream_index(AVFormatContext *s);
1225 1226

/**
1227
 * Get the index for a specific timestamp.
D
Diego Biurrun 已提交
1228 1229 1230
 * @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 >=
1231 1232 1233
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
 * @return < 0 if no such timestamp could be found
 */
1234
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1235

1236
/**
1237
 * Ensure the index uses less memory than the maximum specified in
1238
 * AVFormatContext.max_index_size by discarding entries if it grows
1239 1240 1241 1242 1243 1244
 * too large.
 * This function is not part of the public API and should only be called
 * by demuxers.
 */
void ff_reduce_index(AVFormatContext *s, int stream_index);

1245
/**
1246
 * Add an index entry into a sorted list. Update the entry if the list
D
Diego Biurrun 已提交
1247
 * already contains it.
1248
 *
D
Diego Biurrun 已提交
1249
 * @param timestamp timestamp in the time base of the given stream
1250
 */
1251 1252
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
                       int size, int distance, int flags);
1253 1254

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

/**
1266
 * Update cur_dts of all streams based on the given timestamp and AVStream.
1267
 *
D
Diego Biurrun 已提交
1268 1269
 * 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).
1270 1271 1272
 * @param timestamp new dts expressed in time_base of param ref_st
 * @param ref_st reference stream giving time_base of param timestamp
 */
1273
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1274 1275

/**
1276
 * Perform a binary search using read_timestamp().
1277 1278
 * This is not supposed to be called directly by a user application,
 * but by demuxers.
1279 1280 1281
 * @param target_ts target timestamp in the time base of the given stream
 * @param stream_index stream number
 */
1282 1283 1284 1285 1286 1287
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 ));
1288

1289 1290 1291
/**
 * media file output
 */
1292
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1293

M
Måns Rullgård 已提交
1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319
/**
 * 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);

1320
/**
1321
 * Allocate the stream private data and write the stream header to an
D
Diego Biurrun 已提交
1322
 * output media file.
1323 1324
 *
 * @param s media file handle
D
Diego Biurrun 已提交
1325
 * @return 0 if OK, AVERROR_xxx on error
1326
 */
1327
int av_write_header(AVFormatContext *s);
1328 1329

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

/**
1344
 * Write a packet to an output media file ensuring correct interleaving.
1345 1346
 *
 * The packet must contain one audio or video frame.
1347
 * If the packets are already correctly interleaved, the application should
D
Diego Biurrun 已提交
1348 1349 1350 1351
 * 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.
1352 1353
 *
 * @param s media file handle
1354 1355
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
              dts/pts, ...
D
Diego Biurrun 已提交
1356
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1357
 */
1358
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1359 1360

/**
1361
 * Interleave a packet per dts in an output media file.
1362
 *
1363
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1364
 * function, so they cannot be used after it. Note that calling av_free_packet()
1365
 * on them is still safe.
1366 1367 1368
 *
 * @param s media file handle
 * @param out the interleaved packet will be output here
1369
 * @param pkt the input packet
1370 1371 1372
 * @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 已提交
1373
 *         < 0 if an error occurred
1374
 */
1375 1376
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
                                 AVPacket *pkt, int flush);
1377

1378
/**
1379
 * Write the stream trailer to an output media file and free the
1380
 * file private data.
1381
 *
1382 1383
 * May only be called after a successful call to av_write_header.
 *
1384
 * @param s media file handle
D
Diego Biurrun 已提交
1385
 * @return 0 if OK, AVERROR_xxx on error
1386
 */
1387
int av_write_trailer(AVFormatContext *s);
F
Fabrice Bellard 已提交
1388 1389

void dump_format(AVFormatContext *ic,
1390
                 int index,
F
Fabrice Bellard 已提交
1391 1392
                 const char *url,
                 int is_output);
1393

1394
#if LIBAVFORMAT_VERSION_MAJOR < 53
1395
/**
1396
 * Parse width and height out of string str.
1397
 * @deprecated Use av_parse_video_frame_size instead.
1398
 */
1399 1400
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
                                          const char *str);
1401 1402

/**
1403
 * Convert framerate from a string to a fraction.
1404
 * @deprecated Use av_parse_video_frame_rate instead.
1405
 */
1406 1407
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
                                          const char *arg);
1408
#endif
1409 1410

/**
1411
 * Parse datestr and return a corresponding number of microseconds.
1412 1413
 * @param datestr String representing a date or a duration.
 * - If a date the syntax is:
1414
 * @code
1415
 *  now|{[{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH[:MM[:SS[.m...]]]}|{HH[MM[SS[.m...]]]}}[Z|z]}
1416
 * @endcode
1417
 * If the value is "now" it takes the current time.
D
Diego Biurrun 已提交
1418
 * Time is local time unless Z is appended, in which case it is
1419
 * interpreted as UTC.
D
Diego Biurrun 已提交
1420
 * If the year-month-day part is not specified it takes the current
1421
 * year-month-day.
1422
 * @return the number of microseconds since 1st of January, 1970 up to
1423
 * the time of the parsed date or INT64_MIN if datestr cannot be
1424 1425 1426 1427 1428 1429
 * successfully parsed.
 * - If a duration the syntax is:
 * @code
 *  [-]HH[:MM[:SS[.m...]]]
 *  [-]S+[.m...]
 * @endcode
1430
 * @return the number of microseconds contained in a time interval
1431
 * with the specified duration or INT64_MIN if datestr cannot be
D
Diego Biurrun 已提交
1432
 * successfully parsed.
1433 1434
 * @param duration Flag which tells how to interpret datestr, if
 * not zero datestr is interpreted as a duration, otherwise as a
1435
 * date.
1436
 */
1437
int64_t parse_date(const char *datestr, int duration);
F
Fabrice Bellard 已提交
1438

1439 1440 1441
/**
 * Get the current time in microseconds.
 */
1442
int64_t av_gettime(void);
F
Fabrice Bellard 已提交
1443

D
Diego Biurrun 已提交
1444
/* ffm-specific for ffserver */
F
Fabrice Bellard 已提交
1445
#define FFM_PACKET_SIZE 4096
1446
int64_t ffm_read_write_index(int fd);
1447
int ffm_write_write_index(int fd, int64_t pos);
1448
void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
F
Fabrice Bellard 已提交
1449

1450
/**
1451
 * Attempt to find a specific tag in a URL.
1452 1453 1454 1455
 *
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
 * Return 1 if found.
 */
F
Fabrice Bellard 已提交
1456 1457
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);

1458
/**
1459
 * Return in 'buf' the path with '%d' replaced by a number.
D
Diego Biurrun 已提交
1460
 *
1461 1462 1463 1464 1465 1466
 * 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 已提交
1467
 * @param number frame number
D
Diego Biurrun 已提交
1468
 * @return 0 if OK, -1 on format error
1469
 */
1470 1471
int av_get_frame_filename(char *buf, int buf_size,
                          const char *path, int number);
1472 1473

/**
1474
 * Check whether filename actually is a numbered sequence generator.
1475 1476
 *
 * @param filename possible numbered sequence string
D
Diego Biurrun 已提交
1477
 * @return 1 if a valid numbered sequence string, 0 otherwise
1478
 */
1479
int av_filename_number_test(const char *filename);
1480

L
Luca Abeni 已提交
1481
/**
1482
 * Generate an SDP for an RTP session.
L
Luca Abeni 已提交
1483 1484 1485 1486 1487
 *
 * @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 已提交
1488
 *           must contain only one AVStream.
1489 1490
 * @param n_files number of AVCodecContexts contained in ac
 * @param buff buffer where the SDP will be stored (must be allocated by
D
Diego Biurrun 已提交
1491
 *             the caller)
1492
 * @param size the size of the buffer
D
Diego Biurrun 已提交
1493
 * @return 0 if OK, AVERROR_xxx on error
L
Luca Abeni 已提交
1494
 */
1495
int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
L
Luca Abeni 已提交
1496

1497
/**
1498
 * Return a positive value if the given filename has one of the given
1499 1500 1501 1502 1503 1504
 * extensions, 0 otherwise.
 *
 * @param extensions a comma-separated list of filename extensions
 */
int av_match_ext(const char *filename, const char *extensions);

1505
#endif /* AVFORMAT_AVFORMAT_H */