Turn webrtc::Vad into a pure virtual interface

Review URL: https://codereview.webrtc.org/1317243005

Cr-Commit-Position: refs/heads/master@{#9899}

webrtc/common_audio/vad/include/vad.h

@@ -12,12 +12,12 @@
 #define WEBRTC_COMMON_AUDIO_VAD_INCLUDE_VAD_H_
 
 #include "webrtc/base/checks.h"
+#include "webrtc/base/scoped_ptr.h"
 #include "webrtc/common_audio/vad/include/webrtc_vad.h"
 #include "webrtc/typedefs.h"
 
 namespace webrtc {
 
-// This is a C++ wrapper class for WebRtcVad.
 class Vad {
  public:
   enum Aggressiveness {
@@ -29,21 +29,22 @@ class Vad {
 
   enum Activity { kPassive = 0, kActive = 1, kError = -1 };
 
-  explicit Vad(enum Aggressiveness mode);
+  virtual ~Vad() = default;
-
-  virtual ~Vad();
 
+  // Calculates a VAD decision for the given audio frame. Valid sample rates
+  // are 8000, 16000, and 32000 Hz; the number of samples must be such that the
+  // frame is 10, 20, or 30 ms long.
   virtual Activity VoiceActivity(const int16_t* audio,
                                  size_t num_samples,
-                                 int sample_rate_hz);
+                                 int sample_rate_hz) = 0;
 
-  // Reset VAD state.
+  // Resets VAD state.
-  virtual void Reset();
+  virtual void Reset() = 0;
-
- private:
-  VadInst* handle_;
-  Aggressiveness aggressiveness_;
 };
 
+// Returns a Vad instance that's implemented on top of WebRtcVad.
+rtc::scoped_ptr<Vad> CreateVad(Vad::Aggressiveness aggressiveness);
+
 }  // namespace webrtc
+
 #endif  // WEBRTC_COMMON_AUDIO_VAD_INCLUDE_VAD_H_

webrtc/common_audio/vad/mock/mock_vad.h

@@ -19,7 +19,6 @@ namespace webrtc {
 
 class MockVad : public Vad {
  public:
-  explicit MockVad(enum Aggressiveness mode) : Vad(mode) {}
   virtual ~MockVad() { Die(); }
   MOCK_METHOD0(Die, void());
 

webrtc/common_audio/vad/vad.cc

@@ -14,36 +14,50 @@
 
 namespace webrtc {
 
-Vad::Vad(enum Aggressiveness mode) : handle_(nullptr), aggressiveness_(mode) {
+namespace {
-  Reset();
-}
 
-Vad::~Vad() {
+class VadImpl final : public Vad {
-  WebRtcVad_Free(handle_);
+ public:
-}
+  explicit VadImpl(Aggressiveness aggressiveness)
-
+      : handle_(nullptr), aggressiveness_(aggressiveness) {
-enum Vad::Activity Vad::VoiceActivity(const int16_t* audio,
+    Reset();
-                                      size_t num_samples,
-                                      int sample_rate_hz) {
-  int ret = WebRtcVad_Process(handle_, sample_rate_hz, audio, num_samples);
-  switch (ret) {
-    case 0:
-      return kPassive;
-    case 1:
-      return kActive;
-    default:
-      DCHECK(false) << "WebRtcVad_Process returned an error.";
-      return kError;
   }
-}
 
-void Vad::Reset() {
+  ~VadImpl() override { WebRtcVad_Free(handle_); }
-  if (handle_)
+
-    WebRtcVad_Free(handle_);
+  Activity VoiceActivity(const int16_t* audio,
-  handle_ = WebRtcVad_Create();
+                         size_t num_samples,
-  CHECK(handle_);
+                         int sample_rate_hz) override {
-  CHECK_EQ(WebRtcVad_Init(handle_), 0);
+    int ret = WebRtcVad_Process(handle_, sample_rate_hz, audio, num_samples);
-  CHECK_EQ(WebRtcVad_set_mode(handle_, aggressiveness_), 0);
+    switch (ret) {
+      case 0:
+        return kPassive;
+      case 1:
+        return kActive;
+      default:
+        DCHECK(false) << "WebRtcVad_Process returned an error.";
+        return kError;
+    }
+  }
+
+  void Reset() override {
+    if (handle_)
+      WebRtcVad_Free(handle_);
+    handle_ = WebRtcVad_Create();
+    CHECK(handle_);
+    CHECK_EQ(WebRtcVad_Init(handle_), 0);
+    CHECK_EQ(WebRtcVad_set_mode(handle_, aggressiveness_), 0);
+  }
+
+ private:
+  VadInst* handle_;
+  Aggressiveness aggressiveness_;
+};
+
+}  // namespace
+
+rtc::scoped_ptr<Vad> CreateVad(Vad::Aggressiveness aggressiveness) {
+  return rtc::scoped_ptr<Vad>(new VadImpl(aggressiveness));
 }
 
 }  // namespace webrtc

webrtc/modules/audio_coding/codecs/cng/audio_encoder_cng.cc

@@ -54,7 +54,8 @@ AudioEncoderCng::AudioEncoderCng(const Config& config)
       num_cng_coefficients_(config.num_cng_coefficients),
       sid_frame_interval_ms_(config.sid_frame_interval_ms),
       last_frame_active_(true),
-      vad_(config.vad ? config.vad : new Vad(config.vad_mode)) {
+      vad_(config.vad ? rtc_make_scoped_ptr(config.vad)
+                      : CreateVad(config.vad_mode)) {
   CHECK(config.IsOk()) << "Invalid configuration.";
   cng_inst_ = CreateCngInst(SampleRateHz(), sid_frame_interval_ms_,
                             num_cng_coefficients_);

webrtc/modules/audio_coding/codecs/cng/audio_encoder_cng_unittest.cc

@@ -34,7 +34,7 @@ static const int kCngPayloadType = 18;
 class AudioEncoderCngTest : public ::testing::Test {
  protected:
   AudioEncoderCngTest()
-      : mock_vad_(new MockVad(Vad::kVadNormal)),
+      : mock_vad_(new MockVad),
         timestamp_(4711),
         num_audio_samples_10ms_(0),
         sample_rate_hz_(8000) {