Restructure neteq_rtpplay into a library with small executable wrapper.
Most of the code in neteq_rtpplay is moved into a factory class for
NetEqTest. The factory method takes the same argc and argv arguments as
neteq_rtpplay.
This CL also adds a small public API for neteq_test to allow easy
integration into external software.
Bug: webrtc:9667
Change-Id: I5241c1f51736cb6fbe47b0ad25f4bc83dabd727d
Reviewed-on: https://webrtc-review.googlesource.com/96100
Commit-Queue: Ivo Creusen <ivoc@webrtc.org>
Reviewed-by: Karl Wiberg <kwiberg@webrtc.org>
Reviewed-by: Henrik Lundin <henrik.lundin@webrtc.org>
Reviewed-by: Minyue Li <minyue@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#24531}diff --git a/api/BUILD.gn b/api/BUILD.gn
index ce66627..f8b6ca3 100644
--- a/api/BUILD.gn
+++ b/api/BUILD.gn
@@ -309,6 +309,14 @@
]
}
+rtc_source_set("neteq_simulator_api") {
+ visibility = [ "*" ]
+ sources = [
+ "test/neteq_simulator.cc",
+ "test/neteq_simulator.h",
+ ]
+}
+
if (rtc_include_tests) {
if (rtc_enable_protobuf) {
rtc_source_set("audioproc_f_api") {
@@ -324,6 +332,20 @@
"../modules/audio_processing:audioproc_f_impl",
]
}
+
+ rtc_source_set("neteq_simulator_factory") {
+ visibility = [ "*" ]
+ testonly = true
+ sources = [
+ "test/neteq_simulator_factory.cc",
+ "test/neteq_simulator_factory.h",
+ ]
+ deps = [
+ ":neteq_simulator_api",
+ "../modules/audio_coding:neteq_test_factory",
+ "//third_party/abseil-cpp/absl/memory",
+ ]
+ }
}
rtc_source_set("simulcast_test_fixture_api") {
diff --git a/api/test/neteq_simulator.cc b/api/test/neteq_simulator.cc
new file mode 100644
index 0000000..0615701
--- /dev/null
+++ b/api/test/neteq_simulator.cc
@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2018 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 "api/test/neteq_simulator.h"
+
+namespace webrtc {
+namespace test {
+
+NetEqSimulator::SimulationStepResult::SimulationStepResult() = default;
+NetEqSimulator::SimulationStepResult::SimulationStepResult(
+ const NetEqSimulator::SimulationStepResult& other) = default;
+NetEqSimulator::SimulationStepResult::~SimulationStepResult() = default;
+
+} // namespace test
+} // namespace webrtc
diff --git a/api/test/neteq_simulator.h b/api/test/neteq_simulator.h
new file mode 100644
index 0000000..8f1cd81
--- /dev/null
+++ b/api/test/neteq_simulator.h
@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2018 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 API_TEST_NETEQ_SIMULATOR_H_
+#define API_TEST_NETEQ_SIMULATOR_H_
+
+#include <stdint.h>
+#include <map>
+
+namespace webrtc {
+namespace test {
+
+class NetEqSimulator {
+ public:
+ virtual ~NetEqSimulator() = default;
+
+ enum class Action { kNormal, kExpand, kAccelerate, kPreemptiveExpand };
+
+ // The results of one simulation step.
+ struct SimulationStepResult {
+ SimulationStepResult();
+ SimulationStepResult(const SimulationStepResult& other);
+ ~SimulationStepResult();
+
+ bool is_simulation_finished = false;
+ // The amount of audio produced (in ms) with the actions in this time step.
+ std::map<Action, int> action_times_ms;
+ // The amount of wall clock time (in ms) that elapsed since the previous
+ // event. This is not necessarily equal to the sum of the values in
+ // action_times_ms.
+ int64_t simulation_step_ms = 0;
+ };
+
+ struct NetEqState {
+ // The sum of the packet buffer and sync buffer delay.
+ int current_delay_ms = 0;
+ // TODO(ivoc): Expand this struct with more useful metrics.
+ };
+
+ // Runs the simulation until we hit the next GetAudio event. If the simulation
+ // is finished, is_simulation_finished will be set to true in the returned
+ // SimulationStepResult.
+ virtual SimulationStepResult RunToNextGetAudio() = 0;
+
+ // Set the next action to be taken by NetEq. This will override any action
+ // that NetEq would normally decide to take.
+ virtual void SetNextAction(Action next_operation) = 0;
+
+ // Get the current state of NetEq.
+ virtual NetEqState GetNetEqState() = 0;
+};
+
+} // namespace test
+} // namespace webrtc
+
+#endif // API_TEST_NETEQ_SIMULATOR_H_
diff --git a/api/test/neteq_simulator_factory.cc b/api/test/neteq_simulator_factory.cc
new file mode 100644
index 0000000..568e8a9
--- /dev/null
+++ b/api/test/neteq_simulator_factory.cc
@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2018 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 "api/test/neteq_simulator_factory.h"
+
+#include "absl/memory/memory.h"
+#include "modules/audio_coding/neteq/tools/neteq_test_factory.h"
+
+namespace webrtc {
+namespace test {
+
+NetEqSimulatorFactory::NetEqSimulatorFactory()
+ : factory_(absl::make_unique<NetEqTestFactory>()) {}
+
+NetEqSimulatorFactory::~NetEqSimulatorFactory() = default;
+
+std::unique_ptr<NetEqSimulator> NetEqSimulatorFactory::CreateSimulator(
+ int argc,
+ char* argv[]) {
+ return factory_->InitializeTest(argc, argv);
+}
+
+} // namespace test
+} // namespace webrtc
diff --git a/api/test/neteq_simulator_factory.h b/api/test/neteq_simulator_factory.h
new file mode 100644
index 0000000..e37ff55
--- /dev/null
+++ b/api/test/neteq_simulator_factory.h
@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2018 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 API_TEST_NETEQ_SIMULATOR_FACTORY_H_
+#define API_TEST_NETEQ_SIMULATOR_FACTORY_H_
+
+#include <memory>
+
+#include "api/test/neteq_simulator.h"
+
+namespace webrtc {
+namespace test {
+
+class NetEqTestFactory;
+
+class NetEqSimulatorFactory {
+ public:
+ NetEqSimulatorFactory();
+ ~NetEqSimulatorFactory();
+ // This function takes the same arguments as the neteq_rtpplay utility.
+ std::unique_ptr<NetEqSimulator> CreateSimulator(int argc, char* argv[]);
+
+ private:
+ std::unique_ptr<NetEqTestFactory> factory_;
+};
+
+} // namespace test
+} // namespace webrtc
+
+#endif // API_TEST_NETEQ_SIMULATOR_FACTORY_H_
