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

21 22
#ifndef AVFORMAT_AVFORMAT_H
#define AVFORMAT_AVFORMAT_H
Fabrice Bellard's avatar
Fabrice Bellard committed
23

24

25
/**
26
 * Return the LIBAVFORMAT_VERSION_INT constant.
27 28 29
 */
unsigned avformat_version(void);

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

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

40
#include <time.h>
Zdenek Kabelac's avatar
Zdenek Kabelac committed
41
#include <stdio.h>  /* FILE */
42
#include "libavcodec/avcodec.h"
Fabrice Bellard's avatar
Fabrice Bellard committed
43 44

#include "avio.h"
45
#include "libavformat/version.h"
Fabrice Bellard's avatar
Fabrice Bellard committed
46

47 48
struct AVFormatContext;

49 50

/*
51 52
 * Public Metadata API.
 * The metadata API allows libavformat to export metadata tags to a client
53 54 55
 * 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.
56 57 58 59 60 61 62 63 64
 * 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.
65 66 67 68 69 70 71 72 73 74 75 76
 * 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".
 *
77 78 79
 * 4. Demuxers attempt to export metadata in a generic format, however tags
 *    with no generic equivalents are left as they are stored in the container.
 *    Follows a list of generic tag names:
80 81 82 83 84 85 86 87
 *
 * 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.
88
 * creation_time-- date when the file was created, preferably in ISO 8601.
89 90 91 92 93 94 95
 * 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
96 97
 *                 in ISO 639-2 format. Multiple languages can be specified by
 *                 separating them with commas.
98 99 100 101
 * 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.
102 103
 * service_name     -- name of the service in broadcasting (channel name).
 * service_provider -- name of the service provider in broadcasting.
104 105
 * title        -- name of the work.
 * track        -- number of this work in the set, can be in form current/total.
106
 * variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
107 108
 */

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

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

120
typedef struct AVMetadata AVMetadata;
121
#if FF_API_OLD_METADATA2
122
typedef struct AVMetadataConv AVMetadataConv;
123
#endif
124 125

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

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

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

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

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

171

Fabrice Bellard's avatar
Fabrice Bellard committed
172 173
/* packet functions */

174 175

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

Fabrice Bellard's avatar
Fabrice Bellard committed
185

186
/**
187 188
 * Read data and append it to the current content of the AVPacket.
 * If pkt->size is 0 this is identical to av_get_packet.
189 190 191 192 193 194 195 196 197 198
 * Note that this uses av_grow_packet and thus involves a realloc
 * which is inefficient. Thus this function should only be used
 * when there is no reasonable way to know (an upper bound of)
 * the final size.
 *
 * @param pkt packet
 * @param size amount of data to read
 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
 *         will not be lost even if an error occurs.
 */
199
int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
200

Fabrice Bellard's avatar
Fabrice Bellard committed
201 202 203
/*************************************************/
/* fractional numbers for exact pts handling */

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

Fabrice Bellard's avatar
Fabrice Bellard committed
212
/*************************************************/
213
/* input/output formats */
Fabrice Bellard's avatar
Fabrice Bellard committed
214

215 216
struct AVCodecTag;

217 218 219
/**
 * This structure contains the data a format has to probe a file.
 */
220
typedef struct AVProbeData {
221
    const char *filename;
222 223
    unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
    int buf_size;       /**< Size of buf except extra allocated bytes */
224 225
} AVProbeData;

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

typedef struct AVFormatParameters {
230
    AVRational time_base;
Fabrice Bellard's avatar
Fabrice Bellard committed
231 232 233 234
    int sample_rate;
    int channels;
    int width;
    int height;
235
    enum PixelFormat pix_fmt;
Diego Biurrun's avatar
Diego Biurrun committed
236 237 238 239
    int channel; /**< Used to select DV channel. */
    const char *standard; /**< TV standard, NTSC, PAL, SECAM */
    unsigned int mpeg2ts_raw:1;  /**< Force raw MPEG-2 transport stream output, if possible. */
    unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
240
                                            stream packet (only meaningful if
Diego Biurrun's avatar
Diego Biurrun committed
241 242 243
                                            mpeg2ts_raw is TRUE). */
    unsigned int initial_pause:1;       /**< Do not begin to play the stream
                                            immediately (RTSP only). */
244
    unsigned int prealloced_context:1;
Fabrice Bellard's avatar
Fabrice Bellard committed
245 246
} AVFormatParameters;

247
//! Demuxer will use avio_open, no opened file should be provided by the caller.
248
#define AVFMT_NOFILE        0x0001
Diego Biurrun's avatar
Diego Biurrun committed
249 250 251 252 253 254 255
#define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
#define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
#define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
                                      raw picture data. */
#define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
#define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
256
#define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
257
#define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
258
#define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
259
#define AVFMT_NOSTREAMS     0x1000 /**< Format does not require any streams */
260 261
#define AVFMT_NOBINSEARCH   0x2000 /**< Format does not allow to fallback to binary search via read_timestamp */
#define AVFMT_NOGENSEARCH   0x4000 /**< Format does not allow to fallback to generic search */
262 263

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

    void *dummy;

292 293
    int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
                             AVPacket *in, int flush);
294 295

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

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

303
#if FF_API_OLD_METADATA2
304
    const AVMetadataConv *metadata_conv;
305
#endif
306

307 308
    const AVClass *priv_class; ///< AVClass for the private context

309 310 311
    /* private fields */
    struct AVOutputFormat *next;
} AVOutputFormat;
Fabrice Bellard's avatar
Fabrice Bellard committed
312

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

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

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

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

    /**
     * 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.
     */
Fabrice Bellard's avatar
Fabrice Bellard committed
345 346
    int (*read_header)(struct AVFormatContext *,
                       AVFormatParameters *ap);
347 348 349 350

    /**
     * Read one packet and put it in 'pkt'. pts and flags are also
     * set. 'av_new_stream' can be called only if the flag
351 352
     * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
     * background thread).
353 354 355 356
     * @return 0 on success, < 0 on error.
     *         When returning an error, pkt must not have been allocated
     *         or must be freed before returning
     */
Fabrice Bellard's avatar
Fabrice Bellard committed
357
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
358 359 360 361 362

    /**
     * Close the stream. The AVFormatContext and AVStreams are not
     * freed by this function
     */
Fabrice Bellard's avatar
Fabrice Bellard committed
363
    int (*read_close)(struct AVFormatContext *);
364

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

    /**
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
     */
Fabrice Bellard's avatar
Fabrice Bellard committed
387
    int flags;
388 389 390 391 392 393

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

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

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

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

413
    const struct AVCodecTag * const *codec_tag;
414

415
    /**
416
     * Seek to timestamp ts.
417 418 419 420
     * 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.
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
421
    int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
422

423
#if FF_API_OLD_METADATA2
424
    const AVMetadataConv *metadata_conv;
425
#endif
426

427 428
    const AVClass *priv_class; ///< AVClass for the private context

429 430 431
    /* private fields */
    struct AVInputFormat *next;
} AVInputFormat;
Fabrice Bellard's avatar
Fabrice Bellard committed
432

433 434 435
enum AVStreamParseType {
    AVSTREAM_PARSE_NONE,
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
Diego Biurrun's avatar
Diego Biurrun committed
436
    AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
437
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
438
    AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
439 440
};

441 442 443 444
typedef struct AVIndexEntry {
    int64_t pos;
    int64_t timestamp;
#define AVINDEX_KEYFRAME 0x0001
445
    int flags:2;
Diego Biurrun's avatar
Diego Biurrun committed
446 447
    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. */
448 449
} AVIndexEntry;

450 451 452 453 454 455
#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
456 457 458 459 460 461

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

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

489
    /* internal data used in av_find_stream_info() */
490
    int64_t first_dts;
491 492 493 494

    /**
     * encoding: pts generation when outputting stream
     */
495
    struct AVFrac pts;
496 497

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

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

517
    /**
Diego Biurrun's avatar
Diego Biurrun committed
518 519 520
     * 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.
521
     * This may be undefined (AV_NOPTS_VALUE).
522 523
     * @note The ASF header does NOT contain a correct start_time the ASF
     * demuxer must NOT set this.
524
     */
525
    int64_t start_time;
526

527
    /**
Diego Biurrun's avatar
Diego Biurrun committed
528
     * Decoding: duration of the stream, in stream time base.
529
     * If a source file does not specify a duration, but does specify
Diego Biurrun's avatar
Diego Biurrun committed
530
     * a bitrate, this value will be estimated from bitrate and file size.
531
     */
532
    int64_t duration;
533 534

    /* av_read_frame() support */
535
    enum AVStreamParseType need_parsing;
536
    struct AVCodecParserContext *parser;
537

538
    int64_t cur_dts;
Michael Niedermayer's avatar
Michael Niedermayer committed
539 540
    int last_IP_duration;
    int64_t last_IP_pts;
541
    /* av_seek_frame() support */
Diego Biurrun's avatar
Diego Biurrun committed
542 543
    AVIndexEntry *index_entries; /**< Only used if the format does not
                                    support seeking natively. */
544
    int nb_index_entries;
545
    unsigned int index_entries_allocated_size;
546

547
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
548

Diego Biurrun's avatar
Diego Biurrun committed
549
    int disposition; /**< AV_DISPOSITION_* bit field */
550 551

    AVProbeData probe_data;
552 553
#define MAX_REORDER_DELAY 16
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
554 555 556 557 558 559 560

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

562
    AVMetadata *metadata;
563

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

    // 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;
579 580 581 582 583

    /**
     * Number of packets to buffer for codec probing
     * NOT PART OF PUBLIC API
     */
584
#define MAX_PROBE_PACKETS 2500
585
    int probe_packets;
586 587

    /**
588
     * last packet in packet_buffer for this stream when muxing.
589 590
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
     */
591
    struct AVPacketList *last_in_packet_buffer;
592 593 594 595 596

    /**
     * Average framerate
     */
    AVRational avg_frame_rate;
597 598 599 600 601

    /**
     * Number of frames that have been demuxed during av_find_stream_info()
     */
    int codec_info_nb_frames;
602 603 604 605 606 607 608 609 610 611 612 613

    /**
     * Stream informations used internally by av_find_stream_info()
     */
#define MAX_STD_TIMEBASES (60*12+5)
    struct {
        int64_t last_dts;
        int64_t duration_gcd;
        int duration_count;
        double duration_error[MAX_STD_TIMEBASES];
        int64_t codec_info_duration;
    } *info;
614 615 616 617 618 619

    /**
     * flag to indicate that probing is requested
     * NOT PART OF PUBLIC API
     */
    int request_probe;
Fabrice Bellard's avatar
Fabrice Bellard committed
620 621
} AVStream;

622 623
#define AV_PROGRAM_RUNNING 1

624 625
/**
 * New fields can be added to the end with minor version bumps.
Diego Biurrun's avatar
Diego Biurrun committed
626
 * Removal, reordering and changes to existing fields require a major
627
 * version bump.
Diego Biurrun's avatar
Diego Biurrun committed
628
 * sizeof(AVProgram) must not be used outside libav*.
629
 */
630 631 632 633
typedef struct AVProgram {
    int            id;
    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;
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 {
Diego Biurrun's avatar
Diego Biurrun committed
643 644
    int id;                 ///< unique ID to identify the chapter
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
645
    int64_t start, end;     ///< chapter start/end time in time_base units
646
    AVMetadata *metadata;
647 648
} AVChapter;

649
/**
Diego Biurrun's avatar
Diego Biurrun committed
650
 * Format I/O context.
651
 * New fields can be added to the end with minor version bumps.
Diego Biurrun's avatar
Diego Biurrun committed
652
 * Removal, reordering and changes to existing fields require a major
653
 * version bump.
Diego Biurrun's avatar
Diego Biurrun committed
654
 * sizeof(AVFormatContext) must not be used outside libav*.
655
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
656
typedef struct AVFormatContext {
657
    const AVClass *av_class; /**< Set by avformat_alloc_context. */
Diego Biurrun's avatar
Diego Biurrun committed
658
    /* Can only be iformat or oformat, not both at the same time. */
659 660
    struct AVInputFormat *iformat;
    struct AVOutputFormat *oformat;
Fabrice Bellard's avatar
Fabrice Bellard committed
661
    void *priv_data;
662
    AVIOContext *pb;
663
    unsigned int nb_streams;
664
    AVStream **streams;
665
    char filename[1024]; /**< input or output filename */
Fabrice Bellard's avatar
Fabrice Bellard committed
666
    /* stream info */
667
    int64_t timestamp;
668

Diego Biurrun's avatar
Diego Biurrun committed
669 670
    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
    /* private data for pts handling (do not modify directly). */
671 672 673 674 675
    /**
     * This buffer is only needed when packets were already buffered but
     * not decoded, for example to get the codec parameters in MPEG
     * streams.
     */
676 677
    struct AVPacketList *packet_buffer;

678 679 680 681 682
    /**
     * 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.
     */
683
    int64_t start_time;
684 685 686 687 688 689 690

    /**
     * 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.
     */
691
    int64_t duration;
692 693 694 695

    /**
     * decoding: total file size, 0 if unknown
     */
696
    int64_t file_size;
697 698 699 700

    /**
     * Decoding: total stream bitrate in bit/s, 0 if not
     * available. Never set it directly if the file_size and the
701
     * duration are known as FFmpeg can compute it automatically.
702
     */
703
    int bit_rate;
704 705 706 707 708

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

    /* av_seek_frame() support */
709
    int64_t data_offset; /**< offset of the first packet */
710

711
    int mux_rate;
712
    unsigned int packet_size;
713 714
    int preload;
    int max_delay;
715

716 717
#define AVFMT_NOOUTPUTLOOP -1
#define AVFMT_INFINITEOUTPUTLOOP 0
718 719 720
    /**
     * number of times to loop output in formats that support it
     */
721
    int loop_output;
722

723
    int flags;
724
#define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
Diego Biurrun's avatar
Diego Biurrun committed
725 726
#define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
727
#define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
728 729
#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
730
#define AVFMT_FLAG_RTP_HINT     0x0040 ///< Add RTP hinting to the output file
731
#define AVFMT_FLAG_MP4A_LATM    0x0080 ///< Enable RTP MP4A-LATM payload
732
#define AVFMT_FLAG_SORT_DTS    0x10000 ///< try to interleave outputted packets by dts (using this flag can slow demuxing down)
733
#define AVFMT_FLAG_PRIV_OPT    0x20000 ///< Enable use of private options by delaying codec open (this could be made default once all code is converted)
734
#define AVFMT_FLAG_KEEP_SIDE_DATA 0x40000 ///< Dont merge side data but keep it seperate.
735
    int loop_input;
736 737 738 739

    /**
     * decoding: size of data to probe; encoding: unused.
     */
740
    unsigned int probesize;
741 742

    /**
Diego Biurrun's avatar
Diego Biurrun committed
743 744
     * Maximum time (in AV_TIME_BASE units) during which the input should
     * be analyzed in av_find_stream_info().
745 746
     */
    int max_analyze_duration;
747 748 749

    const uint8_t *key;
    int keylen;
750 751 752

    unsigned int nb_programs;
    AVProgram **programs;
753 754 755

    /**
     * Forced video codec_id.
Diego Biurrun's avatar
Diego Biurrun committed
756
     * Demuxing: Set by user.
757 758
     */
    enum CodecID video_codec_id;
759

760 761
    /**
     * Forced audio codec_id.
Diego Biurrun's avatar
Diego Biurrun committed
762
     * Demuxing: Set by user.
763 764
     */
    enum CodecID audio_codec_id;
765

766 767
    /**
     * Forced subtitle codec_id.
Diego Biurrun's avatar
Diego Biurrun committed
768
     * Demuxing: Set by user.
769 770
     */
    enum CodecID subtitle_codec_id;
771 772

    /**
773 774
     * 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
775 776
     * needed to maintain a smaller size. This can lead to slower or less
     * accurate seeking (depends on demuxer).
Diego Biurrun's avatar
Diego Biurrun committed
777
     * Demuxers for which a full in-memory index is mandatory will ignore
778 779 780 781 782
     * this.
     * muxing  : unused
     * demuxing: set by user
     */
    unsigned int max_index_size;
783 784

    /**
Ramiro Polla's avatar
Ramiro Polla committed
785
     * Maximum amount of memory in bytes to use for buffering frames
Diego Biurrun's avatar
Diego Biurrun committed
786
     * obtained from realtime capture devices.
787 788
     */
    unsigned int max_picture_buffer;
789

790
    unsigned int nb_chapters;
791
    AVChapter **chapters;
792 793

    /**
Diego Biurrun's avatar
Diego Biurrun committed
794
     * Flags to enable debugging.
795 796 797
     */
    int debug;
#define FF_FDEBUG_TS        0x0001
798 799

    /**
Diego Biurrun's avatar
Diego Biurrun committed
800
     * Raw packets from the demuxer, prior to parsing and decoding.
801 802 803 804 805
     * 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;
806 807 808
    struct AVPacketList *raw_packet_buffer_end;

    struct AVPacketList *packet_buffer_end;
809

810
    AVMetadata *metadata;
811 812 813 814 815

    /**
     * Remaining size available for raw_packet_buffer, in bytes.
     * NOT PART OF PUBLIC API
     */
816
#define RAW_PACKET_BUFFER_SIZE 2500000
817
    int raw_packet_buffer_remaining_size;
818 819 820 821 822 823 824 825 826

    /**
     * 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;
Fabrice Bellard's avatar
Fabrice Bellard committed
827 828 829 830 831 832 833
} AVFormatContext;

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

834 835
/**
 * If f is NULL, returns the first registered input format,
836
 * if f is non-NULL, returns the next registered input format after f
837 838
 * or NULL if f is the last one.
 */
839
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
840 841 842

/**
 * If f is NULL, returns the first registered output format,
843
 * if f is non-NULL, returns the next registered output format after f
844 845
 * or NULL if f is the last one.
 */
846
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
Fabrice Bellard's avatar
Fabrice Bellard committed
847

848 849 850
#if FF_API_GUESS_IMG2_CODEC
attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
#endif
851

852 853
/* XXX: Use automatic init with either ELF sections or C file parser */
/* modules. */
Fabrice Bellard's avatar
Fabrice Bellard committed
854

855 856 857
/* utils.c */
void av_register_input_format(AVInputFormat *format);
void av_register_output_format(AVOutputFormat *format);
858 859

/**
860 861
 * Return the output format in the list of registered output formats
 * which best matches the provided parameters, or return NULL if
862 863 864 865 866 867 868 869 870
 * 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
 */
871
AVOutputFormat *av_guess_format(const char *short_name,
Stefano Sabatini's avatar
Stefano Sabatini committed
872 873
                                const char *filename,
                                const char *mime_type);
874 875

/**
876
 * Guess the codec ID based upon muxer and filename.
877
 */
878
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
879
                            const char *filename, const char *mime_type,
880
                            enum AVMediaType type);
Fabrice Bellard's avatar
Fabrice Bellard committed
881

882
/**
883
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
884 885
 *
 * @param f The file stream pointer where the dump should be sent to.
886 887
 * @param buf buffer
 * @param size buffer size
888
 *
889
 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
890
 */
891
void av_hex_dump(FILE *f, uint8_t *buf, int size);
892 893

/**
894
 * Send a nice hexadecimal dump of a buffer to the log.
895 896 897 898 899 900 901 902
 *
 * @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
 *
903
 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
904 905 906 907
 */
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);

/**
908
 * Send a nice dump of a packet to the specified file stream.
909 910
 *
 * @param f The file stream pointer where the dump should be sent to.
911
 * @param pkt packet to dump
Diego Biurrun's avatar
Diego Biurrun committed
912
 * @param dump_payload True if the payload must be displayed, too.
913
 * @param st AVStream that the packet belongs to
914
 */
915 916
void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);

Fabrice Bellard's avatar
Fabrice Bellard committed
917

918
/**
919
 * Send a nice dump of a packet to the log.
920 921 922 923 924 925
 *
 * @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
Diego Biurrun's avatar
Diego Biurrun committed
926
 * @param dump_payload True if the payload must be displayed, too.
927
 * @param st AVStream that the packet belongs to
928
 */
929 930 931
void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
                      AVStream *st);

932 933
#if FF_API_PKT_DUMP
attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
934 935
attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
                                          int dump_payload);
936
#endif
937

938
/**
939
 * Initialize libavformat and register all the muxers, demuxers and
940 941 942 943 944
 * 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()
945
 * @see av_register_protocol()
946
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
947
void av_register_all(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
948

949
/**
950
 * Get the CodecID for the given codec tag tag.
951 952 953 954 955
 * 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
 */
956
enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
957 958

/**
959
 * Get the codec tag for the given codec id id.
960 961 962 963 964
 * 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
 */
965
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
966

967
/* media file input */
968 969

/**
970
 * Find AVInputFormat based on the short name of the input format.
971
 */
972
AVInputFormat *av_find_input_format(const char *short_name);
973 974

/**
975
 * Guess the file format.
976
 *
Diego Biurrun's avatar
Diego Biurrun committed
977 978
 * @param is_opened Whether the file is already opened; determines whether
 *                  demuxers with or without AVFMT_NOFILE are probed.
979
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
980
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
981

982
/**
983
 * Guess the file format.
984 985 986
 *
 * @param is_opened Whether the file is already opened; determines whether
 *                  demuxers with or without AVFMT_NOFILE are probed.
987 988 989 990
 * @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
991 992 993 994
 *                  to retry with a larger probe buffer.
 */
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);

995 996 997 998 999 1000 1001 1002 1003
/**
 * Guess the file format.
 *
 * @param is_opened Whether the file is already opened; determines whether
 *                  demuxers with or without AVFMT_NOFILE are probed.
 * @param score_ret The score of the best detection.
 */
AVInputFormat *av_probe_input_format3(AVProbeData *pd, int is_opened, int *score_ret);

1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
/**
 * Probe a bytestream to determine the input format. Each time a probe returns
 * with a score that is too low, the probe buffer size is increased and another
 * attempt is made. When the maximum probe size is reached, the input format
 * with the highest score is returned.
 *
 * @param pb the bytestream to probe
 * @param fmt the input format is put here
 * @param filename the filename of the stream
 * @param logctx the log context
 * @param offset the offset within the bytestream to probe from
 * @param max_probe_size the maximum probe buffer size (zero for default)
 * @return 0 in case of success, a negative value corresponding to an
 * AVERROR code otherwise
 */
1019
int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1020 1021 1022
                          const char *filename, void *logctx,
                          unsigned int offset, unsigned int max_probe_size);

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

/**
1032
 * Open a media file as input. The codecs are not opened. Only the file
1033 1034
 * header (if present) is read.
 *
Diego Biurrun's avatar
Diego Biurrun committed
1035 1036 1037
 * @param ic_ptr The opened media file handle is put here.
 * @param filename filename to open
 * @param fmt If non-NULL, force the file format to use.
1038
 * @param buf_size optional buffer size (zero if default is OK)
1039 1040
 * @param ap Additional parameters needed when opening the file
 *           (NULL if default).
Diego Biurrun's avatar
Diego Biurrun committed
1041
 * @return 0 if OK, AVERROR_xxx otherwise
1042
 */
1043
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1044 1045 1046
                       AVInputFormat *fmt,
                       int buf_size,
                       AVFormatParameters *ap);
1047

1048 1049
int av_demuxer_open(AVFormatContext *ic, AVFormatParameters *ap);

1050
/**
1051
 * Allocate an AVFormatContext.
1052 1053
 * avformat_free_context() can be used to free the context and everything
 * allocated by the framework within it.
1054
 */
1055
AVFormatContext *avformat_alloc_context(void);
1056

1057
#if FF_API_ALLOC_OUTPUT_CONTEXT
1058
/**
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
 * @deprecated deprecated in favor of avformat_alloc_output_context2()
 */
attribute_deprecated
AVFormatContext *avformat_alloc_output_context(const char *format,
                                               AVOutputFormat *oformat,
                                               const char *filename);
#endif

/**
 * Allocate an AVFormatContext for an output format.
 * avformat_free_context() can be used to free the context and
 * everything allocated by the framework within it.
 *
 * @param *ctx is set to the created format context, or to NULL in
 * case of failure
 * @param oformat format to use for allocating the context, if NULL
 * format_name and filename are used instead
 * @param format_name the name of output format to use for allocating the
 * context, if NULL filename is used instead
 * @param filename the name of the filename to use for allocating the
 * context, may be NULL
 * @return >= 0 in case of success, a negative AVERROR code in case of
 * failure
1082
 */
1083 1084
int avformat_alloc_output_context2(AVFormatContext **ctx, AVOutputFormat *oformat,
                                   const char *format_name, const char *filename);
1085

1086
/**
1087
 * Read packets of a media file to get stream information. This
1088
 * is useful for file formats with no headers such as MPEG. This
1089
 * function also computes the real framerate in case of MPEG-2 repeat
1090 1091 1092 1093 1094
 * 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
Diego Biurrun's avatar
Diego Biurrun committed
1095 1096 1097
 * @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.
1098
 */
1099
int av_find_stream_info(AVFormatContext *ic);
1100

1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
/**
 * Find the "best" stream in the file.
 * The best stream is determined according to various heuristics as the most
 * likely to be what the user expects.
 * If the decoder parameter is non-NULL, av_find_best_stream will find the
 * default decoder for the stream's codec; streams for which no decoder can
 * be found are ignored.
 *
 * @param ic                media file handle
 * @param type              stream type: video, audio, subtitles, etc.
 * @param wanted_stream_nb  user-requested stream number,
 *                          or -1 for automatic selection
 * @param related_stream    try to find a stream related (eg. in the same
 *                          program) to this one, or -1 if none
 * @param decoder_ret       if non-NULL, returns the decoder for the
 *                          selected stream
 * @param flags             flags; none are currently defined
 * @return  the non-negative stream number in case of success,
 *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
 *          could be found,
 *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
 * @note  If av_find_best_stream returns successfully and decoder_ret is not
 *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
 */
int av_find_best_stream(AVFormatContext *ic,
                        enum AVMediaType type,
                        int wanted_stream_nb,
                        int related_stream,
                        AVCodec **decoder_ret,
                        int flags);

1132
/**
1133
 * Read a transport packet from a media file.
1134
 *
Ramiro Polla's avatar
Ramiro Polla committed
1135
 * This function is obsolete and should never be used.
1136 1137 1138 1139
 * Use av_read_frame() instead.
 *
 * @param s media file handle
 * @param pkt is filled
Diego Biurrun's avatar
Diego Biurrun committed
1140
 * @return 0 if OK, AVERROR_xxx on error
1141
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
1142
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1143 1144

/**
1145
 * Return the next frame of a stream.
1146 1147 1148 1149 1150
 * This function returns what is stored in the file, and does not validate
 * that what is there are valid frames for the decoder. It will split what is
 * stored in the file into frames and return one for each call. It will not
 * omit invalid data between valid frames so as to give the decoder the maximum
 * information possible for decoding.
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160
 *
 * 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
1161
 * values in AVStream.time_base units (and guessed if the format cannot
Diego Biurrun's avatar
Diego Biurrun committed
1162 1163
 * 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
1164 1165
 * decompress the payload.
 *
Diego Biurrun's avatar
Diego Biurrun committed
1166
 * @return 0 if OK, < 0 on error or end of file
1167
 */
1168
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1169 1170

/**
1171
 * Seek to the keyframe at timestamp.
1172 1173 1174 1175
 * '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.
Diego Biurrun's avatar
Diego Biurrun committed
1176 1177
 * @param timestamp Timestamp in AVStream.time_base units
 *        or, if no stream is specified, in AV_TIME_BASE units.
1178 1179 1180
 * @param flags flags which select direction and seeking mode
 * @return >= 0 on success
 */
1181 1182
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
                  int flags);
1183

1184
/**
1185
 * Seek to timestamp ts.
1186 1187 1188 1189
 * 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.
 *
1190
 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1191
 * are the file position (this may not be supported by all demuxers).
1192
 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1193
 * in the stream with stream_index (this may not be supported by all demuxers).
1194 1195 1196
 * 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
1197 1198
 * keyframes (this may not be supported by all demuxers).
 *
1199
 * @param stream_index index of the stream which is used as time base reference
1200 1201 1202 1203
 * @param min_ts smallest acceptable timestamp
 * @param ts target timestamp
 * @param max_ts largest acceptable timestamp
 * @param flags flags
1204
 * @return >=0 on success, error code otherwise
1205
 *
1206
 * @note This is part of the new seek API which is still under construction.
1207 1208
 *       Thus do not use this yet. It may change at any time, do not expect
 *       ABI compatibility yet!
1209 1210 1211
 */
int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);

1212
/**
1213
 * Start playing a network-based stream (e.g. RTSP stream) at the
Diego Biurrun's avatar
Diego Biurrun committed
1214
 * current position.
1215
 */
1216
int av_read_play(AVFormatContext *s);
1217 1218

/**
1219
 * Pause a network-based stream (e.g. RTSP stream).
1220 1221 1222
 *
 * Use av_read_play() to resume it.
 */
1223
int av_read_pause(AVFormatContext *s);
1224

1225
/**
1226
 * Free a AVFormatContext allocated by av_open_input_stream.
1227 1228 1229 1230
 * @param s context to free
 */
void av_close_input_stream(AVFormatContext *s);

1231
/**
1232
 * Close a media file (but not its codecs).
1233 1234 1235
 *
 * @param s media file handle
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
1236
void av_close_input_file(AVFormatContext *s);
1237

1238 1239 1240 1241 1242 1243
/**
 * Free an AVFormatContext and all its streams.
 * @param s context to free
 */
void avformat_free_context(AVFormatContext *s);

1244
/**
1245
 * Add a new stream to a media file.
1246 1247 1248 1249 1250 1251
 *
 * 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
Diego Biurrun's avatar
Diego Biurrun committed
1252
 * @param id file-format-dependent stream ID
1253
 */
1254
AVStream *av_new_stream(AVFormatContext *s, int id);
1255
AVProgram *av_new_program(AVFormatContext *s, int id);
1256 1257

/**
1258 1259
 * Set the pts for a given stream. If the new values would be invalid
 * (<= 0), it leaves the AVStream unchanged.
1260 1261 1262 1263 1264 1265 1266
 *
 * @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)
 */
1267
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1268
                     unsigned int pts_num, unsigned int pts_den);
Fabrice Bellard's avatar
Fabrice Bellard committed
1269

1270 1271
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
Diego Biurrun's avatar
Diego Biurrun committed
1272
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1273
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1274

1275
int av_find_default_stream_index(AVFormatContext *s);
1276 1277

/**
1278
 * Get the index for a specific timestamp.
Diego Biurrun's avatar
Diego Biurrun committed
1279 1280 1281
 * @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 >=
1282 1283 1284
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
 * @return < 0 if no such timestamp could be found
 */
1285
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1286 1287

/**
1288
 * Add an index entry into a sorted list. Update the entry if the list
Diego Biurrun's avatar
Diego Biurrun committed
1289
 * already contains it.
1290
 *
Diego Biurrun's avatar
Diego Biurrun committed
1291
 * @param timestamp timestamp in the time base of the given stream
1292
 */
1293 1294
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
                       int size, int distance, int flags);
1295 1296

/**
1297
 * Perform a binary search using av_index_search_timestamp() and
1298
 * AVInputFormat.read_timestamp().
1299 1300
 * This is not supposed to be called directly by a user application,
 * but by demuxers.
1301 1302 1303
 * @param target_ts target timestamp in the time base of the given stream
 * @param stream_index stream number
 */
1304 1305
int av_seek_frame_binary(AVFormatContext *s, int stream_index,
                         int64_t target_ts, int flags);
1306 1307

/**
1308
 * Update cur_dts of all streams based on the given timestamp and AVStream.
1309
 *
Diego Biurrun's avatar
Diego Biurrun committed
1310 1311
 * 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).
1312 1313 1314
 * @param timestamp new dts expressed in time_base of param ref_st
 * @param ref_st reference stream giving time_base of param timestamp
 */
1315
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1316 1317

/**
1318
 * Perform a binary search using read_timestamp().
1319 1320
 * This is not supposed to be called directly by a user application,
 * but by demuxers.
1321 1322 1323
 * @param target_ts target timestamp in the time base of the given stream
 * @param stream_index stream number
 */
1324 1325 1326 1327 1328 1329
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 ));
1330

1331 1332 1333
/**
 * media file output
 */
1334
attribute_deprecated int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1335

1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
/**
 * 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);

1362
/**
1363
 * Allocate the stream private data and write the stream header to an
Diego Biurrun's avatar
Diego Biurrun committed
1364
 * output media file.
1365
 * @note: this sets stream time-bases, if possible to stream->codec->time_base
1366
 * but for some formats it might also be some other time base
1367 1368
 *
 * @param s media file handle
Diego Biurrun's avatar
Diego Biurrun committed
1369
 * @return 0 if OK, AVERROR_xxx on error
1370
 */
1371
int av_write_header(AVFormatContext *s);
1372 1373

/**
1374
 * Write a packet to an output media file.
1375 1376
 *
 * The packet shall contain one audio or video frame.
1377 1378
 * The packet must be correctly interleaved according to the container
 * specification, if not then av_interleaved_write_frame must be used.
1379 1380
 *
 * @param s media file handle
1381 1382
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
              dts/pts, ...
Diego Biurrun's avatar
Diego Biurrun committed
1383
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1384
 */
1385
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1386 1387

/**
1388
 * Write a packet to an output media file ensuring correct interleaving.
1389 1390
 *
 * The packet must contain one audio or video frame.
1391
 * If the packets are already correctly interleaved, the application should
Diego Biurrun's avatar
Diego Biurrun committed
1392 1393 1394 1395
 * 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.
1396 1397
 *
 * @param s media file handle
1398 1399
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
              dts/pts, ...
Diego Biurrun's avatar
Diego Biurrun committed
1400
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1401
 */
1402
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1403 1404

/**
1405
 * Interleave a packet per dts in an output media file.
1406
 *
1407
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1408
 * function, so they cannot be used after it. Note that calling av_free_packet()
1409
 * on them is still safe.
1410 1411 1412
 *
 * @param s media file handle
 * @param out the interleaved packet will be output here
1413
 * @param pkt the input packet
1414 1415 1416
 * @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,
1417
 *         < 0 if an error occurred
1418
 */
1419 1420
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
                                 AVPacket *pkt, int flush);
1421

1422
/**
1423
 * Write the stream trailer to an output media file and free the
1424
 * file private data.
1425
 *
1426 1427
 * May only be called after a successful call to av_write_header.
 *
1428
 * @param s media file handle
Diego Biurrun's avatar
Diego Biurrun committed
1429
 * @return 0 if OK, AVERROR_xxx on error
1430
 */
1431
int av_write_trailer(AVFormatContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
1432

1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443
#if FF_API_DUMP_FORMAT
attribute_deprecated void dump_format(AVFormatContext *ic,
                                      int index,
                                      const char *url,
                                      int is_output);
#endif

void av_dump_format(AVFormatContext *ic,
                    int index,
                    const char *url,
                    int is_output);
1444

1445
#if FF_API_PARSE_DATE
1446
/**
1447
 * Parse datestr and return a corresponding number of microseconds.
1448
 *
1449
 * @param datestr String representing a date or a duration.
1450 1451
 * See av_parse_time() for the syntax of the provided string.
 * @deprecated in favor of av_parse_time()
1452
 */
1453
attribute_deprecated
1454
int64_t parse_date(const char *datestr, int duration);
1455
#endif
Fabrice Bellard's avatar
Fabrice Bellard committed
1456

1457 1458 1459
/**
 * Get the current time in microseconds.
 */
1460
int64_t av_gettime(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
1461

1462
#if FF_API_FIND_INFO_TAG
1463
/**
1464
 * @deprecated use av_find_info_tag in libavutil instead.
1465
 */
1466 1467
attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
#endif
Fabrice Bellard's avatar
Fabrice Bellard committed
1468

1469
/**
1470
 * Return in 'buf' the path with '%d' replaced by a number.
Diego Biurrun's avatar
Diego Biurrun committed
1471
 *
1472 1473 1474 1475 1476 1477
 * 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
1478
 * @param number frame number
Diego Biurrun's avatar
Diego Biurrun committed
1479
 * @return 0 if OK, -1 on format error
1480
 */
1481 1482
int av_get_frame_filename(char *buf, int buf_size,
                          const char *path, int number);
1483 1484

/**
1485
 * Check whether filename actually is a numbered sequence generator.
1486 1487
 *
 * @param filename possible numbered sequence string
Diego Biurrun's avatar
Diego Biurrun committed
1488
 * @return 1 if a valid numbered sequence string, 0 otherwise
1489
 */
1490
int av_filename_number_test(const char *filename);
1491

Luca Abeni's avatar
Luca Abeni committed
1492
/**
1493
 * Generate an SDP for an RTP session.
Luca Abeni's avatar
Luca Abeni committed
1494 1495 1496 1497 1498
 *
 * @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)
Diego Biurrun's avatar
Diego Biurrun committed
1499
 *           must contain only one AVStream.
1500
 * @param n_files number of AVCodecContexts contained in ac
1501 1502
 * @param buf buffer where the SDP will be stored (must be allocated by
 *            the caller)
1503
 * @param size the size of the buffer
Diego Biurrun's avatar
Diego Biurrun committed
1504
 * @return 0 if OK, AVERROR_xxx on error
Luca Abeni's avatar
Luca Abeni committed
1505
 */
1506
int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1507 1508 1509 1510

#if FF_API_SDP_CREATE
attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
#endif
Luca Abeni's avatar
Luca Abeni committed
1511

1512
/**
1513
 * Return a positive value if the given filename has one of the given
1514 1515 1516 1517 1518 1519
 * extensions, 0 otherwise.
 *
 * @param extensions a comma-separated list of filename extensions
 */
int av_match_ext(const char *filename, const char *extensions);

1520
#endif /* AVFORMAT_AVFORMAT_H */