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