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

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

24
#define LIBAVFORMAT_VERSION_MAJOR 52
25
#define LIBAVFORMAT_VERSION_MINOR 78
J
Josh Allmann 已提交
26
#define LIBAVFORMAT_VERSION_MICRO  3
27

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

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

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

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

61
/**
62
 * Return the libavformat build-time configuration.
63
 */
64
const char *avformat_configuration(void);
65 66

/**
67
 * Return the libavformat license.
68
 */
69
const char *avformat_license(void);
70

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

#include "avio.h"

A
Aurelien Jacobs 已提交
77 78
struct AVFormatContext;

79 80

/*
81 82
 * Public Metadata API.
 * The metadata API allows libavformat to export metadata tags to a client
83 84 85
 * 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.
86 87 88 89 90 91 92 93 94
 * 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.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
 * 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.
133 134
 */

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

typedef struct {
    char *key;
    char *value;
144
}AVMetadataTag;
145

A
Aurelien Jacobs 已提交
146
typedef struct AVMetadata AVMetadata;
A
Aurelien Jacobs 已提交
147
typedef struct AVMetadataConv AVMetadataConv;
148 149

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

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

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

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

197
/**
198
 * Free all the memory allocated for an AVMetadata struct.
199 200 201
 */
void av_metadata_free(AVMetadata **m);

202

F
Fabrice Bellard 已提交
203 204
/* packet functions */

205 206

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

F
Fabrice Bellard 已提交
216

F
Fabrice Bellard 已提交
217 218 219
/*************************************************/
/* fractional numbers for exact pts handling */

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

F
Fabrice Bellard 已提交
228
/*************************************************/
229
/* input/output formats */
F
Fabrice Bellard 已提交
230

231 232
struct AVCodecTag;

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

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

typedef struct AVFormatParameters {
246
    AVRational time_base;
F
Fabrice Bellard 已提交
247 248 249 250
    int sample_rate;
    int channels;
    int width;
    int height;
251
    enum PixelFormat pix_fmt;
D
Diego Biurrun 已提交
252 253 254 255
    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
256
                                            stream packet (only meaningful if
D
Diego Biurrun 已提交
257 258 259
                                            mpeg2ts_raw is TRUE). */
    unsigned int initial_pause:1;       /**< Do not begin to play the stream
                                            immediately (RTSP only). */
260
    unsigned int prealloced_context:1;
261
#if LIBAVFORMAT_VERSION_INT < (53<<16)
262 263
    enum CodecID video_codec_id;
    enum CodecID audio_codec_id;
264
#endif
F
Fabrice Bellard 已提交
265 266
} AVFormatParameters;

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

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

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

317 318
    enum CodecID subtitle_codec; /**< default subtitle codec */

319
    const AVMetadataConv *metadata_conv;
A
Aurelien Jacobs 已提交
320

321 322 323
    /* private fields */
    struct AVOutputFormat *next;
} AVOutputFormat;
F
Fabrice Bellard 已提交
324

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

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

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

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

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

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

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

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

    /**
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
     */
F
Fabrice Bellard 已提交
398
    int flags;
399 400 401 402 403 404

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

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

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

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

424
    const struct AVCodecTag * const *codec_tag;
425

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

434
    const AVMetadataConv *metadata_conv;
A
Aurelien Jacobs 已提交
435

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

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

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

457 458 459 460 461 462
#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
463 464 465 466 467 468

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

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

493
    /* internal data used in av_find_stream_info() */
494
    int64_t first_dts;
495 496 497 498

    /**
     * encoding: pts generation when outputting stream
     */
499
    struct AVFrac pts;
500 501

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

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

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

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

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

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

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

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

555 556
#if LIBAVFORMAT_VERSION_INT < (53<<16)
    int64_t unused[4+1];
557
#endif
558

559
#if FF_API_OLD_METADATA
560
    char *filename; /**< source filename of the stream */
A
Aurelien Jacobs 已提交
561
#endif
562

D
Diego Biurrun 已提交
563
    int disposition; /**< AV_DISPOSITION_* bit field */
564 565

    AVProbeData probe_data;
566 567
#define MAX_REORDER_DELAY 16
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
568 569 570 571 572 573 574

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

A
Aurelien Jacobs 已提交
576
    AVMetadata *metadata;
577

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

    // 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;
593 594 595 596 597

    /**
     * Number of packets to buffer for codec probing
     * NOT PART OF PUBLIC API
     */
598
#define MAX_PROBE_PACKETS 2500
599
    int probe_packets;
600 601

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

    /**
     * Average framerate
     */
    AVRational avg_frame_rate;
611 612 613 614 615

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

618 619
#define AV_PROGRAM_RUNNING 1

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

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

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

652
#if FF_API_MAX_STREAMS
F
Fabrice Bellard 已提交
653
#define MAX_STREAMS 20
654
#endif
F
Fabrice Bellard 已提交
655

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

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

695 696 697 698 699
    /**
     * Decoding: position of the first frame of the component, in
     * AV_TIME_BASE fractional seconds. NEVER set this value directly:
     * It is deduced from the AVStream values.
     */
700
    int64_t start_time;
701 702 703 704 705 706 707

    /**
     * Decoding: duration of the stream, in AV_TIME_BASE fractional
     * seconds. Only set this value if you know none of the individual stream
     * durations and also dont set any of them. This is deduced from the
     * AVStream values if not set.
     */
708
    int64_t duration;
709 710 711 712

    /**
     * decoding: total file size, 0 if unknown
     */
713
    int64_t file_size;
714 715 716 717 718 719

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

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

    /* av_seek_frame() support */
731
    int64_t data_offset; /**< offset of the first packet */
732
    int index_built;
733

734
    int mux_rate;
735
    unsigned int packet_size;
736 737
    int preload;
    int max_delay;
738

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

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

    int loop_input;
756 757 758 759

    /**
     * decoding: size of data to probe; encoding: unused.
     */
760
    unsigned int probesize;
761 762

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

    const uint8_t *key;
    int keylen;
770 771 772

    unsigned int nb_programs;
    AVProgram **programs;
M
Michael Niedermayer 已提交
773 774 775

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

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

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

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

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

810
    unsigned int nb_chapters;
811
    AVChapter **chapters;
812 813

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

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

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

A
Aurelien Jacobs 已提交
830
    AVMetadata *metadata;
831 832 833 834 835

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

    /**
     * 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 已提交
847 848 849 850 851 852 853
} AVFormatContext;

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

854
#if LIBAVFORMAT_VERSION_INT < (53<<16)
855 856
extern AVInputFormat *first_iformat;
extern AVOutputFormat *first_oformat;
857 858
#endif

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

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

873
enum CodecID av_guess_image2_codec(const char *filename);
874

875 876
/* XXX: Use automatic init with either ELF sections or C file parser */
/* modules. */
F
Fabrice Bellard 已提交
877

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

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

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

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

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

/**
929
 * Send a nice hexadecimal dump of a buffer to the log.
930 931 932 933 934 935 936 937 938 939 940 941 942
 *
 * @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);

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

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

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

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

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

992
/* media file input */
993 994

/**
995
 * Find AVInputFormat based on the short name of the input format.
996
 */
997
AVInputFormat *av_find_input_format(const char *short_name);
998 999

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

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

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

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

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

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

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

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

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

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

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

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

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

1162
/**
1163
 * Free a AVFormatContext allocated by av_open_input_stream.
1164 1165 1166 1167
 * @param s context to free
 */
void av_close_input_stream(AVFormatContext *s);

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

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

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

1204
/**
1205
 * Set the pts for a given stream.
1206 1207 1208 1209 1210 1211 1212
 *
 * @param s stream
 * @param pts_wrap_bits number of bits effectively used by the pts
 *        (used for wrap control, 33 is the value for MPEG)
 * @param pts_num numerator to convert to seconds (MPEG: 1)
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
 */
1213
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1214
                     unsigned int pts_num, unsigned int pts_den);
F
Fabrice Bellard 已提交
1215

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

1221
int av_find_default_stream_index(AVFormatContext *s);
1222 1223

/**
1224
 * Get the index for a specific timestamp.
D
Diego Biurrun 已提交
1225 1226 1227
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
 *                 to the timestamp which is <= the requested one, if backward
 *                 is 0, then it will be >=
1228 1229 1230
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
 * @return < 0 if no such timestamp could be found
 */
1231
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1232

1233
/**
1234
 * Ensure the index uses less memory than the maximum specified in
1235
 * AVFormatContext.max_index_size by discarding entries if it grows
1236 1237 1238 1239 1240 1241
 * 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);

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

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

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

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

1286 1287 1288
/**
 * media file output
 */
1289
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1290

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

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

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

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

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

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

void dump_format(AVFormatContext *ic,
1387
                 int index,
F
Fabrice Bellard 已提交
1388 1389
                 const char *url,
                 int is_output);
1390

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

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

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

1436 1437 1438
/**
 * Get the current time in microseconds.
 */
1439
int64_t av_gettime(void);
F
Fabrice Bellard 已提交
1440

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

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

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

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

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

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

1502
#endif /* AVFORMAT_AVFORMAT_H */