Reland Queue commands to the Os to start a video device.

content/browser/renderer_host/media/video_capture_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.
 
 // VideoCaptureManager is used to open/close, start/stop, enumerate available
 // video capture devices, and manage VideoCaptureController's.
 // All functions are expected to be called from Browser::IO thread. Some helper
 // functions (*OnDeviceThread) will dispatch operations to the device thread.
 // VideoCaptureManager will open OS dependent instances of VideoCaptureDevice.
 // A device can only be opened once.
 
 #ifndef CONTENT_BROWSER_RENDERER_HOST_MEDIA_VIDEO_CAPTURE_MANAGER_H_
 #define CONTENT_BROWSER_RENDERER_HOST_MEDIA_VIDEO_CAPTURE_MANAGER_H_
 
+#include <list>
 #include <map>
 #include <set>
 #include <string>
 
 #include "base/memory/ref_counted.h"
+#include "base/memory/scoped_vector.h"
 #include "base/memory/weak_ptr.h"
 #include "base/message_loop/message_loop.h"
 #include "base/process/process_handle.h"
+#include "base/threading/thread_checker.h"
 #include "base/timer/elapsed_timer.h"
 #include "content/browser/renderer_host/media/media_stream_provider.h"
 #include "content/browser/renderer_host/media/video_capture_controller_event_handler.h"
 #include "content/common/content_export.h"
 #include "content/common/media/media_stream_options.h"
 #include "media/video/capture/video_capture_device.h"
 #include "media/video/capture/video_capture_device_factory.h"
 #include "media/video/capture/video_capture_device_info.h"
 #include "media/video/capture/video_capture_types.h"
 
@@ skipping 98 matching lines @@
     return video_capture_device_factory_.get();
   }
 
 #if defined(OS_WIN)
   void set_device_task_runner(
       const scoped_refptr<base::SingleThreadTaskRunner>& device_task_runner) {
     device_task_runner_ = device_task_runner;
   }
 #endif
 
+  // Returns the SingleThreadTaskRunner where devices are enumerated on and
+  // started.
+  scoped_refptr<base::SingleThreadTaskRunner>& device_task_runner() {
+    return device_task_runner_;
+  }
  private:
   ~VideoCaptureManager() override;
-  struct DeviceEntry;
+  class DeviceEntry;
 
   // Checks to see if |entry| has no clients left on its controller. If so,
   // remove it from the list of devices, and delete it asynchronously. |entry|
   // may be freed by this function.
   void DestroyDeviceEntryIfNoClients(DeviceEntry* entry);
 
   // Helpers to report an event to our Listener.
   void OnOpened(MediaStreamType type,
                 media::VideoCaptureSessionId capture_session_id);
   void OnClosed(MediaStreamType type,
@@ skipping 21 matching lines @@
   // Consolidates the cached devices list with the list of currently connected
   // devices in the system |names_snapshot|. Retrieves the supported formats of
   // the new devices and sends the new cache to OnDevicesInfoEnumerated().
   void ConsolidateDevicesInfoOnDeviceThread(
       base::Callback<void(const media::VideoCaptureDeviceInfos&)>
           on_devices_enumerated_callback,
       MediaStreamType stream_type,
       const media::VideoCaptureDeviceInfos& old_device_info_cache,
       scoped_ptr<media::VideoCaptureDevice::Names> names_snapshot);
 
-  // Creates and Starts a new VideoCaptureDevice, storing the result in
-  // |entry->video_capture_device|. Ownership of |client| passes to
+  // Starting a capture device can take 1-2 seconds.
+  // To avoid multiple unnecessary start/stop commands to the OS, each start
+  // request is queued in |device_start_queue_|.
+  // QueueStartDevice creates a new entry in |device_start_queue_| and posts a
+  // request to start the device on the device thread unless there is
+  // another request pending start.
+  void QueueStartDevice(media::VideoCaptureSessionId session_id,
+                        DeviceEntry* entry,
+                        const media::VideoCaptureParams& params);
+  void OnDeviceStarted(int serial_id,
+                       scoped_ptr<media::VideoCaptureDevice> device);
+  void DoStopDevice(DeviceEntry* entry);
+  void HandleQueuedStartRequest();
+
+  // Creates and Starts a new VideoCaptureDevice. The resulting
+  // VideoCaptureDevice is returned to the IO-thread and stored in
+  // a DeviceEntry in |devices_|. Ownership of |client| passes to
   // the device.
-  void DoStartDeviceOnDeviceThread(
+  scoped_ptr<media::VideoCaptureDevice> DoStartDeviceOnDeviceThread(
       media::VideoCaptureSessionId session_id,
-      DeviceEntry* entry,
+      const std::string& device_id,
+      MediaStreamType stream_type,
       const media::VideoCaptureParams& params,
       scoped_ptr<media::VideoCaptureDevice::Client> client);
 
   // Stops and destroys the VideoCaptureDevice held in
-  // |entry->video_capture_device|.
-  void DoStopDeviceOnDeviceThread(DeviceEntry* entry);
+  // |device|.
+  void DoStopDeviceOnDeviceThread(scoped_ptr<media::VideoCaptureDevice> device);
 
   media::VideoCaptureDeviceInfo* FindDeviceInfoById(
       const std::string& id,
       media::VideoCaptureDeviceInfos& device_vector);
 
-  void SetDesktopCaptureWindowIdOnDeviceThread(DeviceEntry* entry,
-                                               gfx::NativeViewId window_id);
+  void SetDesktopCaptureWindowIdOnDeviceThread(
+      media::VideoCaptureDevice* device,
+      gfx::NativeViewId window_id);
 
   void SaveDesktopCaptureWindowIdOnDeviceThread(
       media::VideoCaptureSessionId session_id,
       gfx::NativeViewId window_id);
 
   // The message loop of media stream device thread, where VCD's live.
   scoped_refptr<base::SingleThreadTaskRunner> device_task_runner_;
 
   // Only accessed on Browser::IO thread.
   MediaStreamProviderListener* listener_;
   media::VideoCaptureSessionId new_capture_session_id_;
 
   typedef std::map<media::VideoCaptureSessionId, MediaStreamDevice> SessionMap;
   // An entry is kept in this map for every session that has been created via
   // the Open() entry point. The keys are session_id's. This map is used to
   // determine which device to use when StartCaptureForClient() occurs. Used
   // only on the IO thread.
   SessionMap sessions_;
 
   // An entry, kept in a map, that owns a VideoCaptureDevice and its associated
   // VideoCaptureController. VideoCaptureManager owns all VideoCaptureDevices
   // and VideoCaptureControllers and is responsible for deleting the instances
   // when they are not used any longer.
   //
   // The set of currently started VideoCaptureDevice and VideoCaptureController
-  // objects is only accessed from IO thread, though the DeviceEntry instances
-  // themselves may visit to the device thread for device creation and
-  // destruction.
-  struct DeviceEntry {
+  // objects is only accessed from IO thread.
+  class DeviceEntry {
+   public:
     DeviceEntry(MediaStreamType stream_type,
                 const std::string& id,
                 scoped_ptr<VideoCaptureController> controller);
     ~DeviceEntry();
 
+    const int serial_id;
     const MediaStreamType stream_type;
     const std::string id;
 
-    // The controller. Only used from the IO thread.
-    scoped_ptr<VideoCaptureController> video_capture_controller;
+    VideoCaptureController* video_capture_controller();
+    media::VideoCaptureDevice* video_capture_device();
 
-    // The capture device. Only used from the device thread.
-    scoped_ptr<media::VideoCaptureDevice> video_capture_device;
+    void SetVideoCaptureDevice(scoped_ptr<media::VideoCaptureDevice> device);
+    scoped_ptr<media::VideoCaptureDevice> ReleaseVideoCaptureDevice();
+
+   private:
+    // The controller.
+    scoped_ptr<VideoCaptureController> video_capture_controller_;
+
+    // The capture device.
+    scoped_ptr<media::VideoCaptureDevice> video_capture_device_;
+
+    base::ThreadChecker thread_checker_;
   };
-  typedef std::set<DeviceEntry*> DeviceEntries;
+
+  typedef ScopedVector<DeviceEntry> DeviceEntries;
+  // Currently opened devices. The device may or may not be started.
   DeviceEntries devices_;
 
+  // Class used for queuing request for starting a device.
+  class CaptureDeviceStartRequest {
+   public:
+    CaptureDeviceStartRequest(
+        int serial_id,
+        media::VideoCaptureSessionId session_id,
+        const media::VideoCaptureParams& params);
+    int serial_id() const { return serial_id_;}
+    media::VideoCaptureSessionId session_id() const { return session_id_; }
+    media::VideoCaptureParams params() const { return params_; }
+
+    // Set to true if the device should be stopped before it has successfully
+    // been started.
+    bool abort_start() const { return abort_start_; }
+    void set_abort_start() { abort_start_ = true; }
+
+   private:
+    const int serial_id_;
+    const media::VideoCaptureSessionId session_id_;
+    const media::VideoCaptureParams params_;
+    // Set to true if the device should be stopped before it has successfully
+    // been started.
+    bool abort_start_;
+  };
+
+  typedef std::list<CaptureDeviceStartRequest> DeviceStartQueue;
+  DeviceStartQueue device_start_queue_;
+
   // Device creation factory injected on construction from MediaStreamManager or
   // from the test harness.
   scoped_ptr<media::VideoCaptureDeviceFactory> video_capture_device_factory_;
 
   // Local cache of the enumerated video capture devices' names and capture
   // supported formats. A snapshot of the current devices and their capabilities
   // is composed in VideoCaptureDeviceFactory::EnumerateDeviceNames() and
   // ConsolidateDevicesInfoOnDeviceThread(), and this snapshot is used to update
   // this list in OnDevicesInfoEnumerated(). GetDeviceSupportedFormats() will
   // use this list if the device is not started, otherwise it will retrieve the
   // active device capture format from the VideoCaptureController associated.
   media::VideoCaptureDeviceInfos devices_info_cache_;
 
   // Accessed on the device thread only.
   std::map<media::VideoCaptureSessionId, gfx::NativeViewId>
       notification_window_ids_;
 
   DISALLOW_COPY_AND_ASSIGN(VideoCaptureManager);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_RENDERER_HOST_MEDIA_VIDEO_CAPTURE_MANAGER_H_