1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/*
* Copyright (C) 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* This file defines an NDK API.
* Do not remove methods.
* Do not change method signatures.
* Do not change the value of constants.
* Do not change the size of any of the classes defined in here.
* Do not reference types that are not part of the NDK.
* Do not #include files that aren't part of the NDK.
*/
#ifndef _NDK_MEDIA_DATASOURCE_H
#define _NDK_MEDIA_DATASOURCE_H
#include <sys/cdefs.h>
#include <sys/types.h>
#include <media/NdkMediaError.h>
__BEGIN_DECLS
struct AMediaDataSource;
typedef struct AMediaDataSource AMediaDataSource;
/*
* AMediaDataSource's callbacks will be invoked on an implementation-defined thread
* or thread pool. No guarantees are provided about which thread(s) will be used for
* callbacks. For example, |close| can be invoked from a different thread than the
* thread invoking |readAt|. As such, the Implementations of AMediaDataSource callbacks
* must be threadsafe.
*/
/**
* Called to request data from the given |offset|.
*
* Implementations should should write up to |size| bytes into
* |buffer|, and return the number of bytes written.
*
* Return 0 if size is zero (thus no bytes are read).
*
* Return -1 to indicate that end of stream is reached.
*/
typedef ssize_t (*AMediaDataSourceReadAt)(
void *userdata, off64_t offset, void * buffer, size_t size);
/**
* Called to get the size of the data source.
*
* Return the size of data source in bytes, or -1 if the size is unknown.
*/
typedef ssize_t (*AMediaDataSourceGetSize)(void *userdata);
/**
* Called to close the data source, unblock reads, and release associated
* resources.
*
* The NDK media framework guarantees that after the first |close| is
* called, no future callbacks will be invoked on the data source except
* for |close| itself.
*
* Closing a data source allows readAt calls that were blocked waiting
* for I/O data to return promptly.
*
* When using AMediaDataSource as input to AMediaExtractor, closing
* has the effect of unblocking slow reads inside of setDataSource
* and readSampleData.
*/
typedef void (*AMediaDataSourceClose)(void *userdata);
/**
* Create new media data source. Returns NULL if memory allocation
* for the new data source object fails.
*
* Available since API level 28.
*/
AMediaDataSource* AMediaDataSource_new() __INTRODUCED_IN(28);
/**
* Called to get an estimate of the number of bytes that can be read from this data source
* starting at |offset| without blocking for I/O.
*
* Return -1 when such an estimate is not possible.
*/
typedef ssize_t (*AMediaDataSourceGetAvailableSize)(void *userdata, off64_t offset);
/**
* Create new media data source. Returns NULL if memory allocation
* for the new data source object fails.
*
* Set the |uri| from which the data source will read,
* plus additional http headers when initiating the request.
*
* Headers will contain corresponding items from |key_values|
* in the following fashion:
*
* key_values[0]:key_values[1]
* key_values[2]:key_values[3]
* ...
* key_values[(numheaders - 1) * 2]:key_values[(numheaders - 1) * 2 + 1]
*
* Available since API level 29.
*/
AMediaDataSource* AMediaDataSource_newUri(const char *uri,
int numheaders,
const char * const *key_values) __INTRODUCED_IN(29);
/**
* Delete a previously created media data source.
*
* Available since API level 28.
*/
void AMediaDataSource_delete(AMediaDataSource*) __INTRODUCED_IN(28);
/**
* Set an user provided opaque handle. This opaque handle is passed as
* the first argument to the data source callbacks.
*
* Available since API level 28.
*/
void AMediaDataSource_setUserdata(
AMediaDataSource*, void *userdata) __INTRODUCED_IN(28);
/**
* Set a custom callback for supplying random access media data to the
* NDK media framework.
*
* Implement this if your app has special requirements for the way media
* data is obtained, or if you need a callback when data is read by the
* NDK media framework.
*
* Please refer to the definition of AMediaDataSourceReadAt for
* additional details.
*
* Available since API level 28.
*/
void AMediaDataSource_setReadAt(
AMediaDataSource*,
AMediaDataSourceReadAt) __INTRODUCED_IN(28);
/**
* Set a custom callback for supplying the size of the data source to the
* NDK media framework.
*
* Please refer to the definition of AMediaDataSourceGetSize for
* additional details.
*
* Available since API level 28.
*/
void AMediaDataSource_setGetSize(
AMediaDataSource*,
AMediaDataSourceGetSize) __INTRODUCED_IN(28);
/**
* Set a custom callback to receive signal from the NDK media framework
* when the data source is closed.
*
* Please refer to the definition of AMediaDataSourceClose for
* additional details.
*
* Available since API level 28.
*/
void AMediaDataSource_setClose(
AMediaDataSource*,
AMediaDataSourceClose) __INTRODUCED_IN(28);
/**
* Close the data source, unblock reads, and release associated resources.
*
* Please refer to the definition of AMediaDataSourceClose for
* additional details.
*
* Available since API level 29.
*/
void AMediaDataSource_close(AMediaDataSource*) __INTRODUCED_IN(29);
/**
* Set a custom callback for supplying the estimated number of bytes
* that can be read from this data source starting at an offset without
* blocking for I/O.
*
* Please refer to the definition of AMediaDataSourceGetAvailableSize
* for additional details.
*
* Available since API level 29.
*/
void AMediaDataSource_setGetAvailableSize(
AMediaDataSource*,
AMediaDataSourceGetAvailableSize) __INTRODUCED_IN(29);
__END_DECLS
#endif // _NDK_MEDIA_DATASOURCE_H
|
