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 35 #include "webrtc/common_types.h" 36 37 namespace webrtc { 38 39 class VoiceEngine; 40 41 class WEBRTC_DLLEXPORT VoEHardware { 42 public: 43 // Factory for the VoEHardware sub-API. Increases an internal 44 // reference counter if successful. Returns NULL if the API is not 45 // supported or if construction fails. 46 static VoEHardware* GetInterface(VoiceEngine* voiceEngine); 47 48 // Releases the VoEHardware sub-API and decreases an internal 49 // reference counter. Returns the new reference count. This value should 50 // be zero for all sub-API:s before the VoiceEngine object can be safely 51 // deleted. 52 virtual int Release() = 0; 53 54 // Gets the number of audio devices available for recording. 55 virtual int GetNumOfRecordingDevices(int& devices) = 0; 56 57 // Gets the number of audio devices available for playout. 58 virtual int GetNumOfPlayoutDevices(int& devices) = 0; 59 60 // Gets the name of a specific recording device given by an |index|. 61 // On Windows Vista/7, it also retrieves an additional unique ID 62 // (GUID) for the recording device. 63 virtual int GetRecordingDeviceName(int index, 64 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, 71 char strNameUTF8[128], 72 char strGuidUTF8[128]) = 0; 73 74 // Sets the audio device used for recording. 75 virtual int SetRecordingDevice( 76 int index, 77 StereoChannel recordingChannel = kStereoBoth) = 0; 78 79 // Sets the audio device used for playout. 80 virtual int SetPlayoutDevice(int index) = 0; 81 82 // Sets the type of audio device layer to use. 83 virtual int SetAudioDeviceLayer(AudioLayers audioLayer) = 0; 84 85 // Gets the currently used (active) audio device layer. 86 virtual int GetAudioDeviceLayer(AudioLayers& audioLayer) = 0; 87 88 // Native sample rate controls (samples/sec) 89 virtual int SetRecordingSampleRate(unsigned int samples_per_sec) = 0; 90 virtual int RecordingSampleRate(unsigned int* samples_per_sec) const = 0; 91 virtual int SetPlayoutSampleRate(unsigned int samples_per_sec) = 0; 92 virtual int PlayoutSampleRate(unsigned int* samples_per_sec) const = 0; 93 94 // Queries and controls platform audio effects on Android devices. 95 virtual bool BuiltInAECIsAvailable() const = 0; 96 virtual int EnableBuiltInAEC(bool enable) = 0; 97 virtual bool BuiltInAGCIsAvailable() const = 0; 98 virtual int EnableBuiltInAGC(bool enable) = 0; 99 virtual bool BuiltInNSIsAvailable() const = 0; 100 virtual int EnableBuiltInNS(bool enable) = 0; 101 102 protected: VoEHardware()103 VoEHardware() {} ~VoEHardware()104 virtual ~VoEHardware() {} 105 }; 106 107 } // namespace webrtc 108 109 #endif // WEBRTC_VOICE_ENGINE_VOE_HARDWARE_H 110