[DesktopCapturer] FallbackDesktopCapturerWrapper and its tests

webrtc/modules/desktop_capture/fallback_desktop_capturer_wrapper.h

+/*
+ *  Copyright (c) 2016 The WebRTC project authors. All Rights Reserved.
+ *
+ *  Use of this source code is governed by a BSD-style license
+ *  that can be found in the LICENSE file in the root of the source
+ *  tree. An additional intellectual property rights grant can be found
+ *  in the file PATENTS.  All contributing project authors may
+ *  be found in the AUTHORS file in the root of the source tree.
+ */
+
+#ifndef WEBRTC_MODULES_DESKTOP_CAPTURE_FALLBACK_DESKTOP_CAPTURER_WRAPPER_H_
+#define WEBRTC_MODULES_DESKTOP_CAPTURE_FALLBACK_DESKTOP_CAPTURER_WRAPPER_H_
+
+#include <memory>
+
+#include "webrtc/modules/desktop_capture/desktop_capturer.h"
+#include "webrtc/modules/desktop_capture/desktop_capture_types.h"
+#include "webrtc/modules/desktop_capture/desktop_frame.h"
+#include "webrtc/modules/desktop_capture/shared_memory.h"
+#include "webrtc/base/gtest_prod_util.h"
+
+namespace webrtc {
+
+// A DesktopCapturer wrapper owns two DesktopCapturer implementations. If the
+// main DesktopCapturer fails, it uses the secondary one instead. Two capturers
+// are expected to return same SourceList, and the meaning of each SourceId is
+// identical, otherwise FallbackDesktopCapturerWrapper may return frames from
+// different sources.
+class FallbackDesktopCapturerWrapper final : public DesktopCapturer,
+                                             public DesktopCapturer::Callback {
+ public:
+  FallbackDesktopCapturerWrapper(
+      std::unique_ptr<DesktopCapturer> main_capturer,
+      std::unique_ptr<DesktopCapturer> secondary_capturer);
+  ~FallbackDesktopCapturerWrapper() override;
+
+  // DesktopCapturer interface.
+  void Start(DesktopCapturer::Callback* callback) override;
+  void SetSharedMemoryFactory(
+      std::unique_ptr<SharedMemoryFactory> shared_memory_factory) override;
+  void CaptureFrame() override;
+  void SetExcludedWindow(WindowId window) override;
+  bool GetSourceList(SourceList* sources) override;
+  bool SelectSource(SourceId id) override;
+  bool FocusOnSelectedSource() override;
+
+ private:
+  FRIEND_TEST_WEBRTC(SharedMemoryFactoryWrapperTest, CreateShared);
+
+  // Implementation to share a SharedMemoryFactory between DesktopCapturer
+  // instances. This class is designed for synchronized DesktopCapturer
+  // implementations only.
+  class SharedMemoryFactoryWrapper : public SharedMemoryFactory {

[Sergey Ulanov, 2017/02/16 19:14:17]

Wrapper normally takes ownership of the wrapped object, which may or may not be
the case here, so it's confusing. Maybe call it SharedMemoryFactoryProxy and
move owned_factory_ to FallbackDesktopCapturerWrapper. I.e. there will be only
one constructor that takes raw SharedMemoryFactory* pointer. That would simplify
this class and make it clear that it is a non-owning proxy for
SharedMemoryFactory.

[Sergey Ulanov, 2017/02/16 19:14:18]

Just declare the class here and move the definition to the .cc file?

[Hzj_jie, 2017/02/16 21:31:28]

Done.

[Hzj_jie, 2017/02/16 21:31:28]

The reason of putting it here is for test cases: the initial design is to
provide a generic implementation of SharedMemoryFactory with proper ownership
management. But if we simplify this class to remove the ownership, I am happy to
remove the test cases and move this class into cc file.

+   public:
+    explicit SharedMemoryFactoryWrapper(
+        std::unique_ptr<SharedMemoryFactory> factory);
+    ~SharedMemoryFactoryWrapper() override;
+
+    // Creates a SharedMemoryFactory, which should not overlive current
+    // instance.
+    std::unique_ptr<SharedMemoryFactory> Wrap() const;
+
+    // Forwards CreateSharedMemory() calls to |shared_factory_|. Users should
+    // always call this function in one thread. Users should not call this
+    // function after the SharedMemoryFactoryWrapper which current instance
+    // wrapped from has been destroyed.
+    std::unique_ptr<SharedMemory> CreateSharedMemory(size_t size) override;
+
+   private:
+    explicit SharedMemoryFactoryWrapper(SharedMemoryFactory* factory);
+
+    std::unique_ptr<SharedMemoryFactory> owned_factory_;
+    SharedMemoryFactory* shared_factory_ = nullptr;
+    rtc::ThreadChecker thread_checker_;
+  };
+
+  // DesktopCapturer::Callback interface.
+  void OnCaptureResult(Result result,
+                       std::unique_ptr<DesktopFrame> frame) override;
+
+  const std::unique_ptr<DesktopCapturer> main_capturer_;
+  const std::unique_ptr<DesktopCapturer> secondary_capturer_;
+  std::unique_ptr<SharedMemoryFactoryWrapper> shared_memory_factory_;
+  bool main_capturer_permanent_error_ = false;
+  DesktopCapturer::Callback* callback_ = nullptr;
+};
+
+}  // namespace webrtc
+
+#endif  // WEBRTC_MODULES_DESKTOP_CAPTURE_FALLBACK_DESKTOP_CAPTURER_WRAPPER_H_