andrew@webrtc.org | a7b57da | 2012-10-22 18:19:23 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2011 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 | // This sub-API supports the following functionalities: |
| 12 | // |
| 13 | // - Audio device handling. |
| 14 | // - Device information. |
| 15 | // - CPU load monitoring. |
| 16 | // |
| 17 | // Usage example, omitting error checking: |
| 18 | // |
| 19 | // using namespace webrtc; |
| 20 | // VoiceEngine* voe = VoiceEngine::Create(); |
| 21 | // VoEBase* base = VoEBase::GetInterface(voe); |
| 22 | // VoEHardware* hardware = VoEHardware::GetInterface(voe); |
| 23 | // base->Init(); |
| 24 | // ... |
| 25 | // int n_devices = hardware->GetNumOfPlayoutDevices(); |
| 26 | // ... |
| 27 | // base->Terminate(); |
| 28 | // base->Release(); |
| 29 | // hardware->Release(); |
| 30 | // VoiceEngine::Delete(voe); |
| 31 | // |
| 32 | #ifndef WEBRTC_VOICE_ENGINE_VOE_HARDWARE_H |
| 33 | #define WEBRTC_VOICE_ENGINE_VOE_HARDWARE_H |
| 34 | |
pbos@webrtc.org | be72fe4 | 2013-05-21 13:52:32 +0000 | [diff] [blame] | 35 | #include "webrtc/common_types.h" |
andrew@webrtc.org | a7b57da | 2012-10-22 18:19:23 +0000 | [diff] [blame] | 36 | |
| 37 | namespace webrtc { |
| 38 | |
| 39 | class VoiceEngine; |
| 40 | |
| 41 | class WEBRTC_DLLEXPORT VoEHardware |
| 42 | { |
| 43 | public: |
| 44 | // Factory for the VoEHardware sub-API. Increases an internal |
| 45 | // reference counter if successful. Returns NULL if the API is not |
| 46 | // supported or if construction fails. |
| 47 | static VoEHardware* GetInterface(VoiceEngine* voiceEngine); |
| 48 | |
| 49 | // Releases the VoEHardware sub-API and decreases an internal |
| 50 | // reference counter. Returns the new reference count. This value should |
| 51 | // be zero for all sub-API:s before the VoiceEngine object can be safely |
| 52 | // deleted. |
| 53 | virtual int Release() = 0; |
| 54 | |
| 55 | // Gets the number of audio devices available for recording. |
| 56 | virtual int GetNumOfRecordingDevices(int& devices) = 0; |
| 57 | |
| 58 | // Gets the number of audio devices available for playout. |
| 59 | virtual int GetNumOfPlayoutDevices(int& devices) = 0; |
| 60 | |
| 61 | // Gets the name of a specific recording device given by an |index|. |
| 62 | // On Windows Vista/7, it also retrieves an additional unique ID |
| 63 | // (GUID) for the recording device. |
| 64 | virtual int GetRecordingDeviceName(int index, char strNameUTF8[128], |
| 65 | char strGuidUTF8[128]) = 0; |
| 66 | |
| 67 | // Gets the name of a specific playout device given by an |index|. |
| 68 | // On Windows Vista/7, it also retrieves an additional unique ID |
| 69 | // (GUID) for the playout device. |
| 70 | virtual int GetPlayoutDeviceName(int index, char strNameUTF8[128], |
| 71 | char strGuidUTF8[128]) = 0; |
| 72 | |
henrika@webrtc.org | 28e9b66 | 2014-05-09 11:10:50 +0000 | [diff] [blame^] | 73 | // Checks if the sound card is available to be opened for recording. |
| 74 | virtual int GetRecordingDeviceStatus(bool& isAvailable) = 0; |
| 75 | |
| 76 | // Checks if the sound card is available to be opened for playout. |
| 77 | virtual int GetPlayoutDeviceStatus(bool& isAvailable) = 0; |
| 78 | |
andrew@webrtc.org | a7b57da | 2012-10-22 18:19:23 +0000 | [diff] [blame] | 79 | // Sets the audio device used for recording. |
| 80 | virtual int SetRecordingDevice( |
| 81 | int index, StereoChannel recordingChannel = kStereoBoth) = 0; |
| 82 | |
| 83 | // Sets the audio device used for playout. |
| 84 | virtual int SetPlayoutDevice(int index) = 0; |
| 85 | |
| 86 | // Sets the type of audio device layer to use. |
| 87 | virtual int SetAudioDeviceLayer(AudioLayers audioLayer) = 0; |
| 88 | |
| 89 | // Gets the currently used (active) audio device layer. |
| 90 | virtual int GetAudioDeviceLayer(AudioLayers& audioLayer) = 0; |
| 91 | |
henrika@webrtc.org | 28e9b66 | 2014-05-09 11:10:50 +0000 | [diff] [blame^] | 92 | // Gets the VoiceEngine's current CPU consumption in terms of the percent |
| 93 | // of total CPU availability. [Windows only] |
| 94 | virtual int GetCPULoad(int& loadPercent) = 0; |
| 95 | |
| 96 | // Not supported |
| 97 | virtual int ResetAudioDevice() = 0; |
| 98 | |
| 99 | // Not supported |
| 100 | virtual int AudioDeviceControl( |
| 101 | unsigned int par1, unsigned int par2, unsigned int par3) = 0; |
| 102 | |
| 103 | // Not supported |
| 104 | virtual int SetLoudspeakerStatus(bool enable) = 0; |
| 105 | |
| 106 | // Not supported |
| 107 | virtual int GetLoudspeakerStatus(bool& enabled) = 0; |
| 108 | |
leozwang@webrtc.org | d34a831 | 2012-12-04 19:11:55 +0000 | [diff] [blame] | 109 | // Native sample rate controls (samples/sec) |
| 110 | virtual int SetRecordingSampleRate(unsigned int samples_per_sec) = 0; |
| 111 | virtual int RecordingSampleRate(unsigned int* samples_per_sec) const = 0; |
| 112 | virtual int SetPlayoutSampleRate(unsigned int samples_per_sec) = 0; |
| 113 | virtual int PlayoutSampleRate(unsigned int* samples_per_sec) const = 0; |
| 114 | |
henrika@webrtc.org | 28e9b66 | 2014-05-09 11:10:50 +0000 | [diff] [blame^] | 115 | // *Experimental - not recommended for use.* |
| 116 | // Enables the Windows Core Audio built-in AEC. Fails on other platforms. |
| 117 | // |
| 118 | // Currently incompatible with the standard VoE AEC and AGC; don't attempt |
| 119 | // to enable them while this is active. |
| 120 | // |
| 121 | // Must be called before VoEBase::StartSend(). When enabled: |
| 122 | // 1. VoEBase::StartPlayout() must be called before VoEBase::StartSend(). |
| 123 | // 2. VoEBase::StopSend() should be called before VoEBase::StopPlayout(). |
| 124 | // The reverse order may cause garbage audio to be rendered or the |
| 125 | // capture side to halt until StopSend() is called. |
| 126 | // |
| 127 | // As a consequence, SetPlayoutDevice() should be used with caution |
| 128 | // during a call. It will function, but may cause the above issues for |
| 129 | // the duration it takes to complete. (In practice, it should complete |
| 130 | // fast enough to avoid audible degradation). |
| 131 | virtual int EnableBuiltInAEC(bool enable) = 0; |
| 132 | virtual bool BuiltInAECIsEnabled() const = 0; |
andrew@webrtc.org | a7b57da | 2012-10-22 18:19:23 +0000 | [diff] [blame] | 133 | |
| 134 | protected: |
| 135 | VoEHardware() {} |
| 136 | virtual ~VoEHardware() {} |
| 137 | }; |
| 138 | |
pbos@webrtc.org | 5ab7b93 | 2013-07-03 15:12:26 +0000 | [diff] [blame] | 139 | } // namespace webrtc |
andrew@webrtc.org | a7b57da | 2012-10-22 18:19:23 +0000 | [diff] [blame] | 140 | |
| 141 | #endif // WEBRTC_VOICE_ENGINE_VOE_HARDWARE_H |