Reland review 34393006: Refactor MediaStreamManager to not output real device id.

content/browser/renderer_host/media/media_stream_manager.h

 // 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.
 
 // MediaStreamManager is used to open/enumerate media capture devices (video
 // supported now). Call flow:
 // 1. GenerateStream is called when a render process wants to use a capture
 //    device.
 // 2. MediaStreamManager will ask MediaStreamUIController for permission to
 //    use devices and for which device to use.
@@ skipping 137 matching lines @@
 
   // Used by unit test to make sure fake devices are used instead of a real
   // devices, which is needed for server based testing or certain tests (which
   // can pass --use-fake-device-for-media-stream).
   void UseFakeDevice();
 
   // Called by the tests to specify a fake UI that should be used for next
   // generated stream (or when using --use-fake-ui-for-media-stream).
   void UseFakeUI(scoped_ptr<FakeMediaStreamUIProxy> fake_ui);
 
+  // Returns all devices currently opened by a request with label |label|.
+  // If no request with |label| exist, an empty array is returned.

[tommi (sloooow) - chröme, 2013/11/27 22:09:43]

if there are thread restrictions it might be good to document those here as
well.

[perkj_chrome, 2013/11/28 09:46:43]

There are no specific thread restrictions. All methods in MSM are called on the
IO thread except ctor and dtor that to my understanding is done on the UI
thread.

+  StreamDeviceInfoArray GetDevicesOpenedByRequest(
+      const std::string& label) const;
+
   // This object gets deleted on the UI thread after the IO thread has been
   // destroyed. So we need to know when IO thread is being destroyed so that
-  // we can delete VideoCaptureManager and AudioInputDeviceManager.
-  // We also must call this function explicitly in tests which use
-  // TestBrowserThreadBundle, because the notification happens too late in that
-  // case (see http://crbug.com/247525#c14).
+  // we can delete VideoCaptureManager and AudioInputDeviceManager. Normally
+  // this is handled by
+  // base::MessageLoop::DestructionObserver::WillDestroyCurrentMessageLoop.
+  // But for some tests which use TestBrowserThreadBundle, we need to call
+  // WillDestroyCurrentMessageLoop explicitly because the notification happens
+  // too late. (see http://crbug.com/247525#c14).
   virtual void WillDestroyCurrentMessageLoop() OVERRIDE;
 
  protected:
   // Used for testing.
   MediaStreamManager();
 
  private:
-  friend class MockMediaStreamDispatcherHost;
-
   // Contains all data needed to keep track of requests.
   class DeviceRequest;
 
   // Cache enumerated device list.
   struct EnumerationCache {
     EnumerationCache();
     ~EnumerationCache();
 
     bool valid;
     StreamDeviceInfoArray devices;
   };
 
   typedef std::map<std::string, DeviceRequest*> DeviceRequests;
 
   // Initializes the device managers on IO thread.  Auto-starts the device
   // thread and registers this as a listener with the device managers.
   void InitializeDeviceManagersOnIOThread();
 
   // Helper for sending up-to-date device lists to media observer when a
   // capture device is plugged in or unplugged.
   void NotifyDevicesChanged(MediaStreamType stream_type,
                             const StreamDeviceInfoArray& devices);
 
-
   void HandleAccessRequestResponse(const std::string& label,
                                    const MediaStreamDevices& devices);
   void StopMediaStreamFromBrowser(const std::string& label);
 
+  void DoEnumerateDevices(const std::string& label);
+
   // Helpers.
   // Checks if all devices that was requested in the request identififed by
   // |label| has been opened and set the request state accordingly.
   void HandleRequestDone(const std::string& label,
                          DeviceRequest* request);
   // Stop the use of the device associated with |session_id| of type |type| in
   // all |requests_|. The device is removed from the request. If a request
   /// doesn't use any devices as a consequence, the request is deleted.
   void StopDevice(MediaStreamType type, int session_id);
   // Calls the correct capture manager and close the device with |session_id|.
   // All requests that uses the device are updated.
   void CloseDevice(MediaStreamType type, int session_id);
   // Returns true if a request for devices has been completed and the devices
   // has either been opened or an error has occurred.
   bool RequestDone(const DeviceRequest& request) const;
   MediaStreamProvider* GetDeviceManager(MediaStreamType stream_type);
   void StartEnumeration(DeviceRequest* request);
   std::string AddRequest(DeviceRequest* request);
-  void RemoveRequest(DeviceRequests::iterator it);
+  DeviceRequest* FindRequest(const std::string& label) const;
+  void DeleteRequest(const std::string& label);
   void ClearEnumerationCache(EnumerationCache* cache);
-  void PostRequestToUI(const std::string& label);
-  void HandleRequest(const std::string& label);
+  // Prepare the request with label |label| by starting device enumeration if
+  // needed.
+  void SetupRequest(const std::string& label);
+  bool SetupTabCaptureRequest(DeviceRequest* request);
+  bool SetupScreenCaptureRequest(DeviceRequest* request);
+  // Called when a request has been setup and devices have been enumerated if
+  // needed. If a certain source id has been requested, the source id is
+  // translated to a real device id before the request is posted to UI.
+  void PostRequestToUI(const std::string& label, DeviceRequest* request);
   // Returns true if a device with |device_id| has already been requested by
   // |render_process_id| and |render_view_id| of type |type|. If it has been
-  // requested, |device_info| contain information about the the device.
+  // requested, |device_info| contain information about the device.
   bool FindExistingRequestedDeviceInfo(int render_process_id,
                                        int render_view_id,
+                                       const GURL& security_origin,
                                        MediaStreamRequestType type,
                                        const std::string& device_id,
+                                       MediaStreamType device_type,
                                        StreamDeviceInfo* device_info,
                                        MediaRequestState* request_state) const;
 
-  // Sends cached device list to a client corresponding to the request
-  // identified by |label|.
-  void SendCachedDeviceList(EnumerationCache* cache, const std::string& label);
+  void FinalizeGenerateStream(const std::string& label,
+                              DeviceRequest* request);
+  void FinalizeRequestFailed(const std::string& label,
+                             DeviceRequest* request);
+  void FinalizeOpenDevice(const std::string& label,
+                          DeviceRequest* request);
+  void FinalizeMediaAccessRequest(const std::string& label,
+                                  DeviceRequest* request,
+                                  const MediaStreamDevices& devices);
+  void FinalizeEnumerateDevices(const std::string& label,
+                                DeviceRequest* request);
 
   // This method is called when an audio or video device is plugged in or
   // removed. It make sure all MediaStreams that use a removed device is
   // stopped and that the render process is notified. |old_devices| is the list
   // of previously available devices. |new_devices| is the new
   // list of currently available devices.
   void StopRemovedDevices(const StreamDeviceInfoArray& old_devices,
                           const StreamDeviceInfoArray& new_devices);
   // Helper method used by StopRemovedDevices to stop the use of a certain
   // device.
   void StopRemovedDevice(const MediaStreamDevice& device);
 
   // Helpers to start and stop monitoring devices.
   void StartMonitoring();
   void StopMonitoring();
 
-  // Finds and returns the raw device id corresponding to the given
-  // |device_guid|. Returns true if there was a raw device id that matched the
-  // given |device_guid|, false if nothing matched it.
-  bool TranslateGUIDToRawId(
+  bool TranslateRequestedSourceIdToDeviceId(MediaStreamRequest* request);
+  void TranslateDeviceIdToSourceId(const MediaStreamRequest& request,
+                                   MediaStreamDevice* device);
+
+  // Finds and returns the device id corresponding to the given
+  // |source_id|. Returns true if there was a raw device id that matched the
+  // given |source_id|, false if nothing matched it.
+  bool TranslateSourceIdToDeviceId(
       MediaStreamType stream_type,
       const GURL& security_origin,
-      const std::string& device_guid,
-      std::string* raw_device_id);
+      const std::string& source_id,
+      std::string* device_id);
 
   // Device thread shared by VideoCaptureManager and AudioInputDeviceManager.
   scoped_ptr<base::Thread> device_thread_;
 
   media::AudioManager* const audio_manager_;  // not owned
   scoped_refptr<AudioInputDeviceManager> audio_input_device_manager_;
   scoped_refptr<VideoCaptureManager> video_capture_manager_;
 
   // Indicator of device monitoring state.
   bool monitoring_started_;
 
   // Stores most recently enumerated device lists. The cache is cleared when
   // monitoring is stopped or there is no request for that type of device.
   EnumerationCache audio_enumeration_cache_;
   EnumerationCache video_enumeration_cache_;
 
   // Keeps track of live enumeration commands sent to VideoCaptureManager or
   // AudioInputDeviceManager, in order to only enumerate when necessary.
   int active_enumeration_ref_count_[NUM_MEDIA_TYPES];
 
   // All non-closed request.
   DeviceRequests requests_;
 
-  std::vector<int> opened_audio_session_ids_;
-  std::vector<int> opened_video_session_ids_;
-
   // Hold a pointer to the IO loop to check we delete the device thread and
   // managers on the right thread.
   base::MessageLoop* io_loop_;
 
-  bool screen_capture_active_;
-
   bool use_fake_ui_;
   scoped_ptr<FakeMediaStreamUIProxy> fake_ui_;
 
   DISALLOW_COPY_AND_ASSIGN(MediaStreamManager);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_RENDERER_HOST_MEDIA_MEDIA_STREAM_MANAGER_H_