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