Gitiles
Code Review Sign In
gerrit.omnirom.org / android_frameworks_av / a55209dcdf9e4a17373be384e8b02ec88d998dac / . / drm / libmediadrm / include / mediadrm / DrmHalHidl.h
blob: 94ef28529f942e20b31cd92e31cfe0919b177f04 [file] [log] [blame]
Kyle Zhang6605add2022-01-13 17:51:23 +0000[diff] [blame]1/*
2 * Copyright (C) 2021 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_HAL_HIDL_H_
18#define DRM_HAL_HIDL_H_
19
Kyle Zhang6605add2022-01-13 17:51:23 +0000[diff] [blame]20#include <android/hardware/drm/1.2/IDrmFactory.h>
21#include <android/hardware/drm/1.2/IDrmPlugin.h>
22#include <android/hardware/drm/1.2/IDrmPluginListener.h>
23#include <android/hardware/drm/1.4/IDrmPlugin.h>
24#include <android/hardware/drm/1.4/types.h>
25
26#include <media/drm/DrmAPI.h>
27#include <mediadrm/DrmMetrics.h>
28#include <mediadrm/DrmSessionManager.h>
29#include <mediadrm/IDrm.h>
30#include <mediadrm/IDrmClient.h>
31#include <mediadrm/IDrmMetricsConsumer.h>
32#include <utils/threads.h>
33
34namespace drm = ::android::hardware::drm;
35using drm::V1_0::EventType;
36using drm::V1_0::IDrmFactory;
37using drm::V1_0::IDrmPlugin;
38using drm::V1_0::IDrmPluginListener;
39using drm::V1_1::SecurityLevel;
40using drm::V1_2::KeyStatus;
41using drm::V1_2::OfflineLicenseState;
42using ::android::hardware::hidl_vec;
43using ::android::hardware::Return;
44using ::android::hardware::Void;
45
46typedef drm::V1_2::IDrmPluginListener IDrmPluginListener_V1_2;
47typedef drm::V1_0::KeyStatus KeyStatus_V1_0;
48
49namespace android {
50
51struct DrmSessionClientInterface;
52
53inline bool operator==(const Vector<uint8_t> &l, const Vector<uint8_t> &r) {
54 if (l.size() != r.size()) return false;
55 return memcmp(l.array(), r.array(), l.size()) == 0;
56}
57
58struct DrmHalHidl : public IDrm,
59 public IDrmPluginListener_V1_2 {
60
61 struct DrmSessionClient;
62
63 DrmHalHidl();
64 virtual ~DrmHalHidl();
65
66 virtual status_t initCheck() const;
67
68 virtual status_t isCryptoSchemeSupported(const uint8_t uuid[16],
69 const String8& mimeType,
70 DrmPlugin::SecurityLevel level,
71 bool *isSupported);
72
73 virtual status_t createPlugin(const uint8_t uuid[16],
74 const String8 &appPackageName);
75
76 virtual status_t destroyPlugin();
77
78 virtual status_t openSession(DrmPlugin::SecurityLevel level,
79 Vector<uint8_t> &sessionId);
80
81 virtual status_t closeSession(Vector<uint8_t> const &sessionId);
82
83 virtual status_t
84 getKeyRequest(Vector<uint8_t> const &sessionId,
85 Vector<uint8_t> const &initData,
86 String8 const &mimeType, DrmPlugin::KeyType keyType,
87 KeyedVector<String8, String8> const &optionalParameters,
88 Vector<uint8_t> &request, String8 &defaultUrl,
89 DrmPlugin::KeyRequestType *keyRequestType);
90
91 virtual status_t provideKeyResponse(Vector<uint8_t> const &sessionId,
92 Vector<uint8_t> const &response,
93 Vector<uint8_t> &keySetId);
94
95 virtual status_t removeKeys(Vector<uint8_t> const &keySetId);
96
97 virtual status_t restoreKeys(Vector<uint8_t> const &sessionId,
98 Vector<uint8_t> const &keySetId);
99
100 virtual status_t queryKeyStatus(Vector<uint8_t> const &sessionId,
101 KeyedVector<String8, String8> &infoMap) const;
102
103 virtual status_t getProvisionRequest(String8 const &certType,
104 String8 const &certAuthority,
105 Vector<uint8_t> &request,
106 String8 &defaultUrl);
107
108 virtual status_t provideProvisionResponse(Vector<uint8_t> const &response,
109 Vector<uint8_t> &certificate,
110 Vector<uint8_t> &wrappedKey);
111
112 virtual status_t getSecureStops(List<Vector<uint8_t>> &secureStops);
113 virtual status_t getSecureStopIds(List<Vector<uint8_t>> &secureStopIds);
114 virtual status_t getSecureStop(Vector<uint8_t> const &ssid, Vector<uint8_t> &secureStop);
115
116 virtual status_t releaseSecureStops(Vector<uint8_t> const &ssRelease);
117 virtual status_t removeSecureStop(Vector<uint8_t> const &ssid);
118 virtual status_t removeAllSecureStops();
119
120 virtual status_t getHdcpLevels(DrmPlugin::HdcpLevel *connectedLevel,
121 DrmPlugin::HdcpLevel *maxLevel) const;
122 virtual status_t getNumberOfSessions(uint32_t *currentSessions,
123 uint32_t *maxSessions) const;
124 virtual status_t getSecurityLevel(Vector<uint8_t> const &sessionId,
125 DrmPlugin::SecurityLevel *level) const;
126
127 virtual status_t getOfflineLicenseKeySetIds(List<Vector<uint8_t>> &keySetIds) const;
128 virtual status_t removeOfflineLicense(Vector<uint8_t> const &keySetId);
129 virtual status_t getOfflineLicenseState(Vector<uint8_t> const &keySetId,
130 DrmPlugin::OfflineLicenseState *licenseState) const;
131
132 virtual status_t getPropertyString(String8 const &name, String8 &value ) const;
133 virtual status_t getPropertyByteArray(String8 const &name,
134 Vector<uint8_t> &value ) const;
135 virtual status_t setPropertyString(String8 const &name, String8 const &value ) const;
136 virtual status_t setPropertyByteArray(String8 const &name,
137 Vector<uint8_t> const &value ) const;
138 virtual status_t getMetrics(const sp<IDrmMetricsConsumer> &consumer);
139
140 virtual status_t setCipherAlgorithm(Vector<uint8_t> const &sessionId,
141 String8 const &algorithm);
142
143 virtual status_t setMacAlgorithm(Vector<uint8_t> const &sessionId,
144 String8 const &algorithm);
145
146 virtual status_t encrypt(Vector<uint8_t> const &sessionId,
147 Vector<uint8_t> const &keyId,
148 Vector<uint8_t> const &input,
149 Vector<uint8_t> const &iv,
150 Vector<uint8_t> &output);
151
152 virtual status_t decrypt(Vector<uint8_t> const &sessionId,
153 Vector<uint8_t> const &keyId,
154 Vector<uint8_t> const &input,
155 Vector<uint8_t> const &iv,
156 Vector<uint8_t> &output);
157
158 virtual status_t sign(Vector<uint8_t> const &sessionId,
159 Vector<uint8_t> const &keyId,
160 Vector<uint8_t> const &message,
161 Vector<uint8_t> &signature);
162
163 virtual status_t verify(Vector<uint8_t> const &sessionId,
164 Vector<uint8_t> const &keyId,
165 Vector<uint8_t> const &message,
166 Vector<uint8_t> const &signature,
167 bool &match);
168
169 virtual status_t signRSA(Vector<uint8_t> const &sessionId,
170 String8 const &algorithm,
171 Vector<uint8_t> const &message,
172 Vector<uint8_t> const &wrappedKey,
173 Vector<uint8_t> &signature);
174
175 virtual status_t setListener(const sp<IDrmClient>& listener);
176
177 virtual status_t requiresSecureDecoder(const char *mime, bool *required) const;
178
179 virtual status_t requiresSecureDecoder(const char *mime, DrmPlugin::SecurityLevel securityLevel,
180 bool *required) const;
181
182 virtual status_t setPlaybackId(
183 Vector<uint8_t> const &sessionId,
184 const char *playbackId);
185
186 virtual status_t getLogMessages(Vector<drm::V1_4::LogMessage> &logs) const;
187
188 // Methods of IDrmPluginListener
189 Return<void> sendEvent(EventType eventType,
190 const hidl_vec<uint8_t>& sessionId, const hidl_vec<uint8_t>& data);
191
192 Return<void> sendExpirationUpdate(const hidl_vec<uint8_t>& sessionId,
193 int64_t expiryTimeInMS);
194
195 Return<void> sendKeysChange(const hidl_vec<uint8_t>& sessionId,
196 const hidl_vec<KeyStatus_V1_0>& keyStatusList, bool hasNewUsableKey);
197
198 Return<void> sendKeysChange_1_2(const hidl_vec<uint8_t>& sessionId,
199 const hidl_vec<KeyStatus>& keyStatusList, bool hasNewUsableKey);
200
201 Return<void> sendSessionLostState(const hidl_vec<uint8_t>& sessionId);
202
203private:
204 static Mutex mLock;
205
206 sp<IDrmClient> mListener;
207 mutable Mutex mEventLock;
208 mutable Mutex mNotifyLock;
209
210 const std::vector<sp<IDrmFactory>> mFactories;
211 sp<IDrmPlugin> mPlugin;
212 sp<drm::V1_1::IDrmPlugin> mPluginV1_1;
213 sp<drm::V1_2::IDrmPlugin> mPluginV1_2;
214 sp<drm::V1_4::IDrmPlugin> mPluginV1_4;
215 String8 mAppPackageName;
216
217 // Mutable to allow modification within GetPropertyByteArray.
218 mutable MediaDrmMetrics mMetrics;
219
220 std::vector<std::shared_ptr<DrmSessionClient>> mOpenSessions;
221 void closeOpenSessions();
222 void cleanup();
223
224 /**
225 * mInitCheck is:
226 * NO_INIT if a plugin hasn't been created yet
227 * ERROR_UNSUPPORTED if a plugin can't be created for the uuid
228 * OK after a plugin has been created and mPlugin is valid
229 */
230 status_t mInitCheck;
231
232 std::vector<sp<IDrmFactory>> makeDrmFactories();
233 sp<IDrmPlugin> makeDrmPlugin(const sp<IDrmFactory>& factory,
234 const uint8_t uuid[16], const String8& appPackageName);
235
236 void writeByteArray(Parcel &obj, const hidl_vec<uint8_t>& array);
237
238 std::string reportPluginMetrics() const;
239 std::string reportFrameworkMetrics(const std::string& pluginMetrics) const;
240 status_t getPropertyStringInternal(String8 const &name, String8 &value) const;
241 status_t getPropertyByteArrayInternal(String8 const &name,
242 Vector<uint8_t> &value) const;
243 status_t matchMimeTypeAndSecurityLevel(const sp<IDrmFactory> &factory,
244 const uint8_t uuid[16],
245 const String8 &mimeType,
246 DrmPlugin::SecurityLevel level,
247 bool *isSupported);
248
249 DISALLOW_EVIL_CONSTRUCTORS(DrmHalHidl);
250};
251
252} // namespace android
253
Kyle Zhanga55209d2022-02-03 01:52:46 +0000[diff] [blame^]254#endif // DRM_HAL_HIDL_H_