Pass Environment into NetEqImpl

To propagate field trials in addition to clock

Bug: webrtc:356878416
Change-Id: Idefc4848ec4af30c8aed0f93b7fadfc3181bddb1
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/358980
Commit-Queue: Danil Chapovalov <danilchap@webrtc.org>
Reviewed-by: Jakob Ivarsson‎ <jakobi@webrtc.org>
Cr-Commit-Position: refs/heads/main@{#42761}

api/neteq/BUILD.gn

@@ -21,9 +21,7 @@ rtc_source_set("neteq_api") {
     "..:rtp_headers",
     "..:rtp_packet_info",
     "..:scoped_refptr",
-    "../../rtc_base:checks",
     "../../rtc_base:stringutils",
-    "../../system_wrappers:system_wrappers",
     "../audio_codecs:audio_codecs_api",
     "../environment",
     "../units:timestamp",
@@ -43,8 +41,8 @@ rtc_source_set("custom_neteq_factory") {
     ":neteq_controller_api",
     "..:scoped_refptr",
     "../../modules/audio_coding:neteq",
-    "../../system_wrappers:system_wrappers",
     "../audio_codecs:audio_codecs_api",
+    "../environment",
   ]
 }
 

api/neteq/custom_neteq_factory.cc

@@ -12,6 +12,7 @@
 
 #include <utility>
 
+#include "api/environment/environment.h"
 #include "modules/audio_coding/neteq/neteq_impl.h"
 
 namespace webrtc {
@@ -22,12 +23,12 @@ CustomNetEqFactory::CustomNetEqFactory(
 
 CustomNetEqFactory::~CustomNetEqFactory() = default;
 
-std::unique_ptr<NetEq> CustomNetEqFactory::CreateNetEq(
+std::unique_ptr<NetEq> CustomNetEqFactory::Create(
+    const Environment& env,
     const NetEq::Config& config,
-    const rtc::scoped_refptr<AudioDecoderFactory>& decoder_factory,
+    scoped_refptr<AudioDecoderFactory> decoder_factory) const {
-    Clock* clock) const {
   return std::make_unique<NetEqImpl>(
-      config, NetEqImpl::Dependencies(config, clock, decoder_factory,
+      config, NetEqImpl::Dependencies(env, config, std::move(decoder_factory),
                                       *controller_factory_));
 }
 

api/neteq/custom_neteq_factory.h

@@ -14,11 +14,11 @@
 #include <memory>
 
 #include "api/audio_codecs/audio_decoder_factory.h"
+#include "api/environment/environment.h"
 #include "api/neteq/neteq.h"
 #include "api/neteq/neteq_controller_factory.h"
 #include "api/neteq/neteq_factory.h"
 #include "api/scoped_refptr.h"
-#include "system_wrappers/include/clock.h"
 
 namespace webrtc {
 
@@ -32,10 +32,10 @@ class CustomNetEqFactory : public NetEqFactory {
   CustomNetEqFactory(const CustomNetEqFactory&) = delete;
   CustomNetEqFactory& operator=(const CustomNetEqFactory&) = delete;
 
-  std::unique_ptr<NetEq> CreateNetEq(
+  std::unique_ptr<NetEq> Create(
+      const Environment& env,
       const NetEq::Config& config,
-      const rtc::scoped_refptr<AudioDecoderFactory>& decoder_factory,
+      scoped_refptr<AudioDecoderFactory> decoder_factory) const override;
-      Clock* clock) const override;
 
  private:
   std::unique_ptr<NetEqControllerFactory> controller_factory_;

api/neteq/neteq_factory.h

@@ -17,8 +17,6 @@
 #include "api/environment/environment.h"
 #include "api/neteq/neteq.h"
 #include "api/scoped_refptr.h"
-#include "rtc_base/checks.h"
-#include "system_wrappers/include/clock.h"
 
 namespace webrtc {
 
@@ -33,18 +31,7 @@ class NetEqFactory {
   virtual std::unique_ptr<NetEq> Create(
       const Environment& env,
       const NetEq::Config& config,
-      scoped_refptr<AudioDecoderFactory> decoder_factory) const {
+      scoped_refptr<AudioDecoderFactory> decoder_factory) const = 0;
-    return CreateNetEq(config, decoder_factory, &env.clock());
-  }
-
-  virtual std::unique_ptr<NetEq> CreateNetEq(
-      const NetEq::Config& config,
-      const rtc::scoped_refptr<AudioDecoderFactory>& decoder_factory,
-      Clock* clock) const {
-    // TODO: b/356878416 - Delete this function when all callers are migrated
-    // to `Create` function above.
-    RTC_CHECK_NOTREACHED();
-  }
 };
 
 }  // namespace webrtc

modules/audio_coding/BUILD.gn

@@ -716,6 +716,7 @@ rtc_library("neteq") {
     "../../api:scoped_refptr",
     "../../api/audio:audio_frame_api",
     "../../api/audio_codecs:audio_codecs_api",
+    "../../api/environment",
     "../../api/neteq:neteq_api",
     "../../api/neteq:neteq_controller_api",
     "../../api/neteq:tick_timer",
@@ -754,9 +755,9 @@ rtc_source_set("default_neteq_factory") {
     ":neteq",
     "../../api:scoped_refptr",
     "../../api/audio_codecs:audio_codecs_api",
+    "../../api/environment",
     "../../api/neteq:default_neteq_controller_factory",
     "../../api/neteq:neteq_api",
-    "../../system_wrappers:system_wrappers",
   ]
 }
 

modules/audio_coding/neteq/default_neteq_factory.cc

@@ -12,6 +12,7 @@
 
 #include <utility>
 
+#include "api/environment/environment.h"
 #include "modules/audio_coding/neteq/neteq_impl.h"
 
 namespace webrtc {
@@ -19,12 +20,12 @@ namespace webrtc {
 DefaultNetEqFactory::DefaultNetEqFactory() = default;
 DefaultNetEqFactory::~DefaultNetEqFactory() = default;
 
-std::unique_ptr<NetEq> DefaultNetEqFactory::CreateNetEq(
+std::unique_ptr<NetEq> DefaultNetEqFactory::Create(
+    const Environment& env,
     const NetEq::Config& config,
-    const rtc::scoped_refptr<AudioDecoderFactory>& decoder_factory,
+    scoped_refptr<AudioDecoderFactory> decoder_factory) const {
-    Clock* clock) const {
   return std::make_unique<NetEqImpl>(
-      config, NetEqImpl::Dependencies(config, clock, decoder_factory,
+      config, NetEqImpl::Dependencies(env, config, std::move(decoder_factory),
                                       controller_factory_));
 }
 

modules/audio_coding/neteq/default_neteq_factory.h

@@ -14,10 +14,10 @@
 #include <memory>
 
 #include "api/audio_codecs/audio_decoder_factory.h"
+#include "api/environment/environment.h"
 #include "api/neteq/default_neteq_controller_factory.h"
 #include "api/neteq/neteq_factory.h"
 #include "api/scoped_refptr.h"
-#include "system_wrappers/include/clock.h"
 
 namespace webrtc {
 
@@ -28,10 +28,10 @@ class DefaultNetEqFactory : public NetEqFactory {
   DefaultNetEqFactory(const DefaultNetEqFactory&) = delete;
   DefaultNetEqFactory& operator=(const DefaultNetEqFactory&) = delete;
 
-  std::unique_ptr<NetEq> CreateNetEq(
+  std::unique_ptr<NetEq> Create(
+      const Environment& env,
       const NetEq::Config& config,
-      const rtc::scoped_refptr<AudioDecoderFactory>& decoder_factory,
+      scoped_refptr<AudioDecoderFactory> decoder_factory) const override;
-      Clock* clock) const override;
 
  private:
   const DefaultNetEqControllerFactory controller_factory_;

modules/audio_coding/neteq/neteq_impl.cc

@@ -107,11 +107,11 @@ bool EqualSampleRates(uint8_t pt1,
 }  // namespace
 
 NetEqImpl::Dependencies::Dependencies(
+    const Environment& env,
     const NetEq::Config& config,
-    Clock* clock,
+    scoped_refptr<AudioDecoderFactory> decoder_factory,
-    const rtc::scoped_refptr<AudioDecoderFactory>& decoder_factory,
     const NetEqControllerFactory& controller_factory)
-    : clock(clock),
+    : env(env),
       tick_timer(new TickTimer),
       stats(new StatisticsCalculator),
       decoder_database(
@@ -127,7 +127,7 @@ NetEqImpl::Dependencies::Dependencies(
                                 config.max_packets_in_buffer,
                                 !config.for_test_no_time_stretching,
                                 tick_timer.get(),
-                                clock)),
+                                &env.clock())),
       red_payload_splitter(new RedPayloadSplitter),
       timestamp_scaler(new TimestampScaler(*decoder_database)),
       accelerate_factory(new AccelerateFactory),
@@ -139,7 +139,7 @@ NetEqImpl::Dependencies::~Dependencies() = default;
 NetEqImpl::NetEqImpl(const NetEq::Config& config,
                      Dependencies&& deps,
                      bool create_components)
-    : clock_(deps.clock),
+    : env_(deps.env),
       tick_timer_(std::move(deps.tick_timer)),
       decoder_database_(std::move(deps.decoder_database)),
       dtmf_buffer_(std::move(deps.dtmf_buffer)),
@@ -1981,7 +1981,7 @@ int NetEqImpl::ExtractPackets(size_t required_samples,
     if (packet->packet_info.has_value() &&
         !packet->packet_info->receive_time().IsMinusInfinity()) {
       processing_time =
-          clock_->CurrentTime() - packet->packet_info->receive_time();
+          env_.clock().CurrentTime() - packet->packet_info->receive_time();
     }
 
     stats_->JitterBufferDelay(

modules/audio_coding/neteq/neteq_impl.h

@@ -20,6 +20,7 @@
 
 #include "absl/types/optional.h"
 #include "api/audio/audio_frame.h"
+#include "api/environment/environment.h"
 #include "api/neteq/neteq.h"
 #include "api/neteq/neteq_controller.h"
 #include "api/neteq/neteq_controller_factory.h"
@@ -40,7 +41,6 @@ namespace webrtc {
 // Forward declarations.
 class Accelerate;
 class BackgroundNoise;
-class Clock;
 class ComfortNoise;
 class DecoderDatabase;
 class DtmfBuffer;
@@ -96,13 +96,13 @@ class NetEqImpl : public webrtc::NetEq {
     // before sending the struct to the NetEqImpl constructor. However, there
     // are dependencies between some of the classes inside the struct, so
     // swapping out one may make it necessary to re-create another one.
-    Dependencies(const NetEq::Config& config,
+    Dependencies(const Environment& env,
-                 Clock* clock,
+                 const NetEq::Config& config,
-                 const rtc::scoped_refptr<AudioDecoderFactory>& decoder_factory,
+                 scoped_refptr<AudioDecoderFactory> decoder_factory,
                  const NetEqControllerFactory& controller_factory);
     ~Dependencies();
 
-    Clock* const clock;
+    const Environment env;
     std::unique_ptr<TickTimer> tick_timer;
     std::unique_ptr<StatisticsCalculator> stats;
     std::unique_ptr<DecoderDatabase> decoder_database;
@@ -340,7 +340,7 @@ class NetEqImpl : public webrtc::NetEq {
   NetEqController::PacketArrivedInfo ToPacketArrivedInfo(
       const Packet& packet) const RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_);
 
-  Clock* const clock_;
+  const Environment env_;
 
   mutable Mutex mutex_;
   const std::unique_ptr<TickTimer> tick_timer_ RTC_GUARDED_BY(mutex_);

modules/audio_coding/neteq/neteq_impl_unittest.cc

@@ -72,13 +72,14 @@ int DeletePacketsAndReturnOk(PacketList* packet_list) {
 
 class NetEqImplTest : public ::testing::Test {
  protected:
-  NetEqImplTest() : clock_(0) { config_.sample_rate_hz = 8000; }
+  NetEqImplTest() : clock_(0), env_(CreateEnvironment(&clock_)) {
+    config_.sample_rate_hz = 8000;
+  }
 
-  void CreateInstance(
+  void CreateInstance(scoped_refptr<AudioDecoderFactory> decoder_factory) {
-      const rtc::scoped_refptr<AudioDecoderFactory>& decoder_factory) {
     ASSERT_TRUE(decoder_factory);
     config_.enable_muted_state = enable_muted_state_;
-    NetEqImpl::Dependencies deps(config_, &clock_, decoder_factory,
+    NetEqImpl::Dependencies deps(env_, config_, std::move(decoder_factory),
                                  DefaultNetEqControllerFactory());
 
     // Get a local pointer to NetEq's TickTimer object.
@@ -230,6 +231,7 @@ class NetEqImplTest : public ::testing::Test {
   std::unique_ptr<NetEqImpl> neteq_;
   NetEq::Config config_;
   SimulatedClock clock_;
+  const Environment env_;
   TickTimer* tick_timer_ = nullptr;
   MockDecoderDatabase* mock_decoder_database_ = nullptr;
   DecoderDatabase* decoder_database_ = nullptr;