Migrate MediaDevices.enumerateDevices to Mojo

content/renderer/media/user_media_client_impl.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "content/renderer/media/user_media_client_impl.h"
 
 #include <stddef.h>
 
 #include <utility>
 #include <vector>
 
 #include "base/hash.h"
 #include "base/location.h"
 #include "base/logging.h"
 #include "base/single_thread_task_runner.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/string_util.h"
 #include "base/strings/stringprintf.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/threading/thread_task_runner_handle.h"
+#include "build/build_config.h"
 #include "content/public/renderer/render_frame.h"
 #include "content/renderer/media/local_media_stream_audio_source.h"
 #include "content/renderer/media/media_stream.h"
 #include "content/renderer/media/media_stream_constraints_util.h"
 #include "content/renderer/media/media_stream_dispatcher.h"
 #include "content/renderer/media/media_stream_video_capturer_source.h"
 #include "content/renderer/media/media_stream_video_track.h"
 #include "content/renderer/media/peer_connection_tracker.h"
 #include "content/renderer/media/webrtc/processed_local_audio_source.h"
 #include "content/renderer/media/webrtc/webrtc_video_capturer_adapter.h"
@@ skipping 85 matching lines @@
       static_cast<MediaStreamSource*>(source.getExtraData());
   const StreamDeviceInfo& device = source_extra_data->device_info();
 
   MediaStreamSource* const other_source_extra_data =
       static_cast<MediaStreamSource*>(other_source.getExtraData());
   const StreamDeviceInfo& other_device = other_source_extra_data->device_info();
 
   return IsSameDevice(device, other_device);
 }
 
-static int g_next_request_id  = 0;
+blink::WebMediaDeviceInfo::MediaDeviceKind ToMediaDeviceKind(
+    MediaDeviceType type) {
+  switch (type) {
+    case MEDIA_DEVICE_TYPE_AUDIO_INPUT:
+      return blink::WebMediaDeviceInfo::MediaDeviceKindAudioInput;
+    case MEDIA_DEVICE_TYPE_VIDEO_INPUT:
+      return blink::WebMediaDeviceInfo::MediaDeviceKindVideoInput;
+    case MEDIA_DEVICE_TYPE_AUDIO_OUTPUT:
+      return blink::WebMediaDeviceInfo::MediaDeviceKindAudioOutput;
+    default:
+      NOTREACHED();
+      return blink::WebMediaDeviceInfo::MediaDeviceKindAudioInput;
+  }
+}
+
+blink::WebSourceInfo::VideoFacingMode ToVideoFacingMode(
+    const std::string& device_label) {
+#if defined(OS_ANDROID)
+  if (device_label.find("front") != std::string::npos) {

[tommi (sloooow) - chröme, 2016/10/07 19:59:40]

is this behavior copied from somewhere?  Would it make sense for us to be a
little more strict here? e.g. what should "backfront" match with?

[Guido Urdaneta, 2016/10/08 10:09:56]

This is copied from here:
https://cs.chromium.org/chromium/src/content/public/common/media_stream_reque...

The reason it works is because, in Android, camera labels include the
orientation and can only include one of the strings. See
https://cs.chromium.org/chromium/src/third_party/webrtc/api/android/java/src/...

MediaStreamTrack.GetSources() is going away anyway, but we will have to decide
how to deal with the orientation once we implement capabilities and
applyConstraints.

+    return blink::WebSourceInfo::VideoFacingModeUser;
+  } else if (device_label.find("back") != std::string::npos) {
+    return blink::WebSourceInfo::VideoFacingModeEnvironment;
+  }
+#endif
+  return blink::WebSourceInfo::VideoFacingModeNone;
+}
+
+static int g_next_request_id = 0;
 
 }  // namespace
 
-struct UserMediaClientImpl::MediaDevicesRequestInfo {
-  MediaDevicesRequestInfo(const blink::WebMediaDevicesRequest& request,
-                          int audio_input_request_id,
-                          int video_input_request_id,
-                          int audio_output_request_id)
-      : media_devices_request(request),
-        audio_input_request_id(audio_input_request_id),
-        video_input_request_id(video_input_request_id),
-        audio_output_request_id(audio_output_request_id),
-        has_audio_input_returned(false),
-        has_video_input_returned(false),
-        has_audio_output_returned(false) {}
-
-  MediaDevicesRequestInfo(
-      const blink::WebMediaStreamTrackSourcesRequest& request,
-      int audio_input_request_id,
-      int video_input_request_id)
-      : sources_request(request),
-        audio_input_request_id(audio_input_request_id),
-        video_input_request_id(video_input_request_id),
-        audio_output_request_id(-1),
-        has_audio_input_returned(false),
-        has_video_input_returned(false),
-        has_audio_output_returned(false) {}
-
-  bool IsSourcesRequest() {
-    // We can't check isNull() on |media_devices_request| and |sources_request|,
-    // because in unit tests they will always be null.
-    return audio_output_request_id == -1;
-  }
-
-  blink::WebMediaDevicesRequest media_devices_request;
-  blink::WebMediaStreamTrackSourcesRequest sources_request;
-  int audio_input_request_id;
-  int video_input_request_id;
-  int audio_output_request_id;
-  bool has_audio_input_returned;
-  bool has_video_input_returned;
-  bool has_audio_output_returned;
-  StreamDeviceInfoArray audio_input_devices;
-  StreamDeviceInfoArray video_input_devices;
-  StreamDeviceInfoArray audio_output_devices;
-};
-
 UserMediaClientImpl::UserMediaClientImpl(
     RenderFrame* render_frame,
     PeerConnectionDependencyFactory* dependency_factory,
     std::unique_ptr<MediaStreamDispatcher> media_stream_dispatcher)
     : RenderFrameObserver(render_frame),
       dependency_factory_(dependency_factory),
       media_stream_dispatcher_(std::move(media_stream_dispatcher)),
       weak_factory_(this) {
   DCHECK(dependency_factory_);
   DCHECK(media_stream_dispatcher_.get());
@@ skipping 99 matching lines @@
     LogUserMediaRequestWithNoResult(MEDIA_STREAM_REQUEST_EXPLICITLY_CANCELLED);
     DeleteUserMediaRequestInfo(request);
   }
 }
 
 void UserMediaClientImpl::requestMediaDevices(
     const blink::WebMediaDevicesRequest& media_devices_request) {
   UpdateWebRTCMethodCount(WEBKIT_GET_MEDIA_DEVICES);
   DCHECK(CalledOnValidThread());
 
-  int audio_input_request_id = g_next_request_id++;
-  int video_input_request_id = g_next_request_id++;
-  int audio_output_request_id = g_next_request_id++;
-
   // |media_devices_request| can't be mocked, so in tests it will be empty (the
   // underlying pointer is null). In order to use this function in a test we
   // need to check if it isNull.
   url::Origin security_origin;
   if (!media_devices_request.isNull())
     security_origin = media_devices_request.getSecurityOrigin();
 
-  DVLOG(1) << "UserMediaClientImpl::requestMediaDevices("
-           << audio_input_request_id << ", " << video_input_request_id << ", "
-           << audio_output_request_id << ", " << security_origin << ")";
-
-  media_devices_requests_.push_back(new MediaDevicesRequestInfo(
-      media_devices_request,
-      audio_input_request_id,
-      video_input_request_id,
-      audio_output_request_id));
-
-  media_stream_dispatcher_->EnumerateDevices(
-      audio_input_request_id,
-      weak_factory_.GetWeakPtr(),
-      MEDIA_DEVICE_AUDIO_CAPTURE,
-      security_origin);
-
-  media_stream_dispatcher_->EnumerateDevices(
-      video_input_request_id,
-      weak_factory_.GetWeakPtr(),
-      MEDIA_DEVICE_VIDEO_CAPTURE,
-      security_origin);
-
-  media_stream_dispatcher_->EnumerateDevices(
-      audio_output_request_id,
-      weak_factory_.GetWeakPtr(),
-      MEDIA_DEVICE_AUDIO_OUTPUT,
-      security_origin);
+  GetMediaDevicesDispatcher()->EnumerateDevices(
+      true /* audio input */, true /* video input */, true /* audio output */,
+      security_origin,
+      base::Bind(&UserMediaClientImpl::FinalizeEnumerateDevices,
+                 weak_factory_.GetWeakPtr(), media_devices_request));
 }
 
 void UserMediaClientImpl::requestSources(
     const blink::WebMediaStreamTrackSourcesRequest& sources_request) {
   // We don't call UpdateWebRTCMethodCount() here to track the API count in UMA
   // stats. This is instead counted in MediaStreamTrack::getSources in blink.
   DCHECK(CalledOnValidThread());
 
-  int audio_input_request_id = g_next_request_id++;
-  int video_input_request_id = g_next_request_id++;
-
   // |sources_request| can't be mocked, so in tests it will be empty (the
   // underlying pointer is null). In order to use this function in a test we
   // need to check if it isNull.
   url::Origin security_origin;
   if (!sources_request.isNull())
     security_origin = sources_request.origin();
 
-  DVLOG(1) << "UserMediaClientImpl::requestSources(" << audio_input_request_id
-           << ", " << video_input_request_id << ", " << security_origin << ")";
-
-  media_devices_requests_.push_back(new MediaDevicesRequestInfo(
-      sources_request,
-      audio_input_request_id,
-      video_input_request_id));
-
-  media_stream_dispatcher_->EnumerateDevices(
-      audio_input_request_id,
-      weak_factory_.GetWeakPtr(),
-      MEDIA_DEVICE_AUDIO_CAPTURE,
-      security_origin);
-
-  media_stream_dispatcher_->EnumerateDevices(
-      video_input_request_id,
-      weak_factory_.GetWeakPtr(),
-      MEDIA_DEVICE_VIDEO_CAPTURE,
-      security_origin);
+  GetMediaDevicesDispatcher()->EnumerateDevices(
+      true /* audio input */, true /* video input */, false /* audio output */,
+      security_origin, base::Bind(&UserMediaClientImpl::FinalizeGetSources,
+                                  weak_factory_.GetWeakPtr(), sources_request));
 }
 
 void UserMediaClientImpl::setMediaDeviceChangeObserver(
     const blink::WebMediaDeviceChangeObserver& observer) {
   media_device_change_observer_ = observer;
 
   if (media_device_change_observer_.isNull()) {
     media_stream_dispatcher_->CancelDeviceChangeNotifications(
         weak_factory_.GetWeakPtr());
   } else {
@@ skipping 71 matching lines @@
   }
 
   for (StreamDeviceInfoArray::const_iterator device_it = video_array.begin();
        device_it != video_array.end(); ++device_it) {
     if (!FindLocalSource(*device_it))
       media_stream_dispatcher_->StopStreamDevice(*device_it);
   }
 }
 
 void UserMediaClientImpl::FinalizeEnumerateDevices(
-    MediaDevicesRequestInfo* request) {
-  blink::WebVector<blink::WebMediaDeviceInfo>
-      devices(request->audio_input_devices.size() +
-              request->video_input_devices.size() +
-              request->audio_output_devices.size());
-  for (size_t i = 0; i  < request->audio_input_devices.size(); ++i) {
-    const MediaStreamDevice& device = request->audio_input_devices[i].device;
-    DCHECK_EQ(device.type, MEDIA_DEVICE_AUDIO_CAPTURE);
+    blink::WebMediaDevicesRequest request,
+    const EnumerationResult& result) {
+  DCHECK_EQ(static_cast<size_t>(NUM_MEDIA_DEVICE_TYPES), result.size());
 
-    devices[i].initialize(blink::WebString::fromUTF8(device.id),
-                          blink::WebMediaDeviceInfo::MediaDeviceKindAudioInput,
-                          blink::WebString::fromUTF8(device.name),
-                          blink::WebString::fromUTF8(device.group_id));
-  }
-  size_t offset = request->audio_input_devices.size();
-  for (size_t i = 0; i  < request->video_input_devices.size(); ++i) {
-    const MediaStreamDevice& device = request->video_input_devices[i].device;
-    DCHECK_EQ(device.type, MEDIA_DEVICE_VIDEO_CAPTURE);
-    devices[offset + i].initialize(
-        blink::WebString::fromUTF8(device.id),
-        blink::WebMediaDeviceInfo::MediaDeviceKindVideoInput,
-        blink::WebString::fromUTF8(device.name),
-        blink::WebString());
-  }
-  offset += request->video_input_devices.size();
-  for (size_t i = 0; i  < request->audio_output_devices.size(); ++i) {
-    const MediaStreamDevice& device = request->audio_output_devices[i].device;
-    DCHECK_EQ(device.type, MEDIA_DEVICE_AUDIO_OUTPUT);
-    devices[offset + i].initialize(
-        blink::WebString::fromUTF8(device.id),
-        blink::WebMediaDeviceInfo::MediaDeviceKindAudioOutput,
-        blink::WebString::fromUTF8(device.name),
-        blink::WebString::fromUTF8(device.group_id));
+  blink::WebVector<blink::WebMediaDeviceInfo> devices(
+      result[MEDIA_DEVICE_TYPE_AUDIO_INPUT].size() +
+      result[MEDIA_DEVICE_TYPE_VIDEO_INPUT].size() +
+      result[MEDIA_DEVICE_TYPE_AUDIO_OUTPUT].size());
+  size_t index = 0;
+  for (size_t i = 0; i < NUM_MEDIA_DEVICE_TYPES; ++i) {
+    blink::WebMediaDeviceInfo::MediaDeviceKind device_kind =
+        ToMediaDeviceKind(static_cast<MediaDeviceType>(i));
+    for (const auto& device_info : result[i]) {
+      devices[index++].initialize(
+          blink::WebString::fromUTF8(device_info.device_id), device_kind,
+          blink::WebString::fromUTF8(device_info.label),
+          blink::WebString::fromUTF8(device_info.group_id));
+    }
   }
 
-  EnumerateDevicesSucceded(&request->media_devices_request, devices);
+  EnumerateDevicesSucceded(&request, devices);
 }
 
-void UserMediaClientImpl::FinalizeEnumerateSources(
-    MediaDevicesRequestInfo* request) {
-  blink::WebVector<blink::WebSourceInfo>
-      sources(request->audio_input_devices.size() +
-              request->video_input_devices.size());
-  for (size_t i = 0; i  < request->audio_input_devices.size(); ++i) {
-    const MediaStreamDevice& device = request->audio_input_devices[i].device;
-    DCHECK_EQ(device.type, MEDIA_DEVICE_AUDIO_CAPTURE);
-    std::string group_id = base::UintToString(base::Hash(
-        !device.matched_output_device_id.empty() ?
-            device.matched_output_device_id :
-            device.id));
-    sources[i].initialize(blink::WebString::fromUTF8(device.id),
-                          blink::WebSourceInfo::SourceKindAudio,
-                          blink::WebString::fromUTF8(device.name),
-                          blink::WebSourceInfo::VideoFacingModeNone);
-  }
-  size_t offset = request->audio_input_devices.size();
-  for (size_t i = 0; i  < request->video_input_devices.size(); ++i) {
-    const MediaStreamDevice& device = request->video_input_devices[i].device;
-    DCHECK_EQ(device.type, MEDIA_DEVICE_VIDEO_CAPTURE);
-    blink::WebSourceInfo::VideoFacingMode video_facing;
-    switch (device.video_facing) {
-      case MEDIA_VIDEO_FACING_USER:
-        video_facing = blink::WebSourceInfo::VideoFacingModeUser;
-        break;
-      case MEDIA_VIDEO_FACING_ENVIRONMENT:
-        video_facing = blink::WebSourceInfo::VideoFacingModeEnvironment;
-        break;
-      default:
-        video_facing = blink::WebSourceInfo::VideoFacingModeNone;
-    }
-    sources[offset + i].initialize(blink::WebString::fromUTF8(device.id),
-                                   blink::WebSourceInfo::SourceKindVideo,
-                                   blink::WebString::fromUTF8(device.name),
-                                   video_facing);
+void UserMediaClientImpl::FinalizeGetSources(
+    blink::WebMediaStreamTrackSourcesRequest request,
+    const EnumerationResult& result) {
+  DCHECK_EQ(static_cast<size_t>(NUM_MEDIA_DEVICE_TYPES), result.size());
+
+  blink::WebVector<blink::WebSourceInfo> sources(
+      result[MEDIA_DEVICE_TYPE_AUDIO_INPUT].size() +
+      result[MEDIA_DEVICE_TYPE_VIDEO_INPUT].size());
+  size_t index = 0;
+  for (const auto& device_info : result[MEDIA_DEVICE_TYPE_AUDIO_INPUT]) {
+    sources[index++].initialize(
+        blink::WebString::fromUTF8(device_info.device_id),
+        blink::WebSourceInfo::SourceKindAudio,
+        blink::WebString::fromUTF8(device_info.label),
+        blink::WebSourceInfo::VideoFacingModeNone);
   }
 
-  EnumerateSourcesSucceded(&request->sources_request, sources);
+  for (const auto& device_info : result[MEDIA_DEVICE_TYPE_VIDEO_INPUT]) {
+    sources[index++].initialize(
+        blink::WebString::fromUTF8(device_info.device_id),
+        blink::WebSourceInfo::SourceKindVideo,
+        blink::WebString::fromUTF8(device_info.label),
+        ToVideoFacingMode(device_info.label));
+  }
+
+  EnumerateSourcesSucceded(&request, sources);
 }
 
 // Callback from MediaStreamDispatcher.
 // The requested stream failed to be generated.
 void UserMediaClientImpl::OnStreamGenerationFailed(
     int request_id,
     MediaStreamRequestResult result) {
   DCHECK(CalledOnValidThread());
   DVLOG(1) << "UserMediaClientImpl::OnStreamGenerationFailed("
            << request_id << ")";
@@ skipping 189 matching lines @@
         track->Stop();
     }
   }
 
   DeleteUserMediaRequestInfo(request);
 }
 
 void UserMediaClientImpl::OnDevicesEnumerated(
     int request_id,
     const StreamDeviceInfoArray& device_array) {
-  DVLOG(1) << "UserMediaClientImpl::OnDevicesEnumerated(" << request_id << ")";
-
-  MediaDevicesRequestInfo* request = FindMediaDevicesRequestInfo(request_id);
-  if (!request)
-    return;
-
-  if (request_id == request->audio_input_request_id) {
-    request->has_audio_input_returned = true;
-    request->audio_input_devices = device_array;
-  } else if (request_id == request->video_input_request_id) {
-    request->has_video_input_returned = true;
-    request->video_input_devices = device_array;
-  } else {
-    DCHECK_EQ(request->audio_output_request_id, request_id);
-    request->has_audio_output_returned = true;
-    request->audio_output_devices = device_array;
-  }
-
-  if (!request->has_audio_input_returned ||
-      !request->has_video_input_returned ||
-      (!request->IsSourcesRequest() && !request->has_audio_output_returned)) {
-    // Wait for the rest of the devices to complete.
-    return;
-  }
-
-  if (request->IsSourcesRequest())
-    FinalizeEnumerateSources(request);
-  else
-    FinalizeEnumerateDevices(request);
-
-  CancelAndDeleteMediaDevicesRequest(request);
+  NOTREACHED();
 }
 
 void UserMediaClientImpl::OnDeviceOpened(
     int request_id,
     const std::string& label,
     const StreamDeviceInfo& video_device) {
   DVLOG(1) << "UserMediaClientImpl::OnDeviceOpened("
            << request_id << ", " << label << ")";
   NOTIMPLEMENTED();
 }
@@ skipping 190 matching lines @@
       LogUserMediaRequestWithNoResult(MEDIA_STREAM_REQUEST_NOT_GENERATED);
     } else {
       DCHECK((*request_it)->HasPendingSources());
       LogUserMediaRequestWithNoResult(
           MEDIA_STREAM_REQUEST_PENDING_MEDIA_TRACKS);
     }
     request_it = user_media_requests_.erase(request_it);
   }
 }
 
-UserMediaClientImpl::MediaDevicesRequestInfo*
-UserMediaClientImpl::FindMediaDevicesRequestInfo(
-    int request_id) {
-  MediaDevicesRequests::iterator it = media_devices_requests_.begin();
-  for (; it != media_devices_requests_.end(); ++it) {
-    if ((*it)->audio_input_request_id == request_id ||
-        (*it)->video_input_request_id == request_id ||
-        (*it)->audio_output_request_id == request_id) {
-      return (*it);
-    }
-  }
-  return NULL;
-}
-
-UserMediaClientImpl::MediaDevicesRequestInfo*
-UserMediaClientImpl::FindMediaDevicesRequestInfo(
-    const blink::WebMediaDevicesRequest& request) {
-  MediaDevicesRequests::iterator it = media_devices_requests_.begin();
-  for (; it != media_devices_requests_.end(); ++it) {
-    if ((*it)->media_devices_request == request)
-      return (*it);
-  }
-  return NULL;
-}
-
-void UserMediaClientImpl::CancelAndDeleteMediaDevicesRequest(
-    MediaDevicesRequestInfo* request) {
-  MediaDevicesRequests::iterator it = media_devices_requests_.begin();
-  for (; it != media_devices_requests_.end(); ++it) {
-    if ((*it) == request) {
-      // Cancel device enumeration.
-      media_stream_dispatcher_->StopEnumerateDevices(
-          request->audio_input_request_id, weak_factory_.GetWeakPtr());
-      media_stream_dispatcher_->StopEnumerateDevices(
-          request->video_input_request_id, weak_factory_.GetWeakPtr());
-      media_stream_dispatcher_->StopEnumerateDevices(
-          request->audio_output_request_id, weak_factory_.GetWeakPtr());
-
-      media_devices_requests_.erase(it);
-      return;
-    }
-  }
-  NOTREACHED();
-}
-
 void UserMediaClientImpl::WillCommitProvisionalLoad() {
   // Cancel all outstanding UserMediaRequests.
   DeleteAllUserMediaRequests();
 
   // Loop through all current local sources and stop the sources.
   LocalStreamSources::iterator sources_it = local_sources_.begin();
   while (sources_it != local_sources_.end()) {
     StopLocalSource(*sources_it, true);
     sources_it = local_sources_.erase(sources_it);
   }
 }
 
+void UserMediaClientImpl::SetMediaDevicesDispatcherForTesting(
+    ::mojom::MediaDevicesDispatcherHostPtr media_devices_dispatcher) {
+  media_devices_dispatcher_ = std::move(media_devices_dispatcher);
+}
+
 void UserMediaClientImpl::OnLocalSourceStopped(
     const blink::WebMediaStreamSource& source) {
   DCHECK(CalledOnValidThread());
   DVLOG(1) << "UserMediaClientImpl::OnLocalSourceStopped";
 
   const bool some_source_removed = RemoveLocalSource(source);
   CHECK(some_source_removed);
 
   MediaStreamSource* source_impl =
       static_cast<MediaStreamSource*>(source.getExtraData());
   media_stream_dispatcher_->StopStreamDevice(source_impl->device_info());
 }
 
 void UserMediaClientImpl::StopLocalSource(
     const blink::WebMediaStreamSource& source,
     bool notify_dispatcher) {
   MediaStreamSource* source_impl =
       static_cast<MediaStreamSource*>(source.getExtraData());
   DVLOG(1) << "UserMediaClientImpl::StopLocalSource("
            << "{device_id = " << source_impl->device_info().device.id << "})";
 
   if (notify_dispatcher)
     media_stream_dispatcher_->StopStreamDevice(source_impl->device_info());
 
   source_impl->ResetSourceStoppedCallback();
   source_impl->StopSource();
 }
 
+const ::mojom::MediaDevicesDispatcherHostPtr&
+UserMediaClientImpl::GetMediaDevicesDispatcher() {
+  if (!media_devices_dispatcher_) {
+    render_frame()->GetRemoteInterfaces()->GetInterface(
+        mojo::GetProxy(&media_devices_dispatcher_));
+  }
+
+  return media_devices_dispatcher_;
+}
+
 UserMediaClientImpl::UserMediaRequestInfo::UserMediaRequestInfo(
     int request_id,
     const blink::WebUserMediaRequest& request,
     bool enable_automatic_output_device_selection)
     : request_id(request_id),
       generated(false),
       enable_automatic_output_device_selection(
           enable_automatic_output_device_selection),
       request(request),
       request_result_(MEDIA_DEVICE_OK),
@@ skipping 95 matching lines @@
 
 bool UserMediaClientImpl::UserMediaRequestInfo::HasPendingSources() const {
   return !sources_waiting_for_callback_.empty();
 }
 
 void UserMediaClientImpl::OnDestruct() {
   delete this;
 }
 
 }  // namespace content