1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
/*
* Copyright (c) 2020 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_VOIP_VOIP_ENGINE_FACTORY_H_
#define API_VOIP_VOIP_ENGINE_FACTORY_H_
#include <memory>
#include <optional>
#include "api/audio/audio_device.h"
#include "api/audio/audio_processing.h"
#include "api/audio_codecs/audio_decoder_factory.h"
#include "api/audio_codecs/audio_encoder_factory.h"
#include "api/environment/environment.h"
#include "api/scoped_refptr.h"
#include "api/task_queue/task_queue_factory.h"
#include "api/voip/voip_engine.h"
namespace webrtc {
// VoipEngineConfig is a struct that defines parameters to instantiate a
// VoipEngine instance through CreateVoipEngine factory method. Each member is
// marked with comments as either mandatory or optional and default
// implementations that applications can use.
struct VoipEngineConfig {
// Mandatory (e.g. api/audio_codec/builtin_audio_encoder_factory).
// AudioEncoderFactory provides a set of audio codecs for VoipEngine to encode
// the audio input sample. Application can choose to limit the set to reduce
// application footprint.
scoped_refptr<AudioEncoderFactory> encoder_factory;
// Mandatory (e.g. api/audio_codec/builtin_audio_decoder_factory).
// AudioDecoderFactory provides a set of audio codecs for VoipEngine to decode
// the received RTP packets from remote media endpoint. Application can choose
// to limit the set to reduce application footprint.
scoped_refptr<AudioDecoderFactory> decoder_factory;
// Optional (e.g. api/task_queue/default_task_queue_factory).
// TaskQueueFactory provided for VoipEngine to work asynchronously on its
// encoding flow.
// It is an error to provide both `env` and `task_queue_factory`.
std::unique_ptr<TaskQueueFactory> task_queue_factory;
// Mandatory (e.g. modules/audio_device/include).
// AudioDeviceModule that periocally provides audio input samples from
// recording device (e.g. microphone) and requests audio output samples to
// play through its output device (e.g. speaker).
scoped_refptr<AudioDeviceModule> audio_device_module;
// Optional. When not set, VoipEngine will use a default Environment created
// with `CreateEnvironment`, see api/environment/environment_factory.h
// Provides
// - TaskQueueFactory to work asynchronously on VoipEngine encoding flow
// - FieldTrialsView for experimentations
std::optional<Environment> env;
// Optional (e.g. api/audio/builtin_audio_processing_builder).
// AudioProcessing provides audio procesing functionalities (e.g. acoustic
// echo cancellation, noise suppression, gain control, etc) on audio input
// samples for VoipEngine. When optionally not set, VoipEngine will not have
// such functionalities to perform on audio input samples received from
// AudioDeviceModule.
std::unique_ptr<AudioProcessingBuilderInterface> audio_processing_builder;
};
// Creates a VoipEngine instance with provided VoipEngineConfig.
std::unique_ptr<VoipEngine> CreateVoipEngine(VoipEngineConfig config);
} // namespace webrtc
#endif // API_VOIP_VOIP_ENGINE_FACTORY_H_
|
