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