FFmpeg 6.1.1
avformat.h
Go to the documentation of this file.
1/*
2 * copyright (c) 2001 Fabrice Bellard
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * 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 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * 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 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21#ifndef AVFORMAT_AVFORMAT_H
22#define AVFORMAT_AVFORMAT_H
23
24/**
25 * @file
26 * @ingroup libavf
27 * Main libavformat public API header
28 */
29
30/**
31 * @defgroup libavf libavformat
32 * I/O and Muxing/Demuxing Library
33 *
34 * Libavformat (lavf) is a library for dealing with various media container
35 * formats. Its main two purposes are demuxing - i.e. splitting a media file
36 * into component streams, and the reverse process of muxing - writing supplied
37 * data in a specified container format. It also has an @ref lavf_io
38 * "I/O module" which supports a number of protocols for accessing the data (e.g.
39 * file, tcp, http and others).
40 * Unless you are absolutely sure you won't use libavformat's network
41 * capabilities, you should also call avformat_network_init().
42 *
43 * A supported input format is described by an AVInputFormat struct, conversely
44 * an output format is described by AVOutputFormat. You can iterate over all
45 * input/output formats using the av_demuxer_iterate / av_muxer_iterate() functions.
46 * The protocols layer is not part of the public API, so you can only get the names
47 * of supported protocols with the avio_enum_protocols() function.
48 *
49 * Main lavf structure used for both muxing and demuxing is AVFormatContext,
50 * which exports all information about the file being read or written. As with
51 * most Libavformat structures, its size is not part of public ABI, so it cannot be
52 * allocated on stack or directly with av_malloc(). To create an
53 * AVFormatContext, use avformat_alloc_context() (some functions, like
54 * avformat_open_input() might do that for you).
55 *
56 * Most importantly an AVFormatContext contains:
57 * @li the @ref AVFormatContext.iformat "input" or @ref AVFormatContext.oformat
58 * "output" format. It is either autodetected or set by user for input;
59 * always set by user for output.
60 * @li an @ref AVFormatContext.streams "array" of AVStreams, which describe all
61 * elementary streams stored in the file. AVStreams are typically referred to
62 * using their index in this array.
63 * @li an @ref AVFormatContext.pb "I/O context". It is either opened by lavf or
64 * set by user for input, always set by user for output (unless you are dealing
65 * with an AVFMT_NOFILE format).
66 *
67 * @section lavf_options Passing options to (de)muxers
68 * It is possible to configure lavf muxers and demuxers using the @ref avoptions
69 * mechanism. Generic (format-independent) libavformat options are provided by
70 * AVFormatContext, they can be examined from a user program by calling
71 * av_opt_next() / av_opt_find() on an allocated AVFormatContext (or its AVClass
72 * from avformat_get_class()). Private (format-specific) options are provided by
73 * AVFormatContext.priv_data if and only if AVInputFormat.priv_class /
74 * AVOutputFormat.priv_class of the corresponding format struct is non-NULL.
75 * Further options may be provided by the @ref AVFormatContext.pb "I/O context",
76 * if its AVClass is non-NULL, and the protocols layer. See the discussion on
77 * nesting in @ref avoptions documentation to learn how to access those.
78 *
79 * @section urls
80 * URL strings in libavformat are made of a scheme/protocol, a ':', and a
81 * scheme specific string. URLs without a scheme and ':' used for local files
82 * are supported but deprecated. "file:" should be used for local files.
83 *
84 * It is important that the scheme string is not taken from untrusted
85 * sources without checks.
86 *
87 * Note that some schemes/protocols are quite powerful, allowing access to
88 * both local and remote files, parts of them, concatenations of them, local
89 * audio and video devices and so on.
90 *
91 * @{
92 *
93 * @defgroup lavf_decoding Demuxing
94 * @{
95 * Demuxers read a media file and split it into chunks of data (@em packets). A
96 * @ref AVPacket "packet" contains one or more encoded frames which belongs to a
97 * single elementary stream. In the lavf API this process is represented by the
98 * avformat_open_input() function for opening a file, av_read_frame() for
99 * reading a single packet and finally avformat_close_input(), which does the
100 * cleanup.
101 *
102 * @section lavf_decoding_open Opening a media file
103 * The minimum information required to open a file is its URL, which
104 * is passed to avformat_open_input(), as in the following code:
105 * @code
106 * const char *url = "file:in.mp3";
107 * AVFormatContext *s = NULL;
108 * int ret = avformat_open_input(&s, url, NULL, NULL);
109 * if (ret < 0)
110 * abort();
111 * @endcode
112 * The above code attempts to allocate an AVFormatContext, open the
113 * specified file (autodetecting the format) and read the header, exporting the
114 * information stored there into s. Some formats do not have a header or do not
115 * store enough information there, so it is recommended that you call the
116 * avformat_find_stream_info() function which tries to read and decode a few
117 * frames to find missing information.
118 *
119 * In some cases you might want to preallocate an AVFormatContext yourself with
120 * avformat_alloc_context() and do some tweaking on it before passing it to
121 * avformat_open_input(). One such case is when you want to use custom functions
122 * for reading input data instead of lavf internal I/O layer.
123 * To do that, create your own AVIOContext with avio_alloc_context(), passing
124 * your reading callbacks to it. Then set the @em pb field of your
125 * AVFormatContext to newly created AVIOContext.
126 *
127 * Since the format of the opened file is in general not known until after
128 * avformat_open_input() has returned, it is not possible to set demuxer private
129 * options on a preallocated context. Instead, the options should be passed to
130 * avformat_open_input() wrapped in an AVDictionary:
131 * @code
132 * AVDictionary *options = NULL;
133 * av_dict_set(&options, "video_size", "640x480", 0);
134 * av_dict_set(&options, "pixel_format", "rgb24", 0);
135 *
136 * if (avformat_open_input(&s, url, NULL, &options) < 0)
137 * abort();
138 * av_dict_free(&options);
139 * @endcode
140 * This code passes the private options 'video_size' and 'pixel_format' to the
141 * demuxer. They would be necessary for e.g. the rawvideo demuxer, since it
142 * cannot know how to interpret raw video data otherwise. If the format turns
143 * out to be something different than raw video, those options will not be
144 * recognized by the demuxer and therefore will not be applied. Such unrecognized
145 * options are then returned in the options dictionary (recognized options are
146 * consumed). The calling program can handle such unrecognized options as it
147 * wishes, e.g.
148 * @code
149 * AVDictionaryEntry *e;
150 * if (e = av_dict_get(options, "", NULL, AV_DICT_IGNORE_SUFFIX)) {
151 * fprintf(stderr, "Option %s not recognized by the demuxer.\n", e->key);
152 * abort();
153 * }
154 * @endcode
155 *
156 * After you have finished reading the file, you must close it with
157 * avformat_close_input(). It will free everything associated with the file.
158 *
159 * @section lavf_decoding_read Reading from an opened file
160 * Reading data from an opened AVFormatContext is done by repeatedly calling
161 * av_read_frame() on it. Each call, if successful, will return an AVPacket
162 * containing encoded data for one AVStream, identified by
163 * AVPacket.stream_index. This packet may be passed straight into the libavcodec
164 * decoding functions avcodec_send_packet() or avcodec_decode_subtitle2() if the
165 * caller wishes to decode the data.
166 *
167 * AVPacket.pts, AVPacket.dts and AVPacket.duration timing information will be
168 * set if known. They may also be unset (i.e. AV_NOPTS_VALUE for
169 * pts/dts, 0 for duration) if the stream does not provide them. The timing
170 * information will be in AVStream.time_base units, i.e. it has to be
171 * multiplied by the timebase to convert them to seconds.
172 *
173 * A packet returned by av_read_frame() is always reference-counted,
174 * i.e. AVPacket.buf is set and the user may keep it indefinitely.
175 * The packet must be freed with av_packet_unref() when it is no
176 * longer needed.
177 *
178 * @section lavf_decoding_seek Seeking
179 * @}
180 *
181 * @defgroup lavf_encoding Muxing
182 * @{
183 * Muxers take encoded data in the form of @ref AVPacket "AVPackets" and write
184 * it into files or other output bytestreams in the specified container format.
185 *
186 * The main API functions for muxing are avformat_write_header() for writing the
187 * file header, av_write_frame() / av_interleaved_write_frame() for writing the
188 * packets and av_write_trailer() for finalizing the file.
189 *
190 * At the beginning of the muxing process, the caller must first call
191 * avformat_alloc_context() to create a muxing context. The caller then sets up
192 * the muxer by filling the various fields in this context:
193 *
194 * - The @ref AVFormatContext.oformat "oformat" field must be set to select the
195 * muxer that will be used.
196 * - Unless the format is of the AVFMT_NOFILE type, the @ref AVFormatContext.pb
197 * "pb" field must be set to an opened IO context, either returned from
198 * avio_open2() or a custom one.
199 * - Unless the format is of the AVFMT_NOSTREAMS type, at least one stream must
200 * be created with the avformat_new_stream() function. The caller should fill
201 * the @ref AVStream.codecpar "stream codec parameters" information, such as the
202 * codec @ref AVCodecParameters.codec_type "type", @ref AVCodecParameters.codec_id
203 * "id" and other parameters (e.g. width / height, the pixel or sample format,
204 * etc.) as known. The @ref AVStream.time_base "stream timebase" should
205 * be set to the timebase that the caller desires to use for this stream (note
206 * that the timebase actually used by the muxer can be different, as will be
207 * described later).
208 * - It is advised to manually initialize only the relevant fields in
209 * AVCodecParameters, rather than using @ref avcodec_parameters_copy() during
210 * remuxing: there is no guarantee that the codec context values remain valid
211 * for both input and output format contexts.
212 * - The caller may fill in additional information, such as @ref
213 * AVFormatContext.metadata "global" or @ref AVStream.metadata "per-stream"
214 * metadata, @ref AVFormatContext.chapters "chapters", @ref
215 * AVFormatContext.programs "programs", etc. as described in the
216 * AVFormatContext documentation. Whether such information will actually be
217 * stored in the output depends on what the container format and the muxer
218 * support.
219 *
220 * When the muxing context is fully set up, the caller must call
221 * avformat_write_header() to initialize the muxer internals and write the file
222 * header. Whether anything actually is written to the IO context at this step
223 * depends on the muxer, but this function must always be called. Any muxer
224 * private options must be passed in the options parameter to this function.
225 *
226 * The data is then sent to the muxer by repeatedly calling av_write_frame() or
227 * av_interleaved_write_frame() (consult those functions' documentation for
228 * discussion on the difference between them; only one of them may be used with
229 * a single muxing context, they should not be mixed). Do note that the timing
230 * information on the packets sent to the muxer must be in the corresponding
231 * AVStream's timebase. That timebase is set by the muxer (in the
232 * avformat_write_header() step) and may be different from the timebase
233 * requested by the caller.
234 *
235 * Once all the data has been written, the caller must call av_write_trailer()
236 * to flush any buffered packets and finalize the output file, then close the IO
237 * context (if any) and finally free the muxing context with
238 * avformat_free_context().
239 * @}
240 *
241 * @defgroup lavf_io I/O Read/Write
242 * @{
243 * @section lavf_io_dirlist Directory listing
244 * The directory listing API makes it possible to list files on remote servers.
245 *
246 * Some of possible use cases:
247 * - an "open file" dialog to choose files from a remote location,
248 * - a recursive media finder providing a player with an ability to play all
249 * files from a given directory.
250 *
251 * @subsection lavf_io_dirlist_open Opening a directory
252 * At first, a directory needs to be opened by calling avio_open_dir()
253 * supplied with a URL and, optionally, ::AVDictionary containing
254 * protocol-specific parameters. The function returns zero or positive
255 * integer and allocates AVIODirContext on success.
256 *
257 * @code
258 * AVIODirContext *ctx = NULL;
259 * if (avio_open_dir(&ctx, "smb://example.com/some_dir", NULL) < 0) {
260 * fprintf(stderr, "Cannot open directory.\n");
261 * abort();
262 * }
263 * @endcode
264 *
265 * This code tries to open a sample directory using smb protocol without
266 * any additional parameters.
267 *
268 * @subsection lavf_io_dirlist_read Reading entries
269 * Each directory's entry (i.e. file, another directory, anything else
270 * within ::AVIODirEntryType) is represented by AVIODirEntry.
271 * Reading consecutive entries from an opened AVIODirContext is done by
272 * repeatedly calling avio_read_dir() on it. Each call returns zero or
273 * positive integer if successful. Reading can be stopped right after the
274 * NULL entry has been read -- it means there are no entries left to be
275 * read. The following code reads all entries from a directory associated
276 * with ctx and prints their names to standard output.
277 * @code
278 * AVIODirEntry *entry = NULL;
279 * for (;;) {
280 * if (avio_read_dir(ctx, &entry) < 0) {
281 * fprintf(stderr, "Cannot list directory.\n");
282 * abort();
283 * }
284 * if (!entry)
285 * break;
286 * printf("%s\n", entry->name);
287 * avio_free_directory_entry(&entry);
288 * }
289 * @endcode
290 * @}
291 *
292 * @defgroup lavf_codec Demuxers
293 * @{
294 * @defgroup lavf_codec_native Native Demuxers
295 * @{
296 * @}
297 * @defgroup lavf_codec_wrappers External library wrappers
298 * @{
299 * @}
300 * @}
301 * @defgroup lavf_protos I/O Protocols
302 * @{
303 * @}
304 * @defgroup lavf_internal Internal
305 * @{
306 * @}
307 * @}
308 */
309
310#include <stdio.h> /* FILE */
311
312#include "libavcodec/codec_par.h"
313#include "libavcodec/defs.h"
314#include "libavcodec/packet.h"
315
316#include "libavutil/dict.h"
317#include "libavutil/log.h"
318
319#include "avio.h"
321#ifndef HAVE_AV_CONFIG_H
322/* When included as part of the ffmpeg build, only include the major version
323 * to avoid unnecessary rebuilds. When included externally, keep including
324 * the full version information. */
325#include "libavformat/version.h"
326
327#include "libavutil/frame.h"
328#include "libavcodec/codec.h"
329#endif
330
331struct AVFormatContext;
332struct AVFrame;
333struct AVDeviceInfoList;
334
335/**
336 * @defgroup metadata_api Public Metadata API
337 * @{
338 * @ingroup libavf
339 * The metadata API allows libavformat to export metadata tags to a client
340 * application when demuxing. Conversely it allows a client application to
341 * set metadata when muxing.
342 *
343 * Metadata is exported or set as pairs of key/value strings in the 'metadata'
344 * fields of the AVFormatContext, AVStream, AVChapter and AVProgram structs
345 * using the @ref lavu_dict "AVDictionary" API. Like all strings in FFmpeg,
346 * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata
347 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
348 *
349 * Important concepts to keep in mind:
350 * - Keys are unique; there can never be 2 tags with the same key. This is
351 * also meant semantically, i.e., a demuxer should not knowingly produce
352 * several keys that are literally different but semantically identical.
353 * E.g., key=Author5, key=Author6. In this example, all authors must be
354 * placed in the same tag.
355 * - Metadata is flat, not hierarchical; there are no subtags. If you
356 * want to store, e.g., the email address of the child of producer Alice
357 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
358 * - Several modifiers can be applied to the tag name. This is done by
359 * appending a dash character ('-') and the modifier name in the order
360 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
361 * - language -- a tag whose value is localized for a particular language
362 * is appended with the ISO 639-2/B 3-letter language code.
363 * For example: Author-ger=Michael, Author-eng=Mike
364 * The original/default language is in the unqualified "Author" tag.
365 * A demuxer should set a default if it sets any translated tag.
366 * - sorting -- a modified version of a tag that should be used for
367 * sorting will have '-sort' appended. E.g. artist="The Beatles",
368 * artist-sort="Beatles, The".
369 * - Some protocols and demuxers support metadata updates. After a successful
370 * call to av_read_frame(), AVFormatContext.event_flags or AVStream.event_flags
371 * will be updated to indicate if metadata changed. In order to detect metadata
372 * changes on a stream, you need to loop through all streams in the AVFormatContext
373 * and check their individual event_flags.
374 *
375 * - Demuxers attempt to export metadata in a generic format, however tags
376 * with no generic equivalents are left as they are stored in the container.
377 * Follows a list of generic tag names:
378 *
379 @verbatim
380 album -- name of the set this work belongs to
381 album_artist -- main creator of the set/album, if different from artist.
382 e.g. "Various Artists" for compilation albums.
383 artist -- main creator of the work
384 comment -- any additional description of the file.
385 composer -- who composed the work, if different from artist.
386 copyright -- name of copyright holder.
387 creation_time-- date when the file was created, preferably in ISO 8601.
388 date -- date when the work was created, preferably in ISO 8601.
389 disc -- number of a subset, e.g. disc in a multi-disc collection.
390 encoder -- name/settings of the software/hardware that produced the file.
391 encoded_by -- person/group who created the file.
392 filename -- original name of the file.
393 genre -- <self-evident>.
394 language -- main language in which the work is performed, preferably
395 in ISO 639-2 format. Multiple languages can be specified by
396 separating them with commas.
397 performer -- artist who performed the work, if different from artist.
398 E.g for "Also sprach Zarathustra", artist would be "Richard
399 Strauss" and performer "London Philharmonic Orchestra".
400 publisher -- name of the label/publisher.
401 service_name -- name of the service in broadcasting (channel name).
402 service_provider -- name of the service provider in broadcasting.
403 title -- name of the work.
404 track -- number of this work in the set, can be in form current/total.
405 variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
406 @endverbatim
407 *
408 * Look in the examples section for an application example how to use the Metadata API.
409 *
410 * @}
411 */
412
413/* packet functions */
414
415
416/**
417 * Allocate and read the payload of a packet and initialize its
418 * fields with default values.
419 *
420 * @param s associated IO context
421 * @param pkt packet
422 * @param size desired payload size
423 * @return >0 (read size) if OK, AVERROR_xxx otherwise
424 */
426
427
428/**
429 * Read data and append it to the current content of the AVPacket.
430 * If pkt->size is 0 this is identical to av_get_packet.
431 * Note that this uses av_grow_packet and thus involves a realloc
432 * which is inefficient. Thus this function should only be used
433 * when there is no reasonable way to know (an upper bound of)
434 * the final size.
435 *
436 * @param s associated IO context
437 * @param pkt packet
438 * @param size amount of data to read
439 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
440 * will not be lost even if an error occurs.
441 */
443
444/*************************************************/
445/* input/output formats */
446
447struct AVCodecTag;
448
449/**
450 * This structure contains the data a format has to probe a file.
451 */
452typedef struct AVProbeData {
453 const char *filename;
454 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
455 int buf_size; /**< Size of buf except extra allocated bytes */
456 const char *mime_type; /**< mime_type, when known. */
458
459#define AVPROBE_SCORE_RETRY (AVPROBE_SCORE_MAX/4)
460#define AVPROBE_SCORE_STREAM_RETRY (AVPROBE_SCORE_MAX/4-1)
461
462#define AVPROBE_SCORE_EXTENSION 50 ///< score for file extension
463#define AVPROBE_SCORE_MIME 75 ///< score for file mime type
464#define AVPROBE_SCORE_MAX 100 ///< maximum score
465
466#define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
467
468/// Demuxer will use avio_open, no opened file should be provided by the caller.
469#define AVFMT_NOFILE 0x0001
470#define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
471/**
472 * The muxer/demuxer is experimental and should be used with caution.
473 *
474 * - demuxers: will not be selected automatically by probing, must be specified
475 * explicitly.
476 */
477#define AVFMT_EXPERIMENTAL 0x0004
478#define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
479#define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
480#define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
481#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
482#define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
483#define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
484#define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
485#define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */
486#define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fall back on binary search via read_timestamp */
487#define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fall back on generic search */
488#define AVFMT_NO_BYTE_SEEK 0x8000 /**< Format does not allow seeking by bytes */
489#if FF_API_ALLOW_FLUSH
490#define AVFMT_ALLOW_FLUSH 0x10000 /**< @deprecated: Just send a NULL packet if you want to flush a muxer. */
491#endif
492#define AVFMT_TS_NONSTRICT 0x20000 /**< Format does not require strictly
493 increasing timestamps, but they must
494 still be monotonic */
495#define AVFMT_TS_NEGATIVE 0x40000 /**< Format allows muxing negative
496 timestamps. If not set the timestamp
497 will be shifted in av_write_frame and
498 av_interleaved_write_frame so they
499 start from 0.
500 The user or muxer can override this through
501 AVFormatContext.avoid_negative_ts
502 */
503
504#define AVFMT_SEEK_TO_PTS 0x4000000 /**< Seeking is based on PTS */
505
506/**
507 * @addtogroup lavf_encoding
508 * @{
509 */
510typedef struct AVOutputFormat {
511 const char *name;
512 /**
513 * Descriptive name for the format, meant to be more human-readable
514 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
515 * to define it.
516 */
517 const char *long_name;
518 const char *mime_type;
519 const char *extensions; /**< comma-separated filename extensions */
520 /* output support */
521 enum AVCodecID audio_codec; /**< default audio codec */
522 enum AVCodecID video_codec; /**< default video codec */
523 enum AVCodecID subtitle_codec; /**< default subtitle codec */
524 /**
525 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER,
526 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
527 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS,
528 * AVFMT_TS_NONSTRICT, AVFMT_TS_NEGATIVE
529 */
530 int flags;
531
532 /**
533 * List of supported codec_id-codec_tag pairs, ordered by "better
534 * choice first". The arrays are all terminated by AV_CODEC_ID_NONE.
535 */
536 const struct AVCodecTag * const *codec_tag;
537
538
539 const AVClass *priv_class; ///< AVClass for the private context
541/**
542 * @}
543 */
544
545/**
546 * @addtogroup lavf_decoding
547 * @{
548 */
549typedef struct AVInputFormat {
550 /**
551 * A comma separated list of short names for the format. New names
552 * may be appended with a minor bump.
553 */
554 const char *name;
555
556 /**
557 * Descriptive name for the format, meant to be more human-readable
558 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
559 * to define it.
560 */
561 const char *long_name;
562
563 /**
564 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
565 * AVFMT_NOTIMESTAMPS, AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
566 * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK, AVFMT_SEEK_TO_PTS.
567 */
568 int flags;
569
570 /**
571 * If extensions are defined, then no probe is done. You should
572 * usually not use extension format guessing because it is not
573 * reliable enough
574 */
575 const char *extensions;
576
577 const struct AVCodecTag * const *codec_tag;
578
579 const AVClass *priv_class; ///< AVClass for the private context
580
581 /**
582 * Comma-separated list of mime types.
583 * It is used check for matching mime types while probing.
584 * @see av_probe_input_format2
585 */
586 const char *mime_type;
587
588 /*****************************************************************
589 * No fields below this line are part of the public API. They
590 * may not be used outside of libavformat and can be changed and
591 * removed at will.
592 * New public fields should be added right above.
593 *****************************************************************
594 */
595 /**
596 * Raw demuxers store their codec ID here.
597 */
599
600 /**
601 * Size of private data so that it can be allocated in the wrapper.
602 */
604
605 /**
606 * Internal flags. See FF_FMT_FLAG_* in internal.h.
607 */
609
610 /**
611 * Tell if a given file has a chance of being parsed as this format.
612 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
613 * big so you do not have to check for that unless you need more.
614 */
615 int (*read_probe)(const AVProbeData *);
616
617 /**
618 * Read the format header and initialize the AVFormatContext
619 * structure. Return 0 if OK. 'avformat_new_stream' should be
620 * called to create new streams.
621 */
622 int (*read_header)(struct AVFormatContext *);
623
624 /**
625 * Read one packet and put it in 'pkt'. pts and flags are also
626 * set. 'avformat_new_stream' can be called only if the flag
627 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
628 * background thread).
629 * @return 0 on success, < 0 on error.
630 * Upon returning an error, pkt must be unreferenced by the caller.
631 */
633
634 /**
635 * Close the stream. The AVFormatContext and AVStreams are not
636 * freed by this function
637 */
638 int (*read_close)(struct AVFormatContext *);
639
640 /**
641 * Seek to a given timestamp relative to the frames in
642 * stream component stream_index.
643 * @param stream_index Must not be -1.
644 * @param flags Selects which direction should be preferred if no exact
645 * match is available.
646 * @return >= 0 on success (but not necessarily the new offset)
647 */
648 int (*read_seek)(struct AVFormatContext *,
649 int stream_index, int64_t timestamp, int flags);
650
651 /**
652 * Get the next timestamp in stream[stream_index].time_base units.
653 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
654 */
655 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
656 int64_t *pos, int64_t pos_limit);
657
658 /**
659 * Start/resume playing - only meaningful if using a network-based format
660 * (RTSP).
661 */
662 int (*read_play)(struct AVFormatContext *);
663
664 /**
665 * Pause playing - only meaningful if using a network-based format
666 * (RTSP).
667 */
668 int (*read_pause)(struct AVFormatContext *);
669
670 /**
671 * Seek to timestamp ts.
672 * Seeking will be done so that the point from which all active streams
673 * can be presented successfully will be closest to ts and within min/max_ts.
674 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
675 */
676 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
677
678 /**
679 * Returns device list with it properties.
680 * @see avdevice_list_devices() for more details.
681 */
682 int (*get_device_list)(struct AVFormatContext *s, struct AVDeviceInfoList *device_list);
683
685/**
686 * @}
687 */
688
691 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
692 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
693 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
694 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
695 AVSTREAM_PARSE_FULL_RAW, /**< full parsing and repack with timestamp and position generation by parser for raw
696 this assumes that each packet in the file contains no demuxer level headers and
697 just codec level data, otherwise position generation would fail */
698};
699
700typedef struct AVIndexEntry {
701 int64_t pos;
702 int64_t timestamp; /**<
703 * Timestamp in AVStream.time_base units, preferably the time from which on correctly decoded frames are available
704 * when seeking to this entry. That means preferable PTS on keyframe based formats.
705 * But demuxers can choose to store a different timestamp, if it is more convenient for the implementation or nothing better
706 * is known
707 */
708#define AVINDEX_KEYFRAME 0x0001
709#define AVINDEX_DISCARD_FRAME 0x0002 /**
710 * Flag is used to indicate which frame should be discarded after decoding.
711 */
712 int flags:2;
713 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).
714 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
716
717/**
718 * The stream should be chosen by default among other streams of the same type,
719 * unless the user has explicitly specified otherwise.
720 */
721#define AV_DISPOSITION_DEFAULT (1 << 0)
722/**
723 * The stream is not in original language.
724 *
725 * @note AV_DISPOSITION_ORIGINAL is the inverse of this disposition. At most
726 * one of them should be set in properly tagged streams.
727 * @note This disposition may apply to any stream type, not just audio.
728 */
729#define AV_DISPOSITION_DUB (1 << 1)
730/**
731 * The stream is in original language.
732 *
733 * @see the notes for AV_DISPOSITION_DUB
734 */
735#define AV_DISPOSITION_ORIGINAL (1 << 2)
736/**
737 * The stream is a commentary track.
738 */
739#define AV_DISPOSITION_COMMENT (1 << 3)
740/**
741 * The stream contains song lyrics.
742 */
743#define AV_DISPOSITION_LYRICS (1 << 4)
744/**
745 * The stream contains karaoke audio.
746 */
747#define AV_DISPOSITION_KARAOKE (1 << 5)
748
749/**
750 * Track should be used during playback by default.
751 * Useful for subtitle track that should be displayed
752 * even when user did not explicitly ask for subtitles.
753 */
754#define AV_DISPOSITION_FORCED (1 << 6)
755/**
756 * The stream is intended for hearing impaired audiences.
757 */
758#define AV_DISPOSITION_HEARING_IMPAIRED (1 << 7)
759/**
760 * The stream is intended for visually impaired audiences.
761 */
762#define AV_DISPOSITION_VISUAL_IMPAIRED (1 << 8)
763/**
764 * The audio stream contains music and sound effects without voice.
765 */
766#define AV_DISPOSITION_CLEAN_EFFECTS (1 << 9)
767/**
768 * The stream is stored in the file as an attached picture/"cover art" (e.g.
769 * APIC frame in ID3v2). The first (usually only) packet associated with it
770 * will be returned among the first few packets read from the file unless
771 * seeking takes place. It can also be accessed at any time in
772 * AVStream.attached_pic.
773 */
774#define AV_DISPOSITION_ATTACHED_PIC (1 << 10)
775/**
776 * The stream is sparse, and contains thumbnail images, often corresponding
777 * to chapter markers. Only ever used with AV_DISPOSITION_ATTACHED_PIC.
778 */
779#define AV_DISPOSITION_TIMED_THUMBNAILS (1 << 11)
780
781/**
782 * The stream is intended to be mixed with a spatial audio track. For example,
783 * it could be used for narration or stereo music, and may remain unchanged by
784 * listener head rotation.
785 */
786#define AV_DISPOSITION_NON_DIEGETIC (1 << 12)
787
788/**
789 * The subtitle stream contains captions, providing a transcription and possibly
790 * a translation of audio. Typically intended for hearing-impaired audiences.
791 */
792#define AV_DISPOSITION_CAPTIONS (1 << 16)
793/**
794 * The subtitle stream contains a textual description of the video content.
795 * Typically intended for visually-impaired audiences or for the cases where the
796 * video cannot be seen.
797 */
798#define AV_DISPOSITION_DESCRIPTIONS (1 << 17)
799/**
800 * The subtitle stream contains time-aligned metadata that is not intended to be
801 * directly presented to the user.
802 */
803#define AV_DISPOSITION_METADATA (1 << 18)
804/**
805 * The audio stream is intended to be mixed with another stream before
806 * presentation.
807 * Corresponds to mix_type=0 in mpegts.
808 */
809#define AV_DISPOSITION_DEPENDENT (1 << 19)
810/**
811 * The video stream contains still images.
812 */
813#define AV_DISPOSITION_STILL_IMAGE (1 << 20)
814
815/**
816 * @return The AV_DISPOSITION_* flag corresponding to disp or a negative error
817 * code if disp does not correspond to a known stream disposition.
818 */
819int av_disposition_from_string(const char *disp);
820
821/**
822 * @param disposition a combination of AV_DISPOSITION_* values
823 * @return The string description corresponding to the lowest set bit in
824 * disposition. NULL when the lowest set bit does not correspond
825 * to a known disposition or when disposition is 0.
826 */
827const char *av_disposition_to_string(int disposition);
828
829/**
830 * Options for behavior on timestamp wrap detection.
831 */
832#define AV_PTS_WRAP_IGNORE 0 ///< ignore the wrap
833#define AV_PTS_WRAP_ADD_OFFSET 1 ///< add the format specific offset on wrap detection
834#define AV_PTS_WRAP_SUB_OFFSET -1 ///< subtract the format specific offset on wrap detection
835
836/**
837 * Stream structure.
838 * New fields can be added to the end with minor version bumps.
839 * Removal, reordering and changes to existing fields require a major
840 * version bump.
841 * sizeof(AVStream) must not be used outside libav*.
842 */
843typedef struct AVStream {
844 /**
845 * A class for @ref avoptions. Set on stream creation.
846 */
848
849 int index; /**< stream index in AVFormatContext */
850 /**
851 * Format-specific stream ID.
852 * decoding: set by libavformat
853 * encoding: set by the user, replaced by libavformat if left unset
854 */
855 int id;
856
857 /**
858 * Codec parameters associated with this stream. Allocated and freed by
859 * libavformat in avformat_new_stream() and avformat_free_context()
860 * respectively.
861 *
862 * - demuxing: filled by libavformat on stream creation or in
863 * avformat_find_stream_info()
864 * - muxing: filled by the caller before avformat_write_header()
865 */
867
868 void *priv_data;
869
870 /**
871 * This is the fundamental unit of time (in seconds) in terms
872 * of which frame timestamps are represented.
873 *
874 * decoding: set by libavformat
875 * encoding: May be set by the caller before avformat_write_header() to
876 * provide a hint to the muxer about the desired timebase. In
877 * avformat_write_header(), the muxer will overwrite this field
878 * with the timebase that will actually be used for the timestamps
879 * written into the file (which may or may not be related to the
880 * user-provided one, depending on the format).
881 */
883
884 /**
885 * Decoding: pts of the first frame of the stream in presentation order, in stream time base.
886 * Only set this if you are absolutely 100% sure that the value you set
887 * it to really is the pts of the first frame.
888 * This may be undefined (AV_NOPTS_VALUE).
889 * @note The ASF header does NOT contain a correct start_time the ASF
890 * demuxer must NOT set this.
891 */
892 int64_t start_time;
893
894 /**
895 * Decoding: duration of the stream, in stream time base.
896 * If a source file does not specify a duration, but does specify
897 * a bitrate, this value will be estimated from bitrate and file size.
898 *
899 * Encoding: May be set by the caller before avformat_write_header() to
900 * provide a hint to the muxer about the estimated duration.
901 */
902 int64_t duration;
903
904 int64_t nb_frames; ///< number of frames in this stream if known or 0
905
906 /**
907 * Stream disposition - a combination of AV_DISPOSITION_* flags.
908 * - demuxing: set by libavformat when creating the stream or in
909 * avformat_find_stream_info().
910 * - muxing: may be set by the caller before avformat_write_header().
911 */
913
914 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
915
916 /**
917 * sample aspect ratio (0 if unknown)
918 * - encoding: Set by user.
919 * - decoding: Set by libavformat.
920 */
922
924
925 /**
926 * Average framerate
927 *
928 * - demuxing: May be set by libavformat when creating the stream or in
929 * avformat_find_stream_info().
930 * - muxing: May be set by the caller before avformat_write_header().
931 */
933
934 /**
935 * For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet
936 * will contain the attached picture.
937 *
938 * decoding: set by libavformat, must not be modified by the caller.
939 * encoding: unused
940 */
942
943#if FF_API_AVSTREAM_SIDE_DATA
944 /**
945 * An array of side data that applies to the whole stream (i.e. the
946 * container does not allow it to change between packets).
947 *
948 * There may be no overlap between the side data in this array and side data
949 * in the packets. I.e. a given side data is either exported by the muxer
950 * (demuxing) / set by the caller (muxing) in this array, then it never
951 * appears in the packets, or the side data is exported / sent through
952 * the packets (always in the first packet where the value becomes known or
953 * changes), then it does not appear in this array.
954 *
955 * - demuxing: Set by libavformat when the stream is created.
956 * - muxing: May be set by the caller before avformat_write_header().
957 *
958 * Freed by libavformat in avformat_free_context().
959 *
960 * @deprecated use AVStream's @ref AVCodecParameters.coded_side_data
961 * "codecpar side data".
962 */
965 /**
966 * The number of elements in the AVStream.side_data array.
967 *
968 * @deprecated use AVStream's @ref AVCodecParameters.nb_coded_side_data
969 * "codecpar side data".
970 */
972 int nb_side_data;
973#endif
974
975 /**
976 * Flags indicating events happening on the stream, a combination of
977 * AVSTREAM_EVENT_FLAG_*.
978 *
979 * - demuxing: may be set by the demuxer in avformat_open_input(),
980 * avformat_find_stream_info() and av_read_frame(). Flags must be cleared
981 * by the user once the event has been handled.
982 * - muxing: may be set by the user after avformat_write_header(). to
983 * indicate a user-triggered event. The muxer will clear the flags for
984 * events it has handled in av_[interleaved]_write_frame().
985 */
986 int event_flags;
987/**
988 * - demuxing: the demuxer read new metadata from the file and updated
989 * AVStream.metadata accordingly
990 * - muxing: the user updated AVStream.metadata and wishes the muxer to write
991 * it into the file
992 */
993#define AVSTREAM_EVENT_FLAG_METADATA_UPDATED 0x0001
994/**
995 * - demuxing: new packets for this stream were read from the file. This
996 * event is informational only and does not guarantee that new packets
997 * for this stream will necessarily be returned from av_read_frame().
998 */
999#define AVSTREAM_EVENT_FLAG_NEW_PACKETS (1 << 1)
1000
1001 /**
1002 * Real base framerate of the stream.
1003 * This is the lowest framerate with which all timestamps can be
1004 * represented accurately (it is the least common multiple of all
1005 * framerates in the stream). Note, this value is just a guess!
1006 * For example, if the time base is 1/90000 and all frames have either
1007 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
1008 */
1010
1011 /**
1012 * Number of bits in timestamps. Used for wrapping control.
1013 *
1014 * - demuxing: set by libavformat
1015 * - muxing: set by libavformat
1017 */
1018 int pts_wrap_bits;
1020
1022
1023#if FF_API_GET_END_PTS
1024/**
1025 * Returns the pts of the last muxed packet + its duration
1026 *
1027 * the retuned value is undefined when used with a demuxer.
1030int64_t av_stream_get_end_pts(const AVStream *st);
1031#endif
1032
1033#define AV_PROGRAM_RUNNING 1
1034
1035/**
1036 * New fields can be added to the end with minor version bumps.
1037 * Removal, reordering and changes to existing fields require a major
1038 * version bump.
1039 * sizeof(AVProgram) must not be used outside libav*.
1041typedef struct AVProgram {
1042 int id;
1044 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
1045 unsigned int *stream_index;
1046 unsigned int nb_stream_indexes;
1051 int pcr_pid;
1052 int pmt_version;
1053
1054 /*****************************************************************
1055 * All fields below this line are not part of the public API. They
1056 * may not be used outside of libavformat and can be changed and
1057 * removed at will.
1058 * New public fields should be added right above.
1059 *****************************************************************
1061 int64_t start_time;
1062 int64_t end_time;
1064 int64_t pts_wrap_reference; ///< reference dts for wrap detection
1065 int pts_wrap_behavior; ///< behavior on wrap detection
1066} AVProgram;
1068#define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
1069 (streams are added dynamically) */
1070#define AVFMTCTX_UNSEEKABLE 0x0002 /**< signal that the stream is definitely
1071 not seekable, and attempts to call the
1072 seek function will fail. For some
1073 network protocols (e.g. HLS), this can
1074 change dynamically at runtime. */
1076typedef struct AVChapter {
1077 int64_t id; ///< unique ID to identify the chapter
1078 AVRational time_base; ///< time base in which the start/end timestamps are specified
1079 int64_t start, end; ///< chapter start/end time in time_base units
1081} AVChapter;
1082
1083
1084/**
1085 * Callback used by devices to communicate with application.
1086 */
1087typedef int (*av_format_control_message)(struct AVFormatContext *s, int type,
1088 void *data, size_t data_size);
1089
1090typedef int (*AVOpenCallback)(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags,
1091 const AVIOInterruptCB *int_cb, AVDictionary **options);
1092
1093/**
1094 * The duration of a video can be estimated through various ways, and this enum can be used
1095 * to know how the duration was estimated.
1098 AVFMT_DURATION_FROM_PTS, ///< Duration accurately estimated from PTSes
1099 AVFMT_DURATION_FROM_STREAM, ///< Duration estimated from a stream with a known duration
1100 AVFMT_DURATION_FROM_BITRATE ///< Duration estimated from bitrate (less accurate)
1101};
1102
1103/**
1104 * Format I/O context.
1105 * New fields can be added to the end with minor version bumps.
1106 * Removal, reordering and changes to existing fields require a major
1107 * version bump.
1108 * sizeof(AVFormatContext) must not be used outside libav*, use
1109 * avformat_alloc_context() to create an AVFormatContext.
1110 *
1111 * Fields can be accessed through AVOptions (av_opt*),
1112 * the name string used matches the associated command line parameter name and
1113 * can be found in libavformat/options_table.h.
1114 * The AVOption/command line parameter names differ in some cases from the C
1115 * structure field names for historic reasons or brevity.
1116 */
1117typedef struct AVFormatContext {
1118 /**
1119 * A class for logging and @ref avoptions. Set by avformat_alloc_context().
1120 * Exports (de)muxer private options if they exist.
1121 */
1122 const AVClass *av_class;
1123
1124 /**
1125 * The input container format.
1126 *
1127 * Demuxing only, set by avformat_open_input().
1128 */
1129 const struct AVInputFormat *iformat;
1130
1131 /**
1132 * The output container format.
1133 *
1134 * Muxing only, must be set by the caller before avformat_write_header().
1135 */
1136 const struct AVOutputFormat *oformat;
1137
1138 /**
1139 * Format private data. This is an AVOptions-enabled struct
1140 * if and only if iformat/oformat.priv_class is not NULL.
1141 *
1142 * - muxing: set by avformat_write_header()
1143 * - demuxing: set by avformat_open_input()
1144 */
1145 void *priv_data;
1146
1147 /**
1148 * I/O context.
1149 *
1150 * - demuxing: either set by the user before avformat_open_input() (then
1151 * the user must close it manually) or set by avformat_open_input().
1152 * - muxing: set by the user before avformat_write_header(). The caller must
1153 * take care of closing / freeing the IO context.
1154 *
1155 * Do NOT set this field if AVFMT_NOFILE flag is set in
1156 * iformat/oformat.flags. In such a case, the (de)muxer will handle
1157 * I/O in some other way and this field will be NULL.
1158 */
1159 AVIOContext *pb;
1160
1161 /* stream info */
1162 /**
1163 * Flags signalling stream properties. A combination of AVFMTCTX_*.
1164 * Set by libavformat.
1165 */
1166 int ctx_flags;
1167
1168 /**
1169 * Number of elements in AVFormatContext.streams.
1170 *
1171 * Set by avformat_new_stream(), must not be modified by any other code.
1172 */
1173 unsigned int nb_streams;
1174 /**
1175 * A list of all streams in the file. New streams are created with
1176 * avformat_new_stream().
1177 *
1178 * - demuxing: streams are created by libavformat in avformat_open_input().
1179 * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
1180 * appear in av_read_frame().
1181 * - muxing: streams are created by the user before avformat_write_header().
1182 *
1183 * Freed by libavformat in avformat_free_context().
1184 */
1185 AVStream **streams;
1186
1187 /**
1188 * input or output URL. Unlike the old filename field, this field has no
1189 * length restriction.
1190 *
1191 * - demuxing: set by avformat_open_input(), initialized to an empty
1192 * string if url parameter was NULL in avformat_open_input().
1193 * - muxing: may be set by the caller before calling avformat_write_header()
1194 * (or avformat_init_output() if that is called first) to a string
1195 * which is freeable by av_free(). Set to an empty string if it
1196 * was NULL in avformat_init_output().
1197 *
1198 * Freed by libavformat in avformat_free_context().
1199 */
1200 char *url;
1201
1202 /**
1203 * Position of the first frame of the component, in
1204 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
1205 * It is deduced from the AVStream values.
1206 *
1207 * Demuxing only, set by libavformat.
1208 */
1209 int64_t start_time;
1210
1211 /**
1212 * Duration of the stream, in AV_TIME_BASE fractional
1213 * seconds. Only set this value if you know none of the individual stream
1214 * durations and also do not set any of them. This is deduced from the
1215 * AVStream values if not set.
1216 *
1217 * Demuxing only, set by libavformat.
1218 */
1219 int64_t duration;
1220
1221 /**
1222 * Total stream bitrate in bit/s, 0 if not
1223 * available. Never set it directly if the file_size and the
1224 * duration are known as FFmpeg can compute it automatically.
1225 */
1226 int64_t bit_rate;
1228 unsigned int packet_size;
1229 int max_delay;
1230
1231 /**
1232 * Flags modifying the (de)muxer behaviour. A combination of AVFMT_FLAG_*.
1233 * Set by the user before avformat_open_input() / avformat_write_header().
1236#define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
1237#define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
1238#define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
1239#define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
1240#define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
1241#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
1242#define AVFMT_FLAG_NOBUFFER 0x0040 ///< Do not buffer frames when possible
1243#define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
1244#define AVFMT_FLAG_DISCARD_CORRUPT 0x0100 ///< Discard frames marked corrupted
1245#define AVFMT_FLAG_FLUSH_PACKETS 0x0200 ///< Flush the AVIOContext every packet.
1246/**
1247 * When muxing, try to avoid writing any random/volatile data to the output.
1248 * This includes any random IDs, real-time timestamps/dates, muxer version, etc.
1249 *
1250 * This flag is mainly intended for testing.
1252#define AVFMT_FLAG_BITEXACT 0x0400
1253#define AVFMT_FLAG_SORT_DTS 0x10000 ///< try to interleave outputted packets by dts (using this flag can slow demuxing down)
1254#define AVFMT_FLAG_FAST_SEEK 0x80000 ///< Enable fast, but inaccurate seeks for some formats
1255#if FF_API_LAVF_SHORTEST
1256#define AVFMT_FLAG_SHORTEST 0x100000 ///< Stop muxing when the shortest stream stops.
1257#endif
1258#define AVFMT_FLAG_AUTO_BSF 0x200000 ///< Add bitstream filters as requested by the muxer
1259
1260 /**
1261 * Maximum number of bytes read from input in order to determine stream
1262 * properties. Used when reading the global header and in
1263 * avformat_find_stream_info().
1264 *
1265 * Demuxing only, set by the caller before avformat_open_input().
1266 *
1267 * @note this is \e not used for determining the \ref AVInputFormat
1268 * "input format"
1269 * @sa format_probesize
1270 */
1271 int64_t probesize;
1272
1273 /**
1274 * Maximum duration (in AV_TIME_BASE units) of the data read
1275 * from input in avformat_find_stream_info().
1276 * Demuxing only, set by the caller before avformat_find_stream_info().
1277 * Can be set to 0 to let avformat choose using a heuristic.
1278 */
1281 const uint8_t *key;
1284 unsigned int nb_programs;
1286
1287 /**
1288 * Forced video codec_id.
1289 * Demuxing: Set by user.
1290 */
1292
1293 /**
1294 * Forced audio codec_id.
1295 * Demuxing: Set by user.
1296 */
1298
1299 /**
1300 * Forced subtitle codec_id.
1301 * Demuxing: Set by user.
1302 */
1304
1305 /**
1306 * Maximum amount of memory in bytes to use for the index of each stream.
1307 * If the index exceeds this size, entries will be discarded as
1308 * needed to maintain a smaller size. This can lead to slower or less
1309 * accurate seeking (depends on demuxer).
1310 * Demuxers for which a full in-memory index is mandatory will ignore
1311 * this.
1312 * - muxing: unused
1313 * - demuxing: set by user
1314 */
1315 unsigned int max_index_size;
1316
1317 /**
1318 * Maximum amount of memory in bytes to use for buffering frames
1319 * obtained from realtime capture devices.
1320 */
1321 unsigned int max_picture_buffer;
1322
1323 /**
1324 * Number of chapters in AVChapter array.
1325 * When muxing, chapters are normally written in the file header,
1326 * so nb_chapters should normally be initialized before write_header
1327 * is called. Some muxers (e.g. mov and mkv) can also write chapters
1328 * in the trailer. To write chapters in the trailer, nb_chapters
1329 * must be zero when write_header is called and non-zero when
1330 * write_trailer is called.
1331 * - muxing: set by user
1332 * - demuxing: set by libavformat
1334 unsigned int nb_chapters;
1336
1337 /**
1338 * Metadata that applies to the whole file.
1339 *
1340 * - demuxing: set by libavformat in avformat_open_input()
1341 * - muxing: may be set by the caller before avformat_write_header()
1342 *
1343 * Freed by libavformat in avformat_free_context().
1344 */
1346
1347 /**
1348 * Start time of the stream in real world time, in microseconds
1349 * since the Unix epoch (00:00 1st January 1970). That is, pts=0 in the
1350 * stream was captured at this real world time.
1351 * - muxing: Set by the caller before avformat_write_header(). If set to
1352 * either 0 or AV_NOPTS_VALUE, then the current wall-time will
1353 * be used.
1354 * - demuxing: Set by libavformat. AV_NOPTS_VALUE if unknown. Note that
1355 * the value may become known after some number of frames
1356 * have been received.
1357 */
1358 int64_t start_time_realtime;
1359
1360 /**
1361 * The number of frames used for determining the framerate in
1362 * avformat_find_stream_info().
1363 * Demuxing only, set by the caller before avformat_find_stream_info().
1364 */
1365 int fps_probe_size;
1366
1367 /**
1368 * Error recognition; higher values will detect more errors but may
1369 * misdetect some more or less valid parts as errors.
1370 * Demuxing only, set by the caller before avformat_open_input().
1371 */
1373
1374 /**
1375 * Custom interrupt callbacks for the I/O layer.
1376 *
1377 * demuxing: set by the user before avformat_open_input().
1378 * muxing: set by the user before avformat_write_header()
1379 * (mainly useful for AVFMT_NOFILE formats). The callback
1380 * should also be passed to avio_open2() if it's used to
1381 * open the file.
1382 */
1384
1385 /**
1386 * Flags to enable debugging.
1388 int debug;
1389#define FF_FDEBUG_TS 0x0001
1390
1391 /**
1392 * Maximum buffering duration for interleaving.
1393 *
1394 * To ensure all the streams are interleaved correctly,
1395 * av_interleaved_write_frame() will wait until it has at least one packet
1396 * for each stream before actually writing any packets to the output file.
1397 * When some streams are "sparse" (i.e. there are large gaps between
1398 * successive packets), this can result in excessive buffering.
1399 *
1400 * This field specifies the maximum difference between the timestamps of the
1401 * first and the last packet in the muxing queue, above which libavformat
1402 * will output a packet regardless of whether it has queued a packet for all
1403 * the streams.
1404 *
1405 * Muxing only, set by the caller before avformat_write_header().
1406 */
1407 int64_t max_interleave_delta;
1408
1409 /**
1410 * Allow non-standard and experimental extension
1411 * @see AVCodecContext.strict_std_compliance
1412 */
1414
1415 /**
1416 * Flags indicating events happening on the file, a combination of
1417 * AVFMT_EVENT_FLAG_*.
1418 *
1419 * - demuxing: may be set by the demuxer in avformat_open_input(),
1420 * avformat_find_stream_info() and av_read_frame(). Flags must be cleared
1421 * by the user once the event has been handled.
1422 * - muxing: may be set by the user after avformat_write_header() to
1423 * indicate a user-triggered event. The muxer will clear the flags for
1424 * events it has handled in av_[interleaved]_write_frame().
1425 */
1426 int event_flags;
1427/**
1428 * - demuxing: the demuxer read new metadata from the file and updated
1429 * AVFormatContext.metadata accordingly
1430 * - muxing: the user updated AVFormatContext.metadata and wishes the muxer to
1431 * write it into the file
1432 */
1433#define AVFMT_EVENT_FLAG_METADATA_UPDATED 0x0001
1434
1435 /**
1436 * Maximum number of packets to read while waiting for the first timestamp.
1437 * Decoding only.
1438 */
1439 int max_ts_probe;
1440
1441 /**
1442 * Avoid negative timestamps during muxing.
1443 * Any value of the AVFMT_AVOID_NEG_TS_* constants.
1444 * Note, this works better when using av_interleaved_write_frame().
1445 * - muxing: Set by user
1446 * - demuxing: unused
1449#define AVFMT_AVOID_NEG_TS_AUTO -1 ///< Enabled when required by target format
1450#define AVFMT_AVOID_NEG_TS_DISABLED 0 ///< Do not shift timestamps even when they are negative.
1451#define AVFMT_AVOID_NEG_TS_MAKE_NON_NEGATIVE 1 ///< Shift timestamps so they are non negative
1452#define AVFMT_AVOID_NEG_TS_MAKE_ZERO 2 ///< Shift timestamps so that they start at 0
1453
1454 /**
1455 * Transport stream id.
1456 * This will be moved into demuxer private options. Thus no API/ABI compatibility
1457 */
1458 int ts_id;
1459
1460 /**
1461 * Audio preload in microseconds.
1462 * Note, not all formats support this and unpredictable things may happen if it is used when not supported.
1463 * - encoding: Set by user
1464 * - decoding: unused
1465 */
1466 int audio_preload;
1467
1468 /**
1469 * Max chunk time in microseconds.
1470 * Note, not all formats support this and unpredictable things may happen if it is used when not supported.
1471 * - encoding: Set by user
1472 * - decoding: unused
1473 */
1475
1476 /**
1477 * Max chunk size in bytes
1478 * Note, not all formats support this and unpredictable things may happen if it is used when not supported.
1479 * - encoding: Set by user
1480 * - decoding: unused
1481 */
1482 int max_chunk_size;
1483
1484 /**
1485 * forces the use of wallclock timestamps as pts/dts of packets
1486 * This has undefined results in the presence of B frames.
1487 * - encoding: unused
1488 * - decoding: Set by user
1489 */
1491
1492 /**
1493 * avio flags, used to force AVIO_FLAG_DIRECT.
1494 * - encoding: unused
1495 * - decoding: Set by user
1496 */
1497 int avio_flags;
1498
1499 /**
1500 * The duration field can be estimated through various ways, and this field can be used
1501 * to know how the duration was estimated.
1502 * - encoding: unused
1503 * - decoding: Read by user
1504 */
1506
1507 /**
1508 * Skip initial bytes when opening stream
1509 * - encoding: unused
1510 * - decoding: Set by user
1511 */
1512 int64_t skip_initial_bytes;
1513
1514 /**
1515 * Correct single timestamp overflows
1516 * - encoding: unused
1517 * - decoding: Set by user
1518 */
1519 unsigned int correct_ts_overflow;
1520
1521 /**
1522 * Force seeking to any (also non key) frames.
1523 * - encoding: unused
1524 * - decoding: Set by user
1525 */
1526 int seek2any;
1527
1528 /**
1529 * Flush the I/O context after each packet.
1530 * - encoding: Set by user
1531 * - decoding: unused
1532 */
1533 int flush_packets;
1534
1535 /**
1536 * format probing score.
1537 * The maximal score is AVPROBE_SCORE_MAX, its set when the demuxer probes
1538 * the format.
1539 * - encoding: unused
1540 * - decoding: set by avformat, read by user
1541 */
1542 int probe_score;
1543
1544 /**
1545 * Maximum number of bytes read from input in order to identify the
1546 * \ref AVInputFormat "input format". Only used when the format is not set
1547 * explicitly by the caller.
1548 *
1549 * Demuxing only, set by the caller before avformat_open_input().
1550 *
1551 * @sa probesize
1552 */
1553 int format_probesize;
1554
1555 /**
1556 * ',' separated list of allowed decoders.
1557 * If NULL then all are allowed
1558 * - encoding: unused
1559 * - decoding: set by user
1560 */
1561 char *codec_whitelist;
1562
1563 /**
1564 * ',' separated list of allowed demuxers.
1565 * If NULL then all are allowed
1566 * - encoding: unused
1567 * - decoding: set by user
1568 */
1569 char *format_whitelist;
1570
1571 /**
1572 * IO repositioned flag.
1573 * This is set by avformat when the underlaying IO context read pointer
1574 * is repositioned, for example when doing byte based seeking.
1575 * Demuxers can use the flag to detect such changes.
1576 */
1577 int io_repositioned;
1578
1579 /**
1580 * Forced video codec.
1581 * This allows forcing a specific decoder, even when there are multiple with
1582 * the same codec_id.
1583 * Demuxing: Set by user
1584 */
1585 const struct AVCodec *video_codec;
1586
1587 /**
1588 * Forced audio codec.
1589 * This allows forcing a specific decoder, even when there are multiple with
1590 * the same codec_id.
1591 * Demuxing: Set by user
1592 */
1593 const struct AVCodec *audio_codec;
1594
1595 /**
1596 * Forced subtitle codec.
1597 * This allows forcing a specific decoder, even when there are multiple with
1598 * the same codec_id.
1599 * Demuxing: Set by user
1600 */
1601 const struct AVCodec *subtitle_codec;
1602
1603 /**
1604 * Forced data codec.
1605 * This allows forcing a specific decoder, even when there are multiple with
1606 * the same codec_id.
1607 * Demuxing: Set by user
1608 */
1609 const struct AVCodec *data_codec;
1610
1611 /**
1612 * Number of bytes to be written as padding in a metadata header.
1613 * Demuxing: Unused.
1614 * Muxing: Set by user via av_format_set_metadata_header_padding.
1615 */
1617
1618 /**
1619 * User data.
1620 * This is a place for some private data of the user.
1621 */
1622 void *opaque;
1623
1624 /**
1625 * Callback used by devices to communicate with application.
1626 */
1628
1629 /**
1630 * Output timestamp offset, in microseconds.
1631 * Muxing: set by user
1632 */
1633 int64_t output_ts_offset;
1634
1635 /**
1636 * dump format separator.
1637 * can be ", " or "\n " or anything else
1638 * - muxing: Set by user.
1639 * - demuxing: Set by user.
1640 */
1641 uint8_t *dump_separator;
1642
1643 /**
1644 * Forced Data codec_id.
1645 * Demuxing: Set by user.
1646 */
1648
1649 /**
1650 * ',' separated list of allowed protocols.
1651 * - encoding: unused
1652 * - decoding: set by user
1653 */
1654 char *protocol_whitelist;
1655
1656 /**
1657 * A callback for opening new IO streams.
1658 *
1659 * Whenever a muxer or a demuxer needs to open an IO stream (typically from
1660 * avformat_open_input() for demuxers, but for certain formats can happen at
1661 * other times as well), it will call this callback to obtain an IO context.
1662 *
1663 * @param s the format context
1664 * @param pb on success, the newly opened IO context should be returned here
1665 * @param url the url to open
1666 * @param flags a combination of AVIO_FLAG_*
1667 * @param options a dictionary of additional options, with the same
1668 * semantics as in avio_open2()
1669 * @return 0 on success, a negative AVERROR code on failure
1670 *
1671 * @note Certain muxers and demuxers do nesting, i.e. they open one or more
1672 * additional internal format contexts. Thus the AVFormatContext pointer
1673 * passed to this callback may be different from the one facing the caller.
1674 * It will, however, have the same 'opaque' field.
1675 */
1676 int (*io_open)(struct AVFormatContext *s, AVIOContext **pb, const char *url,
1677 int flags, AVDictionary **options);
1678
1679#if FF_API_AVFORMAT_IO_CLOSE
1680 /**
1681 * A callback for closing the streams opened with AVFormatContext.io_open().
1682 *
1683 * @deprecated use io_close2
1686 void (*io_close)(struct AVFormatContext *s, AVIOContext *pb);
1687#endif
1688
1689 /**
1690 * ',' separated list of disallowed protocols.
1691 * - encoding: unused
1692 * - decoding: set by user
1693 */
1694 char *protocol_blacklist;
1695
1696 /**
1697 * The maximum number of streams.
1698 * - encoding: unused
1699 * - decoding: set by user
1700 */
1701 int max_streams;
1702
1703 /**
1704 * Skip duration calcuation in estimate_timings_from_pts.
1705 * - encoding: unused
1706 * - decoding: set by user
1707 */
1709
1710 /**
1711 * Maximum number of packets that can be probed
1712 * - encoding: unused
1713 * - decoding: set by user
1714 */
1716
1717 /**
1718 * A callback for closing the streams opened with AVFormatContext.io_open().
1719 *
1720 * Using this is preferred over io_close, because this can return an error.
1721 * Therefore this callback is used instead of io_close by the generic
1722 * libavformat code if io_close is NULL or the default.
1723 *
1724 * @param s the format context
1725 * @param pb IO context to be closed and freed
1726 * @return 0 on success, a negative AVERROR code on failure
1727 */
1728 int (*io_close2)(struct AVFormatContext *s, AVIOContext *pb);
1730
1731/**
1732 * This function will cause global side data to be injected in the next packet
1733 * of each stream as well as after any subsequent seek.
1734 *
1735 * @note global side data is always available in every AVStream's
1736 * @ref AVCodecParameters.coded_side_data "codecpar side data" array, and
1737 * in a @ref AVCodecContext.coded_side_data "decoder's side data" array if
1738 * initialized with said stream's codecpar.
1739 * @see av_packet_side_data_get()
1740 */
1742
1743/**
1744 * Returns the method used to set ctx->duration.
1745 *
1746 * @return AVFMT_DURATION_FROM_PTS, AVFMT_DURATION_FROM_STREAM, or AVFMT_DURATION_FROM_BITRATE.
1747 */
1749
1750/**
1751 * @defgroup lavf_core Core functions
1752 * @ingroup libavf
1753 *
1754 * Functions for querying libavformat capabilities, allocating core structures,
1755 * etc.
1756 * @{
1757 */
1758
1759/**
1760 * Return the LIBAVFORMAT_VERSION_INT constant.
1761 */
1762unsigned avformat_version(void);
1763
1764/**
1765 * Return the libavformat build-time configuration.
1766 */
1767const char *avformat_configuration(void);
1768
1769/**
1770 * Return the libavformat license.
1771 */
1772const char *avformat_license(void);
1773
1774/**
1775 * Do global initialization of network libraries. This is optional,
1776 * and not recommended anymore.
1777 *
1778 * This functions only exists to work around thread-safety issues
1779 * with older GnuTLS or OpenSSL libraries. If libavformat is linked
1780 * to newer versions of those libraries, or if you do not use them,
1781 * calling this function is unnecessary. Otherwise, you need to call
1782 * this function before any other threads using them are started.
1783 *
1784 * This function will be deprecated once support for older GnuTLS and
1785 * OpenSSL libraries is removed, and this function has no purpose
1786 * anymore.
1787 */
1788int avformat_network_init(void);
1789
1790/**
1791 * Undo the initialization done by avformat_network_init. Call it only
1792 * once for each time you called avformat_network_init.
1793 */
1794int avformat_network_deinit(void);
1795
1796/**
1797 * Iterate over all registered muxers.
1798 *
1799 * @param opaque a pointer where libavformat will store the iteration state. Must
1800 * point to NULL to start the iteration.
1801 *
1802 * @return the next registered muxer or NULL when the iteration is
1803 * finished
1804 */
1806
1807/**
1808 * Iterate over all registered demuxers.
1809 *
1810 * @param opaque a pointer where libavformat will store the iteration state.
1811 * Must point to NULL to start the iteration.
1812 *
1813 * @return the next registered demuxer or NULL when the iteration is
1814 * finished
1815 */
1817
1818/**
1819 * Allocate an AVFormatContext.
1820 * avformat_free_context() can be used to free the context and everything
1821 * allocated by the framework within it.
1822 */
1824
1825/**
1826 * Free an AVFormatContext and all its streams.
1827 * @param s context to free
1828 */
1830
1831/**
1832 * Get the AVClass for AVFormatContext. It can be used in combination with
1833 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1834 *
1835 * @see av_opt_find().
1836 */
1837const AVClass *avformat_get_class(void);
1838
1839/**
1840 * Get the AVClass for AVStream. It can be used in combination with
1841 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1842 *
1843 * @see av_opt_find().
1844 */
1845const AVClass *av_stream_get_class(void);
1846
1847/**
1848 * Add a new stream to a media file.
1849 *
1850 * When demuxing, it is called by the demuxer in read_header(). If the
1851 * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1852 * be called in read_packet().
1853 *
1854 * When muxing, should be called by the user before avformat_write_header().
1855 *
1856 * User is required to call avformat_free_context() to clean up the allocation
1857 * by avformat_new_stream().
1858 *
1859 * @param s media file handle
1860 * @param c unused, does nothing
1861 *
1862 * @return newly created stream or NULL on error.
1863 */
1865
1866#if FF_API_AVSTREAM_SIDE_DATA
1867/**
1868 * Wrap an existing array as stream side data.
1869 *
1870 * @param st stream
1871 * @param type side information type
1872 * @param data the side data array. It must be allocated with the av_malloc()
1873 * family of functions. The ownership of the data is transferred to
1874 * st.
1875 * @param size side information size
1876 *
1877 * @return zero on success, a negative AVERROR code on failure. On failure,
1878 * the stream is unchanged and the data remains owned by the caller.
1879 * @deprecated use av_packet_side_data_add() with the stream's
1880 * @ref AVCodecParameters.coded_side_data "codecpar side data"
1884 uint8_t *data, size_t size);
1885
1886/**
1887 * Allocate new information from stream.
1888 *
1889 * @param stream stream
1890 * @param type desired side information type
1891 * @param size side information size
1892 *
1893 * @return pointer to fresh allocated data or NULL otherwise
1894 * @deprecated use av_packet_side_data_new() with the stream's
1895 * @ref AVCodecParameters.coded_side_data "codecpar side data"
1898uint8_t *av_stream_new_side_data(AVStream *stream,
1899 enum AVPacketSideDataType type, size_t size);
1900/**
1901 * Get side information from stream.
1902 *
1903 * @param stream stream
1904 * @param type desired side information type
1905 * @param size If supplied, *size will be set to the size of the side data
1906 * or to zero if the desired side data is not present.
1907 *
1908 * @return pointer to data if present or NULL otherwise
1909 * @deprecated use av_packet_side_data_get() with the stream's
1910 * @ref AVCodecParameters.coded_side_data "codecpar side data"
1913uint8_t *av_stream_get_side_data(const AVStream *stream,
1914 enum AVPacketSideDataType type, size_t *size);
1915#endif
1916
1918
1919/**
1920 * @}
1921 */
1922
1923
1924/**
1925 * Allocate an AVFormatContext for an output format.
1926 * avformat_free_context() can be used to free the context and
1927 * everything allocated by the framework within it.
1928 *
1929 * @param ctx pointee is set to the created format context,
1930 * or to NULL in case of failure
1931 * @param oformat format to use for allocating the context, if NULL
1932 * format_name and filename are used instead
1933 * @param format_name the name of output format to use for allocating the
1934 * context, if NULL filename is used instead
1935 * @param filename the name of the filename to use for allocating the
1936 * context, may be NULL
1937 *
1938 * @return >= 0 in case of success, a negative AVERROR code in case of
1939 * failure
1940 */
1942 const char *format_name, const char *filename);
1943
1944/**
1945 * @addtogroup lavf_decoding
1946 * @{
1947 */
1948
1949/**
1950 * Find AVInputFormat based on the short name of the input format.
1951 */
1952const AVInputFormat *av_find_input_format(const char *short_name);
1953
1954/**
1955 * Guess the file format.
1956 *
1957 * @param pd data to be probed
1958 * @param is_opened Whether the file is already opened; determines whether
1959 * demuxers with or without AVFMT_NOFILE are probed.
1960 */
1961const AVInputFormat *av_probe_input_format(const AVProbeData *pd, int is_opened);
1962
1963/**
1964 * Guess the file format.
1965 *
1966 * @param pd data to be probed
1967 * @param is_opened Whether the file is already opened; determines whether
1968 * demuxers with or without AVFMT_NOFILE are probed.
1969 * @param score_max A probe score larger that this is required to accept a
1970 * detection, the variable is set to the actual detection
1971 * score afterwards.
1972 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1973 * to retry with a larger probe buffer.
1974 */
1976 int is_opened, int *score_max);
1977
1978/**
1979 * Guess the file format.
1980 *
1981 * @param is_opened Whether the file is already opened; determines whether
1982 * demuxers with or without AVFMT_NOFILE are probed.
1983 * @param score_ret The score of the best detection.
1984 */
1986 int is_opened, int *score_ret);
1987
1988/**
1989 * Probe a bytestream to determine the input format. Each time a probe returns
1990 * with a score that is too low, the probe buffer size is increased and another
1991 * attempt is made. When the maximum probe size is reached, the input format
1992 * with the highest score is returned.
1993 *
1994 * @param pb the bytestream to probe
1995 * @param fmt the input format is put here
1996 * @param url the url of the stream
1997 * @param logctx the log context
1998 * @param offset the offset within the bytestream to probe from
1999 * @param max_probe_size the maximum probe buffer size (zero for default)
2000 *
2001 * @return the score in case of success, a negative value corresponding to an
2002 * the maximal score is AVPROBE_SCORE_MAX
2003 * AVERROR code otherwise
2004 */
2006 const char *url, void *logctx,
2007 unsigned int offset, unsigned int max_probe_size);
2008
2009/**
2010 * Like av_probe_input_buffer2() but returns 0 on success
2011 */
2013 const char *url, void *logctx,
2014 unsigned int offset, unsigned int max_probe_size);
2015
2016/**
2017 * Open an input stream and read the header. The codecs are not opened.
2018 * The stream must be closed with avformat_close_input().
2019 *
2020 * @param ps Pointer to user-supplied AVFormatContext (allocated by
2021 * avformat_alloc_context). May be a pointer to NULL, in
2022 * which case an AVFormatContext is allocated by this
2023 * function and written into ps.
2024 * Note that a user-supplied AVFormatContext will be freed
2025 * on failure.
2026 * @param url URL of the stream to open.
2027 * @param fmt If non-NULL, this parameter forces a specific input format.
2028 * Otherwise the format is autodetected.
2029 * @param options A dictionary filled with AVFormatContext and demuxer-private
2030 * options.
2031 * On return this parameter will be destroyed and replaced with
2032 * a dict containing options that were not found. May be NULL.
2033 *
2034 * @return 0 on success, a negative AVERROR on failure.
2035 *
2036 * @note If you want to use custom IO, preallocate the format context and set its pb field.
2037 */
2038int avformat_open_input(AVFormatContext **ps, const char *url,
2039 const AVInputFormat *fmt, AVDictionary **options);
2040
2041/**
2042 * Read packets of a media file to get stream information. This
2043 * is useful for file formats with no headers such as MPEG. This
2044 * function also computes the real framerate in case of MPEG-2 repeat
2045 * frame mode.
2046 * The logical file position is not changed by this function;
2047 * examined packets may be buffered for later processing.
2048 *
2049 * @param ic media file handle
2050 * @param options If non-NULL, an ic.nb_streams long array of pointers to
2051 * dictionaries, where i-th member contains options for
2052 * codec corresponding to i-th stream.
2053 * On return each dictionary will be filled with options that were not found.
2054 * @return >=0 if OK, AVERROR_xxx on error
2055 *
2056 * @note this function isn't guaranteed to open all the codecs, so
2057 * options being non-empty at return is a perfectly normal behavior.
2058 *
2059 * @todo Let the user decide somehow what information is needed so that
2060 * we do not waste time getting stuff the user does not need.
2061 */
2063
2064/**
2065 * Find the programs which belong to a given stream.
2066 *
2067 * @param ic media file handle
2068 * @param last the last found program, the search will start after this
2069 * program, or from the beginning if it is NULL
2070 * @param s stream index
2071 *
2072 * @return the next program which belongs to s, NULL if no program is found or
2073 * the last program is not among the programs of ic.
2074 */
2076
2077void av_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
2078
2079/**
2080 * Find the "best" stream in the file.
2081 * The best stream is determined according to various heuristics as the most
2082 * likely to be what the user expects.
2083 * If the decoder parameter is non-NULL, av_find_best_stream will find the
2084 * default decoder for the stream's codec; streams for which no decoder can
2085 * be found are ignored.
2086 *
2087 * @param ic media file handle
2088 * @param type stream type: video, audio, subtitles, etc.
2089 * @param wanted_stream_nb user-requested stream number,
2090 * or -1 for automatic selection
2091 * @param related_stream try to find a stream related (eg. in the same
2092 * program) to this one, or -1 if none
2093 * @param decoder_ret if non-NULL, returns the decoder for the
2094 * selected stream
2095 * @param flags flags; none are currently defined
2096 *
2097 * @return the non-negative stream number in case of success,
2098 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
2099 * could be found,
2100 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
2101 *
2102 * @note If av_find_best_stream returns successfully and decoder_ret is not
2103 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
2104 */
2106 enum AVMediaType type,
2107 int wanted_stream_nb,
2108 int related_stream,
2109 const struct AVCodec **decoder_ret,
2110 int flags);
2111
2112/**
2113 * Return the next frame of a stream.
2114 * This function returns what is stored in the file, and does not validate
2115 * that what is there are valid frames for the decoder. It will split what is
2116 * stored in the file into frames and return one for each call. It will not
2117 * omit invalid data between valid frames so as to give the decoder the maximum
2118 * information possible for decoding.
2119 *
2120 * On success, the returned packet is reference-counted (pkt->buf is set) and
2121 * valid indefinitely. The packet must be freed with av_packet_unref() when
2122 * it is no longer needed. For video, the packet contains exactly one frame.
2123 * For audio, it contains an integer number of frames if each frame has
2124 * a known fixed size (e.g. PCM or ADPCM data). If the audio frames have
2125 * a variable size (e.g. MPEG audio), then it contains one frame.
2126 *
2127 * pkt->pts, pkt->dts and pkt->duration are always set to correct
2128 * values in AVStream.time_base units (and guessed if the format cannot
2129 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
2130 * has B-frames, so it is better to rely on pkt->dts if you do not
2131 * decompress the payload.
2132 *
2133 * @return 0 if OK, < 0 on error or end of file. On error, pkt will be blank
2134 * (as if it came from av_packet_alloc()).
2135 *
2136 * @note pkt will be initialized, so it may be uninitialized, but it must not
2137 * contain data that needs to be freed.
2138 */
2140
2141/**
2142 * Seek to the keyframe at timestamp.
2143 * 'timestamp' in 'stream_index'.
2144 *
2145 * @param s media file handle
2146 * @param stream_index If stream_index is (-1), a default stream is selected,
2147 * and timestamp is automatically converted from
2148 * AV_TIME_BASE units to the stream specific time_base.
2149 * @param timestamp Timestamp in AVStream.time_base units or, if no stream
2150 * is specified, in AV_TIME_BASE units.
2151 * @param flags flags which select direction and seeking mode
2152 *
2153 * @return >= 0 on success
2154 */
2155int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
2156 int flags);
2157
2158/**
2159 * Seek to timestamp ts.
2160 * Seeking will be done so that the point from which all active streams
2161 * can be presented successfully will be closest to ts and within min/max_ts.
2162 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
2163 *
2164 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
2165 * are the file position (this may not be supported by all demuxers).
2166 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
2167 * in the stream with stream_index (this may not be supported by all demuxers).
2168 * Otherwise all timestamps are in units of the stream selected by stream_index
2169 * or if stream_index is -1, in AV_TIME_BASE units.
2170 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
2171 * keyframes (this may not be supported by all demuxers).
2172 * If flags contain AVSEEK_FLAG_BACKWARD, it is ignored.
2173 *
2174 * @param s media file handle
2175 * @param stream_index index of the stream which is used as time base reference
2176 * @param min_ts smallest acceptable timestamp
2177 * @param ts target timestamp
2178 * @param max_ts largest acceptable timestamp
2179 * @param flags flags
2180 * @return >=0 on success, error code otherwise
2181 *
2182 * @note This is part of the new seek API which is still under construction.
2183 */
2184int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
2185
2186/**
2187 * Discard all internally buffered data. This can be useful when dealing with
2188 * discontinuities in the byte stream. Generally works only with formats that
2189 * can resync. This includes headerless formats like MPEG-TS/TS but should also
2190 * work with NUT, Ogg and in a limited way AVI for example.
2191 *
2192 * The set of streams, the detected duration, stream parameters and codecs do
2193 * not change when calling this function. If you want a complete reset, it's
2194 * better to open a new AVFormatContext.
2195 *
2196 * This does not flush the AVIOContext (s->pb). If necessary, call
2197 * avio_flush(s->pb) before calling this function.
2198 *
2199 * @param s media file handle
2200 * @return >=0 on success, error code otherwise
2201 */
2203
2204/**
2205 * Start playing a network-based stream (e.g. RTSP stream) at the
2206 * current position.
2207 */
2209
2210/**
2211 * Pause a network-based stream (e.g. RTSP stream).
2212 *
2213 * Use av_read_play() to resume it.
2214 */
2216
2217/**
2218 * Close an opened input AVFormatContext. Free it and all its contents
2219 * and set *s to NULL.
2220 */
2222/**
2223 * @}
2226#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
2227#define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
2228#define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
2229#define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
2230
2231/**
2232 * @addtogroup lavf_encoding
2233 * @{
2236#define AVSTREAM_INIT_IN_WRITE_HEADER 0 ///< stream parameters initialized in avformat_write_header
2237#define AVSTREAM_INIT_IN_INIT_OUTPUT 1 ///< stream parameters initialized in avformat_init_output
2238
2239/**
2240 * Allocate the stream private data and write the stream header to
2241 * an output media file.
2242 *
2243 * @param s Media file handle, must be allocated with
2244 * avformat_alloc_context().
2245 * Its \ref AVFormatContext.oformat "oformat" field must be set
2246 * to the desired output format;
2247 * Its \ref AVFormatContext.pb "pb" field must be set to an
2248 * already opened ::AVIOContext.
2249 * @param options An ::AVDictionary filled with AVFormatContext and
2250 * muxer-private options.
2251 * On return this parameter will be destroyed and replaced with
2252 * a dict containing options that were not found. May be NULL.
2253 *
2254 * @retval AVSTREAM_INIT_IN_WRITE_HEADER On success, if the codec had not already been
2255 * fully initialized in avformat_init_output().
2256 * @retval AVSTREAM_INIT_IN_INIT_OUTPUT On success, if the codec had already been fully
2257 * initialized in avformat_init_output().
2258 * @retval AVERROR A negative AVERROR on failure.
2259 *
2260 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next, avformat_init_output.
2264
2265/**
2266 * Allocate the stream private data and initialize the codec, but do not write the header.
2267 * May optionally be used before avformat_write_header() to initialize stream parameters
2268 * before actually writing the header.
2269 * If using this function, do not pass the same options to avformat_write_header().
2270 *
2271 * @param s Media file handle, must be allocated with
2272 * avformat_alloc_context().
2273 * Its \ref AVFormatContext.oformat "oformat" field must be set
2274 * to the desired output format;
2275 * Its \ref AVFormatContext.pb "pb" field must be set to an
2276 * already opened ::AVIOContext.
2277 * @param options An ::AVDictionary filled with AVFormatContext and
2278 * muxer-private options.
2279 * On return this parameter will be destroyed and replaced with
2280 * a dict containing options that were not found. May be NULL.
2281 *
2282 * @retval AVSTREAM_INIT_IN_WRITE_HEADER On success, if the codec requires
2283 * avformat_write_header to fully initialize.
2284 * @retval AVSTREAM_INIT_IN_INIT_OUTPUT On success, if the codec has been fully
2285 * initialized.
2286 * @retval AVERROR Anegative AVERROR on failure.
2287 *
2288 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next, avformat_write_header.
2292
2293/**
2294 * Write a packet to an output media file.
2295 *
2296 * This function passes the packet directly to the muxer, without any buffering
2297 * or reordering. The caller is responsible for correctly interleaving the
2298 * packets if the format requires it. Callers that want libavformat to handle
2299 * the interleaving should call av_interleaved_write_frame() instead of this
2300 * function.
2301 *
2302 * @param s media file handle
2303 * @param pkt The packet containing the data to be written. Note that unlike
2304 * av_interleaved_write_frame(), this function does not take
2305 * ownership of the packet passed to it (though some muxers may make
2306 * an internal reference to the input packet).
2307 * <br>
2308 * This parameter can be NULL (at any time, not just at the end), in
2309 * order to immediately flush data buffered within the muxer, for
2310 * muxers that buffer up data internally before writing it to the
2311 * output.
2312 * <br>
2313 * Packet's @ref AVPacket.stream_index "stream_index" field must be
2314 * set to the index of the corresponding stream in @ref
2315 * AVFormatContext.streams "s->streams".
2316 * <br>
2317 * The timestamps (@ref AVPacket.pts "pts", @ref AVPacket.dts "dts")
2318 * must be set to correct values in the stream's timebase (unless the
2319 * output format is flagged with the AVFMT_NOTIMESTAMPS flag, then
2320 * they can be set to AV_NOPTS_VALUE).
2321 * The dts for subsequent packets passed to this function must be strictly
2322 * increasing when compared in their respective timebases (unless the
2323 * output format is flagged with the AVFMT_TS_NONSTRICT, then they
2324 * merely have to be nondecreasing). @ref AVPacket.duration
2325 * "duration") should also be set if known.
2326 * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush
2327 *
2328 * @see av_interleaved_write_frame()
2329 */
2331
2332/**
2333 * Write a packet to an output media file ensuring correct interleaving.
2334 *
2335 * This function will buffer the packets internally as needed to make sure the
2336 * packets in the output file are properly interleaved, usually ordered by
2337 * increasing dts. Callers doing their own interleaving should call
2338 * av_write_frame() instead of this function.
2339 *
2340 * Using this function instead of av_write_frame() can give muxers advance
2341 * knowledge of future packets, improving e.g. the behaviour of the mp4
2342 * muxer for VFR content in fragmenting mode.
2343 *
2344 * @param s media file handle
2345 * @param pkt The packet containing the data to be written.
2346 * <br>
2347 * If the packet is reference-counted, this function will take
2348 * ownership of this reference and unreference it later when it sees
2349 * fit. If the packet is not reference-counted, libavformat will
2350 * make a copy.
2351 * The returned packet will be blank (as if returned from
2352 * av_packet_alloc()), even on error.
2353 * <br>
2354 * This parameter can be NULL (at any time, not just at the end), to
2355 * flush the interleaving queues.
2356 * <br>
2357 * Packet's @ref AVPacket.stream_index "stream_index" field must be
2358 * set to the index of the corresponding stream in @ref
2359 * AVFormatContext.streams "s->streams".
2360 * <br>
2361 * The timestamps (@ref AVPacket.pts "pts", @ref AVPacket.dts "dts")
2362 * must be set to correct values in the stream's timebase (unless the
2363 * output format is flagged with the AVFMT_NOTIMESTAMPS flag, then
2364 * they can be set to AV_NOPTS_VALUE).
2365 * The dts for subsequent packets in one stream must be strictly
2366 * increasing (unless the output format is flagged with the
2367 * AVFMT_TS_NONSTRICT, then they merely have to be nondecreasing).
2368 * @ref AVPacket.duration "duration" should also be set if known.
2369 *
2370 * @return 0 on success, a negative AVERROR on error.
2371 *
2372 * @see av_write_frame(), AVFormatContext.max_interleave_delta
2373 */
2375
2376/**
2377 * Write an uncoded frame to an output media file.
2378 *
2379 * The frame must be correctly interleaved according to the container
2380 * specification; if not, av_interleaved_write_uncoded_frame() must be used.
2381 *
2382 * See av_interleaved_write_uncoded_frame() for details.
2383 */
2384int av_write_uncoded_frame(AVFormatContext *s, int stream_index,
2385 struct AVFrame *frame);
2386
2387/**
2388 * Write an uncoded frame to an output media file.
2389 *
2390 * If the muxer supports it, this function makes it possible to write an AVFrame
2391 * structure directly, without encoding it into a packet.
2392 * It is mostly useful for devices and similar special muxers that use raw
2393 * video or PCM data and will not serialize it into a byte stream.
2394 *
2395 * To test whether it is possible to use it with a given muxer and stream,
2396 * use av_write_uncoded_frame_query().
2397 *
2398 * The caller gives up ownership of the frame and must not access it
2399 * afterwards.
2400 *
2401 * @return >=0 for success, a negative code on error
2402 */
2404 struct AVFrame *frame);
2405
2406/**
2407 * Test whether a muxer supports uncoded frame.
2408 *
2409 * @return >=0 if an uncoded frame can be written to that muxer and stream,
2410 * <0 if not
2411 */
2412int av_write_uncoded_frame_query(AVFormatContext *s, int stream_index);
2413
2414/**
2415 * Write the stream trailer to an output media file and free the
2416 * file private data.
2417 *
2418 * May only be called after a successful call to avformat_write_header.
2419 *
2420 * @param s media file handle
2421 * @return 0 if OK, AVERROR_xxx on error
2422 */
2424
2425/**
2426 * Return the output format in the list of registered output formats
2427 * which best matches the provided parameters, or return NULL if
2428 * there is no match.
2429 *
2430 * @param short_name if non-NULL checks if short_name matches with the
2431 * names of the registered formats
2432 * @param filename if non-NULL checks if filename terminates with the
2433 * extensions of the registered formats
2434 * @param mime_type if non-NULL checks if mime_type matches with the
2435 * MIME type of the registered formats
2436 */
2437const AVOutputFormat *av_guess_format(const char *short_name,
2438 const char *filename,
2439 const char *mime_type);
2440
2441/**
2442 * Guess the codec ID based upon muxer and filename.
2443 */
2444enum AVCodecID av_guess_codec(const AVOutputFormat *fmt, const char *short_name,
2445 const char *filename, const char *mime_type,
2446 enum AVMediaType type);
2447
2448/**
2449 * Get timing information for the data currently output.
2450 * The exact meaning of "currently output" depends on the format.
2451 * It is mostly relevant for devices that have an internal buffer and/or
2452 * work in real time.
2453 * @param s media file handle
2454 * @param stream stream in the media file
2455 * @param[out] dts DTS of the last packet output for the stream, in stream
2456 * time_base units
2457 * @param[out] wall absolute time when that packet whas output,
2458 * in microsecond
2459 * @retval 0 Success
2460 * @retval AVERROR(ENOSYS) The format does not support it
2461 *
2462 * @note Some formats or devices may not allow to measure dts and wall
2463 * atomically.
2464 */
2465int av_get_output_timestamp(struct AVFormatContext *s, int stream,
2466 int64_t *dts, int64_t *wall);
2467
2468
2469/**
2470 * @}
2471 */
2472
2473
2474/**
2475 * @defgroup lavf_misc Utility functions
2476 * @ingroup libavf
2477 * @{
2478 *
2479 * Miscellaneous utility functions related to both muxing and demuxing
2480 * (or neither).
2481 */
2482
2483/**
2484 * Send a nice hexadecimal dump of a buffer to the specified file stream.
2485 *
2486 * @param f The file stream pointer where the dump should be sent to.
2487 * @param buf buffer
2488 * @param size buffer size
2489 *
2490 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
2491 */
2492void av_hex_dump(FILE *f, const uint8_t *buf, int size);
2493
2494/**
2495 * Send a nice hexadecimal dump of a buffer to the log.
2496 *
2497 * @param avcl A pointer to an arbitrary struct of which the first field is a
2498 * pointer to an AVClass struct.
2499 * @param level The importance level of the message, lower values signifying
2500 * higher importance.
2501 * @param buf buffer
2502 * @param size buffer size
2503 *
2504 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
2505 */
2506void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size);
2507
2508/**
2509 * Send a nice dump of a packet to the specified file stream.
2510 *
2511 * @param f The file stream pointer where the dump should be sent to.
2512 * @param pkt packet to dump
2513 * @param dump_payload True if the payload must be displayed, too.
2514 * @param st AVStream that the packet belongs to
2515 */
2516void av_pkt_dump2(FILE *f, const AVPacket *pkt, int dump_payload, const AVStream *st);
2517
2518
2519/**
2520 * Send a nice dump of a packet to the log.
2521 *
2522 * @param avcl A pointer to an arbitrary struct of which the first field is a
2523 * pointer to an AVClass struct.
2524 * @param level The importance level of the message, lower values signifying
2525 * higher importance.
2526 * @param pkt packet to dump
2527 * @param dump_payload True if the payload must be displayed, too.
2528 * @param st AVStream that the packet belongs to
2529 */
2530void av_pkt_dump_log2(void *avcl, int level, const AVPacket *pkt, int dump_payload,
2531 const AVStream *st);
2532
2533/**
2534 * Get the AVCodecID for the given codec tag tag.
2535 * If no codec id is found returns AV_CODEC_ID_NONE.
2536 *
2537 * @param tags list of supported codec_id-codec_tag pairs, as stored
2538 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
2539 * @param tag codec tag to match to a codec ID
2540 */
2541enum AVCodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
2542
2543/**
2544 * Get the codec tag for the given codec id id.
2545 * If no codec tag is found returns 0.
2546 *
2547 * @param tags list of supported codec_id-codec_tag pairs, as stored
2548 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
2549 * @param id codec ID to match to a codec tag
2550 */
2551unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum AVCodecID id);
2552
2553/**
2554 * Get the codec tag for the given codec id.
2555 *
2556 * @param tags list of supported codec_id - codec_tag pairs, as stored
2557 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
2558 * @param id codec id that should be searched for in the list
2559 * @param tag A pointer to the found tag
2560 * @return 0 if id was not found in tags, > 0 if it was found
2561 */
2562int av_codec_get_tag2(const struct AVCodecTag * const *tags, enum AVCodecID id,
2563 unsigned int *tag);
2564
2566
2567/**
2568 * Get the index for a specific timestamp.
2569 *
2570 * @param st stream that the timestamp belongs to
2571 * @param timestamp timestamp to retrieve the index for
2572 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
2573 * to the timestamp which is <= the requested one, if backward
2574 * is 0, then it will be >=
2575 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
2576 * @return < 0 if no such timestamp could be found
2577 */
2578int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
2579
2580/**
2581 * Get the index entry count for the given AVStream.
2582 *
2583 * @param st stream
2584 * @return the number of index entries in the stream
2585 */
2587
2588/**
2589 * Get the AVIndexEntry corresponding to the given index.
2590 *
2591 * @param st Stream containing the requested AVIndexEntry.
2592 * @param idx The desired index.
2593 * @return A pointer to the requested AVIndexEntry if it exists, NULL otherwise.
2594 *
2595 * @note The pointer returned by this function is only guaranteed to be valid
2596 * until any function that takes the stream or the parent AVFormatContext
2597 * as input argument is called.
2598 */
2600
2601/**
2602 * Get the AVIndexEntry corresponding to the given timestamp.
2603 *
2604 * @param st Stream containing the requested AVIndexEntry.
2605 * @param wanted_timestamp Timestamp to retrieve the index entry for.
2606 * @param flags If AVSEEK_FLAG_BACKWARD then the returned entry will correspond
2607 * to the timestamp which is <= the requested one, if backward
2608 * is 0, then it will be >=
2609 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise.
2610 * @return A pointer to the requested AVIndexEntry if it exists, NULL otherwise.
2611 *
2612 * @note The pointer returned by this function is only guaranteed to be valid
2613 * until any function that takes the stream or the parent AVFormatContext
2614 * as input argument is called.
2615 */
2617 int64_t wanted_timestamp,
2618 int flags);
2619/**
2620 * Add an index entry into a sorted list. Update the entry if the list
2621 * already contains it.
2622 *
2623 * @param timestamp timestamp in the time base of the given stream
2624 */
2625int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
2626 int size, int distance, int flags);
2627
2628
2629/**
2630 * Split a URL string into components.
2631 *
2632 * The pointers to buffers for storing individual components may be null,
2633 * in order to ignore that component. Buffers for components not found are
2634 * set to empty strings. If the port is not found, it is set to a negative
2635 * value.
2636 *
2637 * @param proto the buffer for the protocol
2638 * @param proto_size the size of the proto buffer
2639 * @param authorization the buffer for the authorization
2640 * @param authorization_size the size of the authorization buffer
2641 * @param hostname the buffer for the host name
2642 * @param hostname_size the size of the hostname buffer
2643 * @param port_ptr a pointer to store the port number in
2644 * @param path the buffer for the path
2645 * @param path_size the size of the path buffer
2646 * @param url the URL to split
2647 */
2648void av_url_split(char *proto, int proto_size,
2649 char *authorization, int authorization_size,
2650 char *hostname, int hostname_size,
2651 int *port_ptr,
2652 char *path, int path_size,
2653 const char *url);
2654
2655
2656/**
2657 * Print detailed information about the input or output format, such as
2658 * duration, bitrate, streams, container, programs, metadata, side data,
2659 * codec and time base.
2660 *
2661 * @param ic the context to analyze
2662 * @param index index of the stream to dump information about
2663 * @param url the URL to print, such as source or destination file
2664 * @param is_output Select whether the specified context is an input(0) or output(1)
2665 */
2667 int index,
2668 const char *url,
2669 int is_output);
2671
2672#define AV_FRAME_FILENAME_FLAGS_MULTIPLE 1 ///< Allow multiple %d
2673
2674/**
2675 * Return in 'buf' the path with '%d' replaced by a number.
2676 *
2677 * Also handles the '%0nd' format where 'n' is the total number
2678 * of digits and '%%'.
2679 *
2680 * @param buf destination buffer
2681 * @param buf_size destination buffer size
2682 * @param path numbered sequence string
2683 * @param number frame number
2684 * @param flags AV_FRAME_FILENAME_FLAGS_*
2685 * @return 0 if OK, -1 on format error
2686 */
2687int av_get_frame_filename2(char *buf, int buf_size,
2688 const char *path, int number, int flags);
2689
2690int av_get_frame_filename(char *buf, int buf_size,
2691 const char *path, int number);
2692
2693/**
2694 * Check whether filename actually is a numbered sequence generator.
2695 *
2696 * @param filename possible numbered sequence string
2697 * @return 1 if a valid numbered sequence string, 0 otherwise
2698 */
2699int av_filename_number_test(const char *filename);
2700
2701/**
2702 * Generate an SDP for an RTP session.
2703 *
2704 * Note, this overwrites the id values of AVStreams in the muxer contexts
2705 * for getting unique dynamic payload types.
2706 *
2707 * @param ac array of AVFormatContexts describing the RTP streams. If the
2708 * array is composed by only one context, such context can contain
2709 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
2710 * all the contexts in the array (an AVCodecContext per RTP stream)
2711 * must contain only one AVStream.
2712 * @param n_files number of AVCodecContexts contained in ac
2713 * @param buf buffer where the SDP will be stored (must be allocated by
2714 * the caller)
2715 * @param size the size of the buffer
2716 * @return 0 if OK, AVERROR_xxx on error
2717 */
2718int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
2719
2720/**
2721 * Return a positive value if the given filename has one of the given
2722 * extensions, 0 otherwise.
2723 *
2724 * @param filename file name to check against the given extensions
2725 * @param extensions a comma-separated list of filename extensions
2726 */
2727int av_match_ext(const char *filename, const char *extensions);
2728
2729/**
2730 * Test if the given container can store a codec.
2731 *
2732 * @param ofmt container to check for compatibility
2733 * @param codec_id codec to potentially store in container
2734 * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
2735 *
2736 * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
2737 * A negative number if this information is not available.
2738 */
2739int avformat_query_codec(const AVOutputFormat *ofmt, enum AVCodecID codec_id,
2740 int std_compliance);
2741
2742/**
2743 * @defgroup riff_fourcc RIFF FourCCs
2744 * @{
2745 * Get the tables mapping RIFF FourCCs to libavcodec AVCodecIDs. The tables are
2746 * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the
2747 * following code:
2748 * @code
2749 * uint32_t tag = MKTAG('H', '2', '6', '4');
2750 * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 };
2751 * enum AVCodecID id = av_codec_get_id(table, tag);
2752 * @endcode
2753 */
2754/**
2755 * @return the table mapping RIFF FourCCs for video to libavcodec AVCodecID.
2756 */
2757const struct AVCodecTag *avformat_get_riff_video_tags(void);
2758/**
2759 * @return the table mapping RIFF FourCCs for audio to AVCodecID.
2760 */
2761const struct AVCodecTag *avformat_get_riff_audio_tags(void);
2762/**
2763 * @return the table mapping MOV FourCCs for video to libavcodec AVCodecID.
2764 */
2765const struct AVCodecTag *avformat_get_mov_video_tags(void);
2766/**
2767 * @return the table mapping MOV FourCCs for audio to AVCodecID.
2768 */
2769const struct AVCodecTag *avformat_get_mov_audio_tags(void);
2770
2771/**
2772 * @}
2773 */
2774
2775/**
2776 * Guess the sample aspect ratio of a frame, based on both the stream and the
2777 * frame aspect ratio.
2778 *
2779 * Since the frame aspect ratio is set by the codec but the stream aspect ratio
2780 * is set by the demuxer, these two may not be equal. This function tries to
2781 * return the value that you should use if you would like to display the frame.
2782 *
2783 * Basic logic is to use the stream aspect ratio if it is set to something sane
2784 * otherwise use the frame aspect ratio. This way a container setting, which is
2785 * usually easy to modify can override the coded value in the frames.
2786 *
2787 * @param format the format context which the stream is part of
2788 * @param stream the stream which the frame is part of
2789 * @param frame the frame with the aspect ratio to be determined
2790 * @return the guessed (valid) sample_aspect_ratio, 0/1 if no idea
2791 */
2793 struct AVFrame *frame);
2794
2795/**
2796 * Guess the frame rate, based on both the container and codec information.
2797 *
2798 * @param ctx the format context which the stream is part of
2799 * @param stream the stream which the frame is part of
2800 * @param frame the frame for which the frame rate should be determined, may be NULL
2801 * @return the guessed (valid) frame rate, 0/1 if no idea
2802 */
2804 struct AVFrame *frame);
2805
2806/**
2807 * Check if the stream st contained in s is matched by the stream specifier
2808 * spec.
2809 *
2810 * See the "stream specifiers" chapter in the documentation for the syntax
2811 * of spec.
2812 *
2813 * @return >0 if st is matched by spec;
2814 * 0 if st is not matched by spec;
2815 * AVERROR code if spec is invalid
2816 *
2817 * @note A stream specifier can match several streams in the format.
2818 */
2820 const char *spec);
2821
2828#if FF_API_R_FRAME_RATE
2830#endif
2831};
2832
2833/**
2834 * Transfer internal timing information from one stream to another.
2835 *
2836 * This function is useful when doing stream copy.
2837 *
2838 * @param ofmt target output format for ost
2839 * @param ost output stream which needs timings copy and adjustments
2840 * @param ist reference input stream to copy timings from
2841 * @param copy_tb define from where the stream codec timebase needs to be imported
2842 */
2844 AVStream *ost, const AVStream *ist,
2845 enum AVTimebaseSource copy_tb);
2846
2847/**
2848 * Get the internal codec timebase from a stream.
2849 *
2850 * @param st input stream to extract the timebase from
2851 */
2853
2854/**
2855 * @}
2856 */
2857
2858#endif /* AVFORMAT_AVFORMAT_H */
#define av_warn_unused_result
Definition: attributes.h:62
#define attribute_deprecated
Definition: attributes.h:100
int av_append_packet(AVIOContext *s, AVPacket *pkt, int size)
Read data and append it to the current content of the AVPacket.
int(* AVOpenCallback)(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags, const AVIOInterruptCB *int_cb, AVDictionary **options)
Definition: avformat.h:1088
AVDurationEstimationMethod
The duration of a video can be estimated through various ways, and this enum can be used to know how ...
Definition: avformat.h:1095
@ AVFMT_DURATION_FROM_BITRATE
Duration estimated from bitrate (less accurate)
Definition: avformat.h:1098
@ AVFMT_DURATION_FROM_PTS
Duration accurately estimated from PTSes.
Definition: avformat.h:1096
@ AVFMT_DURATION_FROM_STREAM
Duration estimated from a stream with a known duration.
Definition: avformat.h:1097
int(* av_format_control_message)(struct AVFormatContext *s, int type, void *data, size_t data_size)
Callback used by devices to communicate with application.
Definition: avformat.h:1085
const char * av_disposition_to_string(int disposition)
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size)
Allocate and read the payload of a packet and initialize its fields with default values.
void av_format_inject_global_side_data(AVFormatContext *s)
This function will cause global side data to be injected in the next packet of each stream as well as...
int av_disposition_from_string(const char *disp)
attribute_deprecated int64_t av_stream_get_end_pts(const AVStream *st)
Returns the pts of the last muxed packet + its duration.
enum AVDurationEstimationMethod av_fmt_ctx_get_duration_estimation_method(const AVFormatContext *ctx)
Returns the method used to set ctx->duration.
struct AVCodecParserContext * av_stream_get_parser(const AVStream *s)
int avformat_alloc_output_context2(AVFormatContext **ctx, const AVOutputFormat *oformat, const char *format_name, const char *filename)
Allocate an AVFormatContext for an output format.
AVStreamParseType
Definition: avformat.h:689
@ AVSTREAM_PARSE_TIMESTAMPS
full parsing and interpolation of timestamps for frames not starting on a packet boundary
Definition: avformat.h:693
@ AVSTREAM_PARSE_FULL_ONCE
full parsing and repack of the first frame only, only implemented for H.264 currently
Definition: avformat.h:694
@ AVSTREAM_PARSE_FULL_RAW
full parsing and repack with timestamp and position generation by parser for raw this assumes that ea...
Definition: avformat.h:695
@ AVSTREAM_PARSE_HEADERS
Only parse headers, do not repack.
Definition: avformat.h:692
@ AVSTREAM_PARSE_FULL
full parsing and repack
Definition: avformat.h:691
@ AVSTREAM_PARSE_NONE
Definition: avformat.h:690
Buffered I/O operations.
Misc types and constants that do not belong anywhere else.
static AVPacket * pkt
Definition: demux_decode.c:55
static AVFrame * frame
Definition: demux_decode.c:54
Public dictionary API.
reference-counted frame API
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: codec_id.h:49
AVDiscard
Definition: defs.h:210
AVPacketSideDataType
Definition: packet.h:41
attribute_deprecated int av_stream_add_side_data(AVStream *st, enum AVPacketSideDataType type, uint8_t *data, size_t size)
Wrap an existing array as stream side data.
int avformat_network_deinit(void)
Undo the initialization done by avformat_network_init.
const char * avformat_configuration(void)
Return the libavformat build-time configuration.
AVProgram * av_new_program(AVFormatContext *s, int id)
AVStream * avformat_new_stream(AVFormatContext *s, const struct AVCodec *c)
Add a new stream to a media file.
const AVClass * av_stream_get_class(void)
Get the AVClass for AVStream.
attribute_deprecated uint8_t * av_stream_get_side_data(const AVStream *stream, enum AVPacketSideDataType type, size_t *size)
Get side information from stream.
attribute_deprecated uint8_t * av_stream_new_side_data(AVStream *stream, enum AVPacketSideDataType type, size_t size)
Allocate new information from stream.
const AVOutputFormat * av_muxer_iterate(void **opaque)
Iterate over all registered muxers.
int avformat_network_init(void)
Do global initialization of network libraries.
const char * avformat_license(void)
Return the libavformat license.
AVFormatContext * avformat_alloc_context(void)
Allocate an AVFormatContext.
const AVInputFormat * av_demuxer_iterate(void **opaque)
Iterate over all registered demuxers.
void avformat_free_context(AVFormatContext *s)
Free an AVFormatContext and all its streams.
const AVClass * avformat_get_class(void)
Get the AVClass for AVFormatContext.
unsigned avformat_version(void)
Return the LIBAVFORMAT_VERSION_INT constant.
const AVInputFormat * av_find_input_format(const char *short_name)
Find AVInputFormat based on the short name of the input format.
AVProgram * av_find_program_from_stream(AVFormatContext *ic, AVProgram *last, int s)
Find the programs which belong to a given stream.
const AVInputFormat * av_probe_input_format3(const AVProbeData *pd, int is_opened, int *score_ret)
Guess the file format.
int av_read_pause(AVFormatContext *s)
Pause a network-based stream (e.g.
int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags)
Seek to timestamp ts.
int av_read_frame(AVFormatContext *s, AVPacket *pkt)
Return the next frame of a stream.
int av_read_play(AVFormatContext *s)
Start playing a network-based stream (e.g.
int av_find_best_stream(AVFormatContext *ic, enum AVMediaType type, int wanted_stream_nb, int related_stream, const struct AVCodec **decoder_ret, int flags)
Find the "best" stream in the file.
int av_probe_input_buffer(AVIOContext *pb, const AVInputFormat **fmt, const char *url, void *logctx, unsigned int offset, unsigned int max_probe_size)
Like av_probe_input_buffer2() but returns 0 on success.
int avformat_flush(AVFormatContext *s)
Discard all internally buffered data.
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
Seek to the keyframe at timestamp.
void av_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx)
int av_probe_input_buffer2(AVIOContext *pb, const AVInputFormat **fmt, const char *url, void *logctx, unsigned int offset, unsigned int max_probe_size)
Probe a bytestream to determine the input format.
int avformat_open_input(AVFormatContext **ps, const char *url, const AVInputFormat *fmt, AVDictionary **options)
Open an input stream and read the header.
const AVInputFormat * av_probe_input_format(const AVProbeData *pd, int is_opened)
Guess the file format.
const AVInputFormat * av_probe_input_format2(const AVProbeData *pd, int is_opened, int *score_max)
Guess the file format.
int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options)
Read packets of a media file to get stream information.
void avformat_close_input(AVFormatContext **s)
Close an opened input AVFormatContext.
enum AVCodecID av_guess_codec(const AVOutputFormat *fmt, const char *short_name, const char *filename, const char *mime_type, enum AVMediaType type)
Guess the codec ID based upon muxer and filename.
av_warn_unused_result int avformat_init_output(AVFormatContext *s, AVDictionary **options)
Allocate the stream private data and initialize the codec, but do not write the header.
av_warn_unused_result int avformat_write_header(AVFormatContext *s, AVDictionary **options)
Allocate the stream private data and write the stream header to an output media file.
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt)
Write a packet to an output media file ensuring correct interleaving.
int av_interleaved_write_uncoded_frame(AVFormatContext *s, int stream_index, struct AVFrame *frame)
Write an uncoded frame to an output media file.
int av_write_uncoded_frame(AVFormatContext *s, int stream_index, struct AVFrame *frame)
Write an uncoded frame to an output media file.
int av_write_uncoded_frame_query(AVFormatContext *s, int stream_index)
Test whether a muxer supports uncoded frame.
int av_get_output_timestamp(struct AVFormatContext *s, int stream, int64_t *dts, int64_t *wall)
Get timing information for the data currently output.
int av_write_trailer(AVFormatContext *s)
Write the stream trailer to an output media file and free the file private data.
const AVOutputFormat * av_guess_format(const char *short_name, const char *filename, const char *mime_type)
Return the output format in the list of registered output formats which best matches the provided par...
int av_write_frame(AVFormatContext *s, AVPacket *pkt)
Write a packet to an output media file.
int av_get_frame_filename2(char *buf, int buf_size, const char *path, int number, int flags)
Return in 'buf' the path with 'd' replaced by a number.
unsigned int av_codec_get_tag(const struct AVCodecTag *const *tags, enum AVCodecID id)
Get the codec tag for the given codec id id.
enum AVCodecID av_codec_get_id(const struct AVCodecTag *const *tags, unsigned int tag)
Get the AVCodecID for the given codec tag tag.
int avformat_index_get_entries_count(const AVStream *st)
Get the index entry count for the given AVStream.
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp, int size, int distance, int flags)
Add an index entry into a sorted list.
void av_pkt_dump2(FILE *f, const AVPacket *pkt, int dump_payload, const AVStream *st)
Send a nice dump of a packet to the specified file stream.
int avformat_queue_attached_pictures(AVFormatContext *s)
void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size)
Send a nice hexadecimal dump of a buffer to the log.
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)
Split a URL string into components.
AVRational av_stream_get_codec_timebase(const AVStream *st)
Get the internal codec timebase from a stream.
const AVIndexEntry * avformat_index_get_entry(AVStream *st, int idx)
Get the AVIndexEntry corresponding to the given index.
AVTimebaseSource
Definition: avformat.h:2822
AVRational av_guess_frame_rate(AVFormatContext *ctx, AVStream *stream, struct AVFrame *frame)
Guess the frame rate, based on both the container and codec information.
int avformat_match_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec)
Check if the stream st contained in s is matched by the stream specifier spec.
int av_match_ext(const char *filename, const char *extensions)
Return a positive value if the given filename has one of the given extensions, 0 otherwise.
int av_get_frame_filename(char *buf, int buf_size, const char *path, int number)
int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size)
Generate an SDP for an RTP session.
int avformat_query_codec(const AVOutputFormat *ofmt, enum AVCodecID codec_id, int std_compliance)
Test if the given container can store a codec.
void av_pkt_dump_log2(void *avcl, int level, const AVPacket *pkt, int dump_payload, const AVStream *st)
Send a nice dump of a packet to the log.
int av_find_default_stream_index(AVFormatContext *s)
const AVIndexEntry * avformat_index_get_entry_from_timestamp(AVStream *st, int64_t wanted_timestamp, int flags)
Get the AVIndexEntry corresponding to the given timestamp.
void av_hex_dump(FILE *f, const uint8_t *buf, int size)
Send a nice hexadecimal dump of a buffer to the specified file stream.
int av_codec_get_tag2(const struct AVCodecTag *const *tags, enum AVCodecID id, unsigned int *tag)
Get the codec tag for the given codec id.
int av_filename_number_test(const char *filename)
Check whether filename actually is a numbered sequence generator.
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags)
Get the index for a specific timestamp.
void av_dump_format(AVFormatContext *ic, int index, const char *url, int is_output)
Print detailed information about the input or output format, such as duration, bitrate,...
int avformat_transfer_internal_stream_timing_info(const AVOutputFormat *ofmt, AVStream *ost, const AVStream *ist, enum AVTimebaseSource copy_tb)
Transfer internal timing information from one stream to another.
AVRational av_guess_sample_aspect_ratio(AVFormatContext *format, AVStream *stream, struct AVFrame *frame)
Guess the sample aspect ratio of a frame, based on both the stream and the frame aspect ratio.
@ AVFMT_TBCF_DEMUXER
Definition: avformat.h:2825
@ AVFMT_TBCF_R_FRAMERATE
Definition: avformat.h:2827
@ AVFMT_TBCF_AUTO
Definition: avformat.h:2823
@ AVFMT_TBCF_DECODER
Definition: avformat.h:2824
struct AVDictionary AVDictionary
Definition: dict.h:94
AVMediaType
Definition: avutil.h:199
const struct AVCodecTag * avformat_get_mov_audio_tags(void)
const struct AVCodecTag * avformat_get_riff_audio_tags(void)
const struct AVCodecTag * avformat_get_mov_video_tags(void)
const struct AVCodecTag * avformat_get_riff_video_tags(void)
Libavformat version macros.
Libavformat version macros.
int64_t id
unique ID to identify the chapter
Definition: avformat.h:1075
int64_t start
Definition: avformat.h:1077
AVDictionary * metadata
Definition: avformat.h:1078
int64_t end
chapter start/end time in time_base units
Definition: avformat.h:1077
AVRational time_base
time base in which the start/end timestamps are specified
Definition: avformat.h:1076
Describe the class of an AVClass context structure.
Definition: log.h:66
This struct describes the properties of an encoded stream.
Definition: codec_par.h:47
AVCodec.
Definition: codec.h:187
List of devices.
Definition: avdevice.h:343
Format I/O context.
Definition: avformat.h:1115
int64_t max_interleave_delta
Maximum buffering duration for interleaving.
Definition: avformat.h:1405
int event_flags
Flags indicating events happening on the file, a combination of AVFMT_EVENT_FLAG_*.
Definition: avformat.h:1424
int avoid_negative_ts
Avoid negative timestamps during muxing.
Definition: avformat.h:1446
unsigned int packet_size
Definition: avformat.h:1226
unsigned int nb_streams
Number of elements in AVFormatContext.streams.
Definition: avformat.h:1171
const AVClass * av_class
A class for logging and AVOptions.
Definition: avformat.h:1120
int max_streams
The maximum number of streams.
Definition: avformat.h:1699
int(* io_close2)(struct AVFormatContext *s, AVIOContext *pb)
A callback for closing the streams opened with AVFormatContext.io_open().
Definition: avformat.h:1726
const uint8_t * key
Definition: avformat.h:1279
enum AVCodecID audio_codec_id
Forced audio codec_id.
Definition: avformat.h:1295
AVIOContext * pb
I/O context.
Definition: avformat.h:1157
int flush_packets
Flush the I/O context after each packet.
Definition: avformat.h:1531
enum AVCodecID data_codec_id
Forced Data codec_id.
Definition: avformat.h:1645
int64_t start_time
Position of the first frame of the component, in AV_TIME_BASE fractional seconds.
Definition: avformat.h:1207
const struct AVCodec * data_codec
Forced data codec.
Definition: avformat.h:1607
AVDictionary * metadata
Metadata that applies to the whole file.
Definition: avformat.h:1343
int flags
Flags modifying the (de)muxer behaviour.
Definition: avformat.h:1233
const struct AVOutputFormat * oformat
The output container format.
Definition: avformat.h:1134
int max_chunk_size
Max chunk size in bytes Note, not all formats support this and unpredictable things may happen if it ...
Definition: avformat.h:1480
int seek2any
Force seeking to any (also non key) frames.
Definition: avformat.h:1524
int io_repositioned
IO repositioned flag.
Definition: avformat.h:1575
AVProgram ** programs
Definition: avformat.h:1283
int64_t max_analyze_duration
Maximum duration (in AV_TIME_BASE units) of the data read from input in avformat_find_stream_info().
Definition: avformat.h:1277
int ctx_flags
Flags signalling stream properties.
Definition: avformat.h:1164
int strict_std_compliance
Allow non-standard and experimental extension.
Definition: avformat.h:1411
int fps_probe_size
The number of frames used for determining the framerate in avformat_find_stream_info().
Definition: avformat.h:1363
const struct AVCodec * audio_codec
Forced audio codec.
Definition: avformat.h:1591
unsigned int nb_programs
Definition: avformat.h:1282
AVIOInterruptCB interrupt_callback
Custom interrupt callbacks for the I/O layer.
Definition: avformat.h:1381
int ts_id
Transport stream id.
Definition: avformat.h:1456
int avio_flags
avio flags, used to force AVIO_FLAG_DIRECT.
Definition: avformat.h:1495
char * url
input or output URL.
Definition: avformat.h:1198
int probe_score
format probing score.
Definition: avformat.h:1540
const struct AVInputFormat * iformat
The input container format.
Definition: avformat.h:1127
unsigned int nb_chapters
Number of chapters in AVChapter array.
Definition: avformat.h:1332
int metadata_header_padding
Number of bytes to be written as padding in a metadata header.
Definition: avformat.h:1614
int64_t output_ts_offset
Output timestamp offset, in microseconds.
Definition: avformat.h:1631
void * opaque
User data.
Definition: avformat.h:1620
int format_probesize
Maximum number of bytes read from input in order to identify the input format.
Definition: avformat.h:1551
int use_wallclock_as_timestamps
forces the use of wallclock timestamps as pts/dts of packets This has undefined results in the presen...
Definition: avformat.h:1488
enum AVDurationEstimationMethod duration_estimation_method
The duration field can be estimated through various ways, and this field can be used to know how the ...
Definition: avformat.h:1503
int64_t bit_rate
Total stream bitrate in bit/s, 0 if not available.
Definition: avformat.h:1224
char * codec_whitelist
',' separated list of allowed decoders.
Definition: avformat.h:1559
int64_t start_time_realtime
Start time of the stream in real world time, in microseconds since the Unix epoch (00:00 1st January ...
Definition: avformat.h:1356
attribute_deprecated void(* io_close)(struct AVFormatContext *s, AVIOContext *pb)
A callback for closing the streams opened with AVFormatContext.io_open().
Definition: avformat.h:1684
unsigned int max_index_size
Maximum amount of memory in bytes to use for the index of each stream.
Definition: avformat.h:1313
enum AVCodecID video_codec_id
Forced video codec_id.
Definition: avformat.h:1289
int debug
Flags to enable debugging.
Definition: avformat.h:1386
av_format_control_message control_message_cb
Callback used by devices to communicate with application.
Definition: avformat.h:1625
char * format_whitelist
',' separated list of allowed demuxers.
Definition: avformat.h:1567
int audio_preload
Audio preload in microseconds.
Definition: avformat.h:1464
AVChapter ** chapters
Definition: avformat.h:1333
void * priv_data
Format private data.
Definition: avformat.h:1143
int64_t probesize
Maximum number of bytes read from input in order to determine stream properties.
Definition: avformat.h:1269
enum AVCodecID subtitle_codec_id
Forced subtitle codec_id.
Definition: avformat.h:1301
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1183
int64_t duration
Duration of the stream, in AV_TIME_BASE fractional seconds.
Definition: avformat.h:1217
int max_ts_probe
Maximum number of packets to read while waiting for the first timestamp.
Definition: avformat.h:1437
int64_t skip_initial_bytes
Skip initial bytes when opening stream.
Definition: avformat.h:1510
const struct AVCodec * subtitle_codec
Forced subtitle codec.
Definition: avformat.h:1599
char * protocol_whitelist
',' separated list of allowed protocols.
Definition: avformat.h:1652
char * protocol_blacklist
',' separated list of disallowed protocols.
Definition: avformat.h:1692
unsigned int max_picture_buffer
Maximum amount of memory in bytes to use for buffering frames obtained from realtime capture devices.
Definition: avformat.h:1319
int max_chunk_duration
Max chunk time in microseconds.
Definition: avformat.h:1472
const struct AVCodec * video_codec
Forced video codec.
Definition: avformat.h:1583
int skip_estimate_duration_from_pts
Skip duration calcuation in estimate_timings_from_pts.
Definition: avformat.h:1706
int error_recognition
Error recognition; higher values will detect more errors but may misdetect some more or less valid pa...
Definition: avformat.h:1370
int(* io_open)(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags, AVDictionary **options)
A callback for opening new IO streams.
Definition: avformat.h:1674
int max_probe_packets
Maximum number of packets that can be probed.
Definition: avformat.h:1713
unsigned int correct_ts_overflow
Correct single timestamp overflows.
Definition: avformat.h:1517
uint8_t * dump_separator
dump format separator.
Definition: avformat.h:1639
This structure describes decoded (raw) audio or video data.
Definition: frame.h:340
Bytestream IO Context.
Definition: avio.h:166
Callback for checking whether to abort blocking functions.
Definition: avio.h:59
int64_t pos
Definition: avformat.h:701
int min_distance
Minimum distance between this and the previous keyframe, used to avoid unneeded searching.
Definition: avformat.h:712
int64_t timestamp
Timestamp in AVStream.time_base units, preferably the time from which on correctly decoded frames are...
Definition: avformat.h:702
int(* read_seek)(struct AVFormatContext *, int stream_index, int64_t timestamp, int flags)
Seek to a given timestamp relative to the frames in stream component stream_index.
Definition: avformat.h:648
int priv_data_size
Size of private data so that it can be allocated in the wrapper.
Definition: avformat.h:603
int flags
Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS, AVFMT_NOTIMESTAMPS,...
Definition: avformat.h:568
const char * long_name
Descriptive name for the format, meant to be more human-readable than name.
Definition: avformat.h:561
int(* read_header)(struct AVFormatContext *)
Read the format header and initialize the AVFormatContext structure.
Definition: avformat.h:622
int(* read_play)(struct AVFormatContext *)
Start/resume playing - only meaningful if using a network-based format (RTSP).
Definition: avformat.h:662
int(* read_pause)(struct AVFormatContext *)
Pause playing - only meaningful if using a network-based format (RTSP).
Definition: avformat.h:668
int(* read_close)(struct AVFormatContext *)
Close the stream.
Definition: avformat.h:638
int flags_internal
Internal flags.
Definition: avformat.h:608
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:554
const struct AVCodecTag *const * codec_tag
Definition: avformat.h:577
int(* get_device_list)(struct AVFormatContext *s, struct AVDeviceInfoList *device_list)
Returns device list with it properties.
Definition: avformat.h:682
const char * mime_type
Comma-separated list of mime types.
Definition: avformat.h:586
int64_t(* read_timestamp)(struct AVFormatContext *s, int stream_index, int64_t *pos, int64_t pos_limit)
Get the next timestamp in stream[stream_index].time_base units.
Definition: avformat.h:655
int(* read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags)
Seek to timestamp ts.
Definition: avformat.h:676
int raw_codec_id
Raw demuxers store their codec ID here.
Definition: avformat.h:598
const char * extensions
If extensions are defined, then no probe is done.
Definition: avformat.h:575
int(* read_probe)(const AVProbeData *)
Tell if a given file has a chance of being parsed as this format.
Definition: avformat.h:615
int(* read_packet)(struct AVFormatContext *, AVPacket *pkt)
Read one packet and put it in 'pkt'.
Definition: avformat.h:632
const AVClass * priv_class
AVClass for the private context.
Definition: avformat.h:579
const char * extensions
comma-separated filename extensions
Definition: avformat.h:519
enum AVCodecID video_codec
default video codec
Definition: avformat.h:522
enum AVCodecID audio_codec
default audio codec
Definition: avformat.h:521
const char * long_name
Descriptive name for the format, meant to be more human-readable than name.
Definition: avformat.h:517
int flags
can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS,...
Definition: avformat.h:530
const char * name
Definition: avformat.h:511
const struct AVCodecTag *const * codec_tag
List of supported codec_id-codec_tag pairs, ordered by "better choice first".
Definition: avformat.h:536
const char * mime_type
Definition: avformat.h:518
enum AVCodecID subtitle_codec
default subtitle codec
Definition: avformat.h:523
const AVClass * priv_class
AVClass for the private context.
Definition: avformat.h:539
This structure stores auxiliary information for decoding, presenting, or otherwise processing the cod...
Definition: packet.h:342
This structure stores compressed data.
Definition: packet.h:468
This structure contains the data a format has to probe a file.
Definition: avformat.h:452
const char * filename
Definition: avformat.h:453
const char * mime_type
mime_type, when known.
Definition: avformat.h:456
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:455
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:454
New fields can be added to the end with minor version bumps.
Definition: avformat.h:1039
int pmt_pid
Definition: avformat.h:1048
unsigned int nb_stream_indexes
Definition: avformat.h:1044
int64_t start_time
Definition: avformat.h:1059
int program_num
Definition: avformat.h:1047
int64_t end_time
Definition: avformat.h:1060
unsigned int * stream_index
Definition: avformat.h:1043
int pcr_pid
Definition: avformat.h:1049
int64_t pts_wrap_reference
reference dts for wrap detection
Definition: avformat.h:1062
int flags
Definition: avformat.h:1041
enum AVDiscard discard
selects which program to discard and which to feed to the caller
Definition: avformat.h:1042
int pts_wrap_behavior
behavior on wrap detection
Definition: avformat.h:1063
int pmt_version
Definition: avformat.h:1050
AVDictionary * metadata
Definition: avformat.h:1045
Rational number (pair of numerator and denominator).
Definition: rational.h:58
Stream structure.
Definition: avformat.h:841
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:864
attribute_deprecated AVPacketSideData * side_data
An array of side data that applies to the whole stream (i.e.
Definition: avformat.h:962
AVRational sample_aspect_ratio
sample aspect ratio (0 if unknown)
Definition: avformat.h:919
int64_t nb_frames
number of frames in this stream if known or 0
Definition: avformat.h:902
const AVClass * av_class
A class for AVOptions.
Definition: avformat.h:845
enum AVDiscard discard
Selects which packets can be discarded at will and do not need to be demuxed.
Definition: avformat.h:912
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:900
AVDictionary * metadata
Definition: avformat.h:921
void * priv_data
Definition: avformat.h:866
int id
Format-specific stream ID.
Definition: avformat.h:853
int index
stream index in AVFormatContext
Definition: avformat.h:847
int pts_wrap_bits
Number of bits in timestamps.
Definition: avformat.h:1016
attribute_deprecated int nb_side_data
The number of elements in the AVStream.side_data array.
Definition: avformat.h:970
int64_t start_time
Decoding: pts of the first frame of the stream in presentation order, in stream time base.
Definition: avformat.h:890
AVPacket attached_pic
For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet will contain the attached pictu...
Definition: avformat.h:939
AVRational avg_frame_rate
Average framerate.
Definition: avformat.h:930
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented.
Definition: avformat.h:880
int event_flags
Flags indicating events happening on the stream, a combination of AVSTREAM_EVENT_FLAG_*.
Definition: avformat.h:984
AVRational r_frame_rate
Real base framerate of the stream.
Definition: avformat.h:1007
int disposition
Stream disposition - a combination of AV_DISPOSITION_* flags.
Definition: avformat.h:910
static AVStream * ost