823844fe42f4b9eba29e2650473aee41e7318115
[WebKit-https.git] / Source / WebCore / Modules / encryptedmedia / MediaKeySession.h
1 /*
2  * Copyright (C) 2016 Metrological Group B.V.
3  * Copyright (C) 2016 Igalia S.L.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above
12  *    copyright notice, this list of conditions and the following
13  *    disclaimer in the documentation and/or other materials provided
14  *    with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #pragma once
30
31 #if ENABLE(ENCRYPTED_MEDIA)
32
33 #include "ActiveDOMObject.h"
34 #include "CDMInstanceSession.h"
35 #include "EventTarget.h"
36 #include "GenericEventQueue.h"
37 #include "GenericTaskQueue.h"
38 #include "IDLTypes.h"
39 #include "MediaKeyMessageType.h"
40 #include "MediaKeySessionType.h"
41 #include "MediaKeyStatus.h"
42 #include <wtf/RefCounted.h>
43 #include <wtf/Vector.h>
44 #include <wtf/WeakPtr.h>
45 #include <wtf/text/WTFString.h>
46
47 namespace WebCore {
48
49 class BufferSource;
50 class CDM;
51 class DeferredPromise;
52 class MediaKeyStatusMap;
53 class MediaKeys;
54 class SharedBuffer;
55
56 template<typename IDLType> class DOMPromiseProxy;
57
58 class MediaKeySession final : public RefCounted<MediaKeySession>, public EventTargetWithInlineData, public ActiveDOMObject, public CDMInstanceSessionClient {
59     WTF_MAKE_ISO_ALLOCATED(MediaKeySession);
60 public:
61     static Ref<MediaKeySession> create(ScriptExecutionContext&, WeakPtr<MediaKeys>&&, MediaKeySessionType, bool useDistinctiveIdentifier, Ref<CDM>&&, Ref<CDMInstanceSession>&&);
62     virtual ~MediaKeySession();
63
64     using RefCounted<MediaKeySession>::ref;
65     using RefCounted<MediaKeySession>::deref;
66
67     bool isClosed() const { return m_closed; }
68
69     const String& sessionId() const;
70     double expiration() const;
71     Ref<MediaKeyStatusMap> keyStatuses() const;
72
73     void generateRequest(const AtomString&, const BufferSource&, Ref<DeferredPromise>&&);
74     void load(const String&, Ref<DeferredPromise>&&);
75     void update(const BufferSource&, Ref<DeferredPromise>&&);
76     void close(Ref<DeferredPromise>&&);
77     void remove(Ref<DeferredPromise>&&);
78
79     using ClosedPromise = DOMPromiseProxy<IDLVoid>;
80     ClosedPromise& closed() { return m_closedPromise.get(); }
81
82     const Vector<std::pair<Ref<SharedBuffer>, MediaKeyStatus>>& statuses() const { return m_statuses; }
83
84 private:
85     MediaKeySession(ScriptExecutionContext&, WeakPtr<MediaKeys>&&, MediaKeySessionType, bool useDistinctiveIdentifier, Ref<CDM>&&, Ref<CDMInstanceSession>&&);
86     void enqueueMessage(MediaKeyMessageType, const SharedBuffer&);
87     void updateExpiration(double);
88     void sessionClosed();
89     String mediaKeysStorageDirectory() const;
90
91     // CDMInstanceSessionClient
92     void updateKeyStatuses(CDMInstanceSessionClient::KeyStatusVector&&) override;
93     void sendMessage(CDMMessageType, Ref<SharedBuffer>&& message) final;
94     void sessionIdChanged(const String&) final;
95
96     // EventTarget
97     EventTargetInterface eventTargetInterface() const override { return MediaKeySessionEventTargetInterfaceType; }
98     ScriptExecutionContext* scriptExecutionContext() const override { return ActiveDOMObject::scriptExecutionContext(); }
99     void refEventTarget() override { ref(); }
100     void derefEventTarget() override { deref(); }
101
102     // ActiveDOMObject
103     bool hasPendingActivity() const override;
104     const char* activeDOMObjectName() const override;
105     bool canSuspendForDocumentSuspension() const override;
106     void stop() override;
107
108     WeakPtr<MediaKeys> m_keys;
109     String m_sessionId;
110     double m_expiration;
111     UniqueRef<ClosedPromise> m_closedPromise;
112     Ref<MediaKeyStatusMap> m_keyStatuses;
113     bool m_closed { false };
114     bool m_uninitialized { true };
115     bool m_callable { false };
116     bool m_useDistinctiveIdentifier;
117     MediaKeySessionType m_sessionType;
118     Ref<CDM> m_implementation;
119     Ref<CDMInstanceSession> m_instanceSession;
120     UniqueRef<MainThreadGenericEventQueue> m_eventQueue;
121     GenericTaskQueue<Timer> m_taskQueue;
122     Vector<Ref<SharedBuffer>> m_recordOfKeyUsage;
123     double m_firstDecryptTime { 0 };
124     double m_latestDecryptTime { 0 };
125     Vector<std::pair<Ref<SharedBuffer>, MediaKeyStatus>> m_statuses;
126 };
127
128 } // namespace WebCore
129
130 #endif // ENABLE(ENCRYPTED_MEDIA)