avformat.h 52.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
/**
A
Art Clarke 已提交
26 27
 * I return the LIBAVFORMAT_VERSION_INT constant.  You got
 * a fucking problem with that, douchebag?
S
Stefano Sabatini 已提交
28 29 30
 */
unsigned avformat_version(void);

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

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

41
#include <time.h>
Z
Zdenek Kabelac 已提交
42
#include <stdio.h>  /* FILE */
43
#include "libavcodec/avcodec.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 108
 */

109
#define AV_METADATA_MATCH_CASE      1
110
#define AV_METADATA_IGNORE_SUFFIX   2
111 112
#define AV_METADATA_DONT_STRDUP_KEY 4
#define AV_METADATA_DONT_STRDUP_VAL 8
113
#define AV_METADATA_DONT_OVERWRITE 16   ///< Don't overwrite existing tags.
114 115 116 117

typedef struct {
    char *key;
    char *value;
118
}AVMetadataTag;
119

A
Aurelien Jacobs 已提交
120
typedef struct AVMetadata AVMetadata;
121
#if FF_API_OLD_METADATA2
A
Aurelien Jacobs 已提交
122
typedef struct AVMetadataConv AVMetadataConv;
123
#endif
124 125

/**
126
 * Get a metadata element with matching key.
127
 *
128
 * @param prev Set to the previous matching element to find the next.
129
 *             If set to NULL the first matching element is returned.
130 131
 * @param flags Allows case as well as suffix-insensitive comparisons.
 * @return Found tag or NULL, changing key or value leads to undefined behavior.
132
 */
133
AVMetadataTag *
A
Aurelien Jacobs 已提交
134
av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
135

136
/**
137
 * Set the given tag in *pm, overwriting an existing tag.
138
 *
139 140
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
 * a metadata struct is allocated and put in *pm.
141 142
 * @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).
143
 *        Passing a NULL value will cause an existing tag to be deleted.
144 145 146
 * @return >= 0 on success otherwise an error code <0
 */
int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
147

148
#if FF_API_OLD_METADATA2
A
Aurelien Jacobs 已提交
149
/**
150
 * This function is provided for compatibility reason and currently does nothing.
A
Aurelien Jacobs 已提交
151
 */
152 153 154
attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
                                                                        const AVMetadataConv *s_conv);
#endif
A
Aurelien Jacobs 已提交
155

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

166
/**
167
 * Free all the memory allocated for an AVMetadata struct.
168 169 170
 */
void av_metadata_free(AVMetadata **m);

171

F
Fabrice Bellard 已提交
172 173
/* packet functions */

174 175

/**
176
 * Allocate and read the payload of a packet and initialize its
177
 * fields with default values.
178 179
 *
 * @param pkt packet
D
Diego Biurrun 已提交
180 181
 * @param size desired payload size
 * @return >0 (read size) if OK, AVERROR_xxx otherwise
182
 */
183
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
184

F
Fabrice Bellard 已提交
185

186
/**
R
Reimar Döffinger 已提交
187 188
 * Read data and append it to the current content of the AVPacket.
 * If pkt->size is 0 this is identical to av_get_packet.
189 190 191 192 193 194 195 196 197 198
 * 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.
 */
199
int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
200

F
Fabrice Bellard 已提交
201 202 203
/*************************************************/
/* fractional numbers for exact pts handling */

204
/**
D
Diego Biurrun 已提交
205 206
 * The exact value of the fractional number is: 'val + num / den'.
 * num is assumed to be 0 <= num < den.
207
 */
F
Fabrice Bellard 已提交
208
typedef struct AVFrac {
209
    int64_t val, num, den;
210
} AVFrac;
F
Fabrice Bellard 已提交
211

F
Fabrice Bellard 已提交
212
/*************************************************/
213
/* input/output formats */
F
Fabrice Bellard 已提交
214

215 216
struct AVCodecTag;

217 218 219
/**
 * This structure contains the data a format has to probe a file.
 */
220
typedef struct AVProbeData {
221
    const char *filename;
222 223
    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 */
224 225
} AVProbeData;

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

typedef struct AVFormatParameters {
230
    AVRational time_base;
F
Fabrice Bellard 已提交
231 232 233 234
    int sample_rate;
    int channels;
    int width;
    int height;
235
    enum PixelFormat pix_fmt;
D
Diego Biurrun 已提交
236 237 238 239
    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
240
                                            stream packet (only meaningful if
D
Diego Biurrun 已提交
241 242 243
                                            mpeg2ts_raw is TRUE). */
    unsigned int initial_pause:1;       /**< Do not begin to play the stream
                                            immediately (RTSP only). */
244
    unsigned int prealloced_context:1;
F
Fabrice Bellard 已提交
245 246
} AVFormatParameters;

247
//! Demuxer will use avio_open, no opened file should be provided by the caller.
248
#define AVFMT_NOFILE        0x0001
D
Diego Biurrun 已提交
249 250 251 252 253 254 255
#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. */
256
#define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
257
#define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
258
#define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
259
#define AVFMT_NOSTREAMS     0x1000 /**< Format does not require any streams */
260 261

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

    /**
295
     * List of supported codec_id-codec_tag pairs, ordered by "better
296
     * choice first". The arrays are all terminated by CODEC_ID_NONE.
297
     */
298
    const struct AVCodecTag * const *codec_tag;
299

300 301
    enum CodecID subtitle_codec; /**< default subtitle codec */

302
#if FF_API_OLD_METADATA2
303
    const AVMetadataConv *metadata_conv;
304
#endif
A
Aurelien Jacobs 已提交
305

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

308 309 310
    /* private fields */
    struct AVOutputFormat *next;
} AVOutputFormat;
F
Fabrice Bellard 已提交
311

312
typedef struct AVInputFormat {
313 314
    /**
     * A comma separated list of short names for the format. New names
315 316
     * may be appended with a minor bump.
     */
317
    const char *name;
318

319 320
    /**
     * Descriptive name for the format, meant to be more human-readable
321
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
322 323
     * to define it.
     */
324
    const char *long_name;
325 326 327 328

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

331
    /**
332
     * Tell if a given file has a chance of being parsed as this format.
D
Diego Biurrun 已提交
333 334
     * 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.
335
     */
336
    int (*read_probe)(AVProbeData *);
337 338 339 340 341 342 343

    /**
     * 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 已提交
344 345
    int (*read_header)(struct AVFormatContext *,
                       AVFormatParameters *ap);
346 347 348 349

    /**
     * Read one packet and put it in 'pkt'. pts and flags are also
     * set. 'av_new_stream' can be called only if the flag
350 351
     * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
     * background thread).
352 353 354 355
     * @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 已提交
356
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
357 358 359 360 361

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

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

    /**
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
     */
F
Fabrice Bellard 已提交
386
    int flags;
387 388 389 390 391 392

    /**
     * If extensions are defined, then no probe is done. You should
     * usually not use extension format guessing because it is not
     * reliable enough
     */
393
    const char *extensions;
394 395 396 397

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

400 401 402 403
    /**
     * Start/resume playing - only meaningful if using a network-based format
     * (RTSP).
     */
404 405
    int (*read_play)(struct AVFormatContext *);

406 407 408 409
    /**
     * Pause playing - only meaningful if using a network-based format
     * (RTSP).
     */
410 411
    int (*read_pause)(struct AVFormatContext *);

412
    const struct AVCodecTag * const *codec_tag;
413

M
Michael Niedermayer 已提交
414
    /**
415
     * Seek to timestamp ts.
M
Michael Niedermayer 已提交
416 417 418 419
     * 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 已提交
420
    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 已提交
421

422
#if FF_API_OLD_METADATA2
423
    const AVMetadataConv *metadata_conv;
424
#endif
A
Aurelien Jacobs 已提交
425

426 427 428
    /* private fields */
    struct AVInputFormat *next;
} AVInputFormat;
F
Fabrice Bellard 已提交
429

A
Aurelien Jacobs 已提交
430 431 432
enum AVStreamParseType {
    AVSTREAM_PARSE_NONE,
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
D
Diego Biurrun 已提交
433
    AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
434
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
435
    AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
A
Aurelien Jacobs 已提交
436 437
};

438 439 440 441
typedef struct AVIndexEntry {
    int64_t pos;
    int64_t timestamp;
#define AVINDEX_KEYFRAME 0x0001
M
Michael Niedermayer 已提交
442
    int flags:2;
D
Diego Biurrun 已提交
443 444
    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. */
445 446
} AVIndexEntry;

447 448 449 450 451 452
#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
453 454 455 456 457 458

/**
 * 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.
 */
459
#define AV_DISPOSITION_FORCED    0x0040
460 461
#define AV_DISPOSITION_HEARING_IMPAIRED  0x0080  /**< stream for hearing impaired audiences */
#define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100  /**< stream for visual impaired audiences */
462
#define AV_DISPOSITION_CLEAN_EFFECTS     0x0200  /**< stream without voice */
463

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

486
    /* internal data used in av_find_stream_info() */
487
    int64_t first_dts;
488 489 490 491

    /**
     * encoding: pts generation when outputting stream
     */
492
    struct AVFrac pts;
493 494

    /**
D
Diego Biurrun 已提交
495 496
     * This is the fundamental unit of time (in seconds) in terms
     * of which frame timestamps are represented. For fixed-fps content,
497
     * time base should be 1/framerate and timestamp increments should be 1.
498 499
     * decoding: set by libavformat
     * encoding: set by libavformat in av_write_header
500
     */
501
    AVRational time_base;
502
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
F
Fabrice Bellard 已提交
503
    /* ffmpeg.c private use */
D
Diego Biurrun 已提交
504 505
    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.
506

507
    //FIXME move stuff to a flags field?
508 509 510 511
    /**
     * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
     * MN: dunno if that is the right place for it
     */
512
    float quality;
513

514
    /**
D
Diego Biurrun 已提交
515 516 517
     * 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.
518
     * This may be undefined (AV_NOPTS_VALUE).
519
     */
520
    int64_t start_time;
521

522
    /**
D
Diego Biurrun 已提交
523
     * Decoding: duration of the stream, in stream time base.
524
     * If a source file does not specify a duration, but does specify
D
Diego Biurrun 已提交
525
     * a bitrate, this value will be estimated from bitrate and file size.
526
     */
527
    int64_t duration;
528 529

    /* av_read_frame() support */
A
Aurelien Jacobs 已提交
530
    enum AVStreamParseType need_parsing;
531
    struct AVCodecParserContext *parser;
532

533
    int64_t cur_dts;
M
Michael Niedermayer 已提交
534 535
    int last_IP_duration;
    int64_t last_IP_pts;
536
    /* av_seek_frame() support */
D
Diego Biurrun 已提交
537 538
    AVIndexEntry *index_entries; /**< Only used if the format does not
                                    support seeking natively. */
539
    int nb_index_entries;
M
Måns Rullgård 已提交
540
    unsigned int index_entries_allocated_size;
541

542
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
543

D
Diego Biurrun 已提交
544
    int disposition; /**< AV_DISPOSITION_* bit field */
545 546

    AVProbeData probe_data;
547 548
#define MAX_REORDER_DELAY 16
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
549 550 551 552 553 554 555

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

A
Aurelien Jacobs 已提交
557
    AVMetadata *metadata;
558

559 560
    /* Intended mostly for av_read_frame() support. Not supposed to be used by */
    /* external applications; try to use something else if at all possible.    */
561 562 563
    const uint8_t *cur_ptr;
    int cur_len;
    AVPacket cur_pkt;
564 565 566 567 568 569 570 571 572 573

    // 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;
574 575 576 577 578

    /**
     * Number of packets to buffer for codec probing
     * NOT PART OF PUBLIC API
     */
579
#define MAX_PROBE_PACKETS 2500
580
    int probe_packets;
581 582

    /**
583
     * last packet in packet_buffer for this stream when muxing.
584 585
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
     */
586
    struct AVPacketList *last_in_packet_buffer;
M
Michael Niedermayer 已提交
587 588 589 590 591

    /**
     * Average framerate
     */
    AVRational avg_frame_rate;
592 593 594 595 596

    /**
     * Number of frames that have been demuxed during av_find_stream_info()
     */
    int codec_info_nb_frames;
597 598 599 600 601 602 603 604 605 606 607 608

    /**
     * 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 已提交
609 610
} AVStream;

611 612
#define AV_PROGRAM_RUNNING 1

613 614
/**
 * New fields can be added to the end with minor version bumps.
D
Diego Biurrun 已提交
615
 * Removal, reordering and changes to existing fields require a major
616
 * version bump.
D
Diego Biurrun 已提交
617
 * sizeof(AVProgram) must not be used outside libav*.
618
 */
619 620 621 622
typedef struct AVProgram {
    int            id;
    int            flags;
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
623 624
    unsigned int   *stream_index;
    unsigned int   nb_stream_indexes;
A
Aurelien Jacobs 已提交
625
    AVMetadata *metadata;
626 627
} AVProgram;

628
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
629 630
                                         (streams are added dynamically) */

631
typedef struct AVChapter {
D
Diego Biurrun 已提交
632 633
    int id;                 ///< unique ID to identify the chapter
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
M
Michael Niedermayer 已提交
634
    int64_t start, end;     ///< chapter start/end time in time_base units
A
Aurelien Jacobs 已提交
635
    AVMetadata *metadata;
636 637
} AVChapter;

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

D
Diego Biurrun 已提交
658 659
    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
    /* private data for pts handling (do not modify directly). */
660 661 662 663 664
    /**
     * This buffer is only needed when packets were already buffered but
     * not decoded, for example to get the codec parameters in MPEG
     * streams.
     */
665 666
    struct AVPacketList *packet_buffer;

667 668 669 670 671
    /**
     * 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.
     */
672
    int64_t start_time;
673 674 675 676 677 678 679

    /**
     * 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.
     */
680
    int64_t duration;
681 682 683 684

    /**
     * decoding: total file size, 0 if unknown
     */
685
    int64_t file_size;
686 687 688 689

    /**
     * Decoding: total stream bitrate in bit/s, 0 if not
     * available. Never set it directly if the file_size and the
690
     * duration are known as Libav can compute it automatically.
691
     */
692
    int bit_rate;
693 694 695 696 697

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

    /* av_seek_frame() support */
698
    int64_t data_offset; /**< offset of the first packet */
699

700
    int mux_rate;
701
    unsigned int packet_size;
702 703
    int preload;
    int max_delay;
704

705 706
#define AVFMT_NOOUTPUTLOOP -1
#define AVFMT_INFINITEOUTPUTLOOP 0
707 708 709
    /**
     * number of times to loop output in formats that support it
     */
710
    int loop_output;
711

712
    int flags;
713
#define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
D
Diego Biurrun 已提交
714 715
#define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
716
#define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
717 718
#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
719
#define AVFMT_FLAG_RTP_HINT     0x0040 ///< Add RTP hinting to the output file
720 721

    int loop_input;
722 723 724 725

    /**
     * decoding: size of data to probe; encoding: unused.
     */
726
    unsigned int probesize;
727 728

    /**
D
Diego Biurrun 已提交
729 730
     * Maximum time (in AV_TIME_BASE units) during which the input should
     * be analyzed in av_find_stream_info().
731 732
     */
    int max_analyze_duration;
733 734 735

    const uint8_t *key;
    int keylen;
736 737 738

    unsigned int nb_programs;
    AVProgram **programs;
M
Michael Niedermayer 已提交
739 740 741

    /**
     * Forced video codec_id.
D
Diego Biurrun 已提交
742
     * Demuxing: Set by user.
M
Michael Niedermayer 已提交
743 744
     */
    enum CodecID video_codec_id;
745

M
Michael Niedermayer 已提交
746 747
    /**
     * Forced audio codec_id.
D
Diego Biurrun 已提交
748
     * Demuxing: Set by user.
M
Michael Niedermayer 已提交
749 750
     */
    enum CodecID audio_codec_id;
751

M
Michael Niedermayer 已提交
752 753
    /**
     * Forced subtitle codec_id.
D
Diego Biurrun 已提交
754
     * Demuxing: Set by user.
M
Michael Niedermayer 已提交
755 756
     */
    enum CodecID subtitle_codec_id;
757 758

    /**
759 760
     * 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
761 762
     * needed to maintain a smaller size. This can lead to slower or less
     * accurate seeking (depends on demuxer).
D
Diego Biurrun 已提交
763
     * Demuxers for which a full in-memory index is mandatory will ignore
764 765 766 767 768
     * this.
     * muxing  : unused
     * demuxing: set by user
     */
    unsigned int max_index_size;
769 770

    /**
R
Ramiro Polla 已提交
771
     * Maximum amount of memory in bytes to use for buffering frames
D
Diego Biurrun 已提交
772
     * obtained from realtime capture devices.
773 774
     */
    unsigned int max_picture_buffer;
775

776
    unsigned int nb_chapters;
777
    AVChapter **chapters;
778 779

    /**
D
Diego Biurrun 已提交
780
     * Flags to enable debugging.
781 782 783
     */
    int debug;
#define FF_FDEBUG_TS        0x0001
784 785

    /**
D
Diego Biurrun 已提交
786
     * Raw packets from the demuxer, prior to parsing and decoding.
787 788 789 790 791
     * 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;
792 793 794
    struct AVPacketList *raw_packet_buffer_end;

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

A
Aurelien Jacobs 已提交
796
    AVMetadata *metadata;
797 798 799 800 801

    /**
     * Remaining size available for raw_packet_buffer, in bytes.
     * NOT PART OF PUBLIC API
     */
802
#define RAW_PACKET_BUFFER_SIZE 2500000
803
    int raw_packet_buffer_remaining_size;
804 805 806 807 808 809 810 811 812

    /**
     * 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 已提交
813 814 815 816 817 818 819
} AVFormatContext;

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

820 821
/**
 * If f is NULL, returns the first registered input format,
822
 * if f is non-NULL, returns the next registered input format after f
823 824
 * or NULL if f is the last one.
 */
825
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
826 827 828

/**
 * If f is NULL, returns the first registered output format,
829
 * if f is non-NULL, returns the next registered output format after f
830 831
 * or NULL if f is the last one.
 */
832
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
F
Fabrice Bellard 已提交
833

834 835 836
#if FF_API_GUESS_IMG2_CODEC
attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
#endif
837

838 839
/* XXX: Use automatic init with either ELF sections or C file parser */
/* modules. */
F
Fabrice Bellard 已提交
840

841 842 843
/* utils.c */
void av_register_input_format(AVInputFormat *format);
void av_register_output_format(AVOutputFormat *format);
S
Stefano Sabatini 已提交
844 845

/**
846 847
 * Return the output format in the list of registered output formats
 * which best matches the provided parameters, or return NULL if
S
Stefano Sabatini 已提交
848 849 850 851 852 853 854 855 856
 * 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
 */
857
AVOutputFormat *av_guess_format(const char *short_name,
S
Stefano Sabatini 已提交
858 859
                                const char *filename,
                                const char *mime_type);
860 861

/**
862
 * Guess the codec ID based upon muxer and filename.
863
 */
864
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
865
                            const char *filename, const char *mime_type,
866
                            enum AVMediaType type);
F
Fabrice Bellard 已提交
867

868
/**
869
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
870 871
 *
 * @param f The file stream pointer where the dump should be sent to.
872 873
 * @param buf buffer
 * @param size buffer size
874
 *
875
 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
876
 */
877
void av_hex_dump(FILE *f, uint8_t *buf, int size);
878 879

/**
880
 * Send a nice hexadecimal dump of a buffer to the log.
881 882 883 884 885 886 887 888
 *
 * @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
 *
889
 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
890 891 892 893
 */
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);

/**
894
 * Send a nice dump of a packet to the specified file stream.
895 896
 *
 * @param f The file stream pointer where the dump should be sent to.
897
 * @param pkt packet to dump
D
Diego Biurrun 已提交
898
 * @param dump_payload True if the payload must be displayed, too.
899
 * @param st AVStream that the packet belongs to
900
 */
901 902
void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);

F
Fabrice Bellard 已提交
903

904
/**
905
 * Send a nice dump of a packet to the log.
906 907 908 909 910 911
 *
 * @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 已提交
912
 * @param dump_payload True if the payload must be displayed, too.
913
 * @param st AVStream that the packet belongs to
914
 */
915 916 917
void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
                      AVStream *st);

918 919
#if FF_API_PKT_DUMP
attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
920 921
attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
                                          int dump_payload);
922
#endif
923

924
/**
925
 * Initialize libavformat and register all the muxers, demuxers and
926 927 928 929 930
 * 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()
931
 * @see av_register_protocol()
932
 */
F
Fabrice Bellard 已提交
933
void av_register_all(void);
F
Fabrice Bellard 已提交
934

935
/**
936
 * Get the CodecID for the given codec tag tag.
937 938 939 940 941
 * 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
 */
942
enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
943 944

/**
945
 * Get the codec tag for the given codec id id.
946 947 948 949 950
 * 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
 */
951
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
952

953
/* media file input */
954 955

/**
956
 * Find AVInputFormat based on the short name of the input format.
957
 */
958
AVInputFormat *av_find_input_format(const char *short_name);
959 960

/**
961
 * Guess the file format.
962
 *
D
Diego Biurrun 已提交
963 964
 * @param is_opened Whether the file is already opened; determines whether
 *                  demuxers with or without AVFMT_NOFILE are probed.
965
 */
F
Fabrice Bellard 已提交
966
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
967

968
/**
969
 * Guess the file format.
970 971 972
 *
 * @param is_opened Whether the file is already opened; determines whether
 *                  demuxers with or without AVFMT_NOFILE are probed.
973 974 975 976
 * @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
977 978 979 980
 *                  to retry with a larger probe buffer.
 */
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);

981 982 983 984 985 986 987 988 989 990 991 992 993 994 995
/**
 * 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
 */
996
int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
997 998 999
                          const char *filename, void *logctx,
                          unsigned int offset, unsigned int max_probe_size);

1000
/**
1001
 * Allocate all the structures needed to read an input stream.
1002 1003
 *        This does not open the needed codecs for decoding the stream[s].
 */
1004
int av_open_input_stream(AVFormatContext **ic_ptr,
1005
                         AVIOContext *pb, const char *filename,
1006
                         AVInputFormat *fmt, AVFormatParameters *ap);
1007 1008

/**
1009
 * Open a media file as input. The codecs are not opened. Only the file
1010 1011
 * header (if present) is read.
 *
D
Diego Biurrun 已提交
1012 1013 1014
 * @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.
1015
 * @param buf_size optional buffer size (zero if default is OK)
1016 1017
 * @param ap Additional parameters needed when opening the file
 *           (NULL if default).
D
Diego Biurrun 已提交
1018
 * @return 0 if OK, AVERROR_xxx otherwise
1019
 */
1020
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1021 1022 1023
                       AVInputFormat *fmt,
                       int buf_size,
                       AVFormatParameters *ap);
1024

1025
/**
1026
 * Allocate an AVFormatContext.
1027 1028
 * avformat_free_context() can be used to free the context and everything
 * allocated by the framework within it.
1029
 */
1030
AVFormatContext *avformat_alloc_context(void);
1031

1032
/**
1033
 * Read packets of a media file to get stream information. This
1034
 * is useful for file formats with no headers such as MPEG. This
1035
 * function also computes the real framerate in case of MPEG-2 repeat
1036 1037 1038 1039 1040
 * 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 已提交
1041 1042 1043
 * @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.
1044
 */
1045
int av_find_stream_info(AVFormatContext *ic);
1046

N
Nicolas George 已提交
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
/**
 * 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);

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

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

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

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

1158
/**
1159
 * Start playing a network-based stream (e.g. RTSP stream) at the
D
Diego Biurrun 已提交
1160
 * current position.
1161
 */
1162
int av_read_play(AVFormatContext *s);
1163 1164

/**
1165
 * Pause a network-based stream (e.g. RTSP stream).
1166 1167 1168
 *
 * Use av_read_play() to resume it.
 */
1169
int av_read_pause(AVFormatContext *s);
1170

1171
/**
1172
 * Free a AVFormatContext allocated by av_open_input_stream.
1173 1174 1175 1176
 * @param s context to free
 */
void av_close_input_stream(AVFormatContext *s);

1177
/**
1178
 * Close a media file (but not its codecs).
1179 1180 1181
 *
 * @param s media file handle
 */
F
Fabrice Bellard 已提交
1182
void av_close_input_file(AVFormatContext *s);
1183

1184 1185 1186 1187 1188 1189
/**
 * Free an AVFormatContext and all its streams.
 * @param s context to free
 */
void avformat_free_context(AVFormatContext *s);

1190
/**
1191
 * Add a new stream to a media file.
1192 1193 1194 1195 1196 1197
 *
 * 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 已提交
1198
 * @param id file-format-dependent stream ID
1199
 */
1200
AVStream *av_new_stream(AVFormatContext *s, int id);
1201
AVProgram *av_new_program(AVFormatContext *s, int id);
1202 1203

/**
1204 1205
 * Set the pts for a given stream. If the new values would be invalid
 * (<= 0), it leaves the AVStream unchanged.
1206 1207 1208 1209 1210 1211 1212
 *
 * @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)
 */
1213
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1214
                     unsigned int pts_num, unsigned int pts_den);
F
Fabrice Bellard 已提交
1215

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

1221
int av_find_default_stream_index(AVFormatContext *s);
1222 1223

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

/**
1234
 * Add an index entry into a sorted list. Update the entry if the list
D
Diego Biurrun 已提交
1235
 * already contains it.
1236
 *
D
Diego Biurrun 已提交
1237
 * @param timestamp timestamp in the time base of the given stream
1238
 */
1239 1240
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
                       int size, int distance, int flags);
1241 1242

/**
1243
 * Perform a binary search using av_index_search_timestamp() and
1244
 * AVInputFormat.read_timestamp().
1245 1246
 * This is not supposed to be called directly by a user application,
 * but by demuxers.
1247 1248 1249
 * @param target_ts target timestamp in the time base of the given stream
 * @param stream_index stream number
 */
1250 1251
int av_seek_frame_binary(AVFormatContext *s, int stream_index,
                         int64_t target_ts, int flags);
1252 1253

/**
1254
 * Update cur_dts of all streams based on the given timestamp and AVStream.
1255
 *
D
Diego Biurrun 已提交
1256 1257
 * 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).
1258 1259 1260
 * @param timestamp new dts expressed in time_base of param ref_st
 * @param ref_st reference stream giving time_base of param timestamp
 */
1261
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1262 1263

/**
1264
 * Perform a binary search using read_timestamp().
1265 1266
 * This is not supposed to be called directly by a user application,
 * but by demuxers.
1267 1268 1269
 * @param target_ts target timestamp in the time base of the given stream
 * @param stream_index stream number
 */
1270 1271 1272 1273 1274 1275
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 ));
1276

1277 1278 1279
/**
 * media file output
 */
1280
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1281

M
Måns Rullgård 已提交
1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307
/**
 * 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);

1308
/**
1309
 * Allocate the stream private data and write the stream header to an
D
Diego Biurrun 已提交
1310
 * output media file.
1311 1312
 * @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
1313 1314
 *
 * @param s media file handle
D
Diego Biurrun 已提交
1315
 * @return 0 if OK, AVERROR_xxx on error
1316
 */
1317
int av_write_header(AVFormatContext *s);
1318 1319

/**
1320
 * Write a packet to an output media file.
1321 1322
 *
 * The packet shall contain one audio or video frame.
1323 1324
 * The packet must be correctly interleaved according to the container
 * specification, if not then av_interleaved_write_frame must be used.
1325 1326
 *
 * @param s media file handle
1327 1328
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
              dts/pts, ...
D
Diego Biurrun 已提交
1329
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1330
 */
1331
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1332 1333

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

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

1368
/**
1369
 * Write the stream trailer to an output media file and free the
1370
 * file private data.
1371
 *
1372 1373
 * May only be called after a successful call to av_write_header.
 *
1374
 * @param s media file handle
D
Diego Biurrun 已提交
1375
 * @return 0 if OK, AVERROR_xxx on error
1376
 */
1377
int av_write_trailer(AVFormatContext *s);
F
Fabrice Bellard 已提交
1378

1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389
#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);
1390

1391
#if FF_API_PARSE_DATE
1392
/**
1393
 * Parse datestr and return a corresponding number of microseconds.
1394
 *
1395
 * @param datestr String representing a date or a duration.
1396 1397
 * See av_parse_time() for the syntax of the provided string.
 * @deprecated in favor of av_parse_time()
1398
 */
1399
attribute_deprecated
1400
int64_t parse_date(const char *datestr, int duration);
1401
#endif
F
Fabrice Bellard 已提交
1402

1403 1404 1405
/**
 * Get the current time in microseconds.
 */
1406
int64_t av_gettime(void);
F
Fabrice Bellard 已提交
1407

1408
#if FF_API_FIND_INFO_TAG
1409
/**
1410
 * @deprecated use av_find_info_tag in libavutil instead.
1411
 */
1412 1413
attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
#endif
F
Fabrice Bellard 已提交
1414

1415
/**
1416
 * Return in 'buf' the path with '%d' replaced by a number.
D
Diego Biurrun 已提交
1417
 *
1418 1419 1420 1421 1422 1423
 * 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 已提交
1424
 * @param number frame number
D
Diego Biurrun 已提交
1425
 * @return 0 if OK, -1 on format error
1426
 */
1427 1428
int av_get_frame_filename(char *buf, int buf_size,
                          const char *path, int number);
1429 1430

/**
1431
 * Check whether filename actually is a numbered sequence generator.
1432 1433
 *
 * @param filename possible numbered sequence string
D
Diego Biurrun 已提交
1434
 * @return 1 if a valid numbered sequence string, 0 otherwise
1435
 */
1436
int av_filename_number_test(const char *filename);
1437

L
Luca Abeni 已提交
1438
/**
1439
 * Generate an SDP for an RTP session.
L
Luca Abeni 已提交
1440 1441 1442 1443 1444
 *
 * @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 已提交
1445
 *           must contain only one AVStream.
1446
 * @param n_files number of AVCodecContexts contained in ac
1447 1448
 * @param buf buffer where the SDP will be stored (must be allocated by
 *            the caller)
1449
 * @param size the size of the buffer
D
Diego Biurrun 已提交
1450
 * @return 0 if OK, AVERROR_xxx on error
L
Luca Abeni 已提交
1451
 */
1452
int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1453 1454 1455 1456

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

1458
/**
1459
 * Return a positive value if the given filename has one of the given
1460 1461 1462 1463 1464 1465
 * extensions, 0 otherwise.
 *
 * @param extensions a comma-separated list of filename extensions
 */
int av_match_ext(const char *filename, const char *extensions);

1466
#endif /* AVFORMAT_AVFORMAT_H */