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