annotate avformat.h @ 6166:474f78ca41d8 libavformat

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