FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 I/O and Muxing/Demuxing Library
32  * @{
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). Before using lavf, you need to call
40  * av_register_all() to register all compiled muxers, demuxers and protocols.
41  * Unless you are absolutely sure you won't use libavformat's network
42  * capabilities, you should also call avformat_network_init().
43  *
44  * A supported input format is described by an AVInputFormat struct, conversely
45  * an output format is described by AVOutputFormat. You can iterate over all
46  * registered input/output formats using the av_iformat_next() /
47  * av_oformat_next() functions. The protocols layer is not part of the public
48  * API, so you can only get the names of supported protocols with the
49  * avio_enum_protocols() function.
50  *
51  * Main lavf structure used for both muxing and demuxing is AVFormatContext,
52  * which exports all information about the file being read or written. As with
53  * most Libavformat structures, its size is not part of public ABI, so it cannot be
54  * allocated on stack or directly with av_malloc(). To create an
55  * AVFormatContext, use avformat_alloc_context() (some functions, like
56  * avformat_open_input() might do that for you).
57  *
58  * Most importantly an AVFormatContext contains:
59  * @li the @ref AVFormatContext.iformat "input" or @ref AVFormatContext.oformat
60  * "output" format. It is either autodetected or set by user for input;
61  * always set by user for output.
62  * @li an @ref AVFormatContext.streams "array" of AVStreams, which describe all
63  * elementary streams stored in the file. AVStreams are typically referred to
64  * using their index in this array.
65  * @li an @ref AVFormatContext.pb "I/O context". It is either opened by lavf or
66  * set by user for input, always set by user for output (unless you are dealing
67  * with an AVFMT_NOFILE format).
68  *
69  * @section lavf_options Passing options to (de)muxers
70  * Lavf allows to configure muxers and demuxers using the @ref avoptions
71  * mechanism. Generic (format-independent) libavformat options are provided by
72  * AVFormatContext, they can be examined from a user program by calling
73  * av_opt_next() / av_opt_find() on an allocated AVFormatContext (or its AVClass
74  * from avformat_get_class()). Private (format-specific) options are provided by
75  * AVFormatContext.priv_data if and only if AVInputFormat.priv_class /
76  * AVOutputFormat.priv_class of the corresponding format struct is non-NULL.
77  * Further options may be provided by the @ref AVFormatContext.pb "I/O context",
78  * if its AVClass is non-NULL, and the protocols layer. See the discussion on
79  * nesting in @ref avoptions documentation to learn how to access those.
80  *
81  * @defgroup lavf_decoding Demuxing
82  * @{
83  * Demuxers read a media file and split it into chunks of data (@em packets). A
84  * @ref AVPacket "packet" contains one or more encoded frames which belongs to a
85  * single elementary stream. In the lavf API this process is represented by the
86  * avformat_open_input() function for opening a file, av_read_frame() for
87  * reading a single packet and finally avformat_close_input(), which does the
88  * cleanup.
89  *
90  * @section lavf_decoding_open Opening a media file
91  * The minimum information required to open a file is its URL or filename, which
92  * is passed to avformat_open_input(), as in the following code:
93  * @code
94  * const char *url = "in.mp3";
95  * AVFormatContext *s = NULL;
96  * int ret = avformat_open_input(&s, url, NULL, NULL);
97  * if (ret < 0)
98  * abort();
99  * @endcode
100  * The above code attempts to allocate an AVFormatContext, open the
101  * specified file (autodetecting the format) and read the header, exporting the
102  * information stored there into s. Some formats do not have a header or do not
103  * store enough information there, so it is recommended that you call the
104  * avformat_find_stream_info() function which tries to read and decode a few
105  * frames to find missing information.
106  *
107  * In some cases you might want to preallocate an AVFormatContext yourself with
108  * avformat_alloc_context() and do some tweaking on it before passing it to
109  * avformat_open_input(). One such case is when you want to use custom functions
110  * for reading input data instead of lavf internal I/O layer.
111  * To do that, create your own AVIOContext with avio_alloc_context(), passing
112  * your reading callbacks to it. Then set the @em pb field of your
113  * AVFormatContext to newly created AVIOContext.
114  *
115  * Since the format of the opened file is in general not known until after
116  * avformat_open_input() has returned, it is not possible to set demuxer private
117  * options on a preallocated context. Instead, the options should be passed to
118  * avformat_open_input() wrapped in an AVDictionary:
119  * @code
120  * AVDictionary *options = NULL;
121  * av_dict_set(&options, "video_size", "640x480", 0);
122  * av_dict_set(&options, "pixel_format", "rgb24", 0);
123  *
124  * if (avformat_open_input(&s, url, NULL, &options) < 0)
125  * abort();
126  * av_dict_free(&options);
127  * @endcode
128  * This code passes the private options 'video_size' and 'pixel_format' to the
129  * demuxer. They would be necessary for e.g. the rawvideo demuxer, since it
130  * cannot know how to interpret raw video data otherwise. If the format turns
131  * out to be something different than raw video, those options will not be
132  * recognized by the demuxer and therefore will not be applied. Such unrecognized
133  * options are then returned in the options dictionary (recognized options are
134  * consumed). The calling program can handle such unrecognized options as it
135  * wishes, e.g.
136  * @code
137  * AVDictionaryEntry *e;
138  * if (e = av_dict_get(options, "", NULL, AV_DICT_IGNORE_SUFFIX)) {
139  * fprintf(stderr, "Option %s not recognized by the demuxer.\n", e->key);
140  * abort();
141  * }
142  * @endcode
143  *
144  * After you have finished reading the file, you must close it with
145  * avformat_close_input(). It will free everything associated with the file.
146  *
147  * @section lavf_decoding_read Reading from an opened file
148  * Reading data from an opened AVFormatContext is done by repeatedly calling
149  * av_read_frame() on it. Each call, if successful, will return an AVPacket
150  * containing encoded data for one AVStream, identified by
151  * AVPacket.stream_index. This packet may be passed straight into the libavcodec
152  * decoding functions avcodec_decode_video2(), avcodec_decode_audio4() or
153  * avcodec_decode_subtitle2() if the caller wishes to decode the data.
154  *
155  * AVPacket.pts, AVPacket.dts and AVPacket.duration timing information will be
156  * set if known. They may also be unset (i.e. AV_NOPTS_VALUE for
157  * pts/dts, 0 for duration) if the stream does not provide them. The timing
158  * information will be in AVStream.time_base units, i.e. it has to be
159  * multiplied by the timebase to convert them to seconds.
160  *
161  * If AVPacket.buf is set on the returned packet, then the packet is
162  * allocated dynamically and the user may keep it indefinitely.
163  * Otherwise, if AVPacket.buf is NULL, the packet data is backed by a
164  * static storage somewhere inside the demuxer and the packet is only valid
165  * until the next av_read_frame() call or closing the file. If the caller
166  * requires a longer lifetime, av_dup_packet() will make an av_malloc()ed copy
167  * of it.
168  * In both cases, the packet must be freed with av_free_packet() when it is no
169  * longer needed.
170  *
171  * @section lavf_decoding_seek Seeking
172  * @}
173  *
174  * @defgroup lavf_encoding Muxing
175  * @{
176  * Muxers take encoded data in the form of @ref AVPacket "AVPackets" and write
177  * it into files or other output bytestreams in the specified container format.
178  *
179  * The main API functions for muxing are avformat_write_header() for writing the
180  * file header, av_write_frame() / av_interleaved_write_frame() for writing the
181  * packets and av_write_trailer() for finalizing the file.
182  *
183  * At the beginning of the muxing process, the caller must first call
184  * avformat_alloc_context() to create a muxing context. The caller then sets up
185  * the muxer by filling the various fields in this context:
186  *
187  * - The @ref AVFormatContext.oformat "oformat" field must be set to select the
188  * muxer that will be used.
189  * - Unless the format is of the AVFMT_NOFILE type, the @ref AVFormatContext.pb
190  * "pb" field must be set to an opened IO context, either returned from
191  * avio_open2() or a custom one.
192  * - Unless the format is of the AVFMT_NOSTREAMS type, at least one stream must
193  * be created with the avformat_new_stream() function. The caller should fill
194  * the @ref AVStream.codec "stream codec context" information, such as the
195  * codec @ref AVCodecContext.codec_type "type", @ref AVCodecContext.codec_id
196  * "id" and other parameters (e.g. width / height, the pixel or sample format,
197  * etc.) as known. The @ref AVStream.time_base "stream timebase" should
198  * be set to the timebase that the caller desires to use for this stream (note
199  * that the timebase actually used by the muxer can be different, as will be
200  * described later).
201  * - The caller may fill in additional information, such as @ref
202  * AVFormatContext.metadata "global" or @ref AVStream.metadata "per-stream"
203  * metadata, @ref AVFormatContext.chapters "chapters", @ref
204  * AVFormatContext.programs "programs", etc. as described in the
205  * AVFormatContext documentation. Whether such information will actually be
206  * stored in the output depends on what the container format and the muxer
207  * support.
208  *
209  * When the muxing context is fully set up, the caller must call
210  * avformat_write_header() to initialize the muxer internals and write the file
211  * header. Whether anything actually is written to the IO context at this step
212  * depends on the muxer, but this function must always be called. Any muxer
213  * private options must be passed in the options parameter to this function.
214  *
215  * The data is then sent to the muxer by repeatedly calling av_write_frame() or
216  * av_interleaved_write_frame() (consult those functions' documentation for
217  * discussion on the difference between them; only one of them may be used with
218  * a single muxing context, they should not be mixed). Do note that the timing
219  * information on the packets sent to the muxer must be in the corresponding
220  * AVStream's timebase. That timebase is set by the muxer (in the
221  * avformat_write_header() step) and may be different from the timebase
222  * requested by the caller.
223  *
224  * Once all the data has been written, the caller must call av_write_trailer()
225  * to flush any buffered packets and finalize the output file, then close the IO
226  * context (if any) and finally free the muxing context with
227  * avformat_free_context().
228  * @}
229  *
230  * @defgroup lavf_io I/O Read/Write
231  * @{
232  * @}
233  *
234  * @defgroup lavf_codec Demuxers
235  * @{
236  * @defgroup lavf_codec_native Native Demuxers
237  * @{
238  * @}
239  * @defgroup lavf_codec_wrappers External library wrappers
240  * @{
241  * @}
242  * @}
243  * @defgroup lavf_protos I/O Protocols
244  * @{
245  * @}
246  * @defgroup lavf_internal Internal
247  * @{
248  * @}
249  * @}
250  *
251  */
252 
253 #include <time.h>
254 #include <stdio.h> /* FILE */
255 #include "libavcodec/avcodec.h"
256 #include "libavutil/dict.h"
257 #include "libavutil/log.h"
258 
259 #include "avio.h"
260 #include "libavformat/version.h"
261 
262 struct AVFormatContext;
263 
264 struct AVDeviceInfoList;
266 
267 /**
268  * @defgroup metadata_api Public Metadata API
269  * @{
270  * @ingroup libavf
271  * The metadata API allows libavformat to export metadata tags to a client
272  * application when demuxing. Conversely it allows a client application to
273  * set metadata when muxing.
274  *
275  * Metadata is exported or set as pairs of key/value strings in the 'metadata'
276  * fields of the AVFormatContext, AVStream, AVChapter and AVProgram structs
277  * using the @ref lavu_dict "AVDictionary" API. Like all strings in FFmpeg,
278  * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata
279  * exported by demuxers isn't checked to be valid UTF-8 in most cases.
280  *
281  * Important concepts to keep in mind:
282  * - Keys are unique; there can never be 2 tags with the same key. This is
283  * also meant semantically, i.e., a demuxer should not knowingly produce
284  * several keys that are literally different but semantically identical.
285  * E.g., key=Author5, key=Author6. In this example, all authors must be
286  * placed in the same tag.
287  * - Metadata is flat, not hierarchical; there are no subtags. If you
288  * want to store, e.g., the email address of the child of producer Alice
289  * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
290  * - Several modifiers can be applied to the tag name. This is done by
291  * appending a dash character ('-') and the modifier name in the order
292  * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
293  * - language -- a tag whose value is localized for a particular language
294  * is appended with the ISO 639-2/B 3-letter language code.
295  * For example: Author-ger=Michael, Author-eng=Mike
296  * The original/default language is in the unqualified "Author" tag.
297  * A demuxer should set a default if it sets any translated tag.
298  * - sorting -- a modified version of a tag that should be used for
299  * sorting will have '-sort' appended. E.g. artist="The Beatles",
300  * artist-sort="Beatles, The".
301  * - Some protocols and demuxers support metadata updates. After a successful
302  * call to av_read_packet(), AVFormatContext.event_flags or AVStream.event_flags
303  * will be updated to indicate if metadata changed. In order to detect metadata
304  * changes on a stream, you need to loop through all streams in the AVFormatContext
305  * and check their individual event_flags.
306  *
307  * - Demuxers attempt to export metadata in a generic format, however tags
308  * with no generic equivalents are left as they are stored in the container.
309  * Follows a list of generic tag names:
310  *
311  @verbatim
312  album -- name of the set this work belongs to
313  album_artist -- main creator of the set/album, if different from artist.
314  e.g. "Various Artists" for compilation albums.
315  artist -- main creator of the work
316  comment -- any additional description of the file.
317  composer -- who composed the work, if different from artist.
318  copyright -- name of copyright holder.
319  creation_time-- date when the file was created, preferably in ISO 8601.
320  date -- date when the work was created, preferably in ISO 8601.
321  disc -- number of a subset, e.g. disc in a multi-disc collection.
322  encoder -- name/settings of the software/hardware that produced the file.
323  encoded_by -- person/group who created the file.
324  filename -- original name of the file.
325  genre -- <self-evident>.
326  language -- main language in which the work is performed, preferably
327  in ISO 639-2 format. Multiple languages can be specified by
328  separating them with commas.
329  performer -- artist who performed the work, if different from artist.
330  E.g for "Also sprach Zarathustra", artist would be "Richard
331  Strauss" and performer "London Philharmonic Orchestra".
332  publisher -- name of the label/publisher.
333  service_name -- name of the service in broadcasting (channel name).
334  service_provider -- name of the service provider in broadcasting.
335  title -- name of the work.
336  track -- number of this work in the set, can be in form current/total.
337  variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
338  @endverbatim
339  *
340  * Look in the examples section for an application example how to use the Metadata API.
341  *
342  * @}
343  */
344 
345 /* packet functions */
346 
347 
348 /**
349  * Allocate and read the payload of a packet and initialize its
350  * fields with default values.
351  *
352  * @param s associated IO context
353  * @param pkt packet
354  * @param size desired payload size
355  * @return >0 (read size) if OK, AVERROR_xxx otherwise
356  */
358 
359 
360 /**
361  * Read data and append it to the current content of the AVPacket.
362  * If pkt->size is 0 this is identical to av_get_packet.
363  * Note that this uses av_grow_packet and thus involves a realloc
364  * which is inefficient. Thus this function should only be used
365  * when there is no reasonable way to know (an upper bound of)
366  * the final size.
367  *
368  * @param s associated IO context
369  * @param pkt packet
370  * @param size amount of data to read
371  * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
372  * will not be lost even if an error occurs.
373  */
375 
376 #if FF_API_LAVF_FRAC
377 /*************************************************/
378 /* fractional numbers for exact pts handling */
379 
380 /**
381  * The exact value of the fractional number is: 'val + num / den'.
382  * num is assumed to be 0 <= num < den.
383  */
384 typedef struct AVFrac {
385  int64_t val, num, den;
386 } AVFrac;
387 #endif
388 
389 /*************************************************/
390 /* input/output formats */
391 
392 struct AVCodecTag;
393 
394 /**
395  * This structure contains the data a format has to probe a file.
396  */
397 typedef struct AVProbeData {
398  const char *filename;
399  unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
400  int buf_size; /**< Size of buf except extra allocated bytes */
401  const char *mime_type; /**< mime_type, when known. */
402 } AVProbeData;
403 
404 #define AVPROBE_SCORE_RETRY (AVPROBE_SCORE_MAX/4)
405 #define AVPROBE_SCORE_STREAM_RETRY (AVPROBE_SCORE_MAX/4-1)
406 
407 #define AVPROBE_SCORE_EXTENSION 50 ///< score for file extension
408 #define AVPROBE_SCORE_MIME 75 ///< score for file mime type
409 #define AVPROBE_SCORE_MAX 100 ///< maximum score
410 
411 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
412 
413 /// Demuxer will use avio_open, no opened file should be provided by the caller.
414 #define AVFMT_NOFILE 0x0001
415 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
416 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
417 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
418  raw picture data. */
419 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
420 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
421 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
422 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
423 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
424 #define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
425 #define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */
426 #define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fall back on binary search via read_timestamp */
427 #define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fall back on generic search */
428 #define AVFMT_NO_BYTE_SEEK 0x8000 /**< Format does not allow seeking by bytes */
429 #define AVFMT_ALLOW_FLUSH 0x10000 /**< Format allows flushing. If not set, the muxer will not receive a NULL packet in the write_packet function. */
430 #if LIBAVFORMAT_VERSION_MAJOR <= 54
431 #define AVFMT_TS_NONSTRICT 0x8020000 //we try to be compatible to the ABIs of ffmpeg and major forks
432 #else
433 #define AVFMT_TS_NONSTRICT 0x20000
434 #endif
435  /**< Format does not require strictly
436  increasing timestamps, but they must
437  still be monotonic */
438 #define AVFMT_TS_NEGATIVE 0x40000 /**< Format allows muxing negative
439  timestamps. If not set the timestamp
440  will be shifted in av_write_frame and
441  av_interleaved_write_frame so they
442  start from 0.
443  The user or muxer can override this through
444  AVFormatContext.avoid_negative_ts
445  */
446 
447 #define AVFMT_SEEK_TO_PTS 0x4000000 /**< Seeking is based on PTS */
448 
449 /**
450  * @addtogroup lavf_encoding
451  * @{
452  */
453 typedef struct AVOutputFormat {
454  const char *name;
455  /**
456  * Descriptive name for the format, meant to be more human-readable
457  * than name. You should use the NULL_IF_CONFIG_SMALL() macro
458  * to define it.
459  */
460  const char *long_name;
461  const char *mime_type;
462  const char *extensions; /**< comma-separated filename extensions */
463  /* output support */
464  enum AVCodecID audio_codec; /**< default audio codec */
465  enum AVCodecID video_codec; /**< default video codec */
466  enum AVCodecID subtitle_codec; /**< default subtitle codec */
467  /**
468  * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
469  * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
470  * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS, AVFMT_ALLOW_FLUSH,
471  * AVFMT_TS_NONSTRICT
472  */
473  int flags;
474 
475  /**
476  * List of supported codec_id-codec_tag pairs, ordered by "better
477  * choice first". The arrays are all terminated by AV_CODEC_ID_NONE.
478  */
479  const struct AVCodecTag * const *codec_tag;
480 
481 
482  const AVClass *priv_class; ///< AVClass for the private context
483 
484  /*****************************************************************
485  * No fields below this line are part of the public API. They
486  * may not be used outside of libavformat and can be changed and
487  * removed at will.
488  * New public fields should be added right above.
489  *****************************************************************
490  */
492  /**
493  * size of private data so that it can be allocated in the wrapper
494  */
496 
497  int (*write_header)(struct AVFormatContext *);
498  /**
499  * Write a packet. If AVFMT_ALLOW_FLUSH is set in flags,
500  * pkt can be NULL in order to flush data buffered in the muxer.
501  * When flushing, return 0 if there still is more data to flush,
502  * or 1 if everything was flushed and there is no more buffered
503  * data.
504  */
506  int (*write_trailer)(struct AVFormatContext *);
507  /**
508  * Currently only used to set pixel format if not YUV420P.
509  */
511  AVPacket *in, int flush);
512  /**
513  * Test if the given codec can be stored in this container.
514  *
515  * @return 1 if the codec is supported, 0 if it is not.
516  * A negative number if unknown.
517  * MKTAG('A', 'P', 'I', 'C') if the codec is only supported as AV_DISPOSITION_ATTACHED_PIC
518  */
519  int (*query_codec)(enum AVCodecID id, int std_compliance);
520 
521  void (*get_output_timestamp)(struct AVFormatContext *s, int stream,
522  int64_t *dts, int64_t *wall);
523  /**
524  * Allows sending messages from application to device.
525  */
526  int (*control_message)(struct AVFormatContext *s, int type,
527  void *data, size_t data_size);
528 
529  /**
530  * Write an uncoded AVFrame.
531  *
532  * See av_write_uncoded_frame() for details.
533  *
534  * The library will free *frame afterwards, but the muxer can prevent it
535  * by setting the pointer to NULL.
536  */
537  int (*write_uncoded_frame)(struct AVFormatContext *, int stream_index,
538  AVFrame **frame, unsigned flags);
539  /**
540  * Returns device list with it properties.
541  * @see avdevice_list_devices() for more details.
542  */
543  int (*get_device_list)(struct AVFormatContext *s, struct AVDeviceInfoList *device_list);
544  /**
545  * Initialize device capabilities submodule.
546  * @see avdevice_capabilities_create() for more details.
547  */
549  /**
550  * Free device capabilities submodule.
551  * @see avdevice_capabilities_free() for more details.
552  */
554  enum AVCodecID data_codec; /**< default data codec */
556 /**
557  * @}
558  */
559 
560 /**
561  * @addtogroup lavf_decoding
562  * @{
563  */
564 typedef struct AVInputFormat {
565  /**
566  * A comma separated list of short names for the format. New names
567  * may be appended with a minor bump.
568  */
569  const char *name;
570 
571  /**
572  * Descriptive name for the format, meant to be more human-readable
573  * than name. You should use the NULL_IF_CONFIG_SMALL() macro
574  * to define it.
575  */
576  const char *long_name;
577 
578  /**
579  * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
580  * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
581  * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK, AVFMT_SEEK_TO_PTS.
582  */
583  int flags;
584 
585  /**
586  * If extensions are defined, then no probe is done. You should
587  * usually not use extension format guessing because it is not
588  * reliable enough
589  */
590  const char *extensions;
591 
592  const struct AVCodecTag * const *codec_tag;
593 
594  const AVClass *priv_class; ///< AVClass for the private context
595 
596  /**
597  * Comma-separated list of mime types.
598  * It is used check for matching mime types while probing.
599  * @see av_probe_input_format2
600  */
601  const char *mime_type;
602 
603  /*****************************************************************
604  * No fields below this line are part of the public API. They
605  * may not be used outside of libavformat and can be changed and
606  * removed at will.
607  * New public fields should be added right above.
608  *****************************************************************
609  */
611 
612  /**
613  * Raw demuxers store their codec ID here.
614  */
616 
617  /**
618  * Size of private data so that it can be allocated in the wrapper.
619  */
621 
622  /**
623  * Tell if a given file has a chance of being parsed as this format.
624  * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
625  * big so you do not have to check for that unless you need more.
626  */
628 
629  /**
630  * Read the format header and initialize the AVFormatContext
631  * structure. Return 0 if OK. 'avformat_new_stream' should be
632  * called to create new streams.
633  */
634  int (*read_header)(struct AVFormatContext *);
635 
636  /**
637  * Read one packet and put it in 'pkt'. pts and flags are also
638  * set. 'avformat_new_stream' can be called only if the flag
639  * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
640  * background thread).
641  * @return 0 on success, < 0 on error.
642  * When returning an error, pkt must not have been allocated
643  * or must be freed before returning
644  */
646 
647  /**
648  * Close the stream. The AVFormatContext and AVStreams are not
649  * freed by this function
650  */
651  int (*read_close)(struct AVFormatContext *);
652 
653  /**
654  * Seek to a given timestamp relative to the frames in
655  * stream component stream_index.
656  * @param stream_index Must not be -1.
657  * @param flags Selects which direction should be preferred if no exact
658  * match is available.
659  * @return >= 0 on success (but not necessarily the new offset)
660  */
661  int (*read_seek)(struct AVFormatContext *,
662  int stream_index, int64_t timestamp, int flags);
663 
664  /**
665  * Get the next timestamp in stream[stream_index].time_base units.
666  * @return the timestamp or AV_NOPTS_VALUE if an error occurred
667  */
668  int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
669  int64_t *pos, int64_t pos_limit);
670 
671  /**
672  * Start/resume playing - only meaningful if using a network-based format
673  * (RTSP).
674  */
675  int (*read_play)(struct AVFormatContext *);
676 
677  /**
678  * Pause playing - only meaningful if using a network-based format
679  * (RTSP).
680  */
681  int (*read_pause)(struct AVFormatContext *);
682 
683  /**
684  * Seek to timestamp ts.
685  * Seeking will be done so that the point from which all active streams
686  * can be presented successfully will be closest to ts and within min/max_ts.
687  * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
688  */
689  int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
690 
691  /**
692  * Returns device list with it properties.
693  * @see avdevice_list_devices() for more details.
694  */
695  int (*get_device_list)(struct AVFormatContext *s, struct AVDeviceInfoList *device_list);
696 
697  /**
698  * Initialize device capabilities submodule.
699  * @see avdevice_capabilities_create() for more details.
700  */
702 
703  /**
704  * Free device capabilities submodule.
705  * @see avdevice_capabilities_free() for more details.
706  */
708 } AVInputFormat;
709 /**
710  * @}
711  */
712 
715  AVSTREAM_PARSE_FULL, /**< full parsing and repack */
716  AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
717  AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
718  AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
719  AVSTREAM_PARSE_FULL_RAW=MKTAG(0,'R','A','W'), /**< full parsing and repack with timestamp and position generation by parser for raw
720  this assumes that each packet in the file contains no demuxer level headers and
721  just codec level data, otherwise position generation would fail */
722 };
723 
724 typedef struct AVIndexEntry {
725  int64_t pos;
726  int64_t timestamp; /**<
727  * Timestamp in AVStream.time_base units, preferably the time from which on correctly decoded frames are available
728  * when seeking to this entry. That means preferable PTS on keyframe based formats.
729  * But demuxers can choose to store a different timestamp, if it is more convenient for the implementation or nothing better
730  * is known
731  */
732 #define AVINDEX_KEYFRAME 0x0001
733  int flags:2;
734  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).
735  int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
736 } AVIndexEntry;
737 
738 #define AV_DISPOSITION_DEFAULT 0x0001
739 #define AV_DISPOSITION_DUB 0x0002
740 #define AV_DISPOSITION_ORIGINAL 0x0004
741 #define AV_DISPOSITION_COMMENT 0x0008
742 #define AV_DISPOSITION_LYRICS 0x0010
743 #define AV_DISPOSITION_KARAOKE 0x0020
744 
745 /**
746  * Track should be used during playback by default.
747  * Useful for subtitle track that should be displayed
748  * even when user did not explicitly ask for subtitles.
749  */
750 #define AV_DISPOSITION_FORCED 0x0040
751 #define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */
752 #define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */
753 #define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */
754 /**
755  * The stream is stored in the file as an attached picture/"cover art" (e.g.
756  * APIC frame in ID3v2). The single packet associated with it will be returned
757  * among the first few packets read from the file unless seeking takes place.
758  * It can also be accessed at any time in AVStream.attached_pic.
759  */
760 #define AV_DISPOSITION_ATTACHED_PIC 0x0400
761 
762 /**
763  * To specify text track kind (different from subtitles default).
764  */
765 #define AV_DISPOSITION_CAPTIONS 0x10000
766 #define AV_DISPOSITION_DESCRIPTIONS 0x20000
767 #define AV_DISPOSITION_METADATA 0x40000
768 
769 /**
770  * Options for behavior on timestamp wrap detection.
771  */
772 #define AV_PTS_WRAP_IGNORE 0 ///< ignore the wrap
773 #define AV_PTS_WRAP_ADD_OFFSET 1 ///< add the format specific offset on wrap detection
774 #define AV_PTS_WRAP_SUB_OFFSET -1 ///< subtract the format specific offset on wrap detection
775 
776 /**
777  * Stream structure.
778  * New fields can be added to the end with minor version bumps.
779  * Removal, reordering and changes to existing fields require a major
780  * version bump.
781  * sizeof(AVStream) must not be used outside libav*.
782  */
783 typedef struct AVStream {
784  int index; /**< stream index in AVFormatContext */
785  /**
786  * Format-specific stream ID.
787  * decoding: set by libavformat
788  * encoding: set by the user, replaced by libavformat if left unset
789  */
790  int id;
791  /**
792  * Codec context associated with this stream. Allocated and freed by
793  * libavformat.
794  *
795  * - decoding: The demuxer exports codec information stored in the headers
796  * here.
797  * - encoding: The user sets codec information, the muxer writes it to the
798  * output. Mandatory fields as specified in AVCodecContext
799  * documentation must be set even if this AVCodecContext is
800  * not actually used for encoding.
801  */
803  void *priv_data;
804 
805 #if FF_API_LAVF_FRAC
806  /**
807  * @deprecated this field is unused
808  */
810  struct AVFrac pts;
811 #endif
812 
813  /**
814  * This is the fundamental unit of time (in seconds) in terms
815  * of which frame timestamps are represented.
816  *
817  * decoding: set by libavformat
818  * encoding: May be set by the caller before avformat_write_header() to
819  * provide a hint to the muxer about the desired timebase. In
820  * avformat_write_header(), the muxer will overwrite this field
821  * with the timebase that will actually be used for the timestamps
822  * written into the file (which may or may not be related to the
823  * user-provided one, depending on the format).
824  */
826 
827  /**
828  * Decoding: pts of the first frame of the stream in presentation order, in stream time base.
829  * Only set this if you are absolutely 100% sure that the value you set
830  * it to really is the pts of the first frame.
831  * This may be undefined (AV_NOPTS_VALUE).
832  * @note The ASF header does NOT contain a correct start_time the ASF
833  * demuxer must NOT set this.
834  */
835  int64_t start_time;
836 
837  /**
838  * Decoding: duration of the stream, in stream time base.
839  * If a source file does not specify a duration, but does specify
840  * a bitrate, this value will be estimated from bitrate and file size.
841  */
842  int64_t duration;
843 
844  int64_t nb_frames; ///< number of frames in this stream if known or 0
845 
846  int disposition; /**< AV_DISPOSITION_* bit field */
847 
848  enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
849 
850  /**
851  * sample aspect ratio (0 if unknown)
852  * - encoding: Set by user.
853  * - decoding: Set by libavformat.
854  */
856 
858 
859  /**
860  * Average framerate
861  *
862  * - demuxing: May be set by libavformat when creating the stream or in
863  * avformat_find_stream_info().
864  * - muxing: May be set by the caller before avformat_write_header().
865  */
867 
868  /**
869  * For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet
870  * will contain the attached picture.
871  *
872  * decoding: set by libavformat, must not be modified by the caller.
873  * encoding: unused
874  */
876 
877  /**
878  * An array of side data that applies to the whole stream (i.e. the
879  * container does not allow it to change between packets).
880  *
881  * There may be no overlap between the side data in this array and side data
882  * in the packets. I.e. a given side data is either exported by the muxer
883  * (demuxing) / set by the caller (muxing) in this array, then it never
884  * appears in the packets, or the side data is exported / sent through
885  * the packets (always in the first packet where the value becomes known or
886  * changes), then it does not appear in this array.
887  *
888  * - demuxing: Set by libavformat when the stream is created.
889  * - muxing: May be set by the caller before avformat_write_header().
890  *
891  * Freed by libavformat in avformat_free_context().
892  *
893  * @see av_format_inject_global_side_data()
894  */
896  /**
897  * The number of elements in the AVStream.side_data array.
898  */
900 
901  /**
902  * Flags for the user to detect events happening on the stream. Flags must
903  * be cleared by the user once the event has been handled.
904  * A combination of AVSTREAM_EVENT_FLAG_*.
905  */
907 #define AVSTREAM_EVENT_FLAG_METADATA_UPDATED 0x0001 ///< The call resulted in updated metadata.
908 
909  /*****************************************************************
910  * All fields below this line are not part of the public API. They
911  * may not be used outside of libavformat and can be changed and
912  * removed at will.
913  * New public fields should be added right above.
914  *****************************************************************
915  */
916 
917  /**
918  * Stream information used internally by av_find_stream_info()
919  */
920 #define MAX_STD_TIMEBASES (30*12+7+6)
921  struct {
922  int64_t last_dts;
923  int64_t duration_gcd;
929 
930  /**
931  * 0 -> decoder has not been searched for yet.
932  * >0 -> decoder found
933  * <0 -> decoder with codec_id == -found_decoder has not been found
934  */
936 
937  int64_t last_duration;
938 
939  /**
940  * Those are used for average framerate estimation.
941  */
942  int64_t fps_first_dts;
944  int64_t fps_last_dts;
946 
947  } *info;
948 
949  int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
950 
951  // Timestamp generation support:
952  /**
953  * Timestamp corresponding to the last dts sync point.
954  *
955  * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
956  * a DTS is received from the underlying container. Otherwise set to
957  * AV_NOPTS_VALUE by default.
958  */
959  int64_t first_dts;
960  int64_t cur_dts;
961  int64_t last_IP_pts;
963 
964  /**
965  * Number of packets to buffer for codec probing
966  */
967 #define MAX_PROBE_PACKETS 2500
969 
970  /**
971  * Number of frames that have been demuxed during av_find_stream_info()
972  */
974 
975  /* av_read_frame() support */
978 
979  /**
980  * last packet in packet_buffer for this stream when muxing.
981  */
984 #define MAX_REORDER_DELAY 16
986 
987  AVIndexEntry *index_entries; /**< Only used if the format does not
988  support seeking natively. */
991 
992  /**
993  * Real base framerate of the stream.
994  * This is the lowest framerate with which all timestamps can be
995  * represented accurately (it is the least common multiple of all
996  * framerates in the stream). Note, this value is just a guess!
997  * For example, if the time base is 1/90000 and all frames have either
998  * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
999  *
1000  * Code outside avformat should access this field using:
1001  * av_stream_get/set_r_frame_rate(stream)
1002  */
1004 
1005  /**
1006  * Stream Identifier
1007  * This is the MPEG-TS stream identifier +1
1008  * 0 means unknown
1009  */
1011 
1014 
1015  /**
1016  * stream probing state
1017  * -1 -> probing finished
1018  * 0 -> no probing requested
1019  * rest -> perform probing with request_probe being the minimum score to accept.
1020  * NOT PART OF PUBLIC API
1021  */
1023  /**
1024  * Indicates that everything up to the next keyframe
1025  * should be discarded.
1026  */
1028 
1029  /**
1030  * Number of samples to skip at the start of the frame decoded from the next packet.
1031  */
1033 
1034  /**
1035  * If not 0, the first audio sample that should be discarded from the stream.
1036  * This is broken by design (needs global sample count), but can't be
1037  * avoided for broken by design formats such as mp3 with ad-hoc gapless
1038  * audio support.
1039  */
1041 
1042  /**
1043  * The sample after last sample that is intended to be discarded after
1044  * first_discard_sample. Works on frame boundaries only. Used to prevent
1045  * early EOF if the gapless info is broken (considered concatenated mp3s).
1046  */
1048 
1049  /**
1050  * Number of internally decoded frames, used internally in libavformat, do not access
1051  * its lifetime differs from info which is why it is not in that structure.
1052  */
1054 
1055  /**
1056  * Timestamp offset added to timestamps before muxing
1057  * NOT PART OF PUBLIC API
1058  */
1059  int64_t mux_ts_offset;
1060 
1061  /**
1062  * Internal data to check for wrapping of the time stamp
1063  */
1065 
1066  /**
1067  * Options for behavior, when a wrap is detected.
1068  *
1069  * Defined by AV_PTS_WRAP_ values.
1070  *
1071  * If correction is enabled, there are two possibilities:
1072  * If the first time stamp is near the wrap point, the wrap offset
1073  * will be subtracted, which will create negative time stamps.
1074  * Otherwise the offset will be added.
1075  */
1077 
1078  /**
1079  * Internal data to prevent doing update_initial_durations() twice
1080  */
1082 
1083  /**
1084  * Internal data to generate dts from pts
1085  */
1088 
1089  /**
1090  * Internal data to analyze DTS and detect faulty mpeg streams
1091  */
1095 
1096  /**
1097  * Internal data to inject global side data
1098  */
1100 
1101  /**
1102  * String containing paris of key and values describing recommended encoder configuration.
1103  * Paris are separated by ','.
1104  * Keys are separated from values by '='.
1105  */
1107 
1108  /**
1109  * display aspect ratio (0 if unknown)
1110  * - encoding: unused
1111  * - decoding: Set by libavformat to calculate sample_aspect_ratio internally
1112  */
1114 } AVStream;
1115 
1120 void av_stream_set_recommended_encoder_configuration(AVStream *s, char *configuration);
1121 
1122 /**
1123  * Returns the pts of the last muxed packet + its duration
1124  *
1125  * the retuned value is undefined when used with a demuxer.
1126  */
1127 int64_t av_stream_get_end_pts(const AVStream *st);
1128 
1129 #define AV_PROGRAM_RUNNING 1
1130 
1131 /**
1132  * New fields can be added to the end with minor version bumps.
1133  * Removal, reordering and changes to existing fields require a major
1134  * version bump.
1135  * sizeof(AVProgram) must not be used outside libav*.
1136  */
1137 typedef struct AVProgram {
1138  int id;
1139  int flags;
1140  enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
1141  unsigned int *stream_index;
1142  unsigned int nb_stream_indexes;
1144 
1146  int pmt_pid;
1147  int pcr_pid;
1148 
1149  /*****************************************************************
1150  * All fields below this line are not part of the public API. They
1151  * may not be used outside of libavformat and can be changed and
1152  * removed at will.
1153  * New public fields should be added right above.
1154  *****************************************************************
1155  */
1156  int64_t start_time;
1157  int64_t end_time;
1158 
1159  int64_t pts_wrap_reference; ///< reference dts for wrap detection
1160  int pts_wrap_behavior; ///< behavior on wrap detection
1161 } AVProgram;
1162 
1163 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
1164  (streams are added dynamically) */
1165 
1166 typedef struct AVChapter {
1167  int id; ///< unique ID to identify the chapter
1168  AVRational time_base; ///< time base in which the start/end timestamps are specified
1169  int64_t start, end; ///< chapter start/end time in time_base units
1171 } AVChapter;
1172 
1173 
1174 /**
1175  * Callback used by devices to communicate with application.
1176  */
1177 typedef int (*av_format_control_message)(struct AVFormatContext *s, int type,
1178  void *data, size_t data_size);
1179 
1180 
1181 /**
1182  * The duration of a video can be estimated through various ways, and this enum can be used
1183  * to know how the duration was estimated.
1184  */
1186  AVFMT_DURATION_FROM_PTS, ///< Duration accurately estimated from PTSes
1187  AVFMT_DURATION_FROM_STREAM, ///< Duration estimated from a stream with a known duration
1188  AVFMT_DURATION_FROM_BITRATE ///< Duration estimated from bitrate (less accurate)
1189 };
1190 
1191 typedef struct AVFormatInternal AVFormatInternal;
1192 
1193 /**
1194  * Format I/O context.
1195  * New fields can be added to the end with minor version bumps.
1196  * Removal, reordering and changes to existing fields require a major
1197  * version bump.
1198  * sizeof(AVFormatContext) must not be used outside libav*, use
1199  * avformat_alloc_context() to create an AVFormatContext.
1200  */
1201 typedef struct AVFormatContext {
1202  /**
1203  * A class for logging and @ref avoptions. Set by avformat_alloc_context().
1204  * Exports (de)muxer private options if they exist.
1205  */
1207 
1208  /**
1209  * The input container format.
1210  *
1211  * Demuxing only, set by avformat_open_input().
1212  */
1214 
1215  /**
1216  * The output container format.
1217  *
1218  * Muxing only, must be set by the caller before avformat_write_header().
1219  */
1221 
1222  /**
1223  * Format private data. This is an AVOptions-enabled struct
1224  * if and only if iformat/oformat.priv_class is not NULL.
1225  *
1226  * - muxing: set by avformat_write_header()
1227  * - demuxing: set by avformat_open_input()
1228  */
1229  void *priv_data;
1230 
1231  /**
1232  * I/O context.
1233  *
1234  * - demuxing: either set by the user before avformat_open_input() (then
1235  * the user must close it manually) or set by avformat_open_input().
1236  * - muxing: set by the user before avformat_write_header(). The caller must
1237  * take care of closing / freeing the IO context.
1238  *
1239  * Do NOT set this field if AVFMT_NOFILE flag is set in
1240  * iformat/oformat.flags. In such a case, the (de)muxer will handle
1241  * I/O in some other way and this field will be NULL.
1242  */
1244 
1245  /* stream info */
1246  /**
1247  * Flags signalling stream properties. A combination of AVFMTCTX_*.
1248  * Set by libavformat.
1249  */
1251 
1252  /**
1253  * Number of elements in AVFormatContext.streams.
1254  *
1255  * Set by avformat_new_stream(), must not be modified by any other code.
1256  */
1257  unsigned int nb_streams;
1258  /**
1259  * A list of all streams in the file. New streams are created with
1260  * avformat_new_stream().
1261  *
1262  * - demuxing: streams are created by libavformat in avformat_open_input().
1263  * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
1264  * appear in av_read_frame().
1265  * - muxing: streams are created by the user before avformat_write_header().
1266  *
1267  * Freed by libavformat in avformat_free_context().
1268  */
1270 
1271  /**
1272  * input or output filename
1273  *
1274  * - demuxing: set by avformat_open_input()
1275  * - muxing: may be set by the caller before avformat_write_header()
1276  */
1277  char filename[1024];
1278 
1279  /**
1280  * Position of the first frame of the component, in
1281  * AV_TIME_BASE fractional seconds. NEVER set this value directly:
1282  * It is deduced from the AVStream values.
1283  *
1284  * Demuxing only, set by libavformat.
1285  */
1286  int64_t start_time;
1287 
1288  /**
1289  * Duration of the stream, in AV_TIME_BASE fractional
1290  * seconds. Only set this value if you know none of the individual stream
1291  * durations and also do not set any of them. This is deduced from the
1292  * AVStream values if not set.
1293  *
1294  * Demuxing only, set by libavformat.
1295  */
1296  int64_t duration;
1297 
1298  /**
1299  * Total stream bitrate in bit/s, 0 if not
1300  * available. Never set it directly if the file_size and the
1301  * duration are known as FFmpeg can compute it automatically.
1302  */
1304 
1305  unsigned int packet_size;
1307 
1308  /**
1309  * Flags modifying the (de)muxer behaviour. A combination of AVFMT_FLAG_*.
1310  * Set by the user before avformat_open_input() / avformat_write_header().
1311  */
1312  int flags;
1313 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
1314 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
1315 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
1316 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
1317 #define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
1318 #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
1319 #define AVFMT_FLAG_NOBUFFER 0x0040 ///< Do not buffer frames when possible
1320 #define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
1321 #define AVFMT_FLAG_DISCARD_CORRUPT 0x0100 ///< Discard frames marked corrupted
1322 #define AVFMT_FLAG_FLUSH_PACKETS 0x0200 ///< Flush the AVIOContext every packet.
1323 /**
1324  * When muxing, try to avoid writing any random/volatile data to the output.
1325  * This includes any random IDs, real-time timestamps/dates, muxer version, etc.
1326  *
1327  * This flag is mainly intended for testing.
1328  */
1329 #define AVFMT_FLAG_BITEXACT 0x0400
1330 #define AVFMT_FLAG_MP4A_LATM 0x8000 ///< Enable RTP MP4A-LATM payload
1331 #define AVFMT_FLAG_SORT_DTS 0x10000 ///< try to interleave outputted packets by dts (using this flag can slow demuxing down)
1332 #define AVFMT_FLAG_PRIV_OPT 0x20000 ///< Enable use of private options by delaying codec open (this could be made default once all code is converted)
1333 #define AVFMT_FLAG_KEEP_SIDE_DATA 0x40000 ///< Don't merge side data but keep it separate.
1334 
1335  /**
1336  * @deprecated deprecated in favor of probesize2
1337  */
1338  unsigned int probesize;
1339 
1340  /**
1341  * @deprecated deprecated in favor of max_analyze_duration2
1342  */
1345 
1346  const uint8_t *key;
1347  int keylen;
1348 
1349  unsigned int nb_programs;
1351 
1352  /**
1353  * Forced video codec_id.
1354  * Demuxing: Set by user.
1355  */
1357 
1358  /**
1359  * Forced audio codec_id.
1360  * Demuxing: Set by user.
1361  */
1363 
1364  /**
1365  * Forced subtitle codec_id.
1366  * Demuxing: Set by user.
1367  */
1369 
1370  /**
1371  * Maximum amount of memory in bytes to use for the index of each stream.
1372  * If the index exceeds this size, entries will be discarded as
1373  * needed to maintain a smaller size. This can lead to slower or less
1374  * accurate seeking (depends on demuxer).
1375  * Demuxers for which a full in-memory index is mandatory will ignore
1376  * this.
1377  * - muxing: unused
1378  * - demuxing: set by user
1379  */
1380  unsigned int max_index_size;
1381 
1382  /**
1383  * Maximum amount of memory in bytes to use for buffering frames
1384  * obtained from realtime capture devices.
1385  */
1386  unsigned int max_picture_buffer;
1387 
1388  /**
1389  * Number of chapters in AVChapter array.
1390  * When muxing, chapters are normally written in the file header,
1391  * so nb_chapters should normally be initialized before write_header
1392  * is called. Some muxers (e.g. mov and mkv) can also write chapters
1393  * in the trailer. To write chapters in the trailer, nb_chapters
1394  * must be zero when write_header is called and non-zero when
1395  * write_trailer is called.
1396  * - muxing: set by user
1397  * - demuxing: set by libavformat
1398  */
1399  unsigned int nb_chapters;
1401 
1402  /**
1403  * Metadata that applies to the whole file.
1404  *
1405  * - demuxing: set by libavformat in avformat_open_input()
1406  * - muxing: may be set by the caller before avformat_write_header()
1407  *
1408  * Freed by libavformat in avformat_free_context().
1409  */
1411 
1412  /**
1413  * Start time of the stream in real world time, in microseconds
1414  * since the Unix epoch (00:00 1st January 1970). That is, pts=0 in the
1415  * stream was captured at this real world time.
1416  * - muxing: Set by the caller before avformat_write_header(). If set to
1417  * either 0 or AV_NOPTS_VALUE, then the current wall-time will
1418  * be used.
1419  * - demuxing: Set by libavformat. AV_NOPTS_VALUE if unknown. Note that
1420  * the value may become known after some number of frames
1421  * have been received.
1422  */
1424 
1425  /**
1426  * The number of frames used for determining the framerate in
1427  * avformat_find_stream_info().
1428  * Demuxing only, set by the caller before avformat_find_stream_info().
1429  */
1431 
1432  /**
1433  * Error recognition; higher values will detect more errors but may
1434  * misdetect some more or less valid parts as errors.
1435  * Demuxing only, set by the caller before avformat_open_input().
1436  */
1438 
1439  /**
1440  * Custom interrupt callbacks for the I/O layer.
1441  *
1442  * demuxing: set by the user before avformat_open_input().
1443  * muxing: set by the user before avformat_write_header()
1444  * (mainly useful for AVFMT_NOFILE formats). The callback
1445  * should also be passed to avio_open2() if it's used to
1446  * open the file.
1447  */
1449 
1450  /**
1451  * Flags to enable debugging.
1452  */
1453  int debug;
1454 #define FF_FDEBUG_TS 0x0001
1455 
1456  /**
1457  * Maximum buffering duration for interleaving.
1458  *
1459  * To ensure all the streams are interleaved correctly,
1460  * av_interleaved_write_frame() will wait until it has at least one packet
1461  * for each stream before actually writing any packets to the output file.
1462  * When some streams are "sparse" (i.e. there are large gaps between
1463  * successive packets), this can result in excessive buffering.
1464  *
1465  * This field specifies the maximum difference between the timestamps of the
1466  * first and the last packet in the muxing queue, above which libavformat
1467  * will output a packet regardless of whether it has queued a packet for all
1468  * the streams.
1469  *
1470  * Muxing only, set by the caller before avformat_write_header().
1471  */
1473 
1474  /**
1475  * Allow non-standard and experimental extension
1476  * @see AVCodecContext.strict_std_compliance
1477  */
1479 
1480  /**
1481  * Flags for the user to detect events happening on the file. Flags must
1482  * be cleared by the user once the event has been handled.
1483  * A combination of AVFMT_EVENT_FLAG_*.
1484  */
1486 #define AVFMT_EVENT_FLAG_METADATA_UPDATED 0x0001 ///< The call resulted in updated metadata.
1487 
1488  /**
1489  * Maximum number of packets to read while waiting for the first timestamp.
1490  * Decoding only.
1491  */
1493 
1494  /**
1495  * Avoid negative timestamps during muxing.
1496  * Any value of the AVFMT_AVOID_NEG_TS_* constants.
1497  * Note, this only works when using av_interleaved_write_frame. (interleave_packet_per_dts is in use)
1498  * - muxing: Set by user
1499  * - demuxing: unused
1500  */
1502 #define AVFMT_AVOID_NEG_TS_AUTO -1 ///< Enabled when required by target format
1503 #define AVFMT_AVOID_NEG_TS_MAKE_NON_NEGATIVE 1 ///< Shift timestamps so they are non negative
1504 #define AVFMT_AVOID_NEG_TS_MAKE_ZERO 2 ///< Shift timestamps so that they start at 0
1505 
1506 
1507  /**
1508  * Transport stream id.
1509  * This will be moved into demuxer private options. Thus no API/ABI compatibility
1510  */
1511  int ts_id;
1512 
1513  /**
1514  * Audio preload in microseconds.
1515  * Note, not all formats support this and unpredictable things may happen if it is used when not supported.
1516  * - encoding: Set by user via AVOptions (NO direct access)
1517  * - decoding: unused
1518  */
1520 
1521  /**
1522  * Max chunk time in microseconds.
1523  * Note, not all formats support this and unpredictable things may happen if it is used when not supported.
1524  * - encoding: Set by user via AVOptions (NO direct access)
1525  * - decoding: unused
1526  */
1528 
1529  /**
1530  * Max chunk size in bytes
1531  * Note, not all formats support this and unpredictable things may happen if it is used when not supported.
1532  * - encoding: Set by user via AVOptions (NO direct access)
1533  * - decoding: unused
1534  */
1536 
1537  /**
1538  * forces the use of wallclock timestamps as pts/dts of packets
1539  * This has undefined results in the presence of B frames.
1540  * - encoding: unused
1541  * - decoding: Set by user via AVOptions (NO direct access)
1542  */
1544 
1545  /**
1546  * avio flags, used to force AVIO_FLAG_DIRECT.
1547  * - encoding: unused
1548  * - decoding: Set by user via AVOptions (NO direct access)
1549  */
1551 
1552  /**
1553  * The duration field can be estimated through various ways, and this field can be used
1554  * to know how the duration was estimated.
1555  * - encoding: unused
1556  * - decoding: Read by user via AVOptions (NO direct access)
1557  */
1559 
1560  /**
1561  * Skip initial bytes when opening stream
1562  * - encoding: unused
1563  * - decoding: Set by user via AVOptions (NO direct access)
1564  */
1566 
1567  /**
1568  * Correct single timestamp overflows
1569  * - encoding: unused
1570  * - decoding: Set by user via AVOptions (NO direct access)
1571  */
1572  unsigned int correct_ts_overflow;
1573 
1574  /**
1575  * Force seeking to any (also non key) frames.
1576  * - encoding: unused
1577  * - decoding: Set by user via AVOptions (NO direct access)
1578  */
1580 
1581  /**
1582  * Flush the I/O context after each packet.
1583  * - encoding: Set by user via AVOptions (NO direct access)
1584  * - decoding: unused
1585  */
1587 
1588  /**
1589  * format probing score.
1590  * The maximal score is AVPROBE_SCORE_MAX, its set when the demuxer probes
1591  * the format.
1592  * - encoding: unused
1593  * - decoding: set by avformat, read by user via av_format_get_probe_score() (NO direct access)
1594  */
1596 
1597  /**
1598  * number of bytes to read maximally to identify format.
1599  * - encoding: unused
1600  * - decoding: set by user through AVOPtions (NO direct access)
1601  */
1603 
1604  /**
1605  * ',' separated list of allowed decoders.
1606  * If NULL then all are allowed
1607  * - encoding: unused
1608  * - decoding: set by user through AVOptions (NO direct access)
1609  */
1611 
1612  /**
1613  * ',' separated list of allowed demuxers.
1614  * If NULL then all are allowed
1615  * - encoding: unused
1616  * - decoding: set by user through AVOptions (NO direct access)
1617  */
1619 
1620  /*****************************************************************
1621  * All fields below this line are not part of the public API. They
1622  * may not be used outside of libavformat and can be changed and
1623  * removed at will.
1624  * New public fields should be added right above.
1625  *****************************************************************
1626  */
1627 
1628  /**
1629  * This buffer is only needed when packets were already buffered but
1630  * not decoded, for example to get the codec parameters in MPEG
1631  * streams.
1632  */
1635 
1636  /* av_seek_frame() support */
1637  int64_t data_offset; /**< offset of the first packet */
1638 
1639  /**
1640  * Raw packets from the demuxer, prior to parsing and decoding.
1641  * This buffer is used for buffering packets until the codec can
1642  * be identified, as parsing cannot be done without knowing the
1643  * codec.
1644  */
1647  /**
1648  * Packets split by the parser get queued here.
1649  */
1652  /**
1653  * Remaining size available for raw_packet_buffer, in bytes.
1654  */
1655 #define RAW_PACKET_BUFFER_SIZE 2500000
1657 
1658  /**
1659  * Offset to remap timestamps to be non-negative.
1660  * Expressed in timebase units.
1661  * @see AVStream.mux_ts_offset
1662  */
1663  int64_t offset;
1664 
1665  /**
1666  * Timebase for the timestamp offset.
1667  */
1669 
1670  /**
1671  * An opaque field for libavformat internal usage.
1672  * Must not be accessed in any way by callers.
1673  */
1674  AVFormatInternal *internal;
1675 
1676  /**
1677  * IO repositioned flag.
1678  * This is set by avformat when the underlaying IO context read pointer
1679  * is repositioned, for example when doing byte based seeking.
1680  * Demuxers can use the flag to detect such changes.
1681  */
1683 
1684  /**
1685  * Forced video codec.
1686  * This allows forcing a specific decoder, even when there are multiple with
1687  * the same codec_id.
1688  * Demuxing: Set by user via av_format_set_video_codec (NO direct access).
1689  */
1691 
1692  /**
1693  * Forced audio codec.
1694  * This allows forcing a specific decoder, even when there are multiple with
1695  * the same codec_id.
1696  * Demuxing: Set by user via av_format_set_audio_codec (NO direct access).
1697  */
1699 
1700  /**
1701  * Forced subtitle codec.
1702  * This allows forcing a specific decoder, even when there are multiple with
1703  * the same codec_id.
1704  * Demuxing: Set by user via av_format_set_subtitle_codec (NO direct access).
1705  */
1707 
1708  /**
1709  * Forced data codec.
1710  * This allows forcing a specific decoder, even when there are multiple with
1711  * the same codec_id.
1712  * Demuxing: Set by user via av_format_set_data_codec (NO direct access).
1713  */
1715 
1716  /**
1717  * Number of bytes to be written as padding in a metadata header.
1718  * Demuxing: Unused.
1719  * Muxing: Set by user via av_format_set_metadata_header_padding.
1720  */
1722 
1723  /**
1724  * User data.
1725  * This is a place for some private data of the user.
1726  * Mostly usable with control_message_cb or any future callbacks in device's context.
1727  */
1728  void *opaque;
1729 
1730  /**
1731  * Callback used by devices to communicate with application.
1732  */
1734 
1735  /**
1736  * Output timestamp offset, in microseconds.
1737  * Muxing: set by user via AVOptions (NO direct access)
1738  */
1740 
1741  /**
1742  * Maximum duration (in AV_TIME_BASE units) of the data read
1743  * from input in avformat_find_stream_info().
1744  * Demuxing only, set by the caller before avformat_find_stream_info()
1745  * via AVOptions (NO direct access).
1746  * Can be set to 0 to let avformat choose using a heuristic.
1747  */
1749 
1750  /**
1751  * Maximum size of the data read from input for determining
1752  * the input container format.
1753  * Demuxing only, set by the caller before avformat_open_input()
1754  * via AVOptions (NO direct access).
1755  */
1756  int64_t probesize2;
1757 
1758  /**
1759  * dump format separator.
1760  * can be ", " or "\n " or anything else
1761  * Code outside libavformat should access this field using AVOptions
1762  * (NO direct access).
1763  * - muxing: Set by user.
1764  * - demuxing: Set by user.
1765  */
1767 
1768  /**
1769  * Forced Data codec_id.
1770  * Demuxing: Set by user.
1771  */
1773 } AVFormatContext;
1774 
1786 void * av_format_get_opaque(const AVFormatContext *s);
1787 void av_format_set_opaque(AVFormatContext *s, void *opaque);
1790 
1791 /**
1792  * This function will cause global side data to be injected in the next packet
1793  * of each stream as well as after any subsequent seek.
1794  */
1796 
1797 /**
1798  * Returns the method used to set ctx->duration.
1799  *
1800  * @return AVFMT_DURATION_FROM_PTS, AVFMT_DURATION_FROM_STREAM, or AVFMT_DURATION_FROM_BITRATE.
1801  */
1803 
1804 typedef struct AVPacketList {
1807 } AVPacketList;
1808 
1809 
1810 /**
1811  * @defgroup lavf_core Core functions
1812  * @ingroup libavf
1813  *
1814  * Functions for querying libavformat capabilities, allocating core structures,
1815  * etc.
1816  * @{
1817  */
1818 
1819 /**
1820  * Return the LIBAVFORMAT_VERSION_INT constant.
1821  */
1822 unsigned avformat_version(void);
1823 
1824 /**
1825  * Return the libavformat build-time configuration.
1826  */
1827 const char *avformat_configuration(void);
1828 
1829 /**
1830  * Return the libavformat license.
1831  */
1832 const char *avformat_license(void);
1833 
1834 /**
1835  * Initialize libavformat and register all the muxers, demuxers and
1836  * protocols. If you do not call this function, then you can select
1837  * exactly which formats you want to support.
1838  *
1839  * @see av_register_input_format()
1840  * @see av_register_output_format()
1841  */
1842 void av_register_all(void);
1843 
1846 
1847 /**
1848  * Do global initialization of network components. This is optional,
1849  * but recommended, since it avoids the overhead of implicitly
1850  * doing the setup for each session.
1851  *
1852  * Calling this function will become mandatory if using network
1853  * protocols at some major version bump.
1854  */
1855 int avformat_network_init(void);
1856 
1857 /**
1858  * Undo the initialization done by avformat_network_init.
1859  */
1860 int avformat_network_deinit(void);
1861 
1862 /**
1863  * If f is NULL, returns the first registered input format,
1864  * if f is non-NULL, returns the next registered input format after f
1865  * or NULL if f is the last one.
1866  */
1868 
1869 /**
1870  * If f is NULL, returns the first registered output format,
1871  * if f is non-NULL, returns the next registered output format after f
1872  * or NULL if f is the last one.
1873  */
1875 
1876 /**
1877  * Allocate an AVFormatContext.
1878  * avformat_free_context() can be used to free the context and everything
1879  * allocated by the framework within it.
1880  */
1882 
1883 /**
1884  * Free an AVFormatContext and all its streams.
1885  * @param s context to free
1886  */
1888 
1889 /**
1890  * Get the AVClass for AVFormatContext. It can be used in combination with
1891  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1892  *
1893  * @see av_opt_find().
1894  */
1895 const AVClass *avformat_get_class(void);
1896 
1897 /**
1898  * Add a new stream to a media file.
1899  *
1900  * When demuxing, it is called by the demuxer in read_header(). If the
1901  * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1902  * be called in read_packet().
1903  *
1904  * When muxing, should be called by the user before avformat_write_header().
1905  *
1906  * User is required to call avcodec_close() and avformat_free_context() to
1907  * clean up the allocation by avformat_new_stream().
1908  *
1909  * @param s media file handle
1910  * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1911  * will be initialized to use this codec. This is needed for e.g. codec-specific
1912  * defaults to be set, so codec should be provided if it is known.
1913  *
1914  * @return newly created stream or NULL on error.
1915  */
1917 
1918 /**
1919  * Get side information from stream.
1920  *
1921  * @param stream stream
1922  * @param type desired side information type
1923  * @param size pointer for side information size to store (optional)
1924  * @return pointer to data if present or NULL otherwise
1925  */
1927  enum AVPacketSideDataType type, int *size);
1928 
1930 
1931 /**
1932  * @}
1933  */
1934 
1935 
1936 /**
1937  * Allocate an AVFormatContext for an output format.
1938  * avformat_free_context() can be used to free the context and
1939  * everything allocated by the framework within it.
1940  *
1941  * @param *ctx is set to the created format context, or to NULL in
1942  * case of failure
1943  * @param oformat format to use for allocating the context, if NULL
1944  * format_name and filename are used instead
1945  * @param format_name the name of output format to use for allocating the
1946  * context, if NULL filename is used instead
1947  * @param filename the name of the filename to use for allocating the
1948  * context, may be NULL
1949  * @return >= 0 in case of success, a negative AVERROR code in case of
1950  * failure
1951  */
1953  const char *format_name, const char *filename);
1954 
1955 /**
1956  * @addtogroup lavf_decoding
1957  * @{
1958  */
1959 
1960 /**
1961  * Find AVInputFormat based on the short name of the input format.
1962  */
1963 AVInputFormat *av_find_input_format(const char *short_name);
1964 
1965 /**
1966  * Guess the file format.
1967  *
1968  * @param pd data to be probed
1969  * @param is_opened Whether the file is already opened; determines whether
1970  * demuxers with or without AVFMT_NOFILE are probed.
1971  */
1972 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1973 
1974 /**
1975  * Guess the file format.
1976  *
1977  * @param pd data to be probed
1978  * @param is_opened Whether the file is already opened; determines whether
1979  * demuxers with or without AVFMT_NOFILE are probed.
1980  * @param score_max A probe score larger that this is required to accept a
1981  * detection, the variable is set to the actual detection
1982  * score afterwards.
1983  * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1984  * to retry with a larger probe buffer.
1985  */
1986 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1987 
1988 /**
1989  * Guess the file format.
1990  *
1991  * @param is_opened Whether the file is already opened; determines whether
1992  * demuxers with or without AVFMT_NOFILE are probed.
1993  * @param score_ret The score of the best detection.
1994  */
1995 AVInputFormat *av_probe_input_format3(AVProbeData *pd, int is_opened, int *score_ret);
1996 
1997 /**
1998  * Probe a bytestream to determine the input format. Each time a probe returns
1999  * with a score that is too low, the probe buffer size is increased and another
2000  * attempt is made. When the maximum probe size is reached, the input format
2001  * with the highest score is returned.
2002  *
2003  * @param pb the bytestream to probe
2004  * @param fmt the input format is put here
2005  * @param filename the filename of the stream
2006  * @param logctx the log context
2007  * @param offset the offset within the bytestream to probe from
2008  * @param max_probe_size the maximum probe buffer size (zero for default)
2009  * @return the score in case of success, a negative value corresponding to an
2010  * the maximal score is AVPROBE_SCORE_MAX
2011  * AVERROR code otherwise
2012  */
2014  const char *filename, void *logctx,
2015  unsigned int offset, unsigned int max_probe_size);
2016 
2017 /**
2018  * Like av_probe_input_buffer2() but returns 0 on success
2019  */
2021  const char *filename, void *logctx,
2022  unsigned int offset, unsigned int max_probe_size);
2023 
2024 /**
2025  * Open an input stream and read the header. The codecs are not opened.
2026  * The stream must be closed with avformat_close_input().
2027  *
2028  * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
2029  * May be a pointer to NULL, in which case an AVFormatContext is allocated by this
2030  * function and written into ps.
2031  * Note that a user-supplied AVFormatContext will be freed on failure.
2032  * @param filename Name of the stream to open.
2033  * @param fmt If non-NULL, this parameter forces a specific input format.
2034  * Otherwise the format is autodetected.
2035  * @param options A dictionary filled with AVFormatContext and demuxer-private options.
2036  * On return this parameter will be destroyed and replaced with a dict containing
2037  * options that were not found. May be NULL.
2038  *
2039  * @return 0 on success, a negative AVERROR on failure.
2040  *
2041  * @note If you want to use custom IO, preallocate the format context and set its pb field.
2042  */
2043 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
2044 
2047 
2048 /**
2049  * Read packets of a media file to get stream information. This
2050  * is useful for file formats with no headers such as MPEG. This
2051  * function also computes the real framerate in case of MPEG-2 repeat
2052  * frame mode.
2053  * The logical file position is not changed by this function;
2054  * examined packets may be buffered for later processing.
2055  *
2056  * @param ic media file handle
2057  * @param options If non-NULL, an ic.nb_streams long array of pointers to
2058  * dictionaries, where i-th member contains options for
2059  * codec corresponding to i-th stream.
2060  * On return each dictionary will be filled with options that were not found.
2061  * @return >=0 if OK, AVERROR_xxx on error
2062  *
2063  * @note this function isn't guaranteed to open all the codecs, so
2064  * options being non-empty at return is a perfectly normal behavior.
2065  *
2066  * @todo Let the user decide somehow what information is needed so that
2067  * we do not waste time getting stuff the user does not need.
2068  */
2070 
2071 /**
2072  * Find the programs which belong to a given stream.
2073  *
2074  * @param ic media file handle
2075  * @param last the last found program, the search will start after this
2076  * program, or from the beginning if it is NULL
2077  * @param s stream index
2078  * @return the next program which belongs to s, NULL if no program is found or
2079  * the last program is not among the programs of ic.
2080  */
2082 
2083 /**
2084  * Find the "best" stream in the file.
2085  * The best stream is determined according to various heuristics as the most
2086  * likely to be what the user expects.
2087  * If the decoder parameter is non-NULL, av_find_best_stream will find the
2088  * default decoder for the stream's codec; streams for which no decoder can
2089  * be found are ignored.
2090  *
2091  * @param ic media file handle
2092  * @param type stream type: video, audio, subtitles, etc.
2093  * @param wanted_stream_nb user-requested stream number,
2094  * or -1 for automatic selection
2095  * @param related_stream try to find a stream related (eg. in the same
2096  * program) to this one, or -1 if none
2097  * @param decoder_ret if non-NULL, returns the decoder for the
2098  * selected stream
2099  * @param flags flags; none are currently defined
2100  * @return the non-negative stream number in case of success,
2101  * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
2102  * could be found,
2103  * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
2104  * @note If av_find_best_stream returns successfully and decoder_ret is not
2105  * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
2106  */
2108  enum AVMediaType type,
2109  int wanted_stream_nb,
2110  int related_stream,
2111  AVCodec **decoder_ret,
2112  int flags);
2113 
2114 /**
2115  * Return the next frame of a stream.
2116  * This function returns what is stored in the file, and does not validate
2117  * that what is there are valid frames for the decoder. It will split what is
2118  * stored in the file into frames and return one for each call. It will not
2119  * omit invalid data between valid frames so as to give the decoder the maximum
2120  * information possible for decoding.
2121  *
2122  * If pkt->buf is NULL, then the packet is valid until the next
2123  * av_read_frame() or until avformat_close_input(). Otherwise the packet
2124  * is valid indefinitely. In both cases the packet must be freed with
2125  * av_free_packet when it is no longer needed. For video, the packet contains
2126  * exactly one frame. For audio, it contains an integer number of frames if each
2127  * frame has a known fixed size (e.g. PCM or ADPCM data). If the audio frames
2128  * have a variable size (e.g. MPEG audio), then it contains one frame.
2129  *
2130  * pkt->pts, pkt->dts and pkt->duration are always set to correct
2131  * values in AVStream.time_base units (and guessed if the format cannot
2132  * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
2133  * has B-frames, so it is better to rely on pkt->dts if you do not
2134  * decompress the payload.
2135  *
2136  * @return 0 if OK, < 0 on error or end of file
2137  */
2139 
2140 /**
2141  * Seek to the keyframe at timestamp.
2142  * 'timestamp' in 'stream_index'.
2143  *
2144  * @param s media file handle
2145  * @param stream_index If stream_index is (-1), a default
2146  * stream is selected, and timestamp is automatically converted
2147  * from AV_TIME_BASE units to the stream specific time_base.
2148  * @param timestamp Timestamp in AVStream.time_base units
2149  * or, if no stream is specified, in AV_TIME_BASE units.
2150  * @param flags flags which select direction and seeking mode
2151  * @return >= 0 on success
2152  */
2153 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
2154  int flags);
2155 
2156 /**
2157  * Seek to timestamp ts.
2158  * Seeking will be done so that the point from which all active streams
2159  * can be presented successfully will be closest to ts and within min/max_ts.
2160  * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
2161  *
2162  * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
2163  * are the file position (this may not be supported by all demuxers).
2164  * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
2165  * in the stream with stream_index (this may not be supported by all demuxers).
2166  * Otherwise all timestamps are in units of the stream selected by stream_index
2167  * or if stream_index is -1, in AV_TIME_BASE units.
2168  * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
2169  * keyframes (this may not be supported by all demuxers).
2170  * If flags contain AVSEEK_FLAG_BACKWARD, it is ignored.
2171  *
2172  * @param s media file handle
2173  * @param stream_index index of the stream which is used as time base reference
2174  * @param min_ts smallest acceptable timestamp
2175  * @param ts target timestamp
2176  * @param max_ts largest acceptable timestamp
2177  * @param flags flags
2178  * @return >=0 on success, error code otherwise
2179  *
2180  * @note This is part of the new seek API which is still under construction.
2181  * Thus do not use this yet. It may change at any time, do not expect
2182  * ABI compatibility yet!
2183  */
2184 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
2185 
2186 /**
2187  * Start playing a network-based stream (e.g. RTSP stream) at the
2188  * current position.
2189  */
2191 
2192 /**
2193  * Pause a network-based stream (e.g. RTSP stream).
2194  *
2195  * Use av_read_play() to resume it.
2196  */
2198 
2199 /**
2200  * Close an opened input AVFormatContext. Free it and all its contents
2201  * and set *s to NULL.
2202  */
2204 /**
2205  * @}
2206  */
2207 
2208 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
2209 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
2210 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
2211 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
2212 
2213 /**
2214  * @addtogroup lavf_encoding
2215  * @{
2216  */
2217 /**
2218  * Allocate the stream private data and write the stream header to
2219  * an output media file.
2220  *
2221  * @param s Media file handle, must be allocated with avformat_alloc_context().
2222  * Its oformat field must be set to the desired output format;
2223  * Its pb field must be set to an already opened AVIOContext.
2224  * @param options An AVDictionary filled with AVFormatContext and muxer-private options.
2225  * On return this parameter will be destroyed and replaced with a dict containing
2226  * options that were not found. May be NULL.
2227  *
2228  * @return 0 on success, negative AVERROR on failure.
2229  *
2230  * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
2231  */
2233 
2234 /**
2235  * Write a packet to an output media file.
2236  *
2237  * This function passes the packet directly to the muxer, without any buffering
2238  * or reordering. The caller is responsible for correctly interleaving the
2239  * packets if the format requires it. Callers that want libavformat to handle
2240  * the interleaving should call av_interleaved_write_frame() instead of this
2241  * function.
2242  *
2243  * @param s media file handle
2244  * @param pkt The packet containing the data to be written. Note that unlike
2245  * av_interleaved_write_frame(), this function does not take
2246  * ownership of the packet passed to it (though some muxers may make
2247  * an internal reference to the input packet).
2248  * <br>
2249  * This parameter can be NULL (at any time, not just at the end), in
2250  * order to immediately flush data buffered within the muxer, for
2251  * muxers that buffer up data internally before writing it to the
2252  * output.
2253  * <br>
2254  * Packet's @ref AVPacket.stream_index "stream_index" field must be
2255  * set to the index of the corresponding stream in @ref
2256  * AVFormatContext.streams "s->streams". It is very strongly
2257  * recommended that timing information (@ref AVPacket.pts "pts", @ref
2258  * AVPacket.dts "dts", @ref AVPacket.duration "duration") is set to
2259  * correct values.
2260  * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush
2261  *
2262  * @see av_interleaved_write_frame()
2263  */
2265 
2266 /**
2267  * Write a packet to an output media file ensuring correct interleaving.
2268  *
2269  * This function will buffer the packets internally as needed to make sure the
2270  * packets in the output file are properly interleaved in the order of
2271  * increasing dts. Callers doing their own interleaving should call
2272  * av_write_frame() instead of this function.
2273  *
2274  * @param s media file handle
2275  * @param pkt The packet containing the data to be written.
2276  * <br>
2277  * If the packet is reference-counted, this function will take
2278  * ownership of this reference and unreference it later when it sees
2279  * fit.
2280  * The caller must not access the data through this reference after
2281  * this function returns. If the packet is not reference-counted,
2282  * libavformat will make a copy.
2283  * <br>
2284  * This parameter can be NULL (at any time, not just at the end), to
2285  * flush the interleaving queues.
2286  * <br>
2287  * Packet's @ref AVPacket.stream_index "stream_index" field must be
2288  * set to the index of the corresponding stream in @ref
2289  * AVFormatContext.streams "s->streams". It is very strongly
2290  * recommended that timing information (@ref AVPacket.pts "pts", @ref
2291  * AVPacket.dts "dts", @ref AVPacket.duration "duration") is set to
2292  * correct values.
2293  *
2294  * @return 0 on success, a negative AVERROR on error. Libavformat will always
2295  * take care of freeing the packet, even if this function fails.
2296  *
2297  * @see av_write_frame(), AVFormatContext.max_interleave_delta
2298  */
2300 
2301 /**
2302  * Write a uncoded frame to an output media file.
2303  *
2304  * The frame must be correctly interleaved according to the container
2305  * specification; if not, then av_interleaved_write_frame() must be used.
2306  *
2307  * See av_interleaved_write_frame() for details.
2308  */
2309 int av_write_uncoded_frame(AVFormatContext *s, int stream_index,
2310  AVFrame *frame);
2311 
2312 /**
2313  * Write a uncoded frame to an output media file.
2314  *
2315  * If the muxer supports it, this function allows to write an AVFrame
2316  * structure directly, without encoding it into a packet.
2317  * It is mostly useful for devices and similar special muxers that use raw
2318  * video or PCM data and will not serialize it into a byte stream.
2319  *
2320  * To test whether it is possible to use it with a given muxer and stream,
2321  * use av_write_uncoded_frame_query().
2322  *
2323  * The caller gives up ownership of the frame and must not access it
2324  * afterwards.
2325  *
2326  * @return >=0 for success, a negative code on error
2327  */
2328 int av_interleaved_write_uncoded_frame(AVFormatContext *s, int stream_index,
2329  AVFrame *frame);
2330 
2331 /**
2332  * Test whether a muxer supports uncoded frame.
2333  *
2334  * @return >=0 if an uncoded frame can be written to that muxer and stream,
2335  * <0 if not
2336  */
2337 int av_write_uncoded_frame_query(AVFormatContext *s, int stream_index);
2338 
2339 /**
2340  * Write the stream trailer to an output media file and free the
2341  * file private data.
2342  *
2343  * May only be called after a successful call to avformat_write_header.
2344  *
2345  * @param s media file handle
2346  * @return 0 if OK, AVERROR_xxx on error
2347  */
2349 
2350 /**
2351  * Return the output format in the list of registered output formats
2352  * which best matches the provided parameters, or return NULL if
2353  * there is no match.
2354  *
2355  * @param short_name if non-NULL checks if short_name matches with the
2356  * names of the registered formats
2357  * @param filename if non-NULL checks if filename terminates with the
2358  * extensions of the registered formats
2359  * @param mime_type if non-NULL checks if mime_type matches with the
2360  * MIME type of the registered formats
2361  */
2362 AVOutputFormat *av_guess_format(const char *short_name,
2363  const char *filename,
2364  const char *mime_type);
2365 
2366 /**
2367  * Guess the codec ID based upon muxer and filename.
2368  */
2369 enum AVCodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
2370  const char *filename, const char *mime_type,
2371  enum AVMediaType type);
2372 
2373 /**
2374  * Get timing information for the data currently output.
2375  * The exact meaning of "currently output" depends on the format.
2376  * It is mostly relevant for devices that have an internal buffer and/or
2377  * work in real time.
2378  * @param s media file handle
2379  * @param stream stream in the media file
2380  * @param[out] dts DTS of the last packet output for the stream, in stream
2381  * time_base units
2382  * @param[out] wall absolute time when that packet whas output,
2383  * in microsecond
2384  * @return 0 if OK, AVERROR(ENOSYS) if the format does not support it
2385  * Note: some formats or devices may not allow to measure dts and wall
2386  * atomically.
2387  */
2388 int av_get_output_timestamp(struct AVFormatContext *s, int stream,
2389  int64_t *dts, int64_t *wall);
2390 
2391 
2392 /**
2393  * @}
2394  */
2395 
2396 
2397 /**
2398  * @defgroup lavf_misc Utility functions
2399  * @ingroup libavf
2400  * @{
2401  *
2402  * Miscellaneous utility functions related to both muxing and demuxing
2403  * (or neither).
2404  */
2405 
2406 /**
2407  * Send a nice hexadecimal dump of a buffer to the specified file stream.
2408  *
2409  * @param f The file stream pointer where the dump should be sent to.
2410  * @param buf buffer
2411  * @param size buffer size
2412  *
2413  * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
2414  */
2415 void av_hex_dump(FILE *f, const uint8_t *buf, int size);
2416 
2417 /**
2418  * Send a nice hexadecimal dump of a buffer to the log.
2419  *
2420  * @param avcl A pointer to an arbitrary struct of which the first field is a
2421  * pointer to an AVClass struct.
2422  * @param level The importance level of the message, lower values signifying
2423  * higher importance.
2424  * @param buf buffer
2425  * @param size buffer size
2426  *
2427  * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
2428  */
2429 void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size);
2430 
2431 /**
2432  * Send a nice dump of a packet to the specified file stream.
2433  *
2434  * @param f The file stream pointer where the dump should be sent to.
2435  * @param pkt packet to dump
2436  * @param dump_payload True if the payload must be displayed, too.
2437  * @param st AVStream that the packet belongs to
2438  */
2439 void av_pkt_dump2(FILE *f, const AVPacket *pkt, int dump_payload, const AVStream *st);
2440 
2441 
2442 /**
2443  * Send a nice dump of a packet to the log.
2444  *
2445  * @param avcl A pointer to an arbitrary struct of which the first field is a
2446  * pointer to an AVClass struct.
2447  * @param level The importance level of the message, lower values signifying
2448  * higher importance.
2449  * @param pkt packet to dump
2450  * @param dump_payload True if the payload must be displayed, too.
2451  * @param st AVStream that the packet belongs to
2452  */
2453 void av_pkt_dump_log2(void *avcl, int level, const AVPacket *pkt, int dump_payload,
2454  const AVStream *st);
2455 
2456 /**
2457  * Get the AVCodecID for the given codec tag tag.
2458  * If no codec id is found returns AV_CODEC_ID_NONE.
2459  *
2460  * @param tags list of supported codec_id-codec_tag pairs, as stored
2461  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
2462  * @param tag codec tag to match to a codec ID
2463  */
2464 enum AVCodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
2465 
2466 /**
2467  * Get the codec tag for the given codec id id.
2468  * If no codec tag is found returns 0.
2469  *
2470  * @param tags list of supported codec_id-codec_tag pairs, as stored
2471  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
2472  * @param id codec ID to match to a codec tag
2473  */
2474 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum AVCodecID id);
2475 
2476 /**
2477  * Get the codec tag for the given codec id.
2478  *
2479  * @param tags list of supported codec_id - codec_tag pairs, as stored
2480  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
2481  * @param id codec id that should be searched for in the list
2482  * @param tag A pointer to the found tag
2483  * @return 0 if id was not found in tags, > 0 if it was found
2484  */
2485 int av_codec_get_tag2(const struct AVCodecTag * const *tags, enum AVCodecID id,
2486  unsigned int *tag);
2487 
2489 
2490 /**
2491  * Get the index for a specific timestamp.
2492  *
2493  * @param st stream that the timestamp belongs to
2494  * @param timestamp timestamp to retrieve the index for
2495  * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
2496  * to the timestamp which is <= the requested one, if backward
2497  * is 0, then it will be >=
2498  * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
2499  * @return < 0 if no such timestamp could be found
2500  */
2501 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
2502 
2503 /**
2504  * Add an index entry into a sorted list. Update the entry if the list
2505  * already contains it.
2506  *
2507  * @param timestamp timestamp in the time base of the given stream
2508  */
2509 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
2510  int size, int distance, int flags);
2511 
2512 
2513 /**
2514  * Split a URL string into components.
2515  *
2516  * The pointers to buffers for storing individual components may be null,
2517  * in order to ignore that component. Buffers for components not found are
2518  * set to empty strings. If the port is not found, it is set to a negative
2519  * value.
2520  *
2521  * @param proto the buffer for the protocol
2522  * @param proto_size the size of the proto buffer
2523  * @param authorization the buffer for the authorization
2524  * @param authorization_size the size of the authorization buffer
2525  * @param hostname the buffer for the host name
2526  * @param hostname_size the size of the hostname buffer
2527  * @param port_ptr a pointer to store the port number in
2528  * @param path the buffer for the path
2529  * @param path_size the size of the path buffer
2530  * @param url the URL to split
2531  */
2532 void av_url_split(char *proto, int proto_size,
2533  char *authorization, int authorization_size,
2534  char *hostname, int hostname_size,
2535  int *port_ptr,
2536  char *path, int path_size,
2537  const char *url);
2538 
2539 
2540 /**
2541  * Print detailed information about the input or output format, such as
2542  * duration, bitrate, streams, container, programs, metadata, side data,
2543  * codec and time base.
2544  *
2545  * @param ic the context to analyze
2546  * @param index index of the stream to dump information about
2547  * @param url the URL to print, such as source or destination file
2548  * @param is_output Select whether the specified context is an input(0) or output(1)
2549  */
2551  int index,
2552  const char *url,
2553  int is_output);
2554 
2555 /**
2556  * Return in 'buf' the path with '%d' replaced by a number.
2557  *
2558  * Also handles the '%0nd' format where 'n' is the total number
2559  * of digits and '%%'.
2560  *
2561  * @param buf destination buffer
2562  * @param buf_size destination buffer size
2563  * @param path numbered sequence string
2564  * @param number frame number
2565  * @return 0 if OK, -1 on format error
2566  */
2567 int av_get_frame_filename(char *buf, int buf_size,
2568  const char *path, int number);
2569 
2570 /**
2571  * Check whether filename actually is a numbered sequence generator.
2572  *
2573  * @param filename possible numbered sequence string
2574  * @return 1 if a valid numbered sequence string, 0 otherwise
2575  */
2576 int av_filename_number_test(const char *filename);
2577 
2578 /**
2579  * Generate an SDP for an RTP session.
2580  *
2581  * Note, this overwrites the id values of AVStreams in the muxer contexts
2582  * for getting unique dynamic payload types.
2583  *
2584  * @param ac array of AVFormatContexts describing the RTP streams. If the
2585  * array is composed by only one context, such context can contain
2586  * multiple AVStreams (one AVStream per RTP stream). Otherwise,
2587  * all the contexts in the array (an AVCodecContext per RTP stream)
2588  * must contain only one AVStream.
2589  * @param n_files number of AVCodecContexts contained in ac
2590  * @param buf buffer where the SDP will be stored (must be allocated by
2591  * the caller)
2592  * @param size the size of the buffer
2593  * @return 0 if OK, AVERROR_xxx on error
2594  */
2595 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
2596 
2597 /**
2598  * Return a positive value if the given filename has one of the given
2599  * extensions, 0 otherwise.
2600  *
2601  * @param filename file name to check against the given extensions
2602  * @param extensions a comma-separated list of filename extensions
2603  */
2604 int av_match_ext(const char *filename, const char *extensions);
2605 
2606 /**
2607  * Test if the given container can store a codec.
2608  *
2609  * @param ofmt container to check for compatibility
2610  * @param codec_id codec to potentially store in container
2611  * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
2612  *
2613  * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
2614  * A negative number if this information is not available.
2615  */
2617  int std_compliance);
2618 
2619 /**
2620  * @defgroup riff_fourcc RIFF FourCCs
2621  * @{
2622  * Get the tables mapping RIFF FourCCs to libavcodec AVCodecIDs. The tables are
2623  * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the
2624  * following code:
2625  * @code
2626  * uint32_t tag = MKTAG('H', '2', '6', '4');
2627  * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 };
2628  * enum AVCodecID id = av_codec_get_id(table, tag);
2629  * @endcode
2630  */
2631 /**
2632  * @return the table mapping RIFF FourCCs for video to libavcodec AVCodecID.
2633  */
2634 const struct AVCodecTag *avformat_get_riff_video_tags(void);
2635 /**
2636  * @return the table mapping RIFF FourCCs for audio to AVCodecID.
2637  */
2638 const struct AVCodecTag *avformat_get_riff_audio_tags(void);
2639 /**
2640  * @return the table mapping MOV FourCCs for video to libavcodec AVCodecID.
2641  */
2642 const struct AVCodecTag *avformat_get_mov_video_tags(void);
2643 /**
2644  * @return the table mapping MOV FourCCs for audio to AVCodecID.
2645  */
2646 const struct AVCodecTag *avformat_get_mov_audio_tags(void);
2647 
2648 /**
2649  * @}
2650  */
2651 
2652 /**
2653  * Guess the sample aspect ratio of a frame, based on both the stream and the
2654  * frame aspect ratio.
2655  *
2656  * Since the frame aspect ratio is set by the codec but the stream aspect ratio
2657  * is set by the demuxer, these two may not be equal. This function tries to
2658  * return the value that you should use if you would like to display the frame.
2659  *
2660  * Basic logic is to use the stream aspect ratio if it is set to something sane
2661  * otherwise use the frame aspect ratio. This way a container setting, which is
2662  * usually easy to modify can override the coded value in the frames.
2663  *
2664  * @param format the format context which the stream is part of
2665  * @param stream the stream which the frame is part of
2666  * @param frame the frame with the aspect ratio to be determined
2667  * @return the guessed (valid) sample_aspect_ratio, 0/1 if no idea
2668  */
2670 
2671 /**
2672  * Guess the frame rate, based on both the container and codec information.
2673  *
2674  * @param ctx the format context which the stream is part of
2675  * @param stream the stream which the frame is part of
2676  * @param frame the frame for which the frame rate should be determined, may be NULL
2677  * @return the guessed (valid) frame rate, 0/1 if no idea
2678  */
2680 
2681 /**
2682  * Check if the stream st contained in s is matched by the stream specifier
2683  * spec.
2684  *
2685  * See the "stream specifiers" chapter in the documentation for the syntax
2686  * of spec.
2687  *
2688  * @return >0 if st is matched by spec;
2689  * 0 if st is not matched by spec;
2690  * AVERROR code if spec is invalid
2691  *
2692  * @note A stream specifier can match several streams in the format.
2693  */
2695  const char *spec);
2696 
2698 
2699 
2700 /**
2701  * @}
2702  */
2703 
2704 #endif /* AVFORMAT_AVFORMAT_H */