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