Note: We no longer publish the latest version of our code here. We primarily use a kumc-bmi github organization. The heron ETL repository, in particular, is not public. Peers in the informatics community should see MultiSiteDev for details on requesting access.

source: webrtc/webrtc/modules/audio_device/win/audio_device_wave_win.h @ 0:4bda6873e34c

pub_scrub_3792 tip
Last change on this file since 0:4bda6873e34c was 0:4bda6873e34c, checked in by Michael Prittie <mprittie@…>, 6 years ago

Scrubbed password for publication.

File size: 14.0 KB
Line 
1/*
2 *  Copyright (c) 2012 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_DEVICE_AUDIO_DEVICE_WAVE_WIN_H
12#define WEBRTC_AUDIO_DEVICE_AUDIO_DEVICE_WAVE_WIN_H
13
14#include "webrtc/modules/audio_device/audio_device_generic.h"
15#include "webrtc/modules/audio_device/win/audio_mixer_manager_win.h"
16
17#pragma comment( lib, "winmm.lib" )
18
19namespace webrtc {
20class EventWrapper;
21class ThreadWrapper;
22
23const uint32_t TIMER_PERIOD_MS = 2;
24const uint32_t REC_CHECK_TIME_PERIOD_MS = 4;
25const uint16_t REC_PUT_BACK_DELAY = 4;
26
27const uint32_t N_REC_SAMPLES_PER_SEC = 48000;
28const uint32_t N_PLAY_SAMPLES_PER_SEC = 48000;
29
30const uint32_t N_REC_CHANNELS = 1;  // default is mono recording
31const uint32_t N_PLAY_CHANNELS = 2; // default is stereo playout
32
33// NOTE - CPU load will not be correct for other sizes than 10ms
34const uint32_t REC_BUF_SIZE_IN_SAMPLES = (N_REC_SAMPLES_PER_SEC/100);
35const uint32_t PLAY_BUF_SIZE_IN_SAMPLES = (N_PLAY_SAMPLES_PER_SEC/100);
36
37enum { N_BUFFERS_IN = 200 };
38enum { N_BUFFERS_OUT = 200 };
39
40class AudioDeviceWindowsWave : public AudioDeviceGeneric
41{
42public:
43    AudioDeviceWindowsWave(const int32_t id);
44    ~AudioDeviceWindowsWave();
45
46    // Retrieve the currently utilized audio layer
47    virtual int32_t ActiveAudioLayer(AudioDeviceModule::AudioLayer& audioLayer) const;
48
49    // Main initializaton and termination
50    virtual int32_t Init();
51    virtual int32_t Terminate();
52    virtual bool Initialized() const;
53
54    // Device enumeration
55    virtual int16_t PlayoutDevices();
56    virtual int16_t RecordingDevices();
57    virtual int32_t PlayoutDeviceName(
58        uint16_t index,
59        char name[kAdmMaxDeviceNameSize],
60        char guid[kAdmMaxGuidSize]);
61    virtual int32_t RecordingDeviceName(
62        uint16_t index,
63        char name[kAdmMaxDeviceNameSize],
64        char guid[kAdmMaxGuidSize]);
65
66    // Device selection
67    virtual int32_t SetPlayoutDevice(uint16_t index);
68    virtual int32_t SetPlayoutDevice(AudioDeviceModule::WindowsDeviceType device);
69    virtual int32_t SetRecordingDevice(uint16_t index);
70    virtual int32_t SetRecordingDevice(AudioDeviceModule::WindowsDeviceType device);
71
72    // Audio transport initialization
73    virtual int32_t PlayoutIsAvailable(bool& available);
74    virtual int32_t InitPlayout();
75    virtual bool PlayoutIsInitialized() const;
76    virtual int32_t RecordingIsAvailable(bool& available);
77    virtual int32_t InitRecording();
78    virtual bool RecordingIsInitialized() const;
79
80    // Audio transport control
81    virtual int32_t StartPlayout();
82    virtual int32_t StopPlayout();
83    virtual bool Playing() const;
84    virtual int32_t StartRecording();
85    virtual int32_t StopRecording();
86    virtual bool Recording() const;
87
88    // Microphone Automatic Gain Control (AGC)
89    virtual int32_t SetAGC(bool enable);
90    virtual bool AGC() const;
91
92    // Volume control based on the Windows Wave API (Windows only)
93    virtual int32_t SetWaveOutVolume(uint16_t volumeLeft, uint16_t volumeRight);
94    virtual int32_t WaveOutVolume(uint16_t& volumeLeft, uint16_t& volumeRight) const;
95
96    // Audio mixer initialization
97    virtual int32_t SpeakerIsAvailable(bool& available);
98    virtual int32_t InitSpeaker();
99    virtual bool SpeakerIsInitialized() const;
100    virtual int32_t MicrophoneIsAvailable(bool& available);
101    virtual int32_t InitMicrophone();
102    virtual bool MicrophoneIsInitialized() const;
103
104    // Speaker volume controls
105    virtual int32_t SpeakerVolumeIsAvailable(bool& available);
106    virtual int32_t SetSpeakerVolume(uint32_t volume);
107    virtual int32_t SpeakerVolume(uint32_t& volume) const;
108    virtual int32_t MaxSpeakerVolume(uint32_t& maxVolume) const;
109    virtual int32_t MinSpeakerVolume(uint32_t& minVolume) const;
110    virtual int32_t SpeakerVolumeStepSize(uint16_t& stepSize) const;
111
112    // Microphone volume controls
113    virtual int32_t MicrophoneVolumeIsAvailable(bool& available);
114    virtual int32_t SetMicrophoneVolume(uint32_t volume);
115    virtual int32_t MicrophoneVolume(uint32_t& volume) const;
116    virtual int32_t MaxMicrophoneVolume(uint32_t& maxVolume) const;
117    virtual int32_t MinMicrophoneVolume(uint32_t& minVolume) const;
118    virtual int32_t MicrophoneVolumeStepSize(uint16_t& stepSize) const;
119
120    // Speaker mute control
121    virtual int32_t SpeakerMuteIsAvailable(bool& available);
122    virtual int32_t SetSpeakerMute(bool enable);
123    virtual int32_t SpeakerMute(bool& enabled) const;
124
125    // Microphone mute control
126    virtual int32_t MicrophoneMuteIsAvailable(bool& available);
127    virtual int32_t SetMicrophoneMute(bool enable);
128    virtual int32_t MicrophoneMute(bool& enabled) const;
129
130    // Microphone boost control
131    virtual int32_t MicrophoneBoostIsAvailable(bool& available);
132    virtual int32_t SetMicrophoneBoost(bool enable);
133    virtual int32_t MicrophoneBoost(bool& enabled) const;
134
135    // Stereo support
136    virtual int32_t StereoPlayoutIsAvailable(bool& available);
137    virtual int32_t SetStereoPlayout(bool enable);
138    virtual int32_t StereoPlayout(bool& enabled) const;
139    virtual int32_t StereoRecordingIsAvailable(bool& available);
140    virtual int32_t SetStereoRecording(bool enable);
141    virtual int32_t StereoRecording(bool& enabled) const;
142
143    // Delay information and control
144    virtual int32_t SetPlayoutBuffer(const AudioDeviceModule::BufferType type, uint16_t sizeMS);
145    virtual int32_t PlayoutBuffer(AudioDeviceModule::BufferType& type, uint16_t& sizeMS) const;
146    virtual int32_t PlayoutDelay(uint16_t& delayMS) const;
147    virtual int32_t RecordingDelay(uint16_t& delayMS) const;
148
149    // CPU load
150    virtual int32_t CPULoad(uint16_t& load) const;
151
152public:
153    virtual bool PlayoutWarning() const;
154    virtual bool PlayoutError() const;
155    virtual bool RecordingWarning() const;
156    virtual bool RecordingError() const;
157    virtual void ClearPlayoutWarning();
158    virtual void ClearPlayoutError();
159    virtual void ClearRecordingWarning();
160    virtual void ClearRecordingError();
161
162public:
163    virtual void AttachAudioBuffer(AudioDeviceBuffer* audioBuffer);
164
165private:
166    void Lock() { _critSect.Enter(); };
167    void UnLock() { _critSect.Leave(); };
168    int32_t Id() {return _id;}
169    bool IsUsingOutputDeviceIndex() const {return _usingOutputDeviceIndex;}
170    AudioDeviceModule::WindowsDeviceType OutputDevice() const {return _outputDevice;}
171    uint16_t OutputDeviceIndex() const {return _outputDeviceIndex;}
172    bool IsUsingInputDeviceIndex() const {return _usingInputDeviceIndex;}
173    AudioDeviceModule::WindowsDeviceType InputDevice() const {return _inputDevice;}
174    uint16_t InputDeviceIndex() const {return _inputDeviceIndex;}
175
176private:
177    inline int32_t InputSanityCheckAfterUnlockedPeriod() const;
178    inline int32_t OutputSanityCheckAfterUnlockedPeriod() const;
179
180private:
181    bool KeyPressed() const;
182
183private:
184    int32_t EnumeratePlayoutDevices();
185    int32_t EnumerateRecordingDevices();
186    void TraceSupportFlags(DWORD dwSupport) const;
187    void TraceWaveInError(MMRESULT error) const;
188    void TraceWaveOutError(MMRESULT error) const;
189    int32_t PrepareStartRecording();
190    int32_t PrepareStartPlayout();
191
192    int32_t RecProc(LONGLONG& consumedTime);
193    int PlayProc(LONGLONG& consumedTime);
194
195    int32_t GetPlayoutBufferDelay(uint32_t& writtenSamples, uint32_t& playedSamples);
196    int32_t GetRecordingBufferDelay(uint32_t& readSamples, uint32_t& recSamples);
197    int32_t Write(int8_t* data, uint16_t nSamples);
198    int32_t GetClockDrift(const uint32_t plSamp, const uint32_t rcSamp);
199    int32_t MonitorRecording(const uint32_t time);
200    int32_t RestartTimerIfNeeded(const uint32_t time);
201
202private:
203    static bool ThreadFunc(void*);
204    bool ThreadProcess();
205
206    static DWORD WINAPI GetCaptureVolumeThread(LPVOID context);
207    DWORD DoGetCaptureVolumeThread();
208
209    static DWORD WINAPI SetCaptureVolumeThread(LPVOID context);
210    DWORD DoSetCaptureVolumeThread();
211
212private:
213    AudioDeviceBuffer*                      _ptrAudioBuffer;
214
215    CriticalSectionWrapper&                 _critSect;
216    EventWrapper&                           _timeEvent;
217    EventWrapper&                           _recStartEvent;
218    EventWrapper&                           _playStartEvent;
219
220    HANDLE                                  _hGetCaptureVolumeThread;
221    HANDLE                                  _hShutdownGetVolumeEvent;
222    HANDLE                                  _hSetCaptureVolumeThread;
223    HANDLE                                  _hShutdownSetVolumeEvent;
224    HANDLE                                  _hSetCaptureVolumeEvent;
225
226    ThreadWrapper*                          _ptrThread;
227    uint32_t                                _threadID;
228
229    CriticalSectionWrapper&                 _critSectCb;
230
231    int32_t                                 _id;
232
233    AudioMixerManager                       _mixerManager;
234
235    bool                                    _usingInputDeviceIndex;
236    bool                                    _usingOutputDeviceIndex;
237    AudioDeviceModule::WindowsDeviceType    _inputDevice;
238    AudioDeviceModule::WindowsDeviceType    _outputDevice;
239    uint16_t                                _inputDeviceIndex;
240    uint16_t                                _outputDeviceIndex;
241    bool                                    _inputDeviceIsSpecified;
242    bool                                    _outputDeviceIsSpecified;
243
244    WAVEFORMATEX                            _waveFormatIn;
245    WAVEFORMATEX                            _waveFormatOut;
246
247    HWAVEIN                                 _hWaveIn;
248    HWAVEOUT                                _hWaveOut;
249
250    WAVEHDR                                 _waveHeaderIn[N_BUFFERS_IN];
251    WAVEHDR                                 _waveHeaderOut[N_BUFFERS_OUT];
252
253    uint8_t                                 _recChannels;
254    uint8_t                                 _playChannels;
255    uint16_t                                _recBufCount;
256    uint16_t                                _recDelayCount;
257    uint16_t                                _recPutBackDelay;
258
259    int8_t               _recBuffer[N_BUFFERS_IN][4*REC_BUF_SIZE_IN_SAMPLES];
260    int8_t               _playBuffer[N_BUFFERS_OUT][4*PLAY_BUF_SIZE_IN_SAMPLES];
261
262    AudioDeviceModule::BufferType           _playBufType;
263
264private:
265    bool                                    _initialized;
266    bool                                    _recording;
267    bool                                    _playing;
268    bool                                    _recIsInitialized;
269    bool                                    _playIsInitialized;
270    bool                                    _startRec;
271    bool                                    _stopRec;
272    bool                                    _startPlay;
273    bool                                    _stopPlay;
274    bool                                    _AGC;
275
276private:
277    uint32_t                          _prevPlayTime;
278    uint32_t                          _prevRecTime;
279    uint32_t                          _prevTimerCheckTime;
280
281    uint16_t                          _playBufCount;          // playout buffer index
282    uint16_t                          _dTcheckPlayBufDelay;   // dT for check of play buffer, {2,5,10} [ms]
283    uint16_t                          _playBufDelay;          // playback delay
284    uint16_t                          _playBufDelayFixed;     // fixed playback delay
285    uint16_t                          _minPlayBufDelay;       // minimum playback delay
286    uint16_t                          _MAX_minBuffer;         // level of (adaptive) min threshold must be < _MAX_minBuffer
287
288    int32_t                           _erZeroCounter;         // counts "buffer-is-empty" events
289    int32_t                           _intro;
290    int32_t                           _waitCounter;
291
292    uint32_t                          _writtenSamples;
293    uint32_t                          _writtenSamplesOld;
294    uint32_t                          _playedSamplesOld;
295
296    uint32_t                          _sndCardPlayDelay;
297    uint32_t                          _sndCardRecDelay;
298
299    uint32_t                          _plSampOld;
300    uint32_t                          _rcSampOld;
301
302    uint32_t                          _read_samples;
303    uint32_t                          _read_samples_old;
304    uint32_t                          _rec_samples_old;
305
306    // State that detects driver problems:
307    int32_t                           _dc_diff_mean;
308    int32_t                           _dc_y_prev;
309    int32_t                           _dc_penalty_counter;
310    int32_t                           _dc_prevtime;
311    uint32_t                          _dc_prevplay;
312
313    uint32_t                          _recordedBytes;         // accumulated #recorded bytes (reset periodically)
314    uint32_t                          _prevRecByteCheckTime;  // time when we last checked the recording process
315
316    // CPU load measurements
317    LARGE_INTEGER                           _perfFreq;
318    LONGLONG                                _playAcc;               // accumulated time for playout callback
319    float                                   _avgCPULoad;            // average total (rec+play) CPU load
320
321    int32_t                           _wrapCounter;
322
323    int32_t                           _useHeader;
324    int16_t                           _timesdwBytes;
325    int32_t                           _no_of_msecleft_warnings;
326    int32_t                           _writeErrors;
327    int32_t                           _timerFaults;
328    int32_t                           _timerRestartAttempts;
329
330    uint16_t                          _playWarning;
331    uint16_t                          _playError;
332    uint16_t                          _recWarning;
333    uint16_t                          _recError;
334
335    uint32_t                          _newMicLevel;
336    uint32_t                          _minMicVolume;
337    uint32_t                          _maxMicVolume;
338};
339
340}  // namespace webrtc
341
342#endif  // WEBRTC_AUDIO_DEVICE_AUDIO_DEVICE_WAVE_WIN_H
Note: See TracBrowser for help on using the repository browser.