lavf: generic code for exporting attached pictures.
[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. Only used in raw format right
437      * now. 'avformat_new_stream' should be called to create new streams.
438      */
439     int (*read_header)(struct AVFormatContext *);
440
441     /**
442      * Read one packet and put it in 'pkt'. pts and flags are also
443      * set. 'avformat_new_stream' can be called only if the flag
444      * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
445      * background thread).
446      * @return 0 on success, < 0 on error.
447      *         When returning an error, pkt must not have been allocated
448      *         or must be freed before returning
449      */
450     int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
451
452     /**
453      * Close the stream. The AVFormatContext and AVStreams are not
454      * freed by this function
455      */
456     int (*read_close)(struct AVFormatContext *);
457
458     /**
459      * Seek to a given timestamp relative to the frames in
460      * stream component stream_index.
461      * @param stream_index Must not be -1.
462      * @param flags Selects which direction should be preferred if no exact
463      *              match is available.
464      * @return >= 0 on success (but not necessarily the new offset)
465      */
466     int (*read_seek)(struct AVFormatContext *,
467                      int stream_index, int64_t timestamp, int flags);
468
469     /**
470      * Get the next timestamp in stream[stream_index].time_base units.
471      * @return the timestamp or AV_NOPTS_VALUE if an error occurred
472      */
473     int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
474                               int64_t *pos, int64_t pos_limit);
475
476     /**
477      * Start/resume playing - only meaningful if using a network-based format
478      * (RTSP).
479      */
480     int (*read_play)(struct AVFormatContext *);
481
482     /**
483      * Pause playing - only meaningful if using a network-based format
484      * (RTSP).
485      */
486     int (*read_pause)(struct AVFormatContext *);
487
488     /**
489      * Seek to timestamp ts.
490      * Seeking will be done so that the point from which all active streams
491      * can be presented successfully will be closest to ts and within min/max_ts.
492      * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
493      */
494     int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
495 } AVInputFormat;
496 /**
497  * @}
498  */
499
500 enum AVStreamParseType {
501     AVSTREAM_PARSE_NONE,
502     AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
503     AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
504     AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
505     AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
506 };
507
508 typedef struct AVIndexEntry {
509     int64_t pos;
510     int64_t timestamp;
511 #define AVINDEX_KEYFRAME 0x0001
512     int flags:2;
513     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).
514     int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
515 } AVIndexEntry;
516
517 #define AV_DISPOSITION_DEFAULT   0x0001
518 #define AV_DISPOSITION_DUB       0x0002
519 #define AV_DISPOSITION_ORIGINAL  0x0004
520 #define AV_DISPOSITION_COMMENT   0x0008
521 #define AV_DISPOSITION_LYRICS    0x0010
522 #define AV_DISPOSITION_KARAOKE   0x0020
523
524 /**
525  * Track should be used during playback by default.
526  * Useful for subtitle track that should be displayed
527  * even when user did not explicitly ask for subtitles.
528  */
529 #define AV_DISPOSITION_FORCED    0x0040
530 #define AV_DISPOSITION_HEARING_IMPAIRED  0x0080  /**< stream for hearing impaired audiences */
531 #define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100  /**< stream for visual impaired audiences */
532 #define AV_DISPOSITION_CLEAN_EFFECTS     0x0200  /**< stream without voice */
533 /**
534  * The stream is stored in the file as an attached picture/"cover art" (e.g.
535  * APIC frame in ID3v2). The single packet associated with it will be returned
536  * among the first few packets read from the file unless seeking takes place.
537  * It can also be accessed at any time in AVStream.attached_pic.
538  */
539 #define AV_DISPOSITION_ATTACHED_PIC      0x0400
540
541 /**
542  * Stream structure.
543  * New fields can be added to the end with minor version bumps.
544  * Removal, reordering and changes to existing fields require a major
545  * version bump.
546  * sizeof(AVStream) must not be used outside libav*.
547  */
548 typedef struct AVStream {
549     int index;    /**< stream index in AVFormatContext */
550     int id;       /**< format-specific stream ID */
551     AVCodecContext *codec; /**< codec context */
552     /**
553      * Real base framerate of the stream.
554      * This is the lowest framerate with which all timestamps can be
555      * represented accurately (it is the least common multiple of all
556      * framerates in the stream). Note, this value is just a guess!
557      * For example, if the time base is 1/90000 and all frames have either
558      * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
559      */
560     AVRational r_frame_rate;
561     void *priv_data;
562
563     /**
564      * encoding: pts generation when outputting stream
565      */
566     struct AVFrac pts;
567
568     /**
569      * This is the fundamental unit of time (in seconds) in terms
570      * of which frame timestamps are represented. For fixed-fps content,
571      * time base should be 1/framerate and timestamp increments should be 1.
572      * decoding: set by libavformat
573      * encoding: set by libavformat in av_write_header
574      */
575     AVRational time_base;
576
577     /**
578      * Decoding: pts of the first frame of the stream, in stream time base.
579      * Only set this if you are absolutely 100% sure that the value you set
580      * it to really is the pts of the first frame.
581      * This may be undefined (AV_NOPTS_VALUE).
582      */
583     int64_t start_time;
584
585     /**
586      * Decoding: duration of the stream, in stream time base.
587      * If a source file does not specify a duration, but does specify
588      * a bitrate, this value will be estimated from bitrate and file size.
589      */
590     int64_t duration;
591
592     int64_t nb_frames;                 ///< number of frames in this stream if known or 0
593
594     int disposition; /**< AV_DISPOSITION_* bit field */
595
596     enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
597
598     /**
599      * sample aspect ratio (0 if unknown)
600      * - encoding: Set by user.
601      * - decoding: Set by libavformat.
602      */
603     AVRational sample_aspect_ratio;
604
605     AVDictionary *metadata;
606
607     /**
608      * Average framerate
609      */
610     AVRational avg_frame_rate;
611
612     /**
613      * For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet
614      * will contain the attached picture.
615      *
616      * decoding: set by libavformat, must not be modified by the caller.
617      * encoding: unused
618      */
619     AVPacket attached_pic;
620
621     /*****************************************************************
622      * All fields below this line are not part of the public API. They
623      * may not be used outside of libavformat and can be changed and
624      * removed at will.
625      * New public fields should be added right above.
626      *****************************************************************
627      */
628
629     /**
630      * Stream information used internally by av_find_stream_info()
631      */
632 #define MAX_STD_TIMEBASES (60*12+5)
633     struct {
634         int64_t last_dts;
635         int64_t duration_gcd;
636         int duration_count;
637         double duration_error[MAX_STD_TIMEBASES];
638         int64_t codec_info_duration;
639         int nb_decoded_frames;
640     } *info;
641
642     AVPacket cur_pkt;
643     const uint8_t *cur_ptr;
644     int cur_len;
645
646     int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
647
648     // Timestamp generation support:
649     /**
650      * Timestamp corresponding to the last dts sync point.
651      *
652      * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
653      * a DTS is received from the underlying container. Otherwise set to
654      * AV_NOPTS_VALUE by default.
655      */
656     int64_t reference_dts;
657     int64_t first_dts;
658     int64_t cur_dts;
659     int64_t last_IP_pts;
660     int last_IP_duration;
661
662     /**
663      * Number of packets to buffer for codec probing
664      */
665 #define MAX_PROBE_PACKETS 2500
666     int probe_packets;
667
668     /**
669      * Number of frames that have been demuxed during av_find_stream_info()
670      */
671     int codec_info_nb_frames;
672
673     /* av_read_frame() support */
674     enum AVStreamParseType need_parsing;
675     struct AVCodecParserContext *parser;
676
677     /**
678      * last packet in packet_buffer for this stream when muxing.
679      */
680     struct AVPacketList *last_in_packet_buffer;
681     AVProbeData probe_data;
682 #define MAX_REORDER_DELAY 16
683     int64_t pts_buffer[MAX_REORDER_DELAY+1];
684
685     AVIndexEntry *index_entries; /**< Only used if the format does not
686                                     support seeking natively. */
687     int nb_index_entries;
688     unsigned int index_entries_allocated_size;
689 } AVStream;
690
691 #define AV_PROGRAM_RUNNING 1
692
693 /**
694  * New fields can be added to the end with minor version bumps.
695  * Removal, reordering and changes to existing fields require a major
696  * version bump.
697  * sizeof(AVProgram) must not be used outside libav*.
698  */
699 typedef struct AVProgram {
700     int            id;
701     int            flags;
702     enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
703     unsigned int   *stream_index;
704     unsigned int   nb_stream_indexes;
705     AVDictionary *metadata;
706 } AVProgram;
707
708 #define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
709                                          (streams are added dynamically) */
710
711 typedef struct AVChapter {
712     int id;                 ///< unique ID to identify the chapter
713     AVRational time_base;   ///< time base in which the start/end timestamps are specified
714     int64_t start, end;     ///< chapter start/end time in time_base units
715     AVDictionary *metadata;
716 } AVChapter;
717
718 /**
719  * Format I/O context.
720  * New fields can be added to the end with minor version bumps.
721  * Removal, reordering and changes to existing fields require a major
722  * version bump.
723  * sizeof(AVFormatContext) must not be used outside libav*, use
724  * avformat_alloc_context() to create an AVFormatContext.
725  */
726 typedef struct AVFormatContext {
727     /**
728      * A class for logging and AVOptions. Set by avformat_alloc_context().
729      * Exports (de)muxer private options if they exist.
730      */
731     const AVClass *av_class;
732
733     /**
734      * Can only be iformat or oformat, not both at the same time.
735      *
736      * decoding: set by avformat_open_input().
737      * encoding: set by the user.
738      */
739     struct AVInputFormat *iformat;
740     struct AVOutputFormat *oformat;
741
742     /**
743      * Format private data. This is an AVOptions-enabled struct
744      * if and only if iformat/oformat.priv_class is not NULL.
745      */
746     void *priv_data;
747
748     /*
749      * I/O context.
750      *
751      * decoding: either set by the user before avformat_open_input() (then
752      * the user must close it manually) or set by avformat_open_input().
753      * encoding: set by the user.
754      *
755      * Do NOT set this field if AVFMT_NOFILE flag is set in
756      * iformat/oformat.flags. In such a case, the (de)muxer will handle
757      * I/O in some other way and this field will be NULL.
758      */
759     AVIOContext *pb;
760
761     /* stream info */
762     int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
763
764     /**
765      * A list of all streams in the file. New streams are created with
766      * avformat_new_stream().
767      *
768      * decoding: streams are created by libavformat in avformat_open_input().
769      * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
770      * appear in av_read_frame().
771      * encoding: streams are created by the user before avformat_write_header().
772      */
773     unsigned int nb_streams;
774     AVStream **streams;
775
776     char filename[1024]; /**< input or output filename */
777
778     /**
779      * Decoding: position of the first frame of the component, in
780      * AV_TIME_BASE fractional seconds. NEVER set this value directly:
781      * It is deduced from the AVStream values.
782      */
783     int64_t start_time;
784
785     /**
786      * Decoding: duration of the stream, in AV_TIME_BASE fractional
787      * seconds. Only set this value if you know none of the individual stream
788      * durations and also do not set any of them. This is deduced from the
789      * AVStream values if not set.
790      */
791     int64_t duration;
792
793     /**
794      * Decoding: total stream bitrate in bit/s, 0 if not
795      * available. Never set it directly if the file_size and the
796      * duration are known as Libav can compute it automatically.
797      */
798     int bit_rate;
799
800     unsigned int packet_size;
801     int max_delay;
802
803     int flags;
804 #define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
805 #define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
806 #define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
807 #define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
808 #define AVFMT_FLAG_NOFILLIN     0x0010 ///< Do not infer any values from other values, just return what is stored in the container
809 #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
810 #define AVFMT_FLAG_CUSTOM_IO    0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
811 #define AVFMT_FLAG_DISCARD_CORRUPT  0x0100 ///< Discard frames marked corrupted
812
813     /**
814      * decoding: size of data to probe; encoding: unused.
815      */
816     unsigned int probesize;
817
818     /**
819      * decoding: maximum time (in AV_TIME_BASE units) during which the input should
820      * be analyzed in avformat_find_stream_info().
821      */
822     int max_analyze_duration;
823
824     const uint8_t *key;
825     int keylen;
826
827     unsigned int nb_programs;
828     AVProgram **programs;
829
830     /**
831      * Forced video codec_id.
832      * Demuxing: Set by user.
833      */
834     enum CodecID video_codec_id;
835
836     /**
837      * Forced audio codec_id.
838      * Demuxing: Set by user.
839      */
840     enum CodecID audio_codec_id;
841
842     /**
843      * Forced subtitle codec_id.
844      * Demuxing: Set by user.
845      */
846     enum CodecID subtitle_codec_id;
847
848     /**
849      * Maximum amount of memory in bytes to use for the index of each stream.
850      * If the index exceeds this size, entries will be discarded as
851      * needed to maintain a smaller size. This can lead to slower or less
852      * accurate seeking (depends on demuxer).
853      * Demuxers for which a full in-memory index is mandatory will ignore
854      * this.
855      * muxing  : unused
856      * demuxing: set by user
857      */
858     unsigned int max_index_size;
859
860     /**
861      * Maximum amount of memory in bytes to use for buffering frames
862      * obtained from realtime capture devices.
863      */
864     unsigned int max_picture_buffer;
865
866     unsigned int nb_chapters;
867     AVChapter **chapters;
868
869     AVDictionary *metadata;
870
871     /**
872      * Start time of the stream in real world time, in microseconds
873      * since the unix epoch (00:00 1st January 1970). That is, pts=0
874      * in the stream was captured at this real world time.
875      * - encoding: Set by user.
876      * - decoding: Unused.
877      */
878     int64_t start_time_realtime;
879
880     /**
881      * decoding: number of frames used to probe fps
882      */
883     int fps_probe_size;
884
885     /**
886      * Error recognition; higher values will detect more errors but may
887      * misdetect some more or less valid parts as errors.
888      * - encoding: unused
889      * - decoding: Set by user.
890      */
891     int error_recognition;
892
893     /**
894      * Custom interrupt callbacks for the I/O layer.
895      *
896      * decoding: set by the user before avformat_open_input().
897      * encoding: set by the user before avformat_write_header()
898      * (mainly useful for AVFMT_NOFILE formats). The callback
899      * should also be passed to avio_open2() if it's used to
900      * open the file.
901      */
902     AVIOInterruptCB interrupt_callback;
903
904     /**
905      * Flags to enable debugging.
906      */
907     int debug;
908 #define FF_FDEBUG_TS        0x0001
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      * This buffer is only needed when packets were already buffered but
919      * not decoded, for example to get the codec parameters in MPEG
920      * streams.
921      */
922     struct AVPacketList *packet_buffer;
923     struct AVPacketList *packet_buffer_end;
924
925     /* av_read_frame() support */
926     AVStream *cur_st;
927
928     /* av_seek_frame() support */
929     int64_t data_offset; /**< offset of the first packet */
930
931     /**
932      * Raw packets from the demuxer, prior to parsing and decoding.
933      * This buffer is used for buffering packets until the codec can
934      * be identified, as parsing cannot be done without knowing the
935      * codec.
936      */
937     struct AVPacketList *raw_packet_buffer;
938     struct AVPacketList *raw_packet_buffer_end;
939     /**
940      * Remaining size available for raw_packet_buffer, in bytes.
941      */
942 #define RAW_PACKET_BUFFER_SIZE 2500000
943     int raw_packet_buffer_remaining_size;
944 } AVFormatContext;
945
946 typedef struct AVPacketList {
947     AVPacket pkt;
948     struct AVPacketList *next;
949 } AVPacketList;
950
951
952 /**
953  * @defgroup lavf_core Core functions
954  * @ingroup libavf
955  *
956  * Functions for querying libavformat capabilities, allocating core structures,
957  * etc.
958  * @{
959  */
960
961 /**
962  * Return the LIBAVFORMAT_VERSION_INT constant.
963  */
964 unsigned avformat_version(void);
965
966 /**
967  * Return the libavformat build-time configuration.
968  */
969 const char *avformat_configuration(void);
970
971 /**
972  * Return the libavformat license.
973  */
974 const char *avformat_license(void);
975
976 /**
977  * Initialize libavformat and register all the muxers, demuxers and
978  * protocols. If you do not call this function, then you can select
979  * exactly which formats you want to support.
980  *
981  * @see av_register_input_format()
982  * @see av_register_output_format()
983  * @see av_register_protocol()
984  */
985 void av_register_all(void);
986
987 void av_register_input_format(AVInputFormat *format);
988 void av_register_output_format(AVOutputFormat *format);
989
990 /**
991  * Do global initialization of network components. This is optional,
992  * but recommended, since it avoids the overhead of implicitly
993  * doing the setup for each session.
994  *
995  * Calling this function will become mandatory if using network
996  * protocols at some major version bump.
997  */
998 int avformat_network_init(void);
999
1000 /**
1001  * Undo the initialization done by avformat_network_init.
1002  */
1003 int avformat_network_deinit(void);
1004
1005 /**
1006  * If f is NULL, returns the first registered input format,
1007  * if f is non-NULL, returns the next registered input format after f
1008  * or NULL if f is the last one.
1009  */
1010 AVInputFormat  *av_iformat_next(AVInputFormat  *f);
1011
1012 /**
1013  * If f is NULL, returns the first registered output format,
1014  * if f is non-NULL, returns the next registered output format after f
1015  * or NULL if f is the last one.
1016  */
1017 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
1018
1019 /**
1020  * Allocate an AVFormatContext.
1021  * avformat_free_context() can be used to free the context and everything
1022  * allocated by the framework within it.
1023  */
1024 AVFormatContext *avformat_alloc_context(void);
1025
1026 /**
1027  * Free an AVFormatContext and all its streams.
1028  * @param s context to free
1029  */
1030 void avformat_free_context(AVFormatContext *s);
1031
1032 /**
1033  * Get the AVClass for AVFormatContext. It can be used in combination with
1034  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1035  *
1036  * @see av_opt_find().
1037  */
1038 const AVClass *avformat_get_class(void);
1039
1040 /**
1041  * Add a new stream to a media file.
1042  *
1043  * When demuxing, it is called by the demuxer in read_header(). If the
1044  * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1045  * be called in read_packet().
1046  *
1047  * When muxing, should be called by the user before avformat_write_header().
1048  *
1049  * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1050  * will be initialized to use this codec. This is needed for e.g. codec-specific
1051  * defaults to be set, so codec should be provided if it is known.
1052  *
1053  * @return newly created stream or NULL on error.
1054  */
1055 AVStream *avformat_new_stream(AVFormatContext *s, AVCodec *c);
1056
1057 AVProgram *av_new_program(AVFormatContext *s, int id);
1058
1059 /**
1060  * @}
1061  */
1062
1063
1064 /**
1065  * @addtogroup lavf_decoding
1066  * @{
1067  */
1068
1069 /**
1070  * Find AVInputFormat based on the short name of the input format.
1071  */
1072 AVInputFormat *av_find_input_format(const char *short_name);
1073
1074 /**
1075  * Guess the file format.
1076  *
1077  * @param is_opened Whether the file is already opened; determines whether
1078  *                  demuxers with or without AVFMT_NOFILE are probed.
1079  */
1080 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1081
1082 /**
1083  * Guess the file format.
1084  *
1085  * @param is_opened Whether the file is already opened; determines whether
1086  *                  demuxers with or without AVFMT_NOFILE are probed.
1087  * @param score_max A probe score larger that this is required to accept a
1088  *                  detection, the variable is set to the actual detection
1089  *                  score afterwards.
1090  *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1091  *                  to retry with a larger probe buffer.
1092  */
1093 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1094
1095 /**
1096  * Probe a bytestream to determine the input format. Each time a probe returns
1097  * with a score that is too low, the probe buffer size is increased and another
1098  * attempt is made. When the maximum probe size is reached, the input format
1099  * with the highest score is returned.
1100  *
1101  * @param pb the bytestream to probe
1102  * @param fmt the input format is put here
1103  * @param filename the filename of the stream
1104  * @param logctx the log context
1105  * @param offset the offset within the bytestream to probe from
1106  * @param max_probe_size the maximum probe buffer size (zero for default)
1107  * @return 0 in case of success, a negative value corresponding to an
1108  * AVERROR code otherwise
1109  */
1110 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1111                           const char *filename, void *logctx,
1112                           unsigned int offset, unsigned int max_probe_size);
1113
1114 /**
1115  * Open an input stream and read the header. The codecs are not opened.
1116  * The stream must be closed with av_close_input_file().
1117  *
1118  * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1119  *           May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1120  *           function and written into ps.
1121  *           Note that a user-supplied AVFormatContext will be freed on failure.
1122  * @param filename Name of the stream to open.
1123  * @param fmt If non-NULL, this parameter forces a specific input format.
1124  *            Otherwise the format is autodetected.
1125  * @param options  A dictionary filled with AVFormatContext and demuxer-private options.
1126  *                 On return this parameter will be destroyed and replaced with a dict containing
1127  *                 options that were not found. May be NULL.
1128  *
1129  * @return 0 on success, a negative AVERROR on failure.
1130  *
1131  * @note If you want to use custom IO, preallocate the format context and set its pb field.
1132  */
1133 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1134
1135 /**
1136  * Read packets of a media file to get stream information. This
1137  * is useful for file formats with no headers such as MPEG. This
1138  * function also computes the real framerate in case of MPEG-2 repeat
1139  * frame mode.
1140  * The logical file position is not changed by this function;
1141  * examined packets may be buffered for later processing.
1142  *
1143  * @param ic media file handle
1144  * @param options  If non-NULL, an ic.nb_streams long array of pointers to
1145  *                 dictionaries, where i-th member contains options for
1146  *                 codec corresponding to i-th stream.
1147  *                 On return each dictionary will be filled with options that were not found.
1148  * @return >=0 if OK, AVERROR_xxx on error
1149  *
1150  * @note this function isn't guaranteed to open all the codecs, so
1151  *       options being non-empty at return is a perfectly normal behavior.
1152  *
1153  * @todo Let the user decide somehow what information is needed so that
1154  *       we do not waste time getting stuff the user does not need.
1155  */
1156 int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
1157
1158 /**
1159  * Find the "best" stream in the file.
1160  * The best stream is determined according to various heuristics as the most
1161  * likely to be what the user expects.
1162  * If the decoder parameter is non-NULL, av_find_best_stream will find the
1163  * default decoder for the stream's codec; streams for which no decoder can
1164  * be found are ignored.
1165  *
1166  * @param ic                media file handle
1167  * @param type              stream type: video, audio, subtitles, etc.
1168  * @param wanted_stream_nb  user-requested stream number,
1169  *                          or -1 for automatic selection
1170  * @param related_stream    try to find a stream related (eg. in the same
1171  *                          program) to this one, or -1 if none
1172  * @param decoder_ret       if non-NULL, returns the decoder for the
1173  *                          selected stream
1174  * @param flags             flags; none are currently defined
1175  * @return  the non-negative stream number in case of success,
1176  *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1177  *          could be found,
1178  *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1179  * @note  If av_find_best_stream returns successfully and decoder_ret is not
1180  *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1181  */
1182 int av_find_best_stream(AVFormatContext *ic,
1183                         enum AVMediaType type,
1184                         int wanted_stream_nb,
1185                         int related_stream,
1186                         AVCodec **decoder_ret,
1187                         int flags);
1188
1189 /**
1190  * Read a transport packet from a media file.
1191  *
1192  * This function is obsolete and should never be used.
1193  * Use av_read_frame() instead.
1194  *
1195  * @param s media file handle
1196  * @param pkt is filled
1197  * @return 0 if OK, AVERROR_xxx on error
1198  */
1199 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1200
1201 /**
1202  * Return the next frame of a stream.
1203  * This function returns what is stored in the file, and does not validate
1204  * that what is there are valid frames for the decoder. It will split what is
1205  * stored in the file into frames and return one for each call. It will not
1206  * omit invalid data between valid frames so as to give the decoder the maximum
1207  * information possible for decoding.
1208  *
1209  * The returned packet is valid
1210  * until the next av_read_frame() or until av_close_input_file() and
1211  * must be freed with av_free_packet. For video, the packet contains
1212  * exactly one frame. For audio, it contains an integer number of
1213  * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1214  * data). If the audio frames have a variable size (e.g. MPEG audio),
1215  * then it contains one frame.
1216  *
1217  * pkt->pts, pkt->dts and pkt->duration are always set to correct
1218  * values in AVStream.time_base units (and guessed if the format cannot
1219  * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1220  * has B-frames, so it is better to rely on pkt->dts if you do not
1221  * decompress the payload.
1222  *
1223  * @return 0 if OK, < 0 on error or end of file
1224  */
1225 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1226
1227 /**
1228  * Seek to the keyframe at timestamp.
1229  * 'timestamp' in 'stream_index'.
1230  * @param stream_index If stream_index is (-1), a default
1231  * stream is selected, and timestamp is automatically converted
1232  * from AV_TIME_BASE units to the stream specific time_base.
1233  * @param timestamp Timestamp in AVStream.time_base units
1234  *        or, if no stream is specified, in AV_TIME_BASE units.
1235  * @param flags flags which select direction and seeking mode
1236  * @return >= 0 on success
1237  */
1238 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1239                   int flags);
1240
1241 /**
1242  * Seek to timestamp ts.
1243  * Seeking will be done so that the point from which all active streams
1244  * can be presented successfully will be closest to ts and within min/max_ts.
1245  * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1246  *
1247  * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1248  * are the file position (this may not be supported by all demuxers).
1249  * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1250  * in the stream with stream_index (this may not be supported by all demuxers).
1251  * Otherwise all timestamps are in units of the stream selected by stream_index
1252  * or if stream_index is -1, in AV_TIME_BASE units.
1253  * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1254  * keyframes (this may not be supported by all demuxers).
1255  *
1256  * @param stream_index index of the stream which is used as time base reference
1257  * @param min_ts smallest acceptable timestamp
1258  * @param ts target timestamp
1259  * @param max_ts largest acceptable timestamp
1260  * @param flags flags
1261  * @return >=0 on success, error code otherwise
1262  *
1263  * @note This is part of the new seek API which is still under construction.
1264  *       Thus do not use this yet. It may change at any time, do not expect
1265  *       ABI compatibility yet!
1266  */
1267 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1268
1269 /**
1270  * Start playing a network-based stream (e.g. RTSP stream) at the
1271  * current position.
1272  */
1273 int av_read_play(AVFormatContext *s);
1274
1275 /**
1276  * Pause a network-based stream (e.g. RTSP stream).
1277  *
1278  * Use av_read_play() to resume it.
1279  */
1280 int av_read_pause(AVFormatContext *s);
1281
1282 #if FF_API_CLOSE_INPUT_FILE
1283 /**
1284  * @deprecated use avformat_close_input()
1285  * Close a media file (but not its codecs).
1286  *
1287  * @param s media file handle
1288  */
1289 attribute_deprecated
1290 void av_close_input_file(AVFormatContext *s);
1291 #endif
1292
1293 /**
1294  * Close an opened input AVFormatContext. Free it and all its contents
1295  * and set *s to NULL.
1296  */
1297 void avformat_close_input(AVFormatContext **s);
1298 /**
1299  * @}
1300  */
1301
1302 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1303 #define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1304 #define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1305 #define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1306
1307 /**
1308  * @addtogroup lavf_encoding
1309  * @{
1310  */
1311 /**
1312  * Allocate the stream private data and write the stream header to
1313  * an output media file.
1314  *
1315  * @param s Media file handle, must be allocated with avformat_alloc_context().
1316  *          Its oformat field must be set to the desired output format;
1317  *          Its pb field must be set to an already openened AVIOContext.
1318  * @param options  An AVDictionary filled with AVFormatContext and muxer-private options.
1319  *                 On return this parameter will be destroyed and replaced with a dict containing
1320  *                 options that were not found. May be NULL.
1321  *
1322  * @return 0 on success, negative AVERROR on failure.
1323  *
1324  * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1325  */
1326 int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1327
1328 /**
1329  * Write a packet to an output media file.
1330  *
1331  * The packet shall contain one audio or video frame.
1332  * The packet must be correctly interleaved according to the container
1333  * specification, if not then av_interleaved_write_frame must be used.
1334  *
1335  * @param s media file handle
1336  * @param pkt The packet, which contains the stream_index, buf/buf_size,
1337  *            dts/pts, ...
1338  *            This can be NULL (at any time, not just at the end), in
1339  *            order to immediately flush data buffered within the muxer,
1340  *            for muxers that buffer up data internally before writing it
1341  *            to the output.
1342  * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush
1343  */
1344 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1345
1346 /**
1347  * Write a packet to an output media file ensuring correct interleaving.
1348  *
1349  * The packet must contain one audio or video frame.
1350  * If the packets are already correctly interleaved, the application should
1351  * call av_write_frame() instead as it is slightly faster. It is also important
1352  * to keep in mind that completely non-interleaved input will need huge amounts
1353  * of memory to interleave with this, so it is preferable to interleave at the
1354  * demuxer level.
1355  *
1356  * @param s media file handle
1357  * @param pkt The packet containing the data to be written. Libavformat takes
1358  * ownership of the data and will free it when it sees fit using the packet's
1359  * @ref AVPacket.destruct "destruct" field. The caller must not access the data
1360  * after this function returns, as it may already be freed.
1361  * Packet's @ref AVPacket.stream_index "stream_index" field must be set to the
1362  * index of the corresponding stream in @ref AVFormatContext.streams
1363  * "s.streams".
1364  * It is very strongly recommended that timing information (@ref AVPacket.pts
1365  * "pts", @ref AVPacket.dts "dts" @ref AVPacket.duration "duration") is set to
1366  * correct values.
1367  *
1368  * @return 0 on success, a negative AVERROR on error.
1369  */
1370 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1371
1372 /**
1373  * Interleave a packet per dts in an output media file.
1374  *
1375  * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1376  * function, so they cannot be used after it. Note that calling av_free_packet()
1377  * on them is still safe.
1378  *
1379  * @param s media file handle
1380  * @param out the interleaved packet will be output here
1381  * @param pkt the input packet
1382  * @param flush 1 if no further packets are available as input and all
1383  *              remaining packets should be output
1384  * @return 1 if a packet was output, 0 if no packet could be output,
1385  *         < 0 if an error occurred
1386  */
1387 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1388                                  AVPacket *pkt, int flush);
1389
1390 /**
1391  * Write the stream trailer to an output media file and free the
1392  * file private data.
1393  *
1394  * May only be called after a successful call to av_write_header.
1395  *
1396  * @param s media file handle
1397  * @return 0 if OK, AVERROR_xxx on error
1398  */
1399 int av_write_trailer(AVFormatContext *s);
1400
1401 /**
1402  * Return the output format in the list of registered output formats
1403  * which best matches the provided parameters, or return NULL if
1404  * there is no match.
1405  *
1406  * @param short_name if non-NULL checks if short_name matches with the
1407  * names of the registered formats
1408  * @param filename if non-NULL checks if filename terminates with the
1409  * extensions of the registered formats
1410  * @param mime_type if non-NULL checks if mime_type matches with the
1411  * MIME type of the registered formats
1412  */
1413 AVOutputFormat *av_guess_format(const char *short_name,
1414                                 const char *filename,
1415                                 const char *mime_type);
1416
1417 /**
1418  * Guess the codec ID based upon muxer and filename.
1419  */
1420 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
1421                             const char *filename, const char *mime_type,
1422                             enum AVMediaType type);
1423
1424 /**
1425  * @}
1426  */
1427
1428
1429 /**
1430  * @defgroup lavf_misc Utility functions
1431  * @ingroup libavf
1432  * @{
1433  *
1434  * Miscelaneous utility functions related to both muxing and demuxing
1435  * (or neither).
1436  */
1437
1438 /**
1439  * Send a nice hexadecimal dump of a buffer to the specified file stream.
1440  *
1441  * @param f The file stream pointer where the dump should be sent to.
1442  * @param buf buffer
1443  * @param size buffer size
1444  *
1445  * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
1446  */
1447 void av_hex_dump(FILE *f, uint8_t *buf, int size);
1448
1449 /**
1450  * Send a nice hexadecimal dump of a buffer to the log.
1451  *
1452  * @param avcl A pointer to an arbitrary struct of which the first field is a
1453  * pointer to an AVClass struct.
1454  * @param level The importance level of the message, lower values signifying
1455  * higher importance.
1456  * @param buf buffer
1457  * @param size buffer size
1458  *
1459  * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
1460  */
1461 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
1462
1463 /**
1464  * Send a nice dump of a packet to the specified file stream.
1465  *
1466  * @param f The file stream pointer where the dump should be sent to.
1467  * @param pkt packet to dump
1468  * @param dump_payload True if the payload must be displayed, too.
1469  * @param st AVStream that the packet belongs to
1470  */
1471 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
1472
1473
1474 /**
1475  * Send a nice dump of a packet to the log.
1476  *
1477  * @param avcl A pointer to an arbitrary struct of which the first field is a
1478  * pointer to an AVClass struct.
1479  * @param level The importance level of the message, lower values signifying
1480  * higher importance.
1481  * @param pkt packet to dump
1482  * @param dump_payload True if the payload must be displayed, too.
1483  * @param st AVStream that the packet belongs to
1484  */
1485 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
1486                       AVStream *st);
1487
1488 /**
1489  * Get the CodecID for the given codec tag tag.
1490  * If no codec id is found returns CODEC_ID_NONE.
1491  *
1492  * @param tags list of supported codec_id-codec_tag pairs, as stored
1493  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1494  */
1495 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1496
1497 /**
1498  * Get the codec tag for the given codec id id.
1499  * If no codec tag is found returns 0.
1500  *
1501  * @param tags list of supported codec_id-codec_tag pairs, as stored
1502  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1503  */
1504 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1505
1506 int av_find_default_stream_index(AVFormatContext *s);
1507
1508 /**
1509  * Get the index for a specific timestamp.
1510  * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1511  *                 to the timestamp which is <= the requested one, if backward
1512  *                 is 0, then it will be >=
1513  *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1514  * @return < 0 if no such timestamp could be found
1515  */
1516 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1517
1518 /**
1519  * Add an index entry into a sorted list. Update the entry if the list
1520  * already contains it.
1521  *
1522  * @param timestamp timestamp in the time base of the given stream
1523  */
1524 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1525                        int size, int distance, int flags);
1526
1527
1528 /**
1529  * Split a URL string into components.
1530  *
1531  * The pointers to buffers for storing individual components may be null,
1532  * in order to ignore that component. Buffers for components not found are
1533  * set to empty strings. If the port is not found, it is set to a negative
1534  * value.
1535  *
1536  * @param proto the buffer for the protocol
1537  * @param proto_size the size of the proto buffer
1538  * @param authorization the buffer for the authorization
1539  * @param authorization_size the size of the authorization buffer
1540  * @param hostname the buffer for the host name
1541  * @param hostname_size the size of the hostname buffer
1542  * @param port_ptr a pointer to store the port number in
1543  * @param path the buffer for the path
1544  * @param path_size the size of the path buffer
1545  * @param url the URL to split
1546  */
1547 void av_url_split(char *proto,         int proto_size,
1548                   char *authorization, int authorization_size,
1549                   char *hostname,      int hostname_size,
1550                   int *port_ptr,
1551                   char *path,          int path_size,
1552                   const char *url);
1553
1554
1555 void av_dump_format(AVFormatContext *ic,
1556                     int index,
1557                     const char *url,
1558                     int is_output);
1559
1560 /**
1561  * Get the current time in microseconds.
1562  */
1563 int64_t av_gettime(void);
1564
1565 /**
1566  * Return in 'buf' the path with '%d' replaced by a number.
1567  *
1568  * Also handles the '%0nd' format where 'n' is the total number
1569  * of digits and '%%'.
1570  *
1571  * @param buf destination buffer
1572  * @param buf_size destination buffer size
1573  * @param path numbered sequence string
1574  * @param number frame number
1575  * @return 0 if OK, -1 on format error
1576  */
1577 int av_get_frame_filename(char *buf, int buf_size,
1578                           const char *path, int number);
1579
1580 /**
1581  * Check whether filename actually is a numbered sequence generator.
1582  *
1583  * @param filename possible numbered sequence string
1584  * @return 1 if a valid numbered sequence string, 0 otherwise
1585  */
1586 int av_filename_number_test(const char *filename);
1587
1588 /**
1589  * Generate an SDP for an RTP session.
1590  *
1591  * @param ac array of AVFormatContexts describing the RTP streams. If the
1592  *           array is composed by only one context, such context can contain
1593  *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1594  *           all the contexts in the array (an AVCodecContext per RTP stream)
1595  *           must contain only one AVStream.
1596  * @param n_files number of AVCodecContexts contained in ac
1597  * @param buf buffer where the SDP will be stored (must be allocated by
1598  *            the caller)
1599  * @param size the size of the buffer
1600  * @return 0 if OK, AVERROR_xxx on error
1601  */
1602 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1603
1604 /**
1605  * Return a positive value if the given filename has one of the given
1606  * extensions, 0 otherwise.
1607  *
1608  * @param extensions a comma-separated list of filename extensions
1609  */
1610 int av_match_ext(const char *filename, const char *extensions);
1611
1612 /**
1613  * Test if the given container can store a codec.
1614  *
1615  * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
1616  *
1617  * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
1618  *         A negative number if this information is not available.
1619  */
1620 int avformat_query_codec(AVOutputFormat *ofmt, enum CodecID codec_id, int std_compliance);
1621
1622 /**
1623  * @defgroup riff_fourcc RIFF FourCCs
1624  * @{
1625  * Get the tables mapping RIFF FourCCs to libavcodec CodecIDs. The tables are
1626  * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the
1627  * following code:
1628  * @code
1629  * uint32_t tag = MKTAG('H', '2', '6', '4');
1630  * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 };
1631  * enum CodecID id = av_codec_get_id(table, tag);
1632  * @endcode
1633  */
1634 /**
1635  * @return the table mapping RIFF FourCCs for video to libavcodec CodecID.
1636  */
1637 const struct AVCodecTag *avformat_get_riff_video_tags(void);
1638 /**
1639  * @return the table mapping RIFF FourCCs for audio to CodecID.
1640  */
1641 const struct AVCodecTag *avformat_get_riff_audio_tags(void);
1642 /**
1643  * @}
1644  */
1645
1646 /**
1647  * @}
1648  */
1649
1650 #endif /* AVFORMAT_AVFORMAT_H */