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
content / browser / renderer_host / media / media_stream_ui_proxy.h [blame]
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_BROWSER_RENDERER_HOST_MEDIA_MEDIA_STREAM_UI_PROXY_H_
#define CONTENT_BROWSER_RENDERER_HOST_MEDIA_MEDIA_STREAM_UI_PROXY_H_
#include <memory>
#include "base/functional/callback.h"
#include "base/memory/weak_ptr.h"
#include "build/build_config.h"
#include "content/common/content_export.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/desktop_media_id.h"
#include "content/public/browser/media_stream_request.h"
#include "third_party/blink/public/common/mediastream/media_stream_request.h"
#include "third_party/blink/public/mojom/mediastream/media_stream.mojom-shared.h"
#include "ui/gfx/geometry/rect.h"
#include "ui/gfx/native_widget_types.h"
namespace content {
struct MediaStreamRequest;
class RenderFrameHostDelegate;
// MediaStreamUIProxy proxies calls to media stream UI between IO thread and UI
// thread. One instance of this class is created per MediaStream object. It must
// be created, used and destroyed on the IO thread.
class CONTENT_EXPORT MediaStreamUIProxy {
public:
using ResponseCallback = base::OnceCallback<void(
const blink::mojom::StreamDevicesSet& stream_devices_set,
blink::mojom::MediaStreamRequestResult result)>;
using WindowIdCallback =
base::OnceCallback<void(gfx::NativeViewId window_id)>;
static std::unique_ptr<MediaStreamUIProxy> Create();
static std::unique_ptr<MediaStreamUIProxy> CreateForTests(
RenderFrameHostDelegate* render_delegate);
MediaStreamUIProxy(const MediaStreamUIProxy&) = delete;
MediaStreamUIProxy& operator=(const MediaStreamUIProxy&) = delete;
virtual ~MediaStreamUIProxy();
// Requests access for the MediaStream by calling
// WebContentsDelegate::RequestMediaAccessPermission(). The specified
// |response_callback| is called when the WebContentsDelegate approves or
// denies request.
virtual void RequestAccess(std::unique_ptr<MediaStreamRequest> request,
ResponseCallback response_callback);
// Notifies the UI that the MediaStream has started. Must be called after
// access has been approved using RequestAccess().
// |stop_callback| is called on the IO thread when the user requests to stop
// the stream or when it needs to be stopped due to admin policies to protect
// confidential data from being shared. |source_callback| is called on the IO
// thread after the user has requests the stream source to be changed.
// |window_id_callback| is called on the IO thread with the platform-
// dependent window ID of the UI.
// |label| is the unique label of the stream's request.
// |screen_share_ids| is a list of media IDs of the started desktop captures.
// |state_change_callback| is called on the IO thread when the stream should
// be paused on unpaused.
virtual void OnStarted(
base::OnceClosure stop_callback,
MediaStreamUI::SourceCallback source_callback,
WindowIdCallback window_id_callback,
const std::string& label,
std::vector<DesktopMediaID> screen_share_ids,
MediaStreamUI::StateChangeCallback state_change_callback);
// Notifies the UI that the MediaStream is being stopped.
// |label| is the unique label of the stream's request.
// |media_id| is the media ID of the capture that's being stopped.
virtual void OnDeviceStopped(const std::string& label,
const DesktopMediaID& media_id);
// Notifies the UI that the MediaStream is being stopped, similar to
// OnDeviceStopped(), but also notifies (on ChromeOS devices) the DLP module
// that the source for an existing stream is being changed. |label| is the
// unique label of the stream's request. |media_id| is the old media ID of the
// capture that's being stopped.
virtual void OnDeviceStoppedForSourceChange(
const std::string& label,
const DesktopMediaID& old_media_id,
const DesktopMediaID& new_media_id,
bool captured_surface_control_active);
virtual void OnRegionCaptureRectChanged(
const std::optional<gfx::Rect>& region_capture_rect);
#if !BUILDFLAG(IS_ANDROID)
// Determines whether the captured display surface represented by |media_id|
// should be focused or not.
// Only the first call to this method on a given object has an effect; the
// rest are ignored.
//
// |is_from_microtask| and |is_from_timer| are used to distinguish:
// a. Explicit calls from the Web-application.
// b. Implicit calls resulting from the focusability-window-closing microtask.
// c. The browser-side timer.
// This distinction is reflected by UMA.
virtual void SetFocus(const DesktopMediaID& media_id,
bool focus,
bool is_from_microtask,
bool is_from_timer);
#endif
protected:
explicit MediaStreamUIProxy(RenderFrameHostDelegate* test_render_delegate);
private:
class Core;
friend class Core;
friend class FakeMediaStreamUIProxy;
void ProcessAccessRequestResponse(
blink::mojom::StreamDevicesSetPtr stream_devices_set,
blink::mojom::MediaStreamRequestResult result);
void ProcessStopRequestFromUI();
void ProcessChangeSourceRequestFromUI(const DesktopMediaID& media_id,
bool captured_surface_control_active);
void ProcessStateChangeFromUI(const DesktopMediaID& media_id,
blink::mojom::MediaStreamStateChange new_state);
void OnWindowId(WindowIdCallback window_id_callback,
gfx::NativeViewId* window_id);
std::unique_ptr<Core, content::BrowserThread::DeleteOnUIThread> core_;
ResponseCallback response_callback_;
base::OnceClosure stop_callback_;
MediaStreamUI::SourceCallback source_callback_;
MediaStreamUI::StateChangeCallback state_change_callback_;
base::WeakPtrFactory<MediaStreamUIProxy> weak_factory_{this};
};
class CONTENT_EXPORT FakeMediaStreamUIProxy : public MediaStreamUIProxy {
public:
// Set |tests_use_fake_render_frame_hosts| to false if the test that's
// creating the FakeMediaStreamUIProxy creates real RFH objects or true if it
// just passes in dummy IDs to refer to RFHs.
explicit FakeMediaStreamUIProxy(bool tests_use_fake_render_frame_hosts);
FakeMediaStreamUIProxy(const FakeMediaStreamUIProxy&) = delete;
FakeMediaStreamUIProxy& operator=(const FakeMediaStreamUIProxy&) = delete;
~FakeMediaStreamUIProxy() override;
void SetAvailableDevices(const blink::MediaStreamDevices& devices);
void SetMicAccess(bool access);
void SetCameraAccess(bool access);
void SetAudioShare(bool audio_share);
// MediaStreamUIProxy overrides.
void RequestAccess(std::unique_ptr<MediaStreamRequest> request,
ResponseCallback response_callback) override;
void OnStarted(
base::OnceClosure stop_callback,
MediaStreamUI::SourceCallback source_callback,
WindowIdCallback window_id_callback,
const std::string& label,
std::vector<DesktopMediaID> screen_share_ids,
MediaStreamUI::StateChangeCallback state_change_callback) override;
void OnDeviceStopped(const std::string& label,
const DesktopMediaID& media_id) override;
void OnDeviceStoppedForSourceChange(
const std::string& label,
const DesktopMediaID& old_media_id,
const DesktopMediaID& new_media_id,
bool captured_surface_control_active) override;
private:
// This is used for RequestAccess().
// TODO(crbug.com/40220802): Use blink::mojom::StreamDevices instead of
// blink::MediaStreamDevices.
blink::MediaStreamDevices devices_;
// These are used for CheckAccess().
bool mic_access_ = true;
bool camera_access_ = true;
bool audio_share_ = true;
};
} // namespace content
#endif // CONTENT_BROWSER_RENDERER_HOST_MEDIA_MEDIA_STREAM_UI_PROXY_H_