libavformat: Rename the applehttp protocol to hls
[ffmpeg.git] / libavformat / avformat.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; 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 Libav 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  * @defgroup lavf_decoding Demuxing
70  * @{
71  * Demuxers read a media file and split it into chunks of data (@em packets). A
72  * @ref AVPacket "packet" contains one or more frames which belong a single
73  * elementary stream. In lavf API this process is represented by the
74  * avformat_open_input() function for opening a file, av_read_frame() for
75  * reading a single packet and finally avformat_close_input(), which does the
76  * cleanup.
77  *
78  * @section lavf_decoding_open Opening a media file
79  * The minimum information required to open a file is its URL or filename, which
80  * is passed to avformat_open_input(), as in the following code:
81  * @code
82  * const char    *url = "in.mp3";
83  * AVFormatContext *s = NULL;
84  * int ret = avformat_open_input(&s, url, NULL, NULL);
85  * if (ret < 0)
86  *     abort();
87  * @endcode
88  * The above code attempts to allocate an AVFormatContext, open the
89  * specified file (autodetecting the format) and read the header, exporting the
90  * information stored there into s. Some formats do not have a header or do not
91  * store enough information there, so it is recommended that you call the
92  * avformat_find_stream_info() function which tries to read and decode a few
93  * frames to find missing information.
94  *
95  * In some cases you might want to preallocate an AVFormatContext yourself with
96  * avformat_alloc_context() and do some tweaking on it before passing it to
97  * avformat_open_input(). One such case is when you want to use custom functions
98  * for reading input data instead of lavf internal I/O layer.
99  * To do that, create your own AVIOContext with avio_alloc_context(), passing
100  * your reading callbacks to it. Then set the @em pb field of your
101  * AVFormatContext to newly created AVIOContext.
102  *
103  * After you have finished reading the file, you must close it with
104  * avformat_close_input(). It will free everything associated with the file.
105  *
106  * @section lavf_decoding_read Reading from an opened file
107  *
108  * @section lavf_decoding_seek Seeking
109  * @}
110  *
111  * @defgroup lavf_encoding Muxing
112  * @{
113  * @}
114  *
115  * @defgroup lavf_io I/O Read/Write
116  * @{
117  * @}
118  *
119  * @defgroup lavf_codec Demuxers
120  * @{
121  * @defgroup lavf_codec_native Native Demuxers
122  * @{
123  * @}
124  * @defgroup lavf_codec_wrappers External library wrappers
125  * @{
126  * @}
127  * @}
128  * @defgroup lavf_protos I/O Protocols
129  * @{
130  * @}
131  * @defgroup lavf_internal Internal
132  * @{
133  * @}
134  * @}
135  *
136  */
137
138 #include <time.h>
139 #include <stdio.h>  /* FILE */
140 #include "libavcodec/avcodec.h"
141 #include "libavutil/dict.h"
142 #include "libavutil/log.h"
143
144 #include "avio.h"
145 #include "libavformat/version.h"
146
147 struct AVFormatContext;
148
149
150 /**
151  * @defgroup metadata_api Public Metadata API
152  * @{
153  * @ingroup libavf
154  * The metadata API allows libavformat to export metadata tags to a client
155  * application when demuxing. Conversely it allows a client application to
156  * set metadata when muxing.
157  *
158  * Metadata is exported or set as pairs of key/value strings in the 'metadata'
159  * fields of the AVFormatContext, AVStream, AVChapter and AVProgram structs
160  * using the @ref lavu_dict "AVDictionary" API. Like all strings in Libav,
161  * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata
162  * exported by demuxers isn't checked to be valid UTF-8 in most cases.
163  *
164  * Important concepts to keep in mind:
165  * -  Keys are unique; there can never be 2 tags with the same key. This is
166  *    also meant semantically, i.e., a demuxer should not knowingly produce
167  *    several keys that are literally different but semantically identical.
168  *    E.g., key=Author5, key=Author6. In this example, all authors must be
169  *    placed in the same tag.
170  * -  Metadata is flat, not hierarchical; there are no subtags. If you
171  *    want to store, e.g., the email address of the child of producer Alice
172  *    and actor Bob, that could have key=alice_and_bobs_childs_email_address.
173  * -  Several modifiers can be applied to the tag name. This is done by
174  *    appending a dash character ('-') and the modifier name in the order
175  *    they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
176  *    -  language -- a tag whose value is localized for a particular language
177  *       is appended with the ISO 639-2/B 3-letter language code.
178  *       For example: Author-ger=Michael, Author-eng=Mike
179  *       The original/default language is in the unqualified "Author" tag.
180  *       A demuxer should set a default if it sets any translated tag.
181  *    -  sorting  -- a modified version of a tag that should be used for
182  *       sorting will have '-sort' appended. E.g. artist="The Beatles",
183  *       artist-sort="Beatles, The".
184  *
185  * -  Demuxers attempt to export metadata in a generic format, however tags
186  *    with no generic equivalents are left as they are stored in the container.
187  *    Follows a list of generic tag names:
188  *
189  @verbatim
190  album        -- name of the set this work belongs to
191  album_artist -- main creator of the set/album, if different from artist.
192                  e.g. "Various Artists" for compilation albums.
193  artist       -- main creator of the work
194  comment      -- any additional description of the file.
195  composer     -- who composed the work, if different from artist.
196  copyright    -- name of copyright holder.
197  creation_time-- date when the file was created, preferably in ISO 8601.
198  date         -- date when the work was created, preferably in ISO 8601.
199  disc         -- number of a subset, e.g. disc in a multi-disc collection.
200  encoder      -- name/settings of the software/hardware that produced the file.
201  encoded_by   -- person/group who created the file.
202  filename     -- original name of the file.
203  genre        -- <self-evident>.
204  language     -- main language in which the work is performed, preferably
205                  in ISO 639-2 format. Multiple languages can be specified by
206                  separating them with commas.
207  performer    -- artist who performed the work, if different from artist.
208                  E.g for "Also sprach Zarathustra", artist would be "Richard
209                  Strauss" and performer "London Philharmonic Orchestra".
210  publisher    -- name of the label/publisher.
211  service_name     -- name of the service in broadcasting (channel name).
212  service_provider -- name of the service provider in broadcasting.
213  title        -- name of the work.
214  track        -- number of this work in the set, can be in form current/total.
215  variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
216  @endverbatim
217  *
218  * Look in the examples section for an application example how to use the Metadata API.
219  *
220  * @}
221  */
222
223 /* packet functions */
224
225
226 /**
227  * Allocate and read the payload of a packet and initialize its
228  * fields with default values.
229  *
230  * @param pkt packet
231  * @param size desired payload size
232  * @return >0 (read size) if OK, AVERROR_xxx otherwise
233  */
234 int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
235
236
237 /**
238  * Read data and append it to the current content of the AVPacket.
239  * If pkt->size is 0 this is identical to av_get_packet.
240  * Note that this uses av_grow_packet and thus involves a realloc
241  * which is inefficient. Thus this function should only be used
242  * when there is no reasonable way to know (an upper bound of)
243  * the final size.
244  *
245  * @param pkt packet
246  * @param size amount of data to read
247  * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
248  *         will not be lost even if an error occurs.
249  */
250 int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
251
252 /*************************************************/
253 /* fractional numbers for exact pts handling */
254
255 /**
256  * The exact value of the fractional number is: 'val + num / den'.
257  * num is assumed to be 0 <= num < den.
258  */
259 typedef struct AVFrac {
260     int64_t val, num, den;
261 } AVFrac;
262
263 /*************************************************/
264 /* input/output formats */
265
266 struct AVCodecTag;
267
268 /**
269  * This structure contains the data a format has to probe a file.
270  */
271 typedef struct AVProbeData {
272     const char *filename;
273     unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
274     int buf_size;       /**< Size of buf except extra allocated bytes */
275 } AVProbeData;
276
277 #define AVPROBE_SCORE_MAX 100               ///< maximum score, half of that is used for file-extension-based detection
278 #define AVPROBE_PADDING_SIZE 32             ///< extra allocated bytes at the end of the probe buffer
279
280 /// Demuxer will use avio_open, no opened file should be provided by the caller.
281 #define AVFMT_NOFILE        0x0001
282 #define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
283 #define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
284 #define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
285                                       raw picture data. */
286 #define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
287 #define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
288 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
289 #define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
290 #define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
291 #define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
292 #define AVFMT_NOSTREAMS     0x1000 /**< Format does not require any streams */
293 #define AVFMT_NOBINSEARCH   0x2000 /**< Format does not allow to fallback to binary search via read_timestamp */
294 #define AVFMT_NOGENSEARCH   0x4000 /**< Format does not allow to fallback to generic search */
295 #define AVFMT_NO_BYTE_SEEK  0x8000 /**< Format does not allow seeking by bytes */
296 #define AVFMT_ALLOW_FLUSH  0x10000 /**< Format allows flushing. If not set, the muxer will not receive a NULL packet in the write_packet function. */
297
298 /**
299  * @addtogroup lavf_encoding
300  * @{
301  */
302 typedef struct AVOutputFormat {
303     const char *name;
304     /**
305      * Descriptive name for the format, meant to be more human-readable
306      * than name. You should use the NULL_IF_CONFIG_SMALL() macro
307      * to define it.
308      */
309     const char *long_name;
310     const char *mime_type;
311     const char *extensions; /**< comma-separated filename extensions */
312     /* output support */
313     enum CodecID audio_codec;    /**< default audio codec */
314     enum CodecID video_codec;    /**< default video codec */
315     enum CodecID subtitle_codec; /**< default subtitle codec */
316     /**
317      * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
318      * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
319      * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS, AVFMT_ALLOW_FLUSH
320      */
321     int flags;
322
323     /**
324      * List of supported codec_id-codec_tag pairs, ordered by "better
325      * choice first". The arrays are all terminated by CODEC_ID_NONE.
326      */
327     const struct AVCodecTag * const *codec_tag;
328
329
330     const AVClass *priv_class; ///< AVClass for the private context
331
332     /*****************************************************************
333      * No fields below this line are part of the public API. They
334      * may not be used outside of libavformat and can be changed and
335      * removed at will.
336      * New public fields should be added right above.
337      *****************************************************************
338      */
339     struct AVOutputFormat *next;
340     /**
341      * size of private data so that it can be allocated in the wrapper
342      */
343     int priv_data_size;
344
345     int (*write_header)(struct AVFormatContext *);
346     /**
347      * Write a packet. If AVFMT_ALLOW_FLUSH is set in flags,
348      * pkt can be NULL in order to flush data buffered in the muxer.
349      * When flushing, return 0 if there still is more data to flush,
350      * or 1 if everything was flushed and there is no more buffered
351      * data.
352      */
353     int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
354     int (*write_trailer)(struct AVFormatContext *);
355     /**
356      * Currently only used to set pixel format if not YUV420P.
357      */
358     int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
359                              AVPacket *in, int flush);
360     /**
361      * Test if the given codec can be stored in this container.
362      *
363      * @return 1 if the codec is supported, 0 if it is not.
364      *         A negative number if unknown.
365      */
366     int (*query_codec)(enum CodecID id, int std_compliance);
367 } AVOutputFormat;
368 /**
369  * @}
370  */
371
372 /**
373  * @addtogroup lavf_decoding
374  * @{
375  */
376 typedef struct AVInputFormat {
377     /**
378      * A comma separated list of short names for the format. New names
379      * may be appended with a minor bump.
380      */
381     const char *name;
382
383     /**
384      * Descriptive name for the format, meant to be more human-readable
385      * than name. You should use the NULL_IF_CONFIG_SMALL() macro
386      * to define it.
387      */
388     const char *long_name;
389
390     /**
391      * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
392      * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
393      * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK.
394      */
395     int flags;
396
397     /**
398      * If extensions are defined, then no probe is done. You should
399      * usually not use extension format guessing because it is not
400      * reliable enough
401      */
402     const char *extensions;
403
404     const struct AVCodecTag * const *codec_tag;
405
406     const AVClass *priv_class; ///< AVClass for the private context
407
408     /*****************************************************************
409      * No fields below this line are part of the public API. They
410      * may not be used outside of libavformat and can be changed and
411      * removed at will.
412      * New public fields should be added right above.
413      *****************************************************************
414      */
415     struct AVInputFormat *next;
416
417     /**
418      * Raw demuxers store their codec ID here.
419      */
420     int raw_codec_id;
421
422     /**
423      * Size of private data so that it can be allocated in the wrapper.
424      */
425     int priv_data_size;
426
427     /**
428      * Tell if a given file has a chance of being parsed as this format.
429      * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
430      * big so you do not have to check for that unless you need more.
431      */
432     int (*read_probe)(AVProbeData *);
433
434     /**
435      * Read the format header and initialize the AVFormatContext
436      * structure. Return 0 if OK. 'ap' if non-NULL contains
437      * additional parameters. Only used in raw format right
438      * now. 'av_new_stream' should be called to create new streams.
439      */
440     int (*read_header)(struct AVFormatContext *);
441
442     /**
443      * Read one packet and put it in 'pkt'. pts and flags are also
444      * set. 'av_new_stream' can be called only if the flag
445      * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
446      * background thread).
447      * @return 0 on success, < 0 on error.
448      *         When returning an error, pkt must not have been allocated
449      *         or must be freed before returning
450      */
451     int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
452
453     /**
454      * Close the stream. The AVFormatContext and AVStreams are not
455      * freed by this function
456      */
457     int (*read_close)(struct AVFormatContext *);
458
459     /**
460      * Seek to a given timestamp relative to the frames in
461      * stream component stream_index.
462      * @param stream_index Must not be -1.
463      * @param flags Selects which direction should be preferred if no exact
464      *              match is available.
465      * @return >= 0 on success (but not necessarily the new offset)
466      */
467     int (*read_seek)(struct AVFormatContext *,
468                      int stream_index, int64_t timestamp, int flags);
469
470     /**
471      * Get the next timestamp in stream[stream_index].time_base units.
472      * @return the timestamp or AV_NOPTS_VALUE if an error occurred
473      */
474     int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
475                               int64_t *pos, int64_t pos_limit);
476
477     /**
478      * Start/resume playing - only meaningful if using a network-based format
479      * (RTSP).
480      */
481     int (*read_play)(struct AVFormatContext *);
482
483     /**
484      * Pause playing - only meaningful if using a network-based format
485      * (RTSP).
486      */
487     int (*read_pause)(struct AVFormatContext *);
488
489     /**
490      * Seek to timestamp ts.
491      * Seeking will be done so that the point from which all active streams
492      * can be presented successfully will be closest to ts and within min/max_ts.
493      * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
494      */
495     int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
496 } AVInputFormat;
497 /**
498  * @}
499  */
500
501 enum AVStreamParseType {
502     AVSTREAM_PARSE_NONE,
503     AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
504     AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
505     AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
506     AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
507 };
508
509 typedef struct AVIndexEntry {
510     int64_t pos;
511     int64_t timestamp;
512 #define AVINDEX_KEYFRAME 0x0001
513     int flags:2;
514     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).
515     int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
516 } AVIndexEntry;
517
518 #define AV_DISPOSITION_DEFAULT   0x0001
519 #define AV_DISPOSITION_DUB       0x0002
520 #define AV_DISPOSITION_ORIGINAL  0x0004
521 #define AV_DISPOSITION_COMMENT   0x0008
522 #define AV_DISPOSITION_LYRICS    0x0010
523 #define AV_DISPOSITION_KARAOKE   0x0020
524
525 /**
526  * Track should be used during playback by default.
527  * Useful for subtitle track that should be displayed
528  * even when user did not explicitly ask for subtitles.
529  */
530 #define AV_DISPOSITION_FORCED    0x0040
531 #define AV_DISPOSITION_HEARING_IMPAIRED  0x0080  /**< stream for hearing impaired audiences */
532 #define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100  /**< stream for visual impaired audiences */
533 #define AV_DISPOSITION_CLEAN_EFFECTS     0x0200  /**< stream without voice */
534
535 /**
536  * Stream structure.
537  * New fields can be added to the end with minor version bumps.
538  * Removal, reordering and changes to existing fields require a major
539  * version bump.
540  * sizeof(AVStream) must not be used outside libav*.
541  */
542 typedef struct AVStream {
543     int index;    /**< stream index in AVFormatContext */
544     int id;       /**< format-specific stream ID */
545     AVCodecContext *codec; /**< codec context */
546     /**
547      * Real base framerate of the stream.
548      * This is the lowest framerate with which all timestamps can be
549      * represented accurately (it is the least common multiple of all
550      * framerates in the stream). Note, this value is just a guess!
551      * For example, if the time base is 1/90000 and all frames have either
552      * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
553      */
554     AVRational r_frame_rate;
555     void *priv_data;
556
557     /**
558      * encoding: pts generation when outputting stream
559      */
560     struct AVFrac pts;
561
562     /**
563      * This is the fundamental unit of time (in seconds) in terms
564      * of which frame timestamps are represented. For fixed-fps content,
565      * time base should be 1/framerate and timestamp increments should be 1.
566      * decoding: set by libavformat
567      * encoding: set by libavformat in av_write_header
568      */
569     AVRational time_base;
570     enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
571
572     /**
573      * Decoding: pts of the first frame of the stream, in stream time base.
574      * Only set this if you are absolutely 100% sure that the value you set
575      * it to really is the pts of the first frame.
576      * This may be undefined (AV_NOPTS_VALUE).
577      */
578     int64_t start_time;
579
580     /**
581      * Decoding: duration of the stream, in stream time base.
582      * If a source file does not specify a duration, but does specify
583      * a bitrate, this value will be estimated from bitrate and file size.
584      */
585     int64_t duration;
586
587     int64_t nb_frames;                 ///< number of frames in this stream if known or 0
588
589     int disposition; /**< AV_DISPOSITION_* bit field */
590
591     /**
592      * sample aspect ratio (0 if unknown)
593      * - encoding: Set by user.
594      * - decoding: Set by libavformat.
595      */
596     AVRational sample_aspect_ratio;
597
598     AVDictionary *metadata;
599
600     /**
601      * Average framerate
602      */
603     AVRational avg_frame_rate;
604
605     /*****************************************************************
606      * All fields below this line are not part of the public API. They
607      * may not be used outside of libavformat and can be changed and
608      * removed at will.
609      * New public fields should be added right above.
610      *****************************************************************
611      */
612
613     /**
614      * Number of frames that have been demuxed during av_find_stream_info()
615      */
616     int codec_info_nb_frames;
617
618     /**
619      * Stream information used internally by av_find_stream_info()
620      */
621 #define MAX_STD_TIMEBASES (60*12+5)
622     struct {
623         int64_t last_dts;
624         int64_t duration_gcd;
625         int duration_count;
626         double duration_error[MAX_STD_TIMEBASES];
627         int64_t codec_info_duration;
628         int nb_decoded_frames;
629     } *info;
630     const uint8_t *cur_ptr;
631     int cur_len;
632     AVPacket cur_pkt;
633
634     // Timestamp generation support:
635     /**
636      * Timestamp corresponding to the last dts sync point.
637      *
638      * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
639      * a DTS is received from the underlying container. Otherwise set to
640      * AV_NOPTS_VALUE by default.
641      */
642     int64_t reference_dts;
643     int64_t first_dts;
644     int64_t cur_dts;
645     int last_IP_duration;
646     int64_t last_IP_pts;
647
648     /**
649      * Number of packets to buffer for codec probing
650      */
651 #define MAX_PROBE_PACKETS 2500
652     int probe_packets;
653
654     /**
655      * last packet in packet_buffer for this stream when muxing.
656      */
657     struct AVPacketList *last_in_packet_buffer;
658     AVProbeData probe_data;
659 #define MAX_REORDER_DELAY 16
660     int64_t pts_buffer[MAX_REORDER_DELAY+1];
661     /* av_read_frame() support */
662     enum AVStreamParseType need_parsing;
663     struct AVCodecParserContext *parser;
664
665     AVIndexEntry *index_entries; /**< Only used if the format does not
666                                     support seeking natively. */
667     int nb_index_entries;
668     unsigned int index_entries_allocated_size;
669
670     int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
671 } AVStream;
672
673 #define AV_PROGRAM_RUNNING 1
674
675 /**
676  * New fields can be added to the end with minor version bumps.
677  * Removal, reordering and changes to existing fields require a major
678  * version bump.
679  * sizeof(AVProgram) must not be used outside libav*.
680  */
681 typedef struct AVProgram {
682     int            id;
683     int            flags;
684     enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
685     unsigned int   *stream_index;
686     unsigned int   nb_stream_indexes;
687     AVDictionary *metadata;
688 } AVProgram;
689
690 #define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
691                                          (streams are added dynamically) */
692
693 typedef struct AVChapter {
694     int id;                 ///< unique ID to identify the chapter
695     AVRational time_base;   ///< time base in which the start/end timestamps are specified
696     int64_t start, end;     ///< chapter start/end time in time_base units
697     AVDictionary *metadata;
698 } AVChapter;
699
700 /**
701  * Format I/O context.
702  * New fields can be added to the end with minor version bumps.
703  * Removal, reordering and changes to existing fields require a major
704  * version bump.
705  * sizeof(AVFormatContext) must not be used outside libav*, use
706  * avformat_alloc_context() to create an AVFormatContext.
707  */
708 typedef struct AVFormatContext {
709     /**
710      * A class for logging and AVOptions. Set by avformat_alloc_context().
711      * Exports (de)muxer private options if they exist.
712      */
713     const AVClass *av_class;
714
715     /**
716      * Can only be iformat or oformat, not both at the same time.
717      *
718      * decoding: set by avformat_open_input().
719      * encoding: set by the user.
720      */
721     struct AVInputFormat *iformat;
722     struct AVOutputFormat *oformat;
723
724     /**
725      * Format private data. This is an AVOptions-enabled struct
726      * if and only if iformat/oformat.priv_class is not NULL.
727      */
728     void *priv_data;
729
730     /*
731      * I/O context.
732      *
733      * decoding: either set by the user before avformat_open_input() (then
734      * the user must close it manually) or set by avformat_open_input().
735      * encoding: set by the user.
736      *
737      * Do NOT set this field if AVFMT_NOFILE flag is set in
738      * iformat/oformat.flags. In such a case, the (de)muxer will handle
739      * I/O in some other way and this field will be NULL.
740      */
741     AVIOContext *pb;
742
743     /**
744      * A list of all streams in the file. New streams are created with
745      * avformat_new_stream().
746      *
747      * decoding: streams are created by libavformat in avformat_open_input().
748      * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
749      * appear in av_read_frame().
750      * encoding: streams are created by the user before avformat_write_header().
751      */
752     unsigned int nb_streams;
753     AVStream **streams;
754
755     char filename[1024]; /**< input or output filename */
756     /* stream info */
757     int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
758
759     /**
760      * Decoding: position of the first frame of the component, in
761      * AV_TIME_BASE fractional seconds. NEVER set this value directly:
762      * It is deduced from the AVStream values.
763      */
764     int64_t start_time;
765
766     /**
767      * Decoding: duration of the stream, in AV_TIME_BASE fractional
768      * seconds. Only set this value if you know none of the individual stream
769      * durations and also do not set any of them. This is deduced from the
770      * AVStream values if not set.
771      */
772     int64_t duration;
773
774     /**
775      * Decoding: total stream bitrate in bit/s, 0 if not
776      * available. Never set it directly if the file_size and the
777      * duration are known as Libav can compute it automatically.
778      */
779     int bit_rate;
780
781     unsigned int packet_size;
782     int max_delay;
783
784     int flags;
785 #define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
786 #define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
787 #define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
788 #define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
789 #define AVFMT_FLAG_NOFILLIN     0x0010 ///< Do not infer any values from other values, just return what is stored in the container
790 #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
791 #define AVFMT_FLAG_CUSTOM_IO    0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
792 #define AVFMT_FLAG_DISCARD_CORRUPT  0x0100 ///< Discard frames marked corrupted
793
794     /**
795      * decoding: size of data to probe; encoding: unused.
796      */
797     unsigned int probesize;
798
799     /**
800      * decoding: maximum time (in AV_TIME_BASE units) during which the input should
801      * be analyzed in avformat_find_stream_info().
802      */
803     int max_analyze_duration;
804
805     const uint8_t *key;
806     int keylen;
807
808     unsigned int nb_programs;
809     AVProgram **programs;
810
811     /**
812      * Forced video codec_id.
813      * Demuxing: Set by user.
814      */
815     enum CodecID video_codec_id;
816
817     /**
818      * Forced audio codec_id.
819      * Demuxing: Set by user.
820      */
821     enum CodecID audio_codec_id;
822
823     /**
824      * Forced subtitle codec_id.
825      * Demuxing: Set by user.
826      */
827     enum CodecID subtitle_codec_id;
828
829     /**
830      * Maximum amount of memory in bytes to use for the index of each stream.
831      * If the index exceeds this size, entries will be discarded as
832      * needed to maintain a smaller size. This can lead to slower or less
833      * accurate seeking (depends on demuxer).
834      * Demuxers for which a full in-memory index is mandatory will ignore
835      * this.
836      * muxing  : unused
837      * demuxing: set by user
838      */
839     unsigned int max_index_size;
840
841     /**
842      * Maximum amount of memory in bytes to use for buffering frames
843      * obtained from realtime capture devices.
844      */
845     unsigned int max_picture_buffer;
846
847     unsigned int nb_chapters;
848     AVChapter **chapters;
849
850     /**
851      * Flags to enable debugging.
852      */
853     int debug;
854 #define FF_FDEBUG_TS        0x0001
855
856     AVDictionary *metadata;
857
858     /**
859      * Start time of the stream in real world time, in microseconds
860      * since the unix epoch (00:00 1st January 1970). That is, pts=0
861      * in the stream was captured at this real world time.
862      * - encoding: Set by user.
863      * - decoding: Unused.
864      */
865     int64_t start_time_realtime;
866
867     /**
868      * decoding: number of frames used to probe fps
869      */
870     int fps_probe_size;
871
872     /**
873      * Error recognition; higher values will detect more errors but may
874      * misdetect some more or less valid parts as errors.
875      * - encoding: unused
876      * - decoding: Set by user.
877      */
878     int error_recognition;
879
880     /**
881      * Custom interrupt callbacks for the I/O layer.
882      *
883      * decoding: set by the user before avformat_open_input().
884      * encoding: set by the user before avformat_write_header()
885      * (mainly useful for AVFMT_NOFILE formats). The callback
886      * should also be passed to avio_open2() if it's used to
887      * open the file.
888      */
889     AVIOInterruptCB interrupt_callback;
890
891     /*****************************************************************
892      * All fields below this line are not part of the public API. They
893      * may not be used outside of libavformat and can be changed and
894      * removed at will.
895      * New public fields should be added right above.
896      *****************************************************************
897      */
898     /**
899      * Raw packets from the demuxer, prior to parsing and decoding.
900      * This buffer is used for buffering packets until the codec can
901      * be identified, as parsing cannot be done without knowing the
902      * codec.
903      */
904     struct AVPacketList *raw_packet_buffer;
905     struct AVPacketList *raw_packet_buffer_end;
906     /**
907      * Remaining size available for raw_packet_buffer, in bytes.
908      */
909 #define RAW_PACKET_BUFFER_SIZE 2500000
910     int raw_packet_buffer_remaining_size;
911
912     /**
913      * This buffer is only needed when packets were already buffered but
914      * not decoded, for example to get the codec parameters in MPEG
915      * streams.
916      */
917     struct AVPacketList *packet_buffer;
918     struct AVPacketList *packet_buffer_end;
919
920     /* av_read_frame() support */
921     AVStream *cur_st;
922
923     /* av_seek_frame() support */
924     int64_t data_offset; /**< offset of the first packet */
925 } AVFormatContext;
926
927 typedef struct AVPacketList {
928     AVPacket pkt;
929     struct AVPacketList *next;
930 } AVPacketList;
931
932
933 /**
934  * @defgroup lavf_core Core functions
935  * @ingroup libavf
936  *
937  * Functions for querying libavformat capabilities, allocating core structures,
938  * etc.
939  * @{
940  */
941
942 /**
943  * Return the LIBAVFORMAT_VERSION_INT constant.
944  */
945 unsigned avformat_version(void);
946
947 /**
948  * Return the libavformat build-time configuration.
949  */
950 const char *avformat_configuration(void);
951
952 /**
953  * Return the libavformat license.
954  */
955 const char *avformat_license(void);
956
957 /**
958  * Initialize libavformat and register all the muxers, demuxers and
959  * protocols. If you do not call this function, then you can select
960  * exactly which formats you want to support.
961  *
962  * @see av_register_input_format()
963  * @see av_register_output_format()
964  * @see av_register_protocol()
965  */
966 void av_register_all(void);
967
968 void av_register_input_format(AVInputFormat *format);
969 void av_register_output_format(AVOutputFormat *format);
970
971 /**
972  * Do global initialization of network components. This is optional,
973  * but recommended, since it avoids the overhead of implicitly
974  * doing the setup for each session.
975  *
976  * Calling this function will become mandatory if using network
977  * protocols at some major version bump.
978  */
979 int avformat_network_init(void);
980
981 /**
982  * Undo the initialization done by avformat_network_init.
983  */
984 int avformat_network_deinit(void);
985
986 /**
987  * If f is NULL, returns the first registered input format,
988  * if f is non-NULL, returns the next registered input format after f
989  * or NULL if f is the last one.
990  */
991 AVInputFormat  *av_iformat_next(AVInputFormat  *f);
992
993 /**
994  * If f is NULL, returns the first registered output format,
995  * if f is non-NULL, returns the next registered output format after f
996  * or NULL if f is the last one.
997  */
998 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
999
1000 /**
1001  * Allocate an AVFormatContext.
1002  * avformat_free_context() can be used to free the context and everything
1003  * allocated by the framework within it.
1004  */
1005 AVFormatContext *avformat_alloc_context(void);
1006
1007 /**
1008  * Free an AVFormatContext and all its streams.
1009  * @param s context to free
1010  */
1011 void avformat_free_context(AVFormatContext *s);
1012
1013 /**
1014  * Get the AVClass for AVFormatContext. It can be used in combination with
1015  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1016  *
1017  * @see av_opt_find().
1018  */
1019 const AVClass *avformat_get_class(void);
1020
1021 /**
1022  * Add a new stream to a media file.
1023  *
1024  * When demuxing, it is called by the demuxer in read_header(). If the
1025  * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1026  * be called in read_packet().
1027  *
1028  * When muxing, should be called by the user before avformat_write_header().
1029  *
1030  * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1031  * will be initialized to use this codec. This is needed for e.g. codec-specific
1032  * defaults to be set, so codec should be provided if it is known.
1033  *
1034  * @return newly created stream or NULL on error.
1035  */
1036 AVStream *avformat_new_stream(AVFormatContext *s, AVCodec *c);
1037
1038 AVProgram *av_new_program(AVFormatContext *s, int id);
1039
1040 /**
1041  * @}
1042  */
1043
1044
1045 /**
1046  * @addtogroup lavf_decoding
1047  * @{
1048  */
1049
1050 /**
1051  * Find AVInputFormat based on the short name of the input format.
1052  */
1053 AVInputFormat *av_find_input_format(const char *short_name);
1054
1055 /**
1056  * Guess the file format.
1057  *
1058  * @param is_opened Whether the file is already opened; determines whether
1059  *                  demuxers with or without AVFMT_NOFILE are probed.
1060  */
1061 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1062
1063 /**
1064  * Guess the file format.
1065  *
1066  * @param is_opened Whether the file is already opened; determines whether
1067  *                  demuxers with or without AVFMT_NOFILE are probed.
1068  * @param score_max A probe score larger that this is required to accept a
1069  *                  detection, the variable is set to the actual detection
1070  *                  score afterwards.
1071  *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1072  *                  to retry with a larger probe buffer.
1073  */
1074 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1075
1076 /**
1077  * Probe a bytestream to determine the input format. Each time a probe returns
1078  * with a score that is too low, the probe buffer size is increased and another
1079  * attempt is made. When the maximum probe size is reached, the input format
1080  * with the highest score is returned.
1081  *
1082  * @param pb the bytestream to probe
1083  * @param fmt the input format is put here
1084  * @param filename the filename of the stream
1085  * @param logctx the log context
1086  * @param offset the offset within the bytestream to probe from
1087  * @param max_probe_size the maximum probe buffer size (zero for default)
1088  * @return 0 in case of success, a negative value corresponding to an
1089  * AVERROR code otherwise
1090  */
1091 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1092                           const char *filename, void *logctx,
1093                           unsigned int offset, unsigned int max_probe_size);
1094
1095 /**
1096  * Open an input stream and read the header. The codecs are not opened.
1097  * The stream must be closed with av_close_input_file().
1098  *
1099  * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1100  *           May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1101  *           function and written into ps.
1102  *           Note that a user-supplied AVFormatContext will be freed on failure.
1103  * @param filename Name of the stream to open.
1104  * @param fmt If non-NULL, this parameter forces a specific input format.
1105  *            Otherwise the format is autodetected.
1106  * @param options  A dictionary filled with AVFormatContext and demuxer-private options.
1107  *                 On return this parameter will be destroyed and replaced with a dict containing
1108  *                 options that were not found. May be NULL.
1109  *
1110  * @return 0 on success, a negative AVERROR on failure.
1111  *
1112  * @note If you want to use custom IO, preallocate the format context and set its pb field.
1113  */
1114 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1115
1116 /**
1117  * Read packets of a media file to get stream information. This
1118  * is useful for file formats with no headers such as MPEG. This
1119  * function also computes the real framerate in case of MPEG-2 repeat
1120  * frame mode.
1121  * The logical file position is not changed by this function;
1122  * examined packets may be buffered for later processing.
1123  *
1124  * @param ic media file handle
1125  * @param options  If non-NULL, an ic.nb_streams long array of pointers to
1126  *                 dictionaries, where i-th member contains options for
1127  *                 codec corresponding to i-th stream.
1128  *                 On return each dictionary will be filled with options that were not found.
1129  * @return >=0 if OK, AVERROR_xxx on error
1130  *
1131  * @note this function isn't guaranteed to open all the codecs, so
1132  *       options being non-empty at return is a perfectly normal behavior.
1133  *
1134  * @todo Let the user decide somehow what information is needed so that
1135  *       we do not waste time getting stuff the user does not need.
1136  */
1137 int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
1138
1139 /**
1140  * Find the "best" stream in the file.
1141  * The best stream is determined according to various heuristics as the most
1142  * likely to be what the user expects.
1143  * If the decoder parameter is non-NULL, av_find_best_stream will find the
1144  * default decoder for the stream's codec; streams for which no decoder can
1145  * be found are ignored.
1146  *
1147  * @param ic                media file handle
1148  * @param type              stream type: video, audio, subtitles, etc.
1149  * @param wanted_stream_nb  user-requested stream number,
1150  *                          or -1 for automatic selection
1151  * @param related_stream    try to find a stream related (eg. in the same
1152  *                          program) to this one, or -1 if none
1153  * @param decoder_ret       if non-NULL, returns the decoder for the
1154  *                          selected stream
1155  * @param flags             flags; none are currently defined
1156  * @return  the non-negative stream number in case of success,
1157  *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1158  *          could be found,
1159  *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1160  * @note  If av_find_best_stream returns successfully and decoder_ret is not
1161  *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1162  */
1163 int av_find_best_stream(AVFormatContext *ic,
1164                         enum AVMediaType type,
1165                         int wanted_stream_nb,
1166                         int related_stream,
1167                         AVCodec **decoder_ret,
1168                         int flags);
1169
1170 /**
1171  * Read a transport packet from a media file.
1172  *
1173  * This function is obsolete and should never be used.
1174  * Use av_read_frame() instead.
1175  *
1176  * @param s media file handle
1177  * @param pkt is filled
1178  * @return 0 if OK, AVERROR_xxx on error
1179  */
1180 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1181
1182 /**
1183  * Return the next frame of a stream.
1184  * This function returns what is stored in the file, and does not validate
1185  * that what is there are valid frames for the decoder. It will split what is
1186  * stored in the file into frames and return one for each call. It will not
1187  * omit invalid data between valid frames so as to give the decoder the maximum
1188  * information possible for decoding.
1189  *
1190  * The returned packet is valid
1191  * until the next av_read_frame() or until av_close_input_file() and
1192  * must be freed with av_free_packet. For video, the packet contains
1193  * exactly one frame. For audio, it contains an integer number of
1194  * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1195  * data). If the audio frames have a variable size (e.g. MPEG audio),
1196  * then it contains one frame.
1197  *
1198  * pkt->pts, pkt->dts and pkt->duration are always set to correct
1199  * values in AVStream.time_base units (and guessed if the format cannot
1200  * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1201  * has B-frames, so it is better to rely on pkt->dts if you do not
1202  * decompress the payload.
1203  *
1204  * @return 0 if OK, < 0 on error or end of file
1205  */
1206 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1207
1208 /**
1209  * Seek to the keyframe at timestamp.
1210  * 'timestamp' in 'stream_index'.
1211  * @param stream_index If stream_index is (-1), a default
1212  * stream is selected, and timestamp is automatically converted
1213  * from AV_TIME_BASE units to the stream specific time_base.
1214  * @param timestamp Timestamp in AVStream.time_base units
1215  *        or, if no stream is specified, in AV_TIME_BASE units.
1216  * @param flags flags which select direction and seeking mode
1217  * @return >= 0 on success
1218  */
1219 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1220                   int flags);
1221
1222 /**
1223  * Seek to timestamp ts.
1224  * Seeking will be done so that the point from which all active streams
1225  * can be presented successfully will be closest to ts and within min/max_ts.
1226  * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1227  *
1228  * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1229  * are the file position (this may not be supported by all demuxers).
1230  * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1231  * in the stream with stream_index (this may not be supported by all demuxers).
1232  * Otherwise all timestamps are in units of the stream selected by stream_index
1233  * or if stream_index is -1, in AV_TIME_BASE units.
1234  * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1235  * keyframes (this may not be supported by all demuxers).
1236  *
1237  * @param stream_index index of the stream which is used as time base reference
1238  * @param min_ts smallest acceptable timestamp
1239  * @param ts target timestamp
1240  * @param max_ts largest acceptable timestamp
1241  * @param flags flags
1242  * @return >=0 on success, error code otherwise
1243  *
1244  * @note This is part of the new seek API which is still under construction.
1245  *       Thus do not use this yet. It may change at any time, do not expect
1246  *       ABI compatibility yet!
1247  */
1248 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1249
1250 /**
1251  * Start playing a network-based stream (e.g. RTSP stream) at the
1252  * current position.
1253  */
1254 int av_read_play(AVFormatContext *s);
1255
1256 /**
1257  * Pause a network-based stream (e.g. RTSP stream).
1258  *
1259  * Use av_read_play() to resume it.
1260  */
1261 int av_read_pause(AVFormatContext *s);
1262
1263 #if FF_API_CLOSE_INPUT_FILE
1264 /**
1265  * @deprecated use avformat_close_input()
1266  * Close a media file (but not its codecs).
1267  *
1268  * @param s media file handle
1269  */
1270 attribute_deprecated
1271 void av_close_input_file(AVFormatContext *s);
1272 #endif
1273
1274 /**
1275  * Close an opened input AVFormatContext. Free it and all its contents
1276  * and set *s to NULL.
1277  */
1278 void avformat_close_input(AVFormatContext **s);
1279 /**
1280  * @}
1281  */
1282
1283 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1284 #define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1285 #define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1286 #define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1287
1288 /**
1289  * @addtogroup lavf_encoding
1290  * @{
1291  */
1292 /**
1293  * Allocate the stream private data and write the stream header to
1294  * an output media file.
1295  *
1296  * @param s Media file handle, must be allocated with avformat_alloc_context().
1297  *          Its oformat field must be set to the desired output format;
1298  *          Its pb field must be set to an already openened AVIOContext.
1299  * @param options  An AVDictionary filled with AVFormatContext and muxer-private options.
1300  *                 On return this parameter will be destroyed and replaced with a dict containing
1301  *                 options that were not found. May be NULL.
1302  *
1303  * @return 0 on success, negative AVERROR on failure.
1304  *
1305  * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1306  */
1307 int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1308
1309 /**
1310  * Write a packet to an output media file.
1311  *
1312  * The packet shall contain one audio or video frame.
1313  * The packet must be correctly interleaved according to the container
1314  * specification, if not then av_interleaved_write_frame must be used.
1315  *
1316  * @param s media file handle
1317  * @param pkt The packet, which contains the stream_index, buf/buf_size,
1318  *            dts/pts, ...
1319  *            This can be NULL (at any time, not just at the end), in
1320  *            order to immediately flush data buffered within the muxer,
1321  *            for muxers that buffer up data internally before writing it
1322  *            to the output.
1323  * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush
1324  */
1325 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1326
1327 /**
1328  * Write a packet to an output media file ensuring correct interleaving.
1329  *
1330  * The packet must contain one audio or video frame.
1331  * If the packets are already correctly interleaved, the application should
1332  * call av_write_frame() instead as it is slightly faster. It is also important
1333  * to keep in mind that completely non-interleaved input will need huge amounts
1334  * of memory to interleave with this, so it is preferable to interleave at the
1335  * demuxer level.
1336  *
1337  * @param s media file handle
1338  * @param pkt The packet containing the data to be written. Libavformat takes
1339  * ownership of the data and will free it when it sees fit using the packet's
1340  * @ref AVPacket.destruct "destruct" field. The caller must not access the data
1341  * after this function returns, as it may already be freed.
1342  * Packet's @ref AVPacket.stream_index "stream_index" field must be set to the
1343  * index of the corresponding stream in @ref AVFormatContext.streams
1344  * "s.streams".
1345  * It is very strongly recommended that timing information (@ref AVPacket.pts
1346  * "pts", @ref AVPacket.dts "dts" @ref AVPacket.duration "duration") is set to
1347  * correct values.
1348  *
1349  * @return 0 on success, a negative AVERROR on error.
1350  */
1351 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1352
1353 /**
1354  * Interleave a packet per dts in an output media file.
1355  *
1356  * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1357  * function, so they cannot be used after it. Note that calling av_free_packet()
1358  * on them is still safe.
1359  *
1360  * @param s media file handle
1361  * @param out the interleaved packet will be output here
1362  * @param pkt the input packet
1363  * @param flush 1 if no further packets are available as input and all
1364  *              remaining packets should be output
1365  * @return 1 if a packet was output, 0 if no packet could be output,
1366  *         < 0 if an error occurred
1367  */
1368 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1369                                  AVPacket *pkt, int flush);
1370
1371 /**
1372  * Write the stream trailer to an output media file and free the
1373  * file private data.
1374  *
1375  * May only be called after a successful call to av_write_header.
1376  *
1377  * @param s media file handle
1378  * @return 0 if OK, AVERROR_xxx on error
1379  */
1380 int av_write_trailer(AVFormatContext *s);
1381
1382 /**
1383  * Return the output format in the list of registered output formats
1384  * which best matches the provided parameters, or return NULL if
1385  * there is no match.
1386  *
1387  * @param short_name if non-NULL checks if short_name matches with the
1388  * names of the registered formats
1389  * @param filename if non-NULL checks if filename terminates with the
1390  * extensions of the registered formats
1391  * @param mime_type if non-NULL checks if mime_type matches with the
1392  * MIME type of the registered formats
1393  */
1394 AVOutputFormat *av_guess_format(const char *short_name,
1395                                 const char *filename,
1396                                 const char *mime_type);
1397
1398 /**
1399  * Guess the codec ID based upon muxer and filename.
1400  */
1401 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
1402                             const char *filename, const char *mime_type,
1403                             enum AVMediaType type);
1404
1405 /**
1406  * @}
1407  */
1408
1409
1410 /**
1411  * @defgroup lavf_misc Utility functions
1412  * @ingroup libavf
1413  * @{
1414  *
1415  * Miscelaneous utility functions related to both muxing and demuxing
1416  * (or neither).
1417  */
1418
1419 /**
1420  * Send a nice hexadecimal dump of a buffer to the specified file stream.
1421  *
1422  * @param f The file stream pointer where the dump should be sent to.
1423  * @param buf buffer
1424  * @param size buffer size
1425  *
1426  * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
1427  */
1428 void av_hex_dump(FILE *f, uint8_t *buf, int size);
1429
1430 /**
1431  * Send a nice hexadecimal dump of a buffer to the log.
1432  *
1433  * @param avcl A pointer to an arbitrary struct of which the first field is a
1434  * pointer to an AVClass struct.
1435  * @param level The importance level of the message, lower values signifying
1436  * higher importance.
1437  * @param buf buffer
1438  * @param size buffer size
1439  *
1440  * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
1441  */
1442 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
1443
1444 /**
1445  * Send a nice dump of a packet to the specified file stream.
1446  *
1447  * @param f The file stream pointer where the dump should be sent to.
1448  * @param pkt packet to dump
1449  * @param dump_payload True if the payload must be displayed, too.
1450  * @param st AVStream that the packet belongs to
1451  */
1452 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
1453
1454
1455 /**
1456  * Send a nice dump of a packet to the log.
1457  *
1458  * @param avcl A pointer to an arbitrary struct of which the first field is a
1459  * pointer to an AVClass struct.
1460  * @param level The importance level of the message, lower values signifying
1461  * higher importance.
1462  * @param pkt packet to dump
1463  * @param dump_payload True if the payload must be displayed, too.
1464  * @param st AVStream that the packet belongs to
1465  */
1466 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
1467                       AVStream *st);
1468
1469 /**
1470  * Get the CodecID for the given codec tag tag.
1471  * If no codec id is found returns CODEC_ID_NONE.
1472  *
1473  * @param tags list of supported codec_id-codec_tag pairs, as stored
1474  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1475  */
1476 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1477
1478 /**
1479  * Get the codec tag for the given codec id id.
1480  * If no codec tag is found returns 0.
1481  *
1482  * @param tags list of supported codec_id-codec_tag pairs, as stored
1483  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1484  */
1485 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1486
1487 int av_find_default_stream_index(AVFormatContext *s);
1488
1489 /**
1490  * Get the index for a specific timestamp.
1491  * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1492  *                 to the timestamp which is <= the requested one, if backward
1493  *                 is 0, then it will be >=
1494  *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1495  * @return < 0 if no such timestamp could be found
1496  */
1497 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1498
1499 /**
1500  * Add an index entry into a sorted list. Update the entry if the list
1501  * already contains it.
1502  *
1503  * @param timestamp timestamp in the time base of the given stream
1504  */
1505 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1506                        int size, int distance, int flags);
1507
1508
1509 /**
1510  * Split a URL string into components.
1511  *
1512  * The pointers to buffers for storing individual components may be null,
1513  * in order to ignore that component. Buffers for components not found are
1514  * set to empty strings. If the port is not found, it is set to a negative
1515  * value.
1516  *
1517  * @param proto the buffer for the protocol
1518  * @param proto_size the size of the proto buffer
1519  * @param authorization the buffer for the authorization
1520  * @param authorization_size the size of the authorization buffer
1521  * @param hostname the buffer for the host name
1522  * @param hostname_size the size of the hostname buffer
1523  * @param port_ptr a pointer to store the port number in
1524  * @param path the buffer for the path
1525  * @param path_size the size of the path buffer
1526  * @param url the URL to split
1527  */
1528 void av_url_split(char *proto,         int proto_size,
1529                   char *authorization, int authorization_size,
1530                   char *hostname,      int hostname_size,
1531                   int *port_ptr,
1532                   char *path,          int path_size,
1533                   const char *url);
1534
1535
1536 void av_dump_format(AVFormatContext *ic,
1537                     int index,
1538                     const char *url,
1539                     int is_output);
1540
1541 /**
1542  * Get the current time in microseconds.
1543  */
1544 int64_t av_gettime(void);
1545
1546 /**
1547  * Return in 'buf' the path with '%d' replaced by a number.
1548  *
1549  * Also handles the '%0nd' format where 'n' is the total number
1550  * of digits and '%%'.
1551  *
1552  * @param buf destination buffer
1553  * @param buf_size destination buffer size
1554  * @param path numbered sequence string
1555  * @param number frame number
1556  * @return 0 if OK, -1 on format error
1557  */
1558 int av_get_frame_filename(char *buf, int buf_size,
1559                           const char *path, int number);
1560
1561 /**
1562  * Check whether filename actually is a numbered sequence generator.
1563  *
1564  * @param filename possible numbered sequence string
1565  * @return 1 if a valid numbered sequence string, 0 otherwise
1566  */
1567 int av_filename_number_test(const char *filename);
1568
1569 /**
1570  * Generate an SDP for an RTP session.
1571  *
1572  * @param ac array of AVFormatContexts describing the RTP streams. If the
1573  *           array is composed by only one context, such context can contain
1574  *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1575  *           all the contexts in the array (an AVCodecContext per RTP stream)
1576  *           must contain only one AVStream.
1577  * @param n_files number of AVCodecContexts contained in ac
1578  * @param buf buffer where the SDP will be stored (must be allocated by
1579  *            the caller)
1580  * @param size the size of the buffer
1581  * @return 0 if OK, AVERROR_xxx on error
1582  */
1583 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1584
1585 /**
1586  * Return a positive value if the given filename has one of the given
1587  * extensions, 0 otherwise.
1588  *
1589  * @param extensions a comma-separated list of filename extensions
1590  */
1591 int av_match_ext(const char *filename, const char *extensions);
1592
1593 /**
1594  * Test if the given container can store a codec.
1595  *
1596  * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
1597  *
1598  * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
1599  *         A negative number if this information is not available.
1600  */
1601 int avformat_query_codec(AVOutputFormat *ofmt, enum CodecID codec_id, int std_compliance);
1602
1603 /**
1604  * @defgroup riff_fourcc RIFF FourCCs
1605  * @{
1606  * Get the tables mapping RIFF FourCCs to libavcodec CodecIDs. The tables are
1607  * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the
1608  * following code:
1609  * @code
1610  * uint32_t tag = MKTAG('H', '2', '6', '4');
1611  * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 };
1612  * enum CodecID id = av_codec_get_id(table, tag);
1613  * @endcode
1614  */
1615 /**
1616  * @return the table mapping RIFF FourCCs for video to libavcodec CodecID.
1617  */
1618 const struct AVCodecTag *avformat_get_riff_video_tags(void);
1619 /**
1620  * @return the table mapping RIFF FourCCs for audio to CodecID.
1621  */
1622 const struct AVCodecTag *avformat_get_riff_audio_tags(void);
1623 /**
1624  * @}
1625  */
1626
1627 /**
1628  * @}
1629  */
1630
1631 #endif /* AVFORMAT_AVFORMAT_H */