Mercurial > libavformat.hg
annotate avformat.h @ 5324:3616c1434288 libavformat
Add comment on #endif about condition that triggers it.
author | ramiro |
---|---|
date | Wed, 21 Oct 2009 01:25:39 +0000 |
parents | 64e6e0d096b9 |
children | 238bda5af58e |
rev | line source |
---|---|
1306
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1304
diff
changeset
|
1 /* |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1304
diff
changeset
|
2 * copyright (c) 2001 Fabrice Bellard |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1304
diff
changeset
|
3 * |
1358
0899bfe4105c
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
1332
diff
changeset
|
4 * This file is part of FFmpeg. |
0899bfe4105c
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
1332
diff
changeset
|
5 * |
0899bfe4105c
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
1332
diff
changeset
|
6 * FFmpeg is free software; you can redistribute it and/or |
1306
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1304
diff
changeset
|
7 * modify it under the terms of the GNU Lesser General Public |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1304
diff
changeset
|
8 * License as published by the Free Software Foundation; either |
1358
0899bfe4105c
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
1332
diff
changeset
|
9 * version 2.1 of the License, or (at your option) any later version. |
1306
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1304
diff
changeset
|
10 * |
1358
0899bfe4105c
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
1332
diff
changeset
|
11 * FFmpeg is distributed in the hope that it will be useful, |
1306
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1304
diff
changeset
|
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1304
diff
changeset
|
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1304
diff
changeset
|
14 * Lesser General Public License for more details. |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1304
diff
changeset
|
15 * |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1304
diff
changeset
|
16 * You should have received a copy of the GNU Lesser General Public |
1358
0899bfe4105c
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
1332
diff
changeset
|
17 * License along with FFmpeg; if not, write to the Free Software |
1306
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1304
diff
changeset
|
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1304
diff
changeset
|
19 */ |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1304
diff
changeset
|
20 |
3852 | 21 #ifndef AVFORMAT_AVFORMAT_H |
22 #define AVFORMAT_AVFORMAT_H | |
0 | 23 |
3087 | 24 #define LIBAVFORMAT_VERSION_MAJOR 52 |
5227 | 25 #define LIBAVFORMAT_VERSION_MINOR 39 |
5287 | 26 #define LIBAVFORMAT_VERSION_MICRO 2 |
3054 | 27 |
3087 | 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) | |
829 | 34 #define LIBAVFORMAT_BUILD LIBAVFORMAT_VERSION_INT |
218 | 35 |
829 | 36 #define LIBAVFORMAT_IDENT "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION) |
0 | 37 |
3701 | 38 /** |
39 * Returns the LIBAVFORMAT_VERSION_INT constant. | |
40 */ | |
41 unsigned avformat_version(void); | |
42 | |
230
9f4f4ca9f7b5
simpler strptime - added os_support.[ch] - moved localtime_r to os_support.c
bellard
parents:
225
diff
changeset
|
43 #include <time.h> |
314 | 44 #include <stdio.h> /* FILE */ |
3065 | 45 #include "libavcodec/avcodec.h" |
0 | 46 |
47 #include "avio.h" | |
48 | |
4617 | 49 struct AVFormatContext; |
50 | |
4150 | 51 |
52 /* | |
4152
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
53 * Public Metadata API. |
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
54 * The metadata API allows libavformat to export metadata tags to a client |
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
55 * application using a sequence of key/value pairs. |
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
56 * Important concepts to keep in mind: |
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
57 * 1. Keys are unique; there can never be 2 tags with the same key. This is |
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
58 * also meant semantically, i.e., a demuxer should not knowingly produce |
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
59 * several keys that are literally different but semantically identical. |
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
60 * E.g., key=Author5, key=Author6. In this example, all authors must be |
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
61 * placed in the same tag. |
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
62 * 2. Metadata is flat, not hierarchical; there are no subtags. If you |
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
63 * want to store, e.g., the email address of the child of producer Alice |
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
64 * and actor Bob, that could have key=alice_and_bobs_childs_email_address. |
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
65 * 3. A tag whose value is localized for a particular language is appended |
4878
5f8639313523
Clarify which exact variant of ISO 639 is used. (The ISO spec explicitly
michael
parents:
4821
diff
changeset
|
66 * with a dash character ('-') and the ISO 639-2/B 3-letter language code. |
4152
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
67 * For example: Author-ger=Michael, Author-eng=Mike |
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
68 * The original/default language is in the unqualified "Author" tag. |
4150 | 69 * A demuxer should set a default if it sets any translated tag. |
70 */ | |
71 | |
4250
2fc899894f5e
replace AV_METADATA_IGNORE_CASE flag by a new AV_METADATA_MATCH_CASE flag
aurel
parents:
4244
diff
changeset
|
72 #define AV_METADATA_MATCH_CASE 1 |
4150 | 73 #define AV_METADATA_IGNORE_SUFFIX 2 |
74 | |
75 typedef struct { | |
76 char *key; | |
77 char *value; | |
4154
bd4d3fee45d0
rename AVMetaData to AVMetadata and meta_data to metadata
aurel
parents:
4153
diff
changeset
|
78 }AVMetadataTag; |
4150 | 79 |
4157 | 80 typedef struct AVMetadata AVMetadata; |
4617 | 81 typedef struct AVMetadataConv AVMetadataConv; |
4150 | 82 |
83 /** | |
4576 | 84 * Gets a metadata element with matching key. |
85 * @param prev Set to the previous matching element to find the next. | |
86 * @param flags Allows case as well as suffix-insensitive comparisons. | |
87 * @return Found tag or NULL, changing key or value leads to undefined behavior. | |
4150 | 88 */ |
4154
bd4d3fee45d0
rename AVMetaData to AVMetadata and meta_data to metadata
aurel
parents:
4153
diff
changeset
|
89 AVMetadataTag * |
4157 | 90 av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags); |
4150 | 91 |
92 /** | |
4576 | 93 * Sets the given tag in m, overwriting an existing tag. |
94 * @param key tag key to add to m (will be av_strduped) | |
95 * @param value tag value to add to m (will be av_strduped) | |
96 * @return >= 0 on success otherwise an error code <0 | |
4150 | 97 */ |
4353
e4a1b568b313
modify the way to pass parameters to av_metadata_set()
aurel
parents:
4307
diff
changeset
|
98 int av_metadata_set(AVMetadata **pm, const char *key, const char *value); |
4150 | 99 |
4161 | 100 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
101 * Converts all the metadata sets from ctx according to the source and |
4617 | 102 * destination conversion tables. |
103 * @param d_conv destination tags format conversion table | |
104 * @param s_conv source tags format conversion table | |
105 */ | |
106 void av_metadata_conv(struct AVFormatContext *ctx,const AVMetadataConv *d_conv, | |
107 const AVMetadataConv *s_conv); | |
108 | |
109 /** | |
4576 | 110 * Frees all the memory allocated for an AVMetadata struct. |
4161 | 111 */ |
112 void av_metadata_free(AVMetadata **m); | |
113 | |
4150 | 114 |
0 | 115 /* packet functions */ |
116 | |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
117 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
118 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
119 * Allocates and reads the payload of a packet and initializes its |
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
120 * fields with default values. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
121 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
122 * @param pkt packet |
3948 | 123 * @param size desired payload size |
124 * @return >0 (read size) if OK, AVERROR_xxx otherwise | |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
125 */ |
775 | 126 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
127 |
0 | 128 |
129 /*************************************************/ | |
130 /* fractional numbers for exact pts handling */ | |
131 | |
2065
64bd1b09cef2
patch so that the deprecated items show up correctly
benoit
parents:
2061
diff
changeset
|
132 /** |
3948 | 133 * The exact value of the fractional number is: 'val + num / den'. |
134 * num is assumed to be 0 <= num < den. | |
4444
ed1ff5b9e0d5
Cosmetics: vertical align "*" for consistency with the other doxyies.
stefano
parents:
4443
diff
changeset
|
135 */ |
0 | 136 typedef struct AVFrac { |
885 | 137 int64_t val, num, den; |
4156
ccc2608599a5
Revert deprecation of AVFrac structure. Attempts to replace AVFrac have turned
diego
parents:
4154
diff
changeset
|
138 } AVFrac; |
0 | 139 |
140 /*************************************************/ | |
141 /* input/output formats */ | |
142 | |
1677
2a85c82b8538
add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents:
1675
diff
changeset
|
143 struct AVCodecTag; |
2a85c82b8538
add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents:
1675
diff
changeset
|
144 |
3948 | 145 /** This structure contains the data a format has to probe a file. */ |
0 | 146 typedef struct AVProbeData { |
64 | 147 const char *filename; |
5168 | 148 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */ |
149 int buf_size; /**< Size of buf except extra allocated bytes */ | |
0 | 150 } AVProbeData; |
151 | |
4576 | 152 #define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection |
2001
1a3c9056982a
allocate 32 extra bytes at the end of the probe buffer and remove most probe buf_size checks
michael
parents:
1986
diff
changeset
|
153 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer |
0 | 154 |
155 typedef struct AVFormatParameters { | |
743 | 156 AVRational time_base; |
0 | 157 int sample_rate; |
158 int channels; | |
159 int width; | |
160 int height; | |
161 enum PixelFormat pix_fmt; | |
3948 | 162 int channel; /**< Used to select DV channel. */ |
163 const char *standard; /**< TV standard, NTSC, PAL, SECAM */ | |
164 unsigned int mpeg2ts_raw:1; /**< Force raw MPEG-2 transport stream output, if possible. */ | |
165 unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport | |
3553
c3b9334f46ae
One-bit bitfields should probably be unsigned. Unfortunately, it is left
takis
parents:
3445
diff
changeset
|
166 stream packet (only meaningful if |
3948 | 167 mpeg2ts_raw is TRUE). */ |
168 unsigned int initial_pause:1; /**< Do not begin to play the stream | |
169 immediately (RTSP only). */ | |
3553
c3b9334f46ae
One-bit bitfields should probably be unsigned. Unfortunately, it is left
takis
parents:
3445
diff
changeset
|
170 unsigned int prealloced_context:1; |
2833
578a0c783eae
Remove *_codec_id from AVFormatParameters with the next major version bump.
michael
parents:
2832
diff
changeset
|
171 #if LIBAVFORMAT_VERSION_INT < (53<<16) |
583 | 172 enum CodecID video_codec_id; |
173 enum CodecID audio_codec_id; | |
2833
578a0c783eae
Remove *_codec_id from AVFormatParameters with the next major version bump.
michael
parents:
2832
diff
changeset
|
174 #endif |
0 | 175 } AVFormatParameters; |
176 | |
3948 | 177 //! Demuxer will use url_fopen, no opened file should be provided by the caller. |
1675 | 178 #define AVFMT_NOFILE 0x0001 |
3948 | 179 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */ |
180 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */ | |
181 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for | |
182 raw picture data. */ | |
183 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */ | |
184 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */ | |
185 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */ | |
186 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. */ | |
4567
963e3b76c7a6
Add AVFMT_VARIABLE_FPS to specify which muxers do not need duplicated frames.
michael
parents:
4547
diff
changeset
|
187 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */ |
0 | 188 |
189 typedef struct AVOutputFormat { | |
190 const char *name; | |
3424
7a0230981402
Make long_names in lavf/lavdev optional depending on CONFIG_SMALL.
diego
parents:
3334
diff
changeset
|
191 /** |
7a0230981402
Make long_names in lavf/lavdev optional depending on CONFIG_SMALL.
diego
parents:
3334
diff
changeset
|
192 * Descriptive name for the format, meant to be more human-readable |
4958 | 193 * than name. You should use the NULL_IF_CONFIG_SMALL() macro |
3424
7a0230981402
Make long_names in lavf/lavdev optional depending on CONFIG_SMALL.
diego
parents:
3334
diff
changeset
|
194 * to define it. |
7a0230981402
Make long_names in lavf/lavdev optional depending on CONFIG_SMALL.
diego
parents:
3334
diff
changeset
|
195 */ |
0 | 196 const char *long_name; |
197 const char *mime_type; | |
3948 | 198 const char *extensions; /**< comma-separated filename extensions */ |
4576 | 199 /** size of private data so that it can be allocated in the wrapper */ |
0 | 200 int priv_data_size; |
201 /* output support */ | |
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
202 enum CodecID audio_codec; /**< default audio codec */ |
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
203 enum CodecID video_codec; /**< default video codec */ |
0 | 204 int (*write_header)(struct AVFormatContext *); |
468 | 205 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt); |
0 | 206 int (*write_trailer)(struct AVFormatContext *); |
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
207 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */ |
0 | 208 int flags; |
3948 | 209 /** Currently only used to set pixel format if not YUV420P. */ |
17
e1200dd82537
added simple still image format support to simplify image and imagepipe video formats
bellard
parents:
5
diff
changeset
|
210 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *); |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
211 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
212 AVPacket *in, int flush); |
1677
2a85c82b8538
add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents:
1675
diff
changeset
|
213 |
2a85c82b8538
add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents:
1675
diff
changeset
|
214 /** |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
215 * List of supported codec_id-codec_tag pairs, ordered by "better |
4576 | 216 * choice first". The arrays are all terminated by CODEC_ID_NONE. |
1677
2a85c82b8538
add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents:
1675
diff
changeset
|
217 */ |
3766
f062deeedb8d
Change codec_tag type from const struct AVCodecTag ** to const struct AVCodecTag * const *
reimar
parents:
3758
diff
changeset
|
218 const struct AVCodecTag * const *codec_tag; |
1677
2a85c82b8538
add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents:
1675
diff
changeset
|
219 |
2280
69270eb6b20c
add proper support for subtitles muxing/stream copying
aurel
parents:
2241
diff
changeset
|
220 enum CodecID subtitle_codec; /**< default subtitle codec */ |
69270eb6b20c
add proper support for subtitles muxing/stream copying
aurel
parents:
2241
diff
changeset
|
221 |
4618
5b9eddbee9c4
Add some basic metadata conversion tables for matroska and asf.
aurel
parents:
4617
diff
changeset
|
222 const AVMetadataConv *metadata_conv; |
4617 | 223 |
0 | 224 /* private fields */ |
225 struct AVOutputFormat *next; | |
226 } AVOutputFormat; | |
227 | |
228 typedef struct AVInputFormat { | |
229 const char *name; | |
3424
7a0230981402
Make long_names in lavf/lavdev optional depending on CONFIG_SMALL.
diego
parents:
3334
diff
changeset
|
230 /** |
7a0230981402
Make long_names in lavf/lavdev optional depending on CONFIG_SMALL.
diego
parents:
3334
diff
changeset
|
231 * Descriptive name for the format, meant to be more human-readable |
4958 | 232 * than name. You should use the NULL_IF_CONFIG_SMALL() macro |
3424
7a0230981402
Make long_names in lavf/lavdev optional depending on CONFIG_SMALL.
diego
parents:
3334
diff
changeset
|
233 * to define it. |
7a0230981402
Make long_names in lavf/lavdev optional depending on CONFIG_SMALL.
diego
parents:
3334
diff
changeset
|
234 */ |
0 | 235 const char *long_name; |
3948 | 236 /** Size of private data so that it can be allocated in the wrapper. */ |
0 | 237 int priv_data_size; |
2367
43a4290a6d77
mention AVPROBE_PADDING_SIZE at the read_probe() doxy
michael
parents:
2317
diff
changeset
|
238 /** |
4576 | 239 * Tell if a given file has a chance of being parsed as this format. |
2815 | 240 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes |
241 * big so you do not have to check for that unless you need more. | |
2367
43a4290a6d77
mention AVPROBE_PADDING_SIZE at the read_probe() doxy
michael
parents:
2317
diff
changeset
|
242 */ |
0 | 243 int (*read_probe)(AVProbeData *); |
3948 | 244 /** Read the format header and initialize the AVFormatContext |
245 structure. Return 0 if OK. 'ap' if non-NULL contains | |
246 additional parameters. Only used in raw format right | |
0 | 247 now. 'av_new_stream' should be called to create new streams. */ |
248 int (*read_header)(struct AVFormatContext *, | |
249 AVFormatParameters *ap); | |
3948 | 250 /** Read one packet and put it in 'pkt'. pts and flags are also |
0 | 251 set. 'av_new_stream' can be called only if the flag |
4821
810c0bbb435e
Describe read_alloc return value and required pkt handling to avoid memleaks
reimar
parents:
4817
diff
changeset
|
252 AVFMTCTX_NOHEADER is used. |
810c0bbb435e
Describe read_alloc return value and required pkt handling to avoid memleaks
reimar
parents:
4817
diff
changeset
|
253 @return 0 on success, < 0 on error. |
810c0bbb435e
Describe read_alloc return value and required pkt handling to avoid memleaks
reimar
parents:
4817
diff
changeset
|
254 When returning an error, pkt must not have been allocated |
810c0bbb435e
Describe read_alloc return value and required pkt handling to avoid memleaks
reimar
parents:
4817
diff
changeset
|
255 or must be freed before returning */ |
0 | 256 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt); |
3948 | 257 /** Close the stream. The AVFormatContext and AVStreams are not |
0 | 258 freed by this function */ |
259 int (*read_close)(struct AVFormatContext *); | |
4570 | 260 |
261 #if LIBAVFORMAT_VERSION_MAJOR < 53 | |
885 | 262 /** |
3948 | 263 * Seek to a given timestamp relative to the frames in |
264 * stream component stream_index. | |
4576 | 265 * @param stream_index Must not be -1. |
266 * @param flags Selects which direction should be preferred if no exact | |
267 * match is available. | |
2203
a81bd08b5ff2
* clarifying the AVInputFormat::read_seek return value
romansh
parents:
2190
diff
changeset
|
268 * @return >= 0 on success (but not necessarily the new offset) |
555 | 269 */ |
885 | 270 int (*read_seek)(struct AVFormatContext *, |
555 | 271 int stream_index, int64_t timestamp, int flags); |
4570 | 272 #endif |
437
50bae308f71e
moving nearly identical binary search code from nut/mpeg/asf to utils.c
michael
parents:
420
diff
changeset
|
273 /** |
3948 | 274 * Gets the next timestamp in stream[stream_index].time_base units. |
3175 | 275 * @return the timestamp or AV_NOPTS_VALUE if an error occurred |
437
50bae308f71e
moving nearly identical binary search code from nut/mpeg/asf to utils.c
michael
parents:
420
diff
changeset
|
276 */ |
50bae308f71e
moving nearly identical binary search code from nut/mpeg/asf to utils.c
michael
parents:
420
diff
changeset
|
277 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index, |
50bae308f71e
moving nearly identical binary search code from nut/mpeg/asf to utils.c
michael
parents:
420
diff
changeset
|
278 int64_t *pos, int64_t pos_limit); |
3948 | 279 /** Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER. */ |
0 | 280 int flags; |
3948 | 281 /** If extensions are defined, then no probe is done. You should |
0 | 282 usually not use extension format guessing because it is not |
283 reliable enough */ | |
284 const char *extensions; | |
3948 | 285 /** General purpose read-only value that the format can use. */ |
0 | 286 int value; |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
287 |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
288 /** Starts/resumes playing - only meaningful if using a network-based format |
3948 | 289 (RTSP). */ |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
290 int (*read_play)(struct AVFormatContext *); |
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
291 |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
292 /** Pauses playing - only meaningful if using a network-based format |
3948 | 293 (RTSP). */ |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
294 int (*read_pause)(struct AVFormatContext *); |
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
295 |
3766
f062deeedb8d
Change codec_tag type from const struct AVCodecTag ** to const struct AVCodecTag * const *
reimar
parents:
3758
diff
changeset
|
296 const struct AVCodecTag * const *codec_tag; |
1677
2a85c82b8538
add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents:
1675
diff
changeset
|
297 |
4570 | 298 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
299 * Seeks to timestamp ts. |
4570 | 300 * Seeking will be done so that the point from which all active streams |
301 * can be presented successfully will be closest to ts and within min/max_ts. | |
302 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL. | |
303 */ | |
4575 | 304 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags); |
4570 | 305 |
4618
5b9eddbee9c4
Add some basic metadata conversion tables for matroska and asf.
aurel
parents:
4617
diff
changeset
|
306 const AVMetadataConv *metadata_conv; |
4617 | 307 |
0 | 308 /* private fields */ |
309 struct AVInputFormat *next; | |
310 } AVInputFormat; | |
311 | |
2023 | 312 enum AVStreamParseType { |
313 AVSTREAM_PARSE_NONE, | |
314 AVSTREAM_PARSE_FULL, /**< full parsing and repack */ | |
3948 | 315 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */ |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
316 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */ |
2023 | 317 }; |
318 | |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
319 typedef struct AVIndexEntry { |
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
320 int64_t pos; |
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
321 int64_t timestamp; |
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
322 #define AVINDEX_KEYFRAME 0x0001 |
979 | 323 int flags:2; |
3948 | 324 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). |
325 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */ | |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
326 } AVIndexEntry; |
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
327 |
3120
ea5623a8efde
Add 'disposition' bitfield to AVStream and use it for both muxing and demuxing
eugeni
parents:
3087
diff
changeset
|
328 #define AV_DISPOSITION_DEFAULT 0x0001 |
ea5623a8efde
Add 'disposition' bitfield to AVStream and use it for both muxing and demuxing
eugeni
parents:
3087
diff
changeset
|
329 #define AV_DISPOSITION_DUB 0x0002 |
ea5623a8efde
Add 'disposition' bitfield to AVStream and use it for both muxing and demuxing
eugeni
parents:
3087
diff
changeset
|
330 #define AV_DISPOSITION_ORIGINAL 0x0004 |
ea5623a8efde
Add 'disposition' bitfield to AVStream and use it for both muxing and demuxing
eugeni
parents:
3087
diff
changeset
|
331 #define AV_DISPOSITION_COMMENT 0x0008 |
ea5623a8efde
Add 'disposition' bitfield to AVStream and use it for both muxing and demuxing
eugeni
parents:
3087
diff
changeset
|
332 #define AV_DISPOSITION_LYRICS 0x0010 |
ea5623a8efde
Add 'disposition' bitfield to AVStream and use it for both muxing and demuxing
eugeni
parents:
3087
diff
changeset
|
333 #define AV_DISPOSITION_KARAOKE 0x0020 |
ea5623a8efde
Add 'disposition' bitfield to AVStream and use it for both muxing and demuxing
eugeni
parents:
3087
diff
changeset
|
334 |
2846
625c2c60f585
Document a few more structure change rules with relation to ABI/API.
michael
parents:
2844
diff
changeset
|
335 /** |
625c2c60f585
Document a few more structure change rules with relation to ABI/API.
michael
parents:
2844
diff
changeset
|
336 * Stream structure. |
625c2c60f585
Document a few more structure change rules with relation to ABI/API.
michael
parents:
2844
diff
changeset
|
337 * New fields can be added to the end with minor version bumps. |
2851 | 338 * Removal, reordering and changes to existing fields require a major |
2846
625c2c60f585
Document a few more structure change rules with relation to ABI/API.
michael
parents:
2844
diff
changeset
|
339 * version bump. |
2851 | 340 * sizeof(AVStream) must not be used outside libav*. |
2846
625c2c60f585
Document a few more structure change rules with relation to ABI/API.
michael
parents:
2844
diff
changeset
|
341 */ |
0 | 342 typedef struct AVStream { |
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
343 int index; /**< stream index in AVFormatContext */ |
3948 | 344 int id; /**< format-specific stream ID */ |
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
345 AVCodecContext *codec; /**< codec context */ |
793 | 346 /** |
4576 | 347 * Real base framerate of the stream. |
348 * This is the lowest framerate with which all timestamps can be | |
2141 | 349 * represented accurately (it is the least common multiple of all |
4576 | 350 * framerates in the stream). Note, this value is just a guess! |
351 * For example, if the time base is 1/90000 and all frames have either | |
3948 | 352 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1. |
793 | 353 */ |
354 AVRational r_frame_rate; | |
0 | 355 void *priv_data; |
2300
9c8cfadff191
correct initial timestamps which have AV_NOPTS_VALUE
michael
parents:
2284
diff
changeset
|
356 |
0 | 357 /* internal data used in av_find_stream_info() */ |
2300
9c8cfadff191
correct initial timestamps which have AV_NOPTS_VALUE
michael
parents:
2284
diff
changeset
|
358 int64_t first_dts; |
3948 | 359 /** encoding: pts generation when outputting stream */ |
2241 | 360 struct AVFrac pts; |
844
35e372e6a6c3
time_base description by Rich Felker | dalias, aerifal cx
michael
parents:
842
diff
changeset
|
361 |
35e372e6a6c3
time_base description by Rich Felker | dalias, aerifal cx
michael
parents:
842
diff
changeset
|
362 /** |
2851 | 363 * This is the fundamental unit of time (in seconds) in terms |
364 * of which frame timestamps are represented. For fixed-fps content, | |
4576 | 365 * time base should be 1/framerate and timestamp increments should be 1. |
844
35e372e6a6c3
time_base description by Rich Felker | dalias, aerifal cx
michael
parents:
842
diff
changeset
|
366 */ |
462
b69898ffc92a
move time_base (pts_num/pts_den) from AVFormatContext -> AVStream
michael
parents:
437
diff
changeset
|
367 AVRational time_base; |
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
368 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */ |
0 | 369 /* ffmpeg.c private use */ |
3948 | 370 int stream_copy; /**< If set, just copy stream. */ |
371 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed. | |
650 | 372 //FIXME move stuff to a flags field? |
3948 | 373 /** Quality, as it has been removed from AVCodecContext and put in AVVideoFrame. |
2164 | 374 * MN: dunno if that is the right place for it */ |
885 | 375 float quality; |
2386
2beaa59babad
elaborate a little on AVStream.start_time, it seems the comment is not clear
michael
parents:
2374
diff
changeset
|
376 /** |
2851 | 377 * Decoding: pts of the first frame of the stream, in stream time base. |
378 * Only set this if you are absolutely 100% sure that the value you set | |
379 * it to really is the pts of the first frame. | |
2396
28f19eb568a2
mention that start_time maybe AV_NOPTS_VALUE (from patch by neilb suse de)
michael
parents:
2386
diff
changeset
|
380 * This may be undefined (AV_NOPTS_VALUE). |
2851 | 381 * @note The ASF header does NOT contain a correct start_time the ASF |
382 * demuxer must NOT set this. | |
2386
2beaa59babad
elaborate a little on AVStream.start_time, it seems the comment is not clear
michael
parents:
2374
diff
changeset
|
383 */ |
885 | 384 int64_t start_time; |
2397
e5086ec7a4d4
more verbose doxy for duration (from patch by neilb suse de)
michael
parents:
2396
diff
changeset
|
385 /** |
2851 | 386 * Decoding: duration of the stream, in stream time base. |
2397
e5086ec7a4d4
more verbose doxy for duration (from patch by neilb suse de)
michael
parents:
2396
diff
changeset
|
387 * If a source file does not specify a duration, but does specify |
3948 | 388 * a bitrate, this value will be estimated from bitrate and file size. |
2397
e5086ec7a4d4
more verbose doxy for duration (from patch by neilb suse de)
michael
parents:
2396
diff
changeset
|
389 */ |
186
2265d21a04c8
added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents:
184
diff
changeset
|
390 int64_t duration; |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
391 |
4626 | 392 #if LIBAVFORMAT_VERSION_INT < (53<<16) |
4878
5f8639313523
Clarify which exact variant of ISO 639 is used. (The ISO spec explicitly
michael
parents:
4821
diff
changeset
|
393 char language[4]; /** ISO 639-2/B 3-letter language code (empty string if undefined) */ |
4626 | 394 #endif |
784 | 395 |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
396 /* av_read_frame() support */ |
2023 | 397 enum AVStreamParseType need_parsing; |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
398 struct AVCodecParserContext *parser; |
334
7f089db11f9a
fixed incorrect PTS/DTS logic in MPEG video case (caused rare PTS glitches if start codes were between two PES packets)
bellard
parents:
315
diff
changeset
|
399 |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
400 int64_t cur_dts; |
3058 | 401 int last_IP_duration; |
402 int64_t last_IP_pts; | |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
403 /* av_seek_frame() support */ |
3948 | 404 AVIndexEntry *index_entries; /**< Only used if the format does not |
405 support seeking natively. */ | |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
406 int nb_index_entries; |
1332 | 407 unsigned int index_entries_allocated_size; |
885 | 408 |
793 | 409 int64_t nb_frames; ///< number of frames in this stream if known or 0 |
1285
b5226e679a31
fix b pyramid in mp4 muxing if no dts are provided to the muxer
michael
parents:
1279
diff
changeset
|
410 |
3711
a2bdb3bfeb99
increase MAX_REORDER_DELAY and pts_buffer size to 16, max for h264 atm
bcoudurier
parents:
3701
diff
changeset
|
411 #if LIBAVFORMAT_VERSION_INT < (53<<16) |
a2bdb3bfeb99
increase MAX_REORDER_DELAY and pts_buffer size to 16, max for h264 atm
bcoudurier
parents:
3701
diff
changeset
|
412 int64_t unused[4+1]; |
2973 | 413 |
414 char *filename; /**< source filename of the stream */ | |
4626 | 415 #endif |
3120
ea5623a8efde
Add 'disposition' bitfield to AVStream and use it for both muxing and demuxing
eugeni
parents:
3087
diff
changeset
|
416 |
3948 | 417 int disposition; /**< AV_DISPOSITION_* bit field */ |
3568 | 418 |
419 AVProbeData probe_data; | |
3711
a2bdb3bfeb99
increase MAX_REORDER_DELAY and pts_buffer size to 16, max for h264 atm
bcoudurier
parents:
3701
diff
changeset
|
420 #define MAX_REORDER_DELAY 16 |
a2bdb3bfeb99
increase MAX_REORDER_DELAY and pts_buffer size to 16, max for h264 atm
bcoudurier
parents:
3701
diff
changeset
|
421 int64_t pts_buffer[MAX_REORDER_DELAY+1]; |
3758
e966560661e5
export sample_aspect_ratio read by the demuxer in a separate field
aurel
parents:
3724
diff
changeset
|
422 |
e966560661e5
export sample_aspect_ratio read by the demuxer in a separate field
aurel
parents:
3724
diff
changeset
|
423 /** |
e966560661e5
export sample_aspect_ratio read by the demuxer in a separate field
aurel
parents:
3724
diff
changeset
|
424 * sample aspect ratio (0 if unknown) |
e966560661e5
export sample_aspect_ratio read by the demuxer in a separate field
aurel
parents:
3724
diff
changeset
|
425 * - encoding: Set by user. |
e966560661e5
export sample_aspect_ratio read by the demuxer in a separate field
aurel
parents:
3724
diff
changeset
|
426 * - decoding: Set by libavformat. |
e966560661e5
export sample_aspect_ratio read by the demuxer in a separate field
aurel
parents:
3724
diff
changeset
|
427 */ |
e966560661e5
export sample_aspect_ratio read by the demuxer in a separate field
aurel
parents:
3724
diff
changeset
|
428 AVRational sample_aspect_ratio; |
4153 | 429 |
4157 | 430 AVMetadata *metadata; |
4273
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
431 |
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
432 /* av_read_frame() support */ |
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
433 const uint8_t *cur_ptr; |
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
434 int cur_len; |
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
435 AVPacket cur_pkt; |
4569
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
436 |
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
437 // Timestamp generation support: |
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
438 /** |
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
439 * Timestamp corresponding to the last dts sync point. |
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
440 * |
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
441 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and |
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
442 * a DTS is received from the underlying container. Otherwise set to |
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
443 * AV_NOPTS_VALUE by default. |
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
444 */ |
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
445 int64_t reference_dts; |
4975
76263311c368
fix codec probing, stop after MAX_PROBE_PACKETS and return all packets
bcoudurier
parents:
4969
diff
changeset
|
446 |
76263311c368
fix codec probing, stop after MAX_PROBE_PACKETS and return all packets
bcoudurier
parents:
4969
diff
changeset
|
447 /** |
76263311c368
fix codec probing, stop after MAX_PROBE_PACKETS and return all packets
bcoudurier
parents:
4969
diff
changeset
|
448 * Number of packets to buffer for codec probing |
76263311c368
fix codec probing, stop after MAX_PROBE_PACKETS and return all packets
bcoudurier
parents:
4969
diff
changeset
|
449 * NOT PART OF PUBLIC API |
76263311c368
fix codec probing, stop after MAX_PROBE_PACKETS and return all packets
bcoudurier
parents:
4969
diff
changeset
|
450 */ |
5233 | 451 #define MAX_PROBE_PACKETS 2500 |
4975
76263311c368
fix codec probing, stop after MAX_PROBE_PACKETS and return all packets
bcoudurier
parents:
4969
diff
changeset
|
452 int probe_packets; |
5200
cd884511ec8b
Make packet interleaving in the muxer not scan through the whole
michael
parents:
5168
diff
changeset
|
453 |
cd884511ec8b
Make packet interleaving in the muxer not scan through the whole
michael
parents:
5168
diff
changeset
|
454 /** |
5210
36d130853c9b
Improve amortized worst case speed of the muxers packet interleaving code
michael
parents:
5200
diff
changeset
|
455 * last packet in packet_buffer for this stream when muxing. |
5200
cd884511ec8b
Make packet interleaving in the muxer not scan through the whole
michael
parents:
5168
diff
changeset
|
456 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav* |
cd884511ec8b
Make packet interleaving in the muxer not scan through the whole
michael
parents:
5168
diff
changeset
|
457 */ |
5210
36d130853c9b
Improve amortized worst case speed of the muxers packet interleaving code
michael
parents:
5200
diff
changeset
|
458 struct AVPacketList *last_in_packet_buffer; |
0 | 459 } AVStream; |
460 | |
2573
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
461 #define AV_PROGRAM_RUNNING 1 |
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
462 |
2846
625c2c60f585
Document a few more structure change rules with relation to ABI/API.
michael
parents:
2844
diff
changeset
|
463 /** |
625c2c60f585
Document a few more structure change rules with relation to ABI/API.
michael
parents:
2844
diff
changeset
|
464 * New fields can be added to the end with minor version bumps. |
2851 | 465 * Removal, reordering and changes to existing fields require a major |
2846
625c2c60f585
Document a few more structure change rules with relation to ABI/API.
michael
parents:
2844
diff
changeset
|
466 * version bump. |
2851 | 467 * sizeof(AVProgram) must not be used outside libav*. |
2846
625c2c60f585
Document a few more structure change rules with relation to ABI/API.
michael
parents:
2844
diff
changeset
|
468 */ |
2573
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
469 typedef struct AVProgram { |
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
470 int id; |
4626 | 471 #if LIBAVFORMAT_VERSION_INT < (53<<16) |
3948 | 472 char *provider_name; ///< network name for DVB streams |
473 char *name; ///< service name for DVB streams | |
4626 | 474 #endif |
2573
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
475 int flags; |
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
476 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller |
2650
4e3d38c8896c
API extension: AVProgram now has an array (stream_index) containing the indexes of the streams in AVFormatContext
nicodvb
parents:
2620
diff
changeset
|
477 unsigned int *stream_index; |
4e3d38c8896c
API extension: AVProgram now has an array (stream_index) containing the indexes of the streams in AVFormatContext
nicodvb
parents:
2620
diff
changeset
|
478 unsigned int nb_stream_indexes; |
4157 | 479 AVMetadata *metadata; |
2573
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
480 } AVProgram; |
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
481 |
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
482 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present |
293
62cec412a186
make AVFMT_NOHEADER flag dynamic - added av_open_input_stream()
bellard
parents:
274
diff
changeset
|
483 (streams are added dynamically) */ |
62cec412a186
make AVFMT_NOHEADER flag dynamic - added av_open_input_stream()
bellard
parents:
274
diff
changeset
|
484 |
3314 | 485 typedef struct AVChapter { |
3948 | 486 int id; ///< unique ID to identify the chapter |
487 AVRational time_base; ///< time base in which the start/end timestamps are specified | |
3322 | 488 int64_t start, end; ///< chapter start/end time in time_base units |
4626 | 489 #if LIBAVFORMAT_VERSION_INT < (53<<16) |
3321 | 490 char *title; ///< chapter title |
4626 | 491 #endif |
4157 | 492 AVMetadata *metadata; |
3314 | 493 } AVChapter; |
494 | |
0 | 495 #define MAX_STREAMS 20 |
496 | |
2844
440267faee3c
Document structure change rules with relation to ABI/API.
michael
parents:
2836
diff
changeset
|
497 /** |
3948 | 498 * Format I/O context. |
2844
440267faee3c
Document structure change rules with relation to ABI/API.
michael
parents:
2836
diff
changeset
|
499 * New fields can be added to the end with minor version bumps. |
2851 | 500 * Removal, reordering and changes to existing fields require a major |
2844
440267faee3c
Document structure change rules with relation to ABI/API.
michael
parents:
2836
diff
changeset
|
501 * version bump. |
2851 | 502 * sizeof(AVFormatContext) must not be used outside libav*. |
2844
440267faee3c
Document structure change rules with relation to ABI/API.
michael
parents:
2836
diff
changeset
|
503 */ |
0 | 504 typedef struct AVFormatContext { |
4538
63c5b6f7d3f5
av_alloc_format_context has been renamed, update AVFormatContext av_class
benoit
parents:
4499
diff
changeset
|
505 const AVClass *av_class; /**< Set by avformat_alloc_context. */ |
3948 | 506 /* Can only be iformat or oformat, not both at the same time. */ |
0 | 507 struct AVInputFormat *iformat; |
508 struct AVOutputFormat *oformat; | |
509 void *priv_data; | |
2771
d52c718e83f9
Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents:
2749
diff
changeset
|
510 ByteIOContext *pb; |
1663 | 511 unsigned int nb_streams; |
0 | 512 AVStream *streams[MAX_STREAMS]; |
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
513 char filename[1024]; /**< input or output filename */ |
0 | 514 /* stream info */ |
420
e440fb884442
* making it possible to specify recording date and time in a stream
romansh
parents:
384
diff
changeset
|
515 int64_t timestamp; |
4626 | 516 #if LIBAVFORMAT_VERSION_INT < (53<<16) |
0 | 517 char title[512]; |
518 char author[512]; | |
519 char copyright[512]; | |
520 char comment[512]; | |
234 | 521 char album[512]; |
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
522 int year; /**< ID3 year, 0 if none */ |
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
523 int track; /**< track number, 0 if none */ |
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
524 char genre[32]; /**< ID3 genre */ |
4626 | 525 #endif |
234 | 526 |
3948 | 527 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */ |
528 /* private data for pts handling (do not modify directly). */ | |
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
529 /** This buffer is only needed when packets were already buffered but |
3948 | 530 not decoded, for example to get the codec parameters in MPEG |
531 streams. */ | |
186
2265d21a04c8
added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents:
184
diff
changeset
|
532 struct AVPacketList *packet_buffer; |
2265d21a04c8
added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents:
184
diff
changeset
|
533 |
3948 | 534 /** Decoding: position of the first frame of the component, in |
186
2265d21a04c8
added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents:
184
diff
changeset
|
535 AV_TIME_BASE fractional seconds. NEVER set this value directly: |
3948 | 536 It is deduced from the AVStream values. */ |
885 | 537 int64_t start_time; |
3948 | 538 /** Decoding: duration of the stream, in AV_TIME_BASE fractional |
186
2265d21a04c8
added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents:
184
diff
changeset
|
539 seconds. NEVER set this value directly: it is deduced from the |
2265d21a04c8
added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents:
184
diff
changeset
|
540 AVStream values. */ |
2265d21a04c8
added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents:
184
diff
changeset
|
541 int64_t duration; |
3948 | 542 /** decoding: total file size, 0 if unknown */ |
186
2265d21a04c8
added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents:
184
diff
changeset
|
543 int64_t file_size; |
3948 | 544 /** Decoding: total stream bitrate in bit/s, 0 if not |
186
2265d21a04c8
added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents:
184
diff
changeset
|
545 available. Never set it directly if the file_size and the |
4576 | 546 duration are known as FFmpeg can compute it automatically. */ |
186
2265d21a04c8
added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents:
184
diff
changeset
|
547 int bit_rate; |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
548 |
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
549 /* av_read_frame() support */ |
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
550 AVStream *cur_st; |
4273
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
551 #if LIBAVFORMAT_VERSION_INT < (53<<16) |
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
552 const uint8_t *cur_ptr_deprecated; |
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
553 int cur_len_deprecated; |
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
554 AVPacket cur_pkt_deprecated; |
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
555 #endif |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
556 |
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
557 /* av_seek_frame() support */ |
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
558 int64_t data_offset; /** offset of the first packet */ |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
559 int index_built; |
885 | 560 |
551 | 561 int mux_rate; |
5057
c9bbf0a253a8
Change packet_size from signed to unsigned, since it never has a negative
rbultje
parents:
4975
diff
changeset
|
562 unsigned int packet_size; |
566 | 563 int preload; |
564 int max_delay; | |
790
80aec794c2ed
Animated GIF looping patch by (Todd Kirby // ffmpeg.php gmail com)
michael
parents:
784
diff
changeset
|
565 |
885 | 566 #define AVFMT_NOOUTPUTLOOP -1 |
567 #define AVFMT_INFINITEOUTPUTLOOP 0 | |
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
568 /** number of times to loop output in formats that support it */ |
790
80aec794c2ed
Animated GIF looping patch by (Todd Kirby // ffmpeg.php gmail com)
michael
parents:
784
diff
changeset
|
569 int loop_output; |
885 | 570 |
841
ba7631ba33a7
support fixing missing pts by parsing future frames
michael
parents:
829
diff
changeset
|
571 int flags; |
4576 | 572 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames. |
3948 | 573 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index. |
574 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input. | |
1175
8b53c0f3e7ad
add loop_input to AVFormatContext, getting rid of old hack
mru
parents:
1167
diff
changeset
|
575 |
8b53c0f3e7ad
add loop_input to AVFormatContext, getting rid of old hack
mru
parents:
1167
diff
changeset
|
576 int loop_input; |
4576 | 577 /** decoding: size of data to probe; encoding: unused. */ |
1279
a12e0b434174
added option probesize; at the moment only used by mpegts.c
nicodvb
parents:
1278
diff
changeset
|
578 unsigned int probesize; |
1720
1a8d1f66c867
make av_find_stream_info() duration user selectable
michael
parents:
1679
diff
changeset
|
579 |
1a8d1f66c867
make av_find_stream_info() duration user selectable
michael
parents:
1679
diff
changeset
|
580 /** |
3948 | 581 * Maximum time (in AV_TIME_BASE units) during which the input should |
582 * be analyzed in av_find_stream_info(). | |
1720
1a8d1f66c867
make av_find_stream_info() duration user selectable
michael
parents:
1679
diff
changeset
|
583 */ |
1a8d1f66c867
make av_find_stream_info() duration user selectable
michael
parents:
1679
diff
changeset
|
584 int max_analyze_duration; |
1778
d8c6b719a070
add key field to AVFormatContext for de/encryption support, patch by Reimar
bcoudurier
parents:
1756
diff
changeset
|
585 |
d8c6b719a070
add key field to AVFormatContext for de/encryption support, patch by Reimar
bcoudurier
parents:
1756
diff
changeset
|
586 const uint8_t *key; |
d8c6b719a070
add key field to AVFormatContext for de/encryption support, patch by Reimar
bcoudurier
parents:
1756
diff
changeset
|
587 int keylen; |
2573
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
588 |
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
589 unsigned int nb_programs; |
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
590 AVProgram **programs; |
2832 | 591 |
592 /** | |
593 * Forced video codec_id. | |
3948 | 594 * Demuxing: Set by user. |
2832 | 595 */ |
596 enum CodecID video_codec_id; | |
597 /** | |
598 * Forced audio codec_id. | |
3948 | 599 * Demuxing: Set by user. |
2832 | 600 */ |
601 enum CodecID audio_codec_id; | |
602 /** | |
603 * Forced subtitle codec_id. | |
3948 | 604 * Demuxing: Set by user. |
2832 | 605 */ |
606 enum CodecID subtitle_codec_id; | |
2932
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
607 |
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
608 /** |
4576 | 609 * Maximum amount of memory in bytes to use for the index of each stream. |
610 * If the index exceeds this size, entries will be discarded as | |
2932
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
611 * needed to maintain a smaller size. This can lead to slower or less |
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
612 * accurate seeking (depends on demuxer). |
3948 | 613 * Demuxers for which a full in-memory index is mandatory will ignore |
2932
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
614 * this. |
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
615 * muxing : unused |
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
616 * demuxing: set by user |
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
617 */ |
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
618 unsigned int max_index_size; |
3128
b5e2ce291882
Introduce max_picture_buffer variable in AVFormatContext,
ramiro
parents:
3120
diff
changeset
|
619 |
b5e2ce291882
Introduce max_picture_buffer variable in AVFormatContext,
ramiro
parents:
3120
diff
changeset
|
620 /** |
3129 | 621 * Maximum amount of memory in bytes to use for buffering frames |
3948 | 622 * obtained from realtime capture devices. |
3128
b5e2ce291882
Introduce max_picture_buffer variable in AVFormatContext,
ramiro
parents:
3120
diff
changeset
|
623 */ |
b5e2ce291882
Introduce max_picture_buffer variable in AVFormatContext,
ramiro
parents:
3120
diff
changeset
|
624 unsigned int max_picture_buffer; |
3314 | 625 |
3329 | 626 unsigned int nb_chapters; |
3314 | 627 AVChapter **chapters; |
3445 | 628 |
629 /** | |
3948 | 630 * Flags to enable debugging. |
3445 | 631 */ |
632 int debug; | |
633 #define FF_FDEBUG_TS 0x0001 | |
3568 | 634 |
635 /** | |
3948 | 636 * Raw packets from the demuxer, prior to parsing and decoding. |
3568 | 637 * This buffer is used for buffering packets until the codec can |
638 * be identified, as parsing cannot be done without knowing the | |
639 * codec. | |
640 */ | |
641 struct AVPacketList *raw_packet_buffer; | |
3698
b7e347127897
Maintain pointer to end of AVFormatContext.packet_buffer list
mru
parents:
3617
diff
changeset
|
642 struct AVPacketList *raw_packet_buffer_end; |
b7e347127897
Maintain pointer to end of AVFormatContext.packet_buffer list
mru
parents:
3617
diff
changeset
|
643 |
b7e347127897
Maintain pointer to end of AVFormatContext.packet_buffer list
mru
parents:
3617
diff
changeset
|
644 struct AVPacketList *packet_buffer_end; |
4149 | 645 |
4157 | 646 AVMetadata *metadata; |
5069
9fd4808c3916
limit raw packet buffer size used for codec probing
bcoudurier
parents:
5057
diff
changeset
|
647 |
9fd4808c3916
limit raw packet buffer size used for codec probing
bcoudurier
parents:
5057
diff
changeset
|
648 /** |
9fd4808c3916
limit raw packet buffer size used for codec probing
bcoudurier
parents:
5057
diff
changeset
|
649 * Remaining size available for raw_packet_buffer, in bytes. |
9fd4808c3916
limit raw packet buffer size used for codec probing
bcoudurier
parents:
5057
diff
changeset
|
650 * NOT PART OF PUBLIC API |
9fd4808c3916
limit raw packet buffer size used for codec probing
bcoudurier
parents:
5057
diff
changeset
|
651 */ |
5233 | 652 #define RAW_PACKET_BUFFER_SIZE 2500000 |
5069
9fd4808c3916
limit raw packet buffer size used for codec probing
bcoudurier
parents:
5057
diff
changeset
|
653 int raw_packet_buffer_remaining_size; |
0 | 654 } AVFormatContext; |
655 | |
656 typedef struct AVPacketList { | |
657 AVPacket pkt; | |
658 struct AVPacketList *next; | |
659 } AVPacketList; | |
660 | |
2812 | 661 #if LIBAVFORMAT_VERSION_INT < (53<<16) |
0 | 662 extern AVInputFormat *first_iformat; |
663 extern AVOutputFormat *first_oformat; | |
2812 | 664 #endif |
665 | |
4486
fde631f0bc67
Document av_iformat_next() and av_oformat_next() functions.
stefano
parents:
4473
diff
changeset
|
666 /** |
fde631f0bc67
Document av_iformat_next() and av_oformat_next() functions.
stefano
parents:
4473
diff
changeset
|
667 * If f is NULL, returns the first registered input format, |
4576 | 668 * if f is non-NULL, returns the next registered input format after f |
4486
fde631f0bc67
Document av_iformat_next() and av_oformat_next() functions.
stefano
parents:
4473
diff
changeset
|
669 * or NULL if f is the last one. |
fde631f0bc67
Document av_iformat_next() and av_oformat_next() functions.
stefano
parents:
4473
diff
changeset
|
670 */ |
2812 | 671 AVInputFormat *av_iformat_next(AVInputFormat *f); |
4486
fde631f0bc67
Document av_iformat_next() and av_oformat_next() functions.
stefano
parents:
4473
diff
changeset
|
672 |
fde631f0bc67
Document av_iformat_next() and av_oformat_next() functions.
stefano
parents:
4473
diff
changeset
|
673 /** |
fde631f0bc67
Document av_iformat_next() and av_oformat_next() functions.
stefano
parents:
4473
diff
changeset
|
674 * If f is NULL, returns the first registered output format, |
4576 | 675 * if f is non-NULL, returns the next registered output format after f |
4486
fde631f0bc67
Document av_iformat_next() and av_oformat_next() functions.
stefano
parents:
4473
diff
changeset
|
676 * or NULL if f is the last one. |
fde631f0bc67
Document av_iformat_next() and av_oformat_next() functions.
stefano
parents:
4473
diff
changeset
|
677 */ |
2812 | 678 AVOutputFormat *av_oformat_next(AVOutputFormat *f); |
0 | 679 |
583 | 680 enum CodecID av_guess_image2_codec(const char *filename); |
17
e1200dd82537
added simple still image format support to simplify image and imagepipe video formats
bellard
parents:
5
diff
changeset
|
681 |
4576 | 682 /* XXX: Use automatic init with either ELF sections or C file parser */ |
683 /* modules. */ | |
0 | 684 |
685 /* utils.c */ | |
686 void av_register_input_format(AVInputFormat *format); | |
687 void av_register_output_format(AVOutputFormat *format); | |
885 | 688 AVOutputFormat *guess_stream_format(const char *short_name, |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
689 const char *filename, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
690 const char *mime_type); |
885 | 691 AVOutputFormat *guess_format(const char *short_name, |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
692 const char *filename, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
693 const char *mime_type); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
694 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
695 /** |
3948 | 696 * Guesses the codec ID based upon muxer and filename. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
697 */ |
885 | 698 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name, |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
699 const char *filename, const char *mime_type, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
700 enum CodecType type); |
0 | 701 |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
702 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
703 * Sends a nice hexadecimal dump of a buffer to the specified file stream. |
1908
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
704 * |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
705 * @param f The file stream pointer where the dump should be sent to. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
706 * @param buf buffer |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
707 * @param size buffer size |
1908
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
708 * |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
709 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
710 */ |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
711 void av_hex_dump(FILE *f, uint8_t *buf, int size); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
712 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
713 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
714 * Sends a nice hexadecimal dump of a buffer to the log. |
1908
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
715 * |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
716 * @param avcl A pointer to an arbitrary struct of which the first field is a |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
717 * pointer to an AVClass struct. |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
718 * @param level The importance level of the message, lower values signifying |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
719 * higher importance. |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
720 * @param buf buffer |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
721 * @param size buffer size |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
722 * |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
723 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
724 */ |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
725 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size); |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
726 |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
727 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
728 * Sends a nice dump of a packet to the specified file stream. |
1908
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
729 * |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
730 * @param f The file stream pointer where the dump should be sent to. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
731 * @param pkt packet to dump |
3948 | 732 * @param dump_payload True if the payload must be displayed, too. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
733 */ |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
734 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload); |
0 | 735 |
1908
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
736 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
737 * Sends a nice dump of a packet to the log. |
1908
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
738 * |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
739 * @param avcl A pointer to an arbitrary struct of which the first field is a |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
740 * pointer to an AVClass struct. |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
741 * @param level The importance level of the message, lower values signifying |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
742 * higher importance. |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
743 * @param pkt packet to dump |
3948 | 744 * @param dump_payload True if the payload must be displayed, too. |
1908
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
745 */ |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
746 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload); |
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
747 |
4287
fcc542fd3214
Move documentation of av_register_all() from allformats.c to
stefano
parents:
4273
diff
changeset
|
748 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
749 * Initializes libavformat and registers all the muxers, demuxers and |
4287
fcc542fd3214
Move documentation of av_register_all() from allformats.c to
stefano
parents:
4273
diff
changeset
|
750 * protocols. If you do not call this function, then you can select |
fcc542fd3214
Move documentation of av_register_all() from allformats.c to
stefano
parents:
4273
diff
changeset
|
751 * exactly which formats you want to support. |
fcc542fd3214
Move documentation of av_register_all() from allformats.c to
stefano
parents:
4273
diff
changeset
|
752 * |
fcc542fd3214
Move documentation of av_register_all() from allformats.c to
stefano
parents:
4273
diff
changeset
|
753 * @see av_register_input_format() |
fcc542fd3214
Move documentation of av_register_all() from allformats.c to
stefano
parents:
4273
diff
changeset
|
754 * @see av_register_output_format() |
4489
26982fb2d510
Replace calls/references of the deprecated register_protocol()
stefano
parents:
4488
diff
changeset
|
755 * @see av_register_protocol() |
4287
fcc542fd3214
Move documentation of av_register_all() from allformats.c to
stefano
parents:
4273
diff
changeset
|
756 */ |
0 | 757 void av_register_all(void); |
758 | |
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
759 /** codec tag <-> codec id */ |
4019
a2539db62994
Fix argument constness for the av_codec_get_id() and
stefano
parents:
4004
diff
changeset
|
760 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag); |
a2539db62994
Fix argument constness for the av_codec_get_id() and
stefano
parents:
4004
diff
changeset
|
761 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id); |
1677
2a85c82b8538
add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents:
1675
diff
changeset
|
762 |
0 | 763 /* media file input */ |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
764 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
765 /** |
3948 | 766 * Finds AVInputFormat based on the short name of the input format. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
767 */ |
0 | 768 AVInputFormat *av_find_input_format(const char *short_name); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
769 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
770 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
771 * Guesses the file format. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
772 * |
3948 | 773 * @param is_opened Whether the file is already opened; determines whether |
774 * demuxers with or without AVFMT_NOFILE are probed. | |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
775 */ |
0 | 776 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
777 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
778 /** |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
779 * Allocates all the structures needed to read an input stream. |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
780 * This does not open the needed codecs for decoding the stream[s]. |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
781 */ |
885 | 782 int av_open_input_stream(AVFormatContext **ic_ptr, |
783 ByteIOContext *pb, const char *filename, | |
293
62cec412a186
make AVFMT_NOHEADER flag dynamic - added av_open_input_stream()
bellard
parents:
274
diff
changeset
|
784 AVInputFormat *fmt, AVFormatParameters *ap); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
785 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
786 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
787 * Opens a media file as input. The codecs are not opened. Only the file |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
788 * header (if present) is read. |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
789 * |
3948 | 790 * @param ic_ptr The opened media file handle is put here. |
791 * @param filename filename to open | |
792 * @param fmt If non-NULL, force the file format to use. | |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
793 * @param buf_size optional buffer size (zero if default is OK) |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
794 * @param ap Additional parameters needed when opening the file |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
795 * (NULL if default). |
3948 | 796 * @return 0 if OK, AVERROR_xxx otherwise |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
797 */ |
885 | 798 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename, |
0 | 799 AVInputFormat *fmt, |
800 int buf_size, | |
801 AVFormatParameters *ap); | |
4405 | 802 |
803 #if LIBAVFORMAT_VERSION_MAJOR < 53 | |
804 /** | |
805 * @deprecated Use avformat_alloc_context() instead. | |
806 */ | |
807 attribute_deprecated AVFormatContext *av_alloc_format_context(void); | |
808 #endif | |
809 | |
2813
9d53cc092c55
document how to free the result of av_alloc_format_context()
michael
parents:
2812
diff
changeset
|
810 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
811 * Allocates an AVFormatContext. |
2815 | 812 * Can be freed with av_free() but do not forget to free everything you |
2813
9d53cc092c55
document how to free the result of av_alloc_format_context()
michael
parents:
2812
diff
changeset
|
813 * explicitly allocated as well! |
9d53cc092c55
document how to free the result of av_alloc_format_context()
michael
parents:
2812
diff
changeset
|
814 */ |
4405 | 815 AVFormatContext *avformat_alloc_context(void); |
0 | 816 |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
817 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
818 * Reads packets of a media file to get stream information. This |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
819 * is useful for file formats with no headers such as MPEG. This |
4576 | 820 * function also computes the real framerate in case of MPEG-2 repeat |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
821 * frame mode. |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
822 * The logical file position is not changed by this function; |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
823 * examined packets may be buffered for later processing. |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
824 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
825 * @param ic media file handle |
3948 | 826 * @return >=0 if OK, AVERROR_xxx on error |
827 * @todo Let the user decide somehow what information is needed so that | |
828 * we do not waste time getting stuff the user does not need. | |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
829 */ |
0 | 830 int av_find_stream_info(AVFormatContext *ic); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
831 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
832 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
833 * Reads a transport packet from a media file. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
834 * |
2141 | 835 * This function is obsolete and should never be used. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
836 * Use av_read_frame() instead. |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
837 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
838 * @param s media file handle |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
839 * @param pkt is filled |
3948 | 840 * @return 0 if OK, AVERROR_xxx on error |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
841 */ |
0 | 842 int av_read_packet(AVFormatContext *s, AVPacket *pkt); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
843 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
844 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
845 * Returns the next frame of a stream. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
846 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
847 * The returned packet is valid |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
848 * until the next av_read_frame() or until av_close_input_file() and |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
849 * must be freed with av_free_packet. For video, the packet contains |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
850 * exactly one frame. For audio, it contains an integer number of |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
851 * frames if each frame has a known fixed size (e.g. PCM or ADPCM |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
852 * data). If the audio frames have a variable size (e.g. MPEG audio), |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
853 * then it contains one frame. |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
854 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
855 * pkt->pts, pkt->dts and pkt->duration are always set to correct |
4576 | 856 * values in AVStream.time_base units (and guessed if the format cannot |
3948 | 857 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format |
858 * has B-frames, so it is better to rely on pkt->dts if you do not | |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
859 * decompress the payload. |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
860 * |
3948 | 861 * @return 0 if OK, < 0 on error or end of file |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
862 */ |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
863 int av_read_frame(AVFormatContext *s, AVPacket *pkt); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
864 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
865 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
866 * Seeks to the keyframe at timestamp. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
867 * 'timestamp' in 'stream_index'. |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
868 * @param stream_index If stream_index is (-1), a default |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
869 * stream is selected, and timestamp is automatically converted |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
870 * from AV_TIME_BASE units to the stream specific time_base. |
3948 | 871 * @param timestamp Timestamp in AVStream.time_base units |
872 * or, if no stream is specified, in AV_TIME_BASE units. | |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
873 * @param flags flags which select direction and seeking mode |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
874 * @return >= 0 on success |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
875 */ |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
876 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
877 int flags); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
878 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
879 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
880 * Seeks to timestamp ts. |
4413 | 881 * Seeking will be done so that the point from which all active streams |
882 * can be presented successfully will be closest to ts and within min/max_ts. | |
883 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL. | |
884 * | |
4576 | 885 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and |
4413 | 886 * are the file position (this may not be supported by all demuxers). |
4576 | 887 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames |
4413 | 888 * in the stream with stream_index (this may not be supported by all demuxers). |
4576 | 889 * Otherwise all timestamps are in units of the stream selected by stream_index |
890 * or if stream_index is -1, in AV_TIME_BASE units. | |
891 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as | |
4413 | 892 * keyframes (this may not be supported by all demuxers). |
893 * | |
4576 | 894 * @param stream_index index of the stream which is used as time base reference |
4413 | 895 * @param min_ts smallest acceptable timestamp |
896 * @param ts target timestamp | |
897 * @param max_ts largest acceptable timestamp | |
898 * @param flags flags | |
899 * @returns >=0 on success, error code otherwise | |
4414
99317da7348a
Clarify that avformat_seek_file() is not part of the stable API yet.
michael
parents:
4413
diff
changeset
|
900 * |
4576 | 901 * @NOTE This is part of the new seek API which is still under construction. |
902 * Thus do not use this yet. It may change at any time, do not expect | |
903 * ABI compatibility yet! | |
4413 | 904 */ |
905 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags); | |
906 | |
907 /** | |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
908 * Starts playing a network-based stream (e.g. RTSP stream) at the |
3948 | 909 * current position. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
910 */ |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
911 int av_read_play(AVFormatContext *s); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
912 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
913 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
914 * Pauses a network-based stream (e.g. RTSP stream). |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
915 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
916 * Use av_read_play() to resume it. |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
917 */ |
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
918 int av_read_pause(AVFormatContext *s); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
919 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
920 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
921 * Frees a AVFormatContext allocated by av_open_input_stream. |
2835 | 922 * @param s context to free |
923 */ | |
924 void av_close_input_stream(AVFormatContext *s); | |
925 | |
926 /** | |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
927 * Closes a media file (but not its codecs). |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
928 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
929 * @param s media file handle |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
930 */ |
0 | 931 void av_close_input_file(AVFormatContext *s); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
932 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
933 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
934 * Adds a new stream to a media file. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
935 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
936 * Can only be called in the read_header() function. If the flag |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
937 * AVFMTCTX_NOHEADER is in the format context, then new streams |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
938 * can be added in read_packet too. |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
939 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
940 * @param s media file handle |
3948 | 941 * @param id file-format-dependent stream ID |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
942 */ |
0 | 943 AVStream *av_new_stream(AVFormatContext *s, int id); |
2573
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
944 AVProgram *av_new_program(AVFormatContext *s, int id); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
945 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
946 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
947 * Adds a new chapter. |
3314 | 948 * This function is NOT part of the public API |
3948 | 949 * and should ONLY be used by demuxers. |
3314 | 950 * |
951 * @param s media file handle | |
3948 | 952 * @param id unique ID for this chapter |
3334
7a823a401282
Pass time_base as argument to new_chapter() as well.
michael
parents:
3333
diff
changeset
|
953 * @param start chapter start time in time_base units |
7a823a401282
Pass time_base as argument to new_chapter() as well.
michael
parents:
3333
diff
changeset
|
954 * @param end chapter end time in time_base units |
3314 | 955 * @param title chapter title |
3330
374e74567a4e
Make ff_new_chapter() return AVChapter instead of int so its consistant with
michael
parents:
3329
diff
changeset
|
956 * |
3948 | 957 * @return AVChapter or NULL on error |
3314 | 958 */ |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
959 AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
960 int64_t start, int64_t end, const char *title); |
3314 | 961 |
962 /** | |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
963 * Sets the pts for a given stream. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
964 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
965 * @param s stream |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
966 * @param pts_wrap_bits number of bits effectively used by the pts |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
967 * (used for wrap control, 33 is the value for MPEG) |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
968 * @param pts_num numerator to convert to seconds (MPEG: 1) |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
969 * @param pts_den denominator to convert to seconds (MPEG: 90000) |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
970 */ |
462
b69898ffc92a
move time_base (pts_num/pts_den) from AVFormatContext -> AVStream
michael
parents:
437
diff
changeset
|
971 void av_set_pts_info(AVStream *s, int pts_wrap_bits, |
5082 | 972 unsigned int pts_num, unsigned int pts_den); |
0 | 973 |
555 | 974 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward |
975 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes | |
3948 | 976 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes |
5130
b26fba4bb776
actually define AVSEEK_FLAG_FRAME as described in avformat_seek_file() doc
aurel
parents:
5123
diff
changeset
|
977 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number |
555 | 978 |
346
e154eb1b7149
caching of timestamps for mpeg-ps so seeking is faster
michael
parents:
338
diff
changeset
|
979 int av_find_default_stream_index(AVFormatContext *s); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
980 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
981 /** |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
982 * Gets the index for a specific timestamp. |
3948 | 983 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond |
984 * to the timestamp which is <= the requested one, if backward | |
985 * is 0, then it will be >= | |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
986 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
987 * @return < 0 if no such timestamp could be found |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
988 */ |
597
d814669d2c13
int / int64 fix by (Wolfram Gloger <wmglo @@@ dent:med:uni-muenchen:de>)
michael
parents:
594
diff
changeset
|
989 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
990 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
991 /** |
2932
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
992 * Ensures the index uses less memory than the maximum specified in |
4576 | 993 * AVFormatContext.max_index_size by discarding entries if it grows |
2932
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
994 * too large. |
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
995 * This function is not part of the public API and should only be called |
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
996 * by demuxers. |
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
997 */ |
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
998 void ff_reduce_index(AVFormatContext *s, int stream_index); |
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
999 |
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
1000 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
1001 * Adds an index entry into a sorted list. Updates the entry if the list |
3948 | 1002 * already contains it. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1003 * |
3948 | 1004 * @param timestamp timestamp in the time base of the given stream |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1005 */ |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1006 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1007 int size, int distance, int flags); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1008 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1009 /** |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1010 * Does a binary search using av_index_search_timestamp() and |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1011 * AVCodec.read_timestamp(). |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1012 * This is not supposed to be called directly by a user application, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1013 * but by demuxers. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1014 * @param target_ts target timestamp in the time base of the given stream |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1015 * @param stream_index stream number |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1016 */ |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1017 int av_seek_frame_binary(AVFormatContext *s, int stream_index, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1018 int64_t target_ts, int flags); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1019 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1020 /** |
3948 | 1021 * Updates cur_dts of all streams based on the given timestamp and AVStream. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1022 * |
3948 | 1023 * Stream ref_st unchanged, others set cur_dts in their native time base. |
1024 * Only needed for timestamp wrapping or if (dts not set and pts!=dts). | |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1025 * @param timestamp new dts expressed in time_base of param ref_st |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1026 * @param ref_st reference stream giving time_base of param timestamp |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1027 */ |
1185
13dc486b272b
Try to find out correct start time to make seeking faster and add some
reimar
parents:
1175
diff
changeset
|
1028 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1029 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1030 /** |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1031 * Does a binary search using read_timestamp(). |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1032 * This is not supposed to be called directly by a user application, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1033 * but by demuxers. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1034 * @param target_ts target timestamp in the time base of the given stream |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1035 * @param stream_index stream number |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1036 */ |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1037 int64_t av_gen_search(AVFormatContext *s, int stream_index, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1038 int64_t target_ts, int64_t pos_min, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1039 int64_t pos_max, int64_t pos_limit, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1040 int64_t ts_min, int64_t ts_max, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1041 int flags, int64_t *ts_ret, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1042 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t )); |
346
e154eb1b7149
caching of timestamps for mpeg-ps so seeking is faster
michael
parents:
338
diff
changeset
|
1043 |
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
1044 /** media file output */ |
17
e1200dd82537
added simple still image format support to simplify image and imagepipe video formats
bellard
parents:
5
diff
changeset
|
1045 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1046 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1047 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
1048 * Allocates the stream private data and writes the stream header to an |
2164 | 1049 * output media file. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1050 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1051 * @param s media file handle |
3948 | 1052 * @return 0 if OK, AVERROR_xxx on error |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1053 */ |
0 | 1054 int av_write_header(AVFormatContext *s); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1055 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1056 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
1057 * Writes a packet to an output media file. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1058 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1059 * The packet shall contain one audio or video frame. |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1060 * The packet must be correctly interleaved according to the container |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1061 * specification, if not then av_interleaved_write_frame must be used. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1062 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1063 * @param s media file handle |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1064 * @param pkt The packet, which contains the stream_index, buf/buf_size, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1065 dts/pts, ... |
3948 | 1066 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1067 */ |
468 | 1068 int av_write_frame(AVFormatContext *s, AVPacket *pkt); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1069 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1070 /** |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1071 * Writes a packet to an output media file ensuring correct interleaving. |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1072 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1073 * The packet must contain one audio or video frame. |
4576 | 1074 * If the packets are already correctly interleaved, the application should |
2165 | 1075 * call av_write_frame() instead as it is slightly faster. It is also important |
1076 * to keep in mind that completely non-interleaved input will need huge amounts | |
1077 * of memory to interleave with this, so it is preferable to interleave at the | |
1078 * demuxer level. | |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1079 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1080 * @param s media file handle |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1081 * @param pkt The packet, which contains the stream_index, buf/buf_size, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1082 dts/pts, ... |
3948 | 1083 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1084 */ |
470 | 1085 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1086 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1087 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
1088 * Interleaves a packet per dts in an output media file. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1089 * |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1090 * Packets with pkt->destruct == av_destruct_packet will be freed inside this |
4576 | 1091 * function, so they cannot be used after it. Note that calling av_free_packet() |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1092 * on them is still safe. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1093 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1094 * @param s media file handle |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1095 * @param out the interleaved packet will be output here |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1096 * @param in the input packet |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1097 * @param flush 1 if no further packets are available as input and all |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1098 * remaining packets should be output |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1099 * @return 1 if a packet was output, 0 if no packet could be output, |
3175 | 1100 * < 0 if an error occurred |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1101 */ |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1102 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1103 AVPacket *pkt, int flush); |
468 | 1104 |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1105 /** |
5075
9a49ff4cdb6e
Remove inconsistent use of a @brief command in av_write_trailer()
stefano
parents:
5074
diff
changeset
|
1106 * Writes the stream trailer to an output media file and frees the |
9a49ff4cdb6e
Remove inconsistent use of a @brief command in av_write_trailer()
stefano
parents:
5074
diff
changeset
|
1107 * file private data. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1108 * |
3880
5245e7006f4c
Change doxygen comment: Clarify when av_write_trailer should be called.
reimar
parents:
3879
diff
changeset
|
1109 * May only be called after a successful call to av_write_header. |
5245e7006f4c
Change doxygen comment: Clarify when av_write_trailer should be called.
reimar
parents:
3879
diff
changeset
|
1110 * |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1111 * @param s media file handle |
3948 | 1112 * @return 0 if OK, AVERROR_xxx on error |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1113 */ |
0 | 1114 int av_write_trailer(AVFormatContext *s); |
1115 | |
1116 void dump_format(AVFormatContext *ic, | |
885 | 1117 int index, |
0 | 1118 const char *url, |
1119 int is_output); | |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1120 |
4147
b3d75fa26b5c
Drop the deprecated parse_image_size() and parse_frame_rate() functions
stefano
parents:
4019
diff
changeset
|
1121 #if LIBAVFORMAT_VERSION_MAJOR < 53 |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1122 /** |
3948 | 1123 * Parses width and height out of string str. |
2163
6c0176688fae
Move the video size and rate abbreviations system from libavformat to libavcodec
benoit
parents:
2148
diff
changeset
|
1124 * @deprecated Use av_parse_video_frame_size instead. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1125 */ |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1126 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1127 const char *str); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1128 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1129 /** |
4576 | 1130 * Converts framerate from a string to a fraction. |
2163
6c0176688fae
Move the video size and rate abbreviations system from libavformat to libavcodec
benoit
parents:
2148
diff
changeset
|
1131 * @deprecated Use av_parse_video_frame_rate instead. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1132 */ |
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1133 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, |
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1134 const char *arg); |
4147
b3d75fa26b5c
Drop the deprecated parse_image_size() and parse_frame_rate() functions
stefano
parents:
4019
diff
changeset
|
1135 #endif |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1136 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1137 /** |
4958 | 1138 * Parses datestr and returns a corresponding number of microseconds. |
2559
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1139 * @param datestr String representing a date or a duration. |
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1140 * - If a date the syntax is: |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1141 * @code |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1142 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]} |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1143 * @endcode |
3948 | 1144 * Time is local time unless Z is appended, in which case it is |
2559
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1145 * interpreted as UTC. |
3948 | 1146 * If the year-month-day part is not specified it takes the current |
2559
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1147 * year-month-day. |
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1148 * Returns the number of microseconds since 1st of January, 1970 up to |
4958 | 1149 * the time of the parsed date or INT64_MIN if datestr cannot be |
2559
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1150 * successfully parsed. |
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1151 * - If a duration the syntax is: |
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1152 * @code |
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1153 * [-]HH[:MM[:SS[.m...]]] |
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1154 * [-]S+[.m...] |
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1155 * @endcode |
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1156 * Returns the number of microseconds contained in a time interval |
4958 | 1157 * with the specified duration or INT64_MIN if datestr cannot be |
2788 | 1158 * successfully parsed. |
4958 | 1159 * @param duration Flag which tells how to interpret datestr, if |
1160 * not zero datestr is interpreted as a duration, otherwise as a | |
2559
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1161 * date. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1162 */ |
65 | 1163 int64_t parse_date(const char *datestr, int duration); |
0 | 1164 |
3947
a324a7aa8a5b
Move doxygen comments for av_gettime from utils.c to avformat.h.
diego
parents:
3918
diff
changeset
|
1165 /** Gets the current time in microseconds. */ |
65 | 1166 int64_t av_gettime(void); |
0 | 1167 |
3948 | 1168 /* ffm-specific for ffserver */ |
0 | 1169 #define FFM_PACKET_SIZE 4096 |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3970
diff
changeset
|
1170 int64_t ffm_read_write_index(int fd); |
4458
f734aba9452e
Change ffm_write_write_index to return int, and return if error occured.
bcoudurier
parents:
4452
diff
changeset
|
1171 int ffm_write_write_index(int fd, int64_t pos); |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3970
diff
changeset
|
1172 void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size); |
0 | 1173 |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1174 /** |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1175 * Attempts to find a specific tag in a URL. |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1176 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1177 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done. |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1178 * Return 1 if found. |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1179 */ |
0 | 1180 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info); |
1181 | |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1182 /** |
4576 | 1183 * Returns in 'buf' the path with '%d' replaced by a number. |
3948 | 1184 * |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1185 * Also handles the '%0nd' format where 'n' is the total number |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1186 * of digits and '%%'. |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1187 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1188 * @param buf destination buffer |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1189 * @param buf_size destination buffer size |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1190 * @param path numbered sequence string |
2749 | 1191 * @param number frame number |
3948 | 1192 * @return 0 if OK, -1 on format error |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1193 */ |
1291
185190bdc185
Clarified API for numbered sequences, patch by Michel Bardiaux % mbardiaux A mediaxim P be %
gpoirier
parents:
1289
diff
changeset
|
1194 int av_get_frame_filename(char *buf, int buf_size, |
185190bdc185
Clarified API for numbered sequences, patch by Michel Bardiaux % mbardiaux A mediaxim P be %
gpoirier
parents:
1289
diff
changeset
|
1195 const char *path, int number); |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1196 |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1197 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
1198 * Checks whether filename actually is a numbered sequence generator. |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1199 * |
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1200 * @param filename possible numbered sequence string |
3948 | 1201 * @return 1 if a valid numbered sequence string, 0 otherwise |
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1202 */ |
1291
185190bdc185
Clarified API for numbered sequences, patch by Michel Bardiaux % mbardiaux A mediaxim P be %
gpoirier
parents:
1289
diff
changeset
|
1203 int av_filename_number_test(const char *filename); |
0 | 1204 |
2284 | 1205 /** |
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
1206 * Generates an SDP for an RTP session. |
2284 | 1207 * |
1208 * @param ac array of AVFormatContexts describing the RTP streams. If the | |
1209 * array is composed by only one context, such context can contain | |
1210 * multiple AVStreams (one AVStream per RTP stream). Otherwise, | |
1211 * all the contexts in the array (an AVCodecContext per RTP stream) | |
3948 | 1212 * must contain only one AVStream. |
2317
2adc9f64ecfb
Change avf_sdp_create() to get a pre-allocated buffer as input, and to
lucabe
parents:
2300
diff
changeset
|
1213 * @param n_files number of AVCodecContexts contained in ac |
2adc9f64ecfb
Change avf_sdp_create() to get a pre-allocated buffer as input, and to
lucabe
parents:
2300
diff
changeset
|
1214 * @param buff buffer where the SDP will be stored (must be allocated by |
3948 | 1215 * the caller) |
2317
2adc9f64ecfb
Change avf_sdp_create() to get a pre-allocated buffer as input, and to
lucabe
parents:
2300
diff
changeset
|
1216 * @param size the size of the buffer |
3948 | 1217 * @return 0 if OK, AVERROR_xxx on error |
2284 | 1218 */ |
2317
2adc9f64ecfb
Change avf_sdp_create() to get a pre-allocated buffer as input, and to
lucabe
parents:
2300
diff
changeset
|
1219 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size); |
2284 | 1220 |
0 | 1221 #ifdef HAVE_AV_CONFIG_H |
230
9f4f4ca9f7b5
simpler strptime - added os_support.[ch] - moved localtime_r to os_support.c
bellard
parents:
225
diff
changeset
|
1222 |
4375 | 1223 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem); |
151 | 1224 |
255 | 1225 #ifdef __GNUC__ |
151 | 1226 #define dynarray_add(tab, nb_ptr, elem)\ |
1227 do {\ | |
3970
c265c84caa81
Use __typeof__ instead of GCC-specific typeof keyword.
gpoirier
parents:
3949
diff
changeset
|
1228 __typeof__(tab) _tab = (tab);\ |
c265c84caa81
Use __typeof__ instead of GCC-specific typeof keyword.
gpoirier
parents:
3949
diff
changeset
|
1229 __typeof__(elem) _elem = (elem);\ |
151 | 1230 (void)sizeof(**_tab == _elem); /* check that types are compatible */\ |
4375 | 1231 ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\ |
151 | 1232 } while(0) |
255 | 1233 #else |
1234 #define dynarray_add(tab, nb_ptr, elem)\ | |
1235 do {\ | |
4375 | 1236 ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\ |
255 | 1237 } while(0) |
1238 #endif | |
151 | 1239 |
230
9f4f4ca9f7b5
simpler strptime - added os_support.[ch] - moved localtime_r to os_support.c
bellard
parents:
225
diff
changeset
|
1240 time_t mktimegm(struct tm *tm); |
515
ad72189eec07
* replacing calls to not-always-available gmtime_r with our own code.
romansh
parents:
511
diff
changeset
|
1241 struct tm *brktimegm(time_t secs, struct tm *tm); |
885 | 1242 const char *small_strptime(const char *p, const char *fmt, |
230
9f4f4ca9f7b5
simpler strptime - added os_support.[ch] - moved localtime_r to os_support.c
bellard
parents:
225
diff
changeset
|
1243 struct tm *dt); |
9f4f4ca9f7b5
simpler strptime - added os_support.[ch] - moved localtime_r to os_support.c
bellard
parents:
225
diff
changeset
|
1244 |
0 | 1245 struct in_addr; |
1246 int resolve_host(struct in_addr *sin_addr, const char *hostname); | |
1247 | |
1248 void url_split(char *proto, int proto_size, | |
511
056991ab9f10
HTTP Authentication Patch by (Petr Doubek <doubek at vision dot ee dot ethz dot ch>)
michael
parents:
497
diff
changeset
|
1249 char *authorization, int authorization_size, |
0 | 1250 char *hostname, int hostname_size, |
1251 int *port_ptr, | |
1252 char *path, int path_size, | |
1253 const char *url); | |
1254 | |
4969 | 1255 /** |
1256 * Returns a positive value if the given filename has one of the given | |
1257 * extensions, 0 otherwise. | |
1258 * | |
1259 * @param extensions a comma-separated list of filename extensions | |
1260 */ | |
0 | 1261 int match_ext(const char *filename, const char *extensions); |
1262 | |
1263 #endif /* HAVE_AV_CONFIG_H */ | |
1264 | |
3852 | 1265 #endif /* AVFORMAT_AVFORMAT_H */ |