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