FFmpeg
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 <time.h>
311 #include <stdio.h> /* FILE */
312 #include "libavcodec/avcodec.h"
313 #include "libavutil/dict.h"
314 #include "libavutil/log.h"
315 
316 #include "avio.h"
317 #include "libavformat/version.h"
318 
319 struct AVFormatContext;
320 
321 struct AVDeviceInfoList;
323 
324 /**
325  * @defgroup metadata_api Public Metadata API
326  * @{
327  * @ingroup libavf
328  * The metadata API allows libavformat to export metadata tags to a client
329  * application when demuxing. Conversely it allows a client application to
330  * set metadata when muxing.
331  *
332  * Metadata is exported or set as pairs of key/value strings in the 'metadata'
333  * fields of the AVFormatContext, AVStream, AVChapter and AVProgram structs
334  * using the @ref lavu_dict "AVDictionary" API. Like all strings in FFmpeg,
335  * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata
336  * exported by demuxers isn't checked to be valid UTF-8 in most cases.
337  *
338  * Important concepts to keep in mind:
339  * - Keys are unique; there can never be 2 tags with the same key. This is
340  * also meant semantically, i.e., a demuxer should not knowingly produce
341  * several keys that are literally different but semantically identical.
342  * E.g., key=Author5, key=Author6. In this example, all authors must be
343  * placed in the same tag.
344  * - Metadata is flat, not hierarchical; there are no subtags. If you
345  * want to store, e.g., the email address of the child of producer Alice
346  * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
347  * - Several modifiers can be applied to the tag name. This is done by
348  * appending a dash character ('-') and the modifier name in the order
349  * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
350  * - language -- a tag whose value is localized for a particular language
351  * is appended with the ISO 639-2/B 3-letter language code.
352  * For example: Author-ger=Michael, Author-eng=Mike
353  * The original/default language is in the unqualified "Author" tag.
354  * A demuxer should set a default if it sets any translated tag.
355  * - sorting -- a modified version of a tag that should be used for
356  * sorting will have '-sort' appended. E.g. artist="The Beatles",
357  * artist-sort="Beatles, The".
358  * - Some protocols and demuxers support metadata updates. After a successful
359  * call to av_read_packet(), AVFormatContext.event_flags or AVStream.event_flags
360  * will be updated to indicate if metadata changed. In order to detect metadata
361  * changes on a stream, you need to loop through all streams in the AVFormatContext
362  * and check their individual event_flags.
363  *
364  * - Demuxers attempt to export metadata in a generic format, however tags
365  * with no generic equivalents are left as they are stored in the container.
366  * Follows a list of generic tag names:
367  *
368  @verbatim
369  album -- name of the set this work belongs to
370  album_artist -- main creator of the set/album, if different from artist.
371  e.g. "Various Artists" for compilation albums.
372  artist -- main creator of the work
373  comment -- any additional description of the file.
374  composer -- who composed the work, if different from artist.
375  copyright -- name of copyright holder.
376  creation_time-- date when the file was created, preferably in ISO 8601.
377  date -- date when the work was created, preferably in ISO 8601.
378  disc -- number of a subset, e.g. disc in a multi-disc collection.
379  encoder -- name/settings of the software/hardware that produced the file.
380  encoded_by -- person/group who created the file.
381  filename -- original name of the file.
382  genre -- <self-evident>.
383  language -- main language in which the work is performed, preferably
384  in ISO 639-2 format. Multiple languages can be specified by
385  separating them with commas.
386  performer -- artist who performed the work, if different from artist.
387  E.g for "Also sprach Zarathustra", artist would be "Richard
388  Strauss" and performer "London Philharmonic Orchestra".
389  publisher -- name of the label/publisher.
390  service_name -- name of the service in broadcasting (channel name).
391  service_provider -- name of the service provider in broadcasting.
392  title -- name of the work.
393  track -- number of this work in the set, can be in form current/total.
394  variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
395  @endverbatim
396  *
397  * Look in the examples section for an application example how to use the Metadata API.
398  *
399  * @}
400  */
401 
402 /* packet functions */
403 
404 
405 /**
406  * Allocate and read the payload of a packet and initialize its
407  * fields with default values.
408  *
409  * @param s associated IO context
410  * @param pkt packet
411  * @param size desired payload size
412  * @return >0 (read size) if OK, AVERROR_xxx otherwise
413  */
415 
416 
417 /**
418  * Read data and append it to the current content of the AVPacket.
419  * If pkt->size is 0 this is identical to av_get_packet.
420  * Note that this uses av_grow_packet and thus involves a realloc
421  * which is inefficient. Thus this function should only be used
422  * when there is no reasonable way to know (an upper bound of)
423  * the final size.
424  *
425  * @param s associated IO context
426  * @param pkt packet
427  * @param size amount of data to read
428  * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
429  * will not be lost even if an error occurs.
430  */
432 
433 /*************************************************/
434 /* input/output formats */
435 
436 struct AVCodecTag;
437 
438 /**
439  * This structure contains the data a format has to probe a file.
440  */
441 typedef struct AVProbeData {
442  const char *filename;
443  unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
444  int buf_size; /**< Size of buf except extra allocated bytes */
445  const char *mime_type; /**< mime_type, when known. */
446 } AVProbeData;
447 
448 #define AVPROBE_SCORE_RETRY (AVPROBE_SCORE_MAX/4)
449 #define AVPROBE_SCORE_STREAM_RETRY (AVPROBE_SCORE_MAX/4-1)
450 
451 #define AVPROBE_SCORE_EXTENSION 50 ///< score for file extension
452 #define AVPROBE_SCORE_MIME 75 ///< score for file mime type
453 #define AVPROBE_SCORE_MAX 100 ///< maximum score
454 
455 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
456 
457 /// Demuxer will use avio_open, no opened file should be provided by the caller.
458 #define AVFMT_NOFILE 0x0001
459 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
460 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
461 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
462 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
463 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
464 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
465 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
466 #define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
467 #define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */
468 #define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fall back on binary search via read_timestamp */
469 #define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fall back on generic search */
470 #define AVFMT_NO_BYTE_SEEK 0x8000 /**< Format does not allow seeking by bytes */
471 #define AVFMT_ALLOW_FLUSH 0x10000 /**< Format allows flushing. If not set, the muxer will not receive a NULL packet in the write_packet function. */
472 #define AVFMT_TS_NONSTRICT 0x20000 /**< Format does not require strictly
473  increasing timestamps, but they must
474  still be monotonic */
475 #define AVFMT_TS_NEGATIVE 0x40000 /**< Format allows muxing negative
476  timestamps. If not set the timestamp
477  will be shifted in av_write_frame and
478  av_interleaved_write_frame so they
479  start from 0.
480  The user or muxer can override this through
481  AVFormatContext.avoid_negative_ts
482  */
483 
484 #define AVFMT_SEEK_TO_PTS 0x4000000 /**< Seeking is based on PTS */
485 
486 /**
487  * @addtogroup lavf_encoding
488  * @{
489  */
490 typedef struct AVOutputFormat {
491  const char *name;
492  /**
493  * Descriptive name for the format, meant to be more human-readable
494  * than name. You should use the NULL_IF_CONFIG_SMALL() macro
495  * to define it.
496  */
497  const char *long_name;
498  const char *mime_type;
499  const char *extensions; /**< comma-separated filename extensions */
500  /* output support */
501  enum AVCodecID audio_codec; /**< default audio codec */
502  enum AVCodecID video_codec; /**< default video codec */
503  enum AVCodecID subtitle_codec; /**< default subtitle codec */
504  /**
505  * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER,
506  * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
507  * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS, AVFMT_ALLOW_FLUSH,
508  * AVFMT_TS_NONSTRICT, AVFMT_TS_NEGATIVE
509  */
510  int flags;
512  /**
513  * List of supported codec_id-codec_tag pairs, ordered by "better
514  * choice first". The arrays are all terminated by AV_CODEC_ID_NONE.
515  */
516  const struct AVCodecTag * const *codec_tag;
517 
518 
519  const AVClass *priv_class; ///< AVClass for the private context
520 
521  /*****************************************************************
522  * No fields below this line are part of the public API. They
523  * may not be used outside of libavformat and can be changed and
524  * removed at will.
525  * New public fields should be added right above.
526  *****************************************************************
527  */
528  /**
529  * The ff_const59 define is not part of the public API and will
530  * be removed without further warning.
531  */
532 #if FF_API_AVIOFORMAT
533 #define ff_const59
534 #else
535 #define ff_const59 const
536 #endif
538  /**
539  * size of private data so that it can be allocated in the wrapper
540  */
541  int priv_data_size;
542 
543  int (*write_header)(struct AVFormatContext *);
544  /**
545  * Write a packet. If AVFMT_ALLOW_FLUSH is set in flags,
546  * pkt can be NULL in order to flush data buffered in the muxer.
547  * When flushing, return 0 if there still is more data to flush,
548  * or 1 if everything was flushed and there is no more buffered
549  * data.
550  */
553  /**
554  * A format-specific function for interleavement.
555  * If unset, packets will be interleaved by dts.
556  */
558  AVPacket *in, int flush);
559  /**
560  * Test if the given codec can be stored in this container.
561  *
562  * @return 1 if the codec is supported, 0 if it is not.
563  * A negative number if unknown.
564  * MKTAG('A', 'P', 'I', 'C') if the codec is only supported as AV_DISPOSITION_ATTACHED_PIC
565  */
566  int (*query_codec)(enum AVCodecID id, int std_compliance);
567 
568  void (*get_output_timestamp)(struct AVFormatContext *s, int stream,
569  int64_t *dts, int64_t *wall);
570  /**
571  * Allows sending messages from application to device.
572  */
573  int (*control_message)(struct AVFormatContext *s, int type,
574  void *data, size_t data_size);
576  /**
577  * Write an uncoded AVFrame.
578  *
579  * See av_write_uncoded_frame() for details.
580  *
581  * The library will free *frame afterwards, but the muxer can prevent it
582  * by setting the pointer to NULL.
583  */
584  int (*write_uncoded_frame)(struct AVFormatContext *, int stream_index,
585  AVFrame **frame, unsigned flags);
586  /**
587  * Returns device list with it properties.
588  * @see avdevice_list_devices() for more details.
589  */
590  int (*get_device_list)(struct AVFormatContext *s, struct AVDeviceInfoList *device_list);
591  /**
592  * Initialize device capabilities submodule.
593  * @see avdevice_capabilities_create() for more details.
594  */
595  int (*create_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps);
596  /**
597  * Free device capabilities submodule.
598  * @see avdevice_capabilities_free() for more details.
599  */
600  int (*free_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps);
601  enum AVCodecID data_codec; /**< default data codec */
602  /**
603  * Initialize format. May allocate data here, and set any AVFormatContext or
604  * AVStream parameters that need to be set before packets are sent.
605  * This method must not write output.
606  *
607  * Return 0 if streams were fully configured, 1 if not, negative AVERROR on failure
608  *
609  * Any allocations made here must be freed in deinit().
610  */
611  int (*init)(struct AVFormatContext *);
612  /**
613  * Deinitialize format. If present, this is called whenever the muxer is being
614  * destroyed, regardless of whether or not the header has been written.
615  *
616  * If a trailer is being written, this is called after write_trailer().
617  *
618  * This is called if init() fails as well.
619  */
620  void (*deinit)(struct AVFormatContext *);
621  /**
622  * Set up any necessary bitstream filtering and extract any extra data needed
623  * for the global header.
624  * Return 0 if more packets from this stream must be checked; 1 if not.
625  */
626  int (*check_bitstream)(struct AVFormatContext *, const AVPacket *pkt);
628 /**
629  * @}
630  */
631 
632 /**
633  * @addtogroup lavf_decoding
634  * @{
635  */
636 typedef struct AVInputFormat {
637  /**
638  * A comma separated list of short names for the format. New names
639  * may be appended with a minor bump.
640  */
641  const char *name;
642 
643  /**
644  * Descriptive name for the format, meant to be more human-readable
645  * than name. You should use the NULL_IF_CONFIG_SMALL() macro
646  * to define it.
647  */
648  const char *long_name;
649 
650  /**
651  * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
652  * AVFMT_NOTIMESTAMPS, AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
653  * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK, AVFMT_SEEK_TO_PTS.
654  */
655  int flags;
656 
657  /**
658  * If extensions are defined, then no probe is done. You should
659  * usually not use extension format guessing because it is not
660  * reliable enough
661  */
662  const char *extensions;
663 
664  const struct AVCodecTag * const *codec_tag;
665 
666  const AVClass *priv_class; ///< AVClass for the private context
667 
668  /**
669  * Comma-separated list of mime types.
670  * It is used check for matching mime types while probing.
671  * @see av_probe_input_format2
672  */
673  const char *mime_type;
674 
675  /*****************************************************************
676  * No fields below this line are part of the public API. They
677  * may not be used outside of libavformat and can be changed and
678  * removed at will.
679  * New public fields should be added right above.
680  *****************************************************************
681  */
683 
684  /**
685  * Raw demuxers store their codec ID here.
686  */
687  int raw_codec_id;
688 
689  /**
690  * Size of private data so that it can be allocated in the wrapper.
691  */
692  int priv_data_size;
693 
694  /**
695  * Tell if a given file has a chance of being parsed as this format.
696  * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
697  * big so you do not have to check for that unless you need more.
698  */
699  int (*read_probe)(const AVProbeData *);
700 
701  /**
702  * Read the format header and initialize the AVFormatContext
703  * structure. Return 0 if OK. 'avformat_new_stream' should be
704  * called to create new streams.
705  */
706  int (*read_header)(struct AVFormatContext *);
707 
708  /**
709  * Read one packet and put it in 'pkt'. pts and flags are also
710  * set. 'avformat_new_stream' can be called only if the flag
711  * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
712  * background thread).
713  * @return 0 on success, < 0 on error.
714  * Upon returning an error, pkt must be unreferenced by the caller.
715  */
716  int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
717 
718  /**
719  * Close the stream. The AVFormatContext and AVStreams are not
720  * freed by this function
721  */
722  int (*read_close)(struct AVFormatContext *);
723 
724  /**
725  * Seek to a given timestamp relative to the frames in
726  * stream component stream_index.
727  * @param stream_index Must not be -1.
728  * @param flags Selects which direction should be preferred if no exact
729  * match is available.
730  * @return >= 0 on success (but not necessarily the new offset)
731  */
732  int (*read_seek)(struct AVFormatContext *,
733  int stream_index, int64_t timestamp, int flags);
734 
735  /**
736  * Get the next timestamp in stream[stream_index].time_base units.
737  * @return the timestamp or AV_NOPTS_VALUE if an error occurred
738  */
739  int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
740  int64_t *pos, int64_t pos_limit);
742  /**
743  * Start/resume playing - only meaningful if using a network-based format
744  * (RTSP).
745  */
746  int (*read_play)(struct AVFormatContext *);
747 
748  /**
749  * Pause playing - only meaningful if using a network-based format
750  * (RTSP).
751  */
752  int (*read_pause)(struct AVFormatContext *);
753 
754  /**
755  * Seek to timestamp ts.
756  * Seeking will be done so that the point from which all active streams
757  * can be presented successfully will be closest to ts and within min/max_ts.
758  * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
759  */
760  int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
762  /**
763  * Returns device list with it properties.
764  * @see avdevice_list_devices() for more details.
765  */
766  int (*get_device_list)(struct AVFormatContext *s, struct AVDeviceInfoList *device_list);
767 
768  /**
769  * Initialize device capabilities submodule.
770  * @see avdevice_capabilities_create() for more details.
771  */
772  int (*create_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps);
773 
774  /**
775  * Free device capabilities submodule.
776  * @see avdevice_capabilities_free() for more details.
777  */
778  int (*free_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps);
779 } AVInputFormat;
780 /**
781  * @}
782  */
783 
784 enum AVStreamParseType {
786  AVSTREAM_PARSE_FULL, /**< full parsing and repack */
787  AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
788  AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
789  AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
790  AVSTREAM_PARSE_FULL_RAW, /**< full parsing and repack with timestamp and position generation by parser for raw
791  this assumes that each packet in the file contains no demuxer level headers and
792  just codec level data, otherwise position generation would fail */
793 };
795 typedef struct AVIndexEntry {
796  int64_t pos;
797  int64_t timestamp; /**<
798  * Timestamp in AVStream.time_base units, preferably the time from which on correctly decoded frames are available
799  * when seeking to this entry. That means preferable PTS on keyframe based formats.
800  * But demuxers can choose to store a different timestamp, if it is more convenient for the implementation or nothing better
801  * is known
802  */
803 #define AVINDEX_KEYFRAME 0x0001
804 #define AVINDEX_DISCARD_FRAME 0x0002 /**
805  * Flag is used to indicate which frame should be discarded after decoding.
806  */
807  int flags:2;
808  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).
809  int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
810 } AVIndexEntry;
811 
812 #define AV_DISPOSITION_DEFAULT 0x0001
813 #define AV_DISPOSITION_DUB 0x0002
814 #define AV_DISPOSITION_ORIGINAL 0x0004
815 #define AV_DISPOSITION_COMMENT 0x0008
816 #define AV_DISPOSITION_LYRICS 0x0010
817 #define AV_DISPOSITION_KARAOKE 0x0020
819 /**
820  * Track should be used during playback by default.
821  * Useful for subtitle track that should be displayed
822  * even when user did not explicitly ask for subtitles.
823  */
824 #define AV_DISPOSITION_FORCED 0x0040
825 #define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */
826 #define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */
827 #define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */
828 /**
829  * The stream is stored in the file as an attached picture/"cover art" (e.g.
830  * APIC frame in ID3v2). The first (usually only) packet associated with it
831  * will be returned among the first few packets read from the file unless
832  * seeking takes place. It can also be accessed at any time in
833  * AVStream.attached_pic.
834  */
835 #define AV_DISPOSITION_ATTACHED_PIC 0x0400
836 /**
837  * The stream is sparse, and contains thumbnail images, often corresponding
838  * to chapter markers. Only ever used with AV_DISPOSITION_ATTACHED_PIC.
839  */
840 #define AV_DISPOSITION_TIMED_THUMBNAILS 0x0800
841 
842 typedef struct AVStreamInternal AVStreamInternal;
843 
844 /**
845  * To specify text track kind (different from subtitles default).
846  */
847 #define AV_DISPOSITION_CAPTIONS 0x10000
848 #define AV_DISPOSITION_DESCRIPTIONS 0x20000
849 #define AV_DISPOSITION_METADATA 0x40000
850 #define AV_DISPOSITION_DEPENDENT 0x80000 ///< dependent audio stream (mix_type=0 in mpegts)
851 #define AV_DISPOSITION_STILL_IMAGE 0x100000 ///< still images in video stream (still_picture_flag=1 in mpegts)
852 
853 /**
854  * Options for behavior on timestamp wrap detection.
855  */
856 #define AV_PTS_WRAP_IGNORE 0 ///< ignore the wrap
857 #define AV_PTS_WRAP_ADD_OFFSET 1 ///< add the format specific offset on wrap detection
858 #define AV_PTS_WRAP_SUB_OFFSET -1 ///< subtract the format specific offset on wrap detection
860 /**
861  * Stream structure.
862  * New fields can be added to the end with minor version bumps.
863  * Removal, reordering and changes to existing fields require a major
864  * version bump.
865  * sizeof(AVStream) must not be used outside libav*.
866  */
867 typedef struct AVStream {
868  int index; /**< stream index in AVFormatContext */
869  /**
870  * Format-specific stream ID.
871  * decoding: set by libavformat
872  * encoding: set by the user, replaced by libavformat if left unset
873  */
874  int id;
875 #if FF_API_LAVF_AVCTX
876  /**
877  * @deprecated use the codecpar struct instead
878  */
880  AVCodecContext *codec;
881 #endif
882  void *priv_data;
884  /**
885  * This is the fundamental unit of time (in seconds) in terms
886  * of which frame timestamps are represented.
887  *
888  * decoding: set by libavformat
889  * encoding: May be set by the caller before avformat_write_header() to
890  * provide a hint to the muxer about the desired timebase. In
891  * avformat_write_header(), the muxer will overwrite this field
892  * with the timebase that will actually be used for the timestamps
893  * written into the file (which may or may not be related to the
894  * user-provided one, depending on the format).
895  */
896  AVRational time_base;
897 
898  /**
899  * Decoding: pts of the first frame of the stream in presentation order, in stream time base.
900  * Only set this if you are absolutely 100% sure that the value you set
901  * it to really is the pts of the first frame.
902  * This may be undefined (AV_NOPTS_VALUE).
903  * @note The ASF header does NOT contain a correct start_time the ASF
904  * demuxer must NOT set this.
905  */
906  int64_t start_time;
907 
908  /**
909  * Decoding: duration of the stream, in stream time base.
910  * If a source file does not specify a duration, but does specify
911  * a bitrate, this value will be estimated from bitrate and file size.
912  *
913  * Encoding: May be set by the caller before avformat_write_header() to
914  * provide a hint to the muxer about the estimated duration.
915  */
916  int64_t duration;
917 
918  int64_t nb_frames; ///< number of frames in this stream if known or 0
919 
920  int disposition; /**< AV_DISPOSITION_* bit field */
921 
922  enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
923 
924  /**
925  * sample aspect ratio (0 if unknown)
926  * - encoding: Set by user.
927  * - decoding: Set by libavformat.
928  */
929  AVRational sample_aspect_ratio;
930 
931  AVDictionary *metadata;
932 
933  /**
934  * Average framerate
935  *
936  * - demuxing: May be set by libavformat when creating the stream or in
937  * avformat_find_stream_info().
938  * - muxing: May be set by the caller before avformat_write_header().
939  */
940  AVRational avg_frame_rate;
941 
942  /**
943  * For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet
944  * will contain the attached picture.
945  *
946  * decoding: set by libavformat, must not be modified by the caller.
947  * encoding: unused
948  */
949  AVPacket attached_pic;
950 
951  /**
952  * An array of side data that applies to the whole stream (i.e. the
953  * container does not allow it to change between packets).
954  *
955  * There may be no overlap between the side data in this array and side data
956  * in the packets. I.e. a given side data is either exported by the muxer
957  * (demuxing) / set by the caller (muxing) in this array, then it never
958  * appears in the packets, or the side data is exported / sent through
959  * the packets (always in the first packet where the value becomes known or
960  * changes), then it does not appear in this array.
961  *
962  * - demuxing: Set by libavformat when the stream is created.
963  * - muxing: May be set by the caller before avformat_write_header().
964  *
965  * Freed by libavformat in avformat_free_context().
966  *
967  * @see av_format_inject_global_side_data()
968  */
969  AVPacketSideData *side_data;
970  /**
971  * The number of elements in the AVStream.side_data array.
972  */
973  int nb_side_data;
974 
975  /**
976  * Flags for the user to detect events happening on the stream. Flags must
977  * be cleared by the user once the event has been handled.
978  * A combination of AVSTREAM_EVENT_FLAG_*.
979  */
980  int event_flags;
981 #define AVSTREAM_EVENT_FLAG_METADATA_UPDATED 0x0001 ///< The call resulted in updated metadata.
983  /**
984  * Real base framerate of the stream.
985  * This is the lowest framerate with which all timestamps can be
986  * represented accurately (it is the least common multiple of all
987  * framerates in the stream). Note, this value is just a guess!
988  * For example, if the time base is 1/90000 and all frames have either
989  * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
990  */
991  AVRational r_frame_rate;
992 
993 #if FF_API_LAVF_FFSERVER
994  /**
995  * String containing pairs of key and values describing recommended encoder configuration.
996  * Pairs are separated by ','.
997  * Keys are separated from values by '='.
998  *
999  * @deprecated unused
1000  */
1002  char *recommended_encoder_configuration;
1003 #endif
1004 
1005  /**
1006  * Codec parameters associated with this stream. Allocated and freed by
1007  * libavformat in avformat_new_stream() and avformat_free_context()
1008  * respectively.
1009  *
1010  * - demuxing: filled by libavformat on stream creation or in
1011  * avformat_find_stream_info()
1012  * - muxing: filled by the caller before avformat_write_header()
1013  */
1014  AVCodecParameters *codecpar;
1015 
1016  /*****************************************************************
1017  * All fields below this line are not part of the public API. They
1018  * may not be used outside of libavformat and can be changed and
1019  * removed at will.
1020  * Internal note: be aware that physically removing these fields
1021  * will break ABI. Replace removed fields with dummy fields, and
1022  * add new fields to AVStreamInternal.
1023  *****************************************************************
1024  */
1025 
1026 #define MAX_STD_TIMEBASES (30*12+30+3+6)
1027  /**
1028  * Stream information used internally by avformat_find_stream_info()
1029  */
1030  struct {
1031  int64_t last_dts;
1032  int64_t duration_gcd;
1033  int duration_count;
1034  int64_t rfps_duration_sum;
1035  double (*duration_error)[2][MAX_STD_TIMEBASES];
1036  int64_t codec_info_duration;
1037  int64_t codec_info_duration_fields;
1038  int frame_delay_evidence;
1039 
1040  /**
1041  * 0 -> decoder has not been searched for yet.
1042  * >0 -> decoder found
1043  * <0 -> decoder with codec_id == -found_decoder has not been found
1044  */
1045  int found_decoder;
1047  int64_t last_duration;
1048 
1049  /**
1050  * Those are used for average framerate estimation.
1051  */
1052  int64_t fps_first_dts;
1053  int fps_first_dts_idx;
1054  int64_t fps_last_dts;
1055  int fps_last_dts_idx;
1057  } *info;
1058 
1059  int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
1060 
1061  // Timestamp generation support:
1062  /**
1063  * Timestamp corresponding to the last dts sync point.
1064  *
1065  * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
1066  * a DTS is received from the underlying container. Otherwise set to
1067  * AV_NOPTS_VALUE by default.
1068  */
1069  int64_t first_dts;
1070  int64_t cur_dts;
1071  int64_t last_IP_pts;
1072  int last_IP_duration;
1073 
1074  /**
1075  * Number of packets to buffer for codec probing
1076  */
1077  int probe_packets;
1079  /**
1080  * Number of frames that have been demuxed during avformat_find_stream_info()
1081  */
1082  int codec_info_nb_frames;
1083 
1084  /* av_read_frame() support */
1085  enum AVStreamParseType need_parsing;
1087 
1088  /**
1089  * last packet in packet_buffer for this stream when muxing.
1090  */
1091  struct AVPacketList *last_in_packet_buffer;
1092  AVProbeData probe_data;
1093 #define MAX_REORDER_DELAY 16
1094  int64_t pts_buffer[MAX_REORDER_DELAY+1];
1096  AVIndexEntry *index_entries; /**< Only used if the format does not
1097  support seeking natively. */
1098  int nb_index_entries;
1099  unsigned int index_entries_allocated_size;
1101  /**
1102  * Stream Identifier
1103  * This is the MPEG-TS stream identifier +1
1104  * 0 means unknown
1105  */
1106  int stream_identifier;
1108  /**
1109  * Details of the MPEG-TS program which created this stream.
1110  */
1111  int program_num;
1112  int pmt_version;
1113  int pmt_stream_idx;
1114 
1115  int64_t interleaver_chunk_size;
1116  int64_t interleaver_chunk_duration;
1117 
1118  /**
1119  * stream probing state
1120  * -1 -> probing finished
1121  * 0 -> no probing requested
1122  * rest -> perform probing with request_probe being the minimum score to accept.
1123  * NOT PART OF PUBLIC API
1124  */
1125  int request_probe;
1126  /**
1127  * Indicates that everything up to the next keyframe
1128  * should be discarded.
1129  */
1130  int skip_to_keyframe;
1131 
1132  /**
1133  * Number of samples to skip at the start of the frame decoded from the next packet.
1134  */
1135  int skip_samples;
1136 
1137  /**
1138  * If not 0, the number of samples that should be skipped from the start of
1139  * the stream (the samples are removed from packets with pts==0, which also
1140  * assumes negative timestamps do not happen).
1141  * Intended for use with formats such as mp3 with ad-hoc gapless audio
1142  * support.
1143  */
1144  int64_t start_skip_samples;
1145 
1146  /**
1147  * If not 0, the first audio sample that should be discarded from the stream.
1148  * This is broken by design (needs global sample count), but can't be
1149  * avoided for broken by design formats such as mp3 with ad-hoc gapless
1150  * audio support.
1151  */
1152  int64_t first_discard_sample;
1154  /**
1155  * The sample after last sample that is intended to be discarded after
1156  * first_discard_sample. Works on frame boundaries only. Used to prevent
1157  * early EOF if the gapless info is broken (considered concatenated mp3s).
1158  */
1159  int64_t last_discard_sample;
1160 
1161  /**
1162  * Number of internally decoded frames, used internally in libavformat, do not access
1163  * its lifetime differs from info which is why it is not in that structure.
1164  */
1165  int nb_decoded_frames;
1166 
1167  /**
1168  * Timestamp offset added to timestamps before muxing
1169  * NOT PART OF PUBLIC API
1170  */
1171  int64_t mux_ts_offset;
1172 
1173  /**
1174  * Internal data to check for wrapping of the time stamp
1175  */
1176  int64_t pts_wrap_reference;
1177 
1178  /**
1179  * Options for behavior, when a wrap is detected.
1180  *
1181  * Defined by AV_PTS_WRAP_ values.
1182  *
1183  * If correction is enabled, there are two possibilities:
1184  * If the first time stamp is near the wrap point, the wrap offset
1185  * will be subtracted, which will create negative time stamps.
1186  * Otherwise the offset will be added.
1187  */
1188  int pts_wrap_behavior;
1189 
1190  /**
1191  * Internal data to prevent doing update_initial_durations() twice
1192  */
1193  int update_initial_durations_done;
1194 
1195  /**
1196  * Internal data to generate dts from pts
1197  */
1198  int64_t pts_reorder_error[MAX_REORDER_DELAY+1];
1199  uint8_t pts_reorder_error_count[MAX_REORDER_DELAY+1];
1200 
1201  /**
1202  * Internal data to analyze DTS and detect faulty mpeg streams
1203  */
1204  int64_t last_dts_for_order_check;
1205  uint8_t dts_ordered;
1206  uint8_t dts_misordered;
1208  /**
1209  * Internal data to inject global side data
1210  */
1211  int inject_global_side_data;
1212 
1213  /**
1214  * display aspect ratio (0 if unknown)
1215  * - encoding: unused
1216  * - decoding: Set by libavformat to calculate sample_aspect_ratio internally
1217  */
1218  AVRational display_aspect_ratio;
1219 
1220  /**
1221  * An opaque field for libavformat internal usage.
1222  * Must not be accessed in any way by callers.
1223  */
1224  AVStreamInternal *internal;
1225 } AVStream;
1226 
1227 #if FF_API_FORMAT_GET_SET
1228 /**
1229  * Accessors for some AVStream fields. These used to be provided for ABI
1230  * compatibility, and do not need to be used anymore.
1231  */
1233 AVRational av_stream_get_r_frame_rate(const AVStream *s);
1235 void av_stream_set_r_frame_rate(AVStream *s, AVRational r);
1236 #if FF_API_LAVF_FFSERVER
1238 char* av_stream_get_recommended_encoder_configuration(const AVStream *s);
1240 void av_stream_set_recommended_encoder_configuration(AVStream *s, char *configuration);
1241 #endif
1242 #endif
1243 
1245 
1246 /**
1247  * Returns the pts of the last muxed packet + its duration
1248  *
1249  * the retuned value is undefined when used with a demuxer.
1250  */
1251 int64_t av_stream_get_end_pts(const AVStream *st);
1252 
1253 #define AV_PROGRAM_RUNNING 1
1254 
1255 /**
1256  * New fields can be added to the end with minor version bumps.
1257  * Removal, reordering and changes to existing fields require a major
1258  * version bump.
1259  * sizeof(AVProgram) must not be used outside libav*.
1260  */
1261 typedef struct AVProgram {
1262  int id;
1263  int flags;
1264  enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
1265  unsigned int *stream_index;
1266  unsigned int nb_stream_indexes;
1267  AVDictionary *metadata;
1268 
1269  int program_num;
1270  int pmt_pid;
1271  int pcr_pid;
1272  int pmt_version;
1274  /*****************************************************************
1275  * All fields below this line are not part of the public API. They
1276  * may not be used outside of libavformat and can be changed and
1277  * removed at will.
1278  * New public fields should be added right above.
1279  *****************************************************************
1280  */
1281  int64_t start_time;
1282  int64_t end_time;
1283 
1284  int64_t pts_wrap_reference; ///< reference dts for wrap detection
1285  int pts_wrap_behavior; ///< behavior on wrap detection
1286 } AVProgram;
1287 
1288 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
1289  (streams are added dynamically) */
1290 #define AVFMTCTX_UNSEEKABLE 0x0002 /**< signal that the stream is definitely
1291  not seekable, and attempts to call the
1292  seek function will fail. For some
1293  network protocols (e.g. HLS), this can
1294  change dynamically at runtime. */
1295 
1296 typedef struct AVChapter {
1297  int id; ///< unique ID to identify the chapter
1298  AVRational time_base; ///< time base in which the start/end timestamps are specified
1299  int64_t start, end; ///< chapter start/end time in time_base units
1300  AVDictionary *metadata;
1301 } AVChapter;
1302 
1303 
1304 /**
1305  * Callback used by devices to communicate with application.
1306  */
1307 typedef int (*av_format_control_message)(struct AVFormatContext *s, int type,
1308  void *data, size_t data_size);
1309 
1310 typedef int (*AVOpenCallback)(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags,
1313 /**
1314  * The duration of a video can be estimated through various ways, and this enum can be used
1315  * to know how the duration was estimated.
1316  */
1318  AVFMT_DURATION_FROM_PTS, ///< Duration accurately estimated from PTSes
1319  AVFMT_DURATION_FROM_STREAM, ///< Duration estimated from a stream with a known duration
1320  AVFMT_DURATION_FROM_BITRATE ///< Duration estimated from bitrate (less accurate)
1321 };
1322 
1323 typedef struct AVFormatInternal AVFormatInternal;
1325 /**
1326  * Format I/O context.
1327  * New fields can be added to the end with minor version bumps.
1328  * Removal, reordering and changes to existing fields require a major
1329  * version bump.
1330  * sizeof(AVFormatContext) must not be used outside libav*, use
1331  * avformat_alloc_context() to create an AVFormatContext.
1332  *
1333  * Fields can be accessed through AVOptions (av_opt*),
1334  * the name string used matches the associated command line parameter name and
1335  * can be found in libavformat/options_table.h.
1336  * The AVOption/command line parameter names differ in some cases from the C
1337  * structure field names for historic reasons or brevity.
1338  */
1339 typedef struct AVFormatContext {
1340  /**
1341  * A class for logging and @ref avoptions. Set by avformat_alloc_context().
1342  * Exports (de)muxer private options if they exist.
1343  */
1344  const AVClass *av_class;
1345 
1346  /**
1347  * The input container format.
1348  *
1349  * Demuxing only, set by avformat_open_input().
1350  */
1352 
1353  /**
1354  * The output container format.
1355  *
1356  * Muxing only, must be set by the caller before avformat_write_header().
1357  */
1358  ff_const59 struct AVOutputFormat *oformat;
1359 
1360  /**
1361  * Format private data. This is an AVOptions-enabled struct
1362  * if and only if iformat/oformat.priv_class is not NULL.
1363  *
1364  * - muxing: set by avformat_write_header()
1365  * - demuxing: set by avformat_open_input()
1366  */
1367  void *priv_data;
1368 
1369  /**
1370  * I/O context.
1371  *
1372  * - demuxing: either set by the user before avformat_open_input() (then
1373  * the user must close it manually) or set by avformat_open_input().
1374  * - muxing: set by the user before avformat_write_header(). The caller must
1375  * take care of closing / freeing the IO context.
1376  *
1377  * Do NOT set this field if AVFMT_NOFILE flag is set in
1378  * iformat/oformat.flags. In such a case, the (de)muxer will handle
1379  * I/O in some other way and this field will be NULL.
1380  */
1382 
1383  /* stream info */
1384  /**
1385  * Flags signalling stream properties. A combination of AVFMTCTX_*.
1386  * Set by libavformat.
1387  */
1388  int ctx_flags;
1389 
1390  /**
1391  * Number of elements in AVFormatContext.streams.
1392  *
1393  * Set by avformat_new_stream(), must not be modified by any other code.
1394  */
1395  unsigned int nb_streams;
1396  /**
1397  * A list of all streams in the file. New streams are created with
1398  * avformat_new_stream().
1399  *
1400  * - demuxing: streams are created by libavformat in avformat_open_input().
1401  * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
1402  * appear in av_read_frame().
1403  * - muxing: streams are created by the user before avformat_write_header().
1404  *
1405  * Freed by libavformat in avformat_free_context().
1406  */
1407  AVStream **streams;
1408 
1409 #if FF_API_FORMAT_FILENAME
1410  /**
1411  * input or output filename
1412  *
1413  * - demuxing: set by avformat_open_input()
1414  * - muxing: may be set by the caller before avformat_write_header()
1415  *
1416  * @deprecated Use url instead.
1417  */
1419  char filename[1024];
1420 #endif
1422  /**
1423  * input or output URL. Unlike the old filename field, this field has no
1424  * length restriction.
1425  *
1426  * - demuxing: set by avformat_open_input(), initialized to an empty
1427  * string if url parameter was NULL in avformat_open_input().
1428  * - muxing: may be set by the caller before calling avformat_write_header()
1429  * (or avformat_init_output() if that is called first) to a string
1430  * which is freeable by av_free(). Set to an empty string if it
1431  * was NULL in avformat_init_output().
1432  *
1433  * Freed by libavformat in avformat_free_context().
1434  */
1435  char *url;
1436 
1437  /**
1438  * Position of the first frame of the component, in
1439  * AV_TIME_BASE fractional seconds. NEVER set this value directly:
1440  * It is deduced from the AVStream values.
1441  *
1442  * Demuxing only, set by libavformat.
1443  */
1444  int64_t start_time;
1445 
1446  /**
1447  * Duration of the stream, in AV_TIME_BASE fractional
1448  * seconds. Only set this value if you know none of the individual stream
1449  * durations and also do not set any of them. This is deduced from the
1450  * AVStream values if not set.
1451  *
1452  * Demuxing only, set by libavformat.
1453  */
1454  int64_t duration;
1455 
1456  /**
1457  * Total stream bitrate in bit/s, 0 if not
1458  * available. Never set it directly if the file_size and the
1459  * duration are known as FFmpeg can compute it automatically.
1460  */
1461  int64_t bit_rate;
1462 
1463  unsigned int packet_size;
1464  int max_delay;
1465 
1466  /**
1467  * Flags modifying the (de)muxer behaviour. A combination of AVFMT_FLAG_*.
1468  * Set by the user before avformat_open_input() / avformat_write_header().
1469  */
1470  int flags;
1471 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
1472 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
1473 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
1474 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
1475 #define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
1476 #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
1477 #define AVFMT_FLAG_NOBUFFER 0x0040 ///< Do not buffer frames when possible
1478 #define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
1479 #define AVFMT_FLAG_DISCARD_CORRUPT 0x0100 ///< Discard frames marked corrupted
1480 #define AVFMT_FLAG_FLUSH_PACKETS 0x0200 ///< Flush the AVIOContext every packet.
1481 /**
1482  * When muxing, try to avoid writing any random/volatile data to the output.
1483  * This includes any random IDs, real-time timestamps/dates, muxer version, etc.
1484  *
1485  * This flag is mainly intended for testing.
1486  */
1487 #define AVFMT_FLAG_BITEXACT 0x0400
1488 #if FF_API_LAVF_MP4A_LATM
1489 #define AVFMT_FLAG_MP4A_LATM 0x8000 ///< Deprecated, does nothing.
1490 #endif
1491 #define AVFMT_FLAG_SORT_DTS 0x10000 ///< try to interleave outputted packets by dts (using this flag can slow demuxing down)
1492 #define AVFMT_FLAG_PRIV_OPT 0x20000 ///< Enable use of private options by delaying codec open (this could be made default once all code is converted)
1493 #if FF_API_LAVF_KEEPSIDE_FLAG
1494 #define AVFMT_FLAG_KEEP_SIDE_DATA 0x40000 ///< Deprecated, does nothing.
1495 #endif
1496 #define AVFMT_FLAG_FAST_SEEK 0x80000 ///< Enable fast, but inaccurate seeks for some formats
1497 #define AVFMT_FLAG_SHORTEST 0x100000 ///< Stop muxing when the shortest stream stops.
1498 #define AVFMT_FLAG_AUTO_BSF 0x200000 ///< Add bitstream filters as requested by the muxer
1499 
1500  /**
1501  * Maximum size of the data read from input for determining
1502  * the input container format.
1503  * Demuxing only, set by the caller before avformat_open_input().
1504  */
1505  int64_t probesize;
1507  /**
1508  * Maximum duration (in AV_TIME_BASE units) of the data read
1509  * from input in avformat_find_stream_info().
1510  * Demuxing only, set by the caller before avformat_find_stream_info().
1511  * Can be set to 0 to let avformat choose using a heuristic.
1512  */
1513  int64_t max_analyze_duration;
1514 
1515  const uint8_t *key;
1516  int keylen;
1517 
1518  unsigned int nb_programs;
1519  AVProgram **programs;
1520 
1521  /**
1522  * Forced video codec_id.
1523  * Demuxing: Set by user.
1524  */
1525  enum AVCodecID video_codec_id;
1526 
1527  /**
1528  * Forced audio codec_id.
1529  * Demuxing: Set by user.
1530  */
1531  enum AVCodecID audio_codec_id;
1533  /**
1534  * Forced subtitle codec_id.
1535  * Demuxing: Set by user.
1536  */
1537  enum AVCodecID subtitle_codec_id;
1538 
1539  /**
1540  * Maximum amount of memory in bytes to use for the index of each stream.
1541  * If the index exceeds this size, entries will be discarded as
1542  * needed to maintain a smaller size. This can lead to slower or less
1543  * accurate seeking (depends on demuxer).
1544  * Demuxers for which a full in-memory index is mandatory will ignore
1545  * this.
1546  * - muxing: unused
1547  * - demuxing: set by user
1548  */
1549  unsigned int max_index_size;
1550 
1551  /**
1552  * Maximum amount of memory in bytes to use for buffering frames
1553  * obtained from realtime capture devices.
1554  */
1555  unsigned int max_picture_buffer;
1556 
1557  /**
1558  * Number of chapters in AVChapter array.
1559  * When muxing, chapters are normally written in the file header,
1560  * so nb_chapters should normally be initialized before write_header
1561  * is called. Some muxers (e.g. mov and mkv) can also write chapters
1562  * in the trailer. To write chapters in the trailer, nb_chapters
1563  * must be zero when write_header is called and non-zero when
1564  * write_trailer is called.
1565  * - muxing: set by user
1566  * - demuxing: set by libavformat
1567  */
1568  unsigned int nb_chapters;
1569  AVChapter **chapters;
1570 
1571  /**
1572  * Metadata that applies to the whole file.
1573  *
1574  * - demuxing: set by libavformat in avformat_open_input()
1575  * - muxing: may be set by the caller before avformat_write_header()
1576  *
1577  * Freed by libavformat in avformat_free_context().
1578  */
1579  AVDictionary *metadata;
1580 
1581  /**
1582  * Start time of the stream in real world time, in microseconds
1583  * since the Unix epoch (00:00 1st January 1970). That is, pts=0 in the
1584  * stream was captured at this real world time.
1585  * - muxing: Set by the caller before avformat_write_header(). If set to
1586  * either 0 or AV_NOPTS_VALUE, then the current wall-time will
1587  * be used.
1588  * - demuxing: Set by libavformat. AV_NOPTS_VALUE if unknown. Note that
1589  * the value may become known after some number of frames
1590  * have been received.
1591  */
1592  int64_t start_time_realtime;
1594  /**
1595  * The number of frames used for determining the framerate in
1596  * avformat_find_stream_info().
1597  * Demuxing only, set by the caller before avformat_find_stream_info().
1598  */
1599  int fps_probe_size;
1600 
1601  /**
1602  * Error recognition; higher values will detect more errors but may
1603  * misdetect some more or less valid parts as errors.
1604  * Demuxing only, set by the caller before avformat_open_input().
1605  */
1606  int error_recognition;
1607 
1608  /**
1609  * Custom interrupt callbacks for the I/O layer.
1610  *
1611  * demuxing: set by the user before avformat_open_input().
1612  * muxing: set by the user before avformat_write_header()
1613  * (mainly useful for AVFMT_NOFILE formats). The callback
1614  * should also be passed to avio_open2() if it's used to
1615  * open the file.
1616  */
1617  AVIOInterruptCB interrupt_callback;
1618 
1619  /**
1620  * Flags to enable debugging.
1621  */
1622  int debug;
1623 #define FF_FDEBUG_TS 0x0001
1624 
1625  /**
1626  * Maximum buffering duration for interleaving.
1627  *
1628  * To ensure all the streams are interleaved correctly,
1629  * av_interleaved_write_frame() will wait until it has at least one packet
1630  * for each stream before actually writing any packets to the output file.
1631  * When some streams are "sparse" (i.e. there are large gaps between
1632  * successive packets), this can result in excessive buffering.
1633  *
1634  * This field specifies the maximum difference between the timestamps of the
1635  * first and the last packet in the muxing queue, above which libavformat
1636  * will output a packet regardless of whether it has queued a packet for all
1637  * the streams.
1638  *
1639  * Muxing only, set by the caller before avformat_write_header().
1640  */
1641  int64_t max_interleave_delta;
1642 
1643  /**
1644  * Allow non-standard and experimental extension
1645  * @see AVCodecContext.strict_std_compliance
1646  */
1647  int strict_std_compliance;
1648 
1649  /**
1650  * Flags for the user to detect events happening on the file. Flags must
1651  * be cleared by the user once the event has been handled.
1652  * A combination of AVFMT_EVENT_FLAG_*.
1653  */
1654  int event_flags;
1655 #define AVFMT_EVENT_FLAG_METADATA_UPDATED 0x0001 ///< The call resulted in updated metadata.
1656 
1657  /**
1658  * Maximum number of packets to read while waiting for the first timestamp.
1659  * Decoding only.
1660  */
1661  int max_ts_probe;
1662 
1663  /**
1664  * Avoid negative timestamps during muxing.
1665  * Any value of the AVFMT_AVOID_NEG_TS_* constants.
1666  * Note, this only works when using av_interleaved_write_frame. (interleave_packet_per_dts is in use)
1667  * - muxing: Set by user
1668  * - demuxing: unused
1669  */
1670  int avoid_negative_ts;
1671 #define AVFMT_AVOID_NEG_TS_AUTO -1 ///< Enabled when required by target format
1672 #define AVFMT_AVOID_NEG_TS_MAKE_NON_NEGATIVE 1 ///< Shift timestamps so they are non negative
1673 #define AVFMT_AVOID_NEG_TS_MAKE_ZERO 2 ///< Shift timestamps so that they start at 0
1674 
1675  /**
1676  * Transport stream id.
1677  * This will be moved into demuxer private options. Thus no API/ABI compatibility
1678  */
1679  int ts_id;
1680 
1681  /**
1682  * Audio preload in microseconds.
1683  * Note, not all formats support this and unpredictable things may happen if it is used when not supported.
1684  * - encoding: Set by user
1685  * - decoding: unused
1686  */
1687  int audio_preload;
1688 
1689  /**
1690  * Max chunk time in microseconds.
1691  * Note, not all formats support this and unpredictable things may happen if it is used when not supported.
1692  * - encoding: Set by user
1693  * - decoding: unused
1694  */
1695  int max_chunk_duration;
1696 
1697  /**
1698  * Max chunk size in bytes
1699  * Note, not all formats support this and unpredictable things may happen if it is used when not supported.
1700  * - encoding: Set by user
1701  * - decoding: unused
1702  */
1703  int max_chunk_size;
1704 
1705  /**
1706  * forces the use of wallclock timestamps as pts/dts of packets
1707  * This has undefined results in the presence of B frames.
1708  * - encoding: unused
1709  * - decoding: Set by user
1710  */
1711  int use_wallclock_as_timestamps;
1712 
1713  /**
1714  * avio flags, used to force AVIO_FLAG_DIRECT.
1715  * - encoding: unused
1716  * - decoding: Set by user
1717  */
1718  int avio_flags;
1719 
1720  /**
1721  * The duration field can be estimated through various ways, and this field can be used
1722  * to know how the duration was estimated.
1723  * - encoding: unused
1724  * - decoding: Read by user
1725  */
1726  enum AVDurationEstimationMethod duration_estimation_method;
1727 
1728  /**
1729  * Skip initial bytes when opening stream
1730  * - encoding: unused
1731  * - decoding: Set by user
1732  */
1733  int64_t skip_initial_bytes;
1734 
1735  /**
1736  * Correct single timestamp overflows
1737  * - encoding: unused
1738  * - decoding: Set by user
1739  */
1740  unsigned int correct_ts_overflow;
1741 
1742  /**
1743  * Force seeking to any (also non key) frames.
1744  * - encoding: unused
1745  * - decoding: Set by user
1746  */
1747  int seek2any;
1748 
1749  /**
1750  * Flush the I/O context after each packet.
1751  * - encoding: Set by user
1752  * - decoding: unused
1753  */
1754  int flush_packets;
1755 
1756  /**
1757  * format probing score.
1758  * The maximal score is AVPROBE_SCORE_MAX, its set when the demuxer probes
1759  * the format.
1760  * - encoding: unused
1761  * - decoding: set by avformat, read by user
1762  */
1763  int probe_score;
1764 
1765  /**
1766  * number of bytes to read maximally to identify format.
1767  * - encoding: unused
1768  * - decoding: set by user
1769  */
1770  int format_probesize;
1771 
1772  /**
1773  * ',' separated list of allowed decoders.
1774  * If NULL then all are allowed
1775  * - encoding: unused
1776  * - decoding: set by user
1777  */
1778  char *codec_whitelist;
1779 
1780  /**
1781  * ',' separated list of allowed demuxers.
1782  * If NULL then all are allowed
1783  * - encoding: unused
1784  * - decoding: set by user
1785  */
1786  char *format_whitelist;
1787 
1788  /**
1789  * An opaque field for libavformat internal usage.
1790  * Must not be accessed in any way by callers.
1791  */
1792  AVFormatInternal *internal;
1793 
1794  /**
1795  * IO repositioned flag.
1796  * This is set by avformat when the underlaying IO context read pointer
1797  * is repositioned, for example when doing byte based seeking.
1798  * Demuxers can use the flag to detect such changes.
1799  */
1800  int io_repositioned;
1801 
1802  /**
1803  * Forced video codec.
1804  * This allows forcing a specific decoder, even when there are multiple with
1805  * the same codec_id.
1806  * Demuxing: Set by user
1807  */
1809 
1810  /**
1811  * Forced audio codec.
1812  * This allows forcing a specific decoder, even when there are multiple with
1813  * the same codec_id.
1814  * Demuxing: Set by user
1815  */
1817 
1818  /**
1819  * Forced subtitle codec.
1820  * This allows forcing a specific decoder, even when there are multiple with
1821  * the same codec_id.
1822  * Demuxing: Set by user
1823  */
1825 
1826  /**
1827  * Forced data codec.
1828  * This allows forcing a specific decoder, even when there are multiple with
1829  * the same codec_id.
1830  * Demuxing: Set by user
1831  */
1833 
1834  /**
1835  * Number of bytes to be written as padding in a metadata header.
1836  * Demuxing: Unused.
1837  * Muxing: Set by user via av_format_set_metadata_header_padding.
1838  */
1839  int metadata_header_padding;
1840 
1841  /**
1842  * User data.
1843  * This is a place for some private data of the user.
1844  */
1845  void *opaque;
1847  /**
1848  * Callback used by devices to communicate with application.
1849  */
1850  av_format_control_message control_message_cb;
1851 
1852  /**
1853  * Output timestamp offset, in microseconds.
1854  * Muxing: set by user
1855  */
1856  int64_t output_ts_offset;
1857 
1858  /**
1859  * dump format separator.
1860  * can be ", " or "\n " or anything else
1861  * - muxing: Set by user.
1862  * - demuxing: Set by user.
1863  */
1864  uint8_t *dump_separator;
1865 
1866  /**
1867  * Forced Data codec_id.
1868  * Demuxing: Set by user.
1869  */
1870  enum AVCodecID data_codec_id;
1871 
1872 #if FF_API_OLD_OPEN_CALLBACKS
1873  /**
1874  * Called to open further IO contexts when needed for demuxing.
1875  *
1876  * This can be set by the user application to perform security checks on
1877  * the URLs before opening them.
1878  * The function should behave like avio_open2(), AVFormatContext is provided
1879  * as contextual information and to reach AVFormatContext.opaque.
1880  *
1881  * If NULL then some simple checks are used together with avio_open2().
1882  *
1883  * Must not be accessed directly from outside avformat.
1884  * @See av_format_set_open_cb()
1885  *
1886  * Demuxing: Set by user.
1887  *
1888  * @deprecated Use io_open and io_close.
1889  */
1891  int (*open_cb)(struct AVFormatContext *s, AVIOContext **p, const char *url, int flags, const AVIOInterruptCB *int_cb, AVDictionary **options);
1892 #endif
1893 
1894  /**
1895  * ',' separated list of allowed protocols.
1896  * - encoding: unused
1897  * - decoding: set by user
1898  */
1899  char *protocol_whitelist;
1900 
1901  /**
1902  * A callback for opening new IO streams.
1903  *
1904  * Whenever a muxer or a demuxer needs to open an IO stream (typically from
1905  * avformat_open_input() for demuxers, but for certain formats can happen at
1906  * other times as well), it will call this callback to obtain an IO context.
1907  *
1908  * @param s the format context
1909  * @param pb on success, the newly opened IO context should be returned here
1910  * @param url the url to open
1911  * @param flags a combination of AVIO_FLAG_*
1912  * @param options a dictionary of additional options, with the same
1913  * semantics as in avio_open2()
1914  * @return 0 on success, a negative AVERROR code on failure
1915  *
1916  * @note Certain muxers and demuxers do nesting, i.e. they open one or more
1917  * additional internal format contexts. Thus the AVFormatContext pointer
1918  * passed to this callback may be different from the one facing the caller.
1919  * It will, however, have the same 'opaque' field.
1920  */
1921  int (*io_open)(struct AVFormatContext *s, AVIOContext **pb, const char *url,
1922  int flags, AVDictionary **options);
1923 
1924  /**
1925  * A callback for closing the streams opened with AVFormatContext.io_open().
1926  */
1927  void (*io_close)(struct AVFormatContext *s, AVIOContext *pb);
1928 
1929  /**
1930  * ',' separated list of disallowed protocols.
1931  * - encoding: unused
1932  * - decoding: set by user
1933  */
1934  char *protocol_blacklist;
1936  /**
1937  * The maximum number of streams.
1938  * - encoding: unused
1939  * - decoding: set by user
1940  */
1942 
1943  /**
1944  * Skip duration calcuation in estimate_timings_from_pts.
1945  * - encoding: unused
1946  * - decoding: set by user
1947  */
1949 
1950  /**
1951  * Maximum number of packets that can be probed
1952  * - encoding: unused
1953  * - decoding: set by user
1954  */
1956 } AVFormatContext;
1957 
1958 #if FF_API_FORMAT_GET_SET
1959 /**
1960  * Accessors for some AVFormatContext fields. These used to be provided for ABI
1961  * compatibility, and do not need to be used anymore.
1962  */
1964 int av_format_get_probe_score(const AVFormatContext *s);
1966 AVCodec * av_format_get_video_codec(const AVFormatContext *s);
1968 void av_format_set_video_codec(AVFormatContext *s, AVCodec *c);
1970 AVCodec * av_format_get_audio_codec(const AVFormatContext *s);
1972 void av_format_set_audio_codec(AVFormatContext *s, AVCodec *c);
1974 AVCodec * av_format_get_subtitle_codec(const AVFormatContext *s);
1976 void av_format_set_subtitle_codec(AVFormatContext *s, AVCodec *c);
1978 AVCodec * av_format_get_data_codec(const AVFormatContext *s);
1980 void av_format_set_data_codec(AVFormatContext *s, AVCodec *c);
1982 int av_format_get_metadata_header_padding(const AVFormatContext *s);
1984 void av_format_set_metadata_header_padding(AVFormatContext *s, int c);
1986 void * av_format_get_opaque(const AVFormatContext *s);
1988 void av_format_set_opaque(AVFormatContext *s, void *opaque);
1990 av_format_control_message av_format_get_control_message_cb(const AVFormatContext *s);
1992 void av_format_set_control_message_cb(AVFormatContext *s, av_format_control_message callback);
1993 #if FF_API_OLD_OPEN_CALLBACKS
1994 attribute_deprecated AVOpenCallback av_format_get_open_cb(const AVFormatContext *s);
1995 attribute_deprecated void av_format_set_open_cb(AVFormatContext *s, AVOpenCallback callback);
1996 #endif
1997 #endif
1998 
1999 /**
2000  * This function will cause global side data to be injected in the next packet
2001  * of each stream as well as after any subsequent seek.
2002  */
2004 
2005 /**
2006  * Returns the method used to set ctx->duration.
2007  *
2008  * @return AVFMT_DURATION_FROM_PTS, AVFMT_DURATION_FROM_STREAM, or AVFMT_DURATION_FROM_BITRATE.
2009  */
2011 
2012 typedef struct AVPacketList {
2013  AVPacket pkt;
2014  struct AVPacketList *next;
2015 } AVPacketList;
2016 
2017 
2018 /**
2019  * @defgroup lavf_core Core functions
2020  * @ingroup libavf
2021  *
2022  * Functions for querying libavformat capabilities, allocating core structures,
2023  * etc.
2024  * @{
2025  */
2027 /**
2028  * Return the LIBAVFORMAT_VERSION_INT constant.
2029  */
2030 unsigned avformat_version(void);
2031 
2032 /**
2033  * Return the libavformat build-time configuration.
2034  */
2035 const char *avformat_configuration(void);
2036 
2037 /**
2038  * Return the libavformat license.
2039  */
2040 const char *avformat_license(void);
2041 
2042 #if FF_API_NEXT
2043 /**
2044  * Initialize libavformat and register all the muxers, demuxers and
2045  * protocols. If you do not call this function, then you can select
2046  * exactly which formats you want to support.
2047  *
2048  * @see av_register_input_format()
2049  * @see av_register_output_format()
2050  */
2052 void av_register_all(void);
2053 
2055 void av_register_input_format(AVInputFormat *format);
2057 void av_register_output_format(AVOutputFormat *format);
2058 #endif
2059 
2060 /**
2061  * Do global initialization of network libraries. This is optional,
2062  * and not recommended anymore.
2063  *
2064  * This functions only exists to work around thread-safety issues
2065  * with older GnuTLS or OpenSSL libraries. If libavformat is linked
2066  * to newer versions of those libraries, or if you do not use them,
2067  * calling this function is unnecessary. Otherwise, you need to call
2068  * this function before any other threads using them are started.
2069  *
2070  * This function will be deprecated once support for older GnuTLS and
2071  * OpenSSL libraries is removed, and this function has no purpose
2072  * anymore.
2073  */
2074 int avformat_network_init(void);
2075 
2076 /**
2077  * Undo the initialization done by avformat_network_init. Call it only
2078  * once for each time you called avformat_network_init.
2079  */
2080 int avformat_network_deinit(void);
2081 
2082 #if FF_API_NEXT
2083 /**
2084  * If f is NULL, returns the first registered input format,
2085  * if f is non-NULL, returns the next registered input format after f
2086  * or NULL if f is the last one.
2087  */
2089 AVInputFormat *av_iformat_next(const AVInputFormat *f);
2090 
2091 /**
2092  * If f is NULL, returns the first registered output format,
2093  * if f is non-NULL, returns the next registered output format after f
2094  * or NULL if f is the last one.
2095  */
2097 AVOutputFormat *av_oformat_next(const AVOutputFormat *f);
2098 #endif
2099 
2100 /**
2101  * Iterate over all registered muxers.
2102  *
2103  * @param opaque a pointer where libavformat will store the iteration state. Must
2104  * point to NULL to start the iteration.
2105  *
2106  * @return the next registered muxer or NULL when the iteration is
2107  * finished
2108  */
2109 const AVOutputFormat *av_muxer_iterate(void **opaque);
2110 
2111 /**
2112  * Iterate over all registered demuxers.
2113  *
2114  * @param opaque a pointer where libavformat will store the iteration state. Must
2115  * point to NULL to start the iteration.
2116  *
2117  * @return the next registered demuxer or NULL when the iteration is
2118  * finished
2119  */
2120 const AVInputFormat *av_demuxer_iterate(void **opaque);
2121 
2122 /**
2123  * Allocate an AVFormatContext.
2124  * avformat_free_context() can be used to free the context and everything
2125  * allocated by the framework within it.
2126  */
2128 
2129 /**
2130  * Free an AVFormatContext and all its streams.
2131  * @param s context to free
2132  */
2134 
2135 /**
2136  * Get the AVClass for AVFormatContext. It can be used in combination with
2137  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
2138  *
2139  * @see av_opt_find().
2140  */
2141 const AVClass *avformat_get_class(void);
2142 
2143 /**
2144  * Add a new stream to a media file.
2145  *
2146  * When demuxing, it is called by the demuxer in read_header(). If the
2147  * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
2148  * be called in read_packet().
2149  *
2150  * When muxing, should be called by the user before avformat_write_header().
2151  *
2152  * User is required to call avcodec_close() and avformat_free_context() to
2153  * clean up the allocation by avformat_new_stream().
2154  *
2155  * @param s media file handle
2156  * @param c If non-NULL, the AVCodecContext corresponding to the new stream
2157  * will be initialized to use this codec. This is needed for e.g. codec-specific
2158  * defaults to be set, so codec should be provided if it is known.
2159  *
2160  * @return newly created stream or NULL on error.
2161  */
2163 
2164 /**
2165  * Wrap an existing array as stream side data.
2166  *
2167  * @param st stream
2168  * @param type side information type
2169  * @param data the side data array. It must be allocated with the av_malloc()
2170  * family of functions. The ownership of the data is transferred to
2171  * st.
2172  * @param size side information size
2173  * @return zero on success, a negative AVERROR code on failure. On failure,
2174  * the stream is unchanged and the data remains owned by the caller.
2175  */
2177  uint8_t *data, size_t size);
2178 
2179 /**
2180  * Allocate new information from stream.
2181  *
2182  * @param stream stream
2183  * @param type desired side information type
2184  * @param size side information size
2185  * @return pointer to fresh allocated data or NULL otherwise
2186  */
2188  enum AVPacketSideDataType type, int size);
2189 /**
2190  * Get side information from stream.
2191  *
2192  * @param stream stream
2193  * @param type desired side information type
2194  * @param size pointer for side information size to store (optional)
2195  * @return pointer to data if present or NULL otherwise
2196  */
2198  enum AVPacketSideDataType type, int *size);
2199 
2201 
2202 /**
2203  * @}
2204  */
2205 
2206 
2207 /**
2208  * Allocate an AVFormatContext for an output format.
2209  * avformat_free_context() can be used to free the context and
2210  * everything allocated by the framework within it.
2211  *
2212  * @param *ctx is set to the created format context, or to NULL in
2213  * case of failure
2214  * @param oformat format to use for allocating the context, if NULL
2215  * format_name and filename are used instead
2216  * @param format_name the name of output format to use for allocating the
2217  * context, if NULL filename is used instead
2218  * @param filename the name of the filename to use for allocating the
2219  * context, may be NULL
2220  * @return >= 0 in case of success, a negative AVERROR code in case of
2221  * failure
2222  */
2224  const char *format_name, const char *filename);
2225 
2226 /**
2227  * @addtogroup lavf_decoding
2228  * @{
2229  */
2230 
2231 /**
2232  * Find AVInputFormat based on the short name of the input format.
2233  */
2234 ff_const59 AVInputFormat *av_find_input_format(const char *short_name);
2235 
2236 /**
2237  * Guess the file format.
2238  *
2239  * @param pd data to be probed
2240  * @param is_opened Whether the file is already opened; determines whether
2241  * demuxers with or without AVFMT_NOFILE are probed.
2242  */
2244 
2245 /**
2246  * Guess the file format.
2247  *
2248  * @param pd data to be probed
2249  * @param is_opened Whether the file is already opened; determines whether
2250  * demuxers with or without AVFMT_NOFILE are probed.
2251  * @param score_max A probe score larger that this is required to accept a
2252  * detection, the variable is set to the actual detection
2253  * score afterwards.
2254  * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
2255  * to retry with a larger probe buffer.
2256  */
2257 ff_const59 AVInputFormat *av_probe_input_format2(ff_const59 AVProbeData *pd, int is_opened, int *score_max);
2258 
2259 /**
2260  * Guess the file format.
2261  *
2262  * @param is_opened Whether the file is already opened; determines whether
2263  * demuxers with or without AVFMT_NOFILE are probed.
2264  * @param score_ret The score of the best detection.
2265  */
2266 ff_const59 AVInputFormat *av_probe_input_format3(ff_const59 AVProbeData *pd, int is_opened, int *score_ret);
2267 
2268 /**
2269  * Probe a bytestream to determine the input format. Each time a probe returns
2270  * with a score that is too low, the probe buffer size is increased and another
2271  * attempt is made. When the maximum probe size is reached, the input format
2272  * with the highest score is returned.
2273  *
2274  * @param pb the bytestream to probe
2275  * @param fmt the input format is put here
2276  * @param url the url of the stream
2277  * @param logctx the log context
2278  * @param offset the offset within the bytestream to probe from
2279  * @param max_probe_size the maximum probe buffer size (zero for default)
2280  * @return the score in case of success, a negative value corresponding to an
2281  * the maximal score is AVPROBE_SCORE_MAX
2282  * AVERROR code otherwise
2283  */
2285  const char *url, void *logctx,
2286  unsigned int offset, unsigned int max_probe_size);
2287 
2288 /**
2289  * Like av_probe_input_buffer2() but returns 0 on success
2290  */
2292  const char *url, void *logctx,
2293  unsigned int offset, unsigned int max_probe_size);
2294 
2295 /**
2296  * Open an input stream and read the header. The codecs are not opened.
2297  * The stream must be closed with avformat_close_input().
2298  *
2299  * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
2300  * May be a pointer to NULL, in which case an AVFormatContext is allocated by this
2301  * function and written into ps.
2302  * Note that a user-supplied AVFormatContext will be freed on failure.
2303  * @param url URL of the stream to open.
2304  * @param fmt If non-NULL, this parameter forces a specific input format.
2305  * Otherwise the format is autodetected.
2306  * @param options A dictionary filled with AVFormatContext and demuxer-private options.
2307  * On return this parameter will be destroyed and replaced with a dict containing
2308  * options that were not found. May be NULL.
2309  *
2310  * @return 0 on success, a negative AVERROR on failure.
2311  *
2312  * @note If you want to use custom IO, preallocate the format context and set its pb field.
2313  */
2315 
2318 
2319 /**
2320  * Read packets of a media file to get stream information. This
2321  * is useful for file formats with no headers such as MPEG. This
2322  * function also computes the real framerate in case of MPEG-2 repeat
2323  * frame mode.
2324  * The logical file position is not changed by this function;
2325  * examined packets may be buffered for later processing.
2326  *
2327  * @param ic media file handle
2328  * @param options If non-NULL, an ic.nb_streams long array of pointers to
2329  * dictionaries, where i-th member contains options for
2330  * codec corresponding to i-th stream.
2331  * On return each dictionary will be filled with options that were not found.
2332  * @return >=0 if OK, AVERROR_xxx on error
2333  *
2334  * @note this function isn't guaranteed to open all the codecs, so
2335  * options being non-empty at return is a perfectly normal behavior.
2336  *
2337  * @todo Let the user decide somehow what information is needed so that
2338  * we do not waste time getting stuff the user does not need.
2339  */
2341 
2342 /**
2343  * Find the programs which belong to a given stream.
2344  *
2345  * @param ic media file handle
2346  * @param last the last found program, the search will start after this
2347  * program, or from the beginning if it is NULL
2348  * @param s stream index
2349  * @return the next program which belongs to s, NULL if no program is found or
2350  * the last program is not among the programs of ic.
2351  */
2353 
2354 void av_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
2355 
2356 /**
2357  * Find the "best" stream in the file.
2358  * The best stream is determined according to various heuristics as the most
2359  * likely to be what the user expects.
2360  * If the decoder parameter is non-NULL, av_find_best_stream will find the
2361  * default decoder for the stream's codec; streams for which no decoder can
2362  * be found are ignored.
2363  *
2364  * @param ic media file handle
2365  * @param type stream type: video, audio, subtitles, etc.
2366  * @param wanted_stream_nb user-requested stream number,
2367  * or -1 for automatic selection
2368  * @param related_stream try to find a stream related (eg. in the same
2369  * program) to this one, or -1 if none
2370  * @param decoder_ret if non-NULL, returns the decoder for the
2371  * selected stream
2372  * @param flags flags; none are currently defined
2373  * @return the non-negative stream number in case of success,
2374  * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
2375  * could be found,
2376  * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
2377  * @note If av_find_best_stream returns successfully and decoder_ret is not
2378  * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
2379  */
2381  enum AVMediaType type,
2382  int wanted_stream_nb,
2383  int related_stream,
2384  AVCodec **decoder_ret,
2385  int flags);
2386 
2387 /**
2388  * Return the next frame of a stream.
2389  * This function returns what is stored in the file, and does not validate
2390  * that what is there are valid frames for the decoder. It will split what is
2391  * stored in the file into frames and return one for each call. It will not
2392  * omit invalid data between valid frames so as to give the decoder the maximum
2393  * information possible for decoding.
2394  *
2395  * On success, the returned packet is reference-counted (pkt->buf is set) and
2396  * valid indefinitely. The packet must be freed with av_packet_unref() when
2397  * it is no longer needed. For video, the packet contains exactly one frame.
2398  * For audio, it contains an integer number of frames if each frame has
2399  * a known fixed size (e.g. PCM or ADPCM data). If the audio frames have
2400  * a variable size (e.g. MPEG audio), then it contains one frame.
2401  *
2402  * pkt->pts, pkt->dts and pkt->duration are always set to correct
2403  * values in AVStream.time_base units (and guessed if the format cannot
2404  * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
2405  * has B-frames, so it is better to rely on pkt->dts if you do not
2406  * decompress the payload.
2407  *
2408  * @return 0 if OK, < 0 on error or end of file. On error, pkt will be blank
2409  * (as if it came from av_packet_alloc()).
2410  *
2411  * @note pkt will be initialized, so it may be uninitialized, but it must not
2412  * contain data that needs to be freed.
2413  */
2415 
2416 /**
2417  * Seek to the keyframe at timestamp.
2418  * 'timestamp' in 'stream_index'.
2419  *
2420  * @param s media file handle
2421  * @param stream_index If stream_index is (-1), a default
2422  * stream is selected, and timestamp is automatically converted
2423  * from AV_TIME_BASE units to the stream specific time_base.
2424  * @param timestamp Timestamp in AVStream.time_base units
2425  * or, if no stream is specified, in AV_TIME_BASE units.
2426  * @param flags flags which select direction and seeking mode
2427  * @return >= 0 on success
2428  */
2429 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
2430  int flags);
2431 
2432 /**
2433  * Seek to timestamp ts.
2434  * Seeking will be done so that the point from which all active streams
2435  * can be presented successfully will be closest to ts and within min/max_ts.
2436  * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
2437  *
2438  * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
2439  * are the file position (this may not be supported by all demuxers).
2440  * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
2441  * in the stream with stream_index (this may not be supported by all demuxers).
2442  * Otherwise all timestamps are in units of the stream selected by stream_index
2443  * or if stream_index is -1, in AV_TIME_BASE units.
2444  * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
2445  * keyframes (this may not be supported by all demuxers).
2446  * If flags contain AVSEEK_FLAG_BACKWARD, it is ignored.
2447  *
2448  * @param s media file handle
2449  * @param stream_index index of the stream which is used as time base reference
2450  * @param min_ts smallest acceptable timestamp
2451  * @param ts target timestamp
2452  * @param max_ts largest acceptable timestamp
2453  * @param flags flags
2454  * @return >=0 on success, error code otherwise
2455  *
2456  * @note This is part of the new seek API which is still under construction.
2457  */
2458 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
2459 
2460 /**
2461  * Discard all internally buffered data. This can be useful when dealing with
2462  * discontinuities in the byte stream. Generally works only with formats that
2463  * can resync. This includes headerless formats like MPEG-TS/TS but should also
2464  * work with NUT, Ogg and in a limited way AVI for example.
2465  *
2466  * The set of streams, the detected duration, stream parameters and codecs do
2467  * not change when calling this function. If you want a complete reset, it's
2468  * better to open a new AVFormatContext.
2469  *
2470  * This does not flush the AVIOContext (s->pb). If necessary, call
2471  * avio_flush(s->pb) before calling this function.
2472  *
2473  * @param s media file handle
2474  * @return >=0 on success, error code otherwise
2475  */
2477 
2478 /**
2479  * Start playing a network-based stream (e.g. RTSP stream) at the
2480  * current position.
2481  */
2483 
2484 /**
2485  * Pause a network-based stream (e.g. RTSP stream).
2486  *
2487  * Use av_read_play() to resume it.
2488  */
2490 
2491 /**
2492  * Close an opened input AVFormatContext. Free it and all its contents
2493  * and set *s to NULL.
2494  */
2496 /**
2497  * @}
2498  */
2499 
2500 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
2501 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
2502 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
2503 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
2504 
2505 /**
2506  * @addtogroup lavf_encoding
2507  * @{
2508  */
2509 
2510 #define AVSTREAM_INIT_IN_WRITE_HEADER 0 ///< stream parameters initialized in avformat_write_header
2511 #define AVSTREAM_INIT_IN_INIT_OUTPUT 1 ///< stream parameters initialized in avformat_init_output
2512 
2513 /**
2514  * Allocate the stream private data and write the stream header to
2515  * an output media file.
2516  *
2517  * @param s Media file handle, must be allocated with avformat_alloc_context().
2518  * Its oformat field must be set to the desired output format;
2519  * Its pb field must be set to an already opened AVIOContext.
2520  * @param options An AVDictionary filled with AVFormatContext and muxer-private options.
2521  * On return this parameter will be destroyed and replaced with a dict containing
2522  * options that were not found. May be NULL.
2523  *
2524  * @return AVSTREAM_INIT_IN_WRITE_HEADER on success if the codec had not already been fully initialized in avformat_init,
2525  * AVSTREAM_INIT_IN_INIT_OUTPUT on success if the codec had already been fully initialized in avformat_init,
2526  * negative AVERROR on failure.
2527  *
2528  * @see av_opt_find, av_dict_set, avio_open, av_oformat_next, avformat_init_output.
2529  */
2532 
2533 /**
2534  * Allocate the stream private data and initialize the codec, but do not write the header.
2535  * May optionally be used before avformat_write_header to initialize stream parameters
2536  * before actually writing the header.
2537  * If using this function, do not pass the same options to avformat_write_header.
2538  *
2539  * @param s Media file handle, must be allocated with avformat_alloc_context().
2540  * Its oformat field must be set to the desired output format;
2541  * Its pb field must be set to an already opened AVIOContext.
2542  * @param options An AVDictionary filled with AVFormatContext and muxer-private options.
2543  * On return this parameter will be destroyed and replaced with a dict containing
2544  * options that were not found. May be NULL.
2545  *
2546  * @return AVSTREAM_INIT_IN_WRITE_HEADER on success if the codec requires avformat_write_header to fully initialize,
2547  * AVSTREAM_INIT_IN_INIT_OUTPUT on success if the codec has been fully initialized,
2548  * negative AVERROR on failure.
2549  *
2550  * @see av_opt_find, av_dict_set, avio_open, av_oformat_next, avformat_write_header.
2551  */
2554 
2555 /**
2556  * Write a packet to an output media file.
2557  *
2558  * This function passes the packet directly to the muxer, without any buffering
2559  * or reordering. The caller is responsible for correctly interleaving the
2560  * packets if the format requires it. Callers that want libavformat to handle
2561  * the interleaving should call av_interleaved_write_frame() instead of this
2562  * function.
2563  *
2564  * @param s media file handle
2565  * @param pkt The packet containing the data to be written. Note that unlike
2566  * av_interleaved_write_frame(), this function does not take
2567  * ownership of the packet passed to it (though some muxers may make
2568  * an internal reference to the input packet).
2569  * <br>
2570  * This parameter can be NULL (at any time, not just at the end), in
2571  * order to immediately flush data buffered within the muxer, for
2572  * muxers that buffer up data internally before writing it to the
2573  * output.
2574  * <br>
2575  * Packet's @ref AVPacket.stream_index "stream_index" field must be
2576  * set to the index of the corresponding stream in @ref
2577  * AVFormatContext.streams "s->streams".
2578  * <br>
2579  * The timestamps (@ref AVPacket.pts "pts", @ref AVPacket.dts "dts")
2580  * must be set to correct values in the stream's timebase (unless the
2581  * output format is flagged with the AVFMT_NOTIMESTAMPS flag, then
2582  * they can be set to AV_NOPTS_VALUE).
2583  * The dts for subsequent packets passed to this function must be strictly
2584  * increasing when compared in their respective timebases (unless the
2585  * output format is flagged with the AVFMT_TS_NONSTRICT, then they
2586  * merely have to be nondecreasing). @ref AVPacket.duration
2587  * "duration") should also be set if known.
2588  * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush
2589  *
2590  * @see av_interleaved_write_frame()
2591  */
2593 
2594 /**
2595  * Write a packet to an output media file ensuring correct interleaving.
2596  *
2597  * This function will buffer the packets internally as needed to make sure the
2598  * packets in the output file are properly interleaved in the order of
2599  * increasing dts. Callers doing their own interleaving should call
2600  * av_write_frame() instead of this function.
2601  *
2602  * Using this function instead of av_write_frame() can give muxers advance
2603  * knowledge of future packets, improving e.g. the behaviour of the mp4
2604  * muxer for VFR content in fragmenting mode.
2605  *
2606  * @param s media file handle
2607  * @param pkt The packet containing the data to be written.
2608  * <br>
2609  * If the packet is reference-counted, this function will take
2610  * ownership of this reference and unreference it later when it sees
2611  * fit.
2612  * The caller must not access the data through this reference after
2613  * this function returns. If the packet is not reference-counted,
2614  * libavformat will make a copy.
2615  * <br>
2616  * This parameter can be NULL (at any time, not just at the end), to
2617  * flush the interleaving queues.
2618  * <br>
2619  * Packet's @ref AVPacket.stream_index "stream_index" field must be
2620  * set to the index of the corresponding stream in @ref
2621  * AVFormatContext.streams "s->streams".
2622  * <br>
2623  * The timestamps (@ref AVPacket.pts "pts", @ref AVPacket.dts "dts")
2624  * must be set to correct values in the stream's timebase (unless the
2625  * output format is flagged with the AVFMT_NOTIMESTAMPS flag, then
2626  * they can be set to AV_NOPTS_VALUE).
2627  * The dts for subsequent packets in one stream must be strictly
2628  * increasing (unless the output format is flagged with the
2629  * AVFMT_TS_NONSTRICT, then they merely have to be nondecreasing).
2630  * @ref AVPacket.duration "duration") should also be set if known.
2631  *
2632  * @return 0 on success, a negative AVERROR on error. Libavformat will always
2633  * take care of freeing the packet, even if this function fails.
2634  *
2635  * @see av_write_frame(), AVFormatContext.max_interleave_delta
2636  */
2638 
2639 /**
2640  * Write an uncoded frame to an output media file.
2641  *
2642  * The frame must be correctly interleaved according to the container
2643  * specification; if not, av_interleaved_write_uncoded_frame() must be used.
2644  *
2645  * See av_interleaved_write_uncoded_frame() for details.
2646  */
2647 int av_write_uncoded_frame(AVFormatContext *s, int stream_index,
2648  AVFrame *frame);
2649 
2650 /**
2651  * Write an uncoded frame to an output media file.
2652  *
2653  * If the muxer supports it, this function makes it possible to write an AVFrame
2654  * structure directly, without encoding it into a packet.
2655  * It is mostly useful for devices and similar special muxers that use raw
2656  * video or PCM data and will not serialize it into a byte stream.
2657  *
2658  * To test whether it is possible to use it with a given muxer and stream,
2659  * use av_write_uncoded_frame_query().
2660  *
2661  * The caller gives up ownership of the frame and must not access it
2662  * afterwards.
2663  *
2664  * @return >=0 for success, a negative code on error
2665  */
2666 int av_interleaved_write_uncoded_frame(AVFormatContext *s, int stream_index,
2667  AVFrame *frame);
2668 
2669 /**
2670  * Test whether a muxer supports uncoded frame.
2671  *
2672  * @return >=0 if an uncoded frame can be written to that muxer and stream,
2673  * <0 if not
2674  */
2675 int av_write_uncoded_frame_query(AVFormatContext *s, int stream_index);
2676 
2677 /**
2678  * Write the stream trailer to an output media file and free the
2679  * file private data.
2680  *
2681  * May only be called after a successful call to avformat_write_header.
2682  *
2683  * @param s media file handle
2684  * @return 0 if OK, AVERROR_xxx on error
2685  */
2687 
2688 /**
2689  * Return the output format in the list of registered output formats
2690  * which best matches the provided parameters, or return NULL if
2691  * there is no match.
2692  *
2693  * @param short_name if non-NULL checks if short_name matches with the
2694  * names of the registered formats
2695  * @param filename if non-NULL checks if filename terminates with the
2696  * extensions of the registered formats
2697  * @param mime_type if non-NULL checks if mime_type matches with the
2698  * MIME type of the registered formats
2699  */
2700 ff_const59 AVOutputFormat *av_guess_format(const char *short_name,
2701  const char *filename,
2702  const char *mime_type);
2703 
2704 /**
2705  * Guess the codec ID based upon muxer and filename.
2706  */
2707 enum AVCodecID av_guess_codec(ff_const59 AVOutputFormat *fmt, const char *short_name,
2708  const char *filename, const char *mime_type,
2709  enum AVMediaType type);
2710 
2711 /**
2712  * Get timing information for the data currently output.
2713  * The exact meaning of "currently output" depends on the format.
2714  * It is mostly relevant for devices that have an internal buffer and/or
2715  * work in real time.
2716  * @param s media file handle
2717  * @param stream stream in the media file
2718  * @param[out] dts DTS of the last packet output for the stream, in stream
2719  * time_base units
2720  * @param[out] wall absolute time when that packet whas output,
2721  * in microsecond
2722  * @return 0 if OK, AVERROR(ENOSYS) if the format does not support it
2723  * Note: some formats or devices may not allow to measure dts and wall
2724  * atomically.
2725  */
2726 int av_get_output_timestamp(struct AVFormatContext *s, int stream,
2727  int64_t *dts, int64_t *wall);
2728 
2729 
2730 /**
2731  * @}
2732  */
2733 
2734 
2735 /**
2736  * @defgroup lavf_misc Utility functions
2737  * @ingroup libavf
2738  * @{
2739  *
2740  * Miscellaneous utility functions related to both muxing and demuxing
2741  * (or neither).
2742  */
2743 
2744 /**
2745  * Send a nice hexadecimal dump of a buffer to the specified file stream.
2746  *
2747  * @param f The file stream pointer where the dump should be sent to.
2748  * @param buf buffer
2749  * @param size buffer size
2750  *
2751  * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
2752  */
2753 void av_hex_dump(FILE *f, const uint8_t *buf, int size);
2754 
2755 /**
2756  * Send a nice hexadecimal dump of a buffer to the log.
2757  *
2758  * @param avcl A pointer to an arbitrary struct of which the first field is a
2759  * pointer to an AVClass struct.
2760  * @param level The importance level of the message, lower values signifying
2761  * higher importance.
2762  * @param buf buffer
2763  * @param size buffer size
2764  *
2765  * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
2766  */
2767 void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size);
2768 
2769 /**
2770  * Send a nice dump of a packet to the specified file stream.
2771  *
2772  * @param f The file stream pointer where the dump should be sent to.
2773  * @param pkt packet to dump
2774  * @param dump_payload True if the payload must be displayed, too.
2775  * @param st AVStream that the packet belongs to
2776  */
2777 void av_pkt_dump2(FILE *f, const AVPacket *pkt, int dump_payload, const AVStream *st);
2778 
2779 
2780 /**
2781  * Send a nice dump of a packet to the log.
2782  *
2783  * @param avcl A pointer to an arbitrary struct of which the first field is a
2784  * pointer to an AVClass struct.
2785  * @param level The importance level of the message, lower values signifying
2786  * higher importance.
2787  * @param pkt packet to dump
2788  * @param dump_payload True if the payload must be displayed, too.
2789  * @param st AVStream that the packet belongs to
2790  */
2791 void av_pkt_dump_log2(void *avcl, int level, const AVPacket *pkt, int dump_payload,
2792  const AVStream *st);
2793 
2794 /**
2795  * Get the AVCodecID for the given codec tag tag.
2796  * If no codec id is found returns AV_CODEC_ID_NONE.
2797  *
2798  * @param tags list of supported codec_id-codec_tag pairs, as stored
2799  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
2800  * @param tag codec tag to match to a codec ID
2801  */
2802 enum AVCodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
2803 
2804 /**
2805  * Get the codec tag for the given codec id id.
2806  * If no codec tag is found returns 0.
2807  *
2808  * @param tags list of supported codec_id-codec_tag pairs, as stored
2809  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
2810  * @param id codec ID to match to a codec tag
2811  */
2812 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum AVCodecID id);
2813 
2814 /**
2815  * Get the codec tag for the given codec id.
2816  *
2817  * @param tags list of supported codec_id - codec_tag pairs, as stored
2818  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
2819  * @param id codec id that should be searched for in the list
2820  * @param tag A pointer to the found tag
2821  * @return 0 if id was not found in tags, > 0 if it was found
2822  */
2823 int av_codec_get_tag2(const struct AVCodecTag * const *tags, enum AVCodecID id,
2824  unsigned int *tag);
2825 
2827 
2828 /**
2829  * Get the index for a specific timestamp.
2830  *
2831  * @param st stream that the timestamp belongs to
2832  * @param timestamp timestamp to retrieve the index for
2833  * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
2834  * to the timestamp which is <= the requested one, if backward
2835  * is 0, then it will be >=
2836  * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
2837  * @return < 0 if no such timestamp could be found
2838  */
2839 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
2840 
2841 /**
2842  * Add an index entry into a sorted list. Update the entry if the list
2843  * already contains it.
2844  *
2845  * @param timestamp timestamp in the time base of the given stream
2846  */
2847 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
2848  int size, int distance, int flags);
2849 
2850 
2851 /**
2852  * Split a URL string into components.
2853  *
2854  * The pointers to buffers for storing individual components may be null,
2855  * in order to ignore that component. Buffers for components not found are
2856  * set to empty strings. If the port is not found, it is set to a negative
2857  * value.
2858  *
2859  * @param proto the buffer for the protocol
2860  * @param proto_size the size of the proto buffer
2861  * @param authorization the buffer for the authorization
2862  * @param authorization_size the size of the authorization buffer
2863  * @param hostname the buffer for the host name
2864  * @param hostname_size the size of the hostname buffer
2865  * @param port_ptr a pointer to store the port number in
2866  * @param path the buffer for the path
2867  * @param path_size the size of the path buffer
2868  * @param url the URL to split
2869  */
2870 void av_url_split(char *proto, int proto_size,
2871  char *authorization, int authorization_size,
2872  char *hostname, int hostname_size,
2873  int *port_ptr,
2874  char *path, int path_size,
2875  const char *url);
2876 
2877 
2878 /**
2879  * Print detailed information about the input or output format, such as
2880  * duration, bitrate, streams, container, programs, metadata, side data,
2881  * codec and time base.
2882  *
2883  * @param ic the context to analyze
2884  * @param index index of the stream to dump information about
2885  * @param url the URL to print, such as source or destination file
2886  * @param is_output Select whether the specified context is an input(0) or output(1)
2887  */
2889  int index,
2890  const char *url,
2891  int is_output);
2892 
2893 
2894 #define AV_FRAME_FILENAME_FLAGS_MULTIPLE 1 ///< Allow multiple %d
2895 
2896 /**
2897  * Return in 'buf' the path with '%d' replaced by a number.
2898  *
2899  * Also handles the '%0nd' format where 'n' is the total number
2900  * of digits and '%%'.
2901  *
2902  * @param buf destination buffer
2903  * @param buf_size destination buffer size
2904  * @param path numbered sequence string
2905  * @param number frame number
2906  * @param flags AV_FRAME_FILENAME_FLAGS_*
2907  * @return 0 if OK, -1 on format error
2908  */
2909 int av_get_frame_filename2(char *buf, int buf_size,
2910  const char *path, int number, int flags);
2911 
2912 int av_get_frame_filename(char *buf, int buf_size,
2913  const char *path, int number);
2914 
2915 /**
2916  * Check whether filename actually is a numbered sequence generator.
2917  *
2918  * @param filename possible numbered sequence string
2919  * @return 1 if a valid numbered sequence string, 0 otherwise
2920  */
2921 int av_filename_number_test(const char *filename);
2922 
2923 /**
2924  * Generate an SDP for an RTP session.
2925  *
2926  * Note, this overwrites the id values of AVStreams in the muxer contexts
2927  * for getting unique dynamic payload types.
2928  *
2929  * @param ac array of AVFormatContexts describing the RTP streams. If the
2930  * array is composed by only one context, such context can contain
2931  * multiple AVStreams (one AVStream per RTP stream). Otherwise,
2932  * all the contexts in the array (an AVCodecContext per RTP stream)
2933  * must contain only one AVStream.
2934  * @param n_files number of AVCodecContexts contained in ac
2935  * @param buf buffer where the SDP will be stored (must be allocated by
2936  * the caller)
2937  * @param size the size of the buffer
2938  * @return 0 if OK, AVERROR_xxx on error
2939  */
2940 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
2941 
2942 /**
2943  * Return a positive value if the given filename has one of the given
2944  * extensions, 0 otherwise.
2945  *
2946  * @param filename file name to check against the given extensions
2947  * @param extensions a comma-separated list of filename extensions
2948  */
2949 int av_match_ext(const char *filename, const char *extensions);
2950 
2951 /**
2952  * Test if the given container can store a codec.
2953  *
2954  * @param ofmt container to check for compatibility
2955  * @param codec_id codec to potentially store in container
2956  * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
2957  *
2958  * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
2959  * A negative number if this information is not available.
2960  */
2962  int std_compliance);
2963 
2964 /**
2965  * @defgroup riff_fourcc RIFF FourCCs
2966  * @{
2967  * Get the tables mapping RIFF FourCCs to libavcodec AVCodecIDs. The tables are
2968  * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the
2969  * following code:
2970  * @code
2971  * uint32_t tag = MKTAG('H', '2', '6', '4');
2972  * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 };
2973  * enum AVCodecID id = av_codec_get_id(table, tag);
2974  * @endcode
2975  */
2976 /**
2977  * @return the table mapping RIFF FourCCs for video to libavcodec AVCodecID.
2978  */
2979 const struct AVCodecTag *avformat_get_riff_video_tags(void);
2980 /**
2981  * @return the table mapping RIFF FourCCs for audio to AVCodecID.
2982  */
2983 const struct AVCodecTag *avformat_get_riff_audio_tags(void);
2984 /**
2985  * @return the table mapping MOV FourCCs for video to libavcodec AVCodecID.
2986  */
2987 const struct AVCodecTag *avformat_get_mov_video_tags(void);
2988 /**
2989  * @return the table mapping MOV FourCCs for audio to AVCodecID.
2990  */
2991 const struct AVCodecTag *avformat_get_mov_audio_tags(void);
2992 
2993 /**
2994  * @}
2995  */
2996 
2997 /**
2998  * Guess the sample aspect ratio of a frame, based on both the stream and the
2999  * frame aspect ratio.
3000  *
3001  * Since the frame aspect ratio is set by the codec but the stream aspect ratio
3002  * is set by the demuxer, these two may not be equal. This function tries to
3003  * return the value that you should use if you would like to display the frame.
3004  *
3005  * Basic logic is to use the stream aspect ratio if it is set to something sane
3006  * otherwise use the frame aspect ratio. This way a container setting, which is
3007  * usually easy to modify can override the coded value in the frames.
3008  *
3009  * @param format the format context which the stream is part of
3010  * @param stream the stream which the frame is part of
3011  * @param frame the frame with the aspect ratio to be determined
3012  * @return the guessed (valid) sample_aspect_ratio, 0/1 if no idea
3013  */
3015 
3016 /**
3017  * Guess the frame rate, based on both the container and codec information.
3018  *
3019  * @param ctx the format context which the stream is part of
3020  * @param stream the stream which the frame is part of
3021  * @param frame the frame for which the frame rate should be determined, may be NULL
3022  * @return the guessed (valid) frame rate, 0/1 if no idea
3023  */
3025 
3026 /**
3027  * Check if the stream st contained in s is matched by the stream specifier
3028  * spec.
3029  *
3030  * See the "stream specifiers" chapter in the documentation for the syntax
3031  * of spec.
3032  *
3033  * @return >0 if st is matched by spec;
3034  * 0 if st is not matched by spec;
3035  * AVERROR code if spec is invalid
3036  *
3037  * @note A stream specifier can match several streams in the format.
3038  */
3040  const char *spec);
3041 
3043 
3044 #if FF_API_OLD_BSF
3045 /**
3046  * Apply a list of bitstream filters to a packet.
3047  *
3048  * @param codec AVCodecContext, usually from an AVStream
3049  * @param pkt the packet to apply filters to. If, on success, the returned
3050  * packet has size == 0 and side_data_elems == 0, it indicates that
3051  * the packet should be dropped
3052  * @param bsfc a NULL-terminated list of filters to apply
3053  * @return >=0 on success;
3054  * AVERROR code on failure
3055  */
3057 int av_apply_bitstream_filters(AVCodecContext *codec, AVPacket *pkt,
3058  AVBitStreamFilterContext *bsfc);
3059 #endif
3060 
3061 enum AVTimebaseSource {
3062  AVFMT_TBCF_AUTO = -1,
3065 #if FF_API_R_FRAME_RATE
3066  AVFMT_TBCF_R_FRAMERATE,
3067 #endif
3068 };
3069 
3070 /**
3071  * Transfer internal timing information from one stream to another.
3072  *
3073  * This function is useful when doing stream copy.
3074  *
3075  * @param ofmt target output format for ost
3076  * @param ost output stream which needs timings copy and adjustments
3077  * @param ist reference input stream to copy timings from
3078  * @param copy_tb define from where the stream codec timebase needs to be imported
3079  */
3081  AVStream *ost, const AVStream *ist,
3082  enum AVTimebaseSource copy_tb);
3083 
3084 /**
3085  * Get the internal codec timebase from a stream.
3086  *
3087  * @param st input stream to extract the timebase from
3088  */
3090 
3091 /**
3092  * @}
3093  */
3094 
3095 #endif /* AVFORMAT_AVFORMAT_H */
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.
Definition: utils.c:4797
static void write_packet(OutputFile *of, AVPacket *pkt, OutputStream *ost, int unqueue)
Definition: ffmpeg.c:698
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:1935
full parsing and interpolation of timestamps for frames not starting on a packet boundary ...
Definition: avformat.h:797
Bytestream IO Context.
Definition: avio.h:161
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.
Definition: dump.c:108
Buffered I/O operations.
AVPacketSideDataType
Definition: avcodec.h:1227
attribute_deprecated int av_demuxer_open(AVFormatContext *ic)
Definition: utils.c:393
This structure describes decoded (raw) audio or video data.
Definition: frame.h:295
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt)
Write a packet to an output media file ensuring correct interleaving.
Definition: mux.c:1187
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:100
static void flush(AVCodecContext *avctx)
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.
Definition: utils.c:2049
int av_write_frame(AVFormatContext *s, AVPacket *pkt)
Write a packet to an output media file.
Definition: mux.c:883
const char * fmt
Definition: avisynth_c.h:861
const char * filename
Definition: avformat.h:442
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
static int read_seek(AVFormatContext *ctx, int stream_index, int64_t timestamp, int flags)
Definition: libcdio.c:153
AVRational av_guess_sample_aspect_ratio(AVFormatContext *format, AVStream *stream, AVFrame *frame)
Guess the sample aspect ratio of a frame, based on both the stream and the frame aspect ratio...
Definition: utils.c:5117
enum AVCodecID video_codec
default video codec
Definition: avformat.h:511
ff_const59 struct AVInputFormat * next
Definition: avformat.h:691
GLint GLenum type
Definition: opengl_enc.c:104
int av_get_output_timestamp(struct AVFormatContext *s, int stream, int64_t *dts, int64_t *wall)
Get timing information for the data currently output.
Definition: mux.c:1292
int avformat_open_input(AVFormatContext **ps, const char *url, ff_const59 AVInputFormat *fmt, AVDictionary **options)
Open an input stream and read the header.
Definition: utils.c:537
const char * key
static AVPacket pkt
int av_write_uncoded_frame_query(AVFormatContext *s, int stream_index)
Test whether a muxer supports uncoded frame.
Definition: mux.c:1361
int av_probe_input_buffer(AVIOContext *pb, ff_const59 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.
Definition: format.c:312
int priv_data_size
Size of private data so that it can be allocated in the wrapper.
Definition: avformat.h:701
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample format(the sample packing is implied by the sample format) and sample rate.The lists are not just lists
AVCodec.
Definition: avcodec.h:3555
This struct describes the properties of an encoded stream.
Definition: avcodec.h:4028
enum AVDurationEstimationMethod av_fmt_ctx_get_duration_estimation_method(const AVFormatContext *ctx)
Returns the method used to set ctx->duration.
Definition: options.c:165
Format I/O context.
Definition: avformat.h:1353
AVRational av_guess_frame_rate(AVFormatContext *ctx, AVStream *stream, AVFrame *frame)
Guess the frame rate, based on both the container and codec information.
Definition: utils.c:5140
static int query_codec(enum AVCodecID id, int std_compliance)
Definition: img2enc.c:229
const struct AVCodecTag * avformat_get_mov_audio_tags(void)
Definition: isom.c:671
Public dictionary API.
static int64_t start_time
Definition: ffplay.c:332
uint8_t
static int nb_streams
Definition: ffprobe.c:281
const struct AVCodecTag * avformat_get_riff_video_tags(void)
Definition: riff.c:606
enum AVCodecID av_codec_get_id(const struct AVCodecTag *const *tags, unsigned int tag)
Get the AVCodecID for the given codec tag tag.
unsigned avformat_version(void)
Return the LIBAVFORMAT_VERSION_INT constant.
Definition: utils.c:66
const char * avformat_license(void)
Return the libavformat license.
Definition: utils.c:77
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.
Definition: utils.c:5783
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf offset
#define f(width, name)
Definition: cbs_vp9.c:255
int priv_data_size
size of private data so that it can be allocated in the wrapper
Definition: avformat.h:550
static av_cold int end(AVCodecContext *avctx)
Definition: avrndec.c:90
Undefined Behavior In the C some operations are like signed integer dereferencing freed accessing outside allocated Undefined Behavior must not occur in a C it is not safe even if the output of undefined operations is unused The unsafety may seem nit picking but Optimizing compilers have in fact optimized code on the assumption that no undefined Behavior occurs Optimizing code based on wrong assumptions can and has in some cases lead to effects beyond the output of computations The signed integer overflow problem in speed critical code Code which is highly optimized and works with signed integers sometimes has the problem that often the output of the computation does not c
Definition: undefined.txt:32
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.
Definition: utils.c:5324
AVDurationEstimationMethod
The duration of a video can be estimated through various ways, and this enum can be used to know how ...
Definition: avformat.h:1331
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4524
uint8_t * av_stream_get_side_data(const AVStream *stream, enum AVPacketSideDataType type, int *size)
Get side information from stream.
Definition: utils.c:5503
int64_t duration
Definition: movenc.c:63
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.
AVFormatContext * avformat_alloc_context(void)
Allocate an AVFormatContext.
Definition: options.c:144
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.
Definition: dump.c:113
const char * avformat_configuration(void)
Return the libavformat build-time configuration.
Definition: utils.c:72
#define MAX_REORDER_DELAY
Definition: avformat.h:1102
AVProgram * av_new_program(AVFormatContext *s, int id)
Definition: utils.c:4623
char * protocol_whitelist
&#39;,&#39; separated list of allowed protocols.
Definition: avformat.h:1913
uint32_t tag
Definition: movenc.c:1534
int avformat_network_init(void)
Do global initialization of network libraries.
Definition: utils.c:5054
const struct AVCodecTag * avformat_get_riff_audio_tags(void)
Definition: riff.c:611
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:145
int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size)
Generate an SDP for an RTP session.
Definition: sdp.c:842
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.
Definition: utils.c:308
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.
Definition: format.c:38
const AVClass * avformat_get_class(void)
Get the AVClass for AVFormatContext.
Definition: options.c:170
ptrdiff_t size
Definition: opengl_enc.c:100
static int interleave_packet(AVFormatContext *s, AVPacket *out, AVPacket *in, int flush)
Interleave an AVPacket correctly so it can be muxed.
Definition: mux.c:1176
full parsing and repack with timestamp and position generation by parser for raw this assumes that ea...
Definition: avformat.h:799
Duration estimated from bitrate (less accurate)
Definition: avformat.h:1334
int av_append_packet(AVIOContext *s, AVPacket *pkt, int size)
Read data and append it to the current content of the AVPacket.
Definition: utils.c:318
const AVOutputFormat * av_muxer_iterate(void **opaque)
Iterate over all registered muxers.
Definition: allformats.c:514
const struct AVCodecTag * avformat_get_mov_video_tags(void)
Definition: isom.c:666
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, streams, container, programs, metadata, side data, codec and time base.
Definition: dump.c:581
Callback for checking whether to abort blocking functions.
Definition: avio.h:58
int av_find_best_stream(AVFormatContext *ic, enum AVMediaType type, int wanted_stream_nb, int related_stream, AVCodec **decoder_ret, int flags)
Find the "best" stream in the file.
Definition: utils.c:4246
#define ff_const59
The ff_const59 define is not part of the public API and will be removed without further warning...
Definition: avformat.h:544
AVRational av_stream_get_codec_timebase(const AVStream *st)
Get the internal codec timebase from a stream.
Definition: utils.c:5845
ff_const59 AVInputFormat * av_probe_input_format(ff_const59 AVProbeData *pd, int is_opened)
Guess the file format.
Definition: format.c:216
AVProgram * av_find_program_from_stream(AVFormatContext *ic, AVProgram *last, int s)
Find the programs which belong to a given stream.
Definition: utils.c:4229
ff_const59 AVInputFormat * av_probe_input_format2(ff_const59 AVProbeData *pd, int is_opened, int *score_max)
Guess the file format.
Definition: format.c:205
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: avcodec.h:217
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags)
Get the index for a specific timestamp.
Definition: utils.c:2166
const AVIOInterruptCB int_cb
Definition: ffmpeg.c:489
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.
Definition: dump.c:74
struct AVCodecParser * parser
Definition: avcodec.h:5190
char * url
input or output URL.
Definition: avformat.h:1449
const char * r
Definition: vf_curves.c:114
unsigned int pos
Definition: spdifenc.c:410
struct AVCodecParserContext * av_stream_get_parser(const AVStream *s)
Definition: utils.c:149
int av_read_play(AVFormatContext *s)
Start playing a network-based stream (e.g.
Definition: utils.c:4314
ff_const59 AVInputFormat * av_find_input_format(const char *short_name)
Find AVInputFormat based on the short name of the input format.
Definition: format.c:118
int avformat_alloc_output_context2(AVFormatContext **ctx, ff_const59 AVOutputFormat *oformat, const char *format_name, const char *filename)
Allocate an AVFormatContext for an output format.
Definition: mux.c:148
int skip_estimate_duration_from_pts
Skip duration calcuation in estimate_timings_from_pts.
Definition: avformat.h:1962
New fields can be added to the end with minor version bumps.
Definition: avformat.h:1270
void * opaque
User data.
Definition: avformat.h:1859
Only parse headers, do not repack.
Definition: avformat.h:796
int avformat_query_codec(const AVOutputFormat *ofmt, enum AVCodecID codec_id, int std_compliance)
Test if the given container can store a codec.
Definition: utils.c:5036
static float distance(float x, float y, int band)
const char * mime_type
mime_type, when known.
Definition: avformat.h:445
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:444
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:443
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...
Definition: utils.c:154
int av_read_pause(AVFormatContext *s)
Pause a network-based stream (e.g.
Definition: utils.c:4323
MIPS optimizations info
Definition: mips.txt:2
static void callback(void *priv_data, int index, uint8_t *buf, int buf_size, int64_t time, enum dshowDeviceType devtype)
Definition: dshow.c:161
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.
Definition: mux.c:516
void av_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx)
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:1321
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.
Definition: utils.c:5518
int max_streams
The maximum number of streams.
Definition: avformat.h:1955
typedef void(APIENTRY *FF_PFNGLACTIVETEXTUREPROC)(GLenum texture)
int av_find_default_stream_index(AVFormatContext *s)
Definition: utils.c:1890
static int write_trailer(AVFormatContext *s1)
Definition: v4l2enc.c:94
enum AVCodecID av_guess_codec(ff_const59 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.
Definition: format.c:87
Duration estimated from a stream with a known duration.
Definition: avformat.h:1333
AVFormatContext * ctx
Definition: movenc.c:48
ff_const59 AVInputFormat * av_probe_input_format3(ff_const59 AVProbeData *pd, int is_opened, int *score_ret)
Guess the file format.
Definition: format.c:128
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
#define s(width, name)
Definition: cbs_vp9.c:257
uint8_t * av_stream_new_side_data(AVStream *stream, enum AVPacketSideDataType type, int size)
Allocate new information from stream.
Definition: utils.c:5554
enum AVCodecID codec_id
Definition: vaapi_decode.c:369
Libavformat version macros.
int(* AVOpenCallback)(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags, const AVIOInterruptCB *int_cb, AVDictionary **options)
Definition: avformat.h:1324
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.
Definition: mux.c:496
const AVInputFormat * av_demuxer_iterate(void **opaque)
Iterate over all registered demuxers.
Definition: allformats.c:531
int av_get_frame_filename(char *buf, int buf_size, const char *path, int number)
Definition: utils.c:4792
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:527
Stream structure.
Definition: avformat.h:876
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
int avformat_queue_attached_pictures(AVFormatContext *s)
Definition: utils.c:479
int avformat_network_deinit(void)
Undo the initialization done by avformat_network_init.
Definition: utils.c:5066
static AVInputFormat * iformat
Definition: ffprobe.c:258
Libavcodec external API header.
int av_probe_input_buffer2(AVIOContext *pb, ff_const59 AVInputFormat **fmt, const char *url, void *logctx, unsigned int offset, unsigned int max_probe_size)
Probe a bytestream to determine the input format.
Definition: format.c:222
AVIOContext * pb
I/O context.
Definition: avformat.h:1395
main external API structure.
Definition: avcodec.h:1621
int av_filename_number_test(const char *filename)
Check whether filename actually is a numbered sequence generator.
Definition: utils.c:325
int av_get_frame_filename2(char *buf, int buf_size, const char *path, int number, int flags)
Return in &#39;buf&#39; the path with &#39;d&#39; replaced by a number.
Definition: utils.c:4737
void(* io_close)(struct AVFormatContext *s, AVIOContext *pb)
A callback for closing the streams opened with AVFormatContext.io_open().
Definition: avformat.h:1941
static const AVClass av_class
Definition: options.c:134
uint8_t pi<< 24) CONV_FUNC_GROUP(AV_SAMPLE_FMT_FLT, float, AV_SAMPLE_FMT_U8, uint8_t,(*(const uint8_t *) pi-0x80)*(1.0f/(1<< 7))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_DBL, double, AV_SAMPLE_FMT_U8, uint8_t,(*(const uint8_t *) pi-0x80)*(1.0/(1<< 7))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_U8, uint8_t, AV_SAMPLE_FMT_S16, int16_t,(*(const int16_t *) pi >> 8)+0x80) CONV_FUNC_GROUP(AV_SAMPLE_FMT_FLT, float, AV_SAMPLE_FMT_S16, int16_t,*(const int16_t *) pi *(1.0f/(1<< 15))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_DBL, double, AV_SAMPLE_FMT_S16, int16_t,*(const int16_t *) pi *(1.0/(1<< 15))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_U8, uint8_t, AV_SAMPLE_FMT_S32, int32_t,(*(const int32_t *) pi >> 24)+0x80) CONV_FUNC_GROUP(AV_SAMPLE_FMT_FLT, float, AV_SAMPLE_FMT_S32, int32_t,*(const int32_t *) pi *(1.0f/(1U<< 31))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_DBL, double, AV_SAMPLE_FMT_S32, int32_t,*(const int32_t *) pi *(1.0/(1U<< 31))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_U8, uint8_t, AV_SAMPLE_FMT_FLT, float, av_clip_uint8(lrintf(*(const float *) pi *(1<< 7))+0x80)) CONV_FUNC_GROUP(AV_SAMPLE_FMT_S16, int16_t, AV_SAMPLE_FMT_FLT, float, av_clip_int16(lrintf(*(const float *) pi *(1<< 15)))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_S32, int32_t, AV_SAMPLE_FMT_FLT, float, av_clipl_int32(llrintf(*(const float *) pi *(1U<< 31)))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_U8, uint8_t, AV_SAMPLE_FMT_DBL, double, av_clip_uint8(lrint(*(const double *) pi *(1<< 7))+0x80)) CONV_FUNC_GROUP(AV_SAMPLE_FMT_S16, int16_t, AV_SAMPLE_FMT_DBL, double, av_clip_int16(lrint(*(const double *) pi *(1<< 15)))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_S32, int32_t, AV_SAMPLE_FMT_DBL, double, av_clipl_int32(llrint(*(const double *) pi *(1U<< 31))))#define SET_CONV_FUNC_GROUP(ofmt, ifmt) static void set_generic_function(AudioConvert *ac){}void ff_audio_convert_free(AudioConvert **ac){if(!*ac) return;ff_dither_free(&(*ac) ->dc);av_freep(ac);}AudioConvert *ff_audio_convert_alloc(AVAudioResampleContext *avr, enum AVSampleFormat out_fmt, enum AVSampleFormat in_fmt, int channels, int sample_rate, int apply_map){AudioConvert *ac;int in_planar, out_planar;ac=av_mallocz(sizeof(*ac));if(!ac) return NULL;ac->avr=avr;ac->out_fmt=out_fmt;ac->in_fmt=in_fmt;ac->channels=channels;ac->apply_map=apply_map;if(avr->dither_method!=AV_RESAMPLE_DITHER_NONE &&av_get_packed_sample_fmt(out_fmt)==AV_SAMPLE_FMT_S16 &&av_get_bytes_per_sample(in_fmt) > 2){ac->dc=ff_dither_alloc(avr, out_fmt, in_fmt, channels, sample_rate, apply_map);if(!ac->dc){av_free(ac);return NULL;}return ac;}in_planar=ff_sample_fmt_is_planar(in_fmt, channels);out_planar=ff_sample_fmt_is_planar(out_fmt, channels);if(in_planar==out_planar){ac->func_type=CONV_FUNC_TYPE_FLAT;ac->planes=in_planar?ac->channels:1;}else if(in_planar) ac->func_type=CONV_FUNC_TYPE_INTERLEAVE;else ac->func_type=CONV_FUNC_TYPE_DEINTERLEAVE;set_generic_function(ac);if(ARCH_AARCH64) ff_audio_convert_init_aarch64(ac);if(ARCH_ARM) ff_audio_convert_init_arm(ac);if(ARCH_X86) ff_audio_convert_init_x86(ac);return ac;}int ff_audio_convert(AudioConvert *ac, AudioData *out, AudioData *in){int use_generic=1;int len=in->nb_samples;int p;if(ac->dc){av_log(ac->avr, AV_LOG_TRACE,"%d samples - audio_convert: %s to %s (dithered)\n", len, av_get_sample_fmt_name(ac->in_fmt), av_get_sample_fmt_name(ac->out_fmt));return ff_convert_dither(ac-> in
Describe the class of an AVClass context structure.
Definition: log.h:67
int index
Definition: gxfenc.c:89
enum AVCodecID subtitle_codec
default subtitle codec
Definition: avformat.h:512
ff_const59 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...
Definition: format.c:51
Rational number (pair of numerator and denominator).
Definition: rational.h:58
AVMediaType
Definition: avutil.h:199
int max_probe_packets
Maximum number of packets that can be probed.
Definition: avformat.h:1969
void avformat_free_context(AVFormatContext *s)
Free an AVFormatContext and all its streams.
Definition: utils.c:4453
This structure contains the data a format has to probe a file.
Definition: avformat.h:441
int av_read_frame(AVFormatContext *s, AVPacket *pkt)
Return the next frame of a stream.
Definition: utils.c:1777
List of devices.
Definition: avdevice.h:460
AVTimebaseSource
Definition: avformat.h:3075
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.
Definition: utils.c:2547
full parsing and repack of the first frame only, only implemented for H.264 currently ...
Definition: avformat.h:798
int raw_codec_id
Raw demuxers store their codec ID here.
Definition: avformat.h:696
#define flags(name, subs,...)
Definition: cbs_av1.c:564
static int format_name(const char *buf, char **s, int index, const char *varname)
Definition: hlsenc.c:1807
uint8_t level
Definition: svq3.c:209
#define attribute_deprecated
Definition: attributes.h:94
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
Duration accurately estimated from PTSes.
Definition: avformat.h:1332
#define av_warn_unused_result
Definition: attributes.h:56
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
Seek to the keyframe at timestamp.
Definition: utils.c:2524
full parsing and repack
Definition: avformat.h:795
static AVStream * ost
int
const OptionDef options[]
Definition: ffmpeg_opt.c:3439
int av_interleaved_write_uncoded_frame(AVFormatContext *s, int stream_index, AVFrame *frame)
Write an uncoded frame to an output media file.
Definition: mux.c:1355
struct AVPacketList * next
Definition: avformat.h:2028
enum AVCodecID data_codec
default data codec
Definition: avformat.h:610
int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options)
Read packets of a media file to get stream information.
Definition: utils.c:3617
AVStreamParseType
Definition: avformat.h:793
void avformat_close_input(AVFormatContext **s)
Close an opened input AVFormatContext.
Definition: utils.c:4496
int av_write_uncoded_frame(AVFormatContext *s, int stream_index, AVFrame *frame)
Write an uncoded frame to an output media file.
Definition: mux.c:1349
enum AVCodecID audio_codec
default audio codec
Definition: avformat.h:510
static void write_header(FFV1Context *f)
Definition: ffv1enc.c:346
AVDiscard
Definition: avcodec.h:820
int av_write_trailer(AVFormatContext *s)
Write the stream trailer to an output media file and free the file private data.
Definition: mux.c:1245
char * protocol_blacklist
&#39;,&#39; separated list of disallowed protocols.
Definition: avformat.h:1948
int avformat_flush(AVFormatContext *s)
Discard all internally buffered data.
Definition: utils.c:2604
FILE * out
Definition: movenc.c:54
void INT64 start
Definition: avisynth_c.h:766
ff_const59 struct AVOutputFormat * next
Definition: avformat.h:546
int copy_tb
Definition: ffmpeg_opt.c:163
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.
Definition: dump.c:79
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 id
Following API allows user to probe device capabilities (supported codecs, pixel formats, sample formats, resolutions, channel counts, etc).
Definition: avdevice.h:400
This structure stores compressed data.
Definition: avcodec.h:1510
#define MAX_STD_TIMEBASES
Definition: avformat.h:1035
int64_t av_stream_get_end_pts(const AVStream *st)
Returns the pts of the last muxed packet + its duration.
Definition: utils.c:141
const char * name
Definition: opengl_enc.c:102