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