1 /*
2  *  Copyright (c) 2018 The WebRTC project authors. All Rights Reserved.
3  *
4  *  Use of this source code is governed by a BSD-style license
5  *  that can be found in the LICENSE file in the root of the source
6  *  tree. An additional intellectual property rights grant can be found
7  *  in the file PATENTS.  All contributing project authors may
8  *  be found in the AUTHORS file in the root of the source tree.
9  */
10 
11 #ifndef API_TEST_NETEQ_SIMULATOR_FACTORY_H_
12 #define API_TEST_NETEQ_SIMULATOR_FACTORY_H_
13 
14 #include <memory>
15 #include <string>
16 
17 #include "absl/strings/string_view.h"
18 #include "absl/types/optional.h"
19 #include "api/neteq/neteq_factory.h"
20 #include "api/test/neteq_simulator.h"
21 
22 namespace webrtc {
23 namespace test {
24 
25 class NetEqTestFactory;
26 
27 class NetEqSimulatorFactory {
28  public:
29   NetEqSimulatorFactory();
30   ~NetEqSimulatorFactory();
31   struct Config {
32     // The maximum allowed number of packets in the jitter buffer.
33     int max_nr_packets_in_buffer = 0;
34     // The number of audio packets to insert at the start of the simulation.
35     // Since the simulation is done with a replacement audio file, these
36     // artificial packets will take a small piece of that replacement audio.
37     int initial_dummy_packets = 0;
38     // The number of simulation steps to skip at the start of the simulation.
39     // This removes incoming packets and GetAudio events from the start of the
40     // simulation, until the requested number of GetAudio events has been
41     // removed.
42     int skip_get_audio_events = 0;
43     // A WebRTC field trial string to be used during the simulation.
44     std::string field_trial_string;
45     // A filename for the generated output audio file.
46     absl::optional<std::string> output_audio_filename;
47     // A custom NetEqFactory can be used.
48     NetEqFactory* neteq_factory = nullptr;
49   };
50   std::unique_ptr<NetEqSimulator> CreateSimulatorFromFile(
51       absl::string_view event_log_filename,
52       absl::string_view replacement_audio_filename,
53       Config simulation_config);
54   // The same as above, but pass the file contents as a string.
55   std::unique_ptr<NetEqSimulator> CreateSimulatorFromString(
56       absl::string_view event_log_file_contents,
57       absl::string_view replacement_audio_file,
58       Config simulation_config);
59 
60  private:
61   std::unique_ptr<NetEqTestFactory> factory_;
62 };
63 
64 }  // namespace test
65 }  // namespace webrtc
66 
67 #endif  // API_TEST_NETEQ_SIMULATOR_FACTORY_H_
68