DevicePrefs Class Reference

A PrefsPanel used to select recording and playback devices and other settings. More...

#include <DevicePrefs.h>

Inheritance diagram for DevicePrefs:

Collaboration diagram for DevicePrefs:

Public Member Functions
	DevicePrefs (wxWindow *parent, wxWindowID winid)
virtual	~DevicePrefs ()
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
bool	Commit () override
ManualPageID	HelpPageName () override
	If not empty string, the Help button is added below the panel. More...
void	PopulateOrExchange (ShuttleGui &S) override
Public Member Functions inherited from PrefsPanel
	PrefsPanel (wxWindow *parent, wxWindowID winid, const TranslatableString &title)
virtual	~PrefsPanel ()
virtual void	Preview ()
virtual bool	Commit ()=0
virtual PluginPath	GetPath () const override
virtual VendorSymbol	GetVendor () const override
virtual wxString	GetVersion () const override
virtual bool	ShowsPreviewButton ()
virtual void	PopulateOrExchange (ShuttleGui &WXUNUSED(S))
virtual ManualPageID	HelpPageName ()
	If not empty string, the Help button is added below the panel. More...
virtual void	Cancel ()
Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()
	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
void	SetLabel (const TranslatableString &label)
void	SetName (const TranslatableString &name)
void	SetToolTip (const TranslatableString &toolTip)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
void	Populate ()
void	GetNamesAndLabels ()
void	OnHost (wxCommandEvent &e)
void	OnDevice (wxCommandEvent &e)

Private Attributes
TranslatableStrings	mHostNames
wxArrayStringEx	mHostLabels
wxString	mPlayDevice
wxString	mRecordDevice
wxString	mRecordSource
long	mRecordChannels
wxChoice *	mHost
wxChoice *	mPlay
wxChoice *	mRecord
wxChoice *	mChannels

Additional Inherited Members
Public Types inherited from PrefsPanel
using	Factories = std::vector< PrefsPanel::PrefsNode >
using	Factory = std::function< PrefsPanel *(wxWindow *parent, wxWindowID winid, AudacityProject *) >
Static Public Member Functions inherited from PrefsPanel
static Factories &	DefaultFactories ()

Detailed Description

A PrefsPanel used to select recording and playback devices and other settings.

Presents interface for user to select the recording device and playback device, from the list of choices that PortAudio makes available.

Also lets user decide how many channels to record.

Definition at line 24 of file DevicePrefs.h.

Constructor & Destructor Documentation

DevicePrefs()

DevicePrefs::DevicePrefs	(	wxWindow *	parent,
		wxWindowID	winid
	)

Definition at line 55 of file DevicePrefs.cpp.

:  PrefsPanel(parent, winid, XO("Devices"))
{
   Populate();
}

~DevicePrefs()

DevicePrefs::~DevicePrefs ( )

virtual

Definition at line 61 of file DevicePrefs.cpp.

{
}

Member Function Documentation

Commit()

bool DevicePrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 386 of file DevicePrefs.cpp.

{
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
   DeviceSourceMap *map = NULL;
 
   if (mPlay->GetCount() > 0) {
      map = (DeviceSourceMap *) mPlay->GetClientData(
            mPlay->GetSelection());
   }
   if (map)
      AudioIOPlaybackDevice.Write(map->deviceString);
 
   map = NULL;
   if (mRecord->GetCount() > 0) {
      map = (DeviceSourceMap *) mRecord->GetClientData(mRecord->GetSelection());
   }
   if (map) {
      AudioIORecordingDevice.Write(map->deviceString);
      AudioIORecordingSourceIndex.Write(map->sourceIndex);
      if (map->totalSources >= 1)
         AudioIORecordingSource.Write(map->sourceString);
      else
         AudioIORecordingSource.Reset();
      AudioIORecordChannels.Write(mChannels->GetSelection() + 1);
   }
 
   AudioIOLatencyDuration.Invalidate();
   AudioIOLatencyCorrection.Invalidate();
   return true;
}

References AudioIOLatencyCorrection, AudioIOLatencyDuration, AudioIOPlaybackDevice, AudioIORecordChannels, AudioIORecordingDevice, AudioIORecordingSource, AudioIORecordingSourceIndex, DeviceSourceMap::deviceString, eIsSavingToPrefs, Setting< T >::Invalidate(), mChannels, mPlay, mRecord, PopulateOrExchange(), Setting< T >::Reset(), S, DeviceSourceMap::sourceIndex, DeviceSourceMap::sourceString, DeviceSourceMap::totalSources, and Setting< T >::Write().

Here is the call graph for this function:

GetDescription()

TranslatableString DevicePrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 71 of file DevicePrefs.cpp.

{
   return XO("Preferences for Device");
}

References XO().

Here is the call graph for this function:

GetNamesAndLabels()

void DevicePrefs::GetNamesAndLabels ( )

private

Definition at line 108 of file DevicePrefs.cpp.

{
   // Gather list of hosts.  Only added hosts that have devices attached.
   // FIXME: TRAP_ERR PaErrorCode not handled in DevicePrefs GetNamesAndLabels()
   // With an error code won't add hosts, but won't report a problem either.
   int nDevices = Pa_GetDeviceCount();
   for (int i = 0; i < nDevices; i++) {
      const PaDeviceInfo *info = Pa_GetDeviceInfo(i);
      if ((info!=NULL)&&(info->maxOutputChannels > 0 || info->maxInputChannels > 0)) {
         wxString name = wxSafeConvertMB2WX(Pa_GetHostApiInfo(info->hostApi)->name);
         if (!make_iterator_range(mHostNames)
            .contains( Verbatim( name ) )) {
            mHostNames.push_back( Verbatim( name ) );
            mHostLabels.push_back(name);
         }
      }
   }
}

References make_iterator_range(), mHostLabels, mHostNames, name, and Verbatim().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSymbol()

ComponentInterfaceSymbol DevicePrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 66 of file DevicePrefs.cpp.

{
   return DEVICE_PREFS_PLUGIN_SYMBOL;
}

References DEVICE_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID DevicePrefs::HelpPageName ( )

overridevirtual

If not empty string, the Help button is added below the panel.

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 76 of file DevicePrefs.cpp.

{
   return "Devices_Preferences";
}

OnDevice()

void DevicePrefs::OnDevice ( wxCommandEvent &  e )

private

Definition at line 322 of file DevicePrefs.cpp.

{
   int ndx = mRecord->GetCurrentSelection();
   if (ndx == wxNOT_FOUND) {
      ndx = 0;
   }
 
   int sel = mChannels->GetSelection();
   int cnt = 0;
 
   DeviceSourceMap *inMap = (DeviceSourceMap *) mRecord->GetClientData(ndx);
   if (inMap != NULL) {
      cnt = inMap->numChannels;
   }
 
   if (sel != wxNOT_FOUND) {
      mRecordChannels = sel + 1;
   }
 
   mChannels->Clear();
 
   // Mimic old behavior
   if (cnt <= 0) {
      cnt = 16;
   }
 
   // Place an artificial limit on the number of channels to prevent an
   // outrageous number.  I don't know if this is really necessary, but
   // it doesn't hurt.
   if (cnt > 256) {
      cnt = 256;
   }
 
   wxArrayStringEx channelnames;
 
   // Channel counts, mono, stereo etc...
   for (int i = 0; i < cnt; i++) {
      wxString name;
 
      if (i == 0) {
         name = _("1 (Mono)");
      }
      else if (i == 1) {
         name = _("2 (Stereo)");
      }
      else {
         name = wxString::Format(wxT("%d"), i + 1);
      }
 
      channelnames.push_back(name);
      int index = mChannels->Append(name);
      if (i == mRecordChannels - 1) {
         mChannels->SetSelection(index);
      }
   }
 
   if (mChannels->GetCount() && mChannels->GetCurrentSelection() == wxNOT_FOUND) {
      mChannels->SetSelection(0);
   }
 
   ShuttleGui::SetMinSize(mChannels, channelnames);
   Layout();
}

References _, mChannels, mRecord, mRecordChannels, name, DeviceSourceMap::numChannels, ShuttleGui::SetMinSize(), and wxT().

Referenced by OnHost().

Here is the call graph for this function:

Here is the caller graph for this function:

OnHost()

void DevicePrefs::OnHost ( wxCommandEvent &  e )

private

Definition at line 210 of file DevicePrefs.cpp.

{
   // Bail if we have no hosts
   if (mHostNames.size() < 1)
      return;
 
   // Find the index for the host API selected
   int index = -1;
   auto apiName = mHostLabels[mHost->GetCurrentSelection()];
   int nHosts = Pa_GetHostApiCount();
   for (int i = 0; i < nHosts; ++i) {
      wxString name = wxSafeConvertMB2WX(Pa_GetHostApiInfo(i)->name);
      if (name == apiName) {
         index = i;
         break;
      }
   }
   // We should always find the host!
   if (index < 0) {
      wxLogDebug(wxT("DevicePrefs::OnHost(): API index not found"));
      return;
   }
 
   int nDevices = Pa_GetDeviceCount();
 
   // FIXME: TRAP_ERR PaErrorCode not handled.  nDevices can be negative number.
   if (nDevices == 0) {
      mHost->Clear();
      mHost->Append(_("No audio interfaces"), (void *) NULL);
      mHost->SetSelection(0);
   }
 
   const std::vector<DeviceSourceMap> &inMaps  = DeviceManager::Instance()->GetInputDeviceMaps();
   const std::vector<DeviceSourceMap> &outMaps = DeviceManager::Instance()->GetOutputDeviceMaps();
 
   wxArrayString playnames;
   wxArrayString recordnames;
   size_t i;
   int devindex;  /* temp variable to hold the numeric ID of each device in turn */
   wxString device;
   wxString recDevice;
 
   recDevice = mRecordDevice;
   if (!this->mRecordSource.empty())
      recDevice += wxT(": ") + mRecordSource;
 
   mRecord->Clear();
   for (i = 0; i < inMaps.size(); i++) {
      if (index == inMaps[i].hostIndex) {
         device   = MakeDeviceSourceString(&inMaps[i]);
         devindex = mRecord->Append(device);
         // We need to const cast here because SetClientData is a wx function
         // It is okay because the original variable is non-const.
         mRecord->SetClientData(devindex, const_cast<DeviceSourceMap *>(&inMaps[i]));
         if (device == recDevice) {  /* if this is the default device, select it */
            mRecord->SetSelection(devindex);
         }
      }
   }
 
   mPlay->Clear();
   for (i = 0; i < outMaps.size(); i++) {
      if (index == outMaps[i].hostIndex) {
         device   = MakeDeviceSourceString(&outMaps[i]);
         devindex = mPlay->Append(device);
         mPlay->SetClientData(devindex, const_cast<DeviceSourceMap *>(&outMaps[i]));
         if (device == mPlayDevice) {  /* if this is the default device, select it */
            mPlay->SetSelection(devindex);
         }
      }
   }
 
   /* deal with not having any devices at all */
   if (mPlay->GetCount() == 0) {
      playnames.push_back(_("No devices found"));
      mPlay->Append(playnames[0], (void *) NULL);
      mPlay->SetSelection(0);
   }
   if (mRecord->GetCount() == 0) {
      recordnames.push_back(_("No devices found"));
      mRecord->Append(recordnames[0], (void *) NULL);
      mRecord->SetSelection(0);
   }
 
   /* what if we have no device selected? we should choose the default on
    * this API, as defined by PortAudio. We then fall back to using 0 only if
    * that fails */
   if (mPlay->GetCount() && mPlay->GetSelection() == wxNOT_FOUND) {
      DeviceSourceMap *defaultMap = DeviceManager::Instance()->GetDefaultOutputDevice(index);
      if (defaultMap)
         mPlay->SetStringSelection(MakeDeviceSourceString(defaultMap));
 
      if (mPlay->GetSelection() == wxNOT_FOUND) {
         mPlay->SetSelection(0);
      }
   }
 
   if (mRecord->GetCount() && mRecord->GetSelection() == wxNOT_FOUND) {
      DeviceSourceMap *defaultMap = DeviceManager::Instance()->GetDefaultInputDevice(index);
      if (defaultMap)
         mRecord->SetStringSelection(MakeDeviceSourceString(defaultMap));
 
      if (mPlay->GetSelection() == wxNOT_FOUND) {
         mPlay->SetSelection(0);
      }
   }
 
   ShuttleGui::SetMinSize(mPlay, mPlay->GetStrings());
   ShuttleGui::SetMinSize(mRecord, mRecord->GetStrings());
   OnDevice(e);
}

References _, DeviceManager::GetDefaultInputDevice(), DeviceManager::GetDefaultOutputDevice(), DeviceManager::GetInputDeviceMaps(), DeviceManager::GetOutputDeviceMaps(), DeviceManager::Instance(), MakeDeviceSourceString(), mHost, mHostLabels, mHostNames, mPlay, mPlayDevice, mRecord, mRecordDevice, mRecordSource, name, OnDevice(), ShuttleGui::SetMinSize(), and wxT().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

Populate()

void DevicePrefs::Populate ( )

private

Definition at line 81 of file DevicePrefs.cpp.

{
   // First any pre-processing for constructing the GUI.
   GetNamesAndLabels();
 
   // Get current setting for devices
   mPlayDevice = AudioIOPlaybackDevice.Read();
   mRecordDevice = AudioIORecordingDevice.Read();
   mRecordSource = AudioIORecordingSource.Read();
   mRecordChannels = AudioIORecordChannels.Read();
 
   //------------------------- Main section --------------------
   // Now construct the GUI itself.
   // Use 'eIsCreatingFromPrefs' so that the GUI is
   // initialised with values from gPrefs.
   ShuttleGui S(this, eIsCreatingFromPrefs);
   PopulateOrExchange(S);
   // ----------------------- End of main section --------------
 
   wxCommandEvent e;
   OnHost(e);
}

References AudioIOPlaybackDevice, AudioIORecordChannels, AudioIORecordingDevice, AudioIORecordingSource, eIsCreatingFromPrefs, GetNamesAndLabels(), mPlayDevice, mRecordChannels, mRecordDevice, mRecordSource, OnHost(), PopulateOrExchange(), Setting< T >::Read(), and S.

Here is the call graph for this function:

PopulateOrExchange()

void DevicePrefs::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 127 of file DevicePrefs.cpp.

{
   ChoiceSetting HostSetting{
      AudioIOHost,
      { ByColumns, mHostNames, mHostLabels }
   };
   S.SetBorder(2);
   S.StartScroller();
 
   /* i18n-hint Software interface to audio devices */
   S.StartStatic(XC("Interface", "device"));
   {
      S.StartMultiColumn(2);
      {
         S.Id(HostID);
         mHost = S.TieChoice( XXO("&Host:"), HostSetting);
 
         S.AddPrompt(XXO("Using:"));
         S.AddFixedText( Verbatim(wxSafeConvertMB2WX(Pa_GetVersionText() ) ) );
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
   S.StartStatic(XO("Playback"));
   {
      S.StartMultiColumn(2);
      {
         S.Id(PlayID);
         mPlay = S.AddChoice(XXO("&Device:"),
                             {} );
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
   // i18n-hint: modifier as in "Recording preferences", not progressive verb
   S.StartStatic(XC("Recording", "preference"));
   {
      S.StartMultiColumn(2);
      {
         S.Id(RecordID);
         mRecord = S.AddChoice(XXO("De&vice:"),
                               {} );
 
         S.Id(ChannelsID);
         mChannels = S.AddChoice(XXO("Cha&nnels:"),
                                 {} );
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
   // These previously lived in recording preferences.
   // However they are liable to become device specific.
   // Buffering also affects playback, not just recording, so is a device characteristic.
   S.StartStatic( XO("Latency"));
   {
      S.StartThreeColumn();
      {
         wxTextCtrl *w;
         // only show the following controls if we use Portaudio v19, because
         // for Portaudio v18 we always use default buffer sizes
         w = S
            .NameSuffix(XO("milliseconds"))
            .TieNumericTextBox(XXO("&Buffer length:"),
                                 AudioIOLatencyDuration,
                                 25);
         S.AddUnits(XO("milliseconds"));
 
         w = S
            .NameSuffix(XO("milliseconds"))
            .TieNumericTextBox(XXO("&Latency compensation:"),
               AudioIOLatencyCorrection, 25);
         S.AddUnits(XO("milliseconds"));
      }
      S.EndThreeColumn();
   }
   S.EndStatic();
   S.EndScroller();
 
}

References AudioIOHost, AudioIOLatencyCorrection, AudioIOLatencyDuration, ByColumns, ChannelsID, HostID, mChannels, mHost, mHostLabels, mHostNames, mPlay, mRecord, PlayID, RecordID, S, Verbatim(), XC, XO(), and XXO().

Referenced by Commit(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mChannels

wxChoice* DevicePrefs::mChannels

private

Definition at line 54 of file DevicePrefs.h.

Referenced by Commit(), OnDevice(), and PopulateOrExchange().

mHost

wxChoice* DevicePrefs::mHost

private

Definition at line 51 of file DevicePrefs.h.

Referenced by OnHost(), and PopulateOrExchange().

mHostLabels

wxArrayStringEx DevicePrefs::mHostLabels

private

Definition at line 44 of file DevicePrefs.h.

Referenced by GetNamesAndLabels(), OnHost(), and PopulateOrExchange().

mHostNames

TranslatableStrings DevicePrefs::mHostNames

private

Definition at line 43 of file DevicePrefs.h.

Referenced by GetNamesAndLabels(), OnHost(), and PopulateOrExchange().

mPlay

wxChoice* DevicePrefs::mPlay

private

Definition at line 52 of file DevicePrefs.h.

Referenced by Commit(), OnHost(), and PopulateOrExchange().

mPlayDevice

wxString DevicePrefs::mPlayDevice

private

Definition at line 46 of file DevicePrefs.h.

Referenced by OnHost(), and Populate().

mRecord

wxChoice* DevicePrefs::mRecord

private

Definition at line 53 of file DevicePrefs.h.

Referenced by Commit(), OnDevice(), OnHost(), and PopulateOrExchange().

mRecordChannels

long DevicePrefs::mRecordChannels

private

Definition at line 49 of file DevicePrefs.h.

Referenced by OnDevice(), and Populate().

mRecordDevice

wxString DevicePrefs::mRecordDevice

private

Definition at line 47 of file DevicePrefs.h.

Referenced by OnHost(), and Populate().

mRecordSource

wxString DevicePrefs::mRecordSource

private

Definition at line 48 of file DevicePrefs.h.

Referenced by OnHost(), and Populate().

---

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

• DevicePrefs.h
• DevicePrefs.cpp