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

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

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

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

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

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

363
    const struct AVCodecTag * const *codec_tag;
364

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

373
    const AVMetadataConv *metadata_conv;
A
Aurelien Jacobs 已提交
374

375 376 377
    /* private fields */
    struct AVInputFormat *next;
} AVInputFormat;
F
Fabrice Bellard 已提交
378

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

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

396 397 398 399 400 401
#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
402 403 404 405
/** 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. */
#define AV_DISPOSITION_FORCED    0x0040
406

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

429
    /* internal data used in av_find_stream_info() */
430
    int64_t first_dts;
D
Diego Biurrun 已提交
431
    /** encoding: pts generation when outputting stream */
432
    struct AVFrac pts;
433 434

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

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

468
    /* av_read_frame() support */
A
Aurelien Jacobs 已提交
469
    enum AVStreamParseType need_parsing;
470
    struct AVCodecParserContext *parser;
471

472
    int64_t cur_dts;
M
Michael Niedermayer 已提交
473 474
    int last_IP_duration;
    int64_t last_IP_pts;
475
    /* av_seek_frame() support */
D
Diego Biurrun 已提交
476 477
    AVIndexEntry *index_entries; /**< Only used if the format does not
                                    support seeking natively. */
478
    int nb_index_entries;
M
Måns Rullgård 已提交
479
    unsigned int index_entries_allocated_size;
480

481
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
482

483 484
#if LIBAVFORMAT_VERSION_INT < (53<<16)
    int64_t unused[4+1];
485 486

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

D
Diego Biurrun 已提交
489
    int disposition; /**< AV_DISPOSITION_* bit field */
490 491

    AVProbeData probe_data;
492 493
#define MAX_REORDER_DELAY 16
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
494 495 496 497 498 499 500

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

A
Aurelien Jacobs 已提交
502
    AVMetadata *metadata;
503

504 505
    /* Intended mostly for av_read_frame() support. Not supposed to be used by */
    /* external applications; try to use something else if at all possible.    */
506 507 508
    const uint8_t *cur_ptr;
    int cur_len;
    AVPacket cur_pkt;
509 510 511 512 513 514 515 516 517 518

    // 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;
519 520 521 522 523

    /**
     * Number of packets to buffer for codec probing
     * NOT PART OF PUBLIC API
     */
524
#define MAX_PROBE_PACKETS 2500
525
    int probe_packets;
526 527

    /**
528
     * last packet in packet_buffer for this stream when muxing.
529 530
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
     */
531
    struct AVPacketList *last_in_packet_buffer;
M
Michael Niedermayer 已提交
532 533 534 535 536

    /**
     * Average framerate
     */
    AVRational avg_frame_rate;
537 538 539 540 541

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

544 545
#define AV_PROGRAM_RUNNING 1

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

565
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
566 567
                                         (streams are added dynamically) */

568
typedef struct AVChapter {
D
Diego Biurrun 已提交
569 570
    int id;                 ///< unique ID to identify the chapter
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
M
Michael Niedermayer 已提交
571
    int64_t start, end;     ///< chapter start/end time in time_base units
A
Aurelien Jacobs 已提交
572
#if LIBAVFORMAT_VERSION_INT < (53<<16)
M
Michael Niedermayer 已提交
573
    char *title;            ///< chapter title
A
Aurelien Jacobs 已提交
574
#endif
A
Aurelien Jacobs 已提交
575
    AVMetadata *metadata;
576 577
} AVChapter;

578
#if LIBAVFORMAT_VERSION_MAJOR < 53
F
Fabrice Bellard 已提交
579
#define MAX_STREAMS 20
580
#endif
F
Fabrice Bellard 已提交
581

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

D
Diego Biurrun 已提交
612 613
    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
    /* private data for pts handling (do not modify directly). */
614
    /** This buffer is only needed when packets were already buffered but
D
Diego Biurrun 已提交
615 616
       not decoded, for example to get the codec parameters in MPEG
       streams. */
617 618
    struct AVPacketList *packet_buffer;

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

    /* av_read_frame() support */
    AVStream *cur_st;
637 638 639 640 641
#if LIBAVFORMAT_VERSION_INT < (53<<16)
    const uint8_t *cur_ptr_deprecated;
    int cur_len_deprecated;
    AVPacket cur_pkt_deprecated;
#endif
642 643

    /* av_seek_frame() support */
644
    int64_t data_offset; /** offset of the first packet */
645
    int index_built;
646

647
    int mux_rate;
648
    unsigned int packet_size;
649 650
    int preload;
    int max_delay;
651

652 653
#define AVFMT_NOOUTPUTLOOP -1
#define AVFMT_INFINITEOUTPUTLOOP 0
654
    /** number of times to loop output in formats that support it */
655
    int loop_output;
656

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

    int loop_input;
667
    /** decoding: size of data to probe; encoding: unused. */
668
    unsigned int probesize;
669 670

    /**
D
Diego Biurrun 已提交
671 672
     * Maximum time (in AV_TIME_BASE units) during which the input should
     * be analyzed in av_find_stream_info().
673 674
     */
    int max_analyze_duration;
675 676 677

    const uint8_t *key;
    int keylen;
678 679 680

    unsigned int nb_programs;
    AVProgram **programs;
M
Michael Niedermayer 已提交
681 682 683

    /**
     * Forced video codec_id.
D
Diego Biurrun 已提交
684
     * Demuxing: Set by user.
M
Michael Niedermayer 已提交
685 686 687 688
     */
    enum CodecID video_codec_id;
    /**
     * Forced audio codec_id.
D
Diego Biurrun 已提交
689
     * Demuxing: Set by user.
M
Michael Niedermayer 已提交
690 691 692 693
     */
    enum CodecID audio_codec_id;
    /**
     * Forced subtitle codec_id.
D
Diego Biurrun 已提交
694
     * Demuxing: Set by user.
M
Michael Niedermayer 已提交
695 696
     */
    enum CodecID subtitle_codec_id;
697 698

    /**
699 700
     * 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
701 702
     * needed to maintain a smaller size. This can lead to slower or less
     * accurate seeking (depends on demuxer).
D
Diego Biurrun 已提交
703
     * Demuxers for which a full in-memory index is mandatory will ignore
704 705 706 707 708
     * this.
     * muxing  : unused
     * demuxing: set by user
     */
    unsigned int max_index_size;
709 710

    /**
R
Ramiro Polla 已提交
711
     * Maximum amount of memory in bytes to use for buffering frames
D
Diego Biurrun 已提交
712
     * obtained from realtime capture devices.
713 714
     */
    unsigned int max_picture_buffer;
715

716
    unsigned int nb_chapters;
717
    AVChapter **chapters;
718 719

    /**
D
Diego Biurrun 已提交
720
     * Flags to enable debugging.
721 722 723
     */
    int debug;
#define FF_FDEBUG_TS        0x0001
724 725

    /**
D
Diego Biurrun 已提交
726
     * Raw packets from the demuxer, prior to parsing and decoding.
727 728 729 730 731
     * 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;
732 733 734
    struct AVPacketList *raw_packet_buffer_end;

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

A
Aurelien Jacobs 已提交
736
    AVMetadata *metadata;
737 738 739 740 741

    /**
     * Remaining size available for raw_packet_buffer, in bytes.
     * NOT PART OF PUBLIC API
     */
742
#define RAW_PACKET_BUFFER_SIZE 2500000
743
    int raw_packet_buffer_remaining_size;
744 745 746 747 748 749 750 751 752

    /**
     * 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 已提交
753 754 755 756 757 758 759
} AVFormatContext;

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

760
#if LIBAVFORMAT_VERSION_INT < (53<<16)
761 762
extern AVInputFormat *first_iformat;
extern AVOutputFormat *first_oformat;
763 764
#endif

765 766
/**
 * If f is NULL, returns the first registered input format,
767
 * if f is non-NULL, returns the next registered input format after f
768 769
 * or NULL if f is the last one.
 */
770
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
771 772 773

/**
 * If f is NULL, returns the first registered output format,
774
 * if f is non-NULL, returns the next registered output format after f
775 776
 * or NULL if f is the last one.
 */
777
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
F
Fabrice Bellard 已提交
778

779
enum CodecID av_guess_image2_codec(const char *filename);
780

781 782
/* XXX: Use automatic init with either ELF sections or C file parser */
/* modules. */
F
Fabrice Bellard 已提交
783

784 785 786
/* utils.c */
void av_register_input_format(AVInputFormat *format);
void av_register_output_format(AVOutputFormat *format);
787 788
#if LIBAVFORMAT_VERSION_MAJOR < 53
attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
789 790
                                    const char *filename,
                                    const char *mime_type);
791 792 793 794 795 796 797

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

/**
801 802
 * Return the output format in the list of registered output formats
 * which best matches the provided parameters, or return NULL if
S
Stefano Sabatini 已提交
803 804 805 806 807 808 809 810 811
 * 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
 */
812
AVOutputFormat *av_guess_format(const char *short_name,
S
Stefano Sabatini 已提交
813 814
                                const char *filename,
                                const char *mime_type);
815 816

/**
817
 * Guess the codec ID based upon muxer and filename.
818
 */
819
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
820
                            const char *filename, const char *mime_type,
821
                            enum AVMediaType type);
F
Fabrice Bellard 已提交
822

823
/**
824
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
825 826
 *
 * @param f The file stream pointer where the dump should be sent to.
827 828
 * @param buf buffer
 * @param size buffer size
829 830
 *
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
831
 */
832
void av_hex_dump(FILE *f, uint8_t *buf, int size);
833 834

/**
835
 * Send a nice hexadecimal dump of a buffer to the log.
836 837 838 839 840 841 842 843 844 845 846 847 848
 *
 * @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);

/**
849
 * Send a nice dump of a packet to the specified file stream.
850 851
 *
 * @param f The file stream pointer where the dump should be sent to.
852
 * @param pkt packet to dump
D
Diego Biurrun 已提交
853
 * @param dump_payload True if the payload must be displayed, too.
854
 */
855
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
F
Fabrice Bellard 已提交
856

857
/**
858
 * Send a nice dump of a packet to the log.
859 860 861 862 863 864
 *
 * @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 已提交
865
 * @param dump_payload True if the payload must be displayed, too.
866 867 868
 */
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);

869
/**
870
 * Initialize libavformat and register all the muxers, demuxers and
871 872 873 874 875
 * 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()
876
 * @see av_register_protocol()
877
 */
F
Fabrice Bellard 已提交
878
void av_register_all(void);
F
Fabrice Bellard 已提交
879

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

/**
890
 * Get the codec tag for the given codec id id.
891 892 893 894 895
 * 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
 */
896
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
897

898
/* media file input */
899 900

/**
901
 * Find AVInputFormat based on the short name of the input format.
902
 */
903
AVInputFormat *av_find_input_format(const char *short_name);
904 905

/**
906
 * Guess the file format.
907
 *
D
Diego Biurrun 已提交
908 909
 * @param is_opened Whether the file is already opened; determines whether
 *                  demuxers with or without AVFMT_NOFILE are probed.
910
 */
F
Fabrice Bellard 已提交
911
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
912

913
/**
914
 * Guess the file format.
915 916 917
 *
 * @param is_opened Whether the file is already opened; determines whether
 *                  demuxers with or without AVFMT_NOFILE are probed.
918 919 920 921
 * @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
922 923 924 925
 *                  to retry with a larger probe buffer.
 */
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);

926
/**
927
 * Allocate all the structures needed to read an input stream.
928 929
 *        This does not open the needed codecs for decoding the stream[s].
 */
930 931
int av_open_input_stream(AVFormatContext **ic_ptr,
                         ByteIOContext *pb, const char *filename,
932
                         AVInputFormat *fmt, AVFormatParameters *ap);
933 934

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

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

958
/**
959
 * Allocate an AVFormatContext.
D
Diego Biurrun 已提交
960
 * Can be freed with av_free() but do not forget to free everything you
961 962
 * explicitly allocated as well!
 */
963
AVFormatContext *avformat_alloc_context(void);
964

965
/**
966
 * Read packets of a media file to get stream information. This
967
 * is useful for file formats with no headers such as MPEG. This
968
 * function also computes the real framerate in case of MPEG-2 repeat
969 970 971 972 973
 * 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 已提交
974 975 976
 * @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.
977
 */
978
int av_find_stream_info(AVFormatContext *ic);
979 980

/**
981
 * Read a transport packet from a media file.
982
 *
R
Typos  
Ramiro Polla 已提交
983
 * This function is obsolete and should never be used.
984 985 986 987
 * Use av_read_frame() instead.
 *
 * @param s media file handle
 * @param pkt is filled
D
Diego Biurrun 已提交
988
 * @return 0 if OK, AVERROR_xxx on error
989
 */
F
Fabrice Bellard 已提交
990
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
991 992

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

/**
1014
 * Seek to the keyframe at timestamp.
1015 1016 1017 1018
 * '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 已提交
1019 1020
 * @param timestamp Timestamp in AVStream.time_base units
 *        or, if no stream is specified, in AV_TIME_BASE units.
1021 1022 1023
 * @param flags flags which select direction and seeking mode
 * @return >= 0 on success
 */
1024 1025
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
                  int flags);
1026

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

1055
/**
1056
 * Start playing a network-based stream (e.g. RTSP stream) at the
D
Diego Biurrun 已提交
1057
 * current position.
1058
 */
1059
int av_read_play(AVFormatContext *s);
1060 1061

/**
1062
 * Pause a network-based stream (e.g. RTSP stream).
1063 1064 1065
 *
 * Use av_read_play() to resume it.
 */
1066
int av_read_pause(AVFormatContext *s);
1067

1068
/**
1069
 * Free a AVFormatContext allocated by av_open_input_stream.
1070 1071 1072 1073
 * @param s context to free
 */
void av_close_input_stream(AVFormatContext *s);

1074
/**
1075
 * Close a media file (but not its codecs).
1076 1077 1078
 *
 * @param s media file handle
 */
F
Fabrice Bellard 已提交
1079
void av_close_input_file(AVFormatContext *s);
1080 1081

/**
1082
 * Add a new stream to a media file.
1083 1084 1085 1086 1087 1088
 *
 * 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 已提交
1089
 * @param id file-format-dependent stream ID
1090
 */
1091
AVStream *av_new_stream(AVFormatContext *s, int id);
1092
AVProgram *av_new_program(AVFormatContext *s, int id);
1093

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

1110
/**
1111
 * Set the pts for a given stream.
1112 1113 1114 1115 1116 1117 1118
 *
 * @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)
 */
1119
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1120
                     unsigned int pts_num, unsigned int pts_den);
F
Fabrice Bellard 已提交
1121

1122 1123
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
D
Diego Biurrun 已提交
1124
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1125
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1126

1127
int av_find_default_stream_index(AVFormatContext *s);
1128 1129

/**
1130
 * Get the index for a specific timestamp.
D
Diego Biurrun 已提交
1131 1132 1133
 * @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 >=
1134 1135 1136
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
 * @return < 0 if no such timestamp could be found
 */
1137
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1138

1139
/**
1140
 * Ensure the index uses less memory than the maximum specified in
1141
 * AVFormatContext.max_index_size by discarding entries if it grows
1142 1143 1144 1145 1146 1147
 * 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);

1148
/**
1149
 * Add an index entry into a sorted list. Update the entry if the list
D
Diego Biurrun 已提交
1150
 * already contains it.
1151
 *
D
Diego Biurrun 已提交
1152
 * @param timestamp timestamp in the time base of the given stream
1153
 */
1154 1155
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
                       int size, int distance, int flags);
1156 1157

/**
1158
 * Perform a binary search using av_index_search_timestamp() and
1159
 * AVInputFormat.read_timestamp().
1160 1161
 * This is not supposed to be called directly by a user application,
 * but by demuxers.
1162 1163 1164
 * @param target_ts target timestamp in the time base of the given stream
 * @param stream_index stream number
 */
1165 1166
int av_seek_frame_binary(AVFormatContext *s, int stream_index,
                         int64_t target_ts, int flags);
1167 1168

/**
1169
 * Update cur_dts of all streams based on the given timestamp and AVStream.
1170
 *
D
Diego Biurrun 已提交
1171 1172
 * 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).
1173 1174 1175
 * @param timestamp new dts expressed in time_base of param ref_st
 * @param ref_st reference stream giving time_base of param timestamp
 */
1176
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1177 1178

/**
1179
 * Perform a binary search using read_timestamp().
1180 1181
 * This is not supposed to be called directly by a user application,
 * but by demuxers.
1182 1183 1184
 * @param target_ts target timestamp in the time base of the given stream
 * @param stream_index stream number
 */
1185 1186 1187 1188 1189 1190
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 ));
1191

1192
/** media file output */
1193
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1194

M
Måns Rullgård 已提交
1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
/**
 * 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);

1221
/**
1222
 * Allocate the stream private data and write the stream header to an
D
Diego Biurrun 已提交
1223
 * output media file.
1224 1225
 *
 * @param s media file handle
D
Diego Biurrun 已提交
1226
 * @return 0 if OK, AVERROR_xxx on error
1227
 */
1228
int av_write_header(AVFormatContext *s);
1229 1230

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

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

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

1279
/**
1280
 * Write the stream trailer to an output media file and free the
1281
 * file private data.
1282
 *
1283 1284
 * May only be called after a successful call to av_write_header.
 *
1285
 * @param s media file handle
D
Diego Biurrun 已提交
1286
 * @return 0 if OK, AVERROR_xxx on error
1287
 */
1288
int av_write_trailer(AVFormatContext *s);
F
Fabrice Bellard 已提交
1289 1290

void dump_format(AVFormatContext *ic,
1291
                 int index,
F
Fabrice Bellard 已提交
1292 1293
                 const char *url,
                 int is_output);
1294

1295
#if LIBAVFORMAT_VERSION_MAJOR < 53
1296
/**
1297
 * Parse width and height out of string str.
1298
 * @deprecated Use av_parse_video_frame_size instead.
1299
 */
1300 1301
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
                                          const char *str);
1302 1303

/**
1304
 * Convert framerate from a string to a fraction.
1305
 * @deprecated Use av_parse_video_frame_rate instead.
1306
 */
1307 1308
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
                                          const char *arg);
1309
#endif
1310 1311

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

1340
/** Get the current time in microseconds. */
1341
int64_t av_gettime(void);
F
Fabrice Bellard 已提交
1342

D
Diego Biurrun 已提交
1343
/* ffm-specific for ffserver */
F
Fabrice Bellard 已提交
1344
#define FFM_PACKET_SIZE 4096
1345
int64_t ffm_read_write_index(int fd);
1346
int ffm_write_write_index(int fd, int64_t pos);
1347
void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
F
Fabrice Bellard 已提交
1348

1349
/**
1350
 * Attempt to find a specific tag in a URL.
1351 1352 1353 1354
 *
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
 * Return 1 if found.
 */
F
Fabrice Bellard 已提交
1355 1356
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);

1357
/**
1358
 * Return in 'buf' the path with '%d' replaced by a number.
D
Diego Biurrun 已提交
1359
 *
1360 1361 1362 1363 1364 1365
 * 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 已提交
1366
 * @param number frame number
D
Diego Biurrun 已提交
1367
 * @return 0 if OK, -1 on format error
1368
 */
1369 1370
int av_get_frame_filename(char *buf, int buf_size,
                          const char *path, int number);
1371 1372

/**
1373
 * Check whether filename actually is a numbered sequence generator.
1374 1375
 *
 * @param filename possible numbered sequence string
D
Diego Biurrun 已提交
1376
 * @return 1 if a valid numbered sequence string, 0 otherwise
1377
 */
1378
int av_filename_number_test(const char *filename);
1379

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

1396
/**
1397
 * Return a positive value if the given filename has one of the given
1398 1399 1400 1401 1402 1403
 * extensions, 0 otherwise.
 *
 * @param extensions a comma-separated list of filename extensions
 */
int av_match_ext(const char *filename, const char *extensions);

1404
#endif /* AVFORMAT_AVFORMAT_H */