Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef CONTENT_RENDERER_MEDIA_MEDIA_STREAM_IMPL_H_ |
| 6 | #define CONTENT_RENDERER_MEDIA_MEDIA_STREAM_IMPL_H_ |
| 7 | |
| 8 | #include <string> |
| 9 | #include <vector> |
| 10 | |
| 11 | #include "base/basictypes.h" |
| 12 | #include "base/compiler_specific.h" |
| 13 | #include "base/memory/ref_counted.h" |
| 14 | #include "base/memory/scoped_ptr.h" |
| 15 | #include "base/memory/scoped_vector.h" |
| 16 | #include "base/memory/weak_ptr.h" |
| 17 | #include "base/threading/non_thread_safe.h" |
| 18 | #include "content/common/content_export.h" |
| 19 | #include "content/public/renderer/render_view_observer.h" |
| 20 | #include "content/renderer/media/media_stream_dispatcher_eventhandler.h" |
Torne (Richard Coles) | a140131 | 2014-03-18 10:20:56 +0000 | [diff] [blame] | 21 | #include "content/renderer/media/media_stream_source.h" |
Torne (Richard Coles) | 868fa2f | 2013-06-11 10:57:03 +0100 | [diff] [blame] | 22 | #include "third_party/WebKit/public/platform/WebMediaStream.h" |
Torne (Richard Coles) | 8bcbed8 | 2013-10-22 16:41:35 +0100 | [diff] [blame] | 23 | #include "third_party/WebKit/public/platform/WebMediaStreamSource.h" |
| 24 | #include "third_party/WebKit/public/platform/WebVector.h" |
Torne (Richard Coles) | 46d4c2b | 2014-06-09 12:00:27 +0100 | [diff] [blame^] | 25 | #include "third_party/WebKit/public/web/WebMediaDevicesRequest.h" |
Torne (Richard Coles) | 7d4cd47 | 2013-06-19 11:58:07 +0100 | [diff] [blame] | 26 | #include "third_party/WebKit/public/web/WebUserMediaClient.h" |
| 27 | #include "third_party/WebKit/public/web/WebUserMediaRequest.h" |
Torne (Richard Coles) | 2a99a7e | 2013-03-28 15:31:22 +0000 | [diff] [blame] | 28 | #include "third_party/libjingle/source/talk/app/webrtc/mediastreaminterface.h" |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 29 | |
| 30 | namespace content { |
Torne (Richard Coles) | cedac22 | 2014-06-03 10:58:34 +0100 | [diff] [blame] | 31 | class PeerConnectionDependencyFactory; |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 32 | class MediaStreamDispatcher; |
Torne (Richard Coles) | a140131 | 2014-03-18 10:20:56 +0000 | [diff] [blame] | 33 | class MediaStreamVideoSource; |
| 34 | class VideoCapturerDelegate; |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 35 | |
Torne (Richard Coles) | cedac22 | 2014-06-03 10:58:34 +0100 | [diff] [blame] | 36 | // MediaStreamImpl is a delegate for the Media Stream GetUserMedia API. |
| 37 | // It ties together WebKit and MediaStreamManager |
| 38 | // (via MediaStreamDispatcher and MediaStreamDispatcherHost) |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 39 | // in the browser process. It must be created, called and destroyed on the |
| 40 | // render thread. |
| 41 | // MediaStreamImpl have weak pointers to a MediaStreamDispatcher. |
| 42 | class CONTENT_EXPORT MediaStreamImpl |
| 43 | : public RenderViewObserver, |
Torne (Richard Coles) | f2477e0 | 2013-11-28 11:55:43 +0000 | [diff] [blame] | 44 | NON_EXPORTED_BASE(public blink::WebUserMediaClient), |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 45 | public MediaStreamDispatcherEventHandler, |
| 46 | public base::SupportsWeakPtr<MediaStreamImpl>, |
| 47 | NON_EXPORTED_BASE(public base::NonThreadSafe) { |
| 48 | public: |
| 49 | MediaStreamImpl( |
| 50 | RenderView* render_view, |
| 51 | MediaStreamDispatcher* media_stream_dispatcher, |
Torne (Richard Coles) | cedac22 | 2014-06-03 10:58:34 +0100 | [diff] [blame] | 52 | PeerConnectionDependencyFactory* dependency_factory); |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 53 | virtual ~MediaStreamImpl(); |
| 54 | |
Torne (Richard Coles) | f2477e0 | 2013-11-28 11:55:43 +0000 | [diff] [blame] | 55 | // blink::WebUserMediaClient implementation |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 56 | virtual void requestUserMedia( |
Torne (Richard Coles) | cedac22 | 2014-06-03 10:58:34 +0100 | [diff] [blame] | 57 | const blink::WebUserMediaRequest& user_media_request); |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 58 | virtual void cancelUserMediaRequest( |
Torne (Richard Coles) | cedac22 | 2014-06-03 10:58:34 +0100 | [diff] [blame] | 59 | const blink::WebUserMediaRequest& user_media_request); |
Torne (Richard Coles) | 46d4c2b | 2014-06-09 12:00:27 +0100 | [diff] [blame^] | 60 | virtual void requestMediaDevices( |
| 61 | const blink::WebMediaDevicesRequest& media_devices_request) OVERRIDE; |
| 62 | virtual void cancelMediaDevicesRequest( |
| 63 | const blink::WebMediaDevicesRequest& media_devices_request) OVERRIDE; |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 64 | |
| 65 | // MediaStreamDispatcherEventHandler implementation. |
| 66 | virtual void OnStreamGenerated( |
| 67 | int request_id, |
| 68 | const std::string& label, |
| 69 | const StreamDeviceInfoArray& audio_array, |
| 70 | const StreamDeviceInfoArray& video_array) OVERRIDE; |
Torne (Richard Coles) | a140131 | 2014-03-18 10:20:56 +0000 | [diff] [blame] | 71 | virtual void OnStreamGenerationFailed( |
| 72 | int request_id, |
| 73 | content::MediaStreamRequestResult result) OVERRIDE; |
Torne (Richard Coles) | f2477e0 | 2013-11-28 11:55:43 +0000 | [diff] [blame] | 74 | virtual void OnDeviceStopped(const std::string& label, |
| 75 | const StreamDeviceInfo& device_info) OVERRIDE; |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 76 | virtual void OnDevicesEnumerated( |
| 77 | int request_id, |
| 78 | const StreamDeviceInfoArray& device_array) OVERRIDE; |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 79 | virtual void OnDeviceOpened( |
| 80 | int request_id, |
| 81 | const std::string& label, |
| 82 | const StreamDeviceInfo& device_info) OVERRIDE; |
| 83 | virtual void OnDeviceOpenFailed(int request_id) OVERRIDE; |
| 84 | |
| 85 | // RenderViewObserver OVERRIDE |
Torne (Richard Coles) | f2477e0 | 2013-11-28 11:55:43 +0000 | [diff] [blame] | 86 | virtual void FrameDetached(blink::WebFrame* frame) OVERRIDE; |
| 87 | virtual void FrameWillClose(blink::WebFrame* frame) OVERRIDE; |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 88 | |
| 89 | protected: |
Torne (Richard Coles) | 5d1f7b1 | 2014-02-21 12:16:55 +0000 | [diff] [blame] | 90 | // Called when |source| has been stopped from JavaScript. |
| 91 | void OnLocalSourceStopped(const blink::WebMediaStreamSource& source); |
Torne (Richard Coles) | 8bcbed8 | 2013-10-22 16:41:35 +0100 | [diff] [blame] | 92 | |
Ben Murdoch | 0529e5d | 2014-04-24 10:50:13 +0100 | [diff] [blame] | 93 | // These methods are virtual for test purposes. A test can override them to |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 94 | // test requesting local media streams. The function notifies WebKit that the |
Ben Murdoch | 0529e5d | 2014-04-24 10:50:13 +0100 | [diff] [blame] | 95 | // |request| have completed. |
| 96 | virtual void GetUserMediaRequestSucceeded( |
| 97 | const blink::WebMediaStream& stream, |
| 98 | blink::WebUserMediaRequest* request_info); |
| 99 | virtual void GetUserMediaRequestFailed( |
Torne (Richard Coles) | f2477e0 | 2013-11-28 11:55:43 +0000 | [diff] [blame] | 100 | blink::WebUserMediaRequest* request_info, |
Torne (Richard Coles) | a140131 | 2014-03-18 10:20:56 +0000 | [diff] [blame] | 101 | content::MediaStreamRequestResult result); |
Torne (Richard Coles) | 46d4c2b | 2014-06-09 12:00:27 +0100 | [diff] [blame^] | 102 | virtual void EnumerateDevicesSucceded( |
| 103 | blink::WebMediaDevicesRequest* request, |
| 104 | blink::WebVector<blink::WebMediaDeviceInfo>& devices); |
Torne (Richard Coles) | a140131 | 2014-03-18 10:20:56 +0000 | [diff] [blame] | 105 | // Creates a MediaStreamVideoSource object. |
| 106 | // This is virtual for test purposes. |
| 107 | virtual MediaStreamVideoSource* CreateVideoSource( |
| 108 | const StreamDeviceInfo& device, |
| 109 | const MediaStreamSource::SourceStoppedCallback& stop_callback); |
| 110 | |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 111 | private: |
Torne (Richard Coles) | 5d1f7b1 | 2014-02-21 12:16:55 +0000 | [diff] [blame] | 112 | // Class for storing information about a WebKit request to create a |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 113 | // MediaStream. |
Torne (Richard Coles) | 5d1f7b1 | 2014-02-21 12:16:55 +0000 | [diff] [blame] | 114 | class UserMediaRequestInfo |
| 115 | : public base::SupportsWeakPtr<UserMediaRequestInfo> { |
| 116 | public: |
| 117 | typedef base::Callback<void(UserMediaRequestInfo* request_info, |
Torne (Richard Coles) | a140131 | 2014-03-18 10:20:56 +0000 | [diff] [blame] | 118 | content::MediaStreamRequestResult result)> |
| 119 | ResourcesReady; |
Torne (Richard Coles) | 5d1f7b1 | 2014-02-21 12:16:55 +0000 | [diff] [blame] | 120 | |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 121 | UserMediaRequestInfo(int request_id, |
Torne (Richard Coles) | f2477e0 | 2013-11-28 11:55:43 +0000 | [diff] [blame] | 122 | blink::WebFrame* frame, |
| 123 | const blink::WebUserMediaRequest& request, |
Torne (Richard Coles) | 58537e2 | 2013-09-12 12:10:22 +0100 | [diff] [blame] | 124 | bool enable_automatic_output_device_selection); |
Torne (Richard Coles) | c2e0dbd | 2013-05-09 18:35:53 +0100 | [diff] [blame] | 125 | ~UserMediaRequestInfo(); |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 126 | int request_id; |
| 127 | // True if MediaStreamDispatcher has generated the stream, see |
| 128 | // OnStreamGenerated. |
| 129 | bool generated; |
Torne (Richard Coles) | 58537e2 | 2013-09-12 12:10:22 +0100 | [diff] [blame] | 130 | const bool enable_automatic_output_device_selection; |
Torne (Richard Coles) | f2477e0 | 2013-11-28 11:55:43 +0000 | [diff] [blame] | 131 | blink::WebFrame* frame; // WebFrame that requested the MediaStream. |
| 132 | blink::WebMediaStream web_stream; |
| 133 | blink::WebUserMediaRequest request; |
Torne (Richard Coles) | 5d1f7b1 | 2014-02-21 12:16:55 +0000 | [diff] [blame] | 134 | |
Ben Murdoch | effb81e | 2014-03-31 11:51:25 +0100 | [diff] [blame] | 135 | void StartAudioTrack(const blink::WebMediaStreamTrack& track, |
| 136 | const blink::WebMediaConstraints& constraints); |
| 137 | |
| 138 | blink::WebMediaStreamTrack CreateAndStartVideoTrack( |
| 139 | const blink::WebMediaStreamSource& source, |
Torne (Richard Coles) | cedac22 | 2014-06-03 10:58:34 +0100 | [diff] [blame] | 140 | const blink::WebMediaConstraints& constraints); |
Torne (Richard Coles) | 5d1f7b1 | 2014-02-21 12:16:55 +0000 | [diff] [blame] | 141 | |
| 142 | // Triggers |callback| when all sources used in this request have either |
| 143 | // successfully started, or a source has failed to start. |
| 144 | void CallbackOnTracksStarted(const ResourcesReady& callback); |
| 145 | |
| 146 | bool IsSourceUsed(const blink::WebMediaStreamSource& source) const; |
| 147 | void RemoveSource(const blink::WebMediaStreamSource& source); |
| 148 | |
Torne (Richard Coles) | cedac22 | 2014-06-03 10:58:34 +0100 | [diff] [blame] | 149 | bool AreAllSourcesRemoved() const { return sources_.empty(); } |
Torne (Richard Coles) | 5d1f7b1 | 2014-02-21 12:16:55 +0000 | [diff] [blame] | 150 | |
| 151 | private: |
| 152 | void OnTrackStarted(MediaStreamSource* source, bool success); |
| 153 | void CheckAllTracksStarted(); |
| 154 | |
| 155 | ResourcesReady ready_callback_; |
| 156 | bool request_failed_; |
| 157 | // Sources used in this request. |
| 158 | std::vector<blink::WebMediaStreamSource> sources_; |
| 159 | std::vector<MediaStreamSource*> sources_waiting_for_callback_; |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 160 | }; |
| 161 | typedef ScopedVector<UserMediaRequestInfo> UserMediaRequests; |
| 162 | |
Torne (Richard Coles) | 8bcbed8 | 2013-10-22 16:41:35 +0100 | [diff] [blame] | 163 | struct LocalStreamSource { |
Torne (Richard Coles) | f2477e0 | 2013-11-28 11:55:43 +0000 | [diff] [blame] | 164 | LocalStreamSource(blink::WebFrame* frame, |
| 165 | const blink::WebMediaStreamSource& source) |
Torne (Richard Coles) | 8bcbed8 | 2013-10-22 16:41:35 +0100 | [diff] [blame] | 166 | : frame(frame), source(source) { |
| 167 | } |
| 168 | // |frame| is the WebFrame that requested |source|. NULL in unit tests. |
| 169 | // TODO(perkj): Change so that |frame| is not NULL in unit tests. |
Torne (Richard Coles) | f2477e0 | 2013-11-28 11:55:43 +0000 | [diff] [blame] | 170 | blink::WebFrame* frame; |
| 171 | blink::WebMediaStreamSource source; |
Torne (Richard Coles) | 8bcbed8 | 2013-10-22 16:41:35 +0100 | [diff] [blame] | 172 | }; |
| 173 | typedef std::vector<LocalStreamSource> LocalStreamSources; |
| 174 | |
Torne (Richard Coles) | 46d4c2b | 2014-06-09 12:00:27 +0100 | [diff] [blame^] | 175 | struct MediaDevicesRequestInfo; |
| 176 | typedef ScopedVector<MediaDevicesRequestInfo> MediaDevicesRequests; |
| 177 | |
Torne (Richard Coles) | 8bcbed8 | 2013-10-22 16:41:35 +0100 | [diff] [blame] | 178 | // Creates a WebKit representation of stream sources based on |
| 179 | // |devices| from the MediaStreamDispatcher. |
Torne (Richard Coles) | 5d1f7b1 | 2014-02-21 12:16:55 +0000 | [diff] [blame] | 180 | void InitializeSourceObject( |
| 181 | const StreamDeviceInfo& device, |
Torne (Richard Coles) | f2477e0 | 2013-11-28 11:55:43 +0000 | [diff] [blame] | 182 | blink::WebMediaStreamSource::Type type, |
Torne (Richard Coles) | 5d1f7b1 | 2014-02-21 12:16:55 +0000 | [diff] [blame] | 183 | const blink::WebMediaConstraints& constraints, |
Torne (Richard Coles) | f2477e0 | 2013-11-28 11:55:43 +0000 | [diff] [blame] | 184 | blink::WebFrame* frame, |
Torne (Richard Coles) | 5d1f7b1 | 2014-02-21 12:16:55 +0000 | [diff] [blame] | 185 | blink::WebMediaStreamSource* webkit_source); |
| 186 | |
| 187 | void CreateVideoTracks( |
| 188 | const StreamDeviceInfoArray& devices, |
| 189 | const blink::WebMediaConstraints& constraints, |
| 190 | blink::WebVector<blink::WebMediaStreamTrack>* webkit_tracks, |
| 191 | UserMediaRequestInfo* request); |
| 192 | |
| 193 | void CreateAudioTracks( |
| 194 | const StreamDeviceInfoArray& devices, |
| 195 | const blink::WebMediaConstraints& constraints, |
| 196 | blink::WebVector<blink::WebMediaStreamTrack>* webkit_tracks, |
| 197 | UserMediaRequestInfo* request); |
| 198 | |
| 199 | // Callback function triggered when all native versions of the |
| 200 | // underlying media sources and tracks have been created and started. |
| 201 | void OnCreateNativeTracksCompleted( |
| 202 | UserMediaRequestInfo* request, |
Torne (Richard Coles) | a140131 | 2014-03-18 10:20:56 +0000 | [diff] [blame] | 203 | content::MediaStreamRequestResult result); |
Torne (Richard Coles) | 8bcbed8 | 2013-10-22 16:41:35 +0100 | [diff] [blame] | 204 | |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 205 | UserMediaRequestInfo* FindUserMediaRequestInfo(int request_id); |
| 206 | UserMediaRequestInfo* FindUserMediaRequestInfo( |
Torne (Richard Coles) | f2477e0 | 2013-11-28 11:55:43 +0000 | [diff] [blame] | 207 | const blink::WebUserMediaRequest& request); |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 208 | void DeleteUserMediaRequestInfo(UserMediaRequestInfo* request); |
| 209 | |
Torne (Richard Coles) | 46d4c2b | 2014-06-09 12:00:27 +0100 | [diff] [blame^] | 210 | MediaDevicesRequestInfo* FindMediaDevicesRequestInfo(int request_id); |
| 211 | MediaDevicesRequestInfo* FindMediaDevicesRequestInfo( |
| 212 | const blink::WebMediaDevicesRequest& request); |
| 213 | void DeleteMediaDevicesRequestInfo(MediaDevicesRequestInfo* request); |
| 214 | |
Torne (Richard Coles) | 8bcbed8 | 2013-10-22 16:41:35 +0100 | [diff] [blame] | 215 | // Returns the source that use a device with |device.session_id| |
| 216 | // and |device.device.id|. NULL if such source doesn't exist. |
Torne (Richard Coles) | f2477e0 | 2013-11-28 11:55:43 +0000 | [diff] [blame] | 217 | const blink::WebMediaStreamSource* FindLocalSource( |
Torne (Richard Coles) | 8bcbed8 | 2013-10-22 16:41:35 +0100 | [diff] [blame] | 218 | const StreamDeviceInfo& device) const; |
| 219 | |
Torne (Richard Coles) | f2477e0 | 2013-11-28 11:55:43 +0000 | [diff] [blame] | 220 | void StopLocalSource(const blink::WebMediaStreamSource& source, |
Torne (Richard Coles) | 8bcbed8 | 2013-10-22 16:41:35 +0100 | [diff] [blame] | 221 | bool notify_dispatcher); |
Torne (Richard Coles) | 8bcbed8 | 2013-10-22 16:41:35 +0100 | [diff] [blame] | 222 | |
Torne (Richard Coles) | cedac22 | 2014-06-03 10:58:34 +0100 | [diff] [blame] | 223 | // Weak ref to a PeerConnectionDependencyFactory, owned by the RenderThread. |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 224 | // It's valid for the lifetime of RenderThread. |
Torne (Richard Coles) | cedac22 | 2014-06-03 10:58:34 +0100 | [diff] [blame] | 225 | // TODO(xians): Remove this dependency once audio do not need it for local |
| 226 | // audio. |
| 227 | PeerConnectionDependencyFactory* dependency_factory_; |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 228 | |
| 229 | // media_stream_dispatcher_ is a weak reference, owned by RenderView. It's |
| 230 | // valid for the lifetime of RenderView. |
| 231 | MediaStreamDispatcher* media_stream_dispatcher_; |
| 232 | |
Torne (Richard Coles) | 8bcbed8 | 2013-10-22 16:41:35 +0100 | [diff] [blame] | 233 | LocalStreamSources local_sources_; |
| 234 | |
Ben Murdoch | 0529e5d | 2014-04-24 10:50:13 +0100 | [diff] [blame] | 235 | UserMediaRequests user_media_requests_; |
| 236 | |
Torne (Richard Coles) | 46d4c2b | 2014-06-09 12:00:27 +0100 | [diff] [blame^] | 237 | // Requests to enumerate media devices. |
| 238 | MediaDevicesRequests media_devices_requests_; |
| 239 | |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 240 | DISALLOW_COPY_AND_ASSIGN(MediaStreamImpl); |
| 241 | }; |
| 242 | |
| 243 | } // namespace content |
| 244 | |
| 245 | #endif // CONTENT_RENDERER_MEDIA_MEDIA_STREAM_IMPL_H_ |