5395eb8482f8c74d5dc0d6c5930d49a226720a3f
[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 "IDLTypes.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 template<typename IDLType> class DOMPromiseDeferred;
56
57 class MediaDevices final : public RefCounted<MediaDevices>, public ActiveDOMObject, public EventTargetWithInlineData, public CanMakeWeakPtr<MediaDevices> {
58     WTF_MAKE_ISO_ALLOCATED(MediaDevices);
59 public:
60     static Ref<MediaDevices> create(Document&);
61
62     ~MediaDevices();
63
64     Document* document() const;
65
66     using Promise = DOMPromiseDeferred<IDLInterface<MediaStream>>;
67     using EnumerateDevicesPromise = DOMPromiseDeferred<IDLSequence<IDLInterface<MediaDeviceInfo>>>;
68
69     enum class DisplayCaptureSurfaceType {
70         Monitor,
71         Window,
72         Application,
73         Browser,
74     };
75
76     struct StreamConstraints {
77         Variant<bool, MediaTrackConstraints> video;
78         Variant<bool, MediaTrackConstraints> audio;
79     };
80     void getUserMedia(const StreamConstraints&, Promise&&) const;
81     void getDisplayMedia(const StreamConstraints&, Promise&&) const;
82     void enumerateDevices(EnumerateDevicesPromise&&);
83     MediaTrackSupportedConstraints getSupportedConstraints();
84
85     using RefCounted<MediaDevices>::ref;
86     using RefCounted<MediaDevices>::deref;
87
88     void setDisableGetDisplayMediaUserGestureConstraint(bool value) { m_disableGetDisplayMediaUserGestureConstraint = value; }
89
90 private:
91     explicit MediaDevices(Document&);
92
93     void scheduledEventTimerFired();
94     bool addEventListener(const AtomString& eventType, Ref<EventListener>&&, const AddEventListenerOptions&) override;
95
96     void refreshDevices(const Vector<CaptureDevice>&);
97     void listenForDeviceChanges();
98
99     friend class JSMediaDevicesOwner;
100
101     // ActiveDOMObject
102     const char* activeDOMObjectName() const final;
103     void stop() final;
104     bool hasPendingActivity() const final;
105
106     // EventTargetWithInlineData.
107     EventTargetInterface eventTargetInterface() const final { return MediaDevicesEventTargetInterfaceType; }
108     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
109     void refEventTarget() final { ref(); }
110     void derefEventTarget() final { deref(); }
111
112     Timer m_scheduledEventTimer;
113     UserMediaClient::DeviceChangeObserverToken m_deviceChangeToken;
114     const EventNames& m_eventNames; // Need to cache this so we can use it from GC threads.
115     bool m_listeningForDeviceChanges { false };
116     bool m_disableGetDisplayMediaUserGestureConstraint { false };
117
118     Vector<Ref<MediaDeviceInfo>> m_devices;
119     bool m_canAccessCamera { false };
120     bool m_canAccessMicrophone { false };
121 };
122
123 } // namespace WebCore
124
125 #endif // ENABLE(MEDIA_STREAM)