avformat.h 50.7 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
J
Josh Allmann 已提交
25
#define LIBAVFORMAT_VERSION_MINOR 72
26
#define LIBAVFORMAT_VERSION_MICRO  0
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

S
Stefano Sabatini 已提交
38
/**
A
Art Clarke 已提交
39 40
 * I return the LIBAVFORMAT_VERSION_INT constant.  You got
 * a fucking problem with that, douchebag?
S
Stefano Sabatini 已提交
41 42 43
 */
unsigned avformat_version(void);

44
/**
45
 * Return the libavformat build-time configuration.
46
 */
47
const char *avformat_configuration(void);
48 49

/**
50
 * Return the libavformat license.
51
 */
52
const char *avformat_license(void);
53

54
#include <time.h>
Z
Zdenek Kabelac 已提交
55
#include <stdio.h>  /* FILE */
56
#include "libavcodec/avcodec.h"
F
Fabrice Bellard 已提交
57 58 59

#include "avio.h"

A
Aurelien Jacobs 已提交
60 61
struct AVFormatContext;

62 63

/*
64 65
 * Public Metadata API.
 * The metadata API allows libavformat to export metadata tags to a client
66 67 68
 * 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.
69 70 71 72 73 74 75 76 77
 * 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.
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
 * 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.
116 117
 */

118
#define AV_METADATA_MATCH_CASE      1
119
#define AV_METADATA_IGNORE_SUFFIX   2
120 121
#define AV_METADATA_DONT_STRDUP_KEY 4
#define AV_METADATA_DONT_STRDUP_VAL 8
122
#define AV_METADATA_DONT_OVERWRITE 16   ///< Don't overwrite existing tags.
123 124 125 126

typedef struct {
    char *key;
    char *value;
127
}AVMetadataTag;
128

A
Aurelien Jacobs 已提交
129
typedef struct AVMetadata AVMetadata;
A
Aurelien Jacobs 已提交
130
typedef struct AVMetadataConv AVMetadataConv;
131 132

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

142
#if LIBAVFORMAT_VERSION_MAJOR == 52
143
/**
144
 * Set the given tag in m, overwriting an existing tag.
145 146 147
 * @param key tag key to add to m (will be av_strduped)
 * @param value tag value to add to m (will be av_strduped)
 * @return >= 0 on success otherwise an error code <0
148
 * @deprecated Use av_metadata_set2() instead.
149
 */
150
attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
151 152 153
#endif

/**
154
 * Set the given tag in m, overwriting an existing tag.
155
 * @param key tag key to add to m (will be av_strduped depending on flags)
156 157
 * @param value tag value to add to m (will be av_strduped depending on flags).
 *        Passing a NULL value will cause an existing tag to be deleted.
158 159 160
 * @return >= 0 on success otherwise an error code <0
 */
int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
161

A
Aurelien Jacobs 已提交
162
/**
163
 * Convert all the metadata sets from ctx according to the source and
164 165
 * destination conversion tables. If one of the tables is NULL, then
 * tags are converted to/from ffmpeg generic tag names.
A
Aurelien Jacobs 已提交
166 167 168 169 170 171
 * @param d_conv destination tags format conversion table
 * @param s_conv source tags format conversion table
 */
void av_metadata_conv(struct AVFormatContext *ctx,const AVMetadataConv *d_conv,
                                                  const AVMetadataConv *s_conv);

172
/**
173
 * Free all the memory allocated for an AVMetadata struct.
174 175 176
 */
void av_metadata_free(AVMetadata **m);

177

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

180 181

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

F
Fabrice Bellard 已提交
191

F
Fabrice Bellard 已提交
192 193 194
/*************************************************/
/* fractional numbers for exact pts handling */

195
/**
D
Diego Biurrun 已提交
196 197
 * The exact value of the fractional number is: 'val + num / den'.
 * num is assumed to be 0 <= num < den.
198
 */
F
Fabrice Bellard 已提交
199
typedef struct AVFrac {
200
    int64_t val, num, den;
201
} AVFrac;
F
Fabrice Bellard 已提交
202

F
Fabrice Bellard 已提交
203
/*************************************************/
204
/* input/output formats */
F
Fabrice Bellard 已提交
205

206 207
struct AVCodecTag;

D
Diego Biurrun 已提交
208
/** This structure contains the data a format has to probe a file. */
209
typedef struct AVProbeData {
210
    const char *filename;
211 212
    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 */
213 214
} AVProbeData;

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

typedef struct AVFormatParameters {
219
    AVRational time_base;
F
Fabrice Bellard 已提交
220 221 222 223
    int sample_rate;
    int channels;
    int width;
    int height;
224
    enum PixelFormat pix_fmt;
D
Diego Biurrun 已提交
225 226 227 228
    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
229
                                            stream packet (only meaningful if
D
Diego Biurrun 已提交
230 231 232
                                            mpeg2ts_raw is TRUE). */
    unsigned int initial_pause:1;       /**< Do not begin to play the stream
                                            immediately (RTSP only). */
233
    unsigned int prealloced_context:1;
234
#if LIBAVFORMAT_VERSION_INT < (53<<16)
235 236
    enum CodecID video_codec_id;
    enum CodecID audio_codec_id;
237
#endif
F
Fabrice Bellard 已提交
238 239
} AVFormatParameters;

D
Diego Biurrun 已提交
240
//! Demuxer will use url_fopen, no opened file should be provided by the caller.
241
#define AVFMT_NOFILE        0x0001
D
Diego Biurrun 已提交
242 243 244 245 246 247 248 249
#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. */
250
#define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
251
#define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
252 253

typedef struct AVOutputFormat {
F
Fabrice Bellard 已提交
254
    const char *name;
255 256
    /**
     * Descriptive name for the format, meant to be more human-readable
257
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
258 259
     * to define it.
     */
F
Fabrice Bellard 已提交
260 261
    const char *long_name;
    const char *mime_type;
D
Diego Biurrun 已提交
262
    const char *extensions; /**< comma-separated filename extensions */
263
    /** size of private data so that it can be allocated in the wrapper */
264
    int priv_data_size;
F
Fabrice Bellard 已提交
265
    /* output support */
266 267
    enum CodecID audio_codec; /**< default audio codec */
    enum CodecID video_codec; /**< default video codec */
F
Fabrice Bellard 已提交
268
    int (*write_header)(struct AVFormatContext *);
269
    int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
F
Fabrice Bellard 已提交
270
    int (*write_trailer)(struct AVFormatContext *);
271
    /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
272
    int flags;
D
Diego Biurrun 已提交
273
    /** Currently only used to set pixel format if not YUV420P. */
274
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
275 276
    int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
                             AVPacket *in, int flush);
277 278

    /**
279
     * List of supported codec_id-codec_tag pairs, ordered by "better
280
     * choice first". The arrays are all terminated by CODEC_ID_NONE.
281
     */
282
    const struct AVCodecTag * const *codec_tag;
283

284 285
    enum CodecID subtitle_codec; /**< default subtitle codec */

286
    const AVMetadataConv *metadata_conv;
A
Aurelien Jacobs 已提交
287

288 289 290
    /* private fields */
    struct AVOutputFormat *next;
} AVOutputFormat;
F
Fabrice Bellard 已提交
291

292 293
typedef struct AVInputFormat {
    const char *name;
294 295
    /**
     * Descriptive name for the format, meant to be more human-readable
296
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
297 298
     * to define it.
     */
299
    const char *long_name;
D
Diego Biurrun 已提交
300
    /** Size of private data so that it can be allocated in the wrapper. */
301
    int priv_data_size;
302
    /**
303
     * Tell if a given file has a chance of being parsed as this format.
D
Diego Biurrun 已提交
304 305
     * 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.
306
     */
307
    int (*read_probe)(AVProbeData *);
D
Diego Biurrun 已提交
308 309 310
    /** 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
311
       now. 'av_new_stream' should be called to create new streams.  */
F
Fabrice Bellard 已提交
312 313
    int (*read_header)(struct AVFormatContext *,
                       AVFormatParameters *ap);
D
Diego Biurrun 已提交
314
    /** Read one packet and put it in 'pkt'. pts and flags are also
315
       set. 'av_new_stream' can be called only if the flag
316 317 318 319
       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 已提交
320
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
D
Diego Biurrun 已提交
321
    /** Close the stream. The AVFormatContext and AVStreams are not
F
Fabrice Bellard 已提交
322 323
       freed by this function */
    int (*read_close)(struct AVFormatContext *);
M
Michael Niedermayer 已提交
324 325

#if LIBAVFORMAT_VERSION_MAJOR < 53
326
    /**
D
Diego Biurrun 已提交
327 328
     * Seek to a given timestamp relative to the frames in
     * stream component stream_index.
329 330 331
     * @param stream_index Must not be -1.
     * @param flags Selects which direction should be preferred if no exact
     *              match is available.
332
     * @return >= 0 on success (but not necessarily the new offset)
333
     */
334
    int (*read_seek)(struct AVFormatContext *,
335
                     int stream_index, int64_t timestamp, int flags);
M
Michael Niedermayer 已提交
336
#endif
337
    /**
D
Diego Biurrun 已提交
338
     * Gets the next timestamp in stream[stream_index].time_base units.
D
Diego Biurrun 已提交
339
     * @return the timestamp or AV_NOPTS_VALUE if an error occurred
340 341 342
     */
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
                              int64_t *pos, int64_t pos_limit);
D
Diego Biurrun 已提交
343
    /** Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER. */
F
Fabrice Bellard 已提交
344
    int flags;
D
Diego Biurrun 已提交
345
    /** If extensions are defined, then no probe is done. You should
346 347 348
       usually not use extension format guessing because it is not
       reliable enough */
    const char *extensions;
D
Diego Biurrun 已提交
349
    /** General purpose read-only value that the format can use. */
350
    int value;
351

352
    /** Start/resume playing - only meaningful if using a network-based format
D
Diego Biurrun 已提交
353
       (RTSP). */
354 355
    int (*read_play)(struct AVFormatContext *);

356
    /** Pause playing - only meaningful if using a network-based format
D
Diego Biurrun 已提交
357
       (RTSP). */
358 359
    int (*read_pause)(struct AVFormatContext *);

360
    const struct AVCodecTag * const *codec_tag;
361

M
Michael Niedermayer 已提交
362
    /**
363
     * Seek to timestamp ts.
M
Michael Niedermayer 已提交
364 365 366 367
     * 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 已提交
368
    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 已提交
369

370
    const AVMetadataConv *metadata_conv;
A
Aurelien Jacobs 已提交
371

372 373 374
    /* private fields */
    struct AVInputFormat *next;
} AVInputFormat;
F
Fabrice Bellard 已提交
375

A
Aurelien Jacobs 已提交
376 377 378
enum AVStreamParseType {
    AVSTREAM_PARSE_NONE,
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
D
Diego Biurrun 已提交
379
    AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
380
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
381
    AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
A
Aurelien Jacobs 已提交
382 383
};

384 385 386 387
typedef struct AVIndexEntry {
    int64_t pos;
    int64_t timestamp;
#define AVINDEX_KEYFRAME 0x0001
M
Michael Niedermayer 已提交
388
    int flags:2;
D
Diego Biurrun 已提交
389 390
    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. */
391 392
} AVIndexEntry;

393 394 395 396 397 398 399
#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

400 401 402
/**
 * Stream structure.
 * New fields can be added to the end with minor version bumps.
D
Diego Biurrun 已提交
403
 * Removal, reordering and changes to existing fields require a major
404
 * version bump.
D
Diego Biurrun 已提交
405
 * sizeof(AVStream) must not be used outside libav*.
406
 */
F
Fabrice Bellard 已提交
407
typedef struct AVStream {
408
    int index;    /**< stream index in AVFormatContext */
D
Diego Biurrun 已提交
409
    int id;       /**< format-specific stream ID */
410
    AVCodecContext *codec; /**< codec context */
411
    /**
412 413
     * Real base framerate of the stream.
     * This is the lowest framerate with which all timestamps can be
R
Typos  
Ramiro Polla 已提交
414
     * represented accurately (it is the least common multiple of all
415 416
     * 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 已提交
417
     * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
418 419
     */
    AVRational r_frame_rate;
F
Fabrice Bellard 已提交
420
    void *priv_data;
421

422
    /* internal data used in av_find_stream_info() */
423
    int64_t first_dts;
D
Diego Biurrun 已提交
424
    /** encoding: pts generation when outputting stream */
425
    struct AVFrac pts;
426 427

    /**
D
Diego Biurrun 已提交
428 429
     * This is the fundamental unit of time (in seconds) in terms
     * of which frame timestamps are represented. For fixed-fps content,
430
     * time base should be 1/framerate and timestamp increments should be 1.
431
     */
432
    AVRational time_base;
433
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
F
Fabrice Bellard 已提交
434
    /* ffmpeg.c private use */
D
Diego Biurrun 已提交
435 436
    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.
437
    //FIXME move stuff to a flags field?
D
Diego Biurrun 已提交
438
    /** Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
D
Diego Biurrun 已提交
439
     * MN: dunno if that is the right place for it */
440
    float quality;
441
    /**
D
Diego Biurrun 已提交
442 443 444
     * 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.
445
     * This may be undefined (AV_NOPTS_VALUE).
D
Diego Biurrun 已提交
446 447
     * @note The ASF header does NOT contain a correct start_time the ASF
     * demuxer must NOT set this.
448
     */
449
    int64_t start_time;
450
    /**
D
Diego Biurrun 已提交
451
     * Decoding: duration of the stream, in stream time base.
452
     * If a source file does not specify a duration, but does specify
D
Diego Biurrun 已提交
453
     * a bitrate, this value will be estimated from bitrate and file size.
454
     */
455
    int64_t duration;
456

A
Aurelien Jacobs 已提交
457
#if LIBAVFORMAT_VERSION_INT < (53<<16)
458
    char language[4]; /** ISO 639-2/B 3-letter language code (empty string if undefined) */
A
Aurelien Jacobs 已提交
459
#endif
460

461
    /* av_read_frame() support */
A
Aurelien Jacobs 已提交
462
    enum AVStreamParseType need_parsing;
463
    struct AVCodecParserContext *parser;
464

465
    int64_t cur_dts;
M
Michael Niedermayer 已提交
466 467
    int last_IP_duration;
    int64_t last_IP_pts;
468
    /* av_seek_frame() support */
D
Diego Biurrun 已提交
469 470
    AVIndexEntry *index_entries; /**< Only used if the format does not
                                    support seeking natively. */
471
    int nb_index_entries;
M
Måns Rullgård 已提交
472
    unsigned int index_entries_allocated_size;
473

474
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
475

476 477
#if LIBAVFORMAT_VERSION_INT < (53<<16)
    int64_t unused[4+1];
478 479

    char *filename; /**< source filename of the stream */
A
Aurelien Jacobs 已提交
480
#endif
481

D
Diego Biurrun 已提交
482
    int disposition; /**< AV_DISPOSITION_* bit field */
483 484

    AVProbeData probe_data;
485 486
#define MAX_REORDER_DELAY 16
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
487 488 489 490 491 492 493

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

A
Aurelien Jacobs 已提交
495
    AVMetadata *metadata;
496 497 498 499 500

    /* av_read_frame() support */
    const uint8_t *cur_ptr;
    int cur_len;
    AVPacket cur_pkt;
501 502 503 504 505 506 507 508 509 510

    // 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;
511 512 513 514 515

    /**
     * Number of packets to buffer for codec probing
     * NOT PART OF PUBLIC API
     */
516
#define MAX_PROBE_PACKETS 2500
517
    int probe_packets;
518 519

    /**
520
     * last packet in packet_buffer for this stream when muxing.
521 522
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
     */
523
    struct AVPacketList *last_in_packet_buffer;
M
Michael Niedermayer 已提交
524 525 526 527 528

    /**
     * Average framerate
     */
    AVRational avg_frame_rate;
529 530 531 532 533

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

536 537
#define AV_PROGRAM_RUNNING 1

538 539
/**
 * New fields can be added to the end with minor version bumps.
D
Diego Biurrun 已提交
540
 * Removal, reordering and changes to existing fields require a major
541
 * version bump.
D
Diego Biurrun 已提交
542
 * sizeof(AVProgram) must not be used outside libav*.
543
 */
544 545
typedef struct AVProgram {
    int            id;
A
Aurelien Jacobs 已提交
546
#if LIBAVFORMAT_VERSION_INT < (53<<16)
D
Diego Biurrun 已提交
547 548
    char           *provider_name; ///< network name for DVB streams
    char           *name;          ///< service name for DVB streams
A
Aurelien Jacobs 已提交
549
#endif
550 551
    int            flags;
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
552 553
    unsigned int   *stream_index;
    unsigned int   nb_stream_indexes;
A
Aurelien Jacobs 已提交
554
    AVMetadata *metadata;
555 556
} AVProgram;

557
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
558 559
                                         (streams are added dynamically) */

560
typedef struct AVChapter {
D
Diego Biurrun 已提交
561 562
    int id;                 ///< unique ID to identify the chapter
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
M
Michael Niedermayer 已提交
563
    int64_t start, end;     ///< chapter start/end time in time_base units
A
Aurelien Jacobs 已提交
564
#if LIBAVFORMAT_VERSION_INT < (53<<16)
M
Michael Niedermayer 已提交
565
    char *title;            ///< chapter title
A
Aurelien Jacobs 已提交
566
#endif
A
Aurelien Jacobs 已提交
567
    AVMetadata *metadata;
568 569
} AVChapter;

570
#if LIBAVFORMAT_VERSION_MAJOR < 53
F
Fabrice Bellard 已提交
571
#define MAX_STREAMS 20
572
#endif
F
Fabrice Bellard 已提交
573

574
/**
D
Diego Biurrun 已提交
575
 * Format I/O context.
576
 * New fields can be added to the end with minor version bumps.
D
Diego Biurrun 已提交
577
 * Removal, reordering and changes to existing fields require a major
578
 * version bump.
D
Diego Biurrun 已提交
579
 * sizeof(AVFormatContext) must not be used outside libav*.
580
 */
F
Fabrice Bellard 已提交
581
typedef struct AVFormatContext {
582
    const AVClass *av_class; /**< Set by avformat_alloc_context. */
D
Diego Biurrun 已提交
583
    /* Can only be iformat or oformat, not both at the same time. */
584 585
    struct AVInputFormat *iformat;
    struct AVOutputFormat *oformat;
F
Fabrice Bellard 已提交
586
    void *priv_data;
587
    ByteIOContext *pb;
588
    unsigned int nb_streams;
F
Fabrice Bellard 已提交
589
    AVStream *streams[MAX_STREAMS];
590
    char filename[1024]; /**< input or output filename */
F
Fabrice Bellard 已提交
591
    /* stream info */
592
    int64_t timestamp;
A
Aurelien Jacobs 已提交
593
#if LIBAVFORMAT_VERSION_INT < (53<<16)
F
Fabrice Bellard 已提交
594 595 596 597
    char title[512];
    char author[512];
    char copyright[512];
    char comment[512];
598
    char album[512];
599 600 601
    int year;  /**< ID3 year, 0 if none */
    int track; /**< track number, 0 if none */
    char genre[32]; /**< ID3 genre */
A
Aurelien Jacobs 已提交
602
#endif
603

D
Diego Biurrun 已提交
604 605
    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
    /* private data for pts handling (do not modify directly). */
606
    /** This buffer is only needed when packets were already buffered but
D
Diego Biurrun 已提交
607 608
       not decoded, for example to get the codec parameters in MPEG
       streams. */
609 610
    struct AVPacketList *packet_buffer;

D
Diego Biurrun 已提交
611
    /** Decoding: position of the first frame of the component, in
612
       AV_TIME_BASE fractional seconds. NEVER set this value directly:
D
Diego Biurrun 已提交
613
       It is deduced from the AVStream values.  */
614
    int64_t start_time;
D
Diego Biurrun 已提交
615
    /** Decoding: duration of the stream, in AV_TIME_BASE fractional
616 617 618
       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.  */
619
    int64_t duration;
D
Diego Biurrun 已提交
620
    /** decoding: total file size, 0 if unknown */
621
    int64_t file_size;
D
Diego Biurrun 已提交
622
    /** Decoding: total stream bitrate in bit/s, 0 if not
623
       available. Never set it directly if the file_size and the
624
       duration are known as FFmpeg can compute it automatically. */
625
    int bit_rate;
626 627 628

    /* av_read_frame() support */
    AVStream *cur_st;
629 630 631 632 633
#if LIBAVFORMAT_VERSION_INT < (53<<16)
    const uint8_t *cur_ptr_deprecated;
    int cur_len_deprecated;
    AVPacket cur_pkt_deprecated;
#endif
634 635

    /* av_seek_frame() support */
636
    int64_t data_offset; /** offset of the first packet */
637
    int index_built;
638

639
    int mux_rate;
640
    unsigned int packet_size;
641 642
    int preload;
    int max_delay;
643

644 645
#define AVFMT_NOOUTPUTLOOP -1
#define AVFMT_INFINITEOUTPUTLOOP 0
646
    /** number of times to loop output in formats that support it */
647
    int loop_output;
648

649
    int flags;
650
#define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
D
Diego Biurrun 已提交
651 652
#define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
653
#define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
654 655
#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
656
#define AVFMT_FLAG_RTP_HINT     0x0040 ///< Add RTP hinting to the output file
657 658

    int loop_input;
659
    /** decoding: size of data to probe; encoding: unused. */
660
    unsigned int probesize;
661 662

    /**
D
Diego Biurrun 已提交
663 664
     * Maximum time (in AV_TIME_BASE units) during which the input should
     * be analyzed in av_find_stream_info().
665 666
     */
    int max_analyze_duration;
667 668 669

    const uint8_t *key;
    int keylen;
670 671 672

    unsigned int nb_programs;
    AVProgram **programs;
M
Michael Niedermayer 已提交
673 674 675

    /**
     * Forced video codec_id.
D
Diego Biurrun 已提交
676
     * Demuxing: Set by user.
M
Michael Niedermayer 已提交
677 678 679 680
     */
    enum CodecID video_codec_id;
    /**
     * Forced audio codec_id.
D
Diego Biurrun 已提交
681
     * Demuxing: Set by user.
M
Michael Niedermayer 已提交
682 683 684 685
     */
    enum CodecID audio_codec_id;
    /**
     * Forced subtitle codec_id.
D
Diego Biurrun 已提交
686
     * Demuxing: Set by user.
M
Michael Niedermayer 已提交
687 688
     */
    enum CodecID subtitle_codec_id;
689 690

    /**
691 692
     * 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
693 694
     * needed to maintain a smaller size. This can lead to slower or less
     * accurate seeking (depends on demuxer).
D
Diego Biurrun 已提交
695
     * Demuxers for which a full in-memory index is mandatory will ignore
696 697 698 699 700
     * this.
     * muxing  : unused
     * demuxing: set by user
     */
    unsigned int max_index_size;
701 702

    /**
R
Ramiro Polla 已提交
703
     * Maximum amount of memory in bytes to use for buffering frames
D
Diego Biurrun 已提交
704
     * obtained from realtime capture devices.
705 706
     */
    unsigned int max_picture_buffer;
707

708
    unsigned int nb_chapters;
709
    AVChapter **chapters;
710 711

    /**
D
Diego Biurrun 已提交
712
     * Flags to enable debugging.
713 714 715
     */
    int debug;
#define FF_FDEBUG_TS        0x0001
716 717

    /**
D
Diego Biurrun 已提交
718
     * Raw packets from the demuxer, prior to parsing and decoding.
719 720 721 722 723
     * 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;
724 725 726
    struct AVPacketList *raw_packet_buffer_end;

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

A
Aurelien Jacobs 已提交
728
    AVMetadata *metadata;
729 730 731 732 733

    /**
     * Remaining size available for raw_packet_buffer, in bytes.
     * NOT PART OF PUBLIC API
     */
734
#define RAW_PACKET_BUFFER_SIZE 2500000
735
    int raw_packet_buffer_remaining_size;
736 737 738 739 740 741 742 743 744

    /**
     * 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 已提交
745 746 747 748 749 750 751
} AVFormatContext;

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

752
#if LIBAVFORMAT_VERSION_INT < (53<<16)
753 754
extern AVInputFormat *first_iformat;
extern AVOutputFormat *first_oformat;
755 756
#endif

757 758
/**
 * If f is NULL, returns the first registered input format,
759
 * if f is non-NULL, returns the next registered input format after f
760 761
 * or NULL if f is the last one.
 */
762
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
763 764 765

/**
 * If f is NULL, returns the first registered output format,
766
 * if f is non-NULL, returns the next registered output format after f
767 768
 * or NULL if f is the last one.
 */
769
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
F
Fabrice Bellard 已提交
770

771
enum CodecID av_guess_image2_codec(const char *filename);
772

773 774
/* XXX: Use automatic init with either ELF sections or C file parser */
/* modules. */
F
Fabrice Bellard 已提交
775

776 777 778
/* utils.c */
void av_register_input_format(AVInputFormat *format);
void av_register_output_format(AVOutputFormat *format);
779 780
#if LIBAVFORMAT_VERSION_MAJOR < 53
attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
781 782
                                    const char *filename,
                                    const char *mime_type);
783 784 785 786 787 788 789

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

/**
793 794
 * Return the output format in the list of registered output formats
 * which best matches the provided parameters, or return NULL if
S
Stefano Sabatini 已提交
795 796 797 798 799 800 801 802 803
 * 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
 */
804
AVOutputFormat *av_guess_format(const char *short_name,
S
Stefano Sabatini 已提交
805 806
                                const char *filename,
                                const char *mime_type);
807 808

/**
809
 * Guess the codec ID based upon muxer and filename.
810
 */
811
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
812
                            const char *filename, const char *mime_type,
813
                            enum AVMediaType type);
F
Fabrice Bellard 已提交
814

815
/**
816
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
817 818
 *
 * @param f The file stream pointer where the dump should be sent to.
819 820
 * @param buf buffer
 * @param size buffer size
821 822
 *
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
823
 */
824
void av_hex_dump(FILE *f, uint8_t *buf, int size);
825 826

/**
827
 * Send a nice hexadecimal dump of a buffer to the log.
828 829 830 831 832 833 834 835 836 837 838 839 840
 *
 * @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);

/**
841
 * Send a nice dump of a packet to the specified file stream.
842 843
 *
 * @param f The file stream pointer where the dump should be sent to.
844
 * @param pkt packet to dump
D
Diego Biurrun 已提交
845
 * @param dump_payload True if the payload must be displayed, too.
846
 */
847
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
F
Fabrice Bellard 已提交
848

849
/**
850
 * Send a nice dump of a packet to the log.
851 852 853 854 855 856
 *
 * @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 已提交
857
 * @param dump_payload True if the payload must be displayed, too.
858 859 860
 */
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);

861
/**
862
 * Initialize libavformat and register all the muxers, demuxers and
863 864 865 866 867
 * 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()
868
 * @see av_register_protocol()
869
 */
F
Fabrice Bellard 已提交
870
void av_register_all(void);
F
Fabrice Bellard 已提交
871

872
/**
873
 * Get the CodecID for the given codec tag tag.
874 875 876 877 878
 * 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
 */
879
enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
880 881

/**
882
 * Get the codec tag for the given codec id id.
883 884 885 886 887
 * 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
 */
888
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
889

890
/* media file input */
891 892

/**
893
 * Find AVInputFormat based on the short name of the input format.
894
 */
895
AVInputFormat *av_find_input_format(const char *short_name);
896 897

/**
898
 * Guess the file format.
899
 *
D
Diego Biurrun 已提交
900 901
 * @param is_opened Whether the file is already opened; determines whether
 *                  demuxers with or without AVFMT_NOFILE are probed.
902
 */
F
Fabrice Bellard 已提交
903
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
904

905
/**
906
 * Guess the file format.
907 908 909
 *
 * @param is_opened Whether the file is already opened; determines whether
 *                  demuxers with or without AVFMT_NOFILE are probed.
910 911 912 913
 * @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
914 915 916 917
 *                  to retry with a larger probe buffer.
 */
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);

918
/**
919
 * Allocate all the structures needed to read an input stream.
920 921
 *        This does not open the needed codecs for decoding the stream[s].
 */
922 923
int av_open_input_stream(AVFormatContext **ic_ptr,
                         ByteIOContext *pb, const char *filename,
924
                         AVInputFormat *fmt, AVFormatParameters *ap);
925 926

/**
927
 * Open a media file as input. The codecs are not opened. Only the file
928 929
 * header (if present) is read.
 *
D
Diego Biurrun 已提交
930 931 932
 * @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.
933
 * @param buf_size optional buffer size (zero if default is OK)
934 935
 * @param ap Additional parameters needed when opening the file
 *           (NULL if default).
D
Diego Biurrun 已提交
936
 * @return 0 if OK, AVERROR_xxx otherwise
937
 */
938
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
939 940 941
                       AVInputFormat *fmt,
                       int buf_size,
                       AVFormatParameters *ap);
942 943 944 945 946 947 948 949

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

950
/**
951
 * Allocate an AVFormatContext.
D
Diego Biurrun 已提交
952
 * Can be freed with av_free() but do not forget to free everything you
953 954
 * explicitly allocated as well!
 */
955
AVFormatContext *avformat_alloc_context(void);
956

957
/**
958
 * Read packets of a media file to get stream information. This
959
 * is useful for file formats with no headers such as MPEG. This
960
 * function also computes the real framerate in case of MPEG-2 repeat
961 962 963 964 965
 * 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 已提交
966 967 968
 * @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.
969
 */
970
int av_find_stream_info(AVFormatContext *ic);
971 972

/**
973
 * Read a transport packet from a media file.
974
 *
R
Typos  
Ramiro Polla 已提交
975
 * This function is obsolete and should never be used.
976 977 978 979
 * Use av_read_frame() instead.
 *
 * @param s media file handle
 * @param pkt is filled
D
Diego Biurrun 已提交
980
 * @return 0 if OK, AVERROR_xxx on error
981
 */
F
Fabrice Bellard 已提交
982
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
983 984

/**
985
 * Return the next frame of a stream.
986 987 988 989 990 991 992 993 994 995
 *
 * 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
996
 * values in AVStream.time_base units (and guessed if the format cannot
D
Diego Biurrun 已提交
997 998
 * 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
999 1000
 * decompress the payload.
 *
D
Diego Biurrun 已提交
1001
 * @return 0 if OK, < 0 on error or end of file
1002
 */
1003
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1004 1005

/**
1006
 * Seek to the keyframe at timestamp.
1007 1008 1009 1010
 * '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 已提交
1011 1012
 * @param timestamp Timestamp in AVStream.time_base units
 *        or, if no stream is specified, in AV_TIME_BASE units.
1013 1014 1015
 * @param flags flags which select direction and seeking mode
 * @return >= 0 on success
 */
1016 1017
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
                  int flags);
1018

1019
/**
1020
 * Seek to timestamp ts.
1021 1022 1023 1024
 * 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.
 *
1025
 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1026
 * are the file position (this may not be supported by all demuxers).
1027
 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1028
 * in the stream with stream_index (this may not be supported by all demuxers).
1029 1030 1031
 * 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
1032 1033
 * keyframes (this may not be supported by all demuxers).
 *
1034
 * @param stream_index index of the stream which is used as time base reference
1035 1036 1037 1038
 * @param min_ts smallest acceptable timestamp
 * @param ts target timestamp
 * @param max_ts largest acceptable timestamp
 * @param flags flags
B
Benoit Fouet 已提交
1039
 * @return >=0 on success, error code otherwise
1040
 *
1041 1042 1043
 * @NOTE This is part of the new seek API which is still under construction.
 *       Thus do not use this yet. It may change at any time, do not expect
 *       ABI compatibility yet!
1044 1045 1046
 */
int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);

1047
/**
1048
 * Start playing a network-based stream (e.g. RTSP stream) at the
D
Diego Biurrun 已提交
1049
 * current position.
1050
 */
1051
int av_read_play(AVFormatContext *s);
1052 1053

/**
1054
 * Pause a network-based stream (e.g. RTSP stream).
1055 1056 1057
 *
 * Use av_read_play() to resume it.
 */
1058
int av_read_pause(AVFormatContext *s);
1059

1060
/**
1061
 * Free a AVFormatContext allocated by av_open_input_stream.
1062 1063 1064 1065
 * @param s context to free
 */
void av_close_input_stream(AVFormatContext *s);

1066
/**
1067
 * Close a media file (but not its codecs).
1068 1069 1070
 *
 * @param s media file handle
 */
F
Fabrice Bellard 已提交
1071
void av_close_input_file(AVFormatContext *s);
1072 1073

/**
1074
 * Add a new stream to a media file.
1075 1076 1077 1078 1079 1080
 *
 * 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 已提交
1081
 * @param id file-format-dependent stream ID
1082
 */
1083
AVStream *av_new_stream(AVFormatContext *s, int id);
1084
AVProgram *av_new_program(AVFormatContext *s, int id);
1085

1086
/**
1087
 * Add a new chapter.
1088
 * This function is NOT part of the public API
D
Diego Biurrun 已提交
1089
 * and should ONLY be used by demuxers.
1090 1091
 *
 * @param s media file handle
D
Diego Biurrun 已提交
1092
 * @param id unique ID for this chapter
1093 1094
 * @param start chapter start time in time_base units
 * @param end chapter end time in time_base units
1095
 * @param title chapter title
1096
 *
D
Diego Biurrun 已提交
1097
 * @return AVChapter or NULL on error
1098
 */
1099 1100
AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
                          int64_t start, int64_t end, const char *title);
1101

1102
/**
1103
 * Set the pts for a given stream.
1104 1105 1106 1107 1108 1109 1110
 *
 * @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)
 */
1111
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1112
                     unsigned int pts_num, unsigned int pts_den);
F
Fabrice Bellard 已提交
1113

1114 1115
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
D
Diego Biurrun 已提交
1116
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1117
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1118

1119
int av_find_default_stream_index(AVFormatContext *s);
1120 1121

/**
1122
 * Get the index for a specific timestamp.
D
Diego Biurrun 已提交
1123 1124 1125
 * @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 >=
1126 1127 1128
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
 * @return < 0 if no such timestamp could be found
 */
1129
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1130

1131
/**
1132
 * Ensure the index uses less memory than the maximum specified in
1133
 * AVFormatContext.max_index_size by discarding entries if it grows
1134 1135 1136 1137 1138 1139
 * 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);

1140
/**
1141
 * Add an index entry into a sorted list. Update the entry if the list
D
Diego Biurrun 已提交
1142
 * already contains it.
1143
 *
D
Diego Biurrun 已提交
1144
 * @param timestamp timestamp in the time base of the given stream
1145
 */
1146 1147
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
                       int size, int distance, int flags);
1148 1149

/**
1150
 * Perform a binary search using av_index_search_timestamp() and
1151 1152 1153
 * AVCodec.read_timestamp().
 * This is not supposed to be called directly by a user application,
 * but by demuxers.
1154 1155 1156
 * @param target_ts target timestamp in the time base of the given stream
 * @param stream_index stream number
 */
1157 1158
int av_seek_frame_binary(AVFormatContext *s, int stream_index,
                         int64_t target_ts, int flags);
1159 1160

/**
1161
 * Update cur_dts of all streams based on the given timestamp and AVStream.
1162
 *
D
Diego Biurrun 已提交
1163 1164
 * 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).
1165 1166 1167
 * @param timestamp new dts expressed in time_base of param ref_st
 * @param ref_st reference stream giving time_base of param timestamp
 */
1168
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1169 1170

/**
1171
 * Perform a binary search using read_timestamp().
1172 1173
 * This is not supposed to be called directly by a user application,
 * but by demuxers.
1174 1175 1176
 * @param target_ts target timestamp in the time base of the given stream
 * @param stream_index stream number
 */
1177 1178 1179 1180 1181 1182
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 ));
1183

1184
/** media file output */
1185
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1186

M
Måns Rullgård 已提交
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
/**
 * 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);

1213
/**
1214
 * Allocate the stream private data and write the stream header to an
D
Diego Biurrun 已提交
1215
 * output media file.
1216 1217
 *
 * @param s media file handle
D
Diego Biurrun 已提交
1218
 * @return 0 if OK, AVERROR_xxx on error
1219
 */
1220
int av_write_header(AVFormatContext *s);
1221 1222

/**
1223
 * Write a packet to an output media file.
1224 1225
 *
 * The packet shall contain one audio or video frame.
1226 1227
 * The packet must be correctly interleaved according to the container
 * specification, if not then av_interleaved_write_frame must be used.
1228 1229
 *
 * @param s media file handle
1230 1231
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
              dts/pts, ...
D
Diego Biurrun 已提交
1232
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1233
 */
1234
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1235 1236

/**
1237
 * Write a packet to an output media file ensuring correct interleaving.
1238 1239
 *
 * The packet must contain one audio or video frame.
1240
 * If the packets are already correctly interleaved, the application should
D
Diego Biurrun 已提交
1241 1242 1243 1244
 * 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.
1245 1246
 *
 * @param s media file handle
1247 1248
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
              dts/pts, ...
D
Diego Biurrun 已提交
1249
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1250
 */
1251
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1252 1253

/**
1254
 * Interleave a packet per dts in an output media file.
1255
 *
1256
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1257
 * function, so they cannot be used after it. Note that calling av_free_packet()
1258
 * on them is still safe.
1259 1260 1261
 *
 * @param s media file handle
 * @param out the interleaved packet will be output here
1262
 * @param pkt the input packet
1263 1264 1265
 * @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 已提交
1266
 *         < 0 if an error occurred
1267
 */
1268 1269
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
                                 AVPacket *pkt, int flush);
1270

1271
/**
1272
 * Write the stream trailer to an output media file and free the
1273
 * file private data.
1274
 *
1275 1276
 * May only be called after a successful call to av_write_header.
 *
1277
 * @param s media file handle
D
Diego Biurrun 已提交
1278
 * @return 0 if OK, AVERROR_xxx on error
1279
 */
1280
int av_write_trailer(AVFormatContext *s);
F
Fabrice Bellard 已提交
1281 1282

void dump_format(AVFormatContext *ic,
1283
                 int index,
F
Fabrice Bellard 已提交
1284 1285
                 const char *url,
                 int is_output);
1286

1287
#if LIBAVFORMAT_VERSION_MAJOR < 53
1288
/**
1289
 * Parse width and height out of string str.
1290
 * @deprecated Use av_parse_video_frame_size instead.
1291
 */
1292 1293
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
                                          const char *str);
1294 1295

/**
1296
 * Convert framerate from a string to a fraction.
1297
 * @deprecated Use av_parse_video_frame_rate instead.
1298
 */
1299 1300
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
                                          const char *arg);
1301
#endif
1302 1303

/**
1304
 * Parse datestr and return a corresponding number of microseconds.
1305 1306
 * @param datestr String representing a date or a duration.
 * - If a date the syntax is:
1307
 * @code
1308
 *  now|{[{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH[:MM[:SS[.m...]]]}|{HH[MM[SS[.m...]]]}}[Z|z]}
1309
 * @endcode
1310
 * If the value is "now" it takes the current time.
D
Diego Biurrun 已提交
1311
 * Time is local time unless Z is appended, in which case it is
1312
 * interpreted as UTC.
D
Diego Biurrun 已提交
1313
 * If the year-month-day part is not specified it takes the current
1314
 * year-month-day.
1315
 * @return the number of microseconds since 1st of January, 1970 up to
1316
 * the time of the parsed date or INT64_MIN if datestr cannot be
1317 1318 1319 1320 1321 1322
 * successfully parsed.
 * - If a duration the syntax is:
 * @code
 *  [-]HH[:MM[:SS[.m...]]]
 *  [-]S+[.m...]
 * @endcode
1323
 * @return the number of microseconds contained in a time interval
1324
 * with the specified duration or INT64_MIN if datestr cannot be
D
Diego Biurrun 已提交
1325
 * successfully parsed.
1326 1327
 * @param duration Flag which tells how to interpret datestr, if
 * not zero datestr is interpreted as a duration, otherwise as a
1328
 * date.
1329
 */
1330
int64_t parse_date(const char *datestr, int duration);
F
Fabrice Bellard 已提交
1331

1332
/** Get the current time in microseconds. */
1333
int64_t av_gettime(void);
F
Fabrice Bellard 已提交
1334

D
Diego Biurrun 已提交
1335
/* ffm-specific for ffserver */
F
Fabrice Bellard 已提交
1336
#define FFM_PACKET_SIZE 4096
1337
int64_t ffm_read_write_index(int fd);
1338
int ffm_write_write_index(int fd, int64_t pos);
1339
void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
F
Fabrice Bellard 已提交
1340

1341
/**
1342
 * Attempt to find a specific tag in a URL.
1343 1344 1345 1346
 *
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
 * Return 1 if found.
 */
F
Fabrice Bellard 已提交
1347 1348
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);

1349
/**
1350
 * Return in 'buf' the path with '%d' replaced by a number.
D
Diego Biurrun 已提交
1351
 *
1352 1353 1354 1355 1356 1357
 * 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 已提交
1358
 * @param number frame number
D
Diego Biurrun 已提交
1359
 * @return 0 if OK, -1 on format error
1360
 */
1361 1362
int av_get_frame_filename(char *buf, int buf_size,
                          const char *path, int number);
1363 1364

/**
1365
 * Check whether filename actually is a numbered sequence generator.
1366 1367
 *
 * @param filename possible numbered sequence string
D
Diego Biurrun 已提交
1368
 * @return 1 if a valid numbered sequence string, 0 otherwise
1369
 */
1370
int av_filename_number_test(const char *filename);
1371

L
Luca Abeni 已提交
1372
/**
1373
 * Generate an SDP for an RTP session.
L
Luca Abeni 已提交
1374 1375 1376 1377 1378
 *
 * @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 已提交
1379
 *           must contain only one AVStream.
1380 1381
 * @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 已提交
1382
 *             the caller)
1383
 * @param size the size of the buffer
D
Diego Biurrun 已提交
1384
 * @return 0 if OK, AVERROR_xxx on error
L
Luca Abeni 已提交
1385
 */
1386
int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
L
Luca Abeni 已提交
1387

1388
/**
1389
 * Return a positive value if the given filename has one of the given
1390 1391 1392 1393 1394 1395
 * extensions, 0 otherwise.
 *
 * @param extensions a comma-separated list of filename extensions
 */
int av_match_ext(const char *filename, const char *extensions);

1396
#endif /* AVFORMAT_AVFORMAT_H */