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