Gitiles
Code Review Sign In
gerrit.openfyde.cn / webrtc.googlesource.com / src / b7f89d6e668602e46a20e3a9927790ff34029b2a / . / webrtc / test / mock_voice_engine.h
blob: 887dd35305f574b22ec1bbc93add52eed26ba41d [file] [log] [blame]
Fredrik Solenberg0ccae132015-11-03 10:15:49 +0100[diff] [blame]1/*
2 * Copyright (c) 2015 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 WEBRTC_AUDIO_MOCK_VOICE_ENGINE_H_
12#define WEBRTC_AUDIO_MOCK_VOICE_ENGINE_H_
13
kwibergb7f89d62016-02-17 10:04:18 -0800[diff] [blame^]14#include <memory>
15
Fredrik Solenberg0ccae132015-11-03 10:15:49 +0100[diff] [blame]16#include "testing/gmock/include/gmock/gmock.h"
solenberg13725082015-11-25 08:16:52 -0800[diff] [blame]17#include "webrtc/test/mock_voe_channel_proxy.h"
Fredrik Solenberg0ccae132015-11-03 10:15:49 +0100[diff] [blame]18#include "webrtc/voice_engine/voice_engine_impl.h"
19
20namespace webrtc {
21namespace test {
22
23// NOTE: This class inherits from VoiceEngineImpl so that its clients will be
24// able to get the various interfaces as usual, via T::GetInterface().
solenberg3a941542015-11-16 07:34:50 -0800[diff] [blame]25class MockVoiceEngine : public VoiceEngineImpl {
Fredrik Solenberg0ccae132015-11-03 10:15:49 +0100[diff] [blame]26 public:
27 MockVoiceEngine() : VoiceEngineImpl(new Config(), true) {
28 // Increase ref count so this object isn't automatically deleted whenever
29 // interfaces are Release():d.
30 ++_ref_count;
solenberg13725082015-11-25 08:16:52 -0800[diff] [blame]31 // We add this default behavior to make the mock easier to use in tests. It
32 // will create a NiceMock of a voe::ChannelProxy.
33 ON_CALL(*this, ChannelProxyFactory(testing::_))
34 .WillByDefault(
35 testing::Invoke([](int channel_id) {
36 return new testing::NiceMock<MockVoEChannelProxy>();
37 }));
Fredrik Solenberg0ccae132015-11-03 10:15:49 +0100[diff] [blame]38 }
39 ~MockVoiceEngine() override {
40 // Decrease ref count before base class d-tor is called; otherwise it will
41 // trigger an assertion.
42 --_ref_count;
43 }
solenberg13725082015-11-25 08:16:52 -0800[diff] [blame]44 // Allows injecting a ChannelProxy factory.
45 MOCK_METHOD1(ChannelProxyFactory, voe::ChannelProxy*(int channel_id));
46
47 // VoiceEngineImpl
kwibergb7f89d62016-02-17 10:04:18 -0800[diff] [blame^]48 std::unique_ptr<voe::ChannelProxy> GetChannelProxy(int channel_id) override {
49 return std::unique_ptr<voe::ChannelProxy>(ChannelProxyFactory(channel_id));
solenberg13725082015-11-25 08:16:52 -0800[diff] [blame]50 }
Fredrik Solenberg0ccae132015-11-03 10:15:49 +0100[diff] [blame]51
52 // VoEAudioProcessing
53 MOCK_METHOD2(SetNsStatus, int(bool enable, NsModes mode));
54 MOCK_METHOD2(GetNsStatus, int(bool& enabled, NsModes& mode));
55 MOCK_METHOD2(SetAgcStatus, int(bool enable, AgcModes mode));
56 MOCK_METHOD2(GetAgcStatus, int(bool& enabled, AgcModes& mode));
57 MOCK_METHOD1(SetAgcConfig, int(AgcConfig config));
58 MOCK_METHOD1(GetAgcConfig, int(AgcConfig& config));
59 MOCK_METHOD2(SetEcStatus, int(bool enable, EcModes mode));
60 MOCK_METHOD2(GetEcStatus, int(bool& enabled, EcModes& mode));
61 MOCK_METHOD1(EnableDriftCompensation, int(bool enable));
62 MOCK_METHOD0(DriftCompensationEnabled, bool());
63 MOCK_METHOD1(SetDelayOffsetMs, void(int offset));
64 MOCK_METHOD0(DelayOffsetMs, int());
65 MOCK_METHOD2(SetAecmMode, int(AecmModes mode, bool enableCNG));
66 MOCK_METHOD2(GetAecmMode, int(AecmModes& mode, bool& enabledCNG));
67 MOCK_METHOD1(EnableHighPassFilter, int(bool enable));
68 MOCK_METHOD0(IsHighPassFilterEnabled, bool());
69 MOCK_METHOD3(SetRxNsStatus, int(int channel, bool enable, NsModes mode));
70 MOCK_METHOD3(GetRxNsStatus, int(int channel, bool& enabled, NsModes& mode));
71 MOCK_METHOD3(SetRxAgcStatus, int(int channel, bool enable, AgcModes mode));
72 MOCK_METHOD3(GetRxAgcStatus, int(int channel, bool& enabled, AgcModes& mode));
73 MOCK_METHOD2(SetRxAgcConfig, int(int channel, AgcConfig config));
74 MOCK_METHOD2(GetRxAgcConfig, int(int channel, AgcConfig& config));
75 MOCK_METHOD2(RegisterRxVadObserver,
76 int(int channel, VoERxVadCallback& observer));
77 MOCK_METHOD1(DeRegisterRxVadObserver, int(int channel));
78 MOCK_METHOD1(VoiceActivityIndicator, int(int channel));
79 MOCK_METHOD1(SetEcMetricsStatus, int(bool enable));
80 MOCK_METHOD1(GetEcMetricsStatus, int(bool& enabled));
81 MOCK_METHOD4(GetEchoMetrics, int(int& ERL, int& ERLE, int& RERL, int& A_NLP));
82 MOCK_METHOD3(GetEcDelayMetrics,
83 int(int& delay_median,
84 int& delay_std,
85 float& fraction_poor_delays));
86 MOCK_METHOD1(StartDebugRecording, int(const char* fileNameUTF8));
87 MOCK_METHOD1(StartDebugRecording, int(FILE* file_handle));
88 MOCK_METHOD0(StopDebugRecording, int());
89 MOCK_METHOD1(SetTypingDetectionStatus, int(bool enable));
90 MOCK_METHOD1(GetTypingDetectionStatus, int(bool& enabled));
91 MOCK_METHOD1(TimeSinceLastTyping, int(int& seconds));
92 MOCK_METHOD5(SetTypingDetectionParameters,
93 int(int timeWindow,
94 int costPerTyping,
95 int reportingThreshold,
96 int penaltyDecay,
97 int typeEventDelay));
98 MOCK_METHOD1(EnableStereoChannelSwapping, void(bool enable));
99 MOCK_METHOD0(IsStereoChannelSwappingEnabled, bool());
100
101 // VoEBase
102 MOCK_METHOD1(RegisterVoiceEngineObserver, int(VoiceEngineObserver& observer));
103 MOCK_METHOD0(DeRegisterVoiceEngineObserver, int());
104 MOCK_METHOD2(Init,
105 int(AudioDeviceModule* external_adm,
106 AudioProcessing* audioproc));
107 MOCK_METHOD0(audio_processing, AudioProcessing*());
108 MOCK_METHOD0(Terminate, int());
109 MOCK_METHOD0(CreateChannel, int());
110 MOCK_METHOD1(CreateChannel, int(const Config& config));
111 MOCK_METHOD1(DeleteChannel, int(int channel));
112 MOCK_METHOD1(StartReceive, int(int channel));
113 MOCK_METHOD1(StopReceive, int(int channel));
114 MOCK_METHOD1(StartPlayout, int(int channel));
115 MOCK_METHOD1(StopPlayout, int(int channel));
116 MOCK_METHOD1(StartSend, int(int channel));
117 MOCK_METHOD1(StopSend, int(int channel));
118 MOCK_METHOD1(GetVersion, int(char version[1024]));
119 MOCK_METHOD0(LastError, int());
120 MOCK_METHOD0(audio_transport, AudioTransport*());
121 MOCK_METHOD2(AssociateSendChannel,
122 int(int channel, int accociate_send_channel));
123
124 // VoECodec
125 MOCK_METHOD0(NumOfCodecs, int());
126 MOCK_METHOD2(GetCodec, int(int index, CodecInst& codec));
127 MOCK_METHOD2(SetSendCodec, int(int channel, const CodecInst& codec));
128 MOCK_METHOD2(GetSendCodec, int(int channel, CodecInst& codec));
129 MOCK_METHOD2(SetBitRate, int(int channel, int bitrate_bps));
130 MOCK_METHOD2(GetRecCodec, int(int channel, CodecInst& codec));
131 MOCK_METHOD2(SetRecPayloadType, int(int channel, const CodecInst& codec));
132 MOCK_METHOD2(GetRecPayloadType, int(int channel, CodecInst& codec));
133 MOCK_METHOD3(SetSendCNPayloadType,
134 int(int channel, int type, PayloadFrequencies frequency));
135 MOCK_METHOD2(SetFECStatus, int(int channel, bool enable));
136 MOCK_METHOD2(GetFECStatus, int(int channel, bool& enabled));
137 MOCK_METHOD4(SetVADStatus,
138 int(int channel, bool enable, VadModes mode, bool disableDTX));
139 MOCK_METHOD4(
140 GetVADStatus,
141 int(int channel, bool& enabled, VadModes& mode, bool& disabledDTX));
142 MOCK_METHOD2(SetOpusMaxPlaybackRate, int(int channel, int frequency_hz));
143 MOCK_METHOD2(SetOpusDtx, int(int channel, bool enable_dtx));
144 MOCK_METHOD0(GetEventLog, RtcEventLog*());
145
146 // VoEDtmf
147 MOCK_METHOD5(SendTelephoneEvent,
148 int(int channel,
149 int eventCode,
150 bool outOfBand,
151 int lengthMs,
152 int attenuationDb));
153 MOCK_METHOD2(SetSendTelephoneEventPayloadType,
154 int(int channel, unsigned char type));
155 MOCK_METHOD2(GetSendTelephoneEventPayloadType,
156 int(int channel, unsigned char& type));
157 MOCK_METHOD2(SetDtmfFeedbackStatus, int(bool enable, bool directFeedback));
158 MOCK_METHOD2(GetDtmfFeedbackStatus, int(bool& enabled, bool& directFeedback));
159 MOCK_METHOD3(PlayDtmfTone,
160 int(int eventCode, int lengthMs, int attenuationDb));
161
162 // VoEExternalMedia
163 MOCK_METHOD3(RegisterExternalMediaProcessing,
164 int(int channel,
165 ProcessingTypes type,
166 VoEMediaProcess& processObject));
167 MOCK_METHOD2(DeRegisterExternalMediaProcessing,
168 int(int channel, ProcessingTypes type));
169 MOCK_METHOD3(GetAudioFrame,
170 int(int channel, int desired_sample_rate_hz, AudioFrame* frame));
171 MOCK_METHOD2(SetExternalMixing, int(int channel, bool enable));
172
173 // VoEFile
174 MOCK_METHOD7(StartPlayingFileLocally,
175 int(int channel,
176 const char fileNameUTF8[1024],
177 bool loop,
178 FileFormats format,
179 float volumeScaling,
180 int startPointMs,
181 int stopPointMs));
182 MOCK_METHOD6(StartPlayingFileLocally,
183 int(int channel,
184 InStream* stream,
185 FileFormats format,
186 float volumeScaling,
187 int startPointMs,
188 int stopPointMs));
189 MOCK_METHOD1(StopPlayingFileLocally, int(int channel));
190 MOCK_METHOD1(IsPlayingFileLocally, int(int channel));
191 MOCK_METHOD6(StartPlayingFileAsMicrophone,
192 int(int channel,
193 const char fileNameUTF8[1024],
194 bool loop,
195 bool mixWithMicrophone,
196 FileFormats format,
197 float volumeScaling));
198 MOCK_METHOD5(StartPlayingFileAsMicrophone,
199 int(int channel,
200 InStream* stream,
201 bool mixWithMicrophone,
202 FileFormats format,
203 float volumeScaling));
204 MOCK_METHOD1(StopPlayingFileAsMicrophone, int(int channel));
205 MOCK_METHOD1(IsPlayingFileAsMicrophone, int(int channel));
206 MOCK_METHOD4(StartRecordingPlayout,
207 int(int channel,
208 const char* fileNameUTF8,
209 CodecInst* compression,
210 int maxSizeBytes));
211 MOCK_METHOD1(StopRecordingPlayout, int(int channel));
212 MOCK_METHOD3(StartRecordingPlayout,
213 int(int channel, OutStream* stream, CodecInst* compression));
214 MOCK_METHOD3(StartRecordingMicrophone,
215 int(const char* fileNameUTF8,
216 CodecInst* compression,
217 int maxSizeBytes));
218 MOCK_METHOD2(StartRecordingMicrophone,
219 int(OutStream* stream, CodecInst* compression));
220 MOCK_METHOD0(StopRecordingMicrophone, int());
221
222 // VoEHardware
223 MOCK_METHOD1(GetNumOfRecordingDevices, int(int& devices));
224 MOCK_METHOD1(GetNumOfPlayoutDevices, int(int& devices));
225 MOCK_METHOD3(GetRecordingDeviceName,
226 int(int index, char strNameUTF8[128], char strGuidUTF8[128]));
227 MOCK_METHOD3(GetPlayoutDeviceName,
228 int(int index, char strNameUTF8[128], char strGuidUTF8[128]));
229 MOCK_METHOD2(SetRecordingDevice,
230 int(int index, StereoChannel recordingChannel));
231 MOCK_METHOD1(SetPlayoutDevice, int(int index));
232 MOCK_METHOD1(SetAudioDeviceLayer, int(AudioLayers audioLayer));
233 MOCK_METHOD1(GetAudioDeviceLayer, int(AudioLayers& audioLayer));
234 MOCK_METHOD1(SetRecordingSampleRate, int(unsigned int samples_per_sec));
235 MOCK_CONST_METHOD1(RecordingSampleRate, int(unsigned int* samples_per_sec));
236 MOCK_METHOD1(SetPlayoutSampleRate, int(unsigned int samples_per_sec));
237 MOCK_CONST_METHOD1(PlayoutSampleRate, int(unsigned int* samples_per_sec));
238 MOCK_CONST_METHOD0(BuiltInAECIsAvailable, bool());
239 MOCK_METHOD1(EnableBuiltInAEC, int(bool enable));
240 MOCK_CONST_METHOD0(BuiltInAGCIsAvailable, bool());
241 MOCK_METHOD1(EnableBuiltInAGC, int(bool enable));
242 MOCK_CONST_METHOD0(BuiltInNSIsAvailable, bool());
243 MOCK_METHOD1(EnableBuiltInNS, int(bool enable));
244
245 // VoENetEqStats
246 MOCK_METHOD2(GetNetworkStatistics,
247 int(int channel, NetworkStatistics& stats));
248 MOCK_CONST_METHOD2(GetDecodingCallStatistics,
249 int(int channel, AudioDecodingCallStats* stats));
250
251 // VoENetwork
252 MOCK_METHOD2(RegisterExternalTransport,
253 int(int channel, Transport& transport));
254 MOCK_METHOD1(DeRegisterExternalTransport, int(int channel));
255 MOCK_METHOD3(ReceivedRTPPacket,
256 int(int channel, const void* data, size_t length));
257 MOCK_METHOD4(ReceivedRTPPacket,
258 int(int channel,
259 const void* data,
260 size_t length,
261 const PacketTime& packet_time));
262 MOCK_METHOD3(ReceivedRTCPPacket,
263 int(int channel, const void* data, size_t length));
264
265 // VoERTP_RTCP
266 MOCK_METHOD2(SetLocalSSRC, int(int channel, unsigned int ssrc));
267 MOCK_METHOD2(GetLocalSSRC, int(int channel, unsigned int& ssrc));
268 MOCK_METHOD2(GetRemoteSSRC, int(int channel, unsigned int& ssrc));
269 MOCK_METHOD3(SetSendAudioLevelIndicationStatus,
270 int(int channel, bool enable, unsigned char id));
271 MOCK_METHOD3(SetReceiveAudioLevelIndicationStatus,
272 int(int channel, bool enable, unsigned char id));
273 MOCK_METHOD3(SetSendAbsoluteSenderTimeStatus,
274 int(int channel, bool enable, unsigned char id));
275 MOCK_METHOD3(SetReceiveAbsoluteSenderTimeStatus,
276 int(int channel, bool enable, unsigned char id));
277 MOCK_METHOD2(SetRTCPStatus, int(int channel, bool enable));
278 MOCK_METHOD2(GetRTCPStatus, int(int channel, bool& enabled));
279 MOCK_METHOD2(SetRTCP_CNAME, int(int channel, const char cName[256]));
280 MOCK_METHOD2(GetRTCP_CNAME, int(int channel, char cName[256]));
281 MOCK_METHOD2(GetRemoteRTCP_CNAME, int(int channel, char cName[256]));
282 MOCK_METHOD7(GetRemoteRTCPData,
283 int(int channel,
284 unsigned int& NTPHigh,
285 unsigned int& NTPLow,
286 unsigned int& timestamp,
287 unsigned int& playoutTimestamp,
288 unsigned int* jitter,
289 unsigned short* fractionLost));
290 MOCK_METHOD4(GetRTPStatistics,
291 int(int channel,
292 unsigned int& averageJitterMs,
293 unsigned int& maxJitterMs,
294 unsigned int& discardedPackets));
295 MOCK_METHOD2(GetRTCPStatistics, int(int channel, CallStatistics& stats));
296 MOCK_METHOD2(GetRemoteRTCPReportBlocks,
297 int(int channel, std::vector<ReportBlock>* receive_blocks));
298 MOCK_METHOD3(SetREDStatus, int(int channel, bool enable, int redPayloadtype));
299 MOCK_METHOD3(GetREDStatus,
300 int(int channel, bool& enable, int& redPayloadtype));
301 MOCK_METHOD3(SetNACKStatus, int(int channel, bool enable, int maxNoPackets));
302
303 // VoEVideoSync
304 MOCK_METHOD1(GetPlayoutBufferSize, int(int& buffer_ms));
305 MOCK_METHOD2(SetMinimumPlayoutDelay, int(int channel, int delay_ms));
306 MOCK_METHOD3(GetDelayEstimate,
307 int(int channel,
308 int* jitter_buffer_delay_ms,
309 int* playout_buffer_delay_ms));
310 MOCK_CONST_METHOD1(GetLeastRequiredDelayMs, int(int channel));
311 MOCK_METHOD2(SetInitTimestamp, int(int channel, unsigned int timestamp));
312 MOCK_METHOD2(SetInitSequenceNumber, int(int channel, short sequenceNumber));
313 MOCK_METHOD2(GetPlayoutTimestamp, int(int channel, unsigned int& timestamp));
314 MOCK_METHOD3(GetRtpRtcp,
315 int(int channel,
316 RtpRtcp** rtpRtcpModule,
317 RtpReceiver** rtp_receiver));
318
319 // VoEVolumeControl
320 MOCK_METHOD1(SetSpeakerVolume, int(unsigned int volume));
321 MOCK_METHOD1(GetSpeakerVolume, int(unsigned int& volume));
322 MOCK_METHOD1(SetMicVolume, int(unsigned int volume));
323 MOCK_METHOD1(GetMicVolume, int(unsigned int& volume));
324 MOCK_METHOD2(SetInputMute, int(int channel, bool enable));
325 MOCK_METHOD2(GetInputMute, int(int channel, bool& enabled));
326 MOCK_METHOD1(GetSpeechInputLevel, int(unsigned int& level));
327 MOCK_METHOD2(GetSpeechOutputLevel, int(int channel, unsigned int& level));
328 MOCK_METHOD1(GetSpeechInputLevelFullRange, int(unsigned int& level));
329 MOCK_METHOD2(GetSpeechOutputLevelFullRange,
330 int(int channel, unsigned& level));
331 MOCK_METHOD2(SetChannelOutputVolumeScaling, int(int channel, float scaling));
332 MOCK_METHOD2(GetChannelOutputVolumeScaling, int(int channel, float& scaling));
333 MOCK_METHOD3(SetOutputVolumePan, int(int channel, float left, float right));
334 MOCK_METHOD3(GetOutputVolumePan, int(int channel, float& left, float& right));
335};
336} // namespace test
337} // namespace webrtc
338
339#endif // WEBRTC_AUDIO_MOCK_VOICE_ENGINE_H_