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