DeviceManager Class Reference

A singleton that manages the audio devices known to Audacity. More...

#include <DeviceManager.h>

Inheritance diagram for DeviceManager:

Collaboration diagram for DeviceManager:

Public Member Functions
void	Rescan ()
std::chrono::duration< float >	GetTimeSinceRescan ()
DeviceSourceMap *	GetDefaultOutputDevice (int hostIndex)
DeviceSourceMap *	GetDefaultInputDevice (int hostIndex)
const std::vector< DeviceSourceMap > &	GetInputDeviceMaps ()
const std::vector< DeviceSourceMap > &	GetOutputDeviceMaps ()
Public Member Functions inherited from Observer::Publisher< Message, NotifyAll >
template<typename Alloc = std::allocator<Record>>
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
template<typename Object , typename Return , typename... Args>
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Static Public Member Functions
static DeviceManager *	Instance ()
	Gets the singleton instance. More...

Protected Member Functions
	DeviceManager ()
	~DeviceManager ()
void	Init ()
DeviceSourceMap *	GetDefaultDevice (int hostIndex, int isInput)
Protected Member Functions inherited from Observer::Publisher< Message, NotifyAll >
CallbackReturn	Publish (const Message &message)
	Send a message to connected callbacks. More...

Protected Attributes
bool	m_inited
std::vector< DeviceSourceMap >	mInputDeviceSourceMaps
std::vector< DeviceSourceMap >	mOutputDeviceSourceMaps

Static Protected Attributes
static DeviceManager	dm

Private Attributes
std::chrono::time_point< std::chrono::steady_clock >	mRescanTime

Additional Inherited Members
Public Types inherited from Observer::Publisher< Message, NotifyAll >
using	message_type = Message
using	CallbackReturn = std::conditional_t< NotifyAll, void, bool >
using	Callback = std::function< CallbackReturn(const Message &) >
	Type of functions that can be connected to the Publisher. More...
Static Public Attributes inherited from Observer::Publisher< Message, NotifyAll >
static constexpr bool	notifies_all = NotifyAll

Detailed Description

A singleton that manages the audio devices known to Audacity.

Definition at line 42 of file DeviceManager.h.

Constructor & Destructor Documentation

DeviceManager()

DeviceManager::DeviceManager ( )

protected

Definition at line 299 of file DeviceManager.cpp.

:  DeviceChangeHandler()
#endif
#endif
{
   m_inited = false;
   mRescanTime = std::chrono::steady_clock::now();
}

~DeviceManager()

DeviceManager::~DeviceManager ( )

protected

Definition at line 310 of file DeviceManager.cpp.

{
 
}

Member Function Documentation

GetDefaultDevice()

DeviceSourceMap * DeviceManager::GetDefaultDevice ( int  hostIndex, int  isInput  )

protected

Definition at line 62 of file DeviceManager.cpp.

{
   if (hostIndex < 0 || hostIndex >= Pa_GetHostApiCount()) {
      return NULL;
   }
 
   const struct PaHostApiInfo *apiinfo = Pa_GetHostApiInfo(hostIndex);   // get info on API
   std::vector<DeviceSourceMap> & maps = isInput ? mInputDeviceSourceMaps : mOutputDeviceSourceMaps;
   size_t i;
   int targetDevice = isInput ? apiinfo->defaultInputDevice : apiinfo->defaultOutputDevice;
 
   for (i = 0; i < maps.size(); i++) {
      if (maps[i].deviceIndex == targetDevice)
         return &maps[i];
   }
 
   wxLogDebug(wxT("GetDefaultDevice() no default device"));
   return NULL;
}

References mInputDeviceSourceMaps, mOutputDeviceSourceMaps, and wxT().

Referenced by GetDefaultInputDevice(), and GetDefaultOutputDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDefaultInputDevice()

DeviceSourceMap * DeviceManager::GetDefaultInputDevice

(

int

hostIndex

)

Definition at line 86 of file DeviceManager.cpp.

{
   return GetDefaultDevice(hostIndex, 1);
}

References GetDefaultDevice().

Referenced by DevicePrefs::OnHost(), AudioSetupToolBar::UpdatePrefs(), and DeviceToolBar::UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDefaultOutputDevice()

DeviceSourceMap * DeviceManager::GetDefaultOutputDevice

(

int

hostIndex

)

Definition at line 82 of file DeviceManager.cpp.

{
   return GetDefaultDevice(hostIndex, 0);
}

References GetDefaultDevice().

Referenced by DevicePrefs::OnHost(), and DeviceToolBar::UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

GetInputDeviceMaps()

const std::vector< DeviceSourceMap > & DeviceManager::GetInputDeviceMaps

(

)

Definition at line 38 of file DeviceManager.cpp.

{
   if (!m_inited)
      Init();
   return mInputDeviceSourceMaps;
}

References Init(), m_inited, and mInputDeviceSourceMaps.

Referenced by DeviceToolBar::ChangeDevice(), AudioSetupToolBar::ChangeDeviceLabel(), AudioSetupToolBar::FillHostDevices(), DeviceToolBar::FillHostDevices(), AudioSetupToolBar::FillHosts(), DeviceToolBar::FillHosts(), AudioSetupToolBar::FillInputChannels(), DeviceToolBar::FillInputChannels(), DevicePrefs::OnHost(), AudioSetupToolBar::UpdatePrefs(), and DeviceToolBar::UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

GetOutputDeviceMaps()

const std::vector< DeviceSourceMap > & DeviceManager::GetOutputDeviceMaps

(

)

Definition at line 44 of file DeviceManager.cpp.

{
   if (!m_inited)
      Init();
   return mOutputDeviceSourceMaps;
}

References Init(), m_inited, and mOutputDeviceSourceMaps.

Referenced by DeviceToolBar::ChangeDevice(), AudioSetupToolBar::ChangeDeviceLabel(), AudioSetupToolBar::FillHostDevices(), DeviceToolBar::FillHostDevices(), AudioSetupToolBar::FillHosts(), DeviceToolBar::FillHosts(), DevicePrefs::OnHost(), AudioSetupToolBar::UpdatePrefs(), and DeviceToolBar::UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTimeSinceRescan()

std::chrono::duration< float > DeviceManager::GetTimeSinceRescan

(

)

Definition at line 291 of file DeviceManager.cpp.

                                                           {
   auto now = std::chrono::steady_clock::now();
   auto dur = std::chrono::duration_cast<std::chrono::duration<float>>(now - mRescanTime);
   return dur;
}

References mRescanTime.

Referenced by AudioIO::StartPortAudioStream().

Here is the caller graph for this function:

Init()

void DeviceManager::Init ( )

protected

Does an initial scan. Called by GetInputDeviceMaps and GetOutputDeviceMaps when needed.

Definition at line 315 of file DeviceManager.cpp.

{
    Rescan();
 
#if defined(EXPERIMENTAL_DEVICE_CHANGE_HANDLER)
#if defined(HAVE_DEVICE_CHANGE)
   DeviceChangeHandler::Enable(true);
#endif
#endif
}

References Rescan().

Referenced by GetInputDeviceMaps(), and GetOutputDeviceMaps().

Here is the call graph for this function:

Here is the caller graph for this function:

Instance()

DeviceManager * DeviceManager::Instance ( )

static

Gets the singleton instance.

Definition at line 33 of file DeviceManager.cpp.

{
   return &dm;
}

References dm.

Referenced by AudioSetupToolBar::AudioSetupToolBar(), DeviceToolBar::ChangeDevice(), AudioSetupToolBar::ChangeDeviceLabel(), DeviceToolBar::DeviceToolBar(), AudioSetupToolBar::FillHostDevices(), DeviceToolBar::FillHostDevices(), AudioSetupToolBar::FillHosts(), DeviceToolBar::FillHosts(), AudioSetupToolBar::FillInputChannels(), DeviceToolBar::FillInputChannels(), AudioSetupToolBar::OnAudioDeviceRescan(), DevicePrefs::OnHost(), anonymous_namespace{TransportMenus.cpp}::OnRescanDevices(), AudioIO::StartPortAudioStream(), AudioSetupToolBar::UpdatePrefs(), and DeviceToolBar::UpdatePrefs().

Here is the caller graph for this function:

Rescan()

void DeviceManager::Rescan

(

)

Gets a NEW list of devices by terminating and restarting portaudio Assumes that DeviceManager is only used on the main thread.

Definition at line 238 of file DeviceManager.cpp.

{
   // get rid of the previous scan info
   this->mInputDeviceSourceMaps.clear();
   this->mOutputDeviceSourceMaps.clear();
 
   // if we are doing a second scan then restart portaudio to get NEW devices
   if (m_inited) {
      // check to see if there is a stream open - can happen if monitoring,
      // but otherwise Rescan() should not be available to the user.
      auto gAudioIO = AudioIOBase::Get();
      if (gAudioIO) {
         if (gAudioIO->IsMonitoring())
         {
            using namespace std::chrono;
            gAudioIO->StopStream();
            while (gAudioIO->IsBusy())
               std::this_thread::sleep_for(100ms);
         }
      }
 
      // restart portaudio - this updates the device list
      // FIXME: TRAP_ERR restarting PortAudio
      Pa_Terminate();
      Pa_Initialize();
   }
 
   // FIXME: TRAP_ERR PaErrorCode not handled in ReScan()
   int nDevices = Pa_GetDeviceCount();
 
   //The hierarchy for devices is Host/device/source.
   //Some newer systems aggregate this.
   //So we need to call port mixer for every device to get the sources
   for (int i = 0; i < nDevices; i++) {
      const PaDeviceInfo *info = Pa_GetDeviceInfo(i);
      if (info->maxOutputChannels > 0) {
         AddSources(i, info->defaultSampleRate, &mOutputDeviceSourceMaps, 0);
      }
 
      if (info->maxInputChannels > 0) {
         AddSources(i, info->defaultSampleRate, &mInputDeviceSourceMaps, 1);
      }
   }
 
   // If this was not an initial scan update each device toolbar.
   if ( m_inited )
      Publish(DeviceChangeMessage::Rescan);
 
   m_inited = true;
   mRescanTime = std::chrono::steady_clock::now();
}

References AddSources(), AudioIOBase::Get(), m_inited, mInputDeviceSourceMaps, mOutputDeviceSourceMaps, mRescanTime, Observer::Publisher< Message, NotifyAll >::Publish(), and Rescan.

Referenced by Init(), AudioSetupToolBar::OnAudioDeviceRescan(), and anonymous_namespace{TransportMenus.cpp}::OnRescanDevices().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

dm

DeviceManager DeviceManager::dm

staticprotected

Definition at line 91 of file DeviceManager.h.

Referenced by Instance().

m_inited

bool DeviceManager::m_inited

protected

Definition at line 86 of file DeviceManager.h.

Referenced by GetInputDeviceMaps(), GetOutputDeviceMaps(), and Rescan().

mInputDeviceSourceMaps

std::vector<DeviceSourceMap> DeviceManager::mInputDeviceSourceMaps

protected

Definition at line 88 of file DeviceManager.h.

Referenced by GetDefaultDevice(), GetInputDeviceMaps(), and Rescan().

mOutputDeviceSourceMaps

std::vector<DeviceSourceMap> DeviceManager::mOutputDeviceSourceMaps

protected

Definition at line 89 of file DeviceManager.h.

Referenced by GetDefaultDevice(), GetOutputDeviceMaps(), and Rescan().

mRescanTime

std::chrono::time_point<std::chrono::steady_clock> DeviceManager::mRescanTime

private

Definition at line 74 of file DeviceManager.h.

Referenced by GetTimeSinceRescan(), and Rescan().

---

The documentation for this class was generated from the following files:

• DeviceManager.h
• DeviceManager.cpp