[Mojo Video Capture] Retire buffers when Android Chromium goes to the background

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 "content/browser/renderer_host/media/video_capture_controller.h"
 
 #include <stdint.h>
 #include <string.h>
 
 #include <memory>
 #include <string>
 #include <utility>
 
 #include "base/bind.h"
@@ skipping 34 matching lines @@
   return base::MakeUnique<content::VideoCaptureGpuJpegDecoder>(decode_done_cb);
 }
 
 class MockVideoCaptureControllerEventHandler
     : public VideoCaptureControllerEventHandler {
  public:
   explicit MockVideoCaptureControllerEventHandler(
       VideoCaptureController* controller)
       : controller_(controller), resource_utilization_(-1.0) {}
   ~MockVideoCaptureControllerEventHandler() override {}
+  void set_enable_auto_return_buffer_on_buffer_ready(bool enable) {
+    enable_auto_return_buffer_on_buffer_ready_ = enable;
+  }
 
   // These mock methods are delegated to by our fake implementation of
   // VideoCaptureControllerEventHandler, to be used in EXPECT_CALL().
-  MOCK_METHOD1(DoBufferCreated, void(VideoCaptureControllerID));
-  MOCK_METHOD1(DoBufferDestroyed, void(VideoCaptureControllerID));
+  MOCK_METHOD2(DoBufferCreated, void(VideoCaptureControllerID, int buffer_id));
+  MOCK_METHOD2(DoBufferDestroyed,
+               void(VideoCaptureControllerID, int buffer_id));
   MOCK_METHOD2(DoBufferReady, void(VideoCaptureControllerID, const gfx::Size&));
   MOCK_METHOD1(DoEnded, void(VideoCaptureControllerID));
   MOCK_METHOD1(DoError, void(VideoCaptureControllerID));
 
   void OnError(VideoCaptureControllerID id) override { DoError(id); }
   void OnBufferCreated(VideoCaptureControllerID id,
                        mojo::ScopedSharedBufferHandle handle,
                        int length,
                        int buffer_id) override {
-    DoBufferCreated(id);
+    DoBufferCreated(id, buffer_id);
   }
   void OnBufferDestroyed(VideoCaptureControllerID id, int buffer_id) override {
-    DoBufferDestroyed(id);
+    DoBufferDestroyed(id, buffer_id);
   }
   void OnBufferReady(VideoCaptureControllerID id,
                      int buffer_id,
                      const scoped_refptr<media::VideoFrame>& frame) override {
     EXPECT_EQ(expected_pixel_format_, frame->format());
     base::TimeTicks reference_time;
     EXPECT_TRUE(frame->metadata()->GetTimeTicks(
         media::VideoFrameMetadata::REFERENCE_TIME, &reference_time));
     DoBufferReady(id, frame->coded_size());
-    base::ThreadTaskRunnerHandle::Get()->PostTask(
-        FROM_HERE, base::Bind(&VideoCaptureController::ReturnBuffer,
-                              base::Unretained(controller_), id, this,
-                              buffer_id, resource_utilization_));
+    if (enable_auto_return_buffer_on_buffer_ready_) {
+      base::ThreadTaskRunnerHandle::Get()->PostTask(
+          FROM_HERE, base::Bind(&VideoCaptureController::ReturnBuffer,
+                                base::Unretained(controller_), id, this,
+                                buffer_id, resource_utilization_));
+    }
   }
   void OnEnded(VideoCaptureControllerID id) override {
     DoEnded(id);
     // OnEnded() must respond by (eventually) unregistering the client.
     base::ThreadTaskRunnerHandle::Get()->PostTask(
         FROM_HERE,
         base::Bind(base::IgnoreResult(&VideoCaptureController::RemoveClient),
                    base::Unretained(controller_), id, this));
   }
 
   VideoCaptureController* controller_;
   media::VideoPixelFormat expected_pixel_format_ = media::PIXEL_FORMAT_I420;
   double resource_utilization_;
+  bool enable_auto_return_buffer_on_buffer_ready_ = true;
 };
 
 class MockConsumerFeedbackObserver
     : public media::VideoFrameConsumerFeedbackObserver {
  public:
   MOCK_METHOD2(OnUtilizationReport,
                void(int frame_feedback_id, double utilization));
 };
 
 class MockFrameBufferPool : public media::FrameBufferPool {
  public:
   MOCK_METHOD1(SetBufferHold, void(int buffer_id));
   MOCK_METHOD1(ReleaseBufferHold, void(int buffer_id));
 };
 
-// Test class.
+// Test fixture for testing a unit consisting of an instance of
+// VideoCaptureController connected to an instance of VideoCaptureDeviceClient,
+// an instance of VideoCaptureBufferPoolImpl, as well as related threading glue
+// that replicates how it is used in production.
 class VideoCaptureControllerTest
     : public testing::Test,
       public testing::WithParamInterface<media::VideoPixelFormat> {
  public:
-  VideoCaptureControllerTest() {}
+  VideoCaptureControllerTest()
+      : arbitrary_format_(gfx::Size(320, 240), 30, media::PIXEL_FORMAT_I420),
+        arbitrary_route_id_(0x99),
+        arbitrary_session_id_(100) {}
   ~VideoCaptureControllerTest() override {}
 
  protected:
   static const int kPoolSize = 3;
 
   void SetUp() override {
-    scoped_refptr<media::VideoCaptureBufferPool> buffer_pool(
-        new media::VideoCaptureBufferPoolImpl(
-            base::MakeUnique<media::VideoCaptureBufferTrackerFactoryImpl>(),
-            kPoolSize));
     controller_.reset(new VideoCaptureController());
-    device_client_.reset(new media::VideoCaptureDeviceClient(
-        base::MakeUnique<VideoFrameReceiverOnIOThread>(
-            controller_->GetWeakPtrForIOThread()),
-        buffer_pool,
-        base::Bind(
-            &CreateGpuJpegDecoder,
-            base::Bind(&media::VideoFrameReceiver::OnIncomingCapturedVideoFrame,
-                       controller_->GetWeakPtrForIOThread()))));
+    InitializeNewDeviceClientAndBufferPoolInstances();
     auto frame_receiver_observer = base::MakeUnique<MockFrameBufferPool>();
     mock_frame_receiver_observer_ = frame_receiver_observer.get();
     controller_->SetFrameBufferPool(std::move(frame_receiver_observer));
     auto consumer_feedback_observer =
         base::MakeUnique<MockConsumerFeedbackObserver>();
     mock_consumer_feedback_observer_ = consumer_feedback_observer.get();
     controller_->SetConsumerFeedbackObserver(
         std::move(consumer_feedback_observer));
     client_a_.reset(
         new MockVideoCaptureControllerEventHandler(controller_.get()));
     client_b_.reset(
         new MockVideoCaptureControllerEventHandler(controller_.get()));
   }
 
   void TearDown() override { base::RunLoop().RunUntilIdle(); }
 
+  void InitializeNewDeviceClientAndBufferPoolInstances() {
+    buffer_pool_ = new media::VideoCaptureBufferPoolImpl(
+            base::MakeUnique<media::VideoCaptureBufferTrackerFactoryImpl>(),
+            kPoolSize);
+    device_client_.reset(new media::VideoCaptureDeviceClient(
+        base::MakeUnique<VideoFrameReceiverOnIOThread>(
+            controller_->GetWeakPtrForIOThread()),
+        buffer_pool_,
+        base::Bind(
+            &CreateGpuJpegDecoder,
+            base::Bind(&media::VideoFrameReceiver::OnIncomingCapturedVideoFrame,
+                       controller_->GetWeakPtrForIOThread()))));
+  }
+
+  void SendStubFrameToDeviceClient(const media::VideoCaptureFormat format) {
+    auto stub_frame = media::VideoFrame::CreateZeroInitializedFrame(
+        format.pixel_format, format.frame_size,
+        gfx::Rect(format.frame_size.width(), format.frame_size.height()),
+        format.frame_size, base::TimeDelta());
+    const int rotation = 0;
+    const int frame_feedback_id = 0;
+    device_client_->OnIncomingCapturedData(
+        stub_frame->data(0),
+        media::VideoFrame::AllocationSize(stub_frame->format(),
+                                          stub_frame->coded_size()),
+        format, rotation, base::TimeTicks(), base::TimeDelta(),
+        frame_feedback_id);
+  }
+
   TestBrowserThreadBundle bundle_;
+  scoped_refptr<media::VideoCaptureBufferPool> buffer_pool_;
   std::unique_ptr<MockVideoCaptureControllerEventHandler> client_a_;
   std::unique_ptr<MockVideoCaptureControllerEventHandler> client_b_;
   std::unique_ptr<VideoCaptureController> controller_;
   std::unique_ptr<media::VideoCaptureDevice::Client> device_client_;
   MockFrameBufferPool* mock_frame_receiver_observer_;
   MockConsumerFeedbackObserver* mock_consumer_feedback_observer_;
   const float arbitrary_frame_rate_ = 10.0f;
   const base::TimeTicks arbitrary_reference_time_ = base::TimeTicks();
   const base::TimeDelta arbitrary_timestamp_ = base::TimeDelta();
+  const media::VideoCaptureFormat arbitrary_format_;
+  const VideoCaptureControllerID arbitrary_route_id_;
+  const media::VideoCaptureSessionId arbitrary_session_id_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(VideoCaptureControllerTest);
 };
 
 // A simple test of VideoCaptureController's ability to add, remove, and keep
 // track of clients.
 TEST_F(VideoCaptureControllerTest, AddAndRemoveClients) {
   media::VideoCaptureParams session_100;
   session_100.requested_format = media::VideoCaptureFormat(
@@ skipping 111 matching lines @@
   media::VideoCaptureDevice::Client::Buffer buffer =
       device_client_->ReserveOutputBuffer(
           device_format.frame_size, device_format.pixel_format,
           device_format.pixel_storage, arbitrary_frame_feedback_id);
   ASSERT_TRUE(buffer.is_valid());
   auto buffer_access = buffer.handle_provider()->GetHandleForInProcessAccess();
   ASSERT_EQ(1.0 / kPoolSize, device_client_->GetBufferPoolUtilization());
   memset(buffer_access->data(), buffer_no++, buffer_access->mapped_size());
   {
     InSequence s;
-    EXPECT_CALL(*client_a_, DoBufferCreated(client_a_route_1)).Times(1);
+    EXPECT_CALL(*client_a_, DoBufferCreated(client_a_route_1, _)).Times(1);
     EXPECT_CALL(*client_a_,
                 DoBufferReady(client_a_route_1, device_format.frame_size))
         .Times(1);
   }
   {
     InSequence s;
-    EXPECT_CALL(*client_b_, DoBufferCreated(client_b_route_1)).Times(1);
+    EXPECT_CALL(*client_b_, DoBufferCreated(client_b_route_1, _)).Times(1);
     EXPECT_CALL(*client_b_,
                 DoBufferReady(client_b_route_1, device_format.frame_size))
         .Times(1);
   }
   {
     InSequence s;
-    EXPECT_CALL(*client_a_, DoBufferCreated(client_a_route_2)).Times(1);
+    EXPECT_CALL(*client_a_, DoBufferCreated(client_a_route_2, _)).Times(1);
     EXPECT_CALL(*client_a_,
                 DoBufferReady(client_a_route_2, device_format.frame_size))
         .Times(1);
   }
   client_a_->resource_utilization_ = 0.5;
   client_b_->resource_utilization_ = -1.0;
   {
     InSequence s;
     EXPECT_CALL(*mock_frame_receiver_observer_, SetBufferHold(buffer.id()))
         .Times(1);
@@ skipping 45 matching lines @@
         .Times(1);
   }
 
   device_client_->OnIncomingCapturedBuffer(std::move(buffer2), device_format,
                                            arbitrary_reference_time_,
                                            arbitrary_timestamp_);
 
   // The buffer should be delivered to the clients in any order.
   {
     InSequence s;
-    EXPECT_CALL(*client_a_, DoBufferCreated(client_a_route_1)).Times(1);
+    EXPECT_CALL(*client_a_, DoBufferCreated(client_a_route_1, _)).Times(1);
     EXPECT_CALL(*client_a_,
                 DoBufferReady(client_a_route_1, device_format.frame_size))
         .Times(1);
   }
   {
     InSequence s;
-    EXPECT_CALL(*client_b_, DoBufferCreated(client_b_route_1)).Times(1);
+    EXPECT_CALL(*client_b_, DoBufferCreated(client_b_route_1, _)).Times(1);
     EXPECT_CALL(*client_b_,
                 DoBufferReady(client_b_route_1, device_format.frame_size))
         .Times(1);
   }
   {
     InSequence s;
-    EXPECT_CALL(*client_a_, DoBufferCreated(client_a_route_2)).Times(1);
+    EXPECT_CALL(*client_a_, DoBufferCreated(client_a_route_2, _)).Times(1);
     EXPECT_CALL(*client_a_,
                 DoBufferReady(client_a_route_2, device_format.frame_size))
         .Times(1);
   }
   base::RunLoop().RunUntilIdle();
   Mock::VerifyAndClearExpectations(client_a_.get());
   Mock::VerifyAndClearExpectations(client_b_.get());
   Mock::VerifyAndClearExpectations(mock_consumer_feedback_observer_);
   Mock::VerifyAndClearExpectations(mock_frame_receiver_observer_);
 
@@ skipping 18 matching lines @@
   }
   // ReserveOutputBuffer ought to fail now, because the pool is depleted.
   ASSERT_FALSE(device_client_
                    ->ReserveOutputBuffer(
                        device_format.frame_size, device_format.pixel_format,
                        device_format.pixel_storage, arbitrary_frame_feedback_id)
                    .is_valid());
 
   // The new client needs to be notified of the creation of |kPoolSize| buffers;
   // the old clients only |kPoolSize - 2|.
-  EXPECT_CALL(*client_b_, DoBufferCreated(client_b_route_2)).Times(kPoolSize);
+  EXPECT_CALL(*client_b_, DoBufferCreated(client_b_route_2, _))
+      .Times(kPoolSize);
   EXPECT_CALL(*client_b_,
               DoBufferReady(client_b_route_2, device_format.frame_size))
       .Times(kPoolSize);
-  EXPECT_CALL(*client_a_, DoBufferCreated(client_a_route_1))
+  EXPECT_CALL(*client_a_, DoBufferCreated(client_a_route_1, _))
       .Times(kPoolSize - 2);
   EXPECT_CALL(*client_a_,
               DoBufferReady(client_a_route_1, device_format.frame_size))
       .Times(kPoolSize);
-  EXPECT_CALL(*client_a_, DoBufferCreated(client_a_route_2))
+  EXPECT_CALL(*client_a_, DoBufferCreated(client_a_route_2, _))
       .Times(kPoolSize - 2);
   EXPECT_CALL(*client_a_,
               DoBufferReady(client_a_route_2, device_format.frame_size))
       .Times(kPoolSize);
-  EXPECT_CALL(*client_b_, DoBufferCreated(client_b_route_1))
+  EXPECT_CALL(*client_b_, DoBufferCreated(client_b_route_1, _))
       .Times(kPoolSize - 2);
   EXPECT_CALL(*client_b_,
               DoBufferReady(client_b_route_1, device_format.frame_size))
       .Times(kPoolSize);
   base::RunLoop().RunUntilIdle();
   Mock::VerifyAndClearExpectations(client_a_.get());
   Mock::VerifyAndClearExpectations(client_b_.get());
 
   // Now test the interaction of client shutdown and buffer delivery.
   // Kill A1 via renderer disconnect (synchronous).
@@ skipping 126 matching lines @@
   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(), 200, session_200);
   Mock::VerifyAndClearExpectations(client_b_.get());
 }
 
+TEST_F(VideoCaptureControllerTest,
+       DeviceClientIsReleasedBeforeAnyBufferWasShared) {
+  // Register |client_a_| at |controller_|.
+  media::VideoCaptureParams requested_params;
+  requested_params.requested_format = arbitrary_format_;
+  controller_->AddClient(arbitrary_route_id_, client_a_.get(),
+                         arbitrary_session_id_, requested_params);
+  base::RunLoop().RunUntilIdle();
+
+  // |device_client_| is released by the device.
+  EXPECT_CALL(*client_a_, DoBufferDestroyed(arbitrary_route_id_, _)).Times(0);
+  device_client_.reset();
+  base::RunLoop().RunUntilIdle();
+  Mock::VerifyAndClearExpectations(client_a_.get());
+}
+
+TEST_F(VideoCaptureControllerTest,
+       DeviceClientIsReleasedAfterFrameHasBeenConsumed) {
+  // Register |client_a_| at |controller_|.
+  media::VideoCaptureParams requested_params;
+  requested_params.requested_format = arbitrary_format_;
+  controller_->AddClient(arbitrary_route_id_, client_a_.get(),
+                         arbitrary_session_id_, requested_params);
+  base::RunLoop().RunUntilIdle();
+
+  // Device sends a frame to |device_client_| and |client_a_| reports to
+  // |controller_| that it has finished consuming the frame.
+  {
+    InSequence s;
+    EXPECT_CALL(*client_a_, DoBufferCreated(_, _))
+        .Times(1);
+    EXPECT_CALL(*client_a_, DoBufferReady(_, _)).Times(1);
+  }
+  EXPECT_CALL(*client_a_, DoBufferDestroyed(_, _)).Times(0);
+  SendStubFrameToDeviceClient(arbitrary_format_);
+  base::RunLoop().RunUntilIdle();
+  Mock::VerifyAndClearExpectations(client_a_.get());
+
+  // |device_client_| is released by the device.
+  EXPECT_CALL(*client_a_, DoBufferDestroyed(_, _)).Times(1);
+  device_client_.reset();
+  base::RunLoop().RunUntilIdle();
+  Mock::VerifyAndClearExpectations(client_a_.get());
+}
+
+TEST_F(VideoCaptureControllerTest,
+       DeviceClientIsReleasedWhileFrameIsBeingConsumed) {
+   client_a_->set_enable_auto_return_buffer_on_buffer_ready(false);
+  // Register |client_a_| at |controller_|.
+  media::VideoCaptureParams requested_params;
+  requested_params.requested_format = arbitrary_format_;
+  controller_->AddClient(arbitrary_route_id_, client_a_.get(),
+                         arbitrary_session_id_, requested_params);
+  base::RunLoop().RunUntilIdle();
+
+  // Device sends a frame to |device_client_|.
+  int buffer_id = 0;
+  {
+    InSequence s;
+    EXPECT_CALL(*client_a_, DoBufferCreated(_, _))
+        .Times(1)
+        .WillOnce(SaveArg<1>(&buffer_id));
+    EXPECT_CALL(*client_a_, DoBufferReady(_, _)).Times(1);
+  }
+  SendStubFrameToDeviceClient(arbitrary_format_);
+  base::RunLoop().RunUntilIdle();
+  Mock::VerifyAndClearExpectations(client_a_.get());
+
+  // |device_client_| is released by the device.
+  EXPECT_CALL(*client_a_, DoBufferDestroyed(_, _)).Times(0);
+  device_client_.reset();
+  base::RunLoop().RunUntilIdle();
+  Mock::VerifyAndClearExpectations(client_a_.get());
+
+  // |client_a_| signals to |controller_| that it has finished consuming the
+  // frame.
+  EXPECT_CALL(*client_a_, DoBufferDestroyed(_, _)).Times(1);
+  const double arbitrary_utilization = 0.0;
+  controller_->ReturnBuffer(arbitrary_route_id_, client_a_.get(), buffer_id,
+                            arbitrary_utilization);
+  base::RunLoop().RunUntilIdle();
+  Mock::VerifyAndClearExpectations(client_a_.get());
+}
+
+TEST_F(VideoCaptureControllerTest,
+       NewDeviceClientSendsNewBufferWhileRetiredBufferStillBeingConsumed) {
+  client_a_->set_enable_auto_return_buffer_on_buffer_ready(false);
+  // Register |client_a_| at |controller_|.
+  media::VideoCaptureParams requested_params;
+  requested_params.requested_format = arbitrary_format_;
+  controller_->AddClient(arbitrary_route_id_, client_a_.get(),
+                         arbitrary_session_id_, requested_params);
+  base::RunLoop().RunUntilIdle();
+
+  // Device sends a frame to |device_client_|.
+  int first_buffer_id = 0;
+  {
+    InSequence s;
+    EXPECT_CALL(*client_a_, DoBufferCreated(_, _))
+        .Times(1)
+        .WillOnce(SaveArg<1>(&first_buffer_id));
+    EXPECT_CALL(*client_a_, DoBufferReady(_, _)).Times(1);
+  }
+  SendStubFrameToDeviceClient(arbitrary_format_);
+  base::RunLoop().RunUntilIdle();
+  Mock::VerifyAndClearExpectations(client_a_.get());
+
+  // |device_client_| is released by the device.
+  EXPECT_CALL(*client_a_, DoBufferDestroyed(_, _)).Times(0);
+  device_client_.reset();
+  base::RunLoop().RunUntilIdle();
+  Mock::VerifyAndClearExpectations(client_a_.get());
+
+  // A new |device_client_| is created with a new buffer pool.
+  InitializeNewDeviceClientAndBufferPoolInstances();
+
+  // Device sends a frame to the new |device_client_|.
+  int second_buffer_id = 0;
+  {
+    InSequence s;
+    EXPECT_CALL(*client_a_, DoBufferCreated(_, _))
+        .Times(1)
+        .WillOnce(SaveArg<1>(&second_buffer_id));
+    EXPECT_CALL(*client_a_, DoBufferReady(_, _)).Times(1);
+  }
+  SendStubFrameToDeviceClient(arbitrary_format_);
+  base::RunLoop().RunUntilIdle();
+  Mock::VerifyAndClearExpectations(client_a_.get());
+
+  EXPECT_NE(first_buffer_id, second_buffer_id);
+
+  // |client_a_| signals to |controller_| that it has finished consuming the
+  // first frame.
+  EXPECT_CALL(*client_a_, DoBufferDestroyed(_, first_buffer_id)).Times(1);
+  EXPECT_CALL(*client_a_, DoBufferDestroyed(_, second_buffer_id)).Times(0);
+  const double arbitrary_utilization = 0.0;
+  controller_->ReturnBuffer(arbitrary_route_id_, client_a_.get(),
+                            first_buffer_id, arbitrary_utilization);
+  base::RunLoop().RunUntilIdle();
+  Mock::VerifyAndClearExpectations(client_a_.get());
+
+  // |client_a_| signals to |controller_| that it has finished consuming the
+  // second frame. Since the new |device_client_| is still alive, the second
+  // buffer is expected to stay alive.
+  EXPECT_CALL(*client_a_, DoBufferDestroyed(_, first_buffer_id)).Times(0);
+  EXPECT_CALL(*client_a_, DoBufferDestroyed(_, second_buffer_id)).Times(0);
+  controller_->ReturnBuffer(arbitrary_route_id_, client_a_.get(),
+                            second_buffer_id, arbitrary_utilization);
+  base::RunLoop().RunUntilIdle();
+  Mock::VerifyAndClearExpectations(client_a_.get());
+}
+
 }  // namespace content