avformat.h 113 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 27 28 29
/**
 * @file
 * @ingroup libavf
 * Main libavformat public API header
 */

30
/**
31 32
 * @defgroup libavf libavformat
 * I/O and Muxing/Demuxing Library
33
 *
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
 * Libavformat (lavf) is a library for dealing with various media container
 * formats. Its main two purposes are demuxing - i.e. splitting a media file
 * into component streams, and the reverse process of muxing - writing supplied
 * data in a specified container format. It also has an @ref lavf_io
 * "I/O module" which supports a number of protocols for accessing the data (e.g.
 * file, tcp, http and others). Before using lavf, you need to call
 * av_register_all() to register all compiled muxers, demuxers and protocols.
 * Unless you are absolutely sure you won't use libavformat's network
 * capabilities, you should also call avformat_network_init().
 *
 * A supported input format is described by an AVInputFormat struct, conversely
 * an output format is described by AVOutputFormat. You can iterate over all
 * registered input/output formats using the av_iformat_next() /
 * av_oformat_next() functions. The protocols layer is not part of the public
 * API, so you can only get the names of supported protocols with the
 * avio_enum_protocols() function.
 *
 * Main lavf structure used for both muxing and demuxing is AVFormatContext,
 * which exports all information about the file being read or written. As with
53
 * most Libavformat structures, its size is not part of public ABI, so it cannot be
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
 * allocated on stack or directly with av_malloc(). To create an
 * AVFormatContext, use avformat_alloc_context() (some functions, like
 * avformat_open_input() might do that for you).
 *
 * Most importantly an AVFormatContext contains:
 * @li the @ref AVFormatContext.iformat "input" or @ref AVFormatContext.oformat
 * "output" format. It is either autodetected or set by user for input;
 * always set by user for output.
 * @li an @ref AVFormatContext.streams "array" of AVStreams, which describe all
 * elementary streams stored in the file. AVStreams are typically referred to
 * using their index in this array.
 * @li an @ref AVFormatContext.pb "I/O context". It is either opened by lavf or
 * set by user for input, always set by user for output (unless you are dealing
 * with an AVFMT_NOFILE format).
 *
69
 * @section lavf_options Passing options to (de)muxers
70
 * It is possible to configure lavf muxers and demuxers using the @ref avoptions
71 72 73 74 75 76 77 78 79 80
 * mechanism. Generic (format-independent) libavformat options are provided by
 * AVFormatContext, they can be examined from a user program by calling
 * av_opt_next() / av_opt_find() on an allocated AVFormatContext (or its AVClass
 * from avformat_get_class()). Private (format-specific) options are provided by
 * AVFormatContext.priv_data if and only if AVInputFormat.priv_class /
 * AVOutputFormat.priv_class of the corresponding format struct is non-NULL.
 * Further options may be provided by the @ref AVFormatContext.pb "I/O context",
 * if its AVClass is non-NULL, and the protocols layer. See the discussion on
 * nesting in @ref avoptions documentation to learn how to access those.
 *
81 82 83 84 85 86 87 88 89 90 91 92
 * @section urls
 * URL strings in libavformat are made of a scheme/protocol, a ':', and a
 * scheme specific string. URLs without a scheme and ':' used for local files
 * are supported but deprecated. "file:" should be used for local files.
 *
 * It is important that the scheme string is not taken from untrusted
 * sources without checks.
 *
 * Note that some schemes/protocols are quite powerful, allowing access to
 * both local and remote files, parts of them, concatenations of them, local
 * audio and video devices and so on.
 *
93 94
 * @{
 *
95 96
 * @defgroup lavf_decoding Demuxing
 * @{
97
 * Demuxers read a media file and split it into chunks of data (@em packets). A
98 99
 * @ref AVPacket "packet" contains one or more encoded frames which belongs to a
 * single elementary stream. In the lavf API this process is represented by the
100 101 102 103 104
 * avformat_open_input() function for opening a file, av_read_frame() for
 * reading a single packet and finally avformat_close_input(), which does the
 * cleanup.
 *
 * @section lavf_decoding_open Opening a media file
105
 * The minimum information required to open a file is its URL, which
106 107
 * is passed to avformat_open_input(), as in the following code:
 * @code
108
 * const char    *url = "file:in.mp3";
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
 * AVFormatContext *s = NULL;
 * int ret = avformat_open_input(&s, url, NULL, NULL);
 * if (ret < 0)
 *     abort();
 * @endcode
 * The above code attempts to allocate an AVFormatContext, open the
 * specified file (autodetecting the format) and read the header, exporting the
 * information stored there into s. Some formats do not have a header or do not
 * store enough information there, so it is recommended that you call the
 * avformat_find_stream_info() function which tries to read and decode a few
 * frames to find missing information.
 *
 * In some cases you might want to preallocate an AVFormatContext yourself with
 * avformat_alloc_context() and do some tweaking on it before passing it to
 * avformat_open_input(). One such case is when you want to use custom functions
 * for reading input data instead of lavf internal I/O layer.
 * To do that, create your own AVIOContext with avio_alloc_context(), passing
 * your reading callbacks to it. Then set the @em pb field of your
 * AVFormatContext to newly created AVIOContext.
 *
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
 * Since the format of the opened file is in general not known until after
 * avformat_open_input() has returned, it is not possible to set demuxer private
 * options on a preallocated context. Instead, the options should be passed to
 * avformat_open_input() wrapped in an AVDictionary:
 * @code
 * AVDictionary *options = NULL;
 * av_dict_set(&options, "video_size", "640x480", 0);
 * av_dict_set(&options, "pixel_format", "rgb24", 0);
 *
 * if (avformat_open_input(&s, url, NULL, &options) < 0)
 *     abort();
 * av_dict_free(&options);
 * @endcode
 * This code passes the private options 'video_size' and 'pixel_format' to the
 * demuxer. They would be necessary for e.g. the rawvideo demuxer, since it
 * cannot know how to interpret raw video data otherwise. If the format turns
 * out to be something different than raw video, those options will not be
 * recognized by the demuxer and therefore will not be applied. Such unrecognized
 * options are then returned in the options dictionary (recognized options are
 * consumed). The calling program can handle such unrecognized options as it
 * wishes, e.g.
 * @code
 * AVDictionaryEntry *e;
 * if (e = av_dict_get(options, "", NULL, AV_DICT_IGNORE_SUFFIX)) {
 *     fprintf(stderr, "Option %s not recognized by the demuxer.\n", e->key);
 *     abort();
 * }
 * @endcode
 *
158 159 160 161
 * After you have finished reading the file, you must close it with
 * avformat_close_input(). It will free everything associated with the file.
 *
 * @section lavf_decoding_read Reading from an opened file
162 163 164 165
 * Reading data from an opened AVFormatContext is done by repeatedly calling
 * av_read_frame() on it. Each call, if successful, will return an AVPacket
 * containing encoded data for one AVStream, identified by
 * AVPacket.stream_index. This packet may be passed straight into the libavcodec
166 167
 * decoding functions avcodec_send_packet() or avcodec_decode_subtitle2() if the
 * caller wishes to decode the data.
168 169 170 171 172 173 174
 *
 * AVPacket.pts, AVPacket.dts and AVPacket.duration timing information will be
 * set if known. They may also be unset (i.e. AV_NOPTS_VALUE for
 * pts/dts, 0 for duration) if the stream does not provide them. The timing
 * information will be in AVStream.time_base units, i.e. it has to be
 * multiplied by the timebase to convert them to seconds.
 *
175
 * If AVPacket.buf is set on the returned packet, then the packet is
176
 * allocated dynamically and the user may keep it indefinitely.
177
 * Otherwise, if AVPacket.buf is NULL, the packet data is backed by a
178 179 180 181
 * static storage somewhere inside the demuxer and the packet is only valid
 * until the next av_read_frame() call or closing the file. If the caller
 * requires a longer lifetime, av_dup_packet() will make an av_malloc()ed copy
 * of it.
182
 * In both cases, the packet must be freed with av_packet_unref() when it is no
183
 * longer needed.
184 185
 *
 * @section lavf_decoding_seek Seeking
186 187 188 189
 * @}
 *
 * @defgroup lavf_encoding Muxing
 * @{
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
 * Muxers take encoded data in the form of @ref AVPacket "AVPackets" and write
 * it into files or other output bytestreams in the specified container format.
 *
 * The main API functions for muxing are avformat_write_header() for writing the
 * file header, av_write_frame() / av_interleaved_write_frame() for writing the
 * packets and av_write_trailer() for finalizing the file.
 *
 * At the beginning of the muxing process, the caller must first call
 * avformat_alloc_context() to create a muxing context. The caller then sets up
 * the muxer by filling the various fields in this context:
 *
 * - The @ref AVFormatContext.oformat "oformat" field must be set to select the
 *   muxer that will be used.
 * - Unless the format is of the AVFMT_NOFILE type, the @ref AVFormatContext.pb
 *   "pb" field must be set to an opened IO context, either returned from
 *   avio_open2() or a custom one.
 * - Unless the format is of the AVFMT_NOSTREAMS type, at least one stream must
 *   be created with the avformat_new_stream() function. The caller should fill
208 209
 *   the @ref AVStream.codecpar "stream codec parameters" information, such as the
 *   codec @ref AVCodecParameters.codec_type "type", @ref AVCodecParameters.codec_id
210
 *   "id" and other parameters (e.g. width / height, the pixel or sample format,
211
 *   etc.) as known. The @ref AVStream.time_base "stream timebase" should
212 213 214
 *   be set to the timebase that the caller desires to use for this stream (note
 *   that the timebase actually used by the muxer can be different, as will be
 *   described later).
215
 * - It is advised to manually initialize only the relevant fields in
216
 *   AVCodecParameters, rather than using @ref avcodec_parameters_copy() during
217 218
 *   remuxing: there is no guarantee that the codec context values remain valid
 *   for both input and output format contexts.
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
 * - The caller may fill in additional information, such as @ref
 *   AVFormatContext.metadata "global" or @ref AVStream.metadata "per-stream"
 *   metadata, @ref AVFormatContext.chapters "chapters", @ref
 *   AVFormatContext.programs "programs", etc. as described in the
 *   AVFormatContext documentation. Whether such information will actually be
 *   stored in the output depends on what the container format and the muxer
 *   support.
 *
 * When the muxing context is fully set up, the caller must call
 * avformat_write_header() to initialize the muxer internals and write the file
 * header. Whether anything actually is written to the IO context at this step
 * depends on the muxer, but this function must always be called. Any muxer
 * private options must be passed in the options parameter to this function.
 *
 * The data is then sent to the muxer by repeatedly calling av_write_frame() or
 * av_interleaved_write_frame() (consult those functions' documentation for
 * discussion on the difference between them; only one of them may be used with
 * a single muxing context, they should not be mixed). Do note that the timing
 * information on the packets sent to the muxer must be in the corresponding
 * AVStream's timebase. That timebase is set by the muxer (in the
239 240
 * avformat_write_header() step) and may be different from the timebase
 * requested by the caller.
241 242 243 244 245
 *
 * Once all the data has been written, the caller must call av_write_trailer()
 * to flush any buffered packets and finalize the output file, then close the IO
 * context (if any) and finally free the muxing context with
 * avformat_free_context().
246 247
 * @}
 *
248
 * @defgroup lavf_io I/O Read/Write
249
 * @{
250
 * @section lavf_io_dirlist Directory listing
251
 * The directory listing API makes it possible to list files on remote servers.
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
 *
 * Some of possible use cases:
 * - an "open file" dialog to choose files from a remote location,
 * - a recursive media finder providing a player with an ability to play all
 * files from a given directory.
 *
 * @subsection lavf_io_dirlist_open Opening a directory
 * At first, a directory needs to be opened by calling avio_open_dir()
 * supplied with a URL and, optionally, ::AVDictionary containing
 * protocol-specific parameters. The function returns zero or positive
 * integer and allocates AVIODirContext on success.
 *
 * @code
 * AVIODirContext *ctx = NULL;
 * if (avio_open_dir(&ctx, "smb://example.com/some_dir", NULL) < 0) {
 *     fprintf(stderr, "Cannot open directory.\n");
 *     abort();
 * }
 * @endcode
 *
 * This code tries to open a sample directory using smb protocol without
 * any additional parameters.
 *
 * @subsection lavf_io_dirlist_read Reading entries
 * Each directory's entry (i.e. file, another directory, anything else
 * within ::AVIODirEntryType) is represented by AVIODirEntry.
 * Reading consecutive entries from an opened AVIODirContext is done by
 * repeatedly calling avio_read_dir() on it. Each call returns zero or
 * positive integer if successful. Reading can be stopped right after the
 * NULL entry has been read -- it means there are no entries left to be
 * read. The following code reads all entries from a directory associated
 * with ctx and prints their names to standard output.
 * @code
 * AVIODirEntry *entry = NULL;
 * for (;;) {
 *     if (avio_read_dir(ctx, &entry) < 0) {
 *         fprintf(stderr, "Cannot list directory.\n");
 *         abort();
 *     }
 *     if (!entry)
 *         break;
 *     printf("%s\n", entry->name);
 *     avio_free_directory_entry(&entry);
 * }
 * @endcode
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
 * @}
 *
 * @defgroup lavf_codec Demuxers
 * @{
 * @defgroup lavf_codec_native Native Demuxers
 * @{
 * @}
 * @defgroup lavf_codec_wrappers External library wrappers
 * @{
 * @}
 * @}
 * @defgroup lavf_protos I/O Protocols
 * @{
 * @}
 * @defgroup lavf_internal Internal
 * @{
 * @}
 * @}
 */
316

317
#include <time.h>
Zdenek Kabelac's avatar
Zdenek Kabelac committed
318
#include <stdio.h>  /* FILE */
319
#include "libavcodec/avcodec.h"
320
#include "libavutil/dict.h"
321
#include "libavutil/log.h"
Fabrice Bellard's avatar
Fabrice Bellard committed
322 323

#include "avio.h"
324
#include "libavformat/version.h"
Fabrice Bellard's avatar
Fabrice Bellard committed
325

326 327
struct AVFormatContext;

328
struct AVDeviceInfoList;
329
struct AVDeviceCapabilitiesQuery;
330

331 332 333
/**
 * @defgroup metadata_api Public Metadata API
 * @{
334
 * @ingroup libavf
335
 * The metadata API allows libavformat to export metadata tags to a client
336 337 338 339 340
 * application when demuxing. Conversely it allows a client application to
 * set metadata when muxing.
 *
 * Metadata is exported or set as pairs of key/value strings in the 'metadata'
 * fields of the AVFormatContext, AVStream, AVChapter and AVProgram structs
341
 * using the @ref lavu_dict "AVDictionary" API. Like all strings in FFmpeg,
342
 * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata
343
 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
344
 *
345
 * Important concepts to keep in mind:
346
 * -  Keys are unique; there can never be 2 tags with the same key. This is
347 348 349 350
 *    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.
351
 * -  Metadata is flat, not hierarchical; there are no subtags. If you
352 353
 *    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.
354
 * -  Several modifiers can be applied to the tag name. This is done by
355 356
 *    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.
357
 *    -  language -- a tag whose value is localized for a particular language
358 359 360 361
 *       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.
362
 *    -  sorting  -- a modified version of a tag that should be used for
363 364
 *       sorting will have '-sort' appended. E.g. artist="The Beatles",
 *       artist-sort="Beatles, The".
365 366 367 368 369
 * - Some protocols and demuxers support metadata updates. After a successful
 *   call to av_read_packet(), AVFormatContext.event_flags or AVStream.event_flags
 *   will be updated to indicate if metadata changed. In order to detect metadata
 *   changes on a stream, you need to loop through all streams in the AVFormatContext
 *   and check their individual event_flags.
370
 *
371
 * -  Demuxers attempt to export metadata in a generic format, however tags
372 373
 *    with no generic equivalents are left as they are stored in the container.
 *    Follows a list of generic tag names:
374
 *
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
 @verbatim
 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.
 creation_time-- date when the file was created, preferably in ISO 8601.
 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. Multiple languages can be specified by
                 separating them with commas.
 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.
 service_name     -- name of the service in broadcasting (channel name).
 service_provider -- name of the service provider in broadcasting.
 title        -- name of the work.
 track        -- number of this work in the set, can be in form current/total.
 variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
 @endverbatim
 *
404 405
 * Look in the examples section for an application example how to use the Metadata API.
 *
406
 * @}
407 408
 */

Fabrice Bellard's avatar
Fabrice Bellard committed
409 410
/* packet functions */

411 412

/**
413
 * Allocate and read the payload of a packet and initialize its
414
 * fields with default values.
415
 *
416
 * @param s    associated IO context
417
 * @param pkt packet
Diego Biurrun's avatar
Diego Biurrun committed
418 419
 * @param size desired payload size
 * @return >0 (read size) if OK, AVERROR_xxx otherwise
420
 */
421
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
422

Fabrice Bellard's avatar
Fabrice Bellard committed
423

424
/**
425 426
 * Read data and append it to the current content of the AVPacket.
 * If pkt->size is 0 this is identical to av_get_packet.
427 428 429 430 431
 * 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.
 *
432
 * @param s    associated IO context
433 434 435 436 437
 * @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.
 */
438
int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
439

440
#if FF_API_LAVF_FRAC
Fabrice Bellard's avatar
Fabrice Bellard committed
441 442 443
/*************************************************/
/* fractional numbers for exact pts handling */

444
/**
Diego Biurrun's avatar
Diego Biurrun committed
445 446
 * The exact value of the fractional number is: 'val + num / den'.
 * num is assumed to be 0 <= num < den.
447
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
448
typedef struct AVFrac {
449
    int64_t val, num, den;
450
} AVFrac;
451
#endif
Fabrice Bellard's avatar
Fabrice Bellard committed
452

Fabrice Bellard's avatar
Fabrice Bellard committed
453
/*************************************************/
454
/* input/output formats */
Fabrice Bellard's avatar
Fabrice Bellard committed
455

456 457
struct AVCodecTag;

458 459 460
/**
 * This structure contains the data a format has to probe a file.
 */
461
typedef struct AVProbeData {
462
    const char *filename;
463 464
    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 */
465
    const char *mime_type; /**< mime_type, when known. */
466 467
} AVProbeData;

468
#define AVPROBE_SCORE_RETRY (AVPROBE_SCORE_MAX/4)
469 470
#define AVPROBE_SCORE_STREAM_RETRY (AVPROBE_SCORE_MAX/4-1)

471
#define AVPROBE_SCORE_EXTENSION  50 ///< score for file extension
472
#define AVPROBE_SCORE_MIME       75 ///< score for file mime type
473 474
#define AVPROBE_SCORE_MAX       100 ///< maximum score

475
#define AVPROBE_PADDING_SIZE 32             ///< extra allocated bytes at the end of the probe buffer
Fabrice Bellard's avatar
Fabrice Bellard committed
476

477
/// Demuxer will use avio_open, no opened file should be provided by the caller.
478
#define AVFMT_NOFILE        0x0001
Diego Biurrun's avatar
Diego Biurrun committed
479 480
#define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
#define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
481
#if FF_API_LAVF_FMT_RAWPICTURE
Diego Biurrun's avatar
Diego Biurrun committed
482
#define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
483 484
                                      raw picture data. @deprecated Not used anymore */
#endif
Diego Biurrun's avatar
Diego Biurrun committed
485 486 487
#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. */
488
#define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
489
#define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
490
#define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
491
#define AVFMT_NOSTREAMS     0x1000 /**< Format does not require any streams */
Diego Biurrun's avatar
Diego Biurrun committed
492 493
#define AVFMT_NOBINSEARCH   0x2000 /**< Format does not allow to fall back on binary search via read_timestamp */
#define AVFMT_NOGENSEARCH   0x4000 /**< Format does not allow to fall back on generic search */
494
#define AVFMT_NO_BYTE_SEEK  0x8000 /**< Format does not allow seeking by bytes */
495
#define AVFMT_ALLOW_FLUSH  0x10000 /**< Format allows flushing. If not set, the muxer will not receive a NULL packet in the write_packet function. */
496
#define AVFMT_TS_NONSTRICT 0x20000 /**< Format does not require strictly
497 498
                                        increasing timestamps, but they must
                                        still be monotonic */
499 500 501 502
#define AVFMT_TS_NEGATIVE  0x40000 /**< Format allows muxing negative
                                        timestamps. If not set the timestamp
                                        will be shifted in av_write_frame and
                                        av_interleaved_write_frame so they
503 504 505 506
                                        start from 0.
                                        The user or muxer can override this through
                                        AVFormatContext.avoid_negative_ts
                                        */
507

508
#define AVFMT_SEEK_TO_PTS   0x4000000 /**< Seeking is based on PTS */
509

510 511 512 513
/**
 * @addtogroup lavf_encoding
 * @{
 */
514
typedef struct AVOutputFormat {
Fabrice Bellard's avatar
Fabrice Bellard committed
515
    const char *name;
516 517
    /**
     * Descriptive name for the format, meant to be more human-readable
518
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
519 520
     * to define it.
     */
Fabrice Bellard's avatar
Fabrice Bellard committed
521 522
    const char *long_name;
    const char *mime_type;
Diego Biurrun's avatar
Diego Biurrun committed
523
    const char *extensions; /**< comma-separated filename extensions */
524
    /* output support */
525 526 527
    enum AVCodecID audio_codec;    /**< default audio codec */
    enum AVCodecID video_codec;    /**< default video codec */
    enum AVCodecID subtitle_codec; /**< default subtitle codec */
528
    /**
529
     * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER,
530
     * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
531
     * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS, AVFMT_ALLOW_FLUSH,
532
     * AVFMT_TS_NONSTRICT, AVFMT_TS_NEGATIVE
533 534 535 536 537
     */
    int flags;

    /**
     * List of supported codec_id-codec_tag pairs, ordered by "better
538
     * choice first". The arrays are all terminated by AV_CODEC_ID_NONE.
539 540 541 542 543 544 545 546 547 548 549 550 551 552
     */
    const struct AVCodecTag * const *codec_tag;


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

    /*****************************************************************
     * No fields below this line are part of the public API. They
     * may not be used outside of libavformat and can be changed and
     * removed at will.
     * New public fields should be added right above.
     *****************************************************************
     */
    struct AVOutputFormat *next;
553 554 555
    /**
     * size of private data so that it can be allocated in the wrapper
     */
556
    int priv_data_size;
557

Fabrice Bellard's avatar
Fabrice Bellard committed
558
    int (*write_header)(struct AVFormatContext *);
559 560 561 562 563 564 565
    /**
     * Write a packet. If AVFMT_ALLOW_FLUSH is set in flags,
     * pkt can be NULL in order to flush data buffered in the muxer.
     * When flushing, return 0 if there still is more data to flush,
     * or 1 if everything was flushed and there is no more buffered
     * data.
     */
566
    int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
Fabrice Bellard's avatar
Fabrice Bellard committed
567
    int (*write_trailer)(struct AVFormatContext *);
568 569 570
    /**
     * Currently only used to set pixel format if not YUV420P.
     */
571 572
    int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
                             AVPacket *in, int flush);
573 574 575 576 577
    /**
     * Test if the given codec can be stored in this container.
     *
     * @return 1 if the codec is supported, 0 if it is not.
     *         A negative number if unknown.
578
     *         MKTAG('A', 'P', 'I', 'C') if the codec is only supported as AV_DISPOSITION_ATTACHED_PIC
579
     */
580
    int (*query_codec)(enum AVCodecID id, int std_compliance);
581

582 583
    void (*get_output_timestamp)(struct AVFormatContext *s, int stream,
                                 int64_t *dts, int64_t *wall);
584 585 586 587 588
    /**
     * Allows sending messages from application to device.
     */
    int (*control_message)(struct AVFormatContext *s, int type,
                           void *data, size_t data_size);
589 590 591 592 593 594 595 596 597 598 599

    /**
     * Write an uncoded AVFrame.
     *
     * See av_write_uncoded_frame() for details.
     *
     * The library will free *frame afterwards, but the muxer can prevent it
     * by setting the pointer to NULL.
     */
    int (*write_uncoded_frame)(struct AVFormatContext *, int stream_index,
                               AVFrame **frame, unsigned flags);
600 601 602 603 604
    /**
     * Returns device list with it properties.
     * @see avdevice_list_devices() for more details.
     */
    int (*get_device_list)(struct AVFormatContext *s, struct AVDeviceInfoList *device_list);
605 606 607 608 609 610 611 612 613 614
    /**
     * Initialize device capabilities submodule.
     * @see avdevice_capabilities_create() for more details.
     */
    int (*create_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps);
    /**
     * Free device capabilities submodule.
     * @see avdevice_capabilities_free() for more details.
     */
    int (*free_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps);
615
    enum AVCodecID data_codec; /**< default data codec */
616 617 618 619 620
    /**
     * Initialize format. May allocate data here, and set any AVFormatContext or
     * AVStream parameters that need to be set before packets are sent.
     * This method must not write output.
     *
621 622
     * Return 0 if streams were fully configured, 1 if not, negative AVERROR on failure
     *
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
     * Any allocations made here must be freed in deinit().
     */
    int (*init)(struct AVFormatContext *);
    /**
     * Deinitialize format. If present, this is called whenever the muxer is being
     * destroyed, regardless of whether or not the header has been written.
     *
     * If a trailer is being written, this is called after write_trailer().
     *
     * This is called if init() fails as well.
     */
    void (*deinit)(struct AVFormatContext *);
    /**
     * Set up any necessary bitstream filtering and extract any extra data needed
     * for the global header.
     * Return 0 if more packets from this stream must be checked; 1 if not.
     */
    int (*check_bitstream)(struct AVFormatContext *, const AVPacket *pkt);
641
} AVOutputFormat;
642 643 644
/**
 * @}
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
645

646 647 648 649
/**
 * @addtogroup lavf_decoding
 * @{
 */
650
typedef struct AVInputFormat {
651 652
    /**
     * A comma separated list of short names for the format. New names
653 654
     * may be appended with a minor bump.
     */
655
    const char *name;
656

657 658
    /**
     * Descriptive name for the format, meant to be more human-readable
659
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
660 661
     * to define it.
     */
662
    const char *long_name;
663

664 665 666
    /**
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
     * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
667
     * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK, AVFMT_SEEK_TO_PTS.
668 669 670 671 672 673 674 675 676 677 678 679 680 681
     */
    int flags;

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

    const struct AVCodecTag * const *codec_tag;

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

682 683 684 685 686 687 688
    /**
     * Comma-separated list of mime types.
     * It is used check for matching mime types while probing.
     * @see av_probe_input_format2
     */
    const char *mime_type;

689 690 691 692 693 694 695 696 697 698
    /*****************************************************************
     * No fields below this line are part of the public API. They
     * may not be used outside of libavformat and can be changed and
     * removed at will.
     * New public fields should be added right above.
     *****************************************************************
     */
    struct AVInputFormat *next;

    /**
699
     * Raw demuxers store their codec ID here.
700
     */
701
    int raw_codec_id;
702

703 704 705
    /**
     * Size of private data so that it can be allocated in the wrapper.
     */
706
    int priv_data_size;
707

708
    /**
709
     * Tell if a given file has a chance of being parsed as this format.
710 711
     * 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.
712
     */
713
    int (*read_probe)(AVProbeData *);
714 715 716

    /**
     * Read the format header and initialize the AVFormatContext
717 718
     * structure. Return 0 if OK. 'avformat_new_stream' should be
     * called to create new streams.
719
     */
720
    int (*read_header)(struct AVFormatContext *);
721 722 723

    /**
     * Read one packet and put it in 'pkt'. pts and flags are also
724
     * set. 'avformat_new_stream' can be called only if the flag
725 726
     * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
     * background thread).
727 728 729 730
     * @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
731
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
732 733 734 735 736

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

739
    /**
Diego Biurrun's avatar
Diego Biurrun committed
740 741
     * Seek to a given timestamp relative to the frames in
     * stream component stream_index.
742 743 744
     * @param stream_index Must not be -1.
     * @param flags Selects which direction should be preferred if no exact
     *              match is available.
745
     * @return >= 0 on success (but not necessarily the new offset)
746
     */
747 748 749
    int (*read_seek)(struct AVFormatContext *,
                     int stream_index, int64_t timestamp, int flags);

750
    /**
751
     * Get the next timestamp in stream[stream_index].time_base units.
752
     * @return the timestamp or AV_NOPTS_VALUE if an error occurred
753 754 755
     */
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
                              int64_t *pos, int64_t pos_limit);
756 757 758 759 760

    /**
     * Start/resume playing - only meaningful if using a network-based format
     * (RTSP).
     */
761 762
    int (*read_play)(struct AVFormatContext *);

763 764 765 766
    /**
     * Pause playing - only meaningful if using a network-based format
     * (RTSP).
     */
767 768
    int (*read_pause)(struct AVFormatContext *);

769
    /**
770
     * Seek to timestamp ts.
771 772 773 774
     * 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
775
    int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
776 777 778 779 780 781

    /**
     * Returns device list with it properties.
     * @see avdevice_list_devices() for more details.
     */
    int (*get_device_list)(struct AVFormatContext *s, struct AVDeviceInfoList *device_list);
782 783 784 785 786 787 788 789 790 791 792 793

    /**
     * Initialize device capabilities submodule.
     * @see avdevice_capabilities_create() for more details.
     */
    int (*create_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps);

    /**
     * Free device capabilities submodule.
     * @see avdevice_capabilities_free() for more details.
     */
    int (*free_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps);
794
} AVInputFormat;
795 796 797
/**
 * @}
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
798

799 800 801
enum AVStreamParseType {
    AVSTREAM_PARSE_NONE,
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
Diego Biurrun's avatar
Diego Biurrun committed
802
    AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
803
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
804
    AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
805 806
    AVSTREAM_PARSE_FULL_RAW=MKTAG(0,'R','A','W'),       /**< full parsing and repack with timestamp and position generation by parser for raw
                                                             this assumes that each packet in the file contains no demuxer level headers and
807
                                                             just codec level data, otherwise position generation would fail */
808 809
};

810 811
typedef struct AVIndexEntry {
    int64_t pos;
812 813 814 815 816 817
    int64_t timestamp;        /**<
                               * Timestamp in AVStream.time_base units, preferably the time from which on correctly decoded frames are available
                               * when seeking to this entry. That means preferable PTS on keyframe based formats.
                               * But demuxers can choose to store a different timestamp, if it is more convenient for the implementation or nothing better
                               * is known
                               */
818
#define AVINDEX_KEYFRAME 0x0001
819 820 821
#define AVINDEX_DISCARD_FRAME  0x0002    /**
                                          * Flag is used to indicate which frame should be discarded after decoding.
                                          */
822
    int flags:2;
Diego Biurrun's avatar
Diego Biurrun committed
823 824
    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. */
825 826
} AVIndexEntry;

827 828 829 830 831 832
#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
833 834 835 836 837 838

/**
 * 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.
 */
839
#define AV_DISPOSITION_FORCED    0x0040
840 841
#define AV_DISPOSITION_HEARING_IMPAIRED  0x0080  /**< stream for hearing impaired audiences */
#define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100  /**< stream for visual impaired audiences */
842
#define AV_DISPOSITION_CLEAN_EFFECTS     0x0200  /**< stream without voice */
843 844
/**
 * The stream is stored in the file as an attached picture/"cover art" (e.g.
845 846 847 848
 * APIC frame in ID3v2). The first (usually only) packet associated with it
 * will be returned among the first few packets read from the file unless
 * seeking takes place. It can also be accessed at any time in
 * AVStream.attached_pic.
849 850
 */
#define AV_DISPOSITION_ATTACHED_PIC      0x0400
851 852 853 854 855
/**
 * The stream is sparse, and contains thumbnail images, often corresponding
 * to chapter markers. Only ever used with AV_DISPOSITION_ATTACHED_PIC.
 */
#define AV_DISPOSITION_TIMED_THUMBNAILS  0x0800
856

857 858
typedef struct AVStreamInternal AVStreamInternal;

859 860 861 862 863 864 865
/**
 * To specify text track kind (different from subtitles default).
 */
#define AV_DISPOSITION_CAPTIONS     0x10000
#define AV_DISPOSITION_DESCRIPTIONS 0x20000
#define AV_DISPOSITION_METADATA     0x40000

866 867 868 869 870 871 872
/**
 * Options for behavior on timestamp wrap detection.
 */
#define AV_PTS_WRAP_IGNORE      0   ///< ignore the wrap
#define AV_PTS_WRAP_ADD_OFFSET  1   ///< add the format specific offset on wrap detection
#define AV_PTS_WRAP_SUB_OFFSET  -1  ///< subtract the format specific offset on wrap detection

873 874 875
/**
 * Stream structure.
 * New fields can be added to the end with minor version bumps.
Diego Biurrun's avatar
Diego Biurrun committed
876
 * Removal, reordering and changes to existing fields require a major
877
 * version bump.
Diego Biurrun's avatar
Diego Biurrun committed
878
 * sizeof(AVStream) must not be used outside libav*.
879
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
880
typedef struct AVStream {
881
    int index;    /**< stream index in AVFormatContext */
882 883 884
    /**
     * Format-specific stream ID.
     * decoding: set by libavformat
885
     * encoding: set by the user, replaced by libavformat if left unset
886 887
     */
    int id;
888
#if FF_API_LAVF_AVCTX
889
    /**
890
     * @deprecated use the codecpar struct instead
891
     */
892
    attribute_deprecated
893
    AVCodecContext *codec;
894
#endif
Fabrice Bellard's avatar
Fabrice Bellard committed
895
    void *priv_data;
896

897
#if FF_API_LAVF_FRAC
898
    /**
899
     * @deprecated this field is unused
900
     */
901
    attribute_deprecated
902
    struct AVFrac pts;
903
#endif
904 905

    /**
Diego Biurrun's avatar
Diego Biurrun committed
906
     * This is the fundamental unit of time (in seconds) in terms
907 908
     * of which frame timestamps are represented.
     *
909
     * decoding: set by libavformat
910 911 912 913 914 915
     * encoding: May be set by the caller before avformat_write_header() to
     *           provide a hint to the muxer about the desired timebase. In
     *           avformat_write_header(), the muxer will overwrite this field
     *           with the timebase that will actually be used for the timestamps
     *           written into the file (which may or may not be related to the
     *           user-provided one, depending on the format).
916
     */
917
    AVRational time_base;
918

919
    /**
920
     * Decoding: pts of the first frame of the stream in presentation order, in stream time base.
Diego Biurrun's avatar
Diego Biurrun committed
921 922
     * Only set this if you are absolutely 100% sure that the value you set
     * it to really is the pts of the first frame.
923
     * This may be undefined (AV_NOPTS_VALUE).
924 925
     * @note The ASF header does NOT contain a correct start_time the ASF
     * demuxer must NOT set this.
926
     */
927
    int64_t start_time;
928

929
    /**
Diego Biurrun's avatar
Diego Biurrun committed
930
     * Decoding: duration of the stream, in stream time base.
931
     * If a source file does not specify a duration, but does specify
Diego Biurrun's avatar
Diego Biurrun committed
932
     * a bitrate, this value will be estimated from bitrate and file size.
933 934 935
     *
     * Encoding: May be set by the caller before avformat_write_header() to
     * provide a hint to the muxer about the estimated duration.
936
     */
937
    int64_t duration;
938

939
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
940

Diego Biurrun's avatar
Diego Biurrun committed
941
    int disposition; /**< AV_DISPOSITION_* bit field */
942

943 944
    enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.

945 946 947 948 949 950
    /**
     * sample aspect ratio (0 if unknown)
     * - encoding: Set by user.
     * - decoding: Set by libavformat.
     */
    AVRational sample_aspect_ratio;
951

952
    AVDictionary *metadata;
953

954 955
    /**
     * Average framerate
956 957 958 959
     *
     * - demuxing: May be set by libavformat when creating the stream or in
     *             avformat_find_stream_info().
     * - muxing: May be set by the caller before avformat_write_header().
960 961
     */
    AVRational avg_frame_rate;
962

963 964 965 966 967 968 969 970 971
    /**
     * For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet
     * will contain the attached picture.
     *
     * decoding: set by libavformat, must not be modified by the caller.
     * encoding: unused
     */
    AVPacket attached_pic;

972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
    /**
     * An array of side data that applies to the whole stream (i.e. the
     * container does not allow it to change between packets).
     *
     * There may be no overlap between the side data in this array and side data
     * in the packets. I.e. a given side data is either exported by the muxer
     * (demuxing) / set by the caller (muxing) in this array, then it never
     * appears in the packets, or the side data is exported / sent through
     * the packets (always in the first packet where the value becomes known or
     * changes), then it does not appear in this array.
     *
     * - demuxing: Set by libavformat when the stream is created.
     * - muxing: May be set by the caller before avformat_write_header().
     *
     * Freed by libavformat in avformat_free_context().
987 988
     *
     * @see av_format_inject_global_side_data()
989 990 991 992 993 994 995
     */
    AVPacketSideData *side_data;
    /**
     * The number of elements in the AVStream.side_data array.
     */
    int            nb_side_data;

996 997 998 999 1000 1001 1002 1003
    /**
     * Flags for the user to detect events happening on the stream. Flags must
     * be cleared by the user once the event has been handled.
     * A combination of AVSTREAM_EVENT_FLAG_*.
     */
    int event_flags;
#define AVSTREAM_EVENT_FLAG_METADATA_UPDATED 0x0001 ///< The call resulted in updated metadata.

1004 1005 1006 1007
    /*****************************************************************
     * All fields below this line are not part of the public API. They
     * may not be used outside of libavformat and can be changed and
     * removed at will.
1008 1009 1010
     * Internal note: be aware that physically removing these fields
     * will break ABI. Replace removed fields with dummy fields, and
     * add new fields to AVStreamInternal.
1011 1012 1013
     *****************************************************************
     */

1014
    /**
1015
     * Stream information used internally by avformat_find_stream_info()
1016
     */
1017
#define MAX_STD_TIMEBASES (30*12+30+3+6)
1018 1019 1020 1021
    struct {
        int64_t last_dts;
        int64_t duration_gcd;
        int duration_count;
1022
        int64_t rfps_duration_sum;
1023
        double (*duration_error)[2][MAX_STD_TIMEBASES];
1024
        int64_t codec_info_duration;
1025
        int64_t codec_info_duration_fields;
1026 1027 1028 1029 1030 1031

        /**
         * 0  -> decoder has not been searched for yet.
         * >0 -> decoder found
         * <0 -> decoder with codec_id == -found_decoder has not been found
         */
1032
        int found_decoder;
1033

1034 1035
        int64_t last_duration;

1036 1037 1038 1039 1040 1041 1042 1043
        /**
         * Those are used for average framerate estimation.
         */
        int64_t fps_first_dts;
        int     fps_first_dts_idx;
        int64_t fps_last_dts;
        int     fps_last_dts_idx;

1044
    } *info;
1045 1046

    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058

    // 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 first_dts;
    int64_t cur_dts;
    int64_t last_IP_pts;
1059
    int last_IP_duration;
1060 1061 1062 1063 1064 1065

    /**
     * Number of packets to buffer for codec probing
     */
    int probe_packets;

1066
    /**
1067
     * Number of frames that have been demuxed during avformat_find_stream_info()
1068 1069 1070 1071 1072 1073 1074
     */
    int codec_info_nb_frames;

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

1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
    /**
     * last packet in packet_buffer for this stream when muxing.
     */
    struct AVPacketList *last_in_packet_buffer;
    AVProbeData probe_data;
#define MAX_REORDER_DELAY 16
    int64_t pts_buffer[MAX_REORDER_DELAY+1];

    AVIndexEntry *index_entries; /**< Only used if the format does not
                                    support seeking natively. */
    int nb_index_entries;
    unsigned int index_entries_allocated_size;

1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
    /**
     * Real base framerate of the stream.
     * This is the lowest framerate with which all timestamps can be
     * represented accurately (it is the least common multiple of all
     * 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
     * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
     *
     * Code outside avformat should access this field using:
     * av_stream_get/set_r_frame_rate(stream)
     */
    AVRational r_frame_rate;

    /**
     * Stream Identifier
     * This is the MPEG-TS stream identifier +1
     * 0 means unknown
     */
    int stream_identifier;

    int64_t interleaver_chunk_size;
    int64_t interleaver_chunk_duration;

1111
    /**
1112 1113 1114 1115
     * stream probing state
     * -1   -> probing finished
     *  0   -> no probing requested
     * rest -> perform probing with request_probe being the minimum score to accept.
1116 1117 1118
     * NOT PART OF PUBLIC API
     */
    int request_probe;
1119 1120 1121 1122 1123
    /**
     * Indicates that everything up to the next keyframe
     * should be discarded.
     */
    int skip_to_keyframe;
1124 1125 1126 1127 1128

    /**
     * Number of samples to skip at the start of the frame decoded from the next packet.
     */
    int skip_samples;
1129

1130 1131 1132 1133 1134 1135 1136 1137 1138
    /**
     * If not 0, the number of samples that should be skipped from the start of
     * the stream (the samples are removed from packets with pts==0, which also
     * assumes negative timestamps do not happen).
     * Intended for use with formats such as mp3 with ad-hoc gapless audio
     * support.
     */
    int64_t start_skip_samples;

1139 1140 1141 1142 1143 1144
    /**
     * If not 0, the first audio sample that should be discarded from the stream.
     * This is broken by design (needs global sample count), but can't be
     * avoided for broken by design formats such as mp3 with ad-hoc gapless
     * audio support.
     */
1145 1146 1147 1148 1149 1150 1151 1152
    int64_t first_discard_sample;

    /**
     * The sample after last sample that is intended to be discarded after
     * first_discard_sample. Works on frame boundaries only. Used to prevent
     * early EOF if the gapless info is broken (considered concatenated mp3s).
     */
    int64_t last_discard_sample;
1153

1154 1155
    /**
     * Number of internally decoded frames, used internally in libavformat, do not access
1156
     * its lifetime differs from info which is why it is not in that structure.
1157 1158
     */
    int nb_decoded_frames;
1159 1160 1161 1162 1163 1164 1165

    /**
     * Timestamp offset added to timestamps before muxing
     * NOT PART OF PUBLIC API
     */
    int64_t mux_ts_offset;

1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
    /**
     * Internal data to check for wrapping of the time stamp
     */
    int64_t pts_wrap_reference;

    /**
     * Options for behavior, when a wrap is detected.
     *
     * Defined by AV_PTS_WRAP_ values.
     *
     * If correction is enabled, there are two possibilities:
     * If the first time stamp is near the wrap point, the wrap offset
     * will be subtracted, which will create negative time stamps.
     * Otherwise the offset will be added.
     */
    int pts_wrap_behavior;

1183 1184 1185 1186
    /**
     * Internal data to prevent doing update_initial_durations() twice
     */
    int update_initial_durations_done;
1187 1188 1189 1190 1191 1192 1193

    /**
     * Internal data to generate dts from pts
     */
    int64_t pts_reorder_error[MAX_REORDER_DELAY+1];
    uint8_t pts_reorder_error_count[MAX_REORDER_DELAY+1];

1194 1195 1196 1197 1198 1199 1200
    /**
     * Internal data to analyze DTS and detect faulty mpeg streams
     */
    int64_t last_dts_for_order_check;
    uint8_t dts_ordered;
    uint8_t dts_misordered;

1201 1202 1203
    /**
     * Internal data to inject global side data
     */
1204
    int inject_global_side_data;
1205

1206 1207 1208 1209 1210 1211
    /*****************************************************************
     * All fields above this line are not part of the public API.
     * Fields below are part of the public API and ABI again.
     *****************************************************************
     */

1212 1213 1214 1215 1216 1217
    /**
     * String containing paris of key and values describing recommended encoder configuration.
     * Paris are separated by ','.
     * Keys are separated from values by '='.
     */
    char *recommended_encoder_configuration;
1218 1219 1220 1221 1222 1223 1224

    /**
     * display aspect ratio (0 if unknown)
     * - encoding: unused
     * - decoding: Set by libavformat to calculate sample_aspect_ratio internally
     */
    AVRational display_aspect_ratio;
1225 1226

    struct FFFrac *priv_pts;
1227

1228 1229 1230 1231 1232
    /**
     * An opaque field for libavformat internal usage.
     * Must not be accessed in any way by callers.
     */
    AVStreamInternal *internal;
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243

    /*
     * Codec parameters associated with this stream. Allocated and freed by
     * libavformat in avformat_new_stream() and avformat_free_context()
     * respectively.
     *
     * - demuxing: filled by libavformat on stream creation or in
     *             avformat_find_stream_info()
     * - muxing: filled by the caller before avformat_write_header()
     */
    AVCodecParameters *codecpar;
Fabrice Bellard's avatar
Fabrice Bellard committed
1244 1245
} AVStream;

1246 1247
AVRational av_stream_get_r_frame_rate(const AVStream *s);
void       av_stream_set_r_frame_rate(AVStream *s, AVRational r);
1248
struct AVCodecParserContext *av_stream_get_parser(const AVStream *s);
1249 1250
char* av_stream_get_recommended_encoder_configuration(const AVStream *s);
void  av_stream_set_recommended_encoder_configuration(AVStream *s, char *configuration);
1251

1252 1253 1254 1255 1256 1257 1258
/**
 * Returns the pts of the last muxed packet + its duration
 *
 * the retuned value is undefined when used with a demuxer.
 */
int64_t    av_stream_get_end_pts(const AVStream *st);

1259 1260
#define AV_PROGRAM_RUNNING 1

1261 1262
/**
 * New fields can be added to the end with minor version bumps.
Diego Biurrun's avatar
Diego Biurrun committed
1263
 * Removal, reordering and changes to existing fields require a major
1264
 * version bump.
Diego Biurrun's avatar
Diego Biurrun committed
1265
 * sizeof(AVProgram) must not be used outside libav*.
1266
 */
1267 1268 1269 1270
typedef struct AVProgram {
    int            id;
    int            flags;
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
1271 1272
    unsigned int   *stream_index;
    unsigned int   nb_stream_indexes;
1273
    AVDictionary *metadata;
1274 1275 1276

    int program_num;
    int pmt_pid;
Kieran Kunhya's avatar
Kieran Kunhya committed
1277
    int pcr_pid;
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287

    /*****************************************************************
     * All fields below this line are not part of the public API. They
     * may not be used outside of libavformat and can be changed and
     * removed at will.
     * New public fields should be added right above.
     *****************************************************************
     */
    int64_t start_time;
    int64_t end_time;
1288 1289 1290

    int64_t pts_wrap_reference;    ///< reference dts for wrap detection
    int pts_wrap_behavior;         ///< behavior on wrap detection
1291 1292
} AVProgram;

1293
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
1294 1295
                                         (streams are added dynamically) */

1296
typedef struct AVChapter {
Diego Biurrun's avatar
Diego Biurrun committed
1297 1298
    int id;                 ///< unique ID to identify the chapter
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
1299
    int64_t start, end;     ///< chapter start/end time in time_base units
1300
    AVDictionary *metadata;
1301 1302
} AVChapter;

1303

1304 1305 1306 1307 1308 1309
/**
 * Callback used by devices to communicate with application.
 */
typedef int (*av_format_control_message)(struct AVFormatContext *s, int type,
                                         void *data, size_t data_size);

1310 1311
typedef int (*AVOpenCallback)(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags,
                              const AVIOInterruptCB *int_cb, AVDictionary **options);
1312

1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
/**
 * The duration of a video can be estimated through various ways, and this enum can be used
 * to know how the duration was estimated.
 */
enum AVDurationEstimationMethod {
    AVFMT_DURATION_FROM_PTS,    ///< Duration accurately estimated from PTSes
    AVFMT_DURATION_FROM_STREAM, ///< Duration estimated from a stream with a known duration
    AVFMT_DURATION_FROM_BITRATE ///< Duration estimated from bitrate (less accurate)
};

1323 1324
typedef struct AVFormatInternal AVFormatInternal;

1325
/**
Diego Biurrun's avatar
Diego Biurrun committed
1326
 * Format I/O context.
1327
 * New fields can be added to the end with minor version bumps.
Diego Biurrun's avatar
Diego Biurrun committed
1328
 * Removal, reordering and changes to existing fields require a major
1329
 * version bump.
1330 1331
 * sizeof(AVFormatContext) must not be used outside libav*, use
 * avformat_alloc_context() to create an AVFormatContext.
1332 1333 1334 1335 1336 1337
 *
 * Fields can be accessed through AVOptions (av_opt*),
 * the name string used matches the associated command line parameter name and
 * can be found in libavformat/options_table.h.
 * The AVOption/command line parameter names differ in some cases from the C
 * structure field names for historic reasons or brevity.
1338
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
1339
typedef struct AVFormatContext {
1340
    /**
1341
     * A class for logging and @ref avoptions. Set by avformat_alloc_context().
1342 1343 1344 1345 1346
     * Exports (de)muxer private options if they exist.
     */
    const AVClass *av_class;

    /**
1347
     * The input container format.
1348
     *
1349
     * Demuxing only, set by avformat_open_input().
1350
     */
1351
    struct AVInputFormat *iformat;
1352 1353 1354 1355 1356 1357

    /**
     * The output container format.
     *
     * Muxing only, must be set by the caller before avformat_write_header().
     */
1358
    struct AVOutputFormat *oformat;
1359 1360 1361 1362

    /**
     * Format private data. This is an AVOptions-enabled struct
     * if and only if iformat/oformat.priv_class is not NULL.
1363 1364 1365
     *
     * - muxing: set by avformat_write_header()
     * - demuxing: set by avformat_open_input()
1366
     */
Fabrice Bellard's avatar
Fabrice Bellard committed
1367
    void *priv_data;
1368

1369
    /**
1370 1371
     * I/O context.
     *
1372 1373 1374 1375
     * - demuxing: either set by the user before avformat_open_input() (then
     *             the user must close it manually) or set by avformat_open_input().
     * - muxing: set by the user before avformat_write_header(). The caller must
     *           take care of closing / freeing the IO context.
1376 1377 1378 1379 1380
     *
     * Do NOT set this field if AVFMT_NOFILE flag is set in
     * iformat/oformat.flags. In such a case, the (de)muxer will handle
     * I/O in some other way and this field will be NULL.
     */
1381
    AVIOContext *pb;
1382

1383
    /* stream info */
1384 1385 1386 1387 1388
    /**
     * Flags signalling stream properties. A combination of AVFMTCTX_*.
     * Set by libavformat.
     */
    int ctx_flags;
1389

1390 1391 1392 1393 1394 1395
    /**
     * Number of elements in AVFormatContext.streams.
     *
     * Set by avformat_new_stream(), must not be modified by any other code.
     */
    unsigned int nb_streams;
1396 1397 1398 1399
    /**
     * A list of all streams in the file. New streams are created with
     * avformat_new_stream().
     *
1400 1401 1402 1403 1404 1405
     * - demuxing: streams are created by libavformat in avformat_open_input().
     *             If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
     *             appear in av_read_frame().
     * - muxing: streams are created by the user before avformat_write_header().
     *
     * Freed by libavformat in avformat_free_context().
1406
     */
1407
    AVStream **streams;
1408

1409 1410 1411 1412 1413 1414 1415
    /**
     * input or output filename
     *
     * - demuxing: set by avformat_open_input()
     * - muxing: may be set by the caller before avformat_write_header()
     */
    char filename[1024];
1416

1417
    /**
1418
     * Position of the first frame of the component, in
1419 1420
     * AV_TIME_BASE fractional seconds. NEVER set this value directly:
     * It is deduced from the AVStream values.
1421 1422
     *
     * Demuxing only, set by libavformat.
1423
     */
1424
    int64_t start_time;
1425 1426

    /**
1427
     * Duration of the stream, in AV_TIME_BASE fractional
1428
     * seconds. Only set this value if you know none of the individual stream
1429
     * durations and also do not set any of them. This is deduced from the
1430
     * AVStream values if not set.
1431 1432
     *
     * Demuxing only, set by libavformat.
1433
     */
1434
    int64_t duration;
1435 1436

    /**
1437
     * Total stream bitrate in bit/s, 0 if not
1438
     * available. Never set it directly if the file_size and the
1439
     * duration are known as FFmpeg can compute it automatically.
1440
     */
1441
    int64_t bit_rate;
1442

1443
    unsigned int packet_size;
1444
    int max_delay;
1445

1446 1447 1448 1449
    /**
     * Flags modifying the (de)muxer behaviour. A combination of AVFMT_FLAG_*.
     * Set by the user before avformat_open_input() / avformat_write_header().
     */
1450
    int flags;
1451
#define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
Diego Biurrun's avatar
Diego Biurrun committed
1452 1453
#define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
1454
#define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
1455 1456
#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
1457
#define AVFMT_FLAG_NOBUFFER     0x0040 ///< Do not buffer frames when possible
1458
#define AVFMT_FLAG_CUSTOM_IO    0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
1459
#define AVFMT_FLAG_DISCARD_CORRUPT  0x0100 ///< Discard frames marked corrupted
1460
#define AVFMT_FLAG_FLUSH_PACKETS    0x0200 ///< Flush the AVIOContext every packet.
1461 1462 1463 1464 1465 1466 1467
/**
 * When muxing, try to avoid writing any random/volatile data to the output.
 * This includes any random IDs, real-time timestamps/dates, muxer version, etc.
 *
 * This flag is mainly intended for testing.
 */
#define AVFMT_FLAG_BITEXACT         0x0400
1468
#define AVFMT_FLAG_MP4A_LATM    0x8000 ///< Enable RTP MP4A-LATM payload
1469
#define AVFMT_FLAG_SORT_DTS    0x10000 ///< try to interleave outputted packets by dts (using this flag can slow demuxing down)
1470
#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)
1471 1472 1473
#if FF_API_LAVF_KEEPSIDE_FLAG
#define AVFMT_FLAG_KEEP_SIDE_DATA 0x40000 ///< Don't merge side data but keep it separate. Deprecated, will be the default.
#endif
1474
#define AVFMT_FLAG_FAST_SEEK   0x80000 ///< Enable fast, but inaccurate seeks for some formats
1475
#define AVFMT_FLAG_SHORTEST   0x100000 ///< Stop muxing when the shortest stream stops.
1476
#define AVFMT_FLAG_AUTO_BSF   0x200000 ///< Wait for packet data before writing a header, and add bitstream filters as requested by the muxer
1477

1478
    /**
1479 1480 1481
     * Maximum size of the data read from input for determining
     * the input container format.
     * Demuxing only, set by the caller before avformat_open_input().
1482
     */
1483
    int64_t probesize;
1484 1485

    /**
1486 1487 1488 1489
     * Maximum duration (in AV_TIME_BASE units) of the data read
     * from input in avformat_find_stream_info().
     * Demuxing only, set by the caller before avformat_find_stream_info().
     * Can be set to 0 to let avformat choose using a heuristic.
1490
     */
1491
    int64_t max_analyze_duration;
1492 1493 1494

    const uint8_t *key;
    int keylen;
1495 1496 1497

    unsigned int nb_programs;
    AVProgram **programs;
1498 1499 1500

    /**
     * Forced video codec_id.
Diego Biurrun's avatar
Diego Biurrun committed
1501
     * Demuxing: Set by user.
1502
     */
1503
    enum AVCodecID video_codec_id;
1504

1505 1506
    /**
     * Forced audio codec_id.
Diego Biurrun's avatar
Diego Biurrun committed
1507
     * Demuxing: Set by user.
1508
     */
1509
    enum AVCodecID audio_codec_id;
1510

1511 1512
    /**
     * Forced subtitle codec_id.
Diego Biurrun's avatar
Diego Biurrun committed
1513
     * Demuxing: Set by user.
1514
     */
1515
    enum AVCodecID subtitle_codec_id;
1516 1517

    /**
1518 1519
     * 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
1520 1521
     * 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
1522
     * Demuxers for which a full in-memory index is mandatory will ignore
1523
     * this.
1524 1525
     * - muxing: unused
     * - demuxing: set by user
1526 1527
     */
    unsigned int max_index_size;
1528 1529

    /**
Ramiro Polla's avatar
Ramiro Polla committed
1530
     * Maximum amount of memory in bytes to use for buffering frames
Diego Biurrun's avatar
Diego Biurrun committed
1531
     * obtained from realtime capture devices.
1532 1533
     */
    unsigned int max_picture_buffer;
1534

1535 1536 1537 1538 1539 1540 1541 1542
    /**
     * Number of chapters in AVChapter array.
     * When muxing, chapters are normally written in the file header,
     * so nb_chapters should normally be initialized before write_header
     * is called. Some muxers (e.g. mov and mkv) can also write chapters
     * in the trailer.  To write chapters in the trailer, nb_chapters
     * must be zero when write_header is called and non-zero when
     * write_trailer is called.
1543 1544
     * - muxing: set by user
     * - demuxing: set by libavformat
1545
     */
1546
    unsigned int nb_chapters;
1547
    AVChapter **chapters;
1548

1549 1550 1551 1552 1553 1554 1555 1556
    /**
     * Metadata that applies to the whole file.
     *
     * - demuxing: set by libavformat in avformat_open_input()
     * - muxing: may be set by the caller before avformat_write_header()
     *
     * Freed by libavformat in avformat_free_context().
     */
1557
    AVDictionary *metadata;
1558

1559 1560
    /**
     * Start time of the stream in real world time, in microseconds
1561 1562
     * since the Unix epoch (00:00 1st January 1970). That is, pts=0 in the
     * stream was captured at this real world time.
1563 1564 1565 1566 1567 1568
     * - muxing: Set by the caller before avformat_write_header(). If set to
     *           either 0 or AV_NOPTS_VALUE, then the current wall-time will
     *           be used.
     * - demuxing: Set by libavformat. AV_NOPTS_VALUE if unknown. Note that
     *             the value may become known after some number of frames
     *             have been received.
1569 1570
     */
    int64_t start_time_realtime;
1571 1572

    /**
1573 1574 1575
     * The number of frames used for determining the framerate in
     * avformat_find_stream_info().
     * Demuxing only, set by the caller before avformat_find_stream_info().
1576 1577
     */
    int fps_probe_size;
1578

1579 1580 1581
    /**
     * Error recognition; higher values will detect more errors but may
     * misdetect some more or less valid parts as errors.
1582
     * Demuxing only, set by the caller before avformat_open_input().
1583 1584
     */
    int error_recognition;
1585

1586 1587 1588
    /**
     * Custom interrupt callbacks for the I/O layer.
     *
1589 1590
     * demuxing: set by the user before avformat_open_input().
     * muxing: set by the user before avformat_write_header()
1591 1592 1593 1594 1595 1596
     * (mainly useful for AVFMT_NOFILE formats). The callback
     * should also be passed to avio_open2() if it's used to
     * open the file.
     */
    AVIOInterruptCB interrupt_callback;

1597 1598 1599 1600 1601
    /**
     * Flags to enable debugging.
     */
    int debug;
#define FF_FDEBUG_TS        0x0001
1602

1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620
    /**
     * Maximum buffering duration for interleaving.
     *
     * To ensure all the streams are interleaved correctly,
     * av_interleaved_write_frame() will wait until it has at least one packet
     * for each stream before actually writing any packets to the output file.
     * When some streams are "sparse" (i.e. there are large gaps between
     * successive packets), this can result in excessive buffering.
     *
     * This field specifies the maximum difference between the timestamps of the
     * first and the last packet in the muxing queue, above which libavformat
     * will output a packet regardless of whether it has queued a packet for all
     * the streams.
     *
     * Muxing only, set by the caller before avformat_write_header().
     */
    int64_t max_interleave_delta;

1621 1622 1623 1624 1625
    /**
     * Allow non-standard and experimental extension
     * @see AVCodecContext.strict_std_compliance
     */
    int strict_std_compliance;
1626

1627 1628 1629 1630 1631 1632 1633 1634
    /**
     * Flags for the user to detect events happening on the file. Flags must
     * be cleared by the user once the event has been handled.
     * A combination of AVFMT_EVENT_FLAG_*.
     */
    int event_flags;
#define AVFMT_EVENT_FLAG_METADATA_UPDATED 0x0001 ///< The call resulted in updated metadata.

1635 1636 1637 1638 1639 1640
    /**
     * Maximum number of packets to read while waiting for the first timestamp.
     * Decoding only.
     */
    int max_ts_probe;

1641 1642 1643
    /**
     * Avoid negative timestamps during muxing.
     * Any value of the AVFMT_AVOID_NEG_TS_* constants.
1644
     * Note, this only works when using av_interleaved_write_frame. (interleave_packet_per_dts is in use)
1645 1646 1647 1648 1649 1650 1651 1652
     * - muxing: Set by user
     * - demuxing: unused
     */
    int avoid_negative_ts;
#define AVFMT_AVOID_NEG_TS_AUTO             -1 ///< Enabled when required by target format
#define AVFMT_AVOID_NEG_TS_MAKE_NON_NEGATIVE 1 ///< Shift timestamps so they are non negative
#define AVFMT_AVOID_NEG_TS_MAKE_ZERO         2 ///< Shift timestamps so that they start at 0

1653 1654 1655 1656 1657
    /**
     * Transport stream id.
     * This will be moved into demuxer private options. Thus no API/ABI compatibility
     */
    int ts_id;
1658

1659 1660 1661
    /**
     * Audio preload in microseconds.
     * Note, not all formats support this and unpredictable things may happen if it is used when not supported.
1662
     * - encoding: Set by user
1663 1664 1665
     * - decoding: unused
     */
    int audio_preload;
1666

1667 1668 1669
    /**
     * Max chunk time in microseconds.
     * Note, not all formats support this and unpredictable things may happen if it is used when not supported.
1670
     * - encoding: Set by user
1671 1672 1673 1674 1675 1676 1677
     * - decoding: unused
     */
    int max_chunk_duration;

    /**
     * Max chunk size in bytes
     * Note, not all formats support this and unpredictable things may happen if it is used when not supported.
1678
     * - encoding: Set by user
1679 1680 1681 1682
     * - decoding: unused
     */
    int max_chunk_size;

1683 1684 1685 1686
    /**
     * forces the use of wallclock timestamps as pts/dts of packets
     * This has undefined results in the presence of B frames.
     * - encoding: unused
1687
     * - decoding: Set by user
1688 1689 1690
     */
    int use_wallclock_as_timestamps;

1691
    /**
1692 1693
     * avio flags, used to force AVIO_FLAG_DIRECT.
     * - encoding: unused
1694
     * - decoding: Set by user
1695 1696 1697 1698 1699 1700 1701
     */
    int avio_flags;

    /**
     * The duration field can be estimated through various ways, and this field can be used
     * to know how the duration was estimated.
     * - encoding: unused
1702
     * - decoding: Read by user
1703 1704 1705
     */
    enum AVDurationEstimationMethod duration_estimation_method;

1706 1707 1708
    /**
     * Skip initial bytes when opening stream
     * - encoding: unused
1709
     * - decoding: Set by user
1710
     */
1711
    int64_t skip_initial_bytes;
1712

1713 1714 1715
    /**
     * Correct single timestamp overflows
     * - encoding: unused
1716
     * - decoding: Set by user
1717 1718 1719
     */
    unsigned int correct_ts_overflow;

1720 1721 1722
    /**
     * Force seeking to any (also non key) frames.
     * - encoding: unused
1723
     * - decoding: Set by user
1724 1725 1726
     */
    int seek2any;

1727 1728
    /**
     * Flush the I/O context after each packet.
1729
     * - encoding: Set by user
1730 1731 1732 1733
     * - decoding: unused
     */
    int flush_packets;

1734 1735 1736 1737 1738
    /**
     * format probing score.
     * The maximal score is AVPROBE_SCORE_MAX, its set when the demuxer probes
     * the format.
     * - encoding: unused
1739
     * - decoding: set by avformat, read by user
1740 1741 1742
     */
    int probe_score;

1743 1744 1745
    /**
     * number of bytes to read maximally to identify format.
     * - encoding: unused
1746
     * - decoding: set by user
1747 1748 1749
     */
    int format_probesize;

1750
    /**
1751
     * ',' separated list of allowed decoders.
1752 1753
     * If NULL then all are allowed
     * - encoding: unused
1754
     * - decoding: set by user
1755 1756 1757 1758
     */
    char *codec_whitelist;

    /**
1759
     * ',' separated list of allowed demuxers.
1760 1761
     * If NULL then all are allowed
     * - encoding: unused
1762
     * - decoding: set by user
1763 1764 1765
     */
    char *format_whitelist;

1766 1767 1768 1769 1770
    /**
     * An opaque field for libavformat internal usage.
     * Must not be accessed in any way by callers.
     */
    AVFormatInternal *internal;
1771

1772 1773 1774 1775 1776 1777 1778
    /**
     * IO repositioned flag.
     * This is set by avformat when the underlaying IO context read pointer
     * is repositioned, for example when doing byte based seeking.
     * Demuxers can use the flag to detect such changes.
     */
    int io_repositioned;
1779 1780 1781 1782 1783

    /**
     * Forced video codec.
     * This allows forcing a specific decoder, even when there are multiple with
     * the same codec_id.
1784
     * Demuxing: Set by user
1785 1786 1787 1788 1789 1790 1791
     */
    AVCodec *video_codec;

    /**
     * Forced audio codec.
     * This allows forcing a specific decoder, even when there are multiple with
     * the same codec_id.
1792
     * Demuxing: Set by user
1793 1794 1795 1796 1797 1798 1799
     */
    AVCodec *audio_codec;

    /**
     * Forced subtitle codec.
     * This allows forcing a specific decoder, even when there are multiple with
     * the same codec_id.
1800
     * Demuxing: Set by user
1801 1802
     */
    AVCodec *subtitle_codec;
1803

1804 1805 1806 1807
    /**
     * Forced data codec.
     * This allows forcing a specific decoder, even when there are multiple with
     * the same codec_id.
1808
     * Demuxing: Set by user
1809 1810 1811
     */
    AVCodec *data_codec;

1812 1813 1814 1815 1816 1817
    /**
     * Number of bytes to be written as padding in a metadata header.
     * Demuxing: Unused.
     * Muxing: Set by user via av_format_set_metadata_header_padding.
     */
    int metadata_header_padding;
1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829

    /**
     * User data.
     * This is a place for some private data of the user.
     */
    void *opaque;

    /**
     * Callback used by devices to communicate with application.
     */
    av_format_control_message control_message_cb;

1830 1831
    /**
     * Output timestamp offset, in microseconds.
1832
     * Muxing: set by user
1833 1834
     */
    int64_t output_ts_offset;
1835

1836
    /**
Michael Niedermayer's avatar
Michael Niedermayer committed
1837
     * dump format separator.
1838 1839 1840 1841 1842
     * can be ", " or "\n      " or anything else
     * - muxing: Set by user.
     * - demuxing: Set by user.
     */
    uint8_t *dump_separator;
1843 1844 1845 1846 1847 1848

    /**
     * Forced Data codec_id.
     * Demuxing: Set by user.
     */
    enum AVCodecID data_codec_id;
1849

1850
#if FF_API_OLD_OPEN_CALLBACKS
1851 1852 1853 1854 1855 1856 1857 1858
    /**
     * Called to open further IO contexts when needed for demuxing.
     *
     * This can be set by the user application to perform security checks on
     * the URLs before opening them.
     * The function should behave like avio_open2(), AVFormatContext is provided
     * as contextual information and to reach AVFormatContext.opaque.
     *
1859
     * If NULL then some simple checks are used together with avio_open2().
1860 1861 1862 1863 1864
     *
     * Must not be accessed directly from outside avformat.
     * @See av_format_set_open_cb()
     *
     * Demuxing: Set by user.
1865 1866
     *
     * @deprecated Use io_open and io_close.
1867
     */
1868
    attribute_deprecated
1869
    int (*open_cb)(struct AVFormatContext *s, AVIOContext **p, const char *url, int flags, const AVIOInterruptCB *int_cb, AVDictionary **options);
1870
#endif
1871 1872

    /**
1873
     * ',' separated list of allowed protocols.
1874
     * - encoding: unused
1875
     * - decoding: set by user
1876
     */
1877
    char *protocol_whitelist;
1878 1879

    /*
1880 1881
     * A callback for opening new IO streams.
     *
1882 1883 1884
     * Whenever a muxer or a demuxer needs to open an IO stream (typically from
     * avformat_open_input() for demuxers, but for certain formats can happen at
     * other times as well), it will call this callback to obtain an IO context.
1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905
     *
     * @param s the format context
     * @param pb on success, the newly opened IO context should be returned here
     * @param url the url to open
     * @param flags a combination of AVIO_FLAG_*
     * @param options a dictionary of additional options, with the same
     *                semantics as in avio_open2()
     * @return 0 on success, a negative AVERROR code on failure
     *
     * @note Certain muxers and demuxers do nesting, i.e. they open one or more
     * additional internal format contexts. Thus the AVFormatContext pointer
     * passed to this callback may be different from the one facing the caller.
     * It will, however, have the same 'opaque' field.
     */
    int (*io_open)(struct AVFormatContext *s, AVIOContext **pb, const char *url,
                   int flags, AVDictionary **options);

    /**
     * A callback for closing the streams opened with AVFormatContext.io_open().
     */
    void (*io_close)(struct AVFormatContext *s, AVIOContext *pb);
1906 1907 1908 1909

    /**
     * ',' separated list of disallowed protocols.
     * - encoding: unused
1910
     * - decoding: set by user
1911 1912
     */
    char *protocol_blacklist;
1913 1914 1915 1916

    /**
     * The maximum number of streams.
     * - encoding: unused
1917
     * - decoding: set by user
1918 1919
     */
    int max_streams;
Fabrice Bellard's avatar
Fabrice Bellard committed
1920 1921
} AVFormatContext;

1922 1923 1924 1925
/**
 * Accessors for some AVFormatContext fields. These used to be provided for ABI
 * compatibility, and do not need to be used anymore.
 */
1926
int av_format_get_probe_score(const AVFormatContext *s);
1927 1928 1929 1930 1931 1932
AVCodec * av_format_get_video_codec(const AVFormatContext *s);
void      av_format_set_video_codec(AVFormatContext *s, AVCodec *c);
AVCodec * av_format_get_audio_codec(const AVFormatContext *s);
void      av_format_set_audio_codec(AVFormatContext *s, AVCodec *c);
AVCodec * av_format_get_subtitle_codec(const AVFormatContext *s);
void      av_format_set_subtitle_codec(AVFormatContext *s, AVCodec *c);
1933 1934
AVCodec * av_format_get_data_codec(const AVFormatContext *s);
void      av_format_set_data_codec(AVFormatContext *s, AVCodec *c);
1935 1936
int       av_format_get_metadata_header_padding(const AVFormatContext *s);
void      av_format_set_metadata_header_padding(AVFormatContext *s, int c);
1937 1938 1939 1940
void *    av_format_get_opaque(const AVFormatContext *s);
void      av_format_set_opaque(AVFormatContext *s, void *opaque);
av_format_control_message av_format_get_control_message_cb(const AVFormatContext *s);
void      av_format_set_control_message_cb(AVFormatContext *s, av_format_control_message callback);
1941 1942 1943 1944
#if FF_API_OLD_OPEN_CALLBACKS
attribute_deprecated AVOpenCallback av_format_get_open_cb(const AVFormatContext *s);
attribute_deprecated void av_format_set_open_cb(AVFormatContext *s, AVOpenCallback callback);
#endif
1945

1946 1947 1948 1949 1950 1951
/**
 * This function will cause global side data to be injected in the next packet
 * of each stream as well as after any subsequent seek.
 */
void av_format_inject_global_side_data(AVFormatContext *s);

1952 1953 1954 1955 1956
/**
 * Returns the method used to set ctx->duration.
 *
 * @return AVFMT_DURATION_FROM_PTS, AVFMT_DURATION_FROM_STREAM, or AVFMT_DURATION_FROM_BITRATE.
 */
1957
enum AVDurationEstimationMethod av_fmt_ctx_get_duration_estimation_method(const AVFormatContext* ctx);
1958

Fabrice Bellard's avatar
Fabrice Bellard committed
1959 1960 1961 1962 1963
typedef struct AVPacketList {
    AVPacket pkt;
    struct AVPacketList *next;
} AVPacketList;

1964

1965
/**
1966 1967 1968 1969 1970 1971
 * @defgroup lavf_core Core functions
 * @ingroup libavf
 *
 * Functions for querying libavformat capabilities, allocating core structures,
 * etc.
 * @{
1972 1973 1974
 */

/**
1975
 * Return the LIBAVFORMAT_VERSION_INT constant.
1976
 */
1977
unsigned avformat_version(void);
1978 1979

/**
1980
 * Return the libavformat build-time configuration.
1981
 */
1982
const char *avformat_configuration(void);
1983 1984

/**
1985
 * Return the libavformat license.
1986
 */
1987
const char *avformat_license(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
1988

1989
/**
1990 1991 1992
 * Initialize libavformat and register all the muxers, demuxers and
 * protocols. If you do not call this function, then you can select
 * exactly which formats you want to support.
1993
 *
1994 1995
 * @see av_register_input_format()
 * @see av_register_output_format()
1996
 */
1997 1998 1999 2000
void av_register_all(void);

void av_register_input_format(AVInputFormat *format);
void av_register_output_format(AVOutputFormat *format);
2001 2002

/**
2003 2004 2005
 * Do global initialization of network components. This is optional,
 * but recommended, since it avoids the overhead of implicitly
 * doing the setup for each session.
2006
 *
2007 2008
 * Calling this function will become mandatory if using network
 * protocols at some major version bump.
2009
 */
2010
int avformat_network_init(void);
2011 2012

/**
2013
 * Undo the initialization done by avformat_network_init.
2014
 */
2015
int avformat_network_deinit(void);
2016

2017 2018
/**
 * If f is NULL, returns the first registered input format,
2019
 * if f is non-NULL, returns the next registered input format after f
2020 2021
 * or NULL if f is the last one.
 */
2022
AVInputFormat  *av_iformat_next(const AVInputFormat  *f);
Fabrice Bellard's avatar
Fabrice Bellard committed
2023

2024
/**
2025
 * If f is NULL, returns the first registered output format,
2026
 * if f is non-NULL, returns the next registered output format after f
2027
 * or NULL if f is the last one.
2028
 */
2029
AVOutputFormat *av_oformat_next(const AVOutputFormat *f);
2030

2031 2032 2033 2034 2035 2036
/**
 * Allocate an AVFormatContext.
 * avformat_free_context() can be used to free the context and everything
 * allocated by the framework within it.
 */
AVFormatContext *avformat_alloc_context(void);
2037

2038
/**
2039 2040
 * Free an AVFormatContext and all its streams.
 * @param s context to free
2041
 */
2042
void avformat_free_context(AVFormatContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
2043

2044
/**
2045 2046
 * Get the AVClass for AVFormatContext. It can be used in combination with
 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
2047
 *
2048
 * @see av_opt_find().
2049
 */
2050
const AVClass *avformat_get_class(void);
2051 2052

/**
2053
 * Add a new stream to a media file.
2054
 *
2055 2056 2057 2058 2059 2060
 * When demuxing, it is called by the demuxer in read_header(). If the
 * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
 * be called in read_packet().
 *
 * When muxing, should be called by the user before avformat_write_header().
 *
2061 2062 2063
 * User is required to call avcodec_close() and avformat_free_context() to
 * clean up the allocation by avformat_new_stream().
 *
2064
 * @param s media file handle
2065 2066 2067 2068 2069
 * @param c If non-NULL, the AVCodecContext corresponding to the new stream
 * will be initialized to use this codec. This is needed for e.g. codec-specific
 * defaults to be set, so codec should be provided if it is known.
 *
 * @return newly created stream or NULL on error.
2070
 */
2071
AVStream *avformat_new_stream(AVFormatContext *s, const AVCodec *c);
2072

2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087
/**
 * Wrap an existing array as stream side data.
 *
 * @param st stream
 * @param type side information type
 * @param data the side data array. It must be allocated with the av_malloc()
 *             family of functions. The ownership of the data is transferred to
 *             st.
 * @param size side information size
 * @return zero on success, a negative AVERROR code on failure. On failure,
 *         the stream is unchanged and the data remains owned by the caller.
 */
int av_stream_add_side_data(AVStream *st, enum AVPacketSideDataType type,
                            uint8_t *data, size_t size);

2088 2089 2090 2091 2092 2093 2094 2095 2096 2097
/**
 * Allocate new information from stream.
 *
 * @param stream stream
 * @param type desired side information type
 * @param size side information size
 * @return pointer to fresh allocated data or NULL otherwise
 */
uint8_t *av_stream_new_side_data(AVStream *stream,
                                 enum AVPacketSideDataType type, int size);
2098 2099 2100 2101 2102 2103 2104 2105
/**
 * Get side information from stream.
 *
 * @param stream stream
 * @param type desired side information type
 * @param size pointer for side information size to store (optional)
 * @return pointer to data if present or NULL otherwise
 */
2106
#if FF_API_NOCONST_GET_SIDE_DATA
2107 2108
uint8_t *av_stream_get_side_data(AVStream *stream,
                                 enum AVPacketSideDataType type, int *size);
2109 2110 2111 2112
#else
uint8_t *av_stream_get_side_data(const AVStream *stream,
                                 enum AVPacketSideDataType type, int *size);
#endif
2113

2114
AVProgram *av_new_program(AVFormatContext *s, int id);
2115

2116
/**
2117
 * @}
2118
 */
2119 2120


2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139
/**
 * 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
 */
int avformat_alloc_output_context2(AVFormatContext **ctx, AVOutputFormat *oformat,
                                   const char *format_name, const char *filename);

2140 2141 2142 2143
/**
 * @addtogroup lavf_decoding
 * @{
 */
2144 2145

/**
2146
 * Find AVInputFormat based on the short name of the input format.
2147
 */
2148
AVInputFormat *av_find_input_format(const char *short_name);
2149 2150

/**
2151
 * Guess the file format.
2152
 *
2153
 * @param pd        data to be probed
Diego Biurrun's avatar
Diego Biurrun committed
2154 2155
 * @param is_opened Whether the file is already opened; determines whether
 *                  demuxers with or without AVFMT_NOFILE are probed.
2156
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
2157
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
2158

2159
/**
2160
 * Guess the file format.
2161
 *
2162
 * @param pd        data to be probed
2163 2164
 * @param is_opened Whether the file is already opened; determines whether
 *                  demuxers with or without AVFMT_NOFILE are probed.
2165 2166 2167 2168
 * @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
2169 2170 2171 2172
 *                  to retry with a larger probe buffer.
 */
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);

2173 2174 2175 2176 2177 2178 2179 2180 2181
/**
 * 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);

2182 2183 2184 2185 2186 2187 2188 2189
/**
 * 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
2190
 * @param url the url of the stream
2191 2192 2193
 * @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)
2194 2195
 * @return the score in case of success, a negative value corresponding to an
 *         the maximal score is AVPROBE_SCORE_MAX
2196 2197
 * AVERROR code otherwise
 */
2198
int av_probe_input_buffer2(AVIOContext *pb, AVInputFormat **fmt,
2199
                           const char *url, void *logctx,
2200 2201 2202 2203 2204
                           unsigned int offset, unsigned int max_probe_size);

/**
 * Like av_probe_input_buffer2() but returns 0 on success
 */
2205
int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
2206
                          const char *url, void *logctx,
2207 2208
                          unsigned int offset, unsigned int max_probe_size);

2209 2210
/**
 * Open an input stream and read the header. The codecs are not opened.
2211
 * The stream must be closed with avformat_close_input().
2212 2213 2214 2215 2216
 *
 * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
 *           May be a pointer to NULL, in which case an AVFormatContext is allocated by this
 *           function and written into ps.
 *           Note that a user-supplied AVFormatContext will be freed on failure.
2217
 * @param url URL of the stream to open.
2218 2219 2220 2221 2222 2223 2224 2225 2226 2227
 * @param fmt If non-NULL, this parameter forces a specific input format.
 *            Otherwise the format is autodetected.
 * @param options  A dictionary filled with AVFormatContext and demuxer-private options.
 *                 On return this parameter will be destroyed and replaced with a dict containing
 *                 options that were not found. May be NULL.
 *
 * @return 0 on success, a negative AVERROR on failure.
 *
 * @note If you want to use custom IO, preallocate the format context and set its pb field.
 */
2228
int avformat_open_input(AVFormatContext **ps, const char *url, AVInputFormat *fmt, AVDictionary **options);
2229

2230 2231
attribute_deprecated
int av_demuxer_open(AVFormatContext *ic);
2232

2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254
/**
 * Read packets of a media file to get stream information. This
 * is useful for file formats with no headers such as MPEG. This
 * function also computes the real framerate in case of MPEG-2 repeat
 * 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
 * @param options  If non-NULL, an ic.nb_streams long array of pointers to
 *                 dictionaries, where i-th member contains options for
 *                 codec corresponding to i-th stream.
 *                 On return each dictionary will be filled with options that were not found.
 * @return >=0 if OK, AVERROR_xxx on error
 *
 * @note this function isn't guaranteed to open all the codecs, so
 *       options being non-empty at return is a perfectly normal behavior.
 *
 * @todo Let the user decide somehow what information is needed so that
 *       we do not waste time getting stuff the user does not need.
 */
int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
2255

2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267
/**
 * Find the programs which belong to a given stream.
 *
 * @param ic    media file handle
 * @param last  the last found program, the search will start after this
 *              program, or from the beginning if it is NULL
 * @param s     stream index
 * @return the next program which belongs to s, NULL if no program is found or
 *         the last program is not among the programs of ic.
 */
AVProgram *av_find_program_from_stream(AVFormatContext *ic, AVProgram *last, int s);

2268 2269
void av_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);

2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300
/**
 * 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);

2301
/**
2302
 * Return the next frame of a stream.
2303 2304 2305 2306 2307
 * 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.
2308
 *
2309
 * If pkt->buf is NULL, then the packet is valid until the next
2310 2311
 * av_read_frame() or until avformat_close_input(). Otherwise the packet
 * is valid indefinitely. In both cases the packet must be freed with
2312
 * av_packet_unref when it is no longer needed. For video, the packet contains
2313 2314 2315
 * 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.
2316 2317
 *
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
2318
 * values in AVStream.time_base units (and guessed if the format cannot
Diego Biurrun's avatar
Diego Biurrun committed
2319 2320
 * 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
2321 2322
 * decompress the payload.
 *
Diego Biurrun's avatar
Diego Biurrun committed
2323
 * @return 0 if OK, < 0 on error or end of file
2324
 */
2325
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
2326 2327

/**
2328
 * Seek to the keyframe at timestamp.
2329
 * 'timestamp' in 'stream_index'.
2330 2331
 *
 * @param s media file handle
2332 2333 2334
 * @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
2335 2336
 * @param timestamp Timestamp in AVStream.time_base units
 *        or, if no stream is specified, in AV_TIME_BASE units.
2337 2338 2339
 * @param flags flags which select direction and seeking mode
 * @return >= 0 on success
 */
2340 2341
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
                  int flags);
2342

2343
/**
2344
 * Seek to timestamp ts.
2345 2346 2347 2348
 * 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.
 *
2349
 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
2350
 * are the file position (this may not be supported by all demuxers).
2351
 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
2352
 * in the stream with stream_index (this may not be supported by all demuxers).
2353 2354 2355
 * 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
2356
 * keyframes (this may not be supported by all demuxers).
2357
 * If flags contain AVSEEK_FLAG_BACKWARD, it is ignored.
2358
 *
2359
 * @param s media file handle
2360
 * @param stream_index index of the stream which is used as time base reference
2361 2362 2363 2364
 * @param min_ts smallest acceptable timestamp
 * @param ts target timestamp
 * @param max_ts largest acceptable timestamp
 * @param flags flags
2365
 * @return >=0 on success, error code otherwise
2366
 *
2367
 * @note This is part of the new seek API which is still under construction.
2368 2369
 *       Thus do not use this yet. It may change at any time, do not expect
 *       ABI compatibility yet!
2370 2371 2372
 */
int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);

wm4's avatar
wm4 committed
2373 2374
/**
 * Discard all internally buffered data. This can be useful when dealing with
2375 2376 2377
 * discontinuities in the byte stream. Generally works only with formats that
 * can resync. This includes headerless formats like MPEG-TS/TS but should also
 * work with NUT, Ogg and in a limited way AVI for example.
wm4's avatar
wm4 committed
2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390
 *
 * The set of streams, the detected duration, stream parameters and codecs do
 * not change when calling this function. If you want a complete reset, it's
 * better to open a new AVFormatContext.
 *
 * This does not flush the AVIOContext (s->pb). If necessary, call
 * avio_flush(s->pb) before calling this function.
 *
 * @param s media file handle
 * @return >=0 on success, error code otherwise
 */
int avformat_flush(AVFormatContext *s);

2391
/**
2392
 * Start playing a network-based stream (e.g. RTSP stream) at the
Diego Biurrun's avatar
Diego Biurrun committed
2393
 * current position.
2394
 */
2395
int av_read_play(AVFormatContext *s);
2396 2397

/**
2398
 * Pause a network-based stream (e.g. RTSP stream).
2399 2400 2401
 *
 * Use av_read_play() to resume it.
 */
2402
int av_read_pause(AVFormatContext *s);
2403

2404
/**
2405 2406
 * Close an opened input AVFormatContext. Free it and all its contents
 * and set *s to NULL.
2407
 */
2408
void avformat_close_input(AVFormatContext **s);
2409
/**
2410
 * @}
2411 2412
 */

2413 2414
#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
2415
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
2416
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
2417

2418 2419 2420 2421
/**
 * @addtogroup lavf_encoding
 * @{
 */
2422 2423 2424 2425

#define AVSTREAM_INIT_IN_WRITE_HEADER 0 ///< stream parameters initialized in avformat_write_header
#define AVSTREAM_INIT_IN_INIT_OUTPUT  1 ///< stream parameters initialized in avformat_init_output

2426 2427 2428 2429 2430 2431
/**
 * Allocate the stream private data and write the stream header to
 * an output media file.
 *
 * @param s Media file handle, must be allocated with avformat_alloc_context().
 *          Its oformat field must be set to the desired output format;
Diego Biurrun's avatar
Diego Biurrun committed
2432
 *          Its pb field must be set to an already opened AVIOContext.
2433 2434 2435 2436
 * @param options  An AVDictionary filled with AVFormatContext and muxer-private options.
 *                 On return this parameter will be destroyed and replaced with a dict containing
 *                 options that were not found. May be NULL.
 *
2437 2438 2439
 * @return AVSTREAM_INIT_IN_WRITE_HEADER on success if the codec had not already been fully initialized in avformat_init,
 *         AVSTREAM_INIT_IN_INIT_OUTPUT  on success if the codec had already been fully initialized in avformat_init,
 *         negative AVERROR on failure.
2440
 *
2441
 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next, avformat_init_output.
2442
 */
2443
av_warn_unused_result
2444 2445
int avformat_write_header(AVFormatContext *s, AVDictionary **options);

2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467
/**
 * Allocate the stream private data and initialize the codec, but do not write the header.
 * May optionally be used before avformat_write_header to initialize stream parameters
 * before actually writing the header.
 * If using this function, do not pass the same options to avformat_write_header.
 *
 * @param s Media file handle, must be allocated with avformat_alloc_context().
 *          Its oformat field must be set to the desired output format;
 *          Its pb field must be set to an already opened AVIOContext.
 * @param options  An AVDictionary filled with AVFormatContext and muxer-private options.
 *                 On return this parameter will be destroyed and replaced with a dict containing
 *                 options that were not found. May be NULL.
 *
 * @return AVSTREAM_INIT_IN_WRITE_HEADER on success if the codec requires avformat_write_header to fully initialize,
 *         AVSTREAM_INIT_IN_INIT_OUTPUT  on success if the codec has been fully initialized,
 *         negative AVERROR on failure.
 *
 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next, avformat_write_header.
 */
av_warn_unused_result
int avformat_init_output(AVFormatContext *s, AVDictionary **options);

2468
/**
2469
 * Write a packet to an output media file.
2470
 *
2471 2472 2473 2474 2475
 * This function passes the packet directly to the muxer, without any buffering
 * or reordering. The caller is responsible for correctly interleaving the
 * packets if the format requires it. Callers that want libavformat to handle
 * the interleaving should call av_interleaved_write_frame() instead of this
 * function.
2476 2477
 *
 * @param s media file handle
2478
 * @param pkt The packet containing the data to be written. Note that unlike
2479 2480 2481
 *            av_interleaved_write_frame(), this function does not take
 *            ownership of the packet passed to it (though some muxers may make
 *            an internal reference to the input packet).
2482
 *            <br>
2483 2484 2485 2486
 *            This parameter can be NULL (at any time, not just at the end), in
 *            order to immediately flush data buffered within the muxer, for
 *            muxers that buffer up data internally before writing it to the
 *            output.
2487
 *            <br>
2488 2489
 *            Packet's @ref AVPacket.stream_index "stream_index" field must be
 *            set to the index of the corresponding stream in @ref
2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500
 *            AVFormatContext.streams "s->streams".
 *            <br>
 *            The timestamps (@ref AVPacket.pts "pts", @ref AVPacket.dts "dts")
 *            must be set to correct values in the stream's timebase (unless the
 *            output format is flagged with the AVFMT_NOTIMESTAMPS flag, then
 *            they can be set to AV_NOPTS_VALUE).
 *            The dts for subsequent packets passed to this function must be strictly
 *            increasing when compared in their respective timebases (unless the
 *            output format is flagged with the AVFMT_TS_NONSTRICT, then they
 *            merely have to be nondecreasing).  @ref AVPacket.duration
 *            "duration") should also be set if known.
2501
 * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush
2502 2503
 *
 * @see av_interleaved_write_frame()
2504
 */
2505
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
2506 2507

/**
2508
 * Write a packet to an output media file ensuring correct interleaving.
2509
 *
2510 2511 2512 2513
 * This function will buffer the packets internally as needed to make sure the
 * packets in the output file are properly interleaved in the order of
 * increasing dts. Callers doing their own interleaving should call
 * av_write_frame() instead of this function.
2514
 *
2515 2516 2517 2518
 * Using this function instead of av_write_frame() can give muxers advance
 * knowledge of future packets, improving e.g. the behaviour of the mp4
 * muxer for VFR content in fragmenting mode.
 *
2519
 * @param s media file handle
2520 2521
 * @param pkt The packet containing the data to be written.
 *            <br>
2522 2523 2524 2525 2526 2527
 *            If the packet is reference-counted, this function will take
 *            ownership of this reference and unreference it later when it sees
 *            fit.
 *            The caller must not access the data through this reference after
 *            this function returns. If the packet is not reference-counted,
 *            libavformat will make a copy.
2528
 *            <br>
2529 2530
 *            This parameter can be NULL (at any time, not just at the end), to
 *            flush the interleaving queues.
2531
 *            <br>
2532 2533
 *            Packet's @ref AVPacket.stream_index "stream_index" field must be
 *            set to the index of the corresponding stream in @ref
2534 2535 2536 2537 2538 2539 2540 2541 2542 2543
 *            AVFormatContext.streams "s->streams".
 *            <br>
 *            The timestamps (@ref AVPacket.pts "pts", @ref AVPacket.dts "dts")
 *            must be set to correct values in the stream's timebase (unless the
 *            output format is flagged with the AVFMT_NOTIMESTAMPS flag, then
 *            they can be set to AV_NOPTS_VALUE).
 *            The dts for subsequent packets in one stream must be strictly
 *            increasing (unless the output format is flagged with the
 *            AVFMT_TS_NONSTRICT, then they merely have to be nondecreasing).
 *            @ref AVPacket.duration "duration") should also be set if known.
2544
 *
2545 2546
 * @return 0 on success, a negative AVERROR on error. Libavformat will always
 *         take care of freeing the packet, even if this function fails.
2547 2548
 *
 * @see av_write_frame(), AVFormatContext.max_interleave_delta
2549
 */
2550
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
2551

2552
/**
Lou Logan's avatar
Lou Logan committed
2553
 * Write an uncoded frame to an output media file.
2554 2555 2556 2557 2558 2559 2560 2561 2562 2563
 *
 * The frame must be correctly interleaved according to the container
 * specification; if not, then av_interleaved_write_frame() must be used.
 *
 * See av_interleaved_write_frame() for details.
 */
int av_write_uncoded_frame(AVFormatContext *s, int stream_index,
                           AVFrame *frame);

/**
Lou Logan's avatar
Lou Logan committed
2564
 * Write an uncoded frame to an output media file.
2565
 *
2566
 * If the muxer supports it, this function makes it possible to write an AVFrame
2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589
 * structure directly, without encoding it into a packet.
 * It is mostly useful for devices and similar special muxers that use raw
 * video or PCM data and will not serialize it into a byte stream.
 *
 * To test whether it is possible to use it with a given muxer and stream,
 * use av_write_uncoded_frame_query().
 *
 * The caller gives up ownership of the frame and must not access it
 * afterwards.
 *
 * @return  >=0 for success, a negative code on error
 */
int av_interleaved_write_uncoded_frame(AVFormatContext *s, int stream_index,
                                       AVFrame *frame);

/**
 * Test whether a muxer supports uncoded frame.
 *
 * @return  >=0 if an uncoded frame can be written to that muxer and stream,
 *          <0 if not
 */
int av_write_uncoded_frame_query(AVFormatContext *s, int stream_index);

2590
/**
2591
 * Write the stream trailer to an output media file and free the
2592
 * file private data.
2593
 *
2594
 * May only be called after a successful call to avformat_write_header.
2595
 *
2596
 * @param s media file handle
Diego Biurrun's avatar
Diego Biurrun committed
2597
 * @return 0 if OK, AVERROR_xxx on error
2598
 */
2599
int av_write_trailer(AVFormatContext *s);
2600

2601
/**
2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618
 * Return the output format in the list of registered output formats
 * which best matches the provided parameters, or return NULL if
 * 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
 */
AVOutputFormat *av_guess_format(const char *short_name,
                                const char *filename,
                                const char *mime_type);

/**
 * Guess the codec ID based upon muxer and filename.
2619
 */
2620
enum AVCodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
2621 2622
                            const char *filename, const char *mime_type,
                            enum AVMediaType type);
Fabrice Bellard's avatar
Fabrice Bellard committed
2623

2624 2625 2626 2627 2628 2629 2630
/**
 * Get timing information for the data currently output.
 * The exact meaning of "currently output" depends on the format.
 * It is mostly relevant for devices that have an internal buffer and/or
 * work in real time.
 * @param s          media file handle
 * @param stream     stream in the media file
2631
 * @param[out] dts   DTS of the last packet output for the stream, in stream
2632
 *                   time_base units
2633
 * @param[out] wall  absolute time when that packet whas output,
2634 2635 2636 2637 2638 2639 2640 2641
 *                   in microsecond
 * @return  0 if OK, AVERROR(ENOSYS) if the format does not support it
 * Note: some formats or devices may not allow to measure dts and wall
 * atomically.
 */
int av_get_output_timestamp(struct AVFormatContext *s, int stream,
                            int64_t *dts, int64_t *wall);

2642

2643 2644 2645
/**
 * @}
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
2646

2647 2648 2649 2650 2651 2652

/**
 * @defgroup lavf_misc Utility functions
 * @ingroup libavf
 * @{
 *
2653
 * Miscellaneous utility functions related to both muxing and demuxing
2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665
 * (or neither).
 */

/**
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
 *
 * @param f The file stream pointer where the dump should be sent to.
 * @param buf buffer
 * @param size buffer size
 *
 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
 */
2666
void av_hex_dump(FILE *f, const uint8_t *buf, int size);
2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679

/**
 * Send a nice hexadecimal dump of a buffer to the log.
 *
 * @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_dump2, av_pkt_dump_log2
 */
2680
void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size);
2681 2682 2683 2684 2685 2686 2687 2688 2689

/**
 * Send a nice dump of a packet to the specified file stream.
 *
 * @param f The file stream pointer where the dump should be sent to.
 * @param pkt packet to dump
 * @param dump_payload True if the payload must be displayed, too.
 * @param st AVStream that the packet belongs to
 */
2690
void av_pkt_dump2(FILE *f, const AVPacket *pkt, int dump_payload, const AVStream *st);
2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703


/**
 * Send a nice dump of a packet to the log.
 *
 * @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
 * @param dump_payload True if the payload must be displayed, too.
 * @param st AVStream that the packet belongs to
 */
2704 2705
void av_pkt_dump_log2(void *avcl, int level, const AVPacket *pkt, int dump_payload,
                      const AVStream *st);
2706 2707

/**
2708 2709
 * Get the AVCodecID for the given codec tag tag.
 * If no codec id is found returns AV_CODEC_ID_NONE.
2710 2711 2712
 *
 * @param tags list of supported codec_id-codec_tag pairs, as stored
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
2713
 * @param tag  codec tag to match to a codec ID
2714
 */
2715
enum AVCodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
2716 2717 2718 2719 2720 2721 2722

/**
 * Get the codec tag for the given codec id id.
 * 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
2723
 * @param id   codec ID to match to a codec tag
2724
 */
2725
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum AVCodecID id);
2726

2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738
/**
 * Get the codec tag for the given codec id.
 *
 * @param tags list of supported codec_id - codec_tag pairs, as stored
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
 * @param id codec id that should be searched for in the list
 * @param tag A pointer to the found tag
 * @return 0 if id was not found in tags, > 0 if it was found
 */
int av_codec_get_tag2(const struct AVCodecTag * const *tags, enum AVCodecID id,
                      unsigned int *tag);

2739 2740 2741 2742
int av_find_default_stream_index(AVFormatContext *s);

/**
 * Get the index for a specific timestamp.
2743 2744 2745
 *
 * @param st        stream that the timestamp belongs to
 * @param timestamp timestamp to retrieve the index for
2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789
 * @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 >=
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
 * @return < 0 if no such timestamp could be found
 */
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);

/**
 * Add an index entry into a sorted list. Update the entry if the list
 * already contains it.
 *
 * @param timestamp timestamp in the time base of the given stream
 */
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
                       int size, int distance, int flags);


/**
 * 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);

2790

2791
/**
2792 2793 2794 2795 2796
 * Print detailed information about the input or output format, such as
 * duration, bitrate, streams, container, programs, metadata, side data,
 * codec and time base.
 *
 * @param ic        the context to analyze
2797
 * @param index     index of the stream to dump information about
2798
 * @param url       the URL to print, such as source or destination file
2799
 * @param is_output Select whether the specified context is an input(0) or output(1)
2800
 */
2801 2802 2803 2804
void av_dump_format(AVFormatContext *ic,
                    int index,
                    const char *url,
                    int is_output);
2805

2806 2807 2808

#define AV_FRAME_FILENAME_FLAGS_MULTIPLE 1 ///< Allow multiple %d

2809
/**
2810
 * Return in 'buf' the path with '%d' replaced by a number.
Diego Biurrun's avatar
Diego Biurrun committed
2811
 *
2812 2813 2814 2815 2816 2817
 * 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
2818
 * @param number frame number
2819
 * @param flags AV_FRAME_FILENAME_FLAGS_*
Diego Biurrun's avatar
Diego Biurrun committed
2820
 * @return 0 if OK, -1 on format error
2821
 */
2822
int av_get_frame_filename2(char *buf, int buf_size,
2823
                          const char *path, int number, int flags);
2824

2825 2826
int av_get_frame_filename(char *buf, int buf_size,
                          const char *path, int number);
2827 2828

/**
2829
 * Check whether filename actually is a numbered sequence generator.
2830 2831
 *
 * @param filename possible numbered sequence string
Diego Biurrun's avatar
Diego Biurrun committed
2832
 * @return 1 if a valid numbered sequence string, 0 otherwise
2833
 */
2834
int av_filename_number_test(const char *filename);
2835

Luca Abeni's avatar
Luca Abeni committed
2836
/**
2837
 * Generate an SDP for an RTP session.
Luca Abeni's avatar
Luca Abeni committed
2838
 *
2839 2840 2841
 * Note, this overwrites the id values of AVStreams in the muxer contexts
 * for getting unique dynamic payload types.
 *
Luca Abeni's avatar
Luca Abeni committed
2842 2843 2844 2845
 * @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
2846
 *           must contain only one AVStream.
2847
 * @param n_files number of AVCodecContexts contained in ac
2848 2849
 * @param buf buffer where the SDP will be stored (must be allocated by
 *            the caller)
2850
 * @param size the size of the buffer
Diego Biurrun's avatar
Diego Biurrun committed
2851
 * @return 0 if OK, AVERROR_xxx on error
Luca Abeni's avatar
Luca Abeni committed
2852
 */
2853
int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
2854

2855
/**
2856
 * Return a positive value if the given filename has one of the given
2857 2858
 * extensions, 0 otherwise.
 *
2859
 * @param filename   file name to check against the given extensions
2860 2861 2862 2863
 * @param extensions a comma-separated list of filename extensions
 */
int av_match_ext(const char *filename, const char *extensions);

2864 2865 2866
/**
 * Test if the given container can store a codec.
 *
2867 2868
 * @param ofmt           container to check for compatibility
 * @param codec_id       codec to potentially store in container
2869 2870 2871 2872 2873
 * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
 *
 * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
 *         A negative number if this information is not available.
 */
2874 2875
int avformat_query_codec(const AVOutputFormat *ofmt, enum AVCodecID codec_id,
                         int std_compliance);
2876

2877 2878 2879
/**
 * @defgroup riff_fourcc RIFF FourCCs
 * @{
2880
 * Get the tables mapping RIFF FourCCs to libavcodec AVCodecIDs. The tables are
2881 2882 2883 2884 2885
 * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the
 * following code:
 * @code
 * uint32_t tag = MKTAG('H', '2', '6', '4');
 * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 };
2886
 * enum AVCodecID id = av_codec_get_id(table, tag);
2887 2888 2889
 * @endcode
 */
/**
2890
 * @return the table mapping RIFF FourCCs for video to libavcodec AVCodecID.
2891 2892 2893
 */
const struct AVCodecTag *avformat_get_riff_video_tags(void);
/**
2894
 * @return the table mapping RIFF FourCCs for audio to AVCodecID.
2895 2896
 */
const struct AVCodecTag *avformat_get_riff_audio_tags(void);
2897 2898 2899 2900 2901 2902 2903 2904
/**
 * @return the table mapping MOV FourCCs for video to libavcodec AVCodecID.
 */
const struct AVCodecTag *avformat_get_mov_video_tags(void);
/**
 * @return the table mapping MOV FourCCs for audio to AVCodecID.
 */
const struct AVCodecTag *avformat_get_mov_audio_tags(void);
2905

2906 2907 2908 2909
/**
 * @}
 */

2910
/**
2911
 * Guess the sample aspect ratio of a frame, based on both the stream and the
2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928
 * frame aspect ratio.
 *
 * Since the frame aspect ratio is set by the codec but the stream aspect ratio
 * is set by the demuxer, these two may not be equal. This function tries to
 * return the value that you should use if you would like to display the frame.
 *
 * Basic logic is to use the stream aspect ratio if it is set to something sane
 * otherwise use the frame aspect ratio. This way a container setting, which is
 * usually easy to modify can override the coded value in the frames.
 *
 * @param format the format context which the stream is part of
 * @param stream the stream which the frame is part of
 * @param frame the frame with the aspect ratio to be determined
 * @return the guessed (valid) sample_aspect_ratio, 0/1 if no idea
 */
AVRational av_guess_sample_aspect_ratio(AVFormatContext *format, AVStream *stream, AVFrame *frame);

2929 2930 2931 2932 2933 2934 2935 2936 2937 2938
/**
 * Guess the frame rate, based on both the container and codec information.
 *
 * @param ctx the format context which the stream is part of
 * @param stream the stream which the frame is part of
 * @param frame the frame for which the frame rate should be determined, may be NULL
 * @return the guessed (valid) frame rate, 0/1 if no idea
 */
AVRational av_guess_frame_rate(AVFormatContext *ctx, AVStream *stream, AVFrame *frame);

2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954
/**
 * Check if the stream st contained in s is matched by the stream specifier
 * spec.
 *
 * See the "stream specifiers" chapter in the documentation for the syntax
 * of spec.
 *
 * @return  >0 if st is matched by spec;
 *          0  if st is not matched by spec;
 *          AVERROR code if spec is invalid
 *
 * @note  A stream specifier can match several streams in the format.
 */
int avformat_match_stream_specifier(AVFormatContext *s, AVStream *st,
                                    const char *spec);

2955
int avformat_queue_attached_pictures(AVFormatContext *s);
2956

2957
#if FF_API_OLD_BSF
2958 2959 2960 2961
/**
 * Apply a list of bitstream filters to a packet.
 *
 * @param codec AVCodecContext, usually from an AVStream
2962 2963 2964
 * @param pkt the packet to apply filters to. If, on success, the returned
 *        packet has size == 0 and side_data_elems == 0, it indicates that
 *        the packet should be dropped
2965 2966 2967 2968
 * @param bsfc a NULL-terminated list of filters to apply
 * @return  >=0 on success;
 *          AVERROR code on failure
 */
2969
attribute_deprecated
2970 2971
int av_apply_bitstream_filters(AVCodecContext *codec, AVPacket *pkt,
                               AVBitStreamFilterContext *bsfc);
2972
#endif
2973

2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996
enum AVTimebaseSource {
    AVFMT_TBCF_AUTO = -1,
    AVFMT_TBCF_DECODER,
    AVFMT_TBCF_DEMUXER,
#if FF_API_R_FRAME_RATE
    AVFMT_TBCF_R_FRAMERATE,
#endif
};

/**
 * Transfer internal timing information from one stream to another.
 *
 * This function is useful when doing stream copy.
 *
 * @param ofmt     target output format for ost
 * @param ost      output stream which needs timings copy and adjustments
 * @param ist      reference input stream to copy timings from
 * @param copy_tb  define from where the stream codec timebase needs to be imported
 */
int avformat_transfer_internal_stream_timing_info(const AVOutputFormat *ofmt,
                                                  AVStream *ost, const AVStream *ist,
                                                  enum AVTimebaseSource copy_tb);

2997 2998 2999 3000 3001 3002 3003
/**
 * Get the internal codec timebase from a stream.
 *
 * @param st  input stream to extract the timebase from
 */
AVRational av_stream_get_codec_timebase(const AVStream *st);

3004
/**
3005
 * @}
3006 3007
 */

3008
#endif /* AVFORMAT_AVFORMAT_H */