Add support for MediaKeys.createSession().
[WebKit-https.git] / Source / WebCore / Modules / encryptedmedia / CDM.h
1 /*
2  * Copyright (C) 2016 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 "ContextDestructionObserver.h"
31 #include "MediaKeySystemConfiguration.h"
32 #include <functional>
33 #include <wtf/HashSet.h>
34 #include <wtf/Ref.h>
35 #include <wtf/RefCounted.h>
36 #include <wtf/WeakPtr.h>
37 #include <wtf/text/WTFString.h>
38
39 namespace WebCore {
40
41 class CDM;
42 class CDMInstance;
43 class CDMPrivate;
44 class Document;
45 class ScriptExecutionContext;
46
47 struct MediaKeysRestrictions;
48
49 class CDMFactory {
50 public:
51     virtual ~CDMFactory() { };
52     virtual std::unique_ptr<CDMPrivate> createCDM(CDM&) = 0;
53     virtual bool supportsKeySystem(const String&) = 0;
54 };
55
56 class CDM : public RefCounted<CDM>, private ContextDestructionObserver {
57 public:
58     WEBCORE_EXPORT static void registerCDMFactory(CDMFactory&);
59     WEBCORE_EXPORT static void unregisterCDMFactory(CDMFactory&);
60
61     static bool supportsKeySystem(const String&);
62     static bool isPersistentType(MediaKeySessionType);
63
64     static Ref<CDM> create(Document&, const String& keySystem);
65     ~CDM();
66
67     using SupportedConfigurationCallback = std::function<void(std::optional<MediaKeySystemConfiguration>)>;
68     void getSupportedConfiguration(MediaKeySystemConfiguration&& candidateConfiguration, SupportedConfigurationCallback&&);
69
70     const String& keySystem() const { return m_keySystem; }
71
72     void loadAndInitialize();
73     RefPtr<CDMInstance> createInstance();
74     bool supportsServerCertificates() const;
75     bool supportsSessions() const;
76
77 private:
78     CDM(Document&, const String& keySystem);
79
80     enum class ConfigurationStatus {
81         Supported,
82         NotSupported,
83         ConsentDenied,
84     };
85
86     enum class ConsentStatus {
87         ConsentDenied,
88         InformUser,
89         Allowed,
90     };
91
92     enum class AudioVideoType {
93         Audio,
94         Video,
95     };
96
97     void doSupportedConfigurationStep(MediaKeySystemConfiguration&& candidateConfiguration, MediaKeysRestrictions&&, SupportedConfigurationCallback&&);
98     std::optional<MediaKeySystemConfiguration>  getSupportedConfiguration(const MediaKeySystemConfiguration& candidateConfiguration, MediaKeysRestrictions&);
99     std::optional<Vector<MediaKeySystemMediaCapability>> getSupportedCapabilitiesForAudioVideoType(AudioVideoType, const Vector<MediaKeySystemMediaCapability>& requestedCapabilities, const MediaKeySystemConfiguration& partialConfiguration, MediaKeysRestrictions&);
100
101     WeakPtr<CDM> createWeakPtr() { return m_weakPtrFactory.createWeakPtr(); }
102
103     using ConsentStatusCallback = std::function<void(ConsentStatus, MediaKeySystemConfiguration&&, MediaKeysRestrictions&&)>;
104     void getConsentStatus(MediaKeySystemConfiguration&& accumulatedConfiguration, MediaKeysRestrictions&&, ConsentStatusCallback&&);
105     String m_keySystem;
106     std::unique_ptr<CDMPrivate> m_private;
107     WeakPtrFactory<CDM> m_weakPtrFactory;
108 };
109
110 }
111
112 #endif