VideoCaptureDeviceFactory: Change device enumeration to callback + QTKit enumerates in UI thread.

media/video/capture/video_capture_device_unittest.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 "base/bind.h"
+#include "base/bind_helpers.h"
+#include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop/message_loop_proxy.h"
 #include "base/run_loop.h"
 #include "base/test/test_timeouts.h"
 #include "base/threading/thread.h"
 #include "media/video/capture/video_capture_device.h"
 #include "media/video/capture/video_capture_device_factory.h"
 #include "media/video/capture/video_capture_types.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 #if defined(OS_WIN)
 #include "base/win/scoped_com_initializer.h"
 #include "media/video/capture/win/video_capture_device_factory_win.h"
 #endif
 
+#if defined(OS_MACOSX)
+#include "media/video/capture/mac/video_capture_device_factory_mac.h"
+#endif
+
 #if defined(OS_ANDROID)
 #include "base/android/jni_android.h"
 #include "media/video/capture/android/video_capture_device_android.h"
 #endif
 
 #if defined(OS_MACOSX)
 // Mac/QTKit will always give you the size you ask for and this case will fail.
 #define MAYBE_AllocateBadSize DISABLED_AllocateBadSize
 // We will always get YUYV from the Mac QTKit/AVFoundation implementations.
 #define MAYBE_CaptureMjpeg DISABLED_CaptureMjpeg
@@ skipping 12 matching lines @@
 #define MAYBE_AllocateBadSize DISABLED_AllocateBadSize
 #define ReAllocateCamera DISABLED_ReAllocateCamera
 #define DeAllocateCameraWhileRunning DISABLED_DeAllocateCameraWhileRunning
 #define DeAllocateCameraWhileRunning DISABLED_DeAllocateCameraWhileRunning
 #define MAYBE_CaptureMjpeg DISABLED_CaptureMjpeg
 #else
 #define MAYBE_AllocateBadSize AllocateBadSize
 #define MAYBE_CaptureMjpeg CaptureMjpeg
 #endif
 
+using ::testing::_;
+using ::testing::SaveArg;
+
 namespace media {
 
 class MockClient : public media::VideoCaptureDevice::Client {
  public:
   MOCK_METHOD2(ReserveOutputBuffer,
                scoped_refptr<Buffer>(media::VideoFrame::Format format,
                                      const gfx::Size& dimensions));
   MOCK_METHOD0(OnErr, void());
 
   explicit MockClient(base::Callback<void(const VideoCaptureFormat&)> frame_cb)
@@ skipping 17 matching lines @@
       const scoped_refptr<media::VideoFrame>& frame,
       base::TimeTicks timestamp) OVERRIDE {
     NOTREACHED();
   }
 
  private:
   scoped_refptr<base::SingleThreadTaskRunner> main_thread_;
   base::Callback<void(const VideoCaptureFormat&)> frame_cb_;
 };
 
+class DeviceEnumerationListener :
+    public base::RefCounted<DeviceEnumerationListener>{
+ public:
+  MOCK_METHOD1(OnEnumeratedDevicesCallbackPtr,
+               void(media::VideoCaptureDevice::Names* names));
+  // GMock doesn't support move-only arguments, so we use this forward method.
+  void OnEnumeratedDevicesCallback(
+      scoped_ptr<media::VideoCaptureDevice::Names> names) {
+    OnEnumeratedDevicesCallbackPtr(names.release());
+  }
+ private:
+  friend class base::RefCounted<DeviceEnumerationListener>;
+  virtual ~DeviceEnumerationListener() {}
+};
+
 class VideoCaptureDeviceTest : public testing::Test {
  protected:
   typedef media::VideoCaptureDevice::Client Client;
 
   VideoCaptureDeviceTest()
       : loop_(new base::MessageLoop()),
         client_(
             new MockClient(base::Bind(&VideoCaptureDeviceTest::OnFrameCaptured,
                                       base::Unretained(this)))),
-        video_capture_device_factory_(
-            VideoCaptureDeviceFactory::CreateFactory()) {}
+        video_capture_device_factory_(VideoCaptureDeviceFactory::CreateFactory(
+            base::MessageLoopProxy::current())) {
+    device_enumeration_listener_ = new DeviceEnumerationListener();
+  }
 
   virtual void SetUp() {
 #if defined(OS_ANDROID)
     media::VideoCaptureDeviceAndroid::RegisterVideoCaptureDevice(
         base::android::AttachCurrentThread());
 #endif
   }
 
   void ResetWithNewClient() {
     client_.reset(new MockClient(base::Bind(
         &VideoCaptureDeviceTest::OnFrameCaptured, base::Unretained(this))));
   }
 
   void OnFrameCaptured(const VideoCaptureFormat& format) {
     last_format_ = format;
     run_loop_->QuitClosure().Run();
   }
 
   void WaitForCapturedFrame() {
     run_loop_.reset(new base::RunLoop());
     run_loop_->Run();
   }
 
+  scoped_ptr<media::VideoCaptureDevice::Names> EnumerateDevices() {
+    media::VideoCaptureDevice::Names* names;
+    EXPECT_CALL(*device_enumeration_listener_,
+                OnEnumeratedDevicesCallbackPtr(_)).WillOnce(SaveArg<0>(&names));
+
+    video_capture_device_factory_->EnumerateDeviceNames(
+        base::Bind(&DeviceEnumerationListener::OnEnumeratedDevicesCallback,
+                   device_enumeration_listener_));
+    base::MessageLoop::current()->RunUntilIdle();
+    return scoped_ptr<media::VideoCaptureDevice::Names>(names);
+  }
+
   const VideoCaptureFormat& last_format() const { return last_format_; }
 
   scoped_ptr<VideoCaptureDevice::Name> GetFirstDeviceNameSupportingPixelFormat(
       const VideoPixelFormat& pixel_format) {
-    video_capture_device_factory_->GetDeviceNames(&names_);
-    if (!names_.size()) {
+    names_ = EnumerateDevices();
+    if (!names_->size()) {
       DVLOG(1) << "No camera available.";
       return scoped_ptr<VideoCaptureDevice::Name>();
     }
     VideoCaptureDevice::Names::iterator names_iterator;
-    for (names_iterator = names_.begin(); names_iterator != names_.end();
+    for (names_iterator = names_->begin(); names_iterator != names_->end();
          ++names_iterator) {
       VideoCaptureFormats supported_formats;
       video_capture_device_factory_->GetDeviceSupportedFormats(
           *names_iterator,
           &supported_formats);
       VideoCaptureFormats::iterator formats_iterator;
       for (formats_iterator = supported_formats.begin();
            formats_iterator != supported_formats.end(); ++formats_iterator) {
         if (formats_iterator->pixel_format == pixel_format) {
           return scoped_ptr<VideoCaptureDevice::Name>(
               new VideoCaptureDevice::Name(*names_iterator));
         }
       }
     }
     DVLOG(1) << "No camera can capture the format: " << pixel_format;
     return scoped_ptr<VideoCaptureDevice::Name>();
   }
 
 #if defined(OS_WIN)
   base::win::ScopedCOMInitializer initialize_com_;
 #endif
-  VideoCaptureDevice::Names names_;
+  scoped_ptr<VideoCaptureDevice::Names> names_;
   scoped_ptr<base::MessageLoop> loop_;
   scoped_ptr<base::RunLoop> run_loop_;
   scoped_ptr<MockClient> client_;
+  scoped_refptr<DeviceEnumerationListener> device_enumeration_listener_;
   VideoCaptureFormat last_format_;
   scoped_ptr<VideoCaptureDeviceFactory> video_capture_device_factory_;
 };
 
 TEST_F(VideoCaptureDeviceTest, OpenInvalidDevice) {
 #if defined(OS_WIN)
   VideoCaptureDevice::Name::CaptureApiType api_type =
       VideoCaptureDeviceFactoryWin::PlatformSupportsMediaFoundation()
           ? VideoCaptureDevice::Name::MEDIA_FOUNDATION
           : VideoCaptureDevice::Name::DIRECT_SHOW;
   VideoCaptureDevice::Name device_name("jibberish", "jibberish", api_type);
 #elif defined(OS_MACOSX)
   VideoCaptureDevice::Name device_name("jibberish", "jibberish",
-      VideoCaptureDevice::Name::AVFOUNDATION);
+      VideoCaptureDeviceFactoryMac::PlatformSupportsAVFoundation()
+          ? VideoCaptureDevice::Name::AVFOUNDATION
+          : VideoCaptureDevice::Name::QTKIT);
 #else
   VideoCaptureDevice::Name device_name("jibberish", "jibberish");
 #endif
   scoped_ptr<VideoCaptureDevice> device =
-      video_capture_device_factory_->Create(
-          base::MessageLoopProxy::current(),
-          device_name);
+      video_capture_device_factory_->Create(device_name);
+#if !defined(OS_MACOSX)
   EXPECT_TRUE(device == NULL);
+#else
+  if (VideoCaptureDeviceFactoryMac::PlatformSupportsAVFoundation()) {
+    EXPECT_TRUE(device == NULL);
+  } else {
+    // The presence of the actual device is only checked on AllocateAndStart()
+    // and not on creation for QTKit API in Mac OS X platform.
+    EXPECT_CALL(*client_, OnErr()).Times(1);
+
+    VideoCaptureParams capture_params;
+    capture_params.requested_format.frame_size.SetSize(640, 480);
+    capture_params.requested_format.frame_rate = 30;
+    capture_params.requested_format.pixel_format = PIXEL_FORMAT_I420;
+    capture_params.allow_resolution_change = false;
+    device->AllocateAndStart(capture_params, client_.PassAs<Client>());
+  }
+#endif
 }
 
 TEST_F(VideoCaptureDeviceTest, CaptureVGA) {
-  video_capture_device_factory_->GetDeviceNames(&names_);
-  if (!names_.size()) {
+  names_ = EnumerateDevices();
+  if (!names_->size()) {
     DVLOG(1) << "No camera available. Exiting test.";
     return;
   }
 
   scoped_ptr<VideoCaptureDevice> device(
-      video_capture_device_factory_->Create(base::MessageLoopProxy::current(),
-                                            names_.front()));
+      video_capture_device_factory_->Create(names_->front()));
   ASSERT_TRUE(device);
-  DVLOG(1) << names_.front().id();
+  DVLOG(1) << names_->front().id();
 
   EXPECT_CALL(*client_, OnErr())
       .Times(0);
 
   VideoCaptureParams capture_params;
   capture_params.requested_format.frame_size.SetSize(640, 480);
   capture_params.requested_format.frame_rate = 30;
   capture_params.requested_format.pixel_format = PIXEL_FORMAT_I420;
   capture_params.allow_resolution_change = false;
   device->AllocateAndStart(capture_params, client_.PassAs<Client>());
   // Get captured video frames.
   WaitForCapturedFrame();
   EXPECT_EQ(last_format().frame_size.width(), 640);
   EXPECT_EQ(last_format().frame_size.height(), 480);
   device->StopAndDeAllocate();
 }
 
 TEST_F(VideoCaptureDeviceTest, Capture720p) {
-  video_capture_device_factory_->GetDeviceNames(&names_);
-  if (!names_.size()) {
+  names_ = EnumerateDevices();
+  if (!names_->size()) {
     DVLOG(1) << "No camera available. Exiting test.";
     return;
   }
 
   scoped_ptr<VideoCaptureDevice> device(
-      video_capture_device_factory_->Create(base::MessageLoopProxy::current(),
-                                            names_.front()));
+      video_capture_device_factory_->Create(names_->front()));
   ASSERT_TRUE(device);
 
   EXPECT_CALL(*client_, OnErr())
       .Times(0);
 
   VideoCaptureParams capture_params;
   capture_params.requested_format.frame_size.SetSize(1280, 720);
   capture_params.requested_format.frame_rate = 30;
   capture_params.requested_format.pixel_format = PIXEL_FORMAT_I420;
   capture_params.allow_resolution_change = false;
   device->AllocateAndStart(capture_params, client_.PassAs<Client>());
   // Get captured video frames.
   WaitForCapturedFrame();
   device->StopAndDeAllocate();
 }
 
 TEST_F(VideoCaptureDeviceTest, MAYBE_AllocateBadSize) {
-  video_capture_device_factory_->GetDeviceNames(&names_);
-  if (!names_.size()) {
+  names_ = EnumerateDevices();
+  if (!names_->size()) {
     DVLOG(1) << "No camera available. Exiting test.";
     return;
   }
   scoped_ptr<VideoCaptureDevice> device(
-      video_capture_device_factory_->Create(base::MessageLoopProxy::current(),
-                                            names_.front()));
+      video_capture_device_factory_->Create(names_->front()));
   ASSERT_TRUE(device);
 
   EXPECT_CALL(*client_, OnErr())
       .Times(0);
 
   VideoCaptureParams capture_params;
   capture_params.requested_format.frame_size.SetSize(637, 472);
   capture_params.requested_format.frame_rate = 35;
   capture_params.requested_format.pixel_format = PIXEL_FORMAT_I420;
   capture_params.allow_resolution_change = false;
   device->AllocateAndStart(capture_params, client_.PassAs<Client>());
   WaitForCapturedFrame();
   device->StopAndDeAllocate();
   EXPECT_EQ(last_format().frame_size.width(), 640);
   EXPECT_EQ(last_format().frame_size.height(), 480);
 }
 
 TEST_F(VideoCaptureDeviceTest, ReAllocateCamera) {
-  video_capture_device_factory_->GetDeviceNames(&names_);
-  if (!names_.size()) {
+  names_ = EnumerateDevices();
+  if (!names_->size()) {
     DVLOG(1) << "No camera available. Exiting test.";
     return;
   }
 
   // First, do a number of very fast device start/stops.
   for (int i = 0; i <= 5; i++) {
     ResetWithNewClient();
     scoped_ptr<VideoCaptureDevice> device(
-        video_capture_device_factory_->Create(base::MessageLoopProxy::current(),
-                                              names_.front()));
+        video_capture_device_factory_->Create(names_->front()));
     gfx::Size resolution;
     if (i % 2) {
       resolution = gfx::Size(640, 480);
     } else {
       resolution = gfx::Size(1280, 1024);
     }
     VideoCaptureParams capture_params;
     capture_params.requested_format.frame_size = resolution;
     capture_params.requested_format.frame_rate = 30;
     capture_params.requested_format.pixel_format = PIXEL_FORMAT_I420;
     capture_params.allow_resolution_change = false;
     device->AllocateAndStart(capture_params, client_.PassAs<Client>());
     device->StopAndDeAllocate();
   }
 
   // Finally, do a device start and wait for it to finish.
   VideoCaptureParams capture_params;
   capture_params.requested_format.frame_size.SetSize(320, 240);
   capture_params.requested_format.frame_rate = 30;
   capture_params.requested_format.pixel_format = PIXEL_FORMAT_I420;
   capture_params.allow_resolution_change = false;
 
   ResetWithNewClient();
   scoped_ptr<VideoCaptureDevice> device(
-      video_capture_device_factory_->Create(base::MessageLoopProxy::current(),
-                                            names_.front()));
+      video_capture_device_factory_->Create(names_->front()));
 
   device->AllocateAndStart(capture_params, client_.PassAs<Client>());
   WaitForCapturedFrame();
   device->StopAndDeAllocate();
   device.reset();
   EXPECT_EQ(last_format().frame_size.width(), 320);
   EXPECT_EQ(last_format().frame_size.height(), 240);
 }
 
 TEST_F(VideoCaptureDeviceTest, DeAllocateCameraWhileRunning) {
-  video_capture_device_factory_->GetDeviceNames(&names_);
-  if (!names_.size()) {
+  names_ = EnumerateDevices();
+  if (!names_->size()) {
     DVLOG(1) << "No camera available. Exiting test.";
     return;
   }
   scoped_ptr<VideoCaptureDevice> device(
-      video_capture_device_factory_->Create(base::MessageLoopProxy::current(),
-                                            names_.front()));
+      video_capture_device_factory_->Create(names_->front()));
   ASSERT_TRUE(device);
 
   EXPECT_CALL(*client_, OnErr())
       .Times(0);
 
   VideoCaptureParams capture_params;
   capture_params.requested_format.frame_size.SetSize(640, 480);
   capture_params.requested_format.frame_rate = 30;
   capture_params.requested_format.pixel_format = PIXEL_FORMAT_I420;
   capture_params.allow_resolution_change = false;
   device->AllocateAndStart(capture_params, client_.PassAs<Client>());
   // Get captured video frames.
   WaitForCapturedFrame();
   EXPECT_EQ(last_format().frame_size.width(), 640);
   EXPECT_EQ(last_format().frame_size.height(), 480);
   EXPECT_EQ(last_format().frame_rate, 30);
   device->StopAndDeAllocate();
 }
 
 // Start the camera in 720p to capture MJPEG instead of a raw format.
 TEST_F(VideoCaptureDeviceTest, MAYBE_CaptureMjpeg) {
   scoped_ptr<VideoCaptureDevice::Name> name =
       GetFirstDeviceNameSupportingPixelFormat(PIXEL_FORMAT_MJPEG);
   if (!name) {
     DVLOG(1) << "No camera supports MJPEG format. Exiting test.";
     return;
   }
   scoped_ptr<VideoCaptureDevice> device(
-      video_capture_device_factory_->Create(base::MessageLoopProxy::current(),
-                                            *name));
+      video_capture_device_factory_->Create(*name));
   ASSERT_TRUE(device);
 
   EXPECT_CALL(*client_, OnErr())
       .Times(0);
 
   VideoCaptureParams capture_params;
   capture_params.requested_format.frame_size.SetSize(1280, 720);
   capture_params.requested_format.frame_rate = 30;
   capture_params.requested_format.pixel_format = PIXEL_FORMAT_MJPEG;
   capture_params.allow_resolution_change = false;
@@ skipping 10 matching lines @@
   // Use PIXEL_FORMAT_MAX to iterate all device names for testing
   // GetDeviceSupportedFormats().
   scoped_ptr<VideoCaptureDevice::Name> name =
       GetFirstDeviceNameSupportingPixelFormat(PIXEL_FORMAT_MAX);
   // Verify no camera returned for PIXEL_FORMAT_MAX. Nothing else to test here
   // since we cannot forecast the hardware capabilities.
   ASSERT_FALSE(name);
 }
 
 };  // namespace media