7b2c7ca971d629557b11ad8350f7470609ef9160
[WebKit-https.git] / Source / WebCore / Modules / mediastream / MediaDevices.h
1 /*
2  * Copyright (C) 2015 Ericsson AB. All rights reserved.
3  * Copyright (C) 2016-2018 Apple Inc. All rights reserved.
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 copyright
12  *    notice, this list of conditions and the following disclaimer
13  *    in the documentation and/or other materials provided with the
14  *    distribution.
15  * 3. Neither the name of Ericsson nor the names of its contributors
16  *    may be used to endorse or promote products derived from this
17  *    software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #pragma once
33
34 #if ENABLE(MEDIA_STREAM)
35
36 #include "ActiveDOMObject.h"
37 #include "EventNames.h"
38 #include "EventTarget.h"
39 #include "ExceptionOr.h"
40 #include "JSDOMPromiseDeferred.h"
41 #include "MediaTrackConstraints.h"
42 #include "RealtimeMediaSourceCenter.h"
43 #include "Timer.h"
44 #include "UserMediaClient.h"
45 #include <wtf/WeakPtr.h>
46
47 namespace WebCore {
48
49 class Document;
50 class MediaDeviceInfo;
51 class MediaStream;
52
53 struct MediaTrackSupportedConstraints;
54
55 class MediaDevices : public RefCounted<MediaDevices>, public ActiveDOMObject, public EventTargetWithInlineData, public CanMakeWeakPtr<MediaDevices> {
56 public:
57     static Ref<MediaDevices> create(Document&);
58
59     ~MediaDevices();
60
61     Document* document() const;
62
63     using Promise = DOMPromiseDeferred<IDLInterface<MediaStream>>;
64     using EnumerateDevicesPromise = DOMPromiseDeferred<IDLSequence<IDLInterface<MediaDeviceInfo>>>;
65
66     enum class DisplayCaptureSurfaceType {
67         Monitor,
68         Window,
69         Application,
70         Browser,
71     };
72
73     struct StreamConstraints {
74         Variant<bool, MediaTrackConstraints> video;
75         Variant<bool, MediaTrackConstraints> audio;
76     };
77     ExceptionOr<void> getUserMedia(const StreamConstraints&, Promise&&) const;
78     ExceptionOr<void> getDisplayMedia(const StreamConstraints&, Promise&&) const;
79     void enumerateDevices(EnumerateDevicesPromise&&) const;
80     MediaTrackSupportedConstraints getSupportedConstraints();
81
82     using RefCounted<MediaDevices>::ref;
83     using RefCounted<MediaDevices>::deref;
84
85 private:
86     explicit MediaDevices(Document&);
87
88     void scheduledEventTimerFired();
89     bool addEventListener(const AtomicString& eventType, Ref<EventListener>&&, const AddEventListenerOptions&) override;
90
91     friend class JSMediaDevicesOwner;
92
93     // ActiveDOMObject
94     const char* activeDOMObjectName() const final;
95     bool canSuspendForDocumentSuspension() const final;
96     void stop() final;
97     bool hasPendingActivity() const final;
98
99     // EventTargetWithInlineData.
100     EventTargetInterface eventTargetInterface() const final { return MediaDevicesEventTargetInterfaceType; }
101     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
102     void refEventTarget() final { ref(); }
103     void derefEventTarget() final { deref(); }
104
105     Timer m_scheduledEventTimer;
106     UserMediaClient::DeviceChangeObserverToken m_deviceChangeToken;
107     const EventNames& m_eventNames; // Need to cache this so we can use it from GC threads.
108     bool m_listeningForDeviceChanges { false };
109 };
110
111 } // namespace WebCore
112
113 #endif // ENABLE(MEDIA_STREAM)