NdkMediaCodec.h revision bc1713d3b85d7ce656e032da6e4b6b342f14db03 
1/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17/*
18 * This file defines an NDK API.
19 * Do not remove methods.
20 * Do not change method signatures.
21 * Do not change the value of constants.
22 * Do not change the size of any of the classes defined in here.
23 * Do not reference types that are not part of the NDK.
24 * Do not #include files that aren't part of the NDK.
25 */
26
27#ifndef _NDK_MEDIA_CODEC_H
28#define _NDK_MEDIA_CODEC_H
29
30#include <sys/cdefs.h>
31
32#include "NdkMediaCrypto.h"
33#include "NdkMediaError.h"
34#include "NdkMediaFormat.h"
35
36#ifdef __cplusplus
37extern "C" {
38#endif
39
40struct ANativeWindow;
41
42#if __ANDROID_API__ >= 21
43
44struct AMediaCodec;
45typedef struct AMediaCodec AMediaCodec;
46
47struct AMediaCodecBufferInfo {
48    int32_t offset;
49    int32_t size;
50    int64_t presentationTimeUs;
51    uint32_t flags;
52};
53typedef struct AMediaCodecBufferInfo AMediaCodecBufferInfo;
54typedef struct AMediaCodecCryptoInfo AMediaCodecCryptoInfo;
55
56enum {
57    AMEDIACODEC_BUFFER_FLAG_END_OF_STREAM = 4,
58    AMEDIACODEC_CONFIGURE_FLAG_ENCODE = 1,
59    AMEDIACODEC_INFO_OUTPUT_BUFFERS_CHANGED = -3,
60    AMEDIACODEC_INFO_OUTPUT_FORMAT_CHANGED = -2,
61    AMEDIACODEC_INFO_TRY_AGAIN_LATER = -1
62};
63
64/**
65 * Create codec by name. Use this if you know the exact codec you want to use.
66 * When configuring, you will need to specify whether to use the codec as an
67 * encoder or decoder.
68 */
69AMediaCodec* AMediaCodec_createCodecByName(const char *name);
70
71/**
72 * Create codec by mime type. Most applications will use this, specifying a
73 * mime type obtained from media extractor.
74 */
75AMediaCodec* AMediaCodec_createDecoderByType(const char *mime_type);
76
77/**
78 * Create encoder by name.
79 */
80AMediaCodec* AMediaCodec_createEncoderByType(const char *mime_type);
81
82/**
83 * delete the codec and free its resources
84 */
85media_status_t AMediaCodec_delete(AMediaCodec*);
86
87/**
88 * Configure the codec. For decoding you would typically get the format from an extractor.
89 */
90media_status_t AMediaCodec_configure(
91        AMediaCodec*,
92        const AMediaFormat* format,
93        ANativeWindow* surface,
94        AMediaCrypto *crypto,
95        uint32_t flags);
96
97/**
98 * Start the codec. A codec must be configured before it can be started, and must be started
99 * before buffers can be sent to it.
100 */
101media_status_t AMediaCodec_start(AMediaCodec*);
102
103/**
104 * Stop the codec.
105 */
106media_status_t AMediaCodec_stop(AMediaCodec*);
107
108/*
109 * Flush the codec's input and output. All indices previously returned from calls to
110 * AMediaCodec_dequeueInputBuffer and AMediaCodec_dequeueOutputBuffer become invalid.
111 */
112media_status_t AMediaCodec_flush(AMediaCodec*);
113
114/**
115 * Get an input buffer. The specified buffer index must have been previously obtained from
116 * dequeueInputBuffer, and not yet queued.
117 */
118uint8_t* AMediaCodec_getInputBuffer(AMediaCodec*, size_t idx, size_t *out_size);
119
120/**
121 * Get an output buffer. The specified buffer index must have been previously obtained from
122 * dequeueOutputBuffer, and not yet queued.
123 */
124uint8_t* AMediaCodec_getOutputBuffer(AMediaCodec*, size_t idx, size_t *out_size);
125
126/**
127 * Get the index of the next available input buffer. An app will typically use this with
128 * getInputBuffer() to get a pointer to the buffer, then copy the data to be encoded or decoded
129 * into the buffer before passing it to the codec.
130 */
131ssize_t AMediaCodec_dequeueInputBuffer(AMediaCodec*, int64_t timeoutUs);
132
133/**
134 * Send the specified buffer to the codec for processing.
135 */
136media_status_t AMediaCodec_queueInputBuffer(AMediaCodec*,
137        size_t idx, off_t offset, size_t size, uint64_t time, uint32_t flags);
138
139/**
140 * Send the specified buffer to the codec for processing.
141 */
142media_status_t AMediaCodec_queueSecureInputBuffer(AMediaCodec*,
143        size_t idx, off_t offset, AMediaCodecCryptoInfo*, uint64_t time, uint32_t flags);
144
145/**
146 * Get the index of the next available buffer of processed data.
147 */
148ssize_t AMediaCodec_dequeueOutputBuffer(AMediaCodec*, AMediaCodecBufferInfo *info,
149        int64_t timeoutUs);
150AMediaFormat* AMediaCodec_getOutputFormat(AMediaCodec*);
151
152/**
153 * If you are done with a buffer, use this call to return the buffer to
154 * the codec. If you previously specified a surface when configuring this
155 * video decoder you can optionally render the buffer.
156 */
157media_status_t AMediaCodec_releaseOutputBuffer(AMediaCodec*, size_t idx, bool render);
158
159/**
160 * Dynamically sets the output surface of a codec.
161 *
162 *  This can only be used if the codec was configured with an output surface.  The
163 *  new output surface should have a compatible usage type to the original output surface.
164 *  E.g. codecs may not support switching from a SurfaceTexture (GPU readable) output
165 *  to ImageReader (software readable) output.
166 *
167 * For more details, see the Java documentation for MediaCodec.setOutputSurface.
168 */
169media_status_t AMediaCodec_setOutputSurface(AMediaCodec*, ANativeWindow* surface);
170
171/**
172 * If you are done with a buffer, use this call to update its surface timestamp
173 * and return it to the codec to render it on the output surface. If you
174 * have not specified an output surface when configuring this video codec,
175 * this call will simply return the buffer to the codec.
176 *
177 * For more details, see the Java documentation for MediaCodec.releaseOutputBuffer.
178 */
179media_status_t AMediaCodec_releaseOutputBufferAtTime(
180        AMediaCodec *mData, size_t idx, int64_t timestampNs);
181
182typedef enum {
183    AMEDIACODECRYPTOINFO_MODE_CLEAR = 0,
184    AMEDIACODECRYPTOINFO_MODE_AES_CTR = 1,
185    AMEDIACODECRYPTOINFO_MODE_AES_WV = 2,
186    AMEDIACODECRYPTOINFO_MODE_AES_CBC = 3
187} cryptoinfo_mode_t;
188
189typedef struct {
190    int32_t encryptBlocks;
191    int32_t skipBlocks;
192} cryptoinfo_pattern_t;
193
194/**
195 * Create an AMediaCodecCryptoInfo from scratch. Use this if you need to use custom
196 * crypto info, rather than one obtained from AMediaExtractor.
197 *
198 * AMediaCodecCryptoInfo describes the structure of an (at least
199 * partially) encrypted input sample.
200 * A buffer's data is considered to be partitioned into "subsamples",
201 * each subsample starts with a (potentially empty) run of plain,
202 * unencrypted bytes followed by a (also potentially empty) run of
203 * encrypted bytes.
204 * numBytesOfClearData can be null to indicate that all data is encrypted.
205 * This information encapsulates per-sample metadata as outlined in
206 * ISO/IEC FDIS 23001-7:2011 "Common encryption in ISO base media file format files".
207 */
208AMediaCodecCryptoInfo *AMediaCodecCryptoInfo_new(
209        int numsubsamples,
210        uint8_t key[16],
211        uint8_t iv[16],
212        cryptoinfo_mode_t mode,
213        size_t *clearbytes,
214        size_t *encryptedbytes);
215
216/**
217 * delete an AMediaCodecCryptoInfo created previously with AMediaCodecCryptoInfo_new, or
218 * obtained from AMediaExtractor
219 */
220media_status_t AMediaCodecCryptoInfo_delete(AMediaCodecCryptoInfo*);
221
222/**
223 * Set the crypto pattern on an AMediaCryptoInfo object
224 */
225void AMediaCodecCryptoInfo_setPattern(
226        AMediaCodecCryptoInfo *info,
227        cryptoinfo_pattern_t *pattern);
228
229/**
230 * The number of subsamples that make up the buffer's contents.
231 */
232size_t AMediaCodecCryptoInfo_getNumSubSamples(AMediaCodecCryptoInfo*);
233
234/**
235 * A 16-byte opaque key
236 */
237media_status_t AMediaCodecCryptoInfo_getKey(AMediaCodecCryptoInfo*, uint8_t *dst);
238
239/**
240 * A 16-byte initialization vector
241 */
242media_status_t AMediaCodecCryptoInfo_getIV(AMediaCodecCryptoInfo*, uint8_t *dst);
243
244/**
245 * The type of encryption that has been applied,
246 * one of AMEDIACODECRYPTOINFO_MODE_CLEAR or AMEDIACODECRYPTOINFO_MODE_AES_CTR.
247 */
248cryptoinfo_mode_t AMediaCodecCryptoInfo_getMode(AMediaCodecCryptoInfo*);
249
250/**
251 * The number of leading unencrypted bytes in each subsample.
252 */
253media_status_t AMediaCodecCryptoInfo_getClearBytes(AMediaCodecCryptoInfo*, size_t *dst);
254
255/**
256 * The number of trailing encrypted bytes in each subsample.
257 */
258media_status_t AMediaCodecCryptoInfo_getEncryptedBytes(AMediaCodecCryptoInfo*, size_t *dst);
259
260#endif /* __ANDROID_API__ >= 21 */
261
262#ifdef __cplusplus
263} // extern "C"
264#endif
265
266#endif //_NDK_MEDIA_CODEC_H
267