Allow encoders to fall back dynamically to software.

webrtc/video/video_encoder_unittest.cc

 /*
  *  Copyright (c) 2015 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.
  */
 
 #include "webrtc/video_encoder.h"
 
 #include "testing/gtest/include/gtest/gtest.h"
 #include "webrtc/modules/video_coding/codecs/interface/video_error_codes.h"
 
 namespace webrtc {
 
+const int kWidth = 320;
+const int kHeight = 240;
 const size_t kMaxPayloadSize = 800;
 
 class VideoEncoderSoftwareFallbackWrapperTest : public ::testing::Test {
  protected:
   VideoEncoderSoftwareFallbackWrapperTest()
       : fallback_wrapper_(kVideoCodecVP8, &fake_encoder_) {}
 
   class CountingFakeEncoder : public VideoEncoder {
    public:
     int32_t InitEncode(const VideoCodec* codec_settings,
                        int32_t number_of_cores,
                        size_t max_payload_size) override {
       ++init_encode_count_;
       return init_encode_return_code_;
     }
     int32_t Encode(const VideoFrame& frame,
                    const CodecSpecificInfo* codec_specific_info,
                    const std::vector<FrameType>* frame_types) override {
       ++encode_count_;
-      return WEBRTC_VIDEO_CODEC_OK;
+      return encode_return_code_;
     }
 
     int32_t RegisterEncodeCompleteCallback(
         EncodedImageCallback* callback) override {
       encode_complete_callback_ = callback;
       return WEBRTC_VIDEO_CODEC_OK;
     }
 
     int32_t Release() override {
       ++release_count_;
@@ skipping 12 matching lines @@
 
     void OnDroppedFrame() override { ++on_dropped_frame_count_; }
 
     bool SupportsNativeHandle() const override {
       ++supports_native_handle_count_;
       return false;
     }
 
     int init_encode_count_ = 0;
     int32_t init_encode_return_code_ = WEBRTC_VIDEO_CODEC_OK;
+    int32_t encode_return_code_ = WEBRTC_VIDEO_CODEC_OK;
     int encode_count_ = 0;
     EncodedImageCallback* encode_complete_callback_ = nullptr;
     int release_count_ = 0;
     int set_channel_parameters_count_ = 0;
     int set_rates_count_ = 0;
     int on_dropped_frame_count_ = 0;
     mutable int supports_native_handle_count_ = 0;
   };
 
   class FakeEncodedImageCallback : public EncodedImageCallback {
    public:
     int32_t Encoded(const EncodedImage& encoded_image,
                     const CodecSpecificInfo* codec_specific_info,
                     const RTPFragmentationHeader* fragmentation) override {
       return ++callback_count_;
     }
     int callback_count_ = 0;
   };
 
   void UtilizeFallbackEncoder();
+  void FallbackFromEncodeRequest();
+  void EncodeFrame();
 
   FakeEncodedImageCallback callback_;
   CountingFakeEncoder fake_encoder_;
   VideoEncoderSoftwareFallbackWrapper fallback_wrapper_;
   VideoCodec codec_ = {};
   VideoFrame frame_;
 };
 
+void VideoEncoderSoftwareFallbackWrapperTest::EncodeFrame() {
+  frame_.CreateEmptyFrame(kWidth, kHeight, kWidth, (kWidth + 1) / 2,
+                          (kWidth + 1) / 2);
+  memset(frame_.buffer(webrtc::kYPlane), 16,
+         frame_.allocated_size(webrtc::kYPlane));
+  memset(frame_.buffer(webrtc::kUPlane), 128,
+         frame_.allocated_size(webrtc::kUPlane));
+  memset(frame_.buffer(webrtc::kVPlane), 128,
+         frame_.allocated_size(webrtc::kVPlane));
+
+  std::vector<FrameType> types(1, kKeyFrame);
+  EXPECT_EQ(WEBRTC_VIDEO_CODEC_OK,
+            fallback_wrapper_.Encode(frame_, nullptr, &types));
+}
+
 void VideoEncoderSoftwareFallbackWrapperTest::UtilizeFallbackEncoder() {
-  static const int kWidth = 320;
-  static const int kHeight = 240;
   fallback_wrapper_.RegisterEncodeCompleteCallback(&callback_);
   EXPECT_EQ(&callback_, fake_encoder_.encode_complete_callback_);
 
   // Register with failing fake encoder. Should succeed with VP8 fallback.
   codec_.codecType = kVideoCodecVP8;
   codec_.maxFramerate = 30;
   codec_.width = kWidth;
   codec_.height = kHeight;
   fake_encoder_.init_encode_return_code_ = WEBRTC_VIDEO_CODEC_ERROR;
   EXPECT_EQ(WEBRTC_VIDEO_CODEC_OK,
             fallback_wrapper_.InitEncode(&codec_, 2, kMaxPayloadSize));
   EXPECT_EQ(WEBRTC_VIDEO_CODEC_OK, fallback_wrapper_.SetRates(300, 30));
 
-  frame_.CreateEmptyFrame(kWidth, kHeight, kWidth, (kWidth + 1) / 2,
-                          (kWidth + 1) / 2);
-  memset(frame_.buffer(webrtc::kYPlane), 16,
-         frame_.allocated_size(webrtc::kYPlane));
-  memset(frame_.buffer(webrtc::kUPlane), 128,
-         frame_.allocated_size(webrtc::kUPlane));
-  memset(frame_.buffer(webrtc::kVPlane), 128,
-         frame_.allocated_size(webrtc::kVPlane));
+  int callback_count = callback_.callback_count_;
+  int encode_count = fake_encoder_.encode_count_;
+  EncodeFrame();
+  EXPECT_EQ(encode_count, fake_encoder_.encode_count_);
+  EXPECT_EQ(callback_count + 1, callback_.callback_count_);
+}
 
-  std::vector<FrameType> types(1, kKeyFrame);
-  EXPECT_EQ(WEBRTC_VIDEO_CODEC_OK,
-            fallback_wrapper_.Encode(frame_, nullptr, &types));
-  EXPECT_EQ(0, fake_encoder_.encode_count_);
-  EXPECT_GT(callback_.callback_count_, 0);
+void VideoEncoderSoftwareFallbackWrapperTest::FallbackFromEncodeRequest() {
+  fallback_wrapper_.RegisterEncodeCompleteCallback(&callback_);
+  codec_.codecType = kVideoCodecVP8;
+  codec_.maxFramerate = 30;
+  codec_.width = kWidth;
+  codec_.height = kHeight;
+  fallback_wrapper_.InitEncode(&codec_, 2, kMaxPayloadSize);
+  EXPECT_EQ(WEBRTC_VIDEO_CODEC_OK, fallback_wrapper_.SetRates(300, 30));
+  EXPECT_EQ(1, fake_encoder_.init_encode_count_);
+
+  // Have the non-fallback encoder request a software fallback.
+  fake_encoder_.encode_return_code_ = WEBRTC_VIDEO_CODEC_FALLBACK_SOFTWARE;
+  int callback_count = callback_.callback_count_;
+  int encode_count = fake_encoder_.encode_count_;
+  EncodeFrame();
+  // Single encode request, which returned failure.
+  EXPECT_EQ(encode_count + 1, fake_encoder_.encode_count_);
+  EXPECT_EQ(callback_count + 1, callback_.callback_count_);
 }
 
 TEST_F(VideoEncoderSoftwareFallbackWrapperTest, InitializesEncoder) {
   VideoCodec codec = {};
   fallback_wrapper_.InitEncode(&codec, 2, kMaxPayloadSize);
   EXPECT_EQ(1, fake_encoder_.init_encode_count_);
 }
 
+TEST_F(VideoEncoderSoftwareFallbackWrapperTest, EncodeRequestsFallback) {
+  FallbackFromEncodeRequest();
+  // After fallback, further encodes shouldn't hit the fake encoder.
+  int encode_count = fake_encoder_.encode_count_;
+  EncodeFrame();
+  EXPECT_EQ(encode_count, fake_encoder_.encode_count_);
+}
+
 TEST_F(VideoEncoderSoftwareFallbackWrapperTest, CanUtilizeFallbackEncoder) {
   UtilizeFallbackEncoder();
   EXPECT_EQ(WEBRTC_VIDEO_CODEC_OK, fallback_wrapper_.Release());
 }
 
 TEST_F(VideoEncoderSoftwareFallbackWrapperTest,
-       InternalEncoderNotReleasedDuringFallback) {
+       InternalEncoderReleasedDuringFallback) {
+  EXPECT_EQ(0, fake_encoder_.release_count_);
   UtilizeFallbackEncoder();
+  EXPECT_EQ(1, fake_encoder_.release_count_);
   EXPECT_EQ(WEBRTC_VIDEO_CODEC_OK, fallback_wrapper_.Release());
-  EXPECT_EQ(0, fake_encoder_.release_count_);
+  // No extra release when the fallback is released.
+  EXPECT_EQ(1, fake_encoder_.release_count_);
 }
 
 TEST_F(VideoEncoderSoftwareFallbackWrapperTest,
        InternalEncoderNotEncodingDuringFallback) {
   UtilizeFallbackEncoder();
-  EXPECT_EQ(0, fake_encoder_.encode_count_);
+  int encode_count = fake_encoder_.encode_count_;
+  EncodeFrame();
+  EXPECT_EQ(encode_count, fake_encoder_.encode_count_);
 
   EXPECT_EQ(WEBRTC_VIDEO_CODEC_OK, fallback_wrapper_.Release());
 }
 
 TEST_F(VideoEncoderSoftwareFallbackWrapperTest,
        CanRegisterCallbackWhileUsingFallbackEncoder) {
   UtilizeFallbackEncoder();
   // Registering an encode-complete callback should still work when fallback
   // encoder is being used.
   FakeEncodedImageCallback callback2;
@@ skipping 49 matching lines @@
 
 TEST_F(VideoEncoderSoftwareFallbackWrapperTest,
        SupportsNativeHandleNotForwardedDuringFallback) {
   UtilizeFallbackEncoder();
   fallback_wrapper_.SupportsNativeHandle();
   EXPECT_EQ(0, fake_encoder_.supports_native_handle_count_);
   EXPECT_EQ(WEBRTC_VIDEO_CODEC_OK, fallback_wrapper_.Release());
 }
 
 }  // namespace webrtc