8d12a018e5ac4a89d37bb52c425a74bb50ac1566
[WebKit-https.git] / Source / WebCore / platform / encryptedmedia / CDMInstanceSession.h
1 /*
2  * Copyright (C) 2018 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)
29
30 #include "CDMKeyStatus.h"
31 #include "CDMMessageType.h"
32 #include "CDMSessionType.h"
33 #include <wtf/CompletionHandler.h>
34 #include <wtf/RefCounted.h>
35 #include <wtf/Vector.h>
36 #include <wtf/WeakPtr.h>
37
38 namespace WebCore {
39
40 class SharedBuffer;
41
42 class CDMInstanceSessionClient {
43 public:
44     virtual ~CDMInstanceSessionClient() = default;
45
46     using KeyStatus = CDMKeyStatus;
47     using KeyStatusVector = Vector<std::pair<Ref<SharedBuffer>, KeyStatus>>;
48     virtual void updateKeyStatuses(KeyStatusVector&&) = 0;
49     virtual void sendMessage(CDMMessageType, Ref<SharedBuffer>&& message) = 0;
50     virtual void sessionIdChanged(const String&) = 0;
51 };
52
53 class CDMInstanceSession : public RefCounted<CDMInstanceSession> {
54 public:
55     virtual ~CDMInstanceSession() = default;
56
57     using KeyStatus = CDMKeyStatus;
58     using LicenseType = CDMSessionType;
59     using MessageType = CDMMessageType;
60
61     virtual void setClient(WeakPtr<CDMInstanceSessionClient>&&) { }
62     virtual void clearClient() { }
63
64     enum SuccessValue {
65         Failed,
66         Succeeded,
67     };
68
69     using LicenseCallback = CompletionHandler<void(Ref<SharedBuffer>&& message, const String& sessionId, bool needsIndividualization, SuccessValue succeeded)>;
70     virtual void requestLicense(LicenseType, const AtomicString& initDataType, Ref<SharedBuffer>&& initData, LicenseCallback&&) = 0;
71
72     using KeyStatusVector = CDMInstanceSessionClient::KeyStatusVector;
73     using Message = std::pair<MessageType, Ref<SharedBuffer>>;
74     using LicenseUpdateCallback = CompletionHandler<void(bool sessionWasClosed, Optional<KeyStatusVector>&& changedKeys, Optional<double>&& changedExpiration, Optional<Message>&& message, SuccessValue succeeded)>;
75     virtual void updateLicense(const String& sessionId, LicenseType, const SharedBuffer& response, LicenseUpdateCallback&&) = 0;
76
77     enum class SessionLoadFailure {
78         None,
79         NoSessionData,
80         MismatchedSessionType,
81         QuotaExceeded,
82         Other,
83     };
84
85     using LoadSessionCallback = CompletionHandler<void(Optional<KeyStatusVector>&&, Optional<double>&&, Optional<Message>&&, SuccessValue, SessionLoadFailure)>;
86     virtual void loadSession(LicenseType, const String& sessionId, const String& origin, LoadSessionCallback&&) = 0;
87
88     using CloseSessionCallback = CompletionHandler<void()>;
89     virtual void closeSession(const String& sessionId, CloseSessionCallback&&) = 0;
90
91     using RemoveSessionDataCallback = CompletionHandler<void(KeyStatusVector&&, Optional<Ref<SharedBuffer>>&&, SuccessValue)>;
92     virtual void removeSessionData(const String& sessionId, LicenseType, RemoveSessionDataCallback&&) = 0;
93
94     virtual void storeRecordOfKeyUsage(const String& sessionId) = 0;
95 };
96
97 } // namespace WebCore
98
99 #define SPECIALIZE_TYPE_TRAITS_CDM_INSTANCE(ToValueTypeName, ImplementationTypeName) \
100 SPECIALIZE_TYPE_TRAITS_BEGIN(ToValueTypeName) \
101 static bool isType(const WebCore::CDMInstance& instance) { return instance.implementationType() == ImplementationTypeName; } \
102 SPECIALIZE_TYPE_TRAITS_END()
103
104 #endif