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