OSDN Git Service

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