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 <android/native_window.h> 31 32 #include "NdkMediaCrypto.h" 33 #include "NdkMediaError.h" 34 #include "NdkMediaFormat.h" 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 41 struct AMediaCodec; 42 typedef struct AMediaCodec AMediaCodec; 43 44 struct AMediaCodecBufferInfo { 45 int32_t offset; 46 int32_t size; 47 int64_t presentationTimeUs; 48 uint32_t flags; 49 }; 50 typedef struct AMediaCodecBufferInfo AMediaCodecBufferInfo; 51 typedef struct AMediaCodecCryptoInfo AMediaCodecCryptoInfo; 52 53 enum { 54 AMEDIACODEC_BUFFER_FLAG_END_OF_STREAM = 4, 55 AMEDIACODEC_CONFIGURE_FLAG_ENCODE = 1, 56 AMEDIACODEC_INFO_OUTPUT_BUFFERS_CHANGED = -3, 57 AMEDIACODEC_INFO_OUTPUT_FORMAT_CHANGED = -2, 58 AMEDIACODEC_INFO_TRY_AGAIN_LATER = -1 59 }; 60 61 /** 62 * Create codec by name. Use this if you know the exact codec you want to use. 63 * When configuring, you will need to specify whether to use the codec as an 64 * encoder or decoder. 65 */ 66 AMediaCodec* AMediaCodec_createCodecByName(const char *name); 67 68 /** 69 * Create codec by mime type. Most applications will use this, specifying a 70 * mime type obtained from media extractor. 71 */ 72 AMediaCodec* AMediaCodec_createDecoderByType(const char *mime_type); 73 74 /** 75 * Create encoder by name. 76 */ 77 AMediaCodec* AMediaCodec_createEncoderByType(const char *mime_type); 78 79 /** 80 * delete the codec and free its resources 81 */ 82 media_status_t AMediaCodec_delete(AMediaCodec*); 83 84 /** 85 * Configure the codec. For decoding you would typically get the format from an extractor. 86 */ 87 media_status_t AMediaCodec_configure( 88 AMediaCodec*, 89 const AMediaFormat* format, 90 ANativeWindow* surface, 91 AMediaCrypto *crypto, 92 uint32_t flags); 93 94 /** 95 * Start the codec. A codec must be configured before it can be started, and must be started 96 * before buffers can be sent to it. 97 */ 98 media_status_t AMediaCodec_start(AMediaCodec*); 99 100 /** 101 * Stop the codec. 102 */ 103 media_status_t AMediaCodec_stop(AMediaCodec*); 104 105 /* 106 * Flush the codec's input and output. All indices previously returned from calls to 107 * AMediaCodec_dequeueInputBuffer and AMediaCodec_dequeueOutputBuffer become invalid. 108 */ 109 media_status_t AMediaCodec_flush(AMediaCodec*); 110 111 /** 112 * Get an input buffer. The specified buffer index must have been previously obtained from 113 * dequeueInputBuffer, and not yet queued. 114 */ 115 uint8_t* AMediaCodec_getInputBuffer(AMediaCodec*, size_t idx, size_t *out_size); 116 117 /** 118 * Get an output buffer. The specified buffer index must have been previously obtained from 119 * dequeueOutputBuffer, and not yet queued. 120 */ 121 uint8_t* AMediaCodec_getOutputBuffer(AMediaCodec*, size_t idx, size_t *out_size); 122 123 /** 124 * Get the index of the next available input buffer. An app will typically use this with 125 * getInputBuffer() to get a pointer to the buffer, then copy the data to be encoded or decoded 126 * into the buffer before passing it to the codec. 127 */ 128 ssize_t AMediaCodec_dequeueInputBuffer(AMediaCodec*, int64_t timeoutUs); 129 130 /** 131 * Send the specified buffer to the codec for processing. 132 */ 133 media_status_t AMediaCodec_queueInputBuffer(AMediaCodec*, 134 size_t idx, off_t offset, size_t size, uint64_t time, uint32_t flags); 135 136 /** 137 * Send the specified buffer to the codec for processing. 138 */ 139 media_status_t AMediaCodec_queueSecureInputBuffer(AMediaCodec*, 140 size_t idx, off_t offset, AMediaCodecCryptoInfo*, uint64_t time, uint32_t flags); 141 142 /** 143 * Get the index of the next available buffer of processed data. 144 */ 145 ssize_t AMediaCodec_dequeueOutputBuffer(AMediaCodec*, AMediaCodecBufferInfo *info, int64_t timeoutUs); 146 AMediaFormat* AMediaCodec_getOutputFormat(AMediaCodec*); 147 148 /** 149 * If you are done with a buffer, use this call to return the buffer to 150 * the codec. If you previously specified a surface when configuring this 151 * video decoder you can optionally render the buffer. 152 */ 153 media_status_t AMediaCodec_releaseOutputBuffer(AMediaCodec*, size_t idx, bool render); 154 155 /** 156 * If you are done with a buffer, use this call to update its surface timestamp 157 * and return it to the codec to render it on the output surface. If you 158 * have not specified an output surface when configuring this video codec, 159 * this call will simply return the buffer to the codec. 160 * 161 * For more details, see the Java documentation for MediaCodec.releaseOutputBuffer. 162 */ 163 media_status_t AMediaCodec_releaseOutputBufferAtTime( 164 AMediaCodec *mData, size_t idx, int64_t timestampNs); 165 166 167 typedef enum { 168 AMEDIACODECRYPTOINFO_MODE_CLEAR = 0, 169 AMEDIACODECRYPTOINFO_MODE_AES_CTR = 1 170 } cryptoinfo_mode_t; 171 172 /** 173 * Create an AMediaCodecCryptoInfo from scratch. Use this if you need to use custom 174 * crypto info, rather than one obtained from AMediaExtractor. 175 * 176 * AMediaCodecCryptoInfo describes the structure of an (at least 177 * partially) encrypted input sample. 178 * A buffer's data is considered to be partitioned into "subsamples", 179 * each subsample starts with a (potentially empty) run of plain, 180 * unencrypted bytes followed by a (also potentially empty) run of 181 * encrypted bytes. 182 * numBytesOfClearData can be null to indicate that all data is encrypted. 183 * This information encapsulates per-sample metadata as outlined in 184 * ISO/IEC FDIS 23001-7:2011 "Common encryption in ISO base media file format files". 185 */ 186 AMediaCodecCryptoInfo *AMediaCodecCryptoInfo_new( 187 int numsubsamples, 188 uint8_t key[16], 189 uint8_t iv[16], 190 cryptoinfo_mode_t mode, 191 size_t *clearbytes, 192 size_t *encryptedbytes); 193 194 /** 195 * delete an AMediaCodecCryptoInfo created previously with AMediaCodecCryptoInfo_new, or 196 * obtained from AMediaExtractor 197 */ 198 media_status_t AMediaCodecCryptoInfo_delete(AMediaCodecCryptoInfo*); 199 200 /** 201 * The number of subsamples that make up the buffer's contents. 202 */ 203 size_t AMediaCodecCryptoInfo_getNumSubSamples(AMediaCodecCryptoInfo*); 204 205 /** 206 * A 16-byte opaque key 207 */ 208 media_status_t AMediaCodecCryptoInfo_getKey(AMediaCodecCryptoInfo*, uint8_t *dst); 209 210 /** 211 * A 16-byte initialization vector 212 */ 213 media_status_t AMediaCodecCryptoInfo_getIV(AMediaCodecCryptoInfo*, uint8_t *dst); 214 215 /** 216 * The type of encryption that has been applied, 217 * one of AMEDIACODECRYPTOINFO_MODE_CLEAR or AMEDIACODECRYPTOINFO_MODE_AES_CTR. 218 */ 219 cryptoinfo_mode_t AMediaCodecCryptoInfo_getMode(AMediaCodecCryptoInfo*); 220 221 /** 222 * The number of leading unencrypted bytes in each subsample. 223 */ 224 media_status_t AMediaCodecCryptoInfo_getClearBytes(AMediaCodecCryptoInfo*, size_t *dst); 225 226 /** 227 * The number of trailing encrypted bytes in each subsample. 228 */ 229 media_status_t AMediaCodecCryptoInfo_getEncryptedBytes(AMediaCodecCryptoInfo*, size_t *dst); 230 231 #ifdef __cplusplus 232 } // extern "C" 233 #endif 234 235 #endif //_NDK_MEDIA_CODEC_H 236