Implement IPCs and VideoCapture::Client interfaces for texture capture

content/browser/renderer_host/media/video_capture_controller_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.
 
 // Unit test for VideoCaptureController.
 
 #include <string>
 
 #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.h"
 #include "base/run_loop.h"
 #include "content/browser/renderer_host/media/media_stream_provider.h"
 #include "content/browser/renderer_host/media/video_capture_controller.h"
 #include "content/browser/renderer_host/media/video_capture_controller_event_handler.h"
 #include "content/browser/renderer_host/media/video_capture_manager.h"
 #include "content/common/media/media_stream_options.h"
 #include "content/public/test/test_browser_thread_bundle.h"
-#include "media/base/video_frame.h"
+#include "gpu/command_buffer/common/mailbox_holder.h"
 #include "media/base/video_util.h"
 #include "media/video/capture/video_capture_types.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 using ::testing::InSequence;
 using ::testing::Mock;
 
 namespace content {
 
 class MockVideoCaptureControllerEventHandler
     : public VideoCaptureControllerEventHandler {
  public:
   explicit MockVideoCaptureControllerEventHandler(
       VideoCaptureController* controller)
       : controller_(controller) {}
   virtual ~MockVideoCaptureControllerEventHandler() {}
 
   // These mock methods are delegated to by our fake implementation of
   // VideoCaptureControllerEventHandler, to be used in EXPECT_CALL().
   MOCK_METHOD1(DoBufferCreated, void(const VideoCaptureControllerID&));
   MOCK_METHOD1(DoBufferDestroyed, void(const VideoCaptureControllerID&));
   MOCK_METHOD1(DoBufferReady, void(const VideoCaptureControllerID&));
+  MOCK_METHOD1(DoMailboxBufferReady, void(const VideoCaptureControllerID&));
   MOCK_METHOD1(DoEnded, void(const VideoCaptureControllerID&));
   MOCK_METHOD1(DoError, void(const VideoCaptureControllerID&));
 
   virtual void OnError(const VideoCaptureControllerID& id) OVERRIDE {
     DoError(id);
   }
   virtual void OnBufferCreated(const VideoCaptureControllerID& id,
                                base::SharedMemoryHandle handle,
                                int length, int buffer_id) OVERRIDE {
     DoBufferCreated(id);
   }
   virtual void OnBufferDestroyed(const VideoCaptureControllerID& id,
                                  int buffer_id) OVERRIDE {
     DoBufferDestroyed(id);
   }
   virtual void OnBufferReady(const VideoCaptureControllerID& id,
                              int buffer_id,
-                             base::TimeTicks timestamp,
-                             const media::VideoCaptureFormat& format) OVERRIDE {
+                             const media::VideoCaptureFormat& format,
+                             base::TimeTicks timestamp) OVERRIDE {
     DoBufferReady(id);
-    base::MessageLoop::current()->PostTask(FROM_HERE,
+    base::MessageLoop::current()->PostTask(
+        FROM_HERE,
         base::Bind(&VideoCaptureController::ReturnBuffer,
-                   base::Unretained(controller_), id, this, buffer_id));
+                   base::Unretained(controller_),
+                   id,
+                   this,
+                   buffer_id,
+                   0));
+  }
+  virtual void OnMailboxBufferReady(const VideoCaptureControllerID& id,
+                                    int buffer_id,
+                                    const gpu::MailboxHolder& mailbox_holder,
+                                    const media::VideoCaptureFormat& format,
+                                    base::TimeTicks timestamp) OVERRIDE {
+    DoMailboxBufferReady(id);
+    // Use a very different syncpoint value when returning a new syncpoint.
+    const uint32 new_sync_point = ~mailbox_holder.sync_point;
+    base::MessageLoop::current()->PostTask(
+        FROM_HERE,
+        base::Bind(&VideoCaptureController::ReturnBuffer,
+                   base::Unretained(controller_),
+                   id,
+                   this,
+                   buffer_id,
+                   new_sync_point));
   }
   virtual void OnEnded(const VideoCaptureControllerID& id) OVERRIDE {
     DoEnded(id);
     // OnEnded() must respond by (eventually) unregistering the client.
     base::MessageLoop::current()->PostTask(FROM_HERE,
         base::Bind(base::IgnoreResult(&VideoCaptureController::RemoveClient),
                    base::Unretained(controller_), id, this));
   }
 
   VideoCaptureController* controller_;
@@ skipping 14 matching lines @@
     client_a_.reset(new MockVideoCaptureControllerEventHandler(
         controller_.get()));
     client_b_.reset(new MockVideoCaptureControllerEventHandler(
         controller_.get()));
   }
 
   virtual void TearDown() OVERRIDE {
     base::RunLoop().RunUntilIdle();
   }
 
-  TestBrowserThreadBundle bindle_;
+  scoped_refptr<media::VideoFrame> WrapI420Buffer(
+      const scoped_refptr<media::VideoCaptureDevice::Client::Buffer>& buffer,
+      gfx::Size dimensions) {
+    return media::VideoFrame::WrapExternalPackedMemory(
+        media::VideoFrame::I420,
+        dimensions,
+        gfx::Rect(dimensions),
+        dimensions,
+        reinterpret_cast<uint8*>(buffer->data()),
+        media::VideoFrame::AllocationSize(media::VideoFrame::I420, dimensions),
+        base::SharedMemory::NULLHandle(),
+        base::TimeDelta(),
+        base::Closure());
+  }
+
+  scoped_refptr<media::VideoFrame> WrapMailboxBuffer(
+      const scoped_refptr<media::VideoCaptureDevice::Client::Buffer>& buffer,
+      scoped_ptr<gpu::MailboxHolder> holder,
+      const media::VideoFrame::ReleaseMailboxCB& release_cb,
+      gfx::Size dimensions) {
+    return media::VideoFrame::WrapNativeTexture(
+        holder.Pass(),
+        release_cb,
+        dimensions,
+        gfx::Rect(dimensions),
+        dimensions,
+        base::TimeDelta(),
+        media::VideoFrame::ReadPixelsCB());
+  }
+
+  TestBrowserThreadBundle bundle_;
   scoped_ptr<MockVideoCaptureControllerEventHandler> client_a_;
   scoped_ptr<MockVideoCaptureControllerEventHandler> client_b_;
   scoped_ptr<VideoCaptureController> controller_;
   scoped_ptr<media::VideoCaptureDevice::Client> device_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(VideoCaptureControllerTest);
 };
 
 // A simple test of VideoCaptureController's ability to add, remove, and keep
@@ skipping 89 matching lines @@
   ASSERT_EQ(1, controller_->GetClientCount())
       << "Removing non-existant session 200 should be a no-op.";
   ASSERT_EQ(400,
       controller_->RemoveClient(client_b_route_2, client_b_.get()))
       << "Removing client B/2 should return its session_id.";
   // Clients in controller: []
   ASSERT_EQ(0, controller_->GetClientCount())
       << "Client count should return to zero after all clients are gone.";
 }
 
+static void CacheSyncPoint(uint32* sync_value,
+                           scoped_ptr<gpu::MailboxHolder> mailbox_holder) {
+  *sync_value = mailbox_holder->sync_point;
+}
+
 // This test will connect and disconnect several clients while simulating an
 // active capture device being started and generating frames. It runs on one
 // thread and is intended to behave deterministically.
 TEST_F(VideoCaptureControllerTest, NormalCaptureMultipleClients) {
   media::VideoCaptureParams session_100;
   session_100.requested_format = media::VideoCaptureFormat(
       gfx::Size(320, 240), 30, media::PIXEL_FORMAT_I420);
 
   media::VideoCaptureParams session_200 = session_100;
 
@@ skipping 47 matching lines @@
   {
     InSequence s;
     EXPECT_CALL(*client_b_, DoBufferCreated(client_b_route_1)).Times(1);
     EXPECT_CALL(*client_b_, DoBufferReady(client_b_route_1)).Times(1);
   }
   {
     InSequence s;
     EXPECT_CALL(*client_a_, DoBufferCreated(client_a_route_2)).Times(1);
     EXPECT_CALL(*client_a_, DoBufferReady(client_a_route_2)).Times(1);
   }
-  device_->OnIncomingCapturedBuffer(buffer,
-                                    media::VideoFrame::I420,
-                                    capture_resolution,
-                                    base::TimeTicks(),
-                                    device_format.frame_rate);
+  device_->OnIncomingCapturedVideoFrame(
+      buffer,
+      media::VideoCaptureFormat(capture_resolution,
+                                device_format.frame_rate,
+                                media::PIXEL_FORMAT_I420),
+      WrapI420Buffer(buffer, capture_resolution),
+      base::TimeTicks());
   buffer = NULL;
 
   base::RunLoop().RunUntilIdle();
   Mock::VerifyAndClearExpectations(client_a_.get());
   Mock::VerifyAndClearExpectations(client_b_.get());
 
   // Second buffer which ought to use the same shared memory buffer. In this
   // case pretend that the Buffer pointer is held by the device for a long
   // delay. This shouldn't affect anything.
   buffer =
       device_->ReserveOutputBuffer(media::VideoFrame::I420, capture_resolution);
   ASSERT_TRUE(buffer);
   memset(buffer->data(), buffer_no++, buffer->size());
-  device_->OnIncomingCapturedBuffer(buffer,
-                                    media::VideoFrame::I420,
-                                    capture_resolution,
-                                    base::TimeTicks(),
-                                    device_format.frame_rate);
+  device_->OnIncomingCapturedVideoFrame(
+      buffer,
+      media::VideoCaptureFormat(capture_resolution,
+                                device_format.frame_rate,
+                                media::PIXEL_FORMAT_I420),
+      WrapI420Buffer(buffer, capture_resolution),
+      base::TimeTicks());
   buffer = NULL;
 
   // The buffer should be delivered to the clients in any order.
   EXPECT_CALL(*client_a_, DoBufferReady(client_a_route_1)).Times(1);
   EXPECT_CALL(*client_b_, DoBufferReady(client_b_route_1)).Times(1);
   EXPECT_CALL(*client_a_, DoBufferReady(client_a_route_2)).Times(1);
   base::RunLoop().RunUntilIdle();
   Mock::VerifyAndClearExpectations(client_a_.get());
   Mock::VerifyAndClearExpectations(client_b_.get());
 
   // Add a fourth client now that some buffers have come through.
   controller_->AddClient(client_b_route_2,
                          client_b_.get(),
                          base::kNullProcessHandle,
                          1,
                          session_1);
   Mock::VerifyAndClearExpectations(client_b_.get());
 
   // Third, fourth, and fifth buffers. Pretend they all arrive at the same time.
   for (int i = 0; i < kPoolSize; i++) {
     buffer = device_->ReserveOutputBuffer(media::VideoFrame::I420,
                                           capture_resolution);
     ASSERT_TRUE(buffer);
     memset(buffer->data(), buffer_no++, buffer->size());
-    device_->OnIncomingCapturedBuffer(buffer,
-                                      media::VideoFrame::I420,
-                                      capture_resolution,
-                                      base::TimeTicks(),
-                                      device_format.frame_rate);
+    device_->OnIncomingCapturedVideoFrame(
+        buffer,
+        media::VideoCaptureFormat(capture_resolution,
+                                  device_format.frame_rate,
+                                  media::PIXEL_FORMAT_I420),
+        WrapI420Buffer(buffer, capture_resolution),
+        base::TimeTicks());
     buffer = NULL;
   }
   // ReserveOutputBuffer ought to fail now, because the pool is depleted.
   ASSERT_FALSE(device_->ReserveOutputBuffer(media::VideoFrame::I420,
                                             capture_resolution));
 
   // The new client needs to be told of 3 buffers; the old clients only 2.
   EXPECT_CALL(*client_b_, DoBufferCreated(client_b_route_2)).Times(kPoolSize);
   EXPECT_CALL(*client_b_, DoBufferReady(client_b_route_2)).Times(kPoolSize);
   EXPECT_CALL(*client_a_, DoBufferCreated(client_a_route_1))
@@ skipping 13 matching lines @@
   // Kill A1 via renderer disconnect (synchronous).
   controller_->RemoveClient(client_a_route_1, client_a_.get());
   // Kill B1 via session close (posts a task to disconnect).
   EXPECT_CALL(*client_b_, DoEnded(client_b_route_1)).Times(1);
   controller_->StopSession(300);
   // Queue up another buffer.
   buffer =
       device_->ReserveOutputBuffer(media::VideoFrame::I420, capture_resolution);
   ASSERT_TRUE(buffer);
   memset(buffer->data(), buffer_no++, buffer->size());
-  device_->OnIncomingCapturedBuffer(buffer,
-                                    media::VideoFrame::I420,
-                                    capture_resolution,
-                                    base::TimeTicks(),
-                                    device_format.frame_rate);
+  device_->OnIncomingCapturedVideoFrame(
+      buffer,
+      media::VideoCaptureFormat(capture_resolution,
+                                device_format.frame_rate,
+                                media::PIXEL_FORMAT_I420),
+      WrapI420Buffer(buffer, capture_resolution),
+      base::TimeTicks());
   buffer = NULL;
   buffer =
       device_->ReserveOutputBuffer(media::VideoFrame::I420, capture_resolution);
   {
     // Kill A2 via session close (posts a task to disconnect, but A2 must not
     // be sent either of these two buffers).
     EXPECT_CALL(*client_a_, DoEnded(client_a_route_2)).Times(1);
     controller_->StopSession(200);
   }
   ASSERT_TRUE(buffer);
   memset(buffer->data(), buffer_no++, buffer->size());
-  device_->OnIncomingCapturedBuffer(buffer,
-                                    media::VideoFrame::I420,
-                                    capture_resolution,
-                                    base::TimeTicks(),
-                                    device_format.frame_rate);
+  device_->OnIncomingCapturedVideoFrame(
+      buffer,
+      media::VideoCaptureFormat(capture_resolution,
+                                device_format.frame_rate,
+                                media::PIXEL_FORMAT_I420),
+      WrapI420Buffer(buffer, capture_resolution),
+      base::TimeTicks());
   buffer = NULL;
   // B2 is the only client left, and is the only one that should
   // get the buffer.
   EXPECT_CALL(*client_b_, DoBufferReady(client_b_route_2)).Times(2);
   base::RunLoop().RunUntilIdle();
   Mock::VerifyAndClearExpectations(client_a_.get());
   Mock::VerifyAndClearExpectations(client_b_.get());
+
+  // Allocate all buffers from the buffer pool, half as SHM buffer and half as
+  // mailbox buffers.  Make sure of different counts though.
+  int shm_buffers = kPoolSize / 2;
+  int mailbox_buffers = kPoolSize - shm_buffers;
+  if (shm_buffers == mailbox_buffers) {
+    shm_buffers--;
+    mailbox_buffers++;
+  }
+
+  for (int i = 0; i < shm_buffers; ++i) {
+    buffer = device_->ReserveOutputBuffer(media::VideoFrame::I420,
+                                          capture_resolution);
+    ASSERT_TRUE(buffer);
+    device_->OnIncomingCapturedVideoFrame(
+        buffer,
+        media::VideoCaptureFormat(capture_resolution,
+                                  device_format.frame_rate,
+                                  media::PIXEL_FORMAT_I420),
+        WrapI420Buffer(buffer, capture_resolution),
+        base::TimeTicks());
+    buffer = NULL;
+  }
+  std::vector<uint32> mailbox_syncpoints(mailbox_buffers);
+  std::vector<uint32> mailbox_syncpoints_new(mailbox_buffers);
+  for (int i = 0; i < mailbox_buffers; ++i) {
+    buffer = device_->ReserveOutputBuffer(media::VideoFrame::NATIVE_TEXTURE,
+                                          gfx::Size(0, 0));
+    ASSERT_TRUE(buffer);
+    mailbox_syncpoints[i] = i;
+    device_->OnIncomingCapturedVideoFrame(
+        buffer,
+        media::VideoCaptureFormat(capture_resolution,
+                                  device_format.frame_rate,
+                                  media::PIXEL_FORMAT_TEXTURE),
+        WrapMailboxBuffer(
+            buffer,
+            make_scoped_ptr(new gpu::MailboxHolder(
+                gpu::Mailbox(), 0, mailbox_syncpoints[i])),
+            base::Bind(&CacheSyncPoint, &mailbox_syncpoints_new[i]),
+            capture_resolution),
+        base::TimeTicks());
+    buffer = NULL;
+  }
+  // ReserveOutputBuffers ought to fail now regardless of buffer format, because
+  // the pool is depleted.
+  ASSERT_FALSE(device_->ReserveOutputBuffer(media::VideoFrame::I420,
+                                            capture_resolution));
+  ASSERT_FALSE(device_->ReserveOutputBuffer(media::VideoFrame::NATIVE_TEXTURE,
+                                            gfx::Size(0, 0)));
+  EXPECT_CALL(*client_b_, DoBufferReady(client_b_route_2)).Times(shm_buffers);
+  EXPECT_CALL(*client_b_, DoMailboxBufferReady(client_b_route_2))
+      .Times(mailbox_buffers);
+  base::RunLoop().RunUntilIdle();
+  for (size_t i = 0; i < mailbox_syncpoints.size(); ++i) {
+    // See: MockVideoCaptureControllerEventHandler::OnMailboxBufferReady()
+    ASSERT_EQ(mailbox_syncpoints[i], ~mailbox_syncpoints_new[i]);
+  }
+  Mock::VerifyAndClearExpectations(client_b_.get());
 }
 
 // Exercises the OnError() codepath of VideoCaptureController, and tests the
 // behavior of various operations after the error state has been signalled.
 TEST_F(VideoCaptureControllerTest, ErrorBeforeDeviceCreation) {
   media::VideoCaptureParams session_100;
   session_100.requested_format = media::VideoCaptureFormat(
       gfx::Size(320, 240), 30, media::PIXEL_FORMAT_I420);
 
   media::VideoCaptureParams session_200 = session_100;
@@ skipping 15 matching lines @@
   EXPECT_CALL(*client_b_, DoError(route_id)).Times(1);
   controller_->AddClient(
       route_id, client_b_.get(), base::kNullProcessHandle, 200, session_200);
   base::RunLoop().RunUntilIdle();
   Mock::VerifyAndClearExpectations(client_b_.get());
 
   scoped_refptr<media::VideoCaptureDevice::Client::Buffer> buffer =
       device_->ReserveOutputBuffer(media::VideoFrame::I420, capture_resolution);
   ASSERT_TRUE(buffer);
 
-  device_->OnIncomingCapturedBuffer(buffer,
-                                    media::VideoFrame::I420,
-                                    capture_resolution,
-                                    base::TimeTicks(),
-                                    30);
+  device_->OnIncomingCapturedVideoFrame(
+      buffer,
+      media::VideoCaptureFormat(
+          capture_resolution, 30, media::PIXEL_FORMAT_I420),
+      WrapI420Buffer(buffer, capture_resolution),
+      base::TimeTicks());
   buffer = NULL;
 
   base::RunLoop().RunUntilIdle();
 }
 
 // Exercises the OnError() codepath of VideoCaptureController, and tests the
 // behavior of various operations after the error state has been signalled.
 TEST_F(VideoCaptureControllerTest, ErrorAfterDeviceCreation) {
   media::VideoCaptureParams session_100;
   session_100.requested_format = media::VideoCaptureFormat(
@@ skipping 14 matching lines @@
   // should not be.
   base::RunLoop().RunUntilIdle();
   Mock::VerifyAndClearExpectations(client_a_.get());
 
   const gfx::Size dims(320, 240);
   scoped_refptr<media::VideoCaptureDevice::Client::Buffer> buffer =
       device_->ReserveOutputBuffer(media::VideoFrame::I420, dims);
   ASSERT_TRUE(buffer);
 
   device_->OnError("Test error");
-  device_->OnIncomingCapturedBuffer(buffer,
-                                    media::VideoFrame::I420,
-                                    dims,
-                                    base::TimeTicks(),
-                                    device_format.frame_rate);
+  device_->OnIncomingCapturedVideoFrame(
+      buffer,
+      media::VideoCaptureFormat(
+          dims, device_format.frame_rate, media::PIXEL_FORMAT_I420),
+      WrapI420Buffer(buffer, dims),
+      base::TimeTicks());
   buffer = NULL;
 
   EXPECT_CALL(*client_a_, DoError(route_id)).Times(1);
   base::RunLoop().RunUntilIdle();
   Mock::VerifyAndClearExpectations(client_a_.get());
 
   // Second client connects after the error state. It also should get told of
   // the error.
   EXPECT_CALL(*client_b_, DoError(route_id)).Times(1);
   controller_->AddClient(
       route_id, client_b_.get(), base::kNullProcessHandle, 200, session_200);
   Mock::VerifyAndClearExpectations(client_b_.get());
 }
 
 }  // namespace content