DrmEngineBase.h revision 3473846f64f5b28e1cbeb70ef5867073fc93159e
1/* 2 * Copyright (C) 2010 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#ifndef __DRM_ENGINE_BASE_H__ 18#define __DRM_ENGINE_BASE_H__ 19 20#include <drm/drm_framework_common.h> 21#include "IDrmEngine.h" 22 23namespace android { 24 25/** 26 * This class is an interface for plug-in developers 27 * 28 * Responsibility of this class is control the sequence of actual plug-in. 29 * All each plug-in developer has to do is implement onXXX() type virtual interfaces. 30 */ 31class DrmEngineBase : public IDrmEngine { 32public: 33 DrmEngineBase(); 34 virtual ~DrmEngineBase(); 35 36public: 37 DrmConstraints* getConstraints(int uniqueId, const String8* path, int action); 38 39 DrmMetadata* getMetadata(int uniqueId, const String8* path); 40 41 status_t initialize(int uniqueId); 42 43 status_t setOnInfoListener(int uniqueId, const IDrmEngine::OnInfoListener* infoListener); 44 45 status_t terminate(int uniqueId); 46 47 bool canHandle(int uniqueId, const String8& path); 48 49 DrmInfoStatus* processDrmInfo(int uniqueId, const DrmInfo* drmInfo); 50 51 status_t saveRights(int uniqueId, const DrmRights& drmRights, 52 const String8& rightsPath, const String8& contentPath); 53 54 DrmInfo* acquireDrmInfo(int uniqueId, const DrmInfoRequest* drmInfoRequest); 55 56 String8 getOriginalMimeType(int uniqueId, const String8& path); 57 58 int getDrmObjectType(int uniqueId, const String8& path, const String8& mimeType); 59 60 int checkRightsStatus(int uniqueId, const String8& path, int action); 61 62 status_t consumeRights(int uniqueId, DecryptHandle* decryptHandle, int action, bool reserve); 63 64 status_t setPlaybackStatus( 65 int uniqueId, DecryptHandle* decryptHandle, int playbackStatus, int position); 66 67 bool validateAction( 68 int uniqueId, const String8& path, int action, const ActionDescription& description); 69 70 status_t removeRights(int uniqueId, const String8& path); 71 72 status_t removeAllRights(int uniqueId); 73 74 status_t openConvertSession(int uniqueId, int convertId); 75 76 DrmConvertedStatus* convertData(int uniqueId, int convertId, const DrmBuffer* inputData); 77 78 DrmConvertedStatus* closeConvertSession(int uniqueId, int convertId); 79 80 DrmSupportInfo* getSupportInfo(int uniqueId); 81 82 status_t openDecryptSession( 83 int uniqueId, DecryptHandle* decryptHandle, int fd, int offset, int length); 84 85 status_t openDecryptSession( 86 int uniqueId, DecryptHandle* decryptHandle, const char* uri); 87 88 status_t closeDecryptSession(int uniqueId, DecryptHandle* decryptHandle); 89 90 status_t initializeDecryptUnit(int uniqueId, DecryptHandle* decryptHandle, 91 int decryptUnitId, const DrmBuffer* headerInfo); 92 93 status_t decrypt(int uniqueId, DecryptHandle* decryptHandle, int decryptUnitId, 94 const DrmBuffer* encBuffer, DrmBuffer** decBuffer, DrmBuffer* IV); 95 96 status_t finalizeDecryptUnit(int uniqueId, DecryptHandle* decryptHandle, int decryptUnitId); 97 98 ssize_t pread(int uniqueId, DecryptHandle* decryptHandle, 99 void* buffer, ssize_t numBytes, off_t offset); 100 101protected: 102 ///////////////////////////////////////////////////// 103 // Interface for plug-in developers // 104 // each plug-in has to implement following method // 105 ///////////////////////////////////////////////////// 106 /** 107 * Get constraint information associated with input content 108 * 109 * @param[in] uniqueId Unique identifier for a session 110 * @param[in] path Path of the protected content 111 * @param[in] action Actions defined such as, 112 * Action::DEFAULT, Action::PLAY, etc 113 * @return DrmConstraints 114 * key-value pairs of constraint are embedded in it 115 * @note 116 * In case of error, return NULL 117 */ 118 virtual DrmConstraints* onGetConstraints( 119 int uniqueId, const String8* path, int action) = 0; 120 121 /** 122 * Get metadata information associated with input content 123 * 124 * @param[in] uniqueId Unique identifier for a session 125 * @param[in] path Path of the protected content 126 * @return DrmMetadata 127 * key-value pairs of metadata 128 * @note 129 * In case of error, return NULL 130 */ 131 virtual DrmMetadata* onGetMetadata(int uniqueId, const String8* path) = 0; 132 133 /** 134 * Initialize plug-in 135 * 136 * @param[in] uniqueId Unique identifier for a session 137 * @return status_t 138 * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 139 */ 140 virtual status_t onInitialize(int uniqueId) = 0; 141 142 /** 143 * Register a callback to be invoked when the caller required to 144 * receive necessary information 145 * 146 * @param[in] uniqueId Unique identifier for a session 147 * @param[in] infoListener Listener 148 * @return status_t 149 * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 150 */ 151 virtual status_t onSetOnInfoListener( 152 int uniqueId, const IDrmEngine::OnInfoListener* infoListener) = 0; 153 154 /** 155 * Terminate the plug-in 156 * and release resource bound to plug-in 157 * 158 * @param[in] uniqueId Unique identifier for a session 159 * @return status_t 160 * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 161 */ 162 virtual status_t onTerminate(int uniqueId) = 0; 163 164 /** 165 * Get whether the given content can be handled by this plugin or not 166 * 167 * @param[in] uniqueId Unique identifier for a session 168 * @param[in] path Path the protected object 169 * @return bool 170 * Returns true if this plugin can handle , false in case of not able to handle 171 */ 172 virtual bool onCanHandle(int uniqueId, const String8& path) = 0; 173 174 /** 175 * Executes given drm information based on its type 176 * 177 * @param[in] uniqueId Unique identifier for a session 178 * @param[in] drmInfo Information needs to be processed 179 * @return DrmInfoStatus 180 * instance as a result of processing given input 181 */ 182 virtual DrmInfoStatus* onProcessDrmInfo(int uniqueId, const DrmInfo* drmInfo) = 0; 183 184 /** 185 * Save DRM rights to specified rights path 186 * and make association with content path 187 * 188 * @param[in] uniqueId Unique identifier for a session 189 * @param[in] drmRights DrmRights to be saved 190 * @param[in] rightsPath File path where rights to be saved 191 * @param[in] contentPath File path where content was saved 192 * @return status_t 193 * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 194 */ 195 virtual status_t onSaveRights(int uniqueId, const DrmRights& drmRights, 196 const String8& rightspath, const String8& contentPath) = 0; 197 198 /** 199 * Retrieves necessary information for registration, unregistration or rights 200 * acquisition information. 201 * 202 * @param[in] uniqueId Unique identifier for a session 203 * @param[in] drmInfoRequest Request information to retrieve drmInfo 204 * @return DrmInfo 205 * instance as a result of processing given input 206 */ 207 virtual DrmInfo* onAcquireDrmInfo(int uniqueId, const DrmInfoRequest* drmInforequest) = 0; 208 209 /** 210 * Retrieves the mime type embedded inside the original content 211 * 212 * @param[in] uniqueId Unique identifier for a session 213 * @param[in] path Path of the protected content 214 * @return String8 215 * Returns mime-type of the original content, such as "video/mpeg" 216 */ 217 virtual String8 onGetOriginalMimeType(int uniqueId, const String8& path) = 0; 218 219 /** 220 * Retrieves the type of the protected object (content, rights, etc..) 221 * using specified path or mimetype. At least one parameter should be non null 222 * to retrieve DRM object type 223 * 224 * @param[in] uniqueId Unique identifier for a session 225 * @param[in] path Path of the content or null. 226 * @param[in] mimeType Mime type of the content or null. 227 * @return type of the DRM content, 228 * such as DrmObjectType::CONTENT, DrmObjectType::RIGHTS_OBJECT 229 */ 230 virtual int onGetDrmObjectType( 231 int uniqueId, const String8& path, const String8& mimeType) = 0; 232 233 /** 234 * Check whether the given content has valid rights or not 235 * 236 * @param[in] uniqueId Unique identifier for a session 237 * @param[in] path Path of the protected content 238 * @param[in] action Action to perform (Action::DEFAULT, Action::PLAY, etc) 239 * @return the status of the rights for the protected content, 240 * such as RightsStatus::RIGHTS_VALID, RightsStatus::RIGHTS_EXPIRED, etc. 241 */ 242 virtual int onCheckRightsStatus(int uniqueId, const String8& path, int action) = 0; 243 244 /** 245 * Consumes the rights for a content. 246 * If the reserve parameter is true the rights is reserved until the same 247 * application calls this api again with the reserve parameter set to false. 248 * 249 * @param[in] uniqueId Unique identifier for a session 250 * @param[in] decryptHandle Handle for the decryption session 251 * @param[in] action Action to perform. (Action::DEFAULT, Action::PLAY, etc) 252 * @param[in] reserve True if the rights should be reserved. 253 * @return status_t 254 * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 255 */ 256 virtual status_t onConsumeRights(int uniqueId, DecryptHandle* decryptHandle, 257 int action, bool reserve) = 0; 258 259 /** 260 * Informs the DRM Engine about the playback actions performed on the DRM files. 261 * 262 * @param[in] uniqueId Unique identifier for a session 263 * @param[in] decryptHandle Handle for the decryption session 264 * @param[in] playbackStatus Playback action (Playback::START, Playback::STOP, Playback::PAUSE) 265 * @param[in] position Position in the file (in milliseconds) where the start occurs. 266 * Only valid together with Playback::START. 267 * @return status_t 268 * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 269 */ 270 virtual status_t onSetPlaybackStatus( 271 int uniqueId, DecryptHandle* decryptHandle, int playbackStatus, int position) = 0; 272 273 /** 274 * Validates whether an action on the DRM content is allowed or not. 275 * 276 * @param[in] uniqueId Unique identifier for a session 277 * @param[in] path Path of the protected content 278 * @param[in] action Action to validate (Action::PLAY, Action::TRANSFER, etc) 279 * @param[in] description Detailed description of the action 280 * @return true if the action is allowed. 281 */ 282 virtual bool onValidateAction(int uniqueId, const String8& path, 283 int action, const ActionDescription& description) = 0; 284 285 /** 286 * Removes the rights associated with the given protected content 287 * 288 * @param[in] uniqueId Unique identifier for a session 289 * @param[in] path Path of the protected content 290 * @return status_t 291 * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 292 */ 293 virtual status_t onRemoveRights(int uniqueId, const String8& path) = 0; 294 295 /** 296 * Removes all the rights information of each plug-in associated with 297 * DRM framework. Will be used in master reset 298 * 299 * @param[in] uniqueId Unique identifier for a session 300 * @return status_t 301 * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 302 */ 303 virtual status_t onRemoveAllRights(int uniqueId) = 0; 304 305 /** 306 * This API is for Forward Lock based DRM scheme. 307 * Each time the application tries to download a new DRM file 308 * which needs to be converted, then the application has to 309 * begin with calling this API. 310 * 311 * @param[in] uniqueId Unique identifier for a session 312 * @param[in] convertId Handle for the convert session 313 * @return status_t 314 * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 315 */ 316 virtual status_t onOpenConvertSession(int uniqueId, int convertId) = 0; 317 318 /** 319 * Accepts and converts the input data which is part of DRM file. 320 * The resultant converted data and the status is returned in the DrmConvertedInfo 321 * object. This method will be called each time there are new block 322 * of data received by the application. 323 * 324 * @param[in] uniqueId Unique identifier for a session 325 * @param[in] convertId Handle for the convert session 326 * @param[in] inputData Input Data which need to be converted 327 * @return Return object contains the status of the data conversion, 328 * the output converted data and offset. In this case the 329 * application will ignore the offset information. 330 */ 331 virtual DrmConvertedStatus* onConvertData( 332 int uniqueId, int convertId, const DrmBuffer* inputData) = 0; 333 334 /** 335 * Informs the Drm Agent when there is no more data which need to be converted 336 * or when an error occurs. Upon successful conversion of the complete data, 337 * the agent will inform that where the header and body signature 338 * should be added. This signature appending is needed to integrity 339 * protect the converted file. 340 * 341 * @param[in] uniqueId Unique identifier for a session 342 * @param[in] convertId Handle for the convert session 343 * @return Return object contains the status of the data conversion, 344 * the header and body signature data. It also informs 345 * the application on which offset these signature data 346 * should be appended. 347 */ 348 virtual DrmConvertedStatus* onCloseConvertSession(int uniqueId, int convertId) = 0; 349 350 /** 351 * Returns the information about the Drm Engine capabilities which includes 352 * supported MimeTypes and file suffixes. 353 * 354 * @param[in] uniqueId Unique identifier for a session 355 * @return DrmSupportInfo 356 * instance which holds the capabilities of a plug-in 357 */ 358 virtual DrmSupportInfo* onGetSupportInfo(int uniqueId) = 0; 359 360 /** 361 * Open the decrypt session to decrypt the given protected content 362 * 363 * @param[in] uniqueId Unique identifier for a session 364 * @param[in] decryptHandle Handle for the current decryption session 365 * @param[in] fd File descriptor of the protected content to be decrypted 366 * @param[in] offset Start position of the content 367 * @param[in] length The length of the protected content 368 * @return 369 * DRM_ERROR_CANNOT_HANDLE for failure and DRM_NO_ERROR for success 370 */ 371 virtual status_t onOpenDecryptSession( 372 int uniqueId, DecryptHandle* decryptHandle, int fd, int offset, int length) = 0; 373 374 /** 375 * Open the decrypt session to decrypt the given protected content 376 * 377 * @param[in] uniqueId Unique identifier for a session 378 * @param[in] decryptHandle Handle for the current decryption session 379 * @param[in] uri Path of the protected content to be decrypted 380 * @return 381 * DRM_ERROR_CANNOT_HANDLE for failure and DRM_NO_ERROR for success 382 */ 383 virtual status_t onOpenDecryptSession( 384 int uniqueId, DecryptHandle* decryptHandle, const char* uri) = 0; 385 386 /** 387 * Close the decrypt session for the given handle 388 * 389 * @param[in] uniqueId Unique identifier for a session 390 * @param[in] decryptHandle Handle for the decryption session 391 * @return status_t 392 * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 393 */ 394 virtual status_t onCloseDecryptSession(int uniqueId, DecryptHandle* decryptHandle) = 0; 395 396 /** 397 * Initialize decryption for the given unit of the protected content 398 * 399 * @param[in] uniqueId Unique identifier for a session 400 * @param[in] decryptId Handle for the decryption session 401 * @param[in] decryptUnitId ID Specifies decryption unit, such as track ID 402 * @param[in] headerInfo Information for initializing decryption of this decrypUnit 403 * @return status_t 404 * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 405 */ 406 virtual status_t onInitializeDecryptUnit(int uniqueId, DecryptHandle* decryptHandle, 407 int decryptUnitId, const DrmBuffer* headerInfo) = 0; 408 409 /** 410 * Decrypt the protected content buffers for the given unit 411 * This method will be called any number of times, based on number of 412 * encrypted streams received from application. 413 * 414 * @param[in] uniqueId Unique identifier for a session 415 * @param[in] decryptId Handle for the decryption session 416 * @param[in] decryptUnitId ID Specifies decryption unit, such as track ID 417 * @param[in] encBuffer Encrypted data block 418 * @param[out] decBuffer Decrypted data block 419 * @param[in] IV Optional buffer 420 * @return status_t 421 * Returns the error code for this API 422 * DRM_NO_ERROR for success, and one of DRM_ERROR_UNKNOWN, DRM_ERROR_LICENSE_EXPIRED 423 * DRM_ERROR_SESSION_NOT_OPENED, DRM_ERROR_DECRYPT_UNIT_NOT_INITIALIZED, 424 * DRM_ERROR_DECRYPT for failure. 425 */ 426 virtual status_t onDecrypt(int uniqueId, DecryptHandle* decryptHandle, int decryptUnitId, 427 const DrmBuffer* encBuffer, DrmBuffer** decBuffer, DrmBuffer* IV) = 0; 428 429 /** 430 * Finalize decryption for the given unit of the protected content 431 * 432 * @param[in] uniqueId Unique identifier for a session 433 * @param[in] decryptHandle Handle for the decryption session 434 * @param[in] decryptUnitId ID Specifies decryption unit, such as track ID 435 * @return status_t 436 * Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure 437 */ 438 virtual status_t onFinalizeDecryptUnit( 439 int uniqueId, DecryptHandle* decryptHandle, int decryptUnitId) = 0; 440 441 /** 442 * Reads the specified number of bytes from an open DRM file. 443 * 444 * @param[in] uniqueId Unique identifier for a session 445 * @param[in] decryptHandle Handle for the decryption session 446 * @param[out] buffer Reference to the buffer that should receive the read data. 447 * @param[in] numBytes Number of bytes to read. 448 * @param[in] offset Offset with which to update the file position. 449 * 450 * @return Number of bytes read. Returns -1 for Failure. 451 */ 452 virtual ssize_t onPread(int uniqueId, DecryptHandle* decryptHandle, 453 void* buffer, ssize_t numBytes, off_t offset) = 0; 454}; 455 456}; 457 458#endif /* __DRM_ENGINE_BASE_H__ */ 459 460