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