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