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