1 // Copyright 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef MEDIA_CDM_PPAPI_EXTERNAL_CLEAR_KEY_CLEAR_KEY_CDM_H_
6 #define MEDIA_CDM_PPAPI_EXTERNAL_CLEAR_KEY_CLEAR_KEY_CDM_H_
11 #include "base/basictypes.h"
12 #include "base/compiler_specific.h"
13 #include "base/memory/ref_counted.h"
14 #include "base/memory/scoped_ptr.h"
15 #include "base/synchronization/lock.h"
16 #include "media/cdm/aes_decryptor.h"
17 #include "media/cdm/ppapi/external_clear_key/clear_key_cdm_common.h"
19 // Enable this to use the fake decoder for testing.
20 // TODO(tomfinegan): Move fake audio decoder into a separate class.
22 #define CLEAR_KEY_CDM_USE_FAKE_AUDIO_DECODER
26 class FileIOTestRunner;
27 class CdmVideoDecoder;
29 class FFmpegCdmAudioDecoder;
31 // Clear key implementation of the cdm::ContentDecryptionModule interface.
32 class ClearKeyCdm : public ClearKeyCdmInterface {
34 ClearKeyCdm(Host* host, const std::string& key_system);
35 virtual ~ClearKeyCdm();
37 // ContentDecryptionModule implementation.
38 virtual void CreateSession(uint32 promise_id,
39 const char* init_data_type,
40 uint32 init_data_type_size,
41 const uint8* init_data,
42 uint32 init_data_size,
43 cdm::SessionType session_type) OVERRIDE;
44 virtual void LoadSession(uint32 promise_id,
45 const char* web_session_id,
46 uint32_t web_session_id_length) OVERRIDE;
47 virtual void UpdateSession(uint32 promise_id,
48 const char* web_session_id,
49 uint32_t web_session_id_length,
50 const uint8* response,
51 uint32 response_size) OVERRIDE;
52 virtual void CloseSession(uint32 promise_id,
53 const char* web_session_id,
54 uint32_t web_session_id_length) OVERRIDE;
55 virtual void RemoveSession(uint32 promise_id,
56 const char* web_session_id,
57 uint32_t web_session_id_length) OVERRIDE;
58 virtual void GetUsableKeyIds(uint32_t promise_id,
59 const char* web_session_id,
60 uint32_t web_session_id_length) OVERRIDE;
61 virtual void SetServerCertificate(
63 const uint8_t* server_certificate_data,
64 uint32_t server_certificate_data_size) OVERRIDE;
65 virtual void TimerExpired(void* context) OVERRIDE;
66 virtual cdm::Status Decrypt(const cdm::InputBuffer& encrypted_buffer,
67 cdm::DecryptedBlock* decrypted_block) OVERRIDE;
68 virtual cdm::Status InitializeAudioDecoder(
69 const cdm::AudioDecoderConfig& audio_decoder_config) OVERRIDE;
70 virtual cdm::Status InitializeVideoDecoder(
71 const cdm::VideoDecoderConfig& video_decoder_config) OVERRIDE;
72 virtual void DeinitializeDecoder(cdm::StreamType decoder_type) OVERRIDE;
73 virtual void ResetDecoder(cdm::StreamType decoder_type) OVERRIDE;
74 virtual cdm::Status DecryptAndDecodeFrame(
75 const cdm::InputBuffer& encrypted_buffer,
76 cdm::VideoFrame* video_frame) OVERRIDE;
77 virtual cdm::Status DecryptAndDecodeSamples(
78 const cdm::InputBuffer& encrypted_buffer,
79 cdm::AudioFrames* audio_frames) OVERRIDE;
80 virtual void Destroy() OVERRIDE;
81 virtual void OnPlatformChallengeResponse(
82 const cdm::PlatformChallengeResponse& response) OVERRIDE;
83 virtual void OnQueryOutputProtectionStatus(
84 uint32_t link_mask, uint32_t output_protection_mask) OVERRIDE;
87 // Emulates a session stored for |session_id_for_emulated_loadsession_|. This
88 // is necessary since aes_decryptor.cc does not support storing sessions.
89 void LoadLoadableSession();
91 // ContentDecryptionModule callbacks.
92 void OnSessionMessage(const std::string& web_session_id,
93 const std::vector<uint8>& message,
94 const GURL& destination_url);
95 void OnSessionClosed(const std::string& web_session_id);
97 // Handle the success/failure of a promise. These methods are responsible for
98 // calling |host_| to resolve or reject the promise.
99 void OnSessionCreated(uint32 promise_id, const std::string& web_session_id);
100 void OnSessionLoaded(uint32 promise_id, const std::string& web_session_id);
101 void OnSessionUpdated(uint32 promise_id, const std::string& web_session_id);
102 void OnSessionReleased(uint32 promise_id, const std::string& web_session_id);
103 void OnUsableKeyIdsObtained(uint32 promise_id, const KeyIdsVector& key_ids);
104 void OnPromiseFailed(uint32 promise_id,
105 MediaKeys::Exception exception_code,
107 const std::string& error_message);
109 // Prepares next heartbeat message and sets a timer for it.
110 void ScheduleNextHeartBeat();
112 // Decrypts the |encrypted_buffer| and puts the result in |decrypted_buffer|.
113 // Returns cdm::kSuccess if decryption succeeded. The decrypted result is
114 // put in |decrypted_buffer|. If |encrypted_buffer| is empty, the
115 // |decrypted_buffer| is set to an empty (EOS) buffer.
116 // Returns cdm::kNoKey if no decryption key was available. In this case
117 // |decrypted_buffer| should be ignored by the caller.
118 // Returns cdm::kDecryptError if any decryption error occurred. In this case
119 // |decrypted_buffer| should be ignored by the caller.
120 cdm::Status DecryptToMediaDecoderBuffer(
121 const cdm::InputBuffer& encrypted_buffer,
122 scoped_refptr<DecoderBuffer>* decrypted_buffer);
124 #if defined(CLEAR_KEY_CDM_USE_FAKE_AUDIO_DECODER)
125 int64 CurrentTimeStampInMicroseconds() const;
127 // Generates fake video frames with |duration_in_microseconds|.
128 // Returns the number of samples generated in the |audio_frames|.
129 int GenerateFakeAudioFramesFromDuration(int64 duration_in_microseconds,
130 cdm::AudioFrames* audio_frames) const;
132 // Generates fake video frames given |input_timestamp|.
133 // Returns cdm::kSuccess if any audio frame is successfully generated.
134 cdm::Status GenerateFakeAudioFrames(int64 timestamp_in_microseconds,
135 cdm::AudioFrames* audio_frames);
136 #endif // CLEAR_KEY_CDM_USE_FAKE_AUDIO_DECODER
138 void StartFileIOTest();
140 // Callback for CDM File IO test.
141 void OnFileIOTestComplete(bool success);
143 // Keep track of the last session created.
144 void SetSessionId(const std::string& web_session_id);
146 AesDecryptor decryptor_;
148 ClearKeyCdmHost* host_;
150 const std::string key_system_;
152 std::string last_session_id_;
153 std::string next_heartbeat_message_;
155 // In order to simulate LoadSession(), CreateSession() and then
156 // UpdateSession() will be called to create a session with known keys.
157 // |session_id_for_emulated_loadsession_| is used to keep track of the
158 // session_id allocated by aes_decryptor, as the session_id will be returned
159 // as |kLoadableWebSessionId|. Future requests for this simulated session
160 // need to use |session_id_for_emulated_loadsession_| for all calls
162 // |promise_id_for_emulated_loadsession_| is used to keep track of the
163 // original LoadSession() promise, as it is not resolved until the
164 // UpdateSession() call succeeds.
165 // TODO(xhwang): Extract testing code from main implementation.
166 // See http://crbug.com/341751
167 std::string session_id_for_emulated_loadsession_;
168 uint32_t promise_id_for_emulated_loadsession_;
170 // Timer delay in milliseconds for the next host_->SetTimer() call.
171 int64 timer_delay_ms_;
173 // Indicates whether a heartbeat timer has been set to prevent multiple timers
175 bool heartbeat_timer_set_;
177 #if defined(CLEAR_KEY_CDM_USE_FAKE_AUDIO_DECODER)
179 int bits_per_channel_;
180 int samples_per_second_;
181 int64 output_timestamp_base_in_microseconds_;
182 int total_samples_generated_;
183 #endif // CLEAR_KEY_CDM_USE_FAKE_AUDIO_DECODER
185 #if defined(CLEAR_KEY_CDM_USE_FFMPEG_DECODER)
186 scoped_ptr<FFmpegCdmAudioDecoder> audio_decoder_;
187 #endif // CLEAR_KEY_CDM_USE_FFMPEG_DECODER
189 scoped_ptr<CdmVideoDecoder> video_decoder_;
191 scoped_ptr<FileIOTestRunner> file_io_test_runner_;
193 DISALLOW_COPY_AND_ASSIGN(ClearKeyCdm);
198 #endif // MEDIA_CDM_PPAPI_EXTERNAL_CLEAR_KEY_CLEAR_KEY_CDM_H_