Rename AtomicString to AtomString
[WebKit-https.git] / Source / WebCore / platform / graphics / avfoundation / objc / CDMInstanceFairPlayStreamingAVFObjC.h
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(ENCRYPTED_MEDIA) && HAVE(AVCONTENTKEYSESSION)
29
30 #include "CDMInstance.h"
31 #include "CDMInstanceSession.h"
32 #include <wtf/Function.h>
33 #include <wtf/HashMap.h>
34 #include <wtf/RetainPtr.h>
35 #include <wtf/text/WTFString.h>
36
37 OBJC_CLASS AVContentKeyRequest;
38 OBJC_CLASS AVContentKeySession;
39 OBJC_CLASS NSData;
40 OBJC_CLASS NSError;
41 OBJC_CLASS NSURL;
42 OBJC_CLASS WebCoreFPSContentKeySessionDelegate;
43
44 namespace WebCore {
45
46 class CDMInstanceSessionFairPlayStreamingAVFObjC;
47 struct CDMMediaCapability;
48
49 class CDMInstanceFairPlayStreamingAVFObjC final : public CDMInstance, public CanMakeWeakPtr<CDMInstanceFairPlayStreamingAVFObjC> {
50 public:
51     virtual ~CDMInstanceFairPlayStreamingAVFObjC() = default;
52
53     static bool supportsPersistableState();
54     static bool supportsPersistentKeys();
55     static bool supportsMediaCapability(const CDMMediaCapability&);
56     static bool mimeTypeIsPlayable(const String&);
57
58     ImplementationType implementationType() const final { return ImplementationType::FairPlayStreaming; }
59
60     SuccessValue initializeWithConfiguration(const CDMKeySystemConfiguration&) final;
61     SuccessValue setDistinctiveIdentifiersAllowed(bool) final;
62     SuccessValue setPersistentStateAllowed(bool) final;
63     SuccessValue setServerCertificate(Ref<SharedBuffer>&&) final;
64     SuccessValue setStorageDirectory(const String&) final;
65     RefPtr<CDMInstanceSession> createSession() final;
66
67     const String& keySystem() const final;
68
69     NSURL *storageURL() const { return m_storageURL.get(); }
70     bool persistentStateAllowed() const { return m_persistentStateAllowed; }
71     SharedBuffer* serverCertificate() const { return m_serverCertificate.get(); }
72
73     void outputObscuredDueToInsufficientExternalProtectionChanged(bool);
74     CDMInstanceSessionFairPlayStreamingAVFObjC* sessionForKeyIDs(const Vector<Ref<SharedBuffer>>&) const;
75
76 private:
77     RefPtr<SharedBuffer> m_serverCertificate;
78     bool m_persistentStateAllowed { true };
79     RetainPtr<NSURL> m_storageURL;
80     Vector<WeakPtr<CDMInstanceSessionFairPlayStreamingAVFObjC>> m_sessions;
81 };
82
83 class CDMInstanceSessionFairPlayStreamingAVFObjC final : public CDMInstanceSession, public CanMakeWeakPtr<CDMInstanceSessionFairPlayStreamingAVFObjC> {
84 public:
85     CDMInstanceSessionFairPlayStreamingAVFObjC(Ref<CDMInstanceFairPlayStreamingAVFObjC>&&);
86     virtual ~CDMInstanceSessionFairPlayStreamingAVFObjC();
87
88     // CDMInstanceSession
89     void requestLicense(LicenseType, const AtomString& initDataType, Ref<SharedBuffer>&& initData, LicenseCallback&&) final;
90     void updateLicense(const String&, LicenseType, const SharedBuffer&, LicenseUpdateCallback&&) final;
91     void loadSession(LicenseType, const String&, const String&, LoadSessionCallback&&) final;
92     void closeSession(const String&, CloseSessionCallback&&) final;
93     void removeSessionData(const String&, LicenseType, RemoveSessionDataCallback&&) final;
94     void storeRecordOfKeyUsage(const String&) final;
95     void setClient(WeakPtr<CDMInstanceSessionClient>&&) final;
96     void clearClient() final;
97
98     void didProvideRequest(AVContentKeyRequest*);
99     void didProvideRenewingRequest(AVContentKeyRequest*);
100     void didProvidePersistableRequest(AVContentKeyRequest*);
101     void didFailToProvideRequest(AVContentKeyRequest*, NSError*);
102     void requestDidSucceed(AVContentKeyRequest*);
103     bool shouldRetryRequestForReason(AVContentKeyRequest*, NSString*);
104     void sessionIdentifierChanged(NSData*);
105     void outputObscuredDueToInsufficientExternalProtectionChanged(bool);
106
107     Vector<Ref<SharedBuffer>> keyIDs();
108     AVContentKeySession* contentKeySession() { return m_session.get(); }
109
110 private:
111     AVContentKeySession* ensureSession();
112     bool isLicenseTypeSupported(LicenseType) const;
113
114     KeyStatusVector keyStatuses() const;
115     void nextRequest();
116
117     Ref<CDMInstanceFairPlayStreamingAVFObjC> m_instance;
118     RetainPtr<AVContentKeySession> m_session;
119     RetainPtr<AVContentKeyRequest> m_currentRequest;
120     RetainPtr<WebCoreFPSContentKeySessionDelegate> m_delegate;
121     Vector<RetainPtr<NSData>> m_expiredSessions;
122     WeakPtr<CDMInstanceSessionClient> m_client;
123     String m_sessionId;
124     bool m_outputObscured { false };
125
126     Vector<RetainPtr<AVContentKeyRequest>> m_pendingRequests;
127     Vector<RetainPtr<AVContentKeyRequest>> m_requests;
128
129     LicenseCallback m_requestLicenseCallback;
130     LicenseUpdateCallback m_updateLicenseCallback;
131     CloseSessionCallback m_closeSessionCallback;
132     RemoveSessionDataCallback m_removeSessionDataCallback;
133 };
134
135 }
136
137 SPECIALIZE_TYPE_TRAITS_CDM_INSTANCE(WebCore::CDMInstanceFairPlayStreamingAVFObjC, WebCore::CDMInstance::ImplementationType::FairPlayStreaming)
138
139 #endif // ENABLE(ENCRYPTED_MEDIA) && HAVE(AVCONTENTKEYSESSION)