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