1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef THIRD_PARTY_BLINK_RENDERER_MODULES_MEDIASTREAM_MEDIA_DEVICES_H_
#define THIRD_PARTY_BLINK_RENDERER_MODULES_MEDIASTREAM_MEDIA_DEVICES_H_
#include "base/functional/callback.h"
#include "base/gtest_prod_util.h"
#include "base/sequence_checker.h"
#include "build/build_config.h"
#include "third_party/blink/public/mojom/mediastream/media_devices.mojom-blink.h"
#include "third_party/blink/renderer/bindings/core/v8/active_script_wrappable.h"
#include "third_party/blink/renderer/bindings/core/v8/idl_types.h"
#include "third_party/blink/renderer/bindings/core/v8/script_promise_resolver.h"
#include "third_party/blink/renderer/bindings/core/v8/script_promise_resolver_with_tracker.h"
#include "third_party/blink/renderer/core/dom/element.h"
#include "third_party/blink/renderer/core/dom/events/event_target.h"
#include "third_party/blink/renderer/core/execution_context/execution_context_lifecycle_observer.h"
#include "third_party/blink/renderer/modules/event_target_modules.h"
#include "third_party/blink/renderer/modules/mediastream/media_device_info.h"
#include "third_party/blink/renderer/modules/mediastream/media_stream_track.h"
#include "third_party/blink/renderer/modules/mediastream/sub_capture_target.h"
#include "third_party/blink/renderer/modules/mediastream/user_media_request.h"
#include "third_party/blink/renderer/modules/modules_export.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_hash_map.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_hash_set.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_vector.h"
#include "third_party/blink/renderer/platform/mojo/heap_mojo_receiver.h"
#include "third_party/blink/renderer/platform/mojo/heap_mojo_remote.h"
#include "third_party/blink/renderer/platform/scheduler/public/post_cancellable_task.h"
#include "third_party/blink/renderer/platform/supplementable.h"
namespace blink {
class AudioOutputOptions;
class CaptureHandleConfig;
class CropTarget;
class DisplayMediaStreamOptions;
class ExceptionState;
class LocalFrame;
class Navigator;
class ScopedMediaStreamTracer;
class MediaTrackSupportedConstraints;
class RestrictionTarget;
class ScriptState;
class UserMediaStreamConstraints;
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class EnumerateDevicesResult {
kOk = 0,
kUnknownError = 1,
kErrorCaptureServiceCrash = 2,
kErrorMediaDevicesDispatcherHostDisconnected = 3,
kTimedOut = 4,
kMaxValue = kTimedOut
};
enum class AudioOutputSelectionResult {
kSuccess = 0,
kPermissionDenied = 1,
kNoDevices = 2,
kNoUserActivation = 3,
kOtherError = 4,
kTimedOut = 5,
kNotSupported = 6,
kMaxValue = kNotSupported
};
class MODULES_EXPORT MediaDevices final
: public EventTarget,
public ActiveScriptWrappable<MediaDevices>,
public Supplement<Navigator>,
public ExecutionContextLifecycleObserver,
public mojom::blink::MediaDevicesListener {
DEFINE_WRAPPERTYPEINFO();
public:
using SubCaptureTargetType = media::mojom::blink::SubCaptureTargetType;
static const char kSupplementName[];
static MediaDevices* mediaDevices(Navigator&);
explicit MediaDevices(Navigator&);
~MediaDevices() override;
ScriptPromise<IDLSequence<MediaDeviceInfo>> enumerateDevices(ScriptState*,
ExceptionState&);
MediaTrackSupportedConstraints* getSupportedConstraints() const;
ScriptPromise<MediaStream> getUserMedia(ScriptState*,
const UserMediaStreamConstraints*,
ExceptionState&);
ScriptPromise<IDLSequence<MediaStream>> getAllScreensMedia(ScriptState*,
ExceptionState&);
ScriptPromise<MediaStream> getDisplayMedia(ScriptState*,
const DisplayMediaStreamOptions*,
ExceptionState&);
ScriptPromise<MediaDeviceInfo> selectAudioOutput(
ScriptState*,
const AudioOutputOptions* options,
ExceptionState&);
void setCaptureHandleConfig(ScriptState*,
const CaptureHandleConfig*,
ExceptionState&);
ScriptPromise<IDLUndefined> setPreferredSinkId(ScriptState*,
const String& sink_id,
ExceptionState&);
// Allow the factory methods for SubCaptureTarget subtypes to communicate
// with the browser process through the mojom pipe that `this` owns.
// TODO(crbug.com/1332628): Move most of the logic into
// sub_capture_target.cc/h, leaving only communication in MediaDevices.
ScriptPromise<CropTarget> ProduceCropTarget(ScriptState*,
Element*,
ExceptionState&);
ScriptPromise<RestrictionTarget> ProduceRestrictionTarget(ScriptState*,
Element*,
ExceptionState&);
// EventTarget overrides.
const AtomicString& InterfaceName() const override;
ExecutionContext* GetExecutionContext() const override;
void RemoveAllEventListeners() override;
// ScriptWrappable
bool HasPendingActivity() const override;
// ExecutionContextLifecycleObserver overrides.
void ContextDestroyed() override;
// mojom::blink::MediaDevicesListener implementation.
void OnDevicesChanged(mojom::blink::MediaDeviceType,
const Vector<WebMediaDeviceInfo>&) override;
void MaybeFireDeviceChangeEvent(bool has_permission);
void SetDispatcherHostForTesting(
mojo::PendingRemote<mojom::blink::MediaDevicesDispatcherHost>);
void Trace(Visitor*) const override;
DEFINE_ATTRIBUTE_EVENT_LISTENER(devicechange, kDevicechange)
protected:
// EventTarget overrides.
void AddedEventListener(const AtomicString& event_type,
RegisteredEventListener&) override;
void RemovedEventListener(const AtomicString& event_type,
const RegisteredEventListener&) override;
private:
FRIEND_TEST_ALL_PREFIXES(MediaDevicesTest, ObserveDeviceChangeEvent);
template <typename IDLResolvedType>
ScriptPromise<IDLResolvedType> SendUserMediaRequest(
UserMediaRequestType,
ScriptPromiseResolverWithTracker<UserMediaRequestResult,
IDLResolvedType>*,
const MediaStreamConstraints*,
ExceptionState&,
std::unique_ptr<ScopedMediaStreamTracer> tracer);
void ScheduleDispatchEvent(Event*);
void DispatchScheduledEvents();
void StartObserving();
void FinalizeStartObserving(
const Vector<Vector<WebMediaDeviceInfo>>& enumeration,
Vector<mojom::blink::VideoInputDeviceCapabilitiesPtr>
video_input_capabilities,
Vector<mojom::blink::AudioInputDeviceCapabilitiesPtr>
audio_input_capabilities);
void StopObserving();
void DevicesEnumerated(ScriptPromiseResolverWithTracker<
EnumerateDevicesResult,
IDLSequence<MediaDeviceInfo>>* result_tracker,
std::unique_ptr<ScopedMediaStreamTracer> tracer,
const Vector<Vector<WebMediaDeviceInfo>>&,
Vector<mojom::blink::VideoInputDeviceCapabilitiesPtr>,
Vector<mojom::blink::AudioInputDeviceCapabilitiesPtr>);
void OnDispatcherHostConnectionError();
mojom::blink::MediaDevicesDispatcherHost& GetDispatcherHost(LocalFrame*);
void SetPreferredSinkIdResultReceived(
const String& sink_id,
ScriptPromiseResolver<IDLUndefined>* resolver,
media::mojom::blink::OutputDeviceStatus status);
void OnSelectAudioOutputResult(
ScriptPromiseResolverWithTracker<AudioOutputSelectionResult,
MediaDeviceInfo>* resolver,
mojom::blink::SelectAudioOutputResultPtr result);
#if !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS)
// Manage the window of opportunity that occurs immediately after
// display-capture starts. The application can call
// CaptureController.setFocusBehavior() on the microtask where the
// Promise<MediaStream> was resolved; later calls raise an exception.
// |id| identifies the source, and therefore the track, on the browser-side.
void EnqueueMicrotaskToCloseFocusWindowOfOpportunity(const String&,
CaptureController*);
void CloseFocusWindowOfOpportunity(const String&, CaptureController*);
bool MayProduceSubCaptureTarget(ScriptState* script_state,
Element* element,
ExceptionState& exception_state,
SubCaptureTarget::Type type);
// Callbacks for receiving a message from the browser process with
// the base::Token which is backing a SubCaptureTarget (either CropTarget
// or RestrictionTarget).
void ResolveCropTargetPromise(Element* element, const WTF::String& id);
void ResolveRestrictionTargetPromise(Element* element, const WTF::String& id);
#endif
SEQUENCE_CHECKER(sequence_checker_);
// True if the associated execution context is alive and valid, reset
// immediately before the execution context is destroyed.
bool is_execution_context_active_;
// Async runner may be null when there is no valid execution context.
// No async work may be posted in this scenario.
TaskHandle dispatch_scheduled_events_task_handle_;
HeapVector<Member<Event>> scheduled_events_;
HeapMojoRemote<mojom::blink::MediaDevicesDispatcherHost> dispatcher_host_;
HeapMojoReceiver<mojom::blink::MediaDevicesListener, MediaDevices> receiver_;
HeapHashSet<
Member<ScriptPromiseResolverWithTracker<EnumerateDevicesResult,
IDLSequence<MediaDeviceInfo>>>>
enumerate_device_requests_;
#if !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS)
using ElementToCropTargetResolverMap =
HeapHashMap<Member<Element>, Member<ScriptPromiseResolver<CropTarget>>>;
using ElementToRestrictionTargetResolverMap =
HeapHashMap<Member<Element>,
Member<ScriptPromiseResolver<RestrictionTarget>>>;
// 1. When CropTarget.fromElement() is first called for an Element,
// it has no CropTarget associated with it, and similarly for
// RestrictionTarget.fromElement(). For either of these, we produce
// a Resolver, map the Element to it, and fire off a message to
// the browser process, asking for a new base::Token to be generated.
// This base::Token, once produced, will serve as the underlying
// implementation of the CropTarget/RestrictionTarget object to which
// the Promise will be resolved.
// 2. Subsequent calls to X.fromElement() which occur before the browser
// process has had time to respond, yield a copy of the original Promise
// associated with this Element. (Distinctly for either X=CropTarget
// and X=RestrictionTarget.)
// 3. When the browser process responds with a base::Token, we store it
// on the Element itself, resolve all Promises returned for this Element,
// and eject the resolver from this container. (Note again that CropTarget
// and RestrictionTarget are handled separately here.)
// 4. Later calls to X.fromElement() for this given Element discover that
// a token has already been assigned. They immediately return a resolved
// Promise with the relevant token.
ElementToCropTargetResolverMap crop_target_resolvers_;
ElementToRestrictionTargetResolverMap restriction_target_resolvers_;
#endif
bool starting_observation_ = false;
Vector<Vector<WebMediaDeviceInfo>> current_device_infos_;
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_MODULES_MEDIASTREAM_MEDIA_DEVICES_H_
|
