Mercurial > libavformat.hg
annotate avformat.h @ 6387:4974b3d4992b libavformat
rename LAVF_API_* defines to FF_API_* to clarify that it is not public API
| author | aurel |
|---|---|
| date | Wed, 18 Aug 2010 20:34:31 +0000 |
| parents | 2d51ca7714c3 |
| children | 8ba781dd8b2b |
| 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 |
| 6341 | 25 #define LIBAVFORMAT_VERSION_MINOR 78 |
| 6380 | 26 #define LIBAVFORMAT_VERSION_MICRO 3 |
| 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 |
|
6387
4974b3d4992b
rename LAVF_API_* defines to FF_API_* to clarify that it is not public API
aurel
parents:
6384
diff
changeset
|
38 #ifndef FF_API_MAX_STREAMS |
|
4974b3d4992b
rename LAVF_API_* defines to FF_API_* to clarify that it is not public API
aurel
parents:
6384
diff
changeset
|
39 #define FF_API_MAX_STREAMS (LIBAVFORMAT_VERSION_MAJOR < 53) |
|
6383
65745776af68
add LAVF_API_MAX_STREAMS define to disable the deprecated MAX_STREAMS API
aurel
parents:
6380
diff
changeset
|
40 #endif |
|
6387
4974b3d4992b
rename LAVF_API_* defines to FF_API_* to clarify that it is not public API
aurel
parents:
6384
diff
changeset
|
41 #ifndef FF_API_OLD_METADATA |
|
4974b3d4992b
rename LAVF_API_* defines to FF_API_* to clarify that it is not public API
aurel
parents:
6384
diff
changeset
|
42 #define FF_API_OLD_METADATA (LIBAVFORMAT_VERSION_MAJOR < 53) |
|
6384
2d51ca7714c3
add LAVF_API_OLD_METADATA define to disable the deprecated metadata API
aurel
parents:
6383
diff
changeset
|
43 #endif |
|
6383
65745776af68
add LAVF_API_MAX_STREAMS define to disable the deprecated MAX_STREAMS API
aurel
parents:
6380
diff
changeset
|
44 |
| 3701 | 45 /** |
| 5506 | 46 * I return the LIBAVFORMAT_VERSION_INT constant. You got |
| 47 * a fucking problem with that, douchebag? | |
| 3701 | 48 */ |
| 49 unsigned avformat_version(void); | |
| 50 | |
|
5370
238bda5af58e
Add functions to return library license and library configuration.
diego
parents:
5287
diff
changeset
|
51 /** |
| 6199 | 52 * Return the libavformat build-time configuration. |
|
5370
238bda5af58e
Add functions to return library license and library configuration.
diego
parents:
5287
diff
changeset
|
53 */ |
|
5491
a7aeae5a367b
Prefer "*FUNC_NAME(" over "* FUNC_NAME(" for XXX_configuration() and
stefano
parents:
5489
diff
changeset
|
54 const char *avformat_configuration(void); |
|
5370
238bda5af58e
Add functions to return library license and library configuration.
diego
parents:
5287
diff
changeset
|
55 |
|
238bda5af58e
Add functions to return library license and library configuration.
diego
parents:
5287
diff
changeset
|
56 /** |
| 6199 | 57 * Return the libavformat license. |
|
5370
238bda5af58e
Add functions to return library license and library configuration.
diego
parents:
5287
diff
changeset
|
58 */ |
|
5491
a7aeae5a367b
Prefer "*FUNC_NAME(" over "* FUNC_NAME(" for XXX_configuration() and
stefano
parents:
5489
diff
changeset
|
59 const char *avformat_license(void); |
|
5370
238bda5af58e
Add functions to return library license and library configuration.
diego
parents:
5287
diff
changeset
|
60 |
|
230
9f4f4ca9f7b5
simpler strptime - added os_support.[ch] - moved localtime_r to os_support.c
bellard
parents:
225
diff
changeset
|
61 #include <time.h> |
| 314 | 62 #include <stdio.h> /* FILE */ |
| 3065 | 63 #include "libavcodec/avcodec.h" |
| 0 | 64 |
| 65 #include "avio.h" | |
| 66 | |
| 4617 | 67 struct AVFormatContext; |
| 68 | |
| 4150 | 69 |
| 70 /* | |
|
4152
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
71 * Public Metadata API. |
|
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
72 * The metadata API allows libavformat to export metadata tags to a client |
|
5712
20877abd6b08
Mention that metadata tags are (unvalidated) UTF-8.
rbultje
parents:
5702
diff
changeset
|
73 * application using a sequence of key/value pairs. Like all strings in FFmpeg, |
|
20877abd6b08
Mention that metadata tags are (unvalidated) UTF-8.
rbultje
parents:
5702
diff
changeset
|
74 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata |
|
20877abd6b08
Mention that metadata tags are (unvalidated) UTF-8.
rbultje
parents:
5702
diff
changeset
|
75 * exported by demuxers isn't checked to be valid UTF-8 in most cases. |
|
4152
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
76 * Important concepts to keep in mind: |
|
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
77 * 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
|
78 * 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
|
79 * 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
|
80 * 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
|
81 * placed in the same tag. |
|
41ba5bf14f00
Ministry of English Composition treatment for the new metadata API
melanson
parents:
4150
diff
changeset
|
82 * 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
|
83 * 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
|
84 * and actor Bob, that could have key=alice_and_bobs_childs_email_address. |
|
5618
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
85 * 3. Several modifiers can be applied to the tag name. This is done by |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
86 * appending a dash character ('-') and the modifier name in the order |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
87 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
88 * a) language -- a tag whose value is localized for a particular language |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
89 * is appended with the ISO 639-2/B 3-letter language code. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
90 * For example: Author-ger=Michael, Author-eng=Mike |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
91 * The original/default language is in the unqualified "Author" tag. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
92 * A demuxer should set a default if it sets any translated tag. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
93 * b) sorting -- a modified version of a tag that should be used for |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
94 * sorting will have '-sort' appended. E.g. artist="The Beatles", |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
95 * artist-sort="Beatles, The". |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
96 * |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
97 * 4. Tag names are normally exported exactly as stored in the container to |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
98 * allow lossless remuxing to the same format. For container-independent |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
99 * handling of metadata, av_metadata_conv() can convert it to ffmpeg generic |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
100 * format. Follows a list of generic tag names: |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
101 * |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
102 * album -- name of the set this work belongs to |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
103 * album_artist -- main creator of the set/album, if different from artist. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
104 * e.g. "Various Artists" for compilation albums. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
105 * artist -- main creator of the work |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
106 * comment -- any additional description of the file. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
107 * composer -- who composed the work, if different from artist. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
108 * copyright -- name of copyright holder. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
109 * date -- date when the work was created, preferably in ISO 8601. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
110 * disc -- number of a subset, e.g. disc in a multi-disc collection. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
111 * encoder -- name/settings of the software/hardware that produced the file. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
112 * encoded_by -- person/group who created the file. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
113 * filename -- original name of the file. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
114 * genre -- <self-evident>. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
115 * language -- main language in which the work is performed, preferably |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
116 * in ISO 639-2 format. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
117 * performer -- artist who performed the work, if different from artist. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
118 * E.g for "Also sprach Zarathustra", artist would be "Richard |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
119 * Strauss" and performer "London Philharmonic Orchestra". |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
120 * publisher -- name of the label/publisher. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
121 * title -- name of the work. |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
122 * track -- number of this work in the set, can be in form current/total. |
| 4150 | 123 */ |
| 124 | |
|
4250
2fc899894f5e
replace AV_METADATA_IGNORE_CASE flag by a new AV_METADATA_MATCH_CASE flag
aurel
parents:
4244
diff
changeset
|
125 #define AV_METADATA_MATCH_CASE 1 |
| 4150 | 126 #define AV_METADATA_IGNORE_SUFFIX 2 |
|
5445
d1b5bb2bfe92
Add flags to prevent strdup() on arguments to av_metadata_set2().
michael
parents:
5442
diff
changeset
|
127 #define AV_METADATA_DONT_STRDUP_KEY 4 |
|
d1b5bb2bfe92
Add flags to prevent strdup() on arguments to av_metadata_set2().
michael
parents:
5442
diff
changeset
|
128 #define AV_METADATA_DONT_STRDUP_VAL 8 |
|
5939
b8a234311fc1
Actually add flag (somehow got lost in my previous patchset?), fixes broken
rbultje
parents:
5938
diff
changeset
|
129 #define AV_METADATA_DONT_OVERWRITE 16 ///< Don't overwrite existing tags. |
| 4150 | 130 |
| 131 typedef struct { | |
| 132 char *key; | |
| 133 char *value; | |
|
4154
bd4d3fee45d0
rename AVMetaData to AVMetadata and meta_data to metadata
aurel
parents:
4153
diff
changeset
|
134 }AVMetadataTag; |
| 4150 | 135 |
| 4157 | 136 typedef struct AVMetadata AVMetadata; |
| 4617 | 137 typedef struct AVMetadataConv AVMetadataConv; |
| 4150 | 138 |
| 139 /** | |
| 6199 | 140 * Get a metadata element with matching key. |
|
6362
38df997e4331
Add empty newlines between function descriptions and @params, improve
stefano
parents:
6349
diff
changeset
|
141 * |
| 4576 | 142 * @param prev Set to the previous matching element to find the next. |
|
5899
d80731fed8ee
Document the behavior of av_metadata_get() if the prev parameter is
stefano
parents:
5866
diff
changeset
|
143 * If set to NULL the first matching element is returned. |
| 4576 | 144 * @param flags Allows case as well as suffix-insensitive comparisons. |
| 145 * @return Found tag or NULL, changing key or value leads to undefined behavior. | |
| 4150 | 146 */ |
|
4154
bd4d3fee45d0
rename AVMetaData to AVMetadata and meta_data to metadata
aurel
parents:
4153
diff
changeset
|
147 AVMetadataTag * |
| 4157 | 148 av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags); |
| 4150 | 149 |
|
6387
4974b3d4992b
rename LAVF_API_* defines to FF_API_* to clarify that it is not public API
aurel
parents:
6384
diff
changeset
|
150 #if FF_API_OLD_METADATA |
| 4150 | 151 /** |
|
6364
19e0c709659a
Fix reference to a wrong parameter name in the metadata API functions
stefano
parents:
6363
diff
changeset
|
152 * Set the given tag in *pm, overwriting an existing tag. |
|
6362
38df997e4331
Add empty newlines between function descriptions and @params, improve
stefano
parents:
6349
diff
changeset
|
153 * |
|
6365
c8ba3c854868
Add documentation for the pm parameter of the av_metadata_set*
stefano
parents:
6364
diff
changeset
|
154 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL |
|
c8ba3c854868
Add documentation for the pm parameter of the av_metadata_set*
stefano
parents:
6364
diff
changeset
|
155 * a metadata struct is allocated and put in *pm. |
|
6364
19e0c709659a
Fix reference to a wrong parameter name in the metadata API functions
stefano
parents:
6363
diff
changeset
|
156 * @param key tag key to add to *pm (will be av_strduped) |
|
19e0c709659a
Fix reference to a wrong parameter name in the metadata API functions
stefano
parents:
6363
diff
changeset
|
157 * @param value tag value to add to *pm (will be av_strduped) |
| 4576 | 158 * @return >= 0 on success otherwise an error code <0 |
|
5982
f74198942337
Mark av_metadata_set() as deprecated, and use av_metadata_set2()
stefano
parents:
5946
diff
changeset
|
159 * @deprecated Use av_metadata_set2() instead. |
| 4150 | 160 */ |
|
5982
f74198942337
Mark av_metadata_set() as deprecated, and use av_metadata_set2()
stefano
parents:
5946
diff
changeset
|
161 attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const char *value); |
|
5445
d1b5bb2bfe92
Add flags to prevent strdup() on arguments to av_metadata_set2().
michael
parents:
5442
diff
changeset
|
162 #endif |
|
d1b5bb2bfe92
Add flags to prevent strdup() on arguments to av_metadata_set2().
michael
parents:
5442
diff
changeset
|
163 |
|
d1b5bb2bfe92
Add flags to prevent strdup() on arguments to av_metadata_set2().
michael
parents:
5442
diff
changeset
|
164 /** |
|
6364
19e0c709659a
Fix reference to a wrong parameter name in the metadata API functions
stefano
parents:
6363
diff
changeset
|
165 * Set the given tag in *pm, overwriting an existing tag. |
|
6362
38df997e4331
Add empty newlines between function descriptions and @params, improve
stefano
parents:
6349
diff
changeset
|
166 * |
|
6365
c8ba3c854868
Add documentation for the pm parameter of the av_metadata_set*
stefano
parents:
6364
diff
changeset
|
167 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL |
|
c8ba3c854868
Add documentation for the pm parameter of the av_metadata_set*
stefano
parents:
6364
diff
changeset
|
168 * a metadata struct is allocated and put in *pm. |
|
6364
19e0c709659a
Fix reference to a wrong parameter name in the metadata API functions
stefano
parents:
6363
diff
changeset
|
169 * @param key tag key to add to *pm (will be av_strduped depending on flags) |
|
19e0c709659a
Fix reference to a wrong parameter name in the metadata API functions
stefano
parents:
6363
diff
changeset
|
170 * @param value tag value to add to *pm (will be av_strduped depending on flags). |
| 6084 | 171 * Passing a NULL value will cause an existing tag to be deleted. |
|
5445
d1b5bb2bfe92
Add flags to prevent strdup() on arguments to av_metadata_set2().
michael
parents:
5442
diff
changeset
|
172 * @return >= 0 on success otherwise an error code <0 |
|
d1b5bb2bfe92
Add flags to prevent strdup() on arguments to av_metadata_set2().
michael
parents:
5442
diff
changeset
|
173 */ |
|
d1b5bb2bfe92
Add flags to prevent strdup() on arguments to av_metadata_set2().
michael
parents:
5442
diff
changeset
|
174 int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags); |
| 4150 | 175 |
| 4161 | 176 /** |
| 6199 | 177 * Convert all the metadata sets from ctx according to the source and |
|
5618
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
178 * destination conversion tables. If one of the tables is NULL, then |
|
27fd77f20a89
Add a list of generic tags and change demuxers to follow it.
pross
parents:
5615
diff
changeset
|
179 * tags are converted to/from ffmpeg generic tag names. |
|
6362
38df997e4331
Add empty newlines between function descriptions and @params, improve
stefano
parents:
6349
diff
changeset
|
180 * |
| 4617 | 181 * @param d_conv destination tags format conversion table |
| 182 * @param s_conv source tags format conversion table | |
| 183 */ | |
| 6363 | 184 void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv, |
| 185 const AVMetadataConv *s_conv); | |
| 4617 | 186 |
| 187 /** | |
| 6199 | 188 * Free all the memory allocated for an AVMetadata struct. |
| 4161 | 189 */ |
| 190 void av_metadata_free(AVMetadata **m); | |
| 191 | |
| 4150 | 192 |
| 0 | 193 /* packet functions */ |
| 194 | |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
195 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
196 /** |
| 6199 | 197 * Allocate and read the payload of a packet and initialize its |
|
5074
19abdf659596
Use consistently the third person in doxy, as recommended by the
stefano
parents:
5071
diff
changeset
|
198 * fields with default values. |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
199 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
200 * @param pkt packet |
| 3948 | 201 * @param size desired payload size |
| 202 * @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
|
203 */ |
| 775 | 204 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
|
205 |
| 0 | 206 |
| 207 /*************************************************/ | |
| 208 /* fractional numbers for exact pts handling */ | |
| 209 | |
|
2065
64bd1b09cef2
patch so that the deprecated items show up correctly
benoit
parents:
2061
diff
changeset
|
210 /** |
| 3948 | 211 * The exact value of the fractional number is: 'val + num / den'. |
| 212 * num is assumed to be 0 <= num < den. | |
|
4444
ed1ff5b9e0d5
Cosmetics: vertical align "*" for consistency with the other doxyies.
stefano
parents:
4443
diff
changeset
|
213 */ |
| 0 | 214 typedef struct AVFrac { |
| 885 | 215 int64_t val, num, den; |
|
4156
ccc2608599a5
Revert deprecation of AVFrac structure. Attempts to replace AVFrac have turned
diego
parents:
4154
diff
changeset
|
216 } AVFrac; |
| 0 | 217 |
| 218 /*************************************************/ | |
| 219 /* input/output formats */ | |
| 220 | |
|
1677
2a85c82b8538
add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents:
1675
diff
changeset
|
221 struct AVCodecTag; |
|
2a85c82b8538
add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents:
1675
diff
changeset
|
222 |
| 6328 | 223 /** |
| 224 * This structure contains the data a format has to probe a file. | |
| 225 */ | |
| 0 | 226 typedef struct AVProbeData { |
| 64 | 227 const char *filename; |
| 5168 | 228 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */ |
| 229 int buf_size; /**< Size of buf except extra allocated bytes */ | |
| 0 | 230 } AVProbeData; |
| 231 | |
| 4576 | 232 #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
|
233 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer |
| 0 | 234 |
| 235 typedef struct AVFormatParameters { | |
| 743 | 236 AVRational time_base; |
| 0 | 237 int sample_rate; |
| 238 int channels; | |
| 239 int width; | |
| 240 int height; | |
| 241 enum PixelFormat pix_fmt; | |
| 3948 | 242 int channel; /**< Used to select DV channel. */ |
| 243 const char *standard; /**< TV standard, NTSC, PAL, SECAM */ | |
| 244 unsigned int mpeg2ts_raw:1; /**< Force raw MPEG-2 transport stream output, if possible. */ | |
| 245 unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport | |
|
3553
c3b9334f46ae
One-bit bitfields should probably be unsigned. Unfortunately, it is left
takis
parents:
3445
diff
changeset
|
246 stream packet (only meaningful if |
| 3948 | 247 mpeg2ts_raw is TRUE). */ |
| 248 unsigned int initial_pause:1; /**< Do not begin to play the stream | |
| 249 immediately (RTSP only). */ | |
|
3553
c3b9334f46ae
One-bit bitfields should probably be unsigned. Unfortunately, it is left
takis
parents:
3445
diff
changeset
|
250 unsigned int prealloced_context:1; |
|
2833
578a0c783eae
Remove *_codec_id from AVFormatParameters with the next major version bump.
michael
parents:
2832
diff
changeset
|
251 #if LIBAVFORMAT_VERSION_INT < (53<<16) |
| 583 | 252 enum CodecID video_codec_id; |
| 253 enum CodecID audio_codec_id; | |
|
2833
578a0c783eae
Remove *_codec_id from AVFormatParameters with the next major version bump.
michael
parents:
2832
diff
changeset
|
254 #endif |
| 0 | 255 } AVFormatParameters; |
| 256 | |
| 3948 | 257 //! Demuxer will use url_fopen, no opened file should be provided by the caller. |
| 1675 | 258 #define AVFMT_NOFILE 0x0001 |
| 3948 | 259 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */ |
| 260 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */ | |
| 261 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for | |
| 262 raw picture data. */ | |
| 263 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */ | |
| 264 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */ | |
| 265 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */ | |
| 266 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. */ | |
|
4567
963e3b76c7a6
Add AVFMT_VARIABLE_FPS to specify which muxers do not need duplicated frames.
michael
parents:
4547
diff
changeset
|
267 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */ |
|
5653
25eca7e2cf64
Add flag so muxers not needing width/height can signal this.
michael
parents:
5643
diff
changeset
|
268 #define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */ |
| 0 | 269 |
| 270 typedef struct AVOutputFormat { | |
| 271 const char *name; | |
|
3424
7a0230981402
Make long_names in lavf/lavdev optional depending on CONFIG_SMALL.
diego
parents:
3334
diff
changeset
|
272 /** |
|
7a0230981402
Make long_names in lavf/lavdev optional depending on CONFIG_SMALL.
diego
parents:
3334
diff
changeset
|
273 * Descriptive name for the format, meant to be more human-readable |
| 4958 | 274 * 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
|
275 * to define it. |
|
7a0230981402
Make long_names in lavf/lavdev optional depending on CONFIG_SMALL.
diego
parents:
3334
diff
changeset
|
276 */ |
| 0 | 277 const char *long_name; |
| 278 const char *mime_type; | |
| 3948 | 279 const char *extensions; /**< comma-separated filename extensions */ |
| 6328 | 280 /** |
| 281 * size of private data so that it can be allocated in the wrapper | |
| 282 */ | |
| 0 | 283 int priv_data_size; |
| 284 /* output support */ | |
|
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
285 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
|
286 enum CodecID video_codec; /**< default video codec */ |
| 0 | 287 int (*write_header)(struct AVFormatContext *); |
| 468 | 288 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt); |
| 0 | 289 int (*write_trailer)(struct AVFormatContext *); |
| 6328 | 290 /** |
| 291 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER | |
| 292 */ | |
| 0 | 293 int flags; |
| 6328 | 294 /** |
| 295 * Currently only used to set pixel format if not YUV420P. | |
| 296 */ | |
|
17
e1200dd82537
added simple still image format support to simplify image and imagepipe video formats
bellard
parents:
5
diff
changeset
|
297 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *); |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
298 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, |
|
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
299 AVPacket *in, int flush); |
|
1677
2a85c82b8538
add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents:
1675
diff
changeset
|
300 |
|
2a85c82b8538
add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents:
1675
diff
changeset
|
301 /** |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
302 * List of supported codec_id-codec_tag pairs, ordered by "better |
| 4576 | 303 * 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
|
304 */ |
|
3766
f062deeedb8d
Change codec_tag type from const struct AVCodecTag ** to const struct AVCodecTag * const *
reimar
parents:
3758
diff
changeset
|
305 const struct AVCodecTag * const *codec_tag; |
|
1677
2a85c82b8538
add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents:
1675
diff
changeset
|
306 |
|
2280
69270eb6b20c
add proper support for subtitles muxing/stream copying
aurel
parents:
2241
diff
changeset
|
307 enum CodecID subtitle_codec; /**< default subtitle codec */ |
|
69270eb6b20c
add proper support for subtitles muxing/stream copying
aurel
parents:
2241
diff
changeset
|
308 |
|
4618
5b9eddbee9c4
Add some basic metadata conversion tables for matroska and asf.
aurel
parents:
4617
diff
changeset
|
309 const AVMetadataConv *metadata_conv; |
| 4617 | 310 |
| 0 | 311 /* private fields */ |
| 312 struct AVOutputFormat *next; | |
| 313 } AVOutputFormat; | |
| 314 | |
| 315 typedef struct AVInputFormat { | |
| 6328 | 316 /** |
| 317 * A comma separated list of short names for the format. New names | |
| 6326 | 318 * may be appended with a minor bump. |
| 319 */ | |
| 0 | 320 const char *name; |
| 6328 | 321 |
|
3424
7a0230981402
Make long_names in lavf/lavdev optional depending on CONFIG_SMALL.
diego
parents:
3334
diff
changeset
|
322 /** |
|
7a0230981402
Make long_names in lavf/lavdev optional depending on CONFIG_SMALL.
diego
parents:
3334
diff
changeset
|
323 * Descriptive name for the format, meant to be more human-readable |
| 4958 | 324 * 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
|
325 * to define it. |
|
7a0230981402
Make long_names in lavf/lavdev optional depending on CONFIG_SMALL.
diego
parents:
3334
diff
changeset
|
326 */ |
| 0 | 327 const char *long_name; |
| 6328 | 328 |
| 329 /** | |
| 330 * Size of private data so that it can be allocated in the wrapper. | |
| 331 */ | |
| 0 | 332 int priv_data_size; |
| 6328 | 333 |
|
2367
43a4290a6d77
mention AVPROBE_PADDING_SIZE at the read_probe() doxy
michael
parents:
2317
diff
changeset
|
334 /** |
| 4576 | 335 * Tell if a given file has a chance of being parsed as this format. |
| 2815 | 336 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes |
| 337 * big so you do not have to check for that unless you need more. | |
|
2367
43a4290a6d77
mention AVPROBE_PADDING_SIZE at the read_probe() doxy
michael
parents:
2317
diff
changeset
|
338 */ |
| 0 | 339 int (*read_probe)(AVProbeData *); |
| 6328 | 340 |
| 341 /** | |
| 342 * Read the format header and initialize the AVFormatContext | |
| 343 * structure. Return 0 if OK. 'ap' if non-NULL contains | |
| 344 * additional parameters. Only used in raw format right | |
| 345 * now. 'av_new_stream' should be called to create new streams. | |
| 346 */ | |
| 0 | 347 int (*read_header)(struct AVFormatContext *, |
| 348 AVFormatParameters *ap); | |
| 6328 | 349 |
| 350 /** | |
| 351 * Read one packet and put it in 'pkt'. pts and flags are also | |
| 352 * set. 'av_new_stream' can be called only if the flag | |
| 353 * AVFMTCTX_NOHEADER is used. | |
| 354 * @return 0 on success, < 0 on error. | |
| 355 * When returning an error, pkt must not have been allocated | |
| 356 * or must be freed before returning | |
| 357 */ | |
| 0 | 358 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt); |
| 6328 | 359 |
| 360 /** | |
| 361 * Close the stream. The AVFormatContext and AVStreams are not | |
| 362 * freed by this function | |
| 363 */ | |
| 0 | 364 int (*read_close)(struct AVFormatContext *); |
| 4570 | 365 |
| 366 #if LIBAVFORMAT_VERSION_MAJOR < 53 | |
| 885 | 367 /** |
| 3948 | 368 * Seek to a given timestamp relative to the frames in |
| 369 * stream component stream_index. | |
| 4576 | 370 * @param stream_index Must not be -1. |
| 371 * @param flags Selects which direction should be preferred if no exact | |
| 372 * match is available. | |
|
2203
a81bd08b5ff2
* clarifying the AVInputFormat::read_seek return value
romansh
parents:
2190
diff
changeset
|
373 * @return >= 0 on success (but not necessarily the new offset) |
| 555 | 374 */ |
| 885 | 375 int (*read_seek)(struct AVFormatContext *, |
| 555 | 376 int stream_index, int64_t timestamp, int flags); |
| 4570 | 377 #endif |
|
437
50bae308f71e
moving nearly identical binary search code from nut/mpeg/asf to utils.c
michael
parents:
420
diff
changeset
|
378 /** |
| 3948 | 379 * Gets the next timestamp in stream[stream_index].time_base units. |
| 3175 | 380 * @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
|
381 */ |
|
50bae308f71e
moving nearly identical binary search code from nut/mpeg/asf to utils.c
michael
parents:
420
diff
changeset
|
382 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
|
383 int64_t *pos, int64_t pos_limit); |
| 6328 | 384 |
| 385 /** | |
| 386 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER. | |
| 387 */ | |
| 0 | 388 int flags; |
| 6328 | 389 |
| 390 /** | |
| 391 * If extensions are defined, then no probe is done. You should | |
| 392 * usually not use extension format guessing because it is not | |
| 393 * reliable enough | |
| 394 */ | |
| 0 | 395 const char *extensions; |
| 6328 | 396 |
| 397 /** | |
| 398 * General purpose read-only value that the format can use. | |
| 399 */ | |
| 0 | 400 int value; |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
401 |
| 6328 | 402 /** |
| 403 * Start/resume playing - only meaningful if using a network-based format | |
| 404 * (RTSP). | |
| 405 */ | |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
406 int (*read_play)(struct AVFormatContext *); |
|
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
407 |
| 6328 | 408 /** |
| 409 * Pause playing - only meaningful if using a network-based format | |
| 410 * (RTSP). | |
| 411 */ | |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
412 int (*read_pause)(struct AVFormatContext *); |
|
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
413 |
|
3766
f062deeedb8d
Change codec_tag type from const struct AVCodecTag ** to const struct AVCodecTag * const *
reimar
parents:
3758
diff
changeset
|
414 const struct AVCodecTag * const *codec_tag; |
|
1677
2a85c82b8538
add codec_id <-> codec_tag tables to AVIn/OutputFormat
michael
parents:
1675
diff
changeset
|
415 |
| 4570 | 416 /** |
| 6199 | 417 * Seek to timestamp ts. |
| 4570 | 418 * Seeking will be done so that the point from which all active streams |
| 419 * can be presented successfully will be closest to ts and within min/max_ts. | |
| 420 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL. | |
| 421 */ | |
| 4575 | 422 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags); |
| 4570 | 423 |
|
4618
5b9eddbee9c4
Add some basic metadata conversion tables for matroska and asf.
aurel
parents:
4617
diff
changeset
|
424 const AVMetadataConv *metadata_conv; |
| 4617 | 425 |
| 0 | 426 /* private fields */ |
| 427 struct AVInputFormat *next; | |
| 428 } AVInputFormat; | |
| 429 | |
| 2023 | 430 enum AVStreamParseType { |
| 431 AVSTREAM_PARSE_NONE, | |
| 432 AVSTREAM_PARSE_FULL, /**< full parsing and repack */ | |
| 3948 | 433 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */ |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
434 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */ |
|
6059
65b0ea69d9af
Add an AVSTREAM_PARSE_FULL_ONCE parsing mode to parse headers and combine packets once and only once.
alexc
parents:
6053
diff
changeset
|
435 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */ |
| 2023 | 436 }; |
| 437 | |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
438 typedef struct AVIndexEntry { |
|
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
439 int64_t pos; |
|
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
440 int64_t timestamp; |
|
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
441 #define AVINDEX_KEYFRAME 0x0001 |
| 979 | 442 int flags:2; |
| 3948 | 443 int size:30; //Yeah, trying to keep the size of this small to reduce memory requirements (it is 24 vs. 32 bytes due to possible 8-byte alignment). |
| 444 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */ | |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
445 } AVIndexEntry; |
|
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
446 |
|
3120
ea5623a8efde
Add 'disposition' bitfield to AVStream and use it for both muxing and demuxing
eugeni
parents:
3087
diff
changeset
|
447 #define AV_DISPOSITION_DEFAULT 0x0001 |
|
ea5623a8efde
Add 'disposition' bitfield to AVStream and use it for both muxing and demuxing
eugeni
parents:
3087
diff
changeset
|
448 #define AV_DISPOSITION_DUB 0x0002 |
|
ea5623a8efde
Add 'disposition' bitfield to AVStream and use it for both muxing and demuxing
eugeni
parents:
3087
diff
changeset
|
449 #define AV_DISPOSITION_ORIGINAL 0x0004 |
|
ea5623a8efde
Add 'disposition' bitfield to AVStream and use it for both muxing and demuxing
eugeni
parents:
3087
diff
changeset
|
450 #define AV_DISPOSITION_COMMENT 0x0008 |
|
ea5623a8efde
Add 'disposition' bitfield to AVStream and use it for both muxing and demuxing
eugeni
parents:
3087
diff
changeset
|
451 #define AV_DISPOSITION_LYRICS 0x0010 |
|
ea5623a8efde
Add 'disposition' bitfield to AVStream and use it for both muxing and demuxing
eugeni
parents:
3087
diff
changeset
|
452 #define AV_DISPOSITION_KARAOKE 0x0020 |
| 6328 | 453 |
| 454 /** | |
| 455 * Track should be used during playback by default. | |
| 456 * Useful for subtitle track that should be displayed | |
| 457 * even when user did not explicitly ask for subtitles. | |
| 458 */ | |
|
6222
0bc4c96a5aea
add AV_DISPOSITION_FORCED flag and use it in matroska demuxer
aurel
parents:
6218
diff
changeset
|
459 #define AV_DISPOSITION_FORCED 0x0040 |
|
3120
ea5623a8efde
Add 'disposition' bitfield to AVStream and use it for both muxing and demuxing
eugeni
parents:
3087
diff
changeset
|
460 |
|
2846
625c2c60f585
Document a few more structure change rules with relation to ABI/API.
michael
parents:
2844
diff
changeset
|
461 /** |
|
625c2c60f585
Document a few more structure change rules with relation to ABI/API.
michael
parents:
2844
diff
changeset
|
462 * Stream structure. |
|
625c2c60f585
Document a few more structure change rules with relation to ABI/API.
michael
parents:
2844
diff
changeset
|
463 * New fields can be added to the end with minor version bumps. |
| 2851 | 464 * 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
|
465 * version bump. |
| 2851 | 466 * 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
|
467 */ |
| 0 | 468 typedef struct AVStream { |
|
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
469 int index; /**< stream index in AVFormatContext */ |
| 3948 | 470 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
|
471 AVCodecContext *codec; /**< codec context */ |
| 793 | 472 /** |
| 4576 | 473 * Real base framerate of the stream. |
| 474 * This is the lowest framerate with which all timestamps can be | |
| 2141 | 475 * represented accurately (it is the least common multiple of all |
| 4576 | 476 * framerates in the stream). Note, this value is just a guess! |
| 477 * For example, if the time base is 1/90000 and all frames have either | |
| 3948 | 478 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1. |
| 793 | 479 */ |
| 480 AVRational r_frame_rate; | |
| 0 | 481 void *priv_data; |
|
2300
9c8cfadff191
correct initial timestamps which have AV_NOPTS_VALUE
michael
parents:
2284
diff
changeset
|
482 |
| 0 | 483 /* internal data used in av_find_stream_info() */ |
|
2300
9c8cfadff191
correct initial timestamps which have AV_NOPTS_VALUE
michael
parents:
2284
diff
changeset
|
484 int64_t first_dts; |
| 6328 | 485 |
| 486 /** | |
| 487 * encoding: pts generation when outputting stream | |
| 488 */ | |
| 2241 | 489 struct AVFrac pts; |
|
844
35e372e6a6c3
time_base description by Rich Felker | dalias, aerifal cx
michael
parents:
842
diff
changeset
|
490 |
|
35e372e6a6c3
time_base description by Rich Felker | dalias, aerifal cx
michael
parents:
842
diff
changeset
|
491 /** |
| 2851 | 492 * This is the fundamental unit of time (in seconds) in terms |
| 493 * of which frame timestamps are represented. For fixed-fps content, | |
| 4576 | 494 * 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
|
495 */ |
|
462
b69898ffc92a
move time_base (pts_num/pts_den) from AVFormatContext -> AVStream
michael
parents:
437
diff
changeset
|
496 AVRational time_base; |
|
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
497 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */ |
| 0 | 498 /* ffmpeg.c private use */ |
| 3948 | 499 int stream_copy; /**< If set, just copy stream. */ |
| 500 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed. | |
| 6328 | 501 |
| 650 | 502 //FIXME move stuff to a flags field? |
| 6328 | 503 /** |
| 504 * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame. | |
| 505 * MN: dunno if that is the right place for it | |
| 506 */ | |
| 885 | 507 float quality; |
| 6328 | 508 |
|
2386
2beaa59babad
elaborate a little on AVStream.start_time, it seems the comment is not clear
michael
parents:
2374
diff
changeset
|
509 /** |
| 2851 | 510 * Decoding: pts of the first frame of the stream, in stream time base. |
| 511 * Only set this if you are absolutely 100% sure that the value you set | |
| 512 * it to really is the pts of the first frame. | |
|
2396
28f19eb568a2
mention that start_time maybe AV_NOPTS_VALUE (from patch by neilb suse de)
michael
parents:
2386
diff
changeset
|
513 * This may be undefined (AV_NOPTS_VALUE). |
| 2851 | 514 * @note The ASF header does NOT contain a correct start_time the ASF |
| 515 * 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
|
516 */ |
| 885 | 517 int64_t start_time; |
| 6328 | 518 |
|
2397
e5086ec7a4d4
more verbose doxy for duration (from patch by neilb suse de)
michael
parents:
2396
diff
changeset
|
519 /** |
| 2851 | 520 * 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
|
521 * If a source file does not specify a duration, but does specify |
| 3948 | 522 * 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
|
523 */ |
|
186
2265d21a04c8
added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents:
184
diff
changeset
|
524 int64_t duration; |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
525 |
|
6387
4974b3d4992b
rename LAVF_API_* defines to FF_API_* to clarify that it is not public API
aurel
parents:
6384
diff
changeset
|
526 #if FF_API_OLD_METADATA |
|
6329
614f8591566f
Fix 2 doxy comments that referred to the wrong variable.
michael
parents:
6328
diff
changeset
|
527 char language[4]; /**< ISO 639-2/B 3-letter language code (empty string if undefined) */ |
| 4626 | 528 #endif |
| 784 | 529 |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
530 /* av_read_frame() support */ |
| 2023 | 531 enum AVStreamParseType need_parsing; |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
532 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
|
533 |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
534 int64_t cur_dts; |
| 3058 | 535 int last_IP_duration; |
| 536 int64_t last_IP_pts; | |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
537 /* av_seek_frame() support */ |
| 3948 | 538 AVIndexEntry *index_entries; /**< Only used if the format does not |
| 539 support seeking natively. */ | |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
540 int nb_index_entries; |
| 1332 | 541 unsigned int index_entries_allocated_size; |
| 885 | 542 |
| 793 | 543 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
|
544 |
|
3711
a2bdb3bfeb99
increase MAX_REORDER_DELAY and pts_buffer size to 16, max for h264 atm
bcoudurier
parents:
3701
diff
changeset
|
545 #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
|
546 int64_t unused[4+1]; |
|
6384
2d51ca7714c3
add LAVF_API_OLD_METADATA define to disable the deprecated metadata API
aurel
parents:
6383
diff
changeset
|
547 #endif |
| 2973 | 548 |
|
6387
4974b3d4992b
rename LAVF_API_* defines to FF_API_* to clarify that it is not public API
aurel
parents:
6384
diff
changeset
|
549 #if FF_API_OLD_METADATA |
| 2973 | 550 char *filename; /**< source filename of the stream */ |
| 4626 | 551 #endif |
|
3120
ea5623a8efde
Add 'disposition' bitfield to AVStream and use it for both muxing and demuxing
eugeni
parents:
3087
diff
changeset
|
552 |
| 3948 | 553 int disposition; /**< AV_DISPOSITION_* bit field */ |
| 3568 | 554 |
| 555 AVProbeData probe_data; | |
|
3711
a2bdb3bfeb99
increase MAX_REORDER_DELAY and pts_buffer size to 16, max for h264 atm
bcoudurier
parents:
3701
diff
changeset
|
556 #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
|
557 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
|
558 |
|
e966560661e5
export sample_aspect_ratio read by the demuxer in a separate field
aurel
parents:
3724
diff
changeset
|
559 /** |
|
e966560661e5
export sample_aspect_ratio read by the demuxer in a separate field
aurel
parents:
3724
diff
changeset
|
560 * sample aspect ratio (0 if unknown) |
|
e966560661e5
export sample_aspect_ratio read by the demuxer in a separate field
aurel
parents:
3724
diff
changeset
|
561 * - encoding: Set by user. |
|
e966560661e5
export sample_aspect_ratio read by the demuxer in a separate field
aurel
parents:
3724
diff
changeset
|
562 * - decoding: Set by libavformat. |
|
e966560661e5
export sample_aspect_ratio read by the demuxer in a separate field
aurel
parents:
3724
diff
changeset
|
563 */ |
|
e966560661e5
export sample_aspect_ratio read by the demuxer in a separate field
aurel
parents:
3724
diff
changeset
|
564 AVRational sample_aspect_ratio; |
| 4153 | 565 |
| 4157 | 566 AVMetadata *metadata; |
|
4273
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
567 |
|
6252
deebd9ec774e
Clarify the avoidance of usage of these AVStream fields.
victor
parents:
6224
diff
changeset
|
568 /* Intended mostly for av_read_frame() support. Not supposed to be used by */ |
|
deebd9ec774e
Clarify the avoidance of usage of these AVStream fields.
victor
parents:
6224
diff
changeset
|
569 /* external applications; try to use something else if at all possible. */ |
|
4273
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
570 const uint8_t *cur_ptr; |
|
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
571 int cur_len; |
|
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
572 AVPacket cur_pkt; |
|
4569
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
573 |
|
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
574 // Timestamp generation support: |
|
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
575 /** |
|
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
576 * Timestamp corresponding to the last dts sync point. |
|
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
577 * |
|
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
578 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and |
|
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
579 * 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
|
580 * AV_NOPTS_VALUE by default. |
|
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
581 */ |
|
0000335f1eba
Add timestamp computation if values are exported by decoder.
cehoyos
parents:
4567
diff
changeset
|
582 int64_t reference_dts; |
|
4975
76263311c368
fix codec probing, stop after MAX_PROBE_PACKETS and return all packets
bcoudurier
parents:
4969
diff
changeset
|
583 |
|
76263311c368
fix codec probing, stop after MAX_PROBE_PACKETS and return all packets
bcoudurier
parents:
4969
diff
changeset
|
584 /** |
|
76263311c368
fix codec probing, stop after MAX_PROBE_PACKETS and return all packets
bcoudurier
parents:
4969
diff
changeset
|
585 * 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
|
586 * NOT PART OF PUBLIC API |
|
76263311c368
fix codec probing, stop after MAX_PROBE_PACKETS and return all packets
bcoudurier
parents:
4969
diff
changeset
|
587 */ |
| 5233 | 588 #define MAX_PROBE_PACKETS 2500 |
|
4975
76263311c368
fix codec probing, stop after MAX_PROBE_PACKETS and return all packets
bcoudurier
parents:
4969
diff
changeset
|
589 int probe_packets; |
|
5200
cd884511ec8b
Make packet interleaving in the muxer not scan through the whole
michael
parents:
5168
diff
changeset
|
590 |
|
cd884511ec8b
Make packet interleaving in the muxer not scan through the whole
michael
parents:
5168
diff
changeset
|
591 /** |
|
5210
36d130853c9b
Improve amortized worst case speed of the muxers packet interleaving code
michael
parents:
5200
diff
changeset
|
592 * 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
|
593 * 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
|
594 */ |
|
5210
36d130853c9b
Improve amortized worst case speed of the muxers packet interleaving code
michael
parents:
5200
diff
changeset
|
595 struct AVPacketList *last_in_packet_buffer; |
| 5441 | 596 |
| 597 /** | |
| 598 * Average framerate | |
| 599 */ | |
| 600 AVRational avg_frame_rate; | |
|
5702
c9466f118684
Put codec_info_nb_frames back in AVStream and print its value.
michael
parents:
5695
diff
changeset
|
601 |
|
c9466f118684
Put codec_info_nb_frames back in AVStream and print its value.
michael
parents:
5695
diff
changeset
|
602 /** |
|
c9466f118684
Put codec_info_nb_frames back in AVStream and print its value.
michael
parents:
5695
diff
changeset
|
603 * Number of frames that have been demuxed during av_find_stream_info() |
|
c9466f118684
Put codec_info_nb_frames back in AVStream and print its value.
michael
parents:
5695
diff
changeset
|
604 */ |
|
c9466f118684
Put codec_info_nb_frames back in AVStream and print its value.
michael
parents:
5695
diff
changeset
|
605 int codec_info_nb_frames; |
| 0 | 606 } AVStream; |
| 607 | |
|
2573
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
608 #define AV_PROGRAM_RUNNING 1 |
|
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
609 |
|
2846
625c2c60f585
Document a few more structure change rules with relation to ABI/API.
michael
parents:
2844
diff
changeset
|
610 /** |
|
625c2c60f585
Document a few more structure change rules with relation to ABI/API.
michael
parents:
2844
diff
changeset
|
611 * New fields can be added to the end with minor version bumps. |
| 2851 | 612 * 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
|
613 * version bump. |
| 2851 | 614 * 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
|
615 */ |
|
2573
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
616 typedef struct AVProgram { |
|
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
617 int id; |
|
6387
4974b3d4992b
rename LAVF_API_* defines to FF_API_* to clarify that it is not public API
aurel
parents:
6384
diff
changeset
|
618 #if FF_API_OLD_METADATA |
| 3948 | 619 char *provider_name; ///< network name for DVB streams |
| 620 char *name; ///< service name for DVB streams | |
| 4626 | 621 #endif |
|
2573
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
622 int flags; |
|
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
623 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
|
624 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
|
625 unsigned int nb_stream_indexes; |
| 4157 | 626 AVMetadata *metadata; |
|
2573
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
627 } AVProgram; |
|
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
628 |
|
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
629 #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
|
630 (streams are added dynamically) */ |
|
62cec412a186
make AVFMT_NOHEADER flag dynamic - added av_open_input_stream()
bellard
parents:
274
diff
changeset
|
631 |
| 3314 | 632 typedef struct AVChapter { |
| 3948 | 633 int id; ///< unique ID to identify the chapter |
| 634 AVRational time_base; ///< time base in which the start/end timestamps are specified | |
| 3322 | 635 int64_t start, end; ///< chapter start/end time in time_base units |
|
6387
4974b3d4992b
rename LAVF_API_* defines to FF_API_* to clarify that it is not public API
aurel
parents:
6384
diff
changeset
|
636 #if FF_API_OLD_METADATA |
| 3321 | 637 char *title; ///< chapter title |
| 4626 | 638 #endif |
| 4157 | 639 AVMetadata *metadata; |
| 3314 | 640 } AVChapter; |
| 641 | |
|
6387
4974b3d4992b
rename LAVF_API_* defines to FF_API_* to clarify that it is not public API
aurel
parents:
6384
diff
changeset
|
642 #if FF_API_MAX_STREAMS |
| 0 | 643 #define MAX_STREAMS 20 |
|
5593
cbc342b418f4
Schedule an increase in the maximum number of streams
jai_menon
parents:
5548
diff
changeset
|
644 #endif |
| 0 | 645 |
|
2844
440267faee3c
Document structure change rules with relation to ABI/API.
michael
parents:
2836
diff
changeset
|
646 /** |
| 3948 | 647 * Format I/O context. |
|
2844
440267faee3c
Document structure change rules with relation to ABI/API.
michael
parents:
2836
diff
changeset
|
648 * New fields can be added to the end with minor version bumps. |
| 2851 | 649 * 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
|
650 * version bump. |
| 2851 | 651 * sizeof(AVFormatContext) must not be used outside libav*. |
|
2844
440267faee3c
Document structure change rules with relation to ABI/API.
michael
parents:
2836
diff
changeset
|
652 */ |
| 0 | 653 typedef struct AVFormatContext { |
|
4538
63c5b6f7d3f5
av_alloc_format_context has been renamed, update AVFormatContext av_class
benoit
parents:
4499
diff
changeset
|
654 const AVClass *av_class; /**< Set by avformat_alloc_context. */ |
| 3948 | 655 /* Can only be iformat or oformat, not both at the same time. */ |
| 0 | 656 struct AVInputFormat *iformat; |
| 657 struct AVOutputFormat *oformat; | |
| 658 void *priv_data; | |
|
2771
d52c718e83f9
Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents:
2749
diff
changeset
|
659 ByteIOContext *pb; |
| 1663 | 660 unsigned int nb_streams; |
| 0 | 661 AVStream *streams[MAX_STREAMS]; |
|
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
662 char filename[1024]; /**< input or output filename */ |
| 0 | 663 /* stream info */ |
|
420
e440fb884442
* making it possible to specify recording date and time in a stream
romansh
parents:
384
diff
changeset
|
664 int64_t timestamp; |
|
6387
4974b3d4992b
rename LAVF_API_* defines to FF_API_* to clarify that it is not public API
aurel
parents:
6384
diff
changeset
|
665 #if FF_API_OLD_METADATA |
| 0 | 666 char title[512]; |
| 667 char author[512]; | |
| 668 char copyright[512]; | |
| 669 char comment[512]; | |
| 234 | 670 char album[512]; |
|
1858
7ce72baa2ce5
Doxygenize the existing comments in avformat.h. The contents of the comments
takis
parents:
1844
diff
changeset
|
671 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
|
672 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
|
673 char genre[32]; /**< ID3 genre */ |
| 4626 | 674 #endif |
| 234 | 675 |
| 3948 | 676 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */ |
| 677 /* private data for pts handling (do not modify directly). */ | |
| 6328 | 678 /** |
| 679 * This buffer is only needed when packets were already buffered but | |
| 680 * not decoded, for example to get the codec parameters in MPEG | |
| 681 * streams. | |
| 682 */ | |
|
186
2265d21a04c8
added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents:
184
diff
changeset
|
683 struct AVPacketList *packet_buffer; |
|
2265d21a04c8
added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents:
184
diff
changeset
|
684 |
| 6328 | 685 /** |
| 686 * Decoding: position of the first frame of the component, in | |
| 687 * AV_TIME_BASE fractional seconds. NEVER set this value directly: | |
| 688 * It is deduced from the AVStream values. | |
| 689 */ | |
| 885 | 690 int64_t start_time; |
| 6328 | 691 |
| 692 /** | |
| 693 * Decoding: duration of the stream, in AV_TIME_BASE fractional | |
| 694 * seconds. Only set this value if you know none of the individual stream | |
| 695 * durations and also dont set any of them. This is deduced from the | |
| 696 * AVStream values if not set. | |
| 697 */ | |
|
186
2265d21a04c8
added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents:
184
diff
changeset
|
698 int64_t duration; |
| 6328 | 699 |
| 700 /** | |
| 701 * decoding: total file size, 0 if unknown | |
| 702 */ | |
|
186
2265d21a04c8
added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents:
184
diff
changeset
|
703 int64_t file_size; |
| 6328 | 704 |
| 705 /** | |
| 706 * Decoding: total stream bitrate in bit/s, 0 if not | |
| 707 * available. Never set it directly if the file_size and the | |
| 708 * duration are known as FFmpeg can compute it automatically. | |
| 709 */ | |
|
186
2265d21a04c8
added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
bellard
parents:
184
diff
changeset
|
710 int bit_rate; |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
711 |
|
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
712 /* av_read_frame() support */ |
|
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
713 AVStream *cur_st; |
|
4273
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
714 #if LIBAVFORMAT_VERSION_INT < (53<<16) |
|
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
715 const uint8_t *cur_ptr_deprecated; |
|
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
716 int cur_len_deprecated; |
|
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
717 AVPacket cur_pkt_deprecated; |
|
ed5196e6e112
Move av_read_frame/parser related buffer variables from AVFormatContext
michael
parents:
4257
diff
changeset
|
718 #endif |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
719 |
|
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
720 /* av_seek_frame() support */ |
|
6329
614f8591566f
Fix 2 doxy comments that referred to the wrong variable.
michael
parents:
6328
diff
changeset
|
721 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
|
722 int index_built; |
| 885 | 723 |
| 551 | 724 int mux_rate; |
|
5057
c9bbf0a253a8
Change packet_size from signed to unsigned, since it never has a negative
rbultje
parents:
4975
diff
changeset
|
725 unsigned int packet_size; |
| 566 | 726 int preload; |
| 727 int max_delay; | |
|
790
80aec794c2ed
Animated GIF looping patch by (Todd Kirby // ffmpeg.php gmail com)
michael
parents:
784
diff
changeset
|
728 |
| 885 | 729 #define AVFMT_NOOUTPUTLOOP -1 |
| 730 #define AVFMT_INFINITEOUTPUTLOOP 0 | |
| 6328 | 731 /** |
| 732 * number of times to loop output in formats that support it | |
| 733 */ | |
|
790
80aec794c2ed
Animated GIF looping patch by (Todd Kirby // ffmpeg.php gmail com)
michael
parents:
784
diff
changeset
|
734 int loop_output; |
| 885 | 735 |
|
841
ba7631ba33a7
support fixing missing pts by parsing future frames
michael
parents:
829
diff
changeset
|
736 int flags; |
| 4576 | 737 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames. |
| 3948 | 738 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index. |
| 739 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input. | |
| 5613 | 740 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS |
| 5914 | 741 #define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container |
| 742 #define AVFMT_FLAG_NOPARSE 0x0020 ///< Do not use AVParsers, you also must set AVFMT_FLAG_NOFILLIN as the fillin code works on frames and no parsing -> no frames. Also seeking to frames can not work if parsing to find frame boundaries has been disabled | |
| 6010 | 743 #define AVFMT_FLAG_RTP_HINT 0x0040 ///< Add RTP hinting to the output file |
|
1175
8b53c0f3e7ad
add loop_input to AVFormatContext, getting rid of old hack
mru
parents:
1167
diff
changeset
|
744 |
|
8b53c0f3e7ad
add loop_input to AVFormatContext, getting rid of old hack
mru
parents:
1167
diff
changeset
|
745 int loop_input; |
| 6328 | 746 |
| 747 /** | |
| 748 * decoding: size of data to probe; encoding: unused. | |
| 749 */ | |
|
1279
a12e0b434174
added option probesize; at the moment only used by mpegts.c
nicodvb
parents:
1278
diff
changeset
|
750 unsigned int probesize; |
|
1720
1a8d1f66c867
make av_find_stream_info() duration user selectable
michael
parents:
1679
diff
changeset
|
751 |
|
1a8d1f66c867
make av_find_stream_info() duration user selectable
michael
parents:
1679
diff
changeset
|
752 /** |
| 3948 | 753 * Maximum time (in AV_TIME_BASE units) during which the input should |
| 754 * be analyzed in av_find_stream_info(). | |
|
1720
1a8d1f66c867
make av_find_stream_info() duration user selectable
michael
parents:
1679
diff
changeset
|
755 */ |
|
1a8d1f66c867
make av_find_stream_info() duration user selectable
michael
parents:
1679
diff
changeset
|
756 int max_analyze_duration; |
|
1778
d8c6b719a070
add key field to AVFormatContext for de/encryption support, patch by Reimar
bcoudurier
parents:
1756
diff
changeset
|
757 |
|
d8c6b719a070
add key field to AVFormatContext for de/encryption support, patch by Reimar
bcoudurier
parents:
1756
diff
changeset
|
758 const uint8_t *key; |
|
d8c6b719a070
add key field to AVFormatContext for de/encryption support, patch by Reimar
bcoudurier
parents:
1756
diff
changeset
|
759 int keylen; |
|
2573
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
760 |
|
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
761 unsigned int nb_programs; |
|
2842354cb9a4
Added definition and utility functions to handle AVProgram(s) in AVFormatContext
nicodvb
parents:
2559
diff
changeset
|
762 AVProgram **programs; |
| 2832 | 763 |
| 764 /** | |
| 765 * Forced video codec_id. | |
| 3948 | 766 * Demuxing: Set by user. |
| 2832 | 767 */ |
| 768 enum CodecID video_codec_id; | |
| 6328 | 769 |
| 2832 | 770 /** |
| 771 * Forced audio codec_id. | |
| 3948 | 772 * Demuxing: Set by user. |
| 2832 | 773 */ |
| 774 enum CodecID audio_codec_id; | |
| 6328 | 775 |
| 2832 | 776 /** |
| 777 * Forced subtitle codec_id. | |
| 3948 | 778 * Demuxing: Set by user. |
| 2832 | 779 */ |
| 780 enum CodecID subtitle_codec_id; | |
|
2932
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
781 |
|
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
782 /** |
| 4576 | 783 * Maximum amount of memory in bytes to use for the index of each stream. |
| 784 * If the index exceeds this size, entries will be discarded as | |
|
2932
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
785 * 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
|
786 * accurate seeking (depends on demuxer). |
| 3948 | 787 * 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
|
788 * this. |
|
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
789 * muxing : unused |
|
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
790 * demuxing: set by user |
|
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
791 */ |
|
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
792 unsigned int max_index_size; |
|
3128
b5e2ce291882
Introduce max_picture_buffer variable in AVFormatContext,
ramiro
parents:
3120
diff
changeset
|
793 |
|
b5e2ce291882
Introduce max_picture_buffer variable in AVFormatContext,
ramiro
parents:
3120
diff
changeset
|
794 /** |
| 3129 | 795 * Maximum amount of memory in bytes to use for buffering frames |
| 3948 | 796 * obtained from realtime capture devices. |
|
3128
b5e2ce291882
Introduce max_picture_buffer variable in AVFormatContext,
ramiro
parents:
3120
diff
changeset
|
797 */ |
|
b5e2ce291882
Introduce max_picture_buffer variable in AVFormatContext,
ramiro
parents:
3120
diff
changeset
|
798 unsigned int max_picture_buffer; |
| 3314 | 799 |
| 3329 | 800 unsigned int nb_chapters; |
| 3314 | 801 AVChapter **chapters; |
| 3445 | 802 |
| 803 /** | |
| 3948 | 804 * Flags to enable debugging. |
| 3445 | 805 */ |
| 806 int debug; | |
| 807 #define FF_FDEBUG_TS 0x0001 | |
| 3568 | 808 |
| 809 /** | |
| 3948 | 810 * Raw packets from the demuxer, prior to parsing and decoding. |
| 3568 | 811 * This buffer is used for buffering packets until the codec can |
| 812 * be identified, as parsing cannot be done without knowing the | |
| 813 * codec. | |
| 814 */ | |
| 815 struct AVPacketList *raw_packet_buffer; | |
|
3698
b7e347127897
Maintain pointer to end of AVFormatContext.packet_buffer list
mru
parents:
3617
diff
changeset
|
816 struct AVPacketList *raw_packet_buffer_end; |
|
b7e347127897
Maintain pointer to end of AVFormatContext.packet_buffer list
mru
parents:
3617
diff
changeset
|
817 |
|
b7e347127897
Maintain pointer to end of AVFormatContext.packet_buffer list
mru
parents:
3617
diff
changeset
|
818 struct AVPacketList *packet_buffer_end; |
| 4149 | 819 |
| 4157 | 820 AVMetadata *metadata; |
|
5069
9fd4808c3916
limit raw packet buffer size used for codec probing
bcoudurier
parents:
5057
diff
changeset
|
821 |
|
9fd4808c3916
limit raw packet buffer size used for codec probing
bcoudurier
parents:
5057
diff
changeset
|
822 /** |
|
9fd4808c3916
limit raw packet buffer size used for codec probing
bcoudurier
parents:
5057
diff
changeset
|
823 * Remaining size available for raw_packet_buffer, in bytes. |
|
9fd4808c3916
limit raw packet buffer size used for codec probing
bcoudurier
parents:
5057
diff
changeset
|
824 * NOT PART OF PUBLIC API |
|
9fd4808c3916
limit raw packet buffer size used for codec probing
bcoudurier
parents:
5057
diff
changeset
|
825 */ |
| 5233 | 826 #define RAW_PACKET_BUFFER_SIZE 2500000 |
|
5069
9fd4808c3916
limit raw packet buffer size used for codec probing
bcoudurier
parents:
5057
diff
changeset
|
827 int raw_packet_buffer_remaining_size; |
|
5840
2dd1e67a5892
Add a new field AVFormatContext.start_time_realtime
mstorsjo
parents:
5837
diff
changeset
|
828 |
|
2dd1e67a5892
Add a new field AVFormatContext.start_time_realtime
mstorsjo
parents:
5837
diff
changeset
|
829 /** |
|
2dd1e67a5892
Add a new field AVFormatContext.start_time_realtime
mstorsjo
parents:
5837
diff
changeset
|
830 * Start time of the stream in real world time, in microseconds |
|
2dd1e67a5892
Add a new field AVFormatContext.start_time_realtime
mstorsjo
parents:
5837
diff
changeset
|
831 * since the unix epoch (00:00 1st January 1970). That is, pts=0 |
|
2dd1e67a5892
Add a new field AVFormatContext.start_time_realtime
mstorsjo
parents:
5837
diff
changeset
|
832 * in the stream was captured at this real world time. |
|
2dd1e67a5892
Add a new field AVFormatContext.start_time_realtime
mstorsjo
parents:
5837
diff
changeset
|
833 * - encoding: Set by user. |
|
2dd1e67a5892
Add a new field AVFormatContext.start_time_realtime
mstorsjo
parents:
5837
diff
changeset
|
834 * - decoding: Unused. |
|
2dd1e67a5892
Add a new field AVFormatContext.start_time_realtime
mstorsjo
parents:
5837
diff
changeset
|
835 */ |
|
2dd1e67a5892
Add a new field AVFormatContext.start_time_realtime
mstorsjo
parents:
5837
diff
changeset
|
836 int64_t start_time_realtime; |
| 0 | 837 } AVFormatContext; |
| 838 | |
| 839 typedef struct AVPacketList { | |
| 840 AVPacket pkt; | |
| 841 struct AVPacketList *next; | |
| 842 } AVPacketList; | |
| 843 | |
| 2812 | 844 #if LIBAVFORMAT_VERSION_INT < (53<<16) |
| 0 | 845 extern AVInputFormat *first_iformat; |
| 846 extern AVOutputFormat *first_oformat; | |
| 2812 | 847 #endif |
| 848 | |
|
4486
fde631f0bc67
Document av_iformat_next() and av_oformat_next() functions.
stefano
parents:
4473
diff
changeset
|
849 /** |
|
fde631f0bc67
Document av_iformat_next() and av_oformat_next() functions.
stefano
parents:
4473
diff
changeset
|
850 * If f is NULL, returns the first registered input format, |
| 4576 | 851 * 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
|
852 * or NULL if f is the last one. |
|
fde631f0bc67
Document av_iformat_next() and av_oformat_next() functions.
stefano
parents:
4473
diff
changeset
|
853 */ |
| 2812 | 854 AVInputFormat *av_iformat_next(AVInputFormat *f); |
|
4486
fde631f0bc67
Document av_iformat_next() and av_oformat_next() functions.
stefano
parents:
4473
diff
changeset
|
855 |
|
fde631f0bc67
Document av_iformat_next() and av_oformat_next() functions.
stefano
parents:
4473
diff
changeset
|
856 /** |
|
fde631f0bc67
Document av_iformat_next() and av_oformat_next() functions.
stefano
parents:
4473
diff
changeset
|
857 * If f is NULL, returns the first registered output format, |
| 4576 | 858 * 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
|
859 * or NULL if f is the last one. |
|
fde631f0bc67
Document av_iformat_next() and av_oformat_next() functions.
stefano
parents:
4473
diff
changeset
|
860 */ |
| 2812 | 861 AVOutputFormat *av_oformat_next(AVOutputFormat *f); |
| 0 | 862 |
| 583 | 863 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
|
864 |
| 4576 | 865 /* XXX: Use automatic init with either ELF sections or C file parser */ |
| 866 /* modules. */ | |
| 0 | 867 |
| 868 /* utils.c */ | |
| 869 void av_register_input_format(AVInputFormat *format); | |
| 870 void av_register_output_format(AVOutputFormat *format); | |
|
5482
68c900a2d203
Deprecate and mark for deletion the function guess_stream_format(),
stefano
parents:
5469
diff
changeset
|
871 #if LIBAVFORMAT_VERSION_MAJOR < 53 |
|
68c900a2d203
Deprecate and mark for deletion the function guess_stream_format(),
stefano
parents:
5469
diff
changeset
|
872 attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name, |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
873 const char *filename, |
|
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
874 const char *mime_type); |
|
5486
0794c77c3c46
Deprecate guess_format() in favor of av_guess_format().
stefano
parents:
5483
diff
changeset
|
875 |
|
0794c77c3c46
Deprecate guess_format() in favor of av_guess_format().
stefano
parents:
5483
diff
changeset
|
876 /** |
|
0794c77c3c46
Deprecate guess_format() in favor of av_guess_format().
stefano
parents:
5483
diff
changeset
|
877 * @deprecated Use av_guess_format() instead. |
|
0794c77c3c46
Deprecate guess_format() in favor of av_guess_format().
stefano
parents:
5483
diff
changeset
|
878 */ |
|
0794c77c3c46
Deprecate guess_format() in favor of av_guess_format().
stefano
parents:
5483
diff
changeset
|
879 attribute_deprecated AVOutputFormat *guess_format(const char *short_name, |
|
0794c77c3c46
Deprecate guess_format() in favor of av_guess_format().
stefano
parents:
5483
diff
changeset
|
880 const char *filename, |
|
0794c77c3c46
Deprecate guess_format() in favor of av_guess_format().
stefano
parents:
5483
diff
changeset
|
881 const char *mime_type); |
|
5482
68c900a2d203
Deprecate and mark for deletion the function guess_stream_format(),
stefano
parents:
5469
diff
changeset
|
882 #endif |
| 5483 | 883 |
| 884 /** | |
| 6199 | 885 * Return the output format in the list of registered output formats |
| 886 * which best matches the provided parameters, or return NULL if | |
| 5483 | 887 * there is no match. |
| 888 * | |
| 889 * @param short_name if non-NULL checks if short_name matches with the | |
| 890 * names of the registered formats | |
| 891 * @param filename if non-NULL checks if filename terminates with the | |
| 892 * extensions of the registered formats | |
| 893 * @param mime_type if non-NULL checks if mime_type matches with the | |
| 894 * MIME type of the registered formats | |
| 895 */ | |
|
5486
0794c77c3c46
Deprecate guess_format() in favor of av_guess_format().
stefano
parents:
5483
diff
changeset
|
896 AVOutputFormat *av_guess_format(const char *short_name, |
| 5487 | 897 const char *filename, |
| 898 const char *mime_type); | |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
899 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
900 /** |
| 6199 | 901 * Guess 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
|
902 */ |
| 885 | 903 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
|
904 const char *filename, const char *mime_type, |
|
5910
536e5527c1e0
Define AVMediaType enum, and use it instead of enum CodecType, which
stefano
parents:
5909
diff
changeset
|
905 enum AVMediaType type); |
| 0 | 906 |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
907 /** |
| 6199 | 908 * Send 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
|
909 * |
|
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
910 * @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
|
911 * @param buf buffer |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
912 * @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
|
913 * |
|
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
914 * @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
|
915 */ |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
916 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
|
917 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
918 /** |
| 6199 | 919 * Send 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
|
920 * |
|
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
921 * @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
|
922 * 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
|
923 * @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
|
924 * higher importance. |
|
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
925 * @param buf buffer |
|
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
926 * @param size buffer size |
|
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
927 * |
|
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
928 * @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
|
929 */ |
|
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
930 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
|
931 |
|
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
932 /** |
| 6199 | 933 * Send 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
|
934 * |
|
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
935 * @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
|
936 * @param pkt packet to dump |
| 3948 | 937 * @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
|
938 */ |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
939 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload); |
| 0 | 940 |
|
1908
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
941 /** |
| 6199 | 942 * Send 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
|
943 * |
|
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
944 * @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
|
945 * 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
|
946 * @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
|
947 * higher importance. |
|
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
948 * @param pkt packet to dump |
| 3948 | 949 * @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
|
950 */ |
|
174083eafc6c
Introduce two new logging functions av_hex_dump_log() and av_pkt_dump_log()
takis
parents:
1906
diff
changeset
|
951 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
|
952 |
|
4287
fcc542fd3214
Move documentation of av_register_all() from allformats.c to
stefano
parents:
4273
diff
changeset
|
953 /** |
| 6199 | 954 * Initialize libavformat and register all the muxers, demuxers and |
|
4287
fcc542fd3214
Move documentation of av_register_all() from allformats.c to
stefano
parents:
4273
diff
changeset
|
955 * 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
|
956 * exactly which formats you want to support. |
|
fcc542fd3214
Move documentation of av_register_all() from allformats.c to
stefano
parents:
4273
diff
changeset
|
957 * |
|
fcc542fd3214
Move documentation of av_register_all() from allformats.c to
stefano
parents:
4273
diff
changeset
|
958 * @see av_register_input_format() |
|
fcc542fd3214
Move documentation of av_register_all() from allformats.c to
stefano
parents:
4273
diff
changeset
|
959 * @see av_register_output_format() |
|
4489
26982fb2d510
Replace calls/references of the deprecated register_protocol()
stefano
parents:
4488
diff
changeset
|
960 * @see av_register_protocol() |
|
4287
fcc542fd3214
Move documentation of av_register_all() from allformats.c to
stefano
parents:
4273
diff
changeset
|
961 */ |
| 0 | 962 void av_register_all(void); |
| 963 | |
| 6000 | 964 /** |
| 6199 | 965 * Get the CodecID for the given codec tag tag. |
| 6000 | 966 * If no codec id is found returns CODEC_ID_NONE. |
| 967 * | |
| 968 * @param tags list of supported codec_id-codec_tag pairs, as stored | |
| 969 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag | |
| 970 */ | |
|
4019
a2539db62994
Fix argument constness for the av_codec_get_id() and
stefano
parents:
4004
diff
changeset
|
971 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag); |
| 6000 | 972 |
| 973 /** | |
| 6199 | 974 * Get the codec tag for the given codec id id. |
| 6000 | 975 * If no codec tag is found returns 0. |
| 976 * | |
| 977 * @param tags list of supported codec_id-codec_tag pairs, as stored | |
| 978 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag | |
| 979 */ | |
|
4019
a2539db62994
Fix argument constness for the av_codec_get_id() and
stefano
parents:
4004
diff
changeset
|
980 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
|
981 |
| 0 | 982 /* media file input */ |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
983 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
984 /** |
| 6199 | 985 * Find 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
|
986 */ |
| 0 | 987 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
|
988 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
989 /** |
| 6199 | 990 * Guess the file format. |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
991 * |
| 3948 | 992 * @param is_opened Whether the file is already opened; determines whether |
| 993 * 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
|
994 */ |
| 0 | 995 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
|
996 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
997 /** |
| 6199 | 998 * Guess the file format. |
| 5988 | 999 * |
| 1000 * @param is_opened Whether the file is already opened; determines whether | |
| 1001 * demuxers with or without AVFMT_NOFILE are probed. | |
|
5989
3de601aa9786
Fix off-by-one errors in description of score_max argument for
reimar
parents:
5988
diff
changeset
|
1002 * @param score_max A probe score larger that this is required to accept a |
|
3de601aa9786
Fix off-by-one errors in description of score_max argument for
reimar
parents:
5988
diff
changeset
|
1003 * detection, the variable is set to the actual detection |
|
3de601aa9786
Fix off-by-one errors in description of score_max argument for
reimar
parents:
5988
diff
changeset
|
1004 * score afterwards. |
|
3de601aa9786
Fix off-by-one errors in description of score_max argument for
reimar
parents:
5988
diff
changeset
|
1005 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended |
| 5988 | 1006 * to retry with a larger probe buffer. |
| 1007 */ | |
| 1008 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max); | |
| 1009 | |
| 1010 /** | |
| 6199 | 1011 * Allocate all the structures needed to read an input stream. |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1012 * 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
|
1013 */ |
| 885 | 1014 int av_open_input_stream(AVFormatContext **ic_ptr, |
| 1015 ByteIOContext *pb, const char *filename, | |
|
293
62cec412a186
make AVFMT_NOHEADER flag dynamic - added av_open_input_stream()
bellard
parents:
274
diff
changeset
|
1016 AVInputFormat *fmt, AVFormatParameters *ap); |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1017 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1018 /** |
| 6199 | 1019 * Open 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
|
1020 * header (if present) is read. |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1021 * |
| 3948 | 1022 * @param ic_ptr The opened media file handle is put here. |
| 1023 * @param filename filename to open | |
| 1024 * @param fmt If non-NULL, force the file format to use. | |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1025 * @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
|
1026 * @param ap Additional parameters needed when opening the file |
|
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1027 * (NULL if default). |
| 3948 | 1028 * @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
|
1029 */ |
| 885 | 1030 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename, |
| 0 | 1031 AVInputFormat *fmt, |
| 1032 int buf_size, | |
| 1033 AVFormatParameters *ap); | |
| 4405 | 1034 |
| 1035 #if LIBAVFORMAT_VERSION_MAJOR < 53 | |
| 1036 /** | |
| 1037 * @deprecated Use avformat_alloc_context() instead. | |
| 1038 */ | |
| 1039 attribute_deprecated AVFormatContext *av_alloc_format_context(void); | |
| 1040 #endif | |
| 1041 | |
|
2813
9d53cc092c55
document how to free the result of av_alloc_format_context()
michael
parents:
2812
diff
changeset
|
1042 /** |
| 6199 | 1043 * Allocate an AVFormatContext. |
| 2815 | 1044 * 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
|
1045 * explicitly allocated as well! |
|
9d53cc092c55
document how to free the result of av_alloc_format_context()
michael
parents:
2812
diff
changeset
|
1046 */ |
| 4405 | 1047 AVFormatContext *avformat_alloc_context(void); |
| 0 | 1048 |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1049 /** |
| 6199 | 1050 * Read 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
|
1051 * is useful for file formats with no headers such as MPEG. This |
| 4576 | 1052 * 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
|
1053 * frame mode. |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1054 * 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
|
1055 * 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
|
1056 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1057 * @param ic media file handle |
| 3948 | 1058 * @return >=0 if OK, AVERROR_xxx on error |
| 1059 * @todo Let the user decide somehow what information is needed so that | |
| 1060 * we do not waste time getting stuff the user does not need. | |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1061 */ |
| 0 | 1062 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
|
1063 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1064 /** |
| 6199 | 1065 * Read 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
|
1066 * |
| 2141 | 1067 * 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
|
1068 * Use av_read_frame() instead. |
|
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 * @param s media file handle |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1071 * @param pkt is filled |
| 3948 | 1072 * @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
|
1073 */ |
| 0 | 1074 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
|
1075 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1076 /** |
| 6199 | 1077 * Return 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
|
1078 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1079 * The returned packet is valid |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1080 * 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
|
1081 * 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
|
1082 * 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
|
1083 * 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
|
1084 * 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
|
1085 * then it contains one frame. |
|
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 * pkt->pts, pkt->dts and pkt->duration are always set to correct |
| 4576 | 1088 * values in AVStream.time_base units (and guessed if the format cannot |
| 3948 | 1089 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format |
| 1090 * has B-frames, so it is better to rely on pkt->dts if you do not | |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1091 * decompress the payload. |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1092 * |
| 3948 | 1093 * @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
|
1094 */ |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
1095 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
|
1096 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1097 /** |
| 6199 | 1098 * Seek to the keyframe at timestamp. |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1099 * 'timestamp' in 'stream_index'. |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1100 * @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
|
1101 * 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
|
1102 * from AV_TIME_BASE units to the stream specific time_base. |
| 3948 | 1103 * @param timestamp Timestamp in AVStream.time_base units |
| 1104 * 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
|
1105 * @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
|
1106 * @return >= 0 on success |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1107 */ |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1108 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
|
1109 int flags); |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1110 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1111 /** |
| 6199 | 1112 * Seek to timestamp ts. |
| 4413 | 1113 * Seeking will be done so that the point from which all active streams |
| 1114 * can be presented successfully will be closest to ts and within min/max_ts. | |
| 1115 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL. | |
| 1116 * | |
| 4576 | 1117 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and |
| 4413 | 1118 * are the file position (this may not be supported by all demuxers). |
| 4576 | 1119 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames |
| 4413 | 1120 * in the stream with stream_index (this may not be supported by all demuxers). |
| 4576 | 1121 * Otherwise all timestamps are in units of the stream selected by stream_index |
| 1122 * or if stream_index is -1, in AV_TIME_BASE units. | |
| 1123 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as | |
| 4413 | 1124 * keyframes (this may not be supported by all demuxers). |
| 1125 * | |
| 4576 | 1126 * @param stream_index index of the stream which is used as time base reference |
| 4413 | 1127 * @param min_ts smallest acceptable timestamp |
| 1128 * @param ts target timestamp | |
| 1129 * @param max_ts largest acceptable timestamp | |
| 1130 * @param flags flags | |
| 5909 | 1131 * @return >=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
|
1132 * |
|
6218
3f6559c501e3
Replace incorrect @NOTE Doxygen command by @note; capitalization matters.
diego
parents:
6215
diff
changeset
|
1133 * @note This is part of the new seek API which is still under construction. |
| 4576 | 1134 * Thus do not use this yet. It may change at any time, do not expect |
| 1135 * ABI compatibility yet! | |
| 4413 | 1136 */ |
| 1137 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags); | |
| 1138 | |
| 1139 /** | |
| 6199 | 1140 * Start playing a network-based stream (e.g. RTSP stream) at the |
| 3948 | 1141 * current position. |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1142 */ |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
1143 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
|
1144 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1145 /** |
| 6199 | 1146 * Pause 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
|
1147 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1148 * 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
|
1149 */ |
|
303
2833c2311b66
initial av_read_frame() and av_seek_frame() support
bellard
parents:
293
diff
changeset
|
1150 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
|
1151 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1152 /** |
| 6199 | 1153 * Free a AVFormatContext allocated by av_open_input_stream. |
| 2835 | 1154 * @param s context to free |
| 1155 */ | |
| 1156 void av_close_input_stream(AVFormatContext *s); | |
| 1157 | |
| 1158 /** | |
| 6199 | 1159 * Close 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
|
1160 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1161 * @param s media file handle |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1162 */ |
| 0 | 1163 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
|
1164 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1165 /** |
| 6199 | 1166 * Add 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
|
1167 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1168 * 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
|
1169 * 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
|
1170 * 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
|
1171 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1172 * @param s media file handle |
| 3948 | 1173 * @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
|
1174 */ |
| 0 | 1175 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
|
1176 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
|
1177 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1178 /** |
| 6199 | 1179 * Add a new chapter. |
| 3314 | 1180 * This function is NOT part of the public API |
| 3948 | 1181 * and should ONLY be used by demuxers. |
| 3314 | 1182 * |
| 1183 * @param s media file handle | |
| 3948 | 1184 * @param id unique ID for this chapter |
|
3334
7a823a401282
Pass time_base as argument to new_chapter() as well.
michael
parents:
3333
diff
changeset
|
1185 * @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
|
1186 * @param end chapter end time in time_base units |
| 3314 | 1187 * @param title chapter title |
|
3330
374e74567a4e
Make ff_new_chapter() return AVChapter instead of int so its consistant with
michael
parents:
3329
diff
changeset
|
1188 * |
| 3948 | 1189 * @return AVChapter or NULL on error |
| 3314 | 1190 */ |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1191 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
|
1192 int64_t start, int64_t end, const char *title); |
| 3314 | 1193 |
| 1194 /** | |
| 6199 | 1195 * Set 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
|
1196 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1197 * @param s stream |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1198 * @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
|
1199 * (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
|
1200 * @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
|
1201 * @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
|
1202 */ |
|
462
b69898ffc92a
move time_base (pts_num/pts_den) from AVFormatContext -> AVStream
michael
parents:
437
diff
changeset
|
1203 void av_set_pts_info(AVStream *s, int pts_wrap_bits, |
| 5082 | 1204 unsigned int pts_num, unsigned int pts_den); |
| 0 | 1205 |
| 555 | 1206 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward |
| 1207 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes | |
| 3948 | 1208 #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
|
1209 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number |
| 555 | 1210 |
|
346
e154eb1b7149
caching of timestamps for mpeg-ps so seeking is faster
michael
parents:
338
diff
changeset
|
1211 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
|
1212 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1213 /** |
| 6199 | 1214 * Get the index for a specific timestamp. |
| 3948 | 1215 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond |
| 1216 * to the timestamp which is <= the requested one, if backward | |
| 1217 * is 0, then it will be >= | |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1218 * 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
|
1219 * @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
|
1220 */ |
|
597
d814669d2c13
int / int64 fix by (Wolfram Gloger <wmglo @@@ dent:med:uni-muenchen:de>)
michael
parents:
594
diff
changeset
|
1221 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
|
1222 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1223 /** |
| 6199 | 1224 * Ensure the index uses less memory than the maximum specified in |
| 4576 | 1225 * 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
|
1226 * too large. |
|
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
1227 * 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
|
1228 * by demuxers. |
|
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
1229 */ |
|
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
1230 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
|
1231 |
|
f5de41d943e2
user specifyable maximum amount of memory to use for the index.
michael
parents:
2876
diff
changeset
|
1232 /** |
| 6199 | 1233 * Add an index entry into a sorted list. Update the entry if the list |
| 3948 | 1234 * already contains it. |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1235 * |
| 3948 | 1236 * @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
|
1237 */ |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1238 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
|
1239 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
|
1240 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1241 /** |
| 6199 | 1242 * Perform a binary search using av_index_search_timestamp() and |
| 6279 | 1243 * AVInputFormat.read_timestamp(). |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1244 * 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
|
1245 * but by demuxers. |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1246 * @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
|
1247 * @param stream_index stream number |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1248 */ |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1249 int av_seek_frame_binary(AVFormatContext *s, int stream_index, |
|
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1250 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
|
1251 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1252 /** |
| 6199 | 1253 * Update 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
|
1254 * |
| 3948 | 1255 * Stream ref_st unchanged, others set cur_dts in their native time base. |
| 1256 * Only needed for timestamp wrapping or if (dts not set and pts!=dts). | |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1257 * @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
|
1258 * @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
|
1259 */ |
|
1185
13dc486b272b
Try to find out correct start time to make seeking faster and add some
reimar
parents:
1175
diff
changeset
|
1260 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
|
1261 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1262 /** |
| 6199 | 1263 * Perform a binary search using read_timestamp(). |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1264 * 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
|
1265 * but by demuxers. |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1266 * @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
|
1267 * @param stream_index stream number |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1268 */ |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1269 int64_t av_gen_search(AVFormatContext *s, int stream_index, |
|
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1270 int64_t target_ts, int64_t pos_min, |
|
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1271 int64_t pos_max, int64_t pos_limit, |
|
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1272 int64_t ts_min, int64_t ts_max, |
|
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1273 int flags, int64_t *ts_ret, |
|
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1274 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
|
1275 |
| 6328 | 1276 /** |
| 1277 * media file output | |
| 1278 */ | |
|
17
e1200dd82537
added simple still image format support to simplify image and imagepipe video formats
bellard
parents:
5
diff
changeset
|
1279 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
|
1280 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1281 /** |
| 6182 | 1282 * Split a URL string into components. |
| 1283 * | |
| 1284 * The pointers to buffers for storing individual components may be null, | |
| 1285 * in order to ignore that component. Buffers for components not found are | |
| 1286 * set to empty strings. If the port is not found, it is set to a negative | |
| 1287 * value. | |
| 1288 * | |
| 1289 * @param proto the buffer for the protocol | |
| 1290 * @param proto_size the size of the proto buffer | |
| 1291 * @param authorization the buffer for the authorization | |
| 1292 * @param authorization_size the size of the authorization buffer | |
| 1293 * @param hostname the buffer for the host name | |
| 1294 * @param hostname_size the size of the hostname buffer | |
| 1295 * @param port_ptr a pointer to store the port number in | |
| 1296 * @param path the buffer for the path | |
| 1297 * @param path_size the size of the path buffer | |
| 1298 * @param url the URL to split | |
| 1299 */ | |
| 1300 void av_url_split(char *proto, int proto_size, | |
| 1301 char *authorization, int authorization_size, | |
| 1302 char *hostname, int hostname_size, | |
| 1303 int *port_ptr, | |
| 1304 char *path, int path_size, | |
| 1305 const char *url); | |
| 1306 | |
| 1307 /** | |
| 6199 | 1308 * Allocate the stream private data and write the stream header to an |
| 2164 | 1309 * output media file. |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1310 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1311 * @param s media file handle |
| 3948 | 1312 * @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
|
1313 */ |
| 0 | 1314 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
|
1315 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1316 /** |
| 6199 | 1317 * Write 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
|
1318 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1319 * The packet shall contain one audio or video frame. |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1320 * The packet must be correctly interleaved according to the container |
|
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1321 * 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
|
1322 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1323 * @param s media file handle |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1324 * @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
|
1325 dts/pts, ... |
| 3948 | 1326 * @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
|
1327 */ |
| 468 | 1328 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
|
1329 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1330 /** |
| 6199 | 1331 * Write a packet to an output media file ensuring correct interleaving. |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1332 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1333 * The packet must contain one audio or video frame. |
| 4576 | 1334 * If the packets are already correctly interleaved, the application should |
| 2165 | 1335 * call av_write_frame() instead as it is slightly faster. It is also important |
| 1336 * to keep in mind that completely non-interleaved input will need huge amounts | |
| 1337 * of memory to interleave with this, so it is preferable to interleave at the | |
| 1338 * demuxer level. | |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1339 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1340 * @param s media file handle |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1341 * @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
|
1342 dts/pts, ... |
| 3948 | 1343 * @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
|
1344 */ |
| 470 | 1345 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
|
1346 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1347 /** |
| 6199 | 1348 * Interleave 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
|
1349 * |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1350 * Packets with pkt->destruct == av_destruct_packet will be freed inside this |
| 4576 | 1351 * 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
|
1352 * on them is still safe. |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1353 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1354 * @param s media file handle |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1355 * @param out the interleaved packet will be output here |
|
6215
ccb05424c391
Fix misspelled parameter names in Doxygen documentation.
diego
parents:
6208
diff
changeset
|
1356 * @param pkt the input packet |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1357 * @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
|
1358 * remaining packets should be output |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1359 * @return 1 if a packet was output, 0 if no packet could be output, |
| 3175 | 1360 * < 0 if an error occurred |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1361 */ |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1362 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, |
|
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1363 AVPacket *pkt, int flush); |
| 468 | 1364 |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1365 /** |
| 6199 | 1366 * Write the stream trailer to an output media file and free the |
|
5075
9a49ff4cdb6e
Remove inconsistent use of a @brief command in av_write_trailer()
stefano
parents:
5074
diff
changeset
|
1367 * file private data. |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1368 * |
|
3880
5245e7006f4c
Change doxygen comment: Clarify when av_write_trailer should be called.
reimar
parents:
3879
diff
changeset
|
1369 * 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
|
1370 * |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1371 * @param s media file handle |
| 3948 | 1372 * @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
|
1373 */ |
| 0 | 1374 int av_write_trailer(AVFormatContext *s); |
| 1375 | |
| 1376 void dump_format(AVFormatContext *ic, | |
| 885 | 1377 int index, |
| 0 | 1378 const char *url, |
| 1379 int is_output); | |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1380 |
|
4147
b3d75fa26b5c
Drop the deprecated parse_image_size() and parse_frame_rate() functions
stefano
parents:
4019
diff
changeset
|
1381 #if LIBAVFORMAT_VERSION_MAJOR < 53 |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1382 /** |
| 6199 | 1383 * Parse 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
|
1384 * @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
|
1385 */ |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1386 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
|
1387 const char *str); |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1388 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1389 /** |
| 6199 | 1390 * Convert 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
|
1391 * @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
|
1392 */ |
|
3949
8d94741841b2
cosmetics: Break overly long lines, one grammar fix.
diego
parents:
3948
diff
changeset
|
1393 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
|
1394 const char *arg); |
|
4147
b3d75fa26b5c
Drop the deprecated parse_image_size() and parse_frame_rate() functions
stefano
parents:
4019
diff
changeset
|
1395 #endif |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1396 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1397 /** |
| 6199 | 1398 * Parse datestr and return a corresponding number of microseconds. |
|
2559
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1399 * @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
|
1400 * - 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
|
1401 * @code |
|
6166
474f78ca41d8
Mention how "now" is interpreted in the parse_date() doxy.
stefano
parents:
6165
diff
changeset
|
1402 * now|{[{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH[:MM[:SS[.m...]]]}|{HH[MM[SS[.m...]]]}}[Z|z]} |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1403 * @endcode |
|
6166
474f78ca41d8
Mention how "now" is interpreted in the parse_date() doxy.
stefano
parents:
6165
diff
changeset
|
1404 * If the value is "now" it takes the current time. |
| 3948 | 1405 * 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
|
1406 * interpreted as UTC. |
| 3948 | 1407 * 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
|
1408 * year-month-day. |
| 6199 | 1409 * @return the number of microseconds since 1st of January, 1970 up to |
| 4958 | 1410 * 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
|
1411 * successfully parsed. |
|
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1412 * - If a duration the syntax is: |
|
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1413 * @code |
|
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1414 * [-]HH[:MM[:SS[.m...]]] |
|
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1415 * [-]S+[.m...] |
|
c57d3d6c8f44
Make parse_date return INT64_MIN in case of unparsable input.
benoit
parents:
2548
diff
changeset
|
1416 * @endcode |
| 6199 | 1417 * @return the number of microseconds contained in a time interval |
| 4958 | 1418 * with the specified duration or INT64_MIN if datestr cannot be |
| 2788 | 1419 * successfully parsed. |
| 4958 | 1420 * @param duration Flag which tells how to interpret datestr, if |
| 1421 * 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
|
1422 * date. |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1423 */ |
| 65 | 1424 int64_t parse_date(const char *datestr, int duration); |
| 0 | 1425 |
| 6328 | 1426 /** |
| 1427 * Get the current time in microseconds. | |
| 1428 */ | |
| 65 | 1429 int64_t av_gettime(void); |
| 0 | 1430 |
| 3948 | 1431 /* ffm-specific for ffserver */ |
| 0 | 1432 #define FFM_PACKET_SIZE 4096 |
|
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3970
diff
changeset
|
1433 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
|
1434 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
|
1435 void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size); |
| 0 | 1436 |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1437 /** |
| 6199 | 1438 * Attempt to find a specific tag in a URL. |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1439 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1440 * 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
|
1441 * Return 1 if found. |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1442 */ |
| 0 | 1443 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info); |
| 1444 | |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1445 /** |
| 6199 | 1446 * Return in 'buf' the path with '%d' replaced by a number. |
| 3948 | 1447 * |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1448 * 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
|
1449 * of digits and '%%'. |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1450 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1451 * @param buf destination buffer |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1452 * @param buf_size destination buffer size |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1453 * @param path numbered sequence string |
| 2749 | 1454 * @param number frame number |
| 3948 | 1455 * @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
|
1456 */ |
|
1291
185190bdc185
Clarified API for numbered sequences, patch by Michel Bardiaux % mbardiaux A mediaxim P be %
gpoirier
parents:
1289
diff
changeset
|
1457 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
|
1458 const char *path, int number); |
|
1840
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1459 |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1460 /** |
| 6199 | 1461 * Check 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
|
1462 * |
|
daaa79ca14f0
Move the libavformat public API comments to avformat.h. The comments are
takis
parents:
1795
diff
changeset
|
1463 * @param filename possible numbered sequence string |
| 3948 | 1464 * @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
|
1465 */ |
|
1291
185190bdc185
Clarified API for numbered sequences, patch by Michel Bardiaux % mbardiaux A mediaxim P be %
gpoirier
parents:
1289
diff
changeset
|
1466 int av_filename_number_test(const char *filename); |
| 0 | 1467 |
| 2284 | 1468 /** |
| 6199 | 1469 * Generate an SDP for an RTP session. |
| 2284 | 1470 * |
| 1471 * @param ac array of AVFormatContexts describing the RTP streams. If the | |
| 1472 * array is composed by only one context, such context can contain | |
| 1473 * multiple AVStreams (one AVStream per RTP stream). Otherwise, | |
| 1474 * all the contexts in the array (an AVCodecContext per RTP stream) | |
| 3948 | 1475 * 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
|
1476 * @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
|
1477 * @param buff buffer where the SDP will be stored (must be allocated by |
| 3948 | 1478 * the caller) |
|
2317
2adc9f64ecfb
Change avf_sdp_create() to get a pre-allocated buffer as input, and to
lucabe
parents:
2300
diff
changeset
|
1479 * @param size the size of the buffer |
| 3948 | 1480 * @return 0 if OK, AVERROR_xxx on error |
| 2284 | 1481 */ |
|
2317
2adc9f64ecfb
Change avf_sdp_create() to get a pre-allocated buffer as input, and to
lucabe
parents:
2300
diff
changeset
|
1482 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size); |
| 2284 | 1483 |
|
5915
4cc7fc1878b4
Make av_match_ext() declaration public (move its declaration out of
stefano
parents:
5914
diff
changeset
|
1484 /** |
| 6199 | 1485 * Return a positive value if the given filename has one of the given |
|
5915
4cc7fc1878b4
Make av_match_ext() declaration public (move its declaration out of
stefano
parents:
5914
diff
changeset
|
1486 * extensions, 0 otherwise. |
|
4cc7fc1878b4
Make av_match_ext() declaration public (move its declaration out of
stefano
parents:
5914
diff
changeset
|
1487 * |
|
4cc7fc1878b4
Make av_match_ext() declaration public (move its declaration out of
stefano
parents:
5914
diff
changeset
|
1488 * @param extensions a comma-separated list of filename extensions |
|
4cc7fc1878b4
Make av_match_ext() declaration public (move its declaration out of
stefano
parents:
5914
diff
changeset
|
1489 */ |
|
4cc7fc1878b4
Make av_match_ext() declaration public (move its declaration out of
stefano
parents:
5914
diff
changeset
|
1490 int av_match_ext(const char *filename, const char *extensions); |
|
4cc7fc1878b4
Make av_match_ext() declaration public (move its declaration out of
stefano
parents:
5914
diff
changeset
|
1491 |
| 3852 | 1492 #endif /* AVFORMAT_AVFORMAT_H */ |
