1cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber/* 2cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber * Copyright (C) 2012 The Android Open Source Project 3cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber * 4cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber * Licensed under the Apache License, Version 2.0 (the "License"); 5cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber * you may not use this file except in compliance with the License. 6cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber * You may obtain a copy of the License at 7cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber * 8cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber * http://www.apache.org/licenses/LICENSE-2.0 9cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber * 10cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber * Unless required by applicable law or agreed to in writing, software 11cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber * distributed under the License is distributed on an "AS IS" BASIS, 12cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber * See the License for the specific language governing permissions and 14cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber * limitations under the License. 15cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber */ 16cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 17ac7d8fe36f6bb825b0a4031ee521caf95df39f2aJeff Tinker#include <media/stagefright/MediaErrors.h> 18cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber#include <utils/Errors.h> 19ac7d8fe36f6bb825b0a4031ee521caf95df39f2aJeff Tinker#include <utils/Vector.h> 20cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 21cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber#ifndef CRYPTO_API_H_ 22cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 23cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber#define CRYPTO_API_H_ 24cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 25cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Hubernamespace android { 26cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 27383190e475d7bdbe90359dbb99721041773a8646Andreas Huberstruct AString; 28cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huberstruct CryptoPlugin; 29cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 30cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huberstruct CryptoFactory { 31cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber CryptoFactory() {} 32cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber virtual ~CryptoFactory() {} 33cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 34cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber virtual bool isCryptoSchemeSupported(const uint8_t uuid[16]) const = 0; 35cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 36cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber virtual status_t createPlugin( 37cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber const uint8_t uuid[16], const void *data, size_t size, 38cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber CryptoPlugin **plugin) = 0; 39cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 40cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huberprivate: 41cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber CryptoFactory(const CryptoFactory &); 42cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber CryptoFactory &operator=(const CryptoFactory &); 43cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber}; 44cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 45cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huberstruct CryptoPlugin { 46cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber enum Mode { 47cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber kMode_Unencrypted = 0, 48cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber kMode_AES_CTR = 1, 49e47077fe48b64eacc3dc05314fb806c9f4e0a71aJeff Tinker kMode_AES_WV = 2, 50e47077fe48b64eacc3dc05314fb806c9f4e0a71aJeff Tinker kMode_AES_CBC = 3, 51cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber }; 52cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 53cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber struct SubSample { 5403a0571e96cdc4011872c81545df60e5e3dbfc16Jeff Tinker uint32_t mNumBytesOfClearData; 5503a0571e96cdc4011872c81545df60e5e3dbfc16Jeff Tinker uint32_t mNumBytesOfEncryptedData; 56cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber }; 57cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 58e47077fe48b64eacc3dc05314fb806c9f4e0a71aJeff Tinker struct Pattern { 59e47077fe48b64eacc3dc05314fb806c9f4e0a71aJeff Tinker // Number of blocks to be encrypted in the pattern. If zero, pattern 60e47077fe48b64eacc3dc05314fb806c9f4e0a71aJeff Tinker // encryption is inoperative. 61e47077fe48b64eacc3dc05314fb806c9f4e0a71aJeff Tinker uint32_t mEncryptBlocks; 62e47077fe48b64eacc3dc05314fb806c9f4e0a71aJeff Tinker 63e47077fe48b64eacc3dc05314fb806c9f4e0a71aJeff Tinker // Number of blocks to be skipped (left clear) in the pattern. If zero, 64e47077fe48b64eacc3dc05314fb806c9f4e0a71aJeff Tinker // pattern encryption is inoperative. 65e47077fe48b64eacc3dc05314fb806c9f4e0a71aJeff Tinker uint32_t mSkipBlocks; 66e47077fe48b64eacc3dc05314fb806c9f4e0a71aJeff Tinker }; 67e47077fe48b64eacc3dc05314fb806c9f4e0a71aJeff Tinker 68cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber CryptoPlugin() {} 69cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber virtual ~CryptoPlugin() {} 70cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 71cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber // If this method returns false, a non-secure decoder will be used to 72cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber // decode the data after decryption. The decrypt API below will have 73cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber // to support insecure decryption of the data (secure = false) for 74cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber // media data of the given mime type. 75cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber virtual bool requiresSecureDecoderComponent(const char *mime) const = 0; 76cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 77c3959f5bc22d1605e51c19766fc9a6b2db169ad1Jeff Tinker // To implement resolution constraints, the crypto plugin needs to know 78c3959f5bc22d1605e51c19766fc9a6b2db169ad1Jeff Tinker // the resolution of the video being decrypted. The media player should 79c3959f5bc22d1605e51c19766fc9a6b2db169ad1Jeff Tinker // call this method when the resolution is determined and any time it 80c3959f5bc22d1605e51c19766fc9a6b2db169ad1Jeff Tinker // is subsequently changed. 819a498ef11566a5ae82c24b0651c58280309dfd04Jeff Tinker 829a498ef11566a5ae82c24b0651c58280309dfd04Jeff Tinker virtual void notifyResolution(uint32_t /* width */, uint32_t /* height */) {} 83c3959f5bc22d1605e51c19766fc9a6b2db169ad1Jeff Tinker 84ac7d8fe36f6bb825b0a4031ee521caf95df39f2aJeff Tinker // A MediaDrm session may be associated with a MediaCrypto session. The 85ac7d8fe36f6bb825b0a4031ee521caf95df39f2aJeff Tinker // associated MediaDrm session is used to load decryption keys 86ac7d8fe36f6bb825b0a4031ee521caf95df39f2aJeff Tinker // into the crypto/drm plugin. The keys are then referenced by key-id 87ac7d8fe36f6bb825b0a4031ee521caf95df39f2aJeff Tinker // in the 'key' parameter to the decrypt() method. 88ac7d8fe36f6bb825b0a4031ee521caf95df39f2aJeff Tinker // Should return NO_ERROR on success, ERROR_DRM_SESSION_NOT_OPENED if 89ac7d8fe36f6bb825b0a4031ee521caf95df39f2aJeff Tinker // the session is not opened and a code from MediaErrors.h otherwise. 90ac7d8fe36f6bb825b0a4031ee521caf95df39f2aJeff Tinker virtual status_t setMediaDrmSession(const Vector<uint8_t> & /*sessionId */) { 91ac7d8fe36f6bb825b0a4031ee521caf95df39f2aJeff Tinker return ERROR_UNSUPPORTED; 92ac7d8fe36f6bb825b0a4031ee521caf95df39f2aJeff Tinker } 93ac7d8fe36f6bb825b0a4031ee521caf95df39f2aJeff Tinker 94383190e475d7bdbe90359dbb99721041773a8646Andreas Huber // If the error returned falls into the range 95383190e475d7bdbe90359dbb99721041773a8646Andreas Huber // ERROR_DRM_VENDOR_MIN..ERROR_DRM_VENDOR_MAX, errorDetailMsg should be 96383190e475d7bdbe90359dbb99721041773a8646Andreas Huber // filled in with an appropriate string. 97383190e475d7bdbe90359dbb99721041773a8646Andreas Huber // At the java level these special errors will then trigger a 98383190e475d7bdbe90359dbb99721041773a8646Andreas Huber // MediaCodec.CryptoException that gives clients access to both 99383190e475d7bdbe90359dbb99721041773a8646Andreas Huber // the error code and the errorDetailMsg. 100e0daeb3933e034f037630715e4cd2ecb3880498bEdwin Wong // Returns a non-negative result to indicate the number of bytes written 101e0daeb3933e034f037630715e4cd2ecb3880498bEdwin Wong // to the dstPtr, or a negative result to indicate an error. 102e0daeb3933e034f037630715e4cd2ecb3880498bEdwin Wong virtual ssize_t decrypt( 103cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber bool secure, 104cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber const uint8_t key[16], 105cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber const uint8_t iv[16], 106cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber Mode mode, 107e47077fe48b64eacc3dc05314fb806c9f4e0a71aJeff Tinker const Pattern &pattern, 108cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber const void *srcPtr, 109cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber const SubSample *subSamples, size_t numSubSamples, 110383190e475d7bdbe90359dbb99721041773a8646Andreas Huber void *dstPtr, 111383190e475d7bdbe90359dbb99721041773a8646Andreas Huber AString *errorDetailMsg) = 0; 112cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 113cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huberprivate: 114cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber CryptoPlugin(const CryptoPlugin &); 115cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber CryptoPlugin &operator=(const CryptoPlugin &); 116cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber}; 117cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 118cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber} // namespace android 119cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 120cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huberextern "C" { 121cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber extern android::CryptoFactory *createCryptoFactory(); 122cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber} 123cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber 124cf0db31c323676ba9cfab81c7032a37c09256e48Andreas Huber#endif // CRYPTO_API_H_ 125