annotate avformat.h @ 6473:1a62da965733 libavformat

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