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