DrmEngineBase.h revision cba7b32d8f2c47632313f54118ed3733b4b02cc8
127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi/* 227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Copyright (C) 2010 The Android Open Source Project 327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Licensed under the Apache License, Version 2.0 (the "License"); 527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * you may not use this file except in compliance with the License. 627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * You may obtain a copy of the License at 727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * http://www.apache.org/licenses/LICENSE-2.0 927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 1027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Unless required by applicable law or agreed to in writing, software 1127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * distributed under the License is distributed on an "AS IS" BASIS, 1227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * See the License for the specific language governing permissions and 1427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * limitations under the License. 1527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 1627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 1727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi#ifndef __DRM_ENGINE_BASE_H__ 1827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi#define __DRM_ENGINE_BASE_H__ 1927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 2027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi#include <drm/drm_framework_common.h> 2127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi#include "IDrmEngine.h" 2227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 2327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshinamespace android { 2427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 2527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi/** 2627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * This class is an interface for plug-in developers 2727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 2827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Responsibility of this class is control the sequence of actual plug-in. 2927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * All each plug-in developer has to do is implement onXXX() type virtual interfaces. 3027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 3127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshiclass DrmEngineBase : public IDrmEngine { 3227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshipublic: 3327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi DrmEngineBase(); 3427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual ~DrmEngineBase(); 3527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 3627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshipublic: 3727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi DrmConstraints* getConstraints(int uniqueId, const String8* path, int action); 3827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 393473846f64f5b28e1cbeb70ef5867073fc93159eTakeshi Aimi DrmMetadata* getMetadata(int uniqueId, const String8* path); 403473846f64f5b28e1cbeb70ef5867073fc93159eTakeshi Aimi 4127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi status_t initialize(int uniqueId); 4227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 4327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi status_t setOnInfoListener(int uniqueId, const IDrmEngine::OnInfoListener* infoListener); 4427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 4527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi status_t terminate(int uniqueId); 4627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 4727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi bool canHandle(int uniqueId, const String8& path); 4827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 4927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi DrmInfoStatus* processDrmInfo(int uniqueId, const DrmInfo* drmInfo); 5027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 512272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi status_t saveRights(int uniqueId, const DrmRights& drmRights, 5227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi const String8& rightsPath, const String8& contentPath); 5327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 5427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi DrmInfo* acquireDrmInfo(int uniqueId, const DrmInfoRequest* drmInfoRequest); 5527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 5627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi String8 getOriginalMimeType(int uniqueId, const String8& path); 5727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 5827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi int getDrmObjectType(int uniqueId, const String8& path, const String8& mimeType); 5927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 6027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi int checkRightsStatus(int uniqueId, const String8& path, int action); 6127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 622272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi status_t consumeRights(int uniqueId, DecryptHandle* decryptHandle, int action, bool reserve); 6327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 642272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi status_t setPlaybackStatus( 65a2cd44cb5067b4fe98794860690394254d3ac73cGloria Wang int uniqueId, DecryptHandle* decryptHandle, int playbackStatus, int64_t position); 6627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 6727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi bool validateAction( 6827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi int uniqueId, const String8& path, int action, const ActionDescription& description); 6927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 702272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi status_t removeRights(int uniqueId, const String8& path); 7127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 722272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi status_t removeAllRights(int uniqueId); 7327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 742272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi status_t openConvertSession(int uniqueId, int convertId); 7527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 7627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi DrmConvertedStatus* convertData(int uniqueId, int convertId, const DrmBuffer* inputData); 7727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 7827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi DrmConvertedStatus* closeConvertSession(int uniqueId, int convertId); 7927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 8027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi DrmSupportInfo* getSupportInfo(int uniqueId); 8127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 8227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi status_t openDecryptSession( 839d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong int uniqueId, DecryptHandle* decryptHandle, 849d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong int fd, off64_t offset, off64_t length, const char* mime); 8527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 86e943f84129326ab885cc7a69dcfa17f766b72b89Takeshi Aimi status_t openDecryptSession( 879d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong int uniqueId, DecryptHandle* decryptHandle, 889d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong const char* uri, const char* mime); 89e943f84129326ab885cc7a69dcfa17f766b72b89Takeshi Aimi 90cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi status_t openDecryptSession(int uniqueId, DecryptHandle* decryptHandle, 91cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi const DrmBuffer& buf, const String8& mimeType); 92cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi 932272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi status_t closeDecryptSession(int uniqueId, DecryptHandle* decryptHandle); 9427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 952272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi status_t initializeDecryptUnit(int uniqueId, DecryptHandle* decryptHandle, 9627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi int decryptUnitId, const DrmBuffer* headerInfo); 9727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 982272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi status_t decrypt(int uniqueId, DecryptHandle* decryptHandle, int decryptUnitId, 992272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi const DrmBuffer* encBuffer, DrmBuffer** decBuffer, DrmBuffer* IV); 10027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 1012272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi status_t finalizeDecryptUnit(int uniqueId, DecryptHandle* decryptHandle, int decryptUnitId); 10227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 10327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi ssize_t pread(int uniqueId, DecryptHandle* decryptHandle, 104a2cd44cb5067b4fe98794860690394254d3ac73cGloria Wang void* buffer, ssize_t numBytes, off64_t offset); 10527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 10627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshiprotected: 10727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi ///////////////////////////////////////////////////// 10827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi // Interface for plug-in developers // 10927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi // each plug-in has to implement following method // 11027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi ///////////////////////////////////////////////////// 11127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 11227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Get constraint information associated with input content 11327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 11427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 11527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] path Path of the protected content 11627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] action Actions defined such as, 11727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Action::DEFAULT, Action::PLAY, etc 11827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return DrmConstraints 11927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * key-value pairs of constraint are embedded in it 12027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @note 12127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * In case of error, return NULL 12227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 12327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual DrmConstraints* onGetConstraints( 12427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi int uniqueId, const String8* path, int action) = 0; 12527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 12627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 1273473846f64f5b28e1cbeb70ef5867073fc93159eTakeshi Aimi * Get metadata information associated with input content 1283473846f64f5b28e1cbeb70ef5867073fc93159eTakeshi Aimi * 1293473846f64f5b28e1cbeb70ef5867073fc93159eTakeshi Aimi * @param[in] uniqueId Unique identifier for a session 1303473846f64f5b28e1cbeb70ef5867073fc93159eTakeshi Aimi * @param[in] path Path of the protected content 1313473846f64f5b28e1cbeb70ef5867073fc93159eTakeshi Aimi * @return DrmMetadata 1323473846f64f5b28e1cbeb70ef5867073fc93159eTakeshi Aimi * key-value pairs of metadata 1333473846f64f5b28e1cbeb70ef5867073fc93159eTakeshi Aimi * @note 1343473846f64f5b28e1cbeb70ef5867073fc93159eTakeshi Aimi * In case of error, return NULL 1353473846f64f5b28e1cbeb70ef5867073fc93159eTakeshi Aimi */ 1363473846f64f5b28e1cbeb70ef5867073fc93159eTakeshi Aimi virtual DrmMetadata* onGetMetadata(int uniqueId, const String8* path) = 0; 1373473846f64f5b28e1cbeb70ef5867073fc93159eTakeshi Aimi 1383473846f64f5b28e1cbeb70ef5867073fc93159eTakeshi Aimi /** 13927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Initialize plug-in 14027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 14127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 14227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return status_t 14327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 14427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 14527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual status_t onInitialize(int uniqueId) = 0; 14627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 14727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 14827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Register a callback to be invoked when the caller required to 14927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * receive necessary information 15027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 1518f00151cbe693d52f3e233757c57fab3b6396d21Gloria Wang * @param[in] uniqueId Unique identifier for a session. uniqueId is a random 1528f00151cbe693d52f3e233757c57fab3b6396d21Gloria Wang * number generated in the DRM service. If the DrmManagerClient 1538f00151cbe693d52f3e233757c57fab3b6396d21Gloria Wang * is created in native code, uniqueId will be a number ranged 1548f00151cbe693d52f3e233757c57fab3b6396d21Gloria Wang * from 0x1000 to 0x1fff. If it comes from Java code, the uniqueId 1558f00151cbe693d52f3e233757c57fab3b6396d21Gloria Wang * will be a number ranged from 0x00 to 0xfff. So bit 0x1000 in 1568f00151cbe693d52f3e233757c57fab3b6396d21Gloria Wang * uniqueId could be used in DRM plugins to differentiate native 1578f00151cbe693d52f3e233757c57fab3b6396d21Gloria Wang * OnInfoListener and Java OnInfoListener. 15827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] infoListener Listener 15927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return status_t 16027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 16127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 16227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual status_t onSetOnInfoListener( 16327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi int uniqueId, const IDrmEngine::OnInfoListener* infoListener) = 0; 16427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 16527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 16627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Terminate the plug-in 16727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * and release resource bound to plug-in 16827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 16927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 17027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return status_t 17127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 17227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 17327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual status_t onTerminate(int uniqueId) = 0; 17427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 17527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 17627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Get whether the given content can be handled by this plugin or not 17727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 17827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 17927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] path Path the protected object 18027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return bool 18127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Returns true if this plugin can handle , false in case of not able to handle 18227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 18327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual bool onCanHandle(int uniqueId, const String8& path) = 0; 18427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 18527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 18627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Executes given drm information based on its type 18727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 18827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 18927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] drmInfo Information needs to be processed 19027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return DrmInfoStatus 19127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * instance as a result of processing given input 19227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 19327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual DrmInfoStatus* onProcessDrmInfo(int uniqueId, const DrmInfo* drmInfo) = 0; 19427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 19527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 19627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Save DRM rights to specified rights path 19727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * and make association with content path 19827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 19927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 20027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] drmRights DrmRights to be saved 20127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] rightsPath File path where rights to be saved 20227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] contentPath File path where content was saved 2032272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * @return status_t 2042272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 20527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 2062272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi virtual status_t onSaveRights(int uniqueId, const DrmRights& drmRights, 20727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi const String8& rightspath, const String8& contentPath) = 0; 20827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 20927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 21027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Retrieves necessary information for registration, unregistration or rights 21127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * acquisition information. 21227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 21327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 21427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] drmInfoRequest Request information to retrieve drmInfo 21527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return DrmInfo 21627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * instance as a result of processing given input 21727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 21827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual DrmInfo* onAcquireDrmInfo(int uniqueId, const DrmInfoRequest* drmInforequest) = 0; 21927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 22027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 22127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Retrieves the mime type embedded inside the original content 22227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 22327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 22427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] path Path of the protected content 22527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return String8 22627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Returns mime-type of the original content, such as "video/mpeg" 22727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 22827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual String8 onGetOriginalMimeType(int uniqueId, const String8& path) = 0; 22927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 23027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 23127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Retrieves the type of the protected object (content, rights, etc..) 23227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * using specified path or mimetype. At least one parameter should be non null 23327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * to retrieve DRM object type 23427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 23527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 23627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] path Path of the content or null. 23727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] mimeType Mime type of the content or null. 23827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return type of the DRM content, 23927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * such as DrmObjectType::CONTENT, DrmObjectType::RIGHTS_OBJECT 24027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 24127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual int onGetDrmObjectType( 24227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi int uniqueId, const String8& path, const String8& mimeType) = 0; 24327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 24427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 24527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Check whether the given content has valid rights or not 24627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 24727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 24827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] path Path of the protected content 24927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] action Action to perform (Action::DEFAULT, Action::PLAY, etc) 25027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return the status of the rights for the protected content, 25127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * such as RightsStatus::RIGHTS_VALID, RightsStatus::RIGHTS_EXPIRED, etc. 25227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 25327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual int onCheckRightsStatus(int uniqueId, const String8& path, int action) = 0; 25427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 25527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 25627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Consumes the rights for a content. 25727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * If the reserve parameter is true the rights is reserved until the same 25827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * application calls this api again with the reserve parameter set to false. 25927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 26027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 26127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] decryptHandle Handle for the decryption session 26227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] action Action to perform. (Action::DEFAULT, Action::PLAY, etc) 26327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] reserve True if the rights should be reserved. 2642272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * @return status_t 2652272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 26627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 2672272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi virtual status_t onConsumeRights(int uniqueId, DecryptHandle* decryptHandle, 26827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi int action, bool reserve) = 0; 26927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 27027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 27127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Informs the DRM Engine about the playback actions performed on the DRM files. 27227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 27327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 27427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] decryptHandle Handle for the decryption session 27527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] playbackStatus Playback action (Playback::START, Playback::STOP, Playback::PAUSE) 27627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] position Position in the file (in milliseconds) where the start occurs. 27727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Only valid together with Playback::START. 2782272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * @return status_t 2792272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 28027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 2812272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi virtual status_t onSetPlaybackStatus( 282a2cd44cb5067b4fe98794860690394254d3ac73cGloria Wang int uniqueId, DecryptHandle* decryptHandle, int playbackStatus, int64_t position) = 0; 28327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 28427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 28527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Validates whether an action on the DRM content is allowed or not. 28627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 28727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 28827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] path Path of the protected content 28927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] action Action to validate (Action::PLAY, Action::TRANSFER, etc) 29027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] description Detailed description of the action 29127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return true if the action is allowed. 29227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 29327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual bool onValidateAction(int uniqueId, const String8& path, 29427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi int action, const ActionDescription& description) = 0; 29527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 29627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 29727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Removes the rights associated with the given protected content 29827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 29927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 30027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] path Path of the protected content 3012272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * @return status_t 3022272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 30327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 3042272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi virtual status_t onRemoveRights(int uniqueId, const String8& path) = 0; 30527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 30627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 30727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Removes all the rights information of each plug-in associated with 30827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * DRM framework. Will be used in master reset 30927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 31027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 3112272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * @return status_t 3122272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 31327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 3142272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi virtual status_t onRemoveAllRights(int uniqueId) = 0; 31527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 31627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 31727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * This API is for Forward Lock based DRM scheme. 31827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Each time the application tries to download a new DRM file 31927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * which needs to be converted, then the application has to 32027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * begin with calling this API. 32127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 32227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 32327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] convertId Handle for the convert session 3242272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * @return status_t 3252272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 32627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 3272272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi virtual status_t onOpenConvertSession(int uniqueId, int convertId) = 0; 32827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 32927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 33027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Accepts and converts the input data which is part of DRM file. 33127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * The resultant converted data and the status is returned in the DrmConvertedInfo 33227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * object. This method will be called each time there are new block 33327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * of data received by the application. 33427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 33527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 33627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] convertId Handle for the convert session 33727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] inputData Input Data which need to be converted 33827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return Return object contains the status of the data conversion, 33927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * the output converted data and offset. In this case the 34027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * application will ignore the offset information. 34127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 34227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual DrmConvertedStatus* onConvertData( 34327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi int uniqueId, int convertId, const DrmBuffer* inputData) = 0; 34427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 34527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 34627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Informs the Drm Agent when there is no more data which need to be converted 34727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * or when an error occurs. Upon successful conversion of the complete data, 34827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * the agent will inform that where the header and body signature 34927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * should be added. This signature appending is needed to integrity 35027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * protect the converted file. 35127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 35227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 35327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] convertId Handle for the convert session 35427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return Return object contains the status of the data conversion, 35527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * the header and body signature data. It also informs 35627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * the application on which offset these signature data 35727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * should be appended. 35827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 35927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual DrmConvertedStatus* onCloseConvertSession(int uniqueId, int convertId) = 0; 36027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 36127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 36227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Returns the information about the Drm Engine capabilities which includes 36327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * supported MimeTypes and file suffixes. 36427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 36527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 36627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return DrmSupportInfo 36727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * instance which holds the capabilities of a plug-in 36827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 36927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual DrmSupportInfo* onGetSupportInfo(int uniqueId) = 0; 37027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 37127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 37227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Open the decrypt session to decrypt the given protected content 37327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 37427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 37527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] decryptHandle Handle for the current decryption session 37627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] fd File descriptor of the protected content to be decrypted 37727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] offset Start position of the content 37827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] length The length of the protected content 37927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return 38027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * DRM_ERROR_CANNOT_HANDLE for failure and DRM_NO_ERROR for success 38127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 38227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual status_t onOpenDecryptSession( 3839d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong int uniqueId, DecryptHandle* decryptHandle, 3849d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong int fd, off64_t offset, off64_t length) = 0; 3859d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong 3869d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong /** 3879d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * Open the decrypt session to decrypt the given protected content 3889d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * 3899d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * @param[in] uniqueId Unique identifier for a session 3909d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * @param[in] decryptHandle Handle for the current decryption session 3919d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * @param[in] fd File descriptor of the protected content to be decrypted 3929d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * @param[in] offset Start position of the content 3939d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * @param[in] length The length of the protected content 3949d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * @param[in] mime Mime type of the protected content 3959d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * drm plugin may do some optimization since the mime type is known. 3969d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * @return 3979d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * DRM_ERROR_CANNOT_HANDLE for failure and DRM_NO_ERROR for success 3989d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong */ 3999d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong virtual status_t onOpenDecryptSession( 4009d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong int uniqueId, DecryptHandle* decryptHandle, 4019d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong int fd, off64_t offset, off64_t length, 4029d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong const char* mime) { 4039d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong 4049d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong return DRM_ERROR_CANNOT_HANDLE; 4059d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong } 40627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 40727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 408e943f84129326ab885cc7a69dcfa17f766b72b89Takeshi Aimi * Open the decrypt session to decrypt the given protected content 409e943f84129326ab885cc7a69dcfa17f766b72b89Takeshi Aimi * 410e943f84129326ab885cc7a69dcfa17f766b72b89Takeshi Aimi * @param[in] uniqueId Unique identifier for a session 411e943f84129326ab885cc7a69dcfa17f766b72b89Takeshi Aimi * @param[in] decryptHandle Handle for the current decryption session 412e943f84129326ab885cc7a69dcfa17f766b72b89Takeshi Aimi * @param[in] uri Path of the protected content to be decrypted 413e943f84129326ab885cc7a69dcfa17f766b72b89Takeshi Aimi * @return 414e943f84129326ab885cc7a69dcfa17f766b72b89Takeshi Aimi * DRM_ERROR_CANNOT_HANDLE for failure and DRM_NO_ERROR for success 415e943f84129326ab885cc7a69dcfa17f766b72b89Takeshi Aimi */ 416e943f84129326ab885cc7a69dcfa17f766b72b89Takeshi Aimi virtual status_t onOpenDecryptSession( 4179d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong int uniqueId, DecryptHandle* decryptHandle, 4189d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong const char* uri) = 0; 4199d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong 4209d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong /** 4219d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * Open the decrypt session to decrypt the given protected content 4229d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * 4239d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * @param[in] uniqueId Unique identifier for a session 4249d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * @param[in] decryptHandle Handle for the current decryption session 4259d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * @param[in] uri Path of the protected content to be decrypted 4269d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * @param[in] mime Mime type of the protected content. The corresponding 4279d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * drm plugin may do some optimization since the mime type is known. 4289d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * @return 4299d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong * DRM_ERROR_CANNOT_HANDLE for failure and DRM_NO_ERROR for success 4309d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong */ 4319d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong virtual status_t onOpenDecryptSession( 4329d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong int uniqueId, DecryptHandle* decryptHandle, 4339d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong const char* uri, const char* mime) { 4349d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong 4359d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong return DRM_ERROR_CANNOT_HANDLE; 4369d2f386dd2885eaffa11fd494ae258bb09fe6397James Dong } 437e943f84129326ab885cc7a69dcfa17f766b72b89Takeshi Aimi 438e943f84129326ab885cc7a69dcfa17f766b72b89Takeshi Aimi /** 439cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi * Open the decrypt session to decrypt the given protected content 440cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi * 441cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi * @param[in] uniqueId Unique identifier for a session 442cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi * @param[in] decryptHandle Handle for the current decryption session 443cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi * @param[in] buf Data to initiate decrypt session 444cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi * @param[in] mimeType Mime type of the protected content 445cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi * @return 446cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi * DRM_ERROR_CANNOT_HANDLE for failure and DRM_NO_ERROR for success 447cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi */ 448cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi virtual status_t onOpenDecryptSession(int uniqueId, DecryptHandle* decryptHandle, 449cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi const DrmBuffer& buf, const String8& mimeType) { 450cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi return DRM_ERROR_CANNOT_HANDLE; 451cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi } 452cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi 453cba7b32d8f2c47632313f54118ed3733b4b02cc8Kei Takahashi /** 45427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Close the decrypt session for the given handle 45527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 45627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 45727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] decryptHandle Handle for the decryption session 4582272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * @return status_t 4592272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 46027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 4612272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi virtual status_t onCloseDecryptSession(int uniqueId, DecryptHandle* decryptHandle) = 0; 46227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 46327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 46427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Initialize decryption for the given unit of the protected content 46527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 46627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 46727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] decryptId Handle for the decryption session 46827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] decryptUnitId ID Specifies decryption unit, such as track ID 46927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] headerInfo Information for initializing decryption of this decrypUnit 4702272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * @return status_t 4712272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 47227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 4732272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi virtual status_t onInitializeDecryptUnit(int uniqueId, DecryptHandle* decryptHandle, 47427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi int decryptUnitId, const DrmBuffer* headerInfo) = 0; 47527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 47627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 47727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Decrypt the protected content buffers for the given unit 47827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * This method will be called any number of times, based on number of 47927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * encrypted streams received from application. 48027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 48127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 48227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] decryptId Handle for the decryption session 48327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] decryptUnitId ID Specifies decryption unit, such as track ID 48427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] encBuffer Encrypted data block 48527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[out] decBuffer Decrypted data block 4862272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * @param[in] IV Optional buffer 48727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return status_t 48827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Returns the error code for this API 48927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * DRM_NO_ERROR for success, and one of DRM_ERROR_UNKNOWN, DRM_ERROR_LICENSE_EXPIRED 49027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * DRM_ERROR_SESSION_NOT_OPENED, DRM_ERROR_DECRYPT_UNIT_NOT_INITIALIZED, 49127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * DRM_ERROR_DECRYPT for failure. 49227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 4932272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi virtual status_t onDecrypt(int uniqueId, DecryptHandle* decryptHandle, int decryptUnitId, 4942272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi const DrmBuffer* encBuffer, DrmBuffer** decBuffer, DrmBuffer* IV) = 0; 49527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 49627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 49727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Finalize decryption for the given unit of the protected content 49827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 49927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 50027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] decryptHandle Handle for the decryption session 50127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] decryptUnitId ID Specifies decryption unit, such as track ID 5022272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * @return status_t 5032272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 50427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 5052272ee27d9022d173b6eab45c409b3c3f57f30ecTakeshi Aimi virtual status_t onFinalizeDecryptUnit( 50627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi int uniqueId, DecryptHandle* decryptHandle, int decryptUnitId) = 0; 50727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 50827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi /** 50927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * Reads the specified number of bytes from an open DRM file. 51027ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 51127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] uniqueId Unique identifier for a session 51227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] decryptHandle Handle for the decryption session 51327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[out] buffer Reference to the buffer that should receive the read data. 51427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] numBytes Number of bytes to read. 51527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @param[in] offset Offset with which to update the file position. 51627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * 51727ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi * @return Number of bytes read. Returns -1 for Failure. 51827ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi */ 51927ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi virtual ssize_t onPread(int uniqueId, DecryptHandle* decryptHandle, 520a2cd44cb5067b4fe98794860690394254d3ac73cGloria Wang void* buffer, ssize_t numBytes, off64_t offset) = 0; 52127ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi}; 52227ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 52327ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi}; 52427ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 52527ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi#endif /* __DRM_ENGINE_BASE_H__ */ 52627ed8ad2db653f6ac07dcf8bcc05e2409c8bb024aimitakeshi 527