A toolbar to allow easier changing of input and output devices . More...

#include <AudioSetupToolBar.h>

Inheritance diagram for AudioSetupToolBar:

Collaboration diagram for AudioSetupToolBar:

Public Member Functions
	AudioSetupToolBar (AudacityProject &project)
	Methods for AudioSetupToolBar. More...

virtual	~AudioSetupToolBar ()

void	Create (wxWindow *parent) override

void	UpdatePrefs () override

void	UpdateSelectedPrefs (int) override

void	DeinitChildren ()

void	Populate () override

void	Repaint (wxDC *dc) override

void	EnableDisableButtons () override

void	ReCreateButtons () override

void	OnFocus (wxFocusEvent &event)

void	OnAudioSetup (wxCommandEvent &event)

Public Member Functions inherited from ToolBar
	ToolBar (AudacityProject &project, int type, const TranslatableString &label, const wxString &section, bool resizable=false)

virtual	~ToolBar ()

bool	AcceptsFocus () const override

virtual void	SetToDefaultSize ()

virtual void	Create (wxWindow *parent)

virtual void	EnableDisableButtons ()=0

virtual void	ReCreateButtons ()

void	UpdatePrefs () override

virtual void	RegenerateTooltips ()=0

int	GetType ()

TranslatableString	GetTitle ()

TranslatableString	GetLabel ()

wxString	GetSection ()

ToolDock *	GetDock ()

void	SetLabel (const TranslatableString &label)

virtual void	SetDocked (ToolDock *dock, bool pushed)

virtual bool	Expose (bool show=true)

bool	IsResizable () const

bool	IsVisible () const

bool	IsDocked () const

bool	IsPositioned ()

void	SetVisible (bool bVisible)

void	SetPositioned ()

virtual int	GetInitialWidth ()
	Resizable toolbars should implement these. More...

virtual int	GetMinToolbarWidth ()

virtual wxSize	GetDockedSize ()

wxSize	GetSmartDockedSize ()

virtual void	ResizingDone ()

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

Static Public Member Functions
static AudioSetupToolBar &	Get (AudacityProject &project)

static const AudioSetupToolBar &	Get (const AudacityProject &project)

Static Public Member Functions inherited from ToolBar
static AButton *	MakeButton (wxWindow *parent, teBmps eUp, teBmps eDown, teBmps eHilite, teBmps eDownHi, teBmps eStandardUp, teBmps eStandardDown, teBmps eDisabled, wxWindowID id, wxPoint placement, bool processdownevents, wxSize size)

static AButton *	MakeButton (ToolBar *parent, teBmps eEnabledUp, teBmps eEnabledDown, teBmps eDisabled, int id, bool processdownevents, const TranslatableString &label)

static void	MakeAlternateImages (AButton &button, int idx, teBmps eUp, teBmps eDown, teBmps eHilite, teBmps eDownHi, teBmps eStandardUp, teBmps eStandardDown, teBmps eDisabled, wxSize size)

static void	SetButtonToolTip (AudacityProject &project, AButton &button, const ComponentInterfaceSymbol commands[], size_t nCommands)

static void	MakeButtonBackgroundsSmall ()

static void	MakeButtonBackgroundsLarge ()

Private Types
enum	{ ID_AUDIO_SETUP_BUTTON = 12000 , BUTTON_COUNT }

Private Member Functions
void	OnRescannedDevices (DeviceChangeMessage)

void	OnMenu (wxCommandEvent &event)

bool	ChangeHost (int hostId)

void	ChangeDevice (int deviceId, bool isInput)

void	RepopulateMenus ()

void	FillHosts ()

void	FillHostDevices ()

void	FillInputChannels ()

void	SetDevices (const DeviceSourceMap in, const DeviceSourceMap out)

void	RegenerateTooltips () override

void	MakeAudioSetupButton ()

void	ArrangeButtons ()

std::unique_ptr< wxMenu >	CloneMenu (const wxMenu &menu) const

void	AppendSubMenu (wxMenu &menu, const std::unique_ptr< wxMenu > &submenu, const wxString &title)

std::optional< wxString >	GetSelectedRadioItemLabel (const wxMenu &menu) const

Private Attributes
AButton *	mAudioSetup {}

wxBoxSizer *	mSizer {}

std::unique_ptr< wxMenu >	mInput

std::unique_ptr< wxMenu >	mOutput

std::unique_ptr< wxMenu >	mInputChannels

std::unique_ptr< wxMenu >	mHost

Observer::Subscription	mSubscription

Additional Inherited Members
Public Types inherited from ToolBar
using	Holder = wxWindowPtr< ToolBar >

Protected Member Functions inherited from ToolBar
void	SetButton (bool down, AButton *button)

wxBoxSizer *	GetSizer ()

void	Add (wxWindow window, int proportion=0, int flag=wxALIGN_TOP, int border=0, wxObject userData=NULL)

void	Add (wxSizer sizer, int proportion=0, int flag=0, int border=0, wxObject userData=NULL)

void	Add (int width, int height, int proportion=0, int flag=0, int border=0, wxObject *userData=NULL)

void	AddSpacer (int size=14)

void	AddStretchSpacer (int prop=1)

void	Detach (wxWindow *window)

void	Detach (wxSizer *sizer)

void	Updated ()

int	GetResizeGrabberWidth ()
	Returns the width in pixels of the resizer element. More...

virtual void	Populate ()=0

virtual void	Repaint (wxDC *dc)=0

void	OnErase (wxEraseEvent &event)

void	OnPaint (wxPaintEvent &event)

void	OnMouseEvents (wxMouseEvent &event)

virtual void	UpdateSelectedPrefs (int id)

	PrefsListener ()

virtual	~PrefsListener ()

virtual void	UpdatePrefs ()=0

Static Protected Member Functions inherited from ToolBar
static void	MakeMacRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)

static void	MakeMacRecoloredImageSize (teBmps eBmpOut, teBmps eBmpIn, const wxSize &size)

static void	MakeRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)

static void	MakeRecoloredImageSize (teBmps eBmpOut, teBmps eBmpIn, const wxSize &size)

Static Protected Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Protected Attributes inherited from ToolBar
AudacityProject &	mProject

TranslatableString	mLabel

wxString	mSection

int	mType

Detailed Description

A toolbar to allow easier changing of input and output devices .

Definition at line 25 of file AudioSetupToolBar.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
ID_AUDIO_SETUP_BUTTON
BUTTON_COUNT

Definition at line 69 of file AudioSetupToolBar.h.

        {
      ID_AUDIO_SETUP_BUTTON = 12000,
      BUTTON_COUNT,
   };

Constructor & Destructor Documentation

◆ AudioSetupToolBar()

AudioSetupToolBar::AudioSetupToolBar ( AudacityProject & project )

explicit

Methods for AudioSetupToolBar.

Definition at line 84 of file AudioSetupToolBar.cpp.

: ToolBar( project, AudioSetupBarID, XO("Audio Setup"), wxT("Audio Setup") )
{
   mSubscription = DeviceManager::Instance()->Subscribe(
      *this, &AudioSetupToolBar::OnRescannedDevices );
}

References DeviceManager::Instance(), OnRescannedDevices(), and Observer::Publisher< Message, NotifyAll >::Subscribe().

Here is the call graph for this function:

◆ ~AudioSetupToolBar()

AudioSetupToolBar::~AudioSetupToolBar ( )

virtual

Definition at line 91 of file AudioSetupToolBar.cpp.

92{

93}

Member Function Documentation

◆ AppendSubMenu()

void AudioSetupToolBar::AppendSubMenu	(	wxMenu &	menu,
		const std::unique_ptr< wxMenu > &	submenu,
		const wxString &	title
	)

private

Definition at line 660 of file AudioSetupToolBar.cpp.

{
   auto clone = CloneMenu(*submenu);
   auto menuItem = menu.AppendSubMenu(clone.release(), title);
 
   const auto selected = GetSelectedRadioItemLabel(*submenu);
   if (!selected) {
      menuItem->Enable(false);
   }
}

References CloneMenu(), GetSelectedRadioItemLabel(), and title.

Referenced by OnAudioSetup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ArrangeButtons()

void AudioSetupToolBar::ArrangeButtons ( )

private

Definition at line 193 of file AudioSetupToolBar.cpp.

{
   int flags = wxALIGN_CENTER | wxRIGHT;
 
   // (Re)allocate the button sizer
   if (mSizer)
   {
      Detach(mSizer);
      std::unique_ptr < wxSizer > {mSizer}; // DELETE it
   }
 
   Add((mSizer = safenew wxBoxSizer(wxHORIZONTAL)), 1, wxEXPAND);
 
   auto text = safenew wxStaticText(this, wxID_ANY, "Audio Setup");
   text->SetBackgroundColour(theTheme.Colour(clrMedium));
   text->SetForegroundColour(theTheme.Colour(clrTrackPanelText));
 
   auto vSizer = safenew wxBoxSizer(wxVERTICAL);
   vSizer->AddSpacer(4);
   vSizer->Add(mAudioSetup, 0, flags, 2);
   vSizer->AddSpacer(4);
   vSizer->Add(text, 0, flags, 2);
 
   // Start with a little extra space
   mSizer->Add(5, 55);
   mSizer->Add(vSizer, 1, wxEXPAND);
   mSizer->Add(5, 55);
 
   // Layout the sizer
   mSizer->Layout();
 
   // Layout the toolbar
   Layout();
 
   SetMinSize(GetSizer()->GetMinSize());
}

References ToolBar::Add(), ThemeBase::Colour(), ToolBar::Detach(), ToolBar::GetSizer(), mAudioSetup, mSizer, safenew, and theTheme.

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ChangeDevice()

void AudioSetupToolBar::ChangeDevice	(	int	deviceId,
		bool	isInput
	)

private

Definition at line 741 of file AudioSetupToolBar.cpp.

{
   int newIndex = -1;
   auto& device = isInput ? mInput : mOutput;
 
   auto host = AudioIOHost.Read();
   const std::vector<DeviceSourceMap>& maps = isInput ? DeviceManager::Instance()->GetInputDeviceMaps()
      : DeviceManager::Instance()->GetOutputDeviceMaps();
 
   auto item = device->FindChildItem(deviceId);
   if (item) {
      // Update cache with the chosen device
      item->Check();
      wxString newDevice = item->GetItemLabelText();
 
      for (size_t i = 0; i < maps.size(); ++i) {
         wxString name = MakeDeviceSourceString(&maps[i]);
         if (name == newDevice && maps[i].hostString == host) {
            newIndex = i;
         }
      }
   }
 
   if (newIndex < 0) {
      wxLogDebug(wxT("AudioSetupToolBar::OnMenu(): couldn't find device indices"));
      return;
   }
 
   SetDevices(isInput ? &maps[newIndex] : nullptr,
              isInput ? nullptr : &maps[newIndex]);
}

References AudioIOHost, DeviceManager::GetInputDeviceMaps(), DeviceManager::GetOutputDeviceMaps(), DeviceManager::Instance(), MakeDeviceSourceString(), mInput, mOutput, name, Setting< T >::Read(), and SetDevices().

Referenced by OnMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ChangeHost()

bool AudioSetupToolBar::ChangeHost ( int hostId )

private

Definition at line 691 of file AudioSetupToolBar.cpp.

{
   auto item = mHost->FindChildItem(hostId);
   if (!item)
      return false;
 
   // Update cache with selected host
   item->Check();
 
   auto oldHost = AudioIOHost.Read();
   wxString newHost = item->GetItemLabelText();
 
   if (oldHost == newHost)
      return false;
 
   //change the host and switch to correct devices.
   AudioIOHost.Write(newHost);
   gPrefs->Flush();
 
   // populate the devices
   FillHostDevices();
 
   return true;
}

References AudioIOHost, FillHostDevices(), FileConfig::Flush(), gPrefs, mHost, Setting< T >::Read(), and Setting< T >::Write().

Referenced by OnMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CloneMenu()

std::unique_ptr< wxMenu > AudioSetupToolBar::CloneMenu ( const wxMenu & menu ) const

private

Definition at line 646 of file AudioSetupToolBar.cpp.

{
   auto clonedMenu = std::make_unique<wxMenu>();
 
   for (const auto& item : menu.GetMenuItems()) {
      auto cloneMenuItem = clonedMenu->AppendRadioItem(item->GetId(), item->GetItemLabelText());
 
      if (item->IsChecked())
         cloneMenuItem->Check();
   }
 
   return clonedMenu;
}

Referenced by AppendSubMenu().

Here is the caller graph for this function:

◆ Create()

void AudioSetupToolBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 106 of file AudioSetupToolBar.cpp.

{
   ToolBar::Create(parent);
 
   // Simulate a size event to set initial meter placement/size
   wxSizeEvent event(GetSize(), GetId());
   event.SetEventObject(this);
   GetEventHandler()->ProcessEvent(event);
}

References ToolBar::Create().

Here is the call graph for this function:

◆ DeinitChildren()

void AudioSetupToolBar::DeinitChildren ( )

Definition at line 116 of file AudioSetupToolBar.cpp.

{
   mInput.reset();
   mOutput.reset();
   mInputChannels.reset();
   mHost.reset();
}

References mHost, mInput, mInputChannels, and mOutput.

Referenced by Populate().

Here is the caller graph for this function:

◆ EnableDisableButtons()

void AudioSetupToolBar::EnableDisableButtons ( )

overridevirtual

Implements ToolBar.

Definition at line 429 of file AudioSetupToolBar.cpp.

{
   auto gAudioIO = AudioIOBase::Get();
   if (gAudioIO) {
      // we allow changes when monitoring, but not when recording
      bool audioStreamActive = gAudioIO->IsStreamActive() && !gAudioIO->IsMonitoring();
 
      if (audioStreamActive) {
         mAudioSetup->Disable();
      }
      else {
         mAudioSetup->Enable();
      }
   }
}

References AButton::Disable(), AButton::Enable(), AudioIOBase::Get(), and mAudioSetup.

Referenced by ReCreateButtons().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FillHostDevices()

void AudioSetupToolBar::FillHostDevices ( )

private

Definition at line 509 of file AudioSetupToolBar.cpp.

{
   const std::vector<DeviceSourceMap> &inMaps = DeviceManager::Instance()->GetInputDeviceMaps();
   const std::vector<DeviceSourceMap> &outMaps = DeviceManager::Instance()->GetOutputDeviceMaps();
 
   //read what is in the prefs
   auto host = AudioIOHost.Read();
   int foundHostIndex = -1;
 
   // if the host is not in the hosts combo then we rescanned.
   // set it to blank so we search for another host.
   if (mHost->FindItem(host) == wxNOT_FOUND) {
      host = wxT("");
   }
 
   for (auto & device : outMaps) {
      if (device.hostString == host) {
         foundHostIndex = device.hostIndex;
         break;
      }
   }
 
   if (foundHostIndex == -1) {
      for (auto & device : inMaps) {
         if (device.hostString == host) {
            foundHostIndex = device.hostIndex;
            break;
         }
      }
   }
 
   // If no host was found based on the prefs device host, load the first available one
   if (foundHostIndex == -1) {
      if (outMaps.size()) {
         foundHostIndex = outMaps[0].hostIndex;
      }
      else if (inMaps.size()) {
         foundHostIndex = inMaps[0].hostIndex;
      }
   }
 
   // Make sure in/out are clear in case no host was found
   mInput = std::make_unique<wxMenu>();
   mOutput = std::make_unique<wxMenu>();
 
   // If we still have no host it means no devices, in which case do nothing.
   if (foundHostIndex == -1) {
      return;
   }
 
   // Repopulate the Input/Output device list available to the user
   for (int nextMenuId = kInput, i = 0; i < inMaps.size(); ++i) {
      auto& device = inMaps[i];
 
      if (foundHostIndex == device.hostIndex) {
         mInput->AppendRadioItem(nextMenuId, MakeDeviceSourceString(&device));
         nextMenuId++;
 
         if (host.empty()) {
            host = device.hostString;
            AudioIOHost.Write(host);
 
            const auto id = mHost->FindItem(host);
            if (id != wxNOT_FOUND) {
               mHost->FindChildItem(id)->Check();
            }
         }
      }
   }
 
   for (int nextMenuId = kOutput, i = 0; i < outMaps.size(); ++i) {
      auto& device = outMaps[i];
 
      if (foundHostIndex == device.hostIndex) {
         mOutput->AppendRadioItem(nextMenuId, MakeDeviceSourceString(&device));
         nextMenuId++;
 
         if (host.empty()) {
            host = device.hostString;
            AudioIOHost.Write(host);
            gPrefs->Flush();
 
            const auto id = mHost->FindItem(host);
            if (id != wxNOT_FOUND) {
               mHost->FindChildItem(id)->Check();
            }
         }
      }
   }
 
   // The setting of the Device is left up to OnMenu
}

References AudioIOHost, FileConfig::Flush(), DeviceManager::GetInputDeviceMaps(), DeviceManager::GetOutputDeviceMaps(), gPrefs, DeviceManager::Instance(), anonymous_namespace{AudioSetupToolBar.cpp}::kInput, anonymous_namespace{AudioSetupToolBar.cpp}::kOutput, MakeDeviceSourceString(), mHost, mInput, mOutput, Setting< T >::Read(), and Setting< T >::Write().

Referenced by ChangeHost(), RepopulateMenus(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FillHosts()

void AudioSetupToolBar::FillHosts ( )

private

Definition at line 482 of file AudioSetupToolBar.cpp.

{
   const std::vector<DeviceSourceMap> &inMaps = DeviceManager::Instance()->GetInputDeviceMaps();
   const std::vector<DeviceSourceMap> &outMaps = DeviceManager::Instance()->GetOutputDeviceMaps();
 
   wxArrayString hosts;
 
   // go over our lists add the host to the list if it isn't there yet
 
   for (auto & device : inMaps) {
      if (!make_iterator_range(hosts).contains(device.hostString)) {
         hosts.push_back(device.hostString);
      }
   }
 
   for (auto & device : outMaps) {
      if (!make_iterator_range(hosts).contains(device.hostString)) {
         hosts.push_back(device.hostString);
      }
   }
 
   mHost = std::make_unique<wxMenu>();
 
   for (int i = 0; i < hosts.size(); ++i)
      mHost->AppendRadioItem(kHost + i, hosts[i]);
}

References DeviceManager::GetInputDeviceMaps(), DeviceManager::GetOutputDeviceMaps(), DeviceManager::Instance(), anonymous_namespace{AudioSetupToolBar.cpp}::kHost, make_iterator_range(), and mHost.

Referenced by RepopulateMenus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FillInputChannels()

void AudioSetupToolBar::FillInputChannels ( )

private

Definition at line 602 of file AudioSetupToolBar.cpp.

{
   const std::vector<DeviceSourceMap> &inMaps = DeviceManager::Instance()->GetInputDeviceMaps();
   auto host = AudioIOHost.Read();
   auto device = AudioIORecordingDevice.Read();
   auto source = AudioIORecordingSource.Read();
   long newChannels;
 
   auto oldChannels = AudioIORecordChannels.Read();
   mInputChannels = std::make_unique<wxMenu>();
 
   for (auto & dev: inMaps) {
      if (source == dev.sourceString &&
          device == dev.deviceString &&
          host   == dev.hostString) {
 
         // add one selection for each channel of this source
         for (size_t j = 0; j < (unsigned int)dev.numChannels; j++) {
            wxString name;
 
            if (j == 0) {
               name = _("1 (Mono) Recording Channel");
            }
            else if (j == 1) {
               name = _("2 (Stereo) Recording Channels");
            }
            else {
               name = wxString::Format(wxT("%d"), (int)j + 1);
            }
            mInputChannels->AppendRadioItem(kInputChannels + j, name);
         }
         newChannels = dev.numChannels;
         if (oldChannels <= newChannels && oldChannels >= 1) {
            newChannels = oldChannels;
         }
         if (newChannels >= 1) {
            mInputChannels->FindItem(kInputChannels + newChannels - 1)->Check();
         }
         AudioIORecordChannels.Write(newChannels);
         break;
      }
   }
}

References _, AudioIOHost, AudioIORecordChannels, AudioIORecordingDevice, AudioIORecordingSource, DeviceManager::GetInputDeviceMaps(), DeviceManager::Instance(), anonymous_namespace{AudioSetupToolBar.cpp}::kInputChannels, mInputChannels, name, Setting< T >::Read(), and Setting< T >::Write().

Referenced by RepopulateMenus(), SetDevices(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [1/2]

AudioSetupToolBar & AudioSetupToolBar::Get ( AudacityProject & project )

static

Definition at line 95 of file AudioSetupToolBar.cpp.

{
   auto &toolManager = ToolManager::Get( project );
   return *static_cast<AudioSetupToolBar*>( toolManager.GetToolBar(AudioSetupBarID) );
}

References AudioSetupBarID, and ToolManager::Get().

Referenced by Get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [2/2]

const AudioSetupToolBar & AudioSetupToolBar::Get ( const AudacityProject & project )

static

Definition at line 101 of file AudioSetupToolBar.cpp.

{
   return Get( const_cast<AudacityProject&>( project )) ;
}

References Get().

Here is the call graph for this function:

◆ GetSelectedRadioItemLabel()

std::optional< wxString > AudioSetupToolBar::GetSelectedRadioItemLabel ( const wxMenu & menu ) const

private

Definition at line 671 of file AudioSetupToolBar.cpp.

{
   const auto& items = menu.GetMenuItems();
 
   for (const auto& item : items) {
      if (item->IsChecked())
         return item->GetItemLabelText();
   }
 
   return std::nullopt;
}

Referenced by AppendSubMenu(), and UpdatePrefs().

Here is the caller graph for this function:

◆ MakeAudioSetupButton()

void AudioSetupToolBar::MakeAudioSetupButton ( )

private

Definition at line 154 of file AudioSetupToolBar.cpp.

{
   bool bUseAqua = false;
 
#ifdef EXPERIMENTAL_THEME_PREFS
   gPrefs->Read(wxT("/GUI/ShowMac"), &bUseAqua, false);
#endif
 
#ifdef USE_AQUA_THEME
   bUseAqua = !bUseAqua;
#endif
 
   const auto size = theTheme.ImageSize(bmpRecoloredSetupUpSmall);
 
   if (bUseAqua) {
      MakeMacRecoloredImageSize(bmpRecoloredSetupUpSmall, bmpMacUpButtonSmall, size);
      MakeMacRecoloredImageSize(bmpRecoloredSetupDownSmall, bmpMacDownButtonSmall, size);
      MakeMacRecoloredImageSize(bmpRecoloredSetupUpHiliteSmall, bmpMacHiliteUpButtonSmall, size);
      MakeMacRecoloredImageSize(bmpRecoloredSetupHiliteSmall, bmpMacHiliteButtonSmall, size);
   }
   else {
      MakeRecoloredImageSize(bmpRecoloredSetupUpSmall, bmpUpButtonSmall, size);
      MakeRecoloredImageSize(bmpRecoloredSetupDownSmall, bmpDownButtonSmall, size);
      MakeRecoloredImageSize(bmpRecoloredSetupUpHiliteSmall, bmpHiliteUpButtonSmall, size);
      MakeRecoloredImageSize(bmpRecoloredSetupHiliteSmall, bmpHiliteButtonSmall, size);
   }
 
   mAudioSetup = MakeButton(this,
      bmpRecoloredSetupUpSmall, bmpRecoloredSetupDownSmall,
      bmpRecoloredSetupUpHiliteSmall, bmpRecoloredSetupHiliteSmall,
      bmpSetup, bmpSetup, bmpSetup,
      ID_AUDIO_SETUP_BUTTON,
      wxDefaultPosition,
      true,
      theTheme.ImageSize(bmpRecoloredSetupUpSmall));
 
   mAudioSetup->SetLabel(XO("Audio Setup"));
}

References gPrefs, ID_AUDIO_SETUP_BUTTON, ThemeBase::ImageSize(), ToolBar::MakeButton(), ToolBar::MakeMacRecoloredImageSize(), ToolBar::MakeRecoloredImageSize(), mAudioSetup, AButton::SetLabel(), size, theTheme, and XO.

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnAudioSetup()

void AudioSetupToolBar::OnAudioSetup ( wxCommandEvent & event )

Definition at line 263 of file AudioSetupToolBar.cpp.

{
   // Be sure the pop-up happens even if there are exceptions, except for buttons which toggle.
   auto cleanup = finally([&] { mAudioSetup->InteractionOver(); });
 
   wxMenu menu;
 
   AppendSubMenu(menu, mHost, "&Host");
   menu.AppendSeparator();
 
   AppendSubMenu(menu, mOutput, "&Playback Device");
   menu.AppendSeparator();
 
   AppendSubMenu(menu, mInput, "&Recording Device");
   menu.AppendSeparator();
 
   AppendSubMenu(menu, mInputChannels, "Recording &Channels");
   menu.AppendSeparator();
   menu.Append(kAudioSettings, _("&Audio Settings..."));
 
   menu.Bind(wxEVT_MENU_CLOSE, [this](auto&) { mAudioSetup->PopUp(); });
   menu.Bind(wxEVT_MENU, &AudioSetupToolBar::OnMenu, this);
 
   wxWindow* btn = FindWindow(ID_AUDIO_SETUP_BUTTON);
   wxRect r = btn->GetRect();
   BasicMenu::Handle{ &menu }.Popup(
      wxWidgetsWindowPlacement{ btn },
      { r.GetLeft(), r.GetBottom() }
   );
}

References _, AppendSubMenu(), ID_AUDIO_SETUP_BUTTON, AButton::InteractionOver(), anonymous_namespace{AudioSetupToolBar.cpp}::kAudioSettings, mAudioSetup, mHost, mInput, mInputChannels, mOutput, OnMenu(), AButton::PopUp(), and BasicMenu::Handle::Popup().

Here is the call graph for this function:

◆ OnFocus()

void AudioSetupToolBar::OnFocus ( wxFocusEvent & event )

Definition at line 258 of file AudioSetupToolBar.cpp.

{
   KeyboardCapture::OnFocus( *this, event );
}

References KeyboardCapture::OnFocus().

Here is the call graph for this function:

◆ OnMenu()

void AudioSetupToolBar::OnMenu ( wxCommandEvent & event )

private

Definition at line 773 of file AudioSetupToolBar.cpp.

{
   int id = event.GetId();
   bool audioSettingsChosen = false;
 
   if ((id >= kHost) && (id < kInput)) {
      ChangeHost(id);
   }
   else if ((id >= kInputChannels) && (id < kOutput)) {
      if (auto item = mInputChannels->FindChildItem(id)) {
         // Update cache with selected number of input channels
         item->Check();
         AudioIORecordChannels.Write(id - kInputChannels + 1);
      }
   }
   else if ((id >= kInput) && (id < kInputChannels)) {
      ChangeDevice(id, true);
   }
   else if ((id >= kOutput) && (id < kAudioSettings)) {
      ChangeDevice(id, false);
   }
   else if (id == kAudioSettings) {
      audioSettingsChosen = true;
   }
 
   auto gAudioIO = AudioIOBase::Get();
   if (gAudioIO) {
      // We cannot have gotten here if gAudioIO->IsAudioTokenActive(),
      // per the setting of AudioIONotBusyFlag and AudioIOBusyFlag in
      // AudacityProject::GetUpdateFlags().
      // However, we can have an invalid audio token (so IsAudioTokenActive()
      // is false), but be monitoring.
      // If monitoring, have to stop the stream, so HandleDeviceChange() can work.
      // We could disable the Preferences command while monitoring, i.e.,
      // set AudioIONotBusyFlag/AudioIOBusyFlag according to monitoring, as well.
      // Instead allow it because unlike recording, for example, monitoring
      // is not clearly something that should prohibit changing device.
      // TODO: We *could* be smarter in this method and call HandleDeviceChange()
      // only when the device choices actually changed. True of lots of prefs!
      // As is, we always stop monitoring before handling the device change.
      if (gAudioIO->IsMonitoring())
      {
         gAudioIO->StopStream();
         while (gAudioIO->IsBusy()) {
            using namespace std::chrono;
            std::this_thread::sleep_for(100ms);
         }
      }
 
      if (audioSettingsChosen) {
         PrefsPanel::Factories factories;
         factories.push_back(PrefsPanel::PrefsNode(DevicePrefsFactory));
 
         ViewDeviceSettingsDialog dialog(&GetProjectFrame(mProject), mProject, XO("Audio Settings:"), factories, 0);
         dialog.SetSize(600, 420);
         dialog.Center();
 
         if (0 != dialog.ShowModal()) {
            PrefsListener::Broadcast(DeviceToolbarPrefsID());
         }
      }
      else {
         gAudioIO->HandleDeviceChange();
         PrefsListener::Broadcast(DeviceToolbarPrefsID());
      }
   }
}

References AudioIORecordChannels, PrefsListener::Broadcast(), ChangeDevice(), ChangeHost(), DevicePrefsFactory(), DeviceToolbarPrefsID(), AudioIOBase::Get(), GetProjectFrame(), anonymous_namespace{AudioSetupToolBar.cpp}::kAudioSettings, anonymous_namespace{AudioSetupToolBar.cpp}::kHost, anonymous_namespace{AudioSetupToolBar.cpp}::kInput, anonymous_namespace{AudioSetupToolBar.cpp}::kInputChannels, anonymous_namespace{AudioSetupToolBar.cpp}::kOutput, mInputChannels, ToolBar::mProject, Setting< T >::Write(), and XO.

Referenced by OnAudioSetup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnRescannedDevices()

void AudioSetupToolBar::OnRescannedDevices ( DeviceChangeMessage m )

private

Definition at line 683 of file AudioSetupToolBar.cpp.

{
   // Hosts may have disappeared or appeared so a complete repopulate is needed.
   if (m == DeviceChangeMessage::Rescan)
      RepopulateMenus();
}

References RepopulateMenus(), and Rescan.

Referenced by AudioSetupToolBar().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Populate()

void AudioSetupToolBar::Populate ( )

overridevirtual

Implements ToolBar.

Definition at line 124 of file AudioSetupToolBar.cpp.

{
   SetBackgroundColour( theTheme.Colour( clrMedium  ) );
   MakeAudioSetupButton();
 
   DeinitChildren();
 
#if wxUSE_TOOLTIPS
   RegenerateTooltips();
   wxToolTip::Enable(true);
   wxToolTip::SetDelay(1000);
#endif
 
   // Set default order and mode
   ArrangeButtons();
 
   RepopulateMenus();
}

References ArrangeButtons(), ThemeBase::Colour(), DeinitChildren(), MakeAudioSetupButton(), RegenerateTooltips(), RepopulateMenus(), and theTheme.

Here is the call graph for this function:

◆ ReCreateButtons()

void AudioSetupToolBar::ReCreateButtons ( )

overridevirtual

Reimplemented from ToolBar.

Definition at line 230 of file AudioSetupToolBar.cpp.

{
   bool isAudioSetupDown = false;
 
   // ToolBar::ReCreateButtons() will get rid of its sizer and
   // since we've attached our sizer to it, ours will get deleted too
   // so clean ours up first.
   if (mSizer)
   {
      isAudioSetupDown = mAudioSetup->IsDown();
      Detach(mSizer);
 
      std::unique_ptr < wxSizer > {mSizer}; // DELETE it
      mSizer = nullptr;
   }
 
   ToolBar::ReCreateButtons();
 
   if (isAudioSetupDown)
   {
      mAudioSetup->PushDown();
   }
 
   EnableDisableButtons();
 
   RegenerateTooltips();
}

References ToolBar::Detach(), EnableDisableButtons(), AButton::IsDown(), mAudioSetup, mSizer, AButton::PushDown(), ToolBar::ReCreateButtons(), and RegenerateTooltips().

Here is the call graph for this function:

◆ RegenerateTooltips()

void AudioSetupToolBar::RegenerateTooltips ( )

overrideprivatevirtual

Implements ToolBar.

Definition at line 445 of file AudioSetupToolBar.cpp.

{
#if wxUSE_TOOLTIPS
   for (long iWinID = ID_AUDIO_SETUP_BUTTON; iWinID < BUTTON_COUNT; iWinID++)
   {
      auto pCtrl = static_cast<AButton*>(this->FindWindow(iWinID));
      CommandID name;
      switch (iWinID)
      {
      case ID_AUDIO_SETUP_BUTTON:
         name = wxT("Open Audio Setup");
         break;
      }
      std::vector<ComponentInterfaceSymbol> commands(
         1u, { name, Verbatim(pCtrl->GetLabel()) });
 
      // Some have a second
      switch (iWinID)
      {
      case ID_AUDIO_SETUP_BUTTON:
         break;
      }
      ToolBar::SetButtonToolTip(
         mProject, *pCtrl, commands.data(), commands.size());
   }
#endif
}

References BUTTON_COUNT, ID_AUDIO_SETUP_BUTTON, ToolBar::mProject, name, ToolBar::SetButtonToolTip(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::size(), and Verbatim().

Referenced by Populate(), ReCreateButtons(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Repaint()

void AudioSetupToolBar::Repaint ( wxDC * dc )

overridevirtual

Implements ToolBar.

Definition at line 143 of file AudioSetupToolBar.cpp.

{
#ifndef USE_AQUA_THEME
   wxSize s = mSizer->GetSize();
   wxPoint p = mSizer->GetPosition();
 
   wxRect bevelRect(p.x, p.y, s.GetWidth() - 1, s.GetHeight() - 1);
   AColor::Bevel(*dc, true, bevelRect);
#endif
}

References AColor::Bevel(), and mSizer.

Here is the call graph for this function:

◆ RepopulateMenus()

void AudioSetupToolBar::RepopulateMenus ( )

private

Definition at line 473 of file AudioSetupToolBar.cpp.

{
   FillHosts();
   FillHostDevices();
   FillInputChannels();
   // make the device display selection reflect the prefs if they exist
   UpdatePrefs();
}

References FillHostDevices(), FillHosts(), FillInputChannels(), and UpdatePrefs().

Referenced by OnRescannedDevices(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDevices()

void AudioSetupToolBar::SetDevices	(	const DeviceSourceMap *	in,
		const DeviceSourceMap *	out
	)

private

Definition at line 716 of file AudioSetupToolBar.cpp.

{
   if (in) {
      AudioIORecordingDevice.Write(in->deviceString);
      AudioIORecordingSourceIndex.Write(in->sourceIndex);
      if (in->totalSources >= 1)
         AudioIORecordingSource.Write(in->sourceString);
      else
         AudioIORecordingSource.Reset();
      gPrefs->Flush();
 
      FillInputChannels();
   }
 
   if (out) {
      AudioIOPlaybackDevice.Write(out->deviceString);
      if (out->totalSources >= 1) {
         AudioIOPlaybackSource.Write(out->sourceString);
      } else {
         AudioIOPlaybackSource.Reset();
      }
      gPrefs->Flush();
   }
}

References AudioIOPlaybackDevice, AudioIOPlaybackSource, AudioIORecordingDevice, AudioIORecordingSource, AudioIORecordingSourceIndex, DeviceSourceMap::deviceString, FillInputChannels(), FileConfig::Flush(), gPrefs, Setting< T >::Reset(), DeviceSourceMap::sourceIndex, DeviceSourceMap::sourceString, DeviceSourceMap::totalSources, and Setting< T >::Write().

Referenced by ChangeDevice(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdatePrefs()

void AudioSetupToolBar::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 294 of file AudioSetupToolBar.cpp.

{
   wxString desc;
   const std::vector<DeviceSourceMap> &inMaps  = DeviceManager::Instance()->GetInputDeviceMaps();
   const std::vector<DeviceSourceMap> &outMaps = DeviceManager::Instance()->GetOutputDeviceMaps();
 
   auto selectedHost = GetSelectedRadioItemLabel(*mHost);
   wxString oldHost = selectedHost ? *selectedHost : wxString{};
 
   auto hostName = AudioIOHost.Read();
 
   // if the prefs host name doesn't match the one displayed, it changed
   // in another project's AudioSetupToolBar, so we need to repopulate everything.
   if (oldHost != hostName)
      FillHostDevices();
 
   auto devName = AudioIORecordingDevice.Read();
   auto sourceName = AudioIORecordingSource.Read();
   if (sourceName.empty())
      desc = devName;
   else
      desc = devName + wxT(": ") + sourceName;
 
   auto selectedInput = GetSelectedRadioItemLabel(*mInput);
   if (selectedInput && *selectedInput != desc) {
      if (auto item = mInput->FindItem(desc); item != wxNOT_FOUND) {
         mInput->FindChildItem(item)->Check();
         FillInputChannels();
      }
      else if (mInput->GetMenuItemCount()) {
         for (size_t i = 0; i < inMaps.size(); i++) {
            if (inMaps[i].hostString == hostName &&
               MakeDeviceSourceString(&inMaps[i]) == mInput->FindItem(kInput)->GetItemLabelText()) {
               // use the default.  It should exist but check just in case, falling back on the 0 index.
               DeviceSourceMap* defaultMap = DeviceManager::Instance()->GetDefaultInputDevice(inMaps[i].hostIndex);
               if (defaultMap) {
                  const auto menuId = mInput->FindItem(MakeDeviceSourceString(defaultMap));
                  auto item = mInput->FindChildItem(menuId);
                  if (item)
                     item->Check();
 
                  SetDevices(defaultMap, nullptr);
               }
               else {
                  //use the first item (0th index) if we have no familiar devices
                  auto item = mInput->FindChildItem(kInput);
                  if (item)
                     item->Check();
 
                  SetDevices(&inMaps[i], nullptr);
               }
               break;
            }
         }
      }
   } 
 
   devName = AudioIOPlaybackDevice.Read();
   sourceName = AudioIOPlaybackSource.Read();
   if (sourceName.empty())
      desc = devName;
   else
      desc = devName + wxT(": ") + sourceName;
 
   auto selectedOutput = GetSelectedRadioItemLabel(*mOutput);
   if (selectedOutput && *selectedOutput != desc) {
      if (auto item = mOutput->FindItem(desc); item != wxNOT_FOUND) {
         mOutput->FindChildItem(item)->Check();
      }
      else if (mOutput->GetMenuItemCount()) {
         for (size_t i = 0; i < outMaps.size(); i++) {
            if (outMaps[i].hostString == hostName &&
               MakeDeviceSourceString(&outMaps[i]) == mOutput->FindItem(kOutput)->GetItemLabelText()) {
               // use the default.  It should exist but check just in case, falling back on the 0 index.
               DeviceSourceMap* defaultMap = DeviceManager::Instance()->GetDefaultInputDevice(outMaps[i].hostIndex);
               if (defaultMap) {
                  const auto menuId = mOutput->FindItem(MakeDeviceSourceString(defaultMap));
                  auto item = mOutput->FindChildItem(menuId);
                  if (item)
                     item->Check();
 
                  SetDevices(nullptr, defaultMap);
               }
               else {
                  //use the first item (0th index) if we have no familiar devices
                  auto item = mOutput->FindChildItem(kOutput);
                  if (item)
                     item->Check();
 
                  SetDevices(nullptr, &outMaps[i]);
               }
               break;
            }
         }
      }
   }
 
   long oldChannels;
   for (const auto & item : mInputChannels->GetMenuItems()) {
      if (item->IsChecked())
         oldChannels = item->GetId() - kInputChannels + 1;
   }
 
   auto newChannels = AudioIORecordChannels.ReadWithDefault(0);
   if (newChannels > 0 && oldChannels != newChannels)
      mInputChannels->FindChildItem(kInputChannels + newChannels - 1)->Check();
 
   selectedHost = GetSelectedRadioItemLabel(*mHost);
   if (!hostName.empty() && selectedHost && selectedHost != hostName) {
      const auto id = mHost->FindItem(hostName);
      if (id != wxNOT_FOUND) {
         mHost->FindChildItem(id)->Check();
      }
   }
 
   RegenerateTooltips();
 
   // Set label to pull in language change
   SetLabel(XO("Audio Setup"));
 
   // Give base class a chance
   ToolBar::UpdatePrefs();
 
   Layout();
   Refresh();
}

References AudioIOHost, AudioIOPlaybackDevice, AudioIOPlaybackSource, AudioIORecordChannels, AudioIORecordingDevice, AudioIORecordingSource, desc, FillHostDevices(), FillInputChannels(), DeviceManager::GetDefaultInputDevice(), DeviceManager::GetInputDeviceMaps(), DeviceManager::GetOutputDeviceMaps(), GetSelectedRadioItemLabel(), DeviceManager::Instance(), anonymous_namespace{AudioSetupToolBar.cpp}::kInput, anonymous_namespace{AudioSetupToolBar.cpp}::kInputChannels, anonymous_namespace{AudioSetupToolBar.cpp}::kOutput, MakeDeviceSourceString(), mHost, mInput, mInputChannels, mOutput, Setting< T >::Read(), Setting< T >::ReadWithDefault(), RegenerateTooltips(), SetDevices(), ToolBar::SetLabel(), ToolBar::UpdatePrefs(), and XO.

Referenced by RepopulateMenus(), and UpdateSelectedPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateSelectedPrefs()

void AudioSetupToolBar::UpdateSelectedPrefs ( int id )

overridevirtual

Reimplemented from PrefsListener.

Definition at line 421 of file AudioSetupToolBar.cpp.

{
   if (id == DeviceToolbarPrefsID())
      UpdatePrefs();
   ToolBar::UpdateSelectedPrefs( id );
}

References DeviceToolbarPrefsID(), UpdatePrefs(), and PrefsListener::UpdateSelectedPrefs().

Here is the call graph for this function:

Member Data Documentation

◆ mAudioSetup

AButton* AudioSetupToolBar::mAudioSetup {}

private

Definition at line 74 of file AudioSetupToolBar.h.

Referenced by ArrangeButtons(), EnableDisableButtons(), MakeAudioSetupButton(), OnAudioSetup(), and ReCreateButtons().

◆ mHost

std::unique_ptr<wxMenu> AudioSetupToolBar::mHost

private

Definition at line 80 of file AudioSetupToolBar.h.

Referenced by ChangeHost(), DeinitChildren(), FillHostDevices(), FillHosts(), OnAudioSetup(), and UpdatePrefs().

◆ mInput

std::unique_ptr<wxMenu> AudioSetupToolBar::mInput

private

Definition at line 77 of file AudioSetupToolBar.h.

Referenced by ChangeDevice(), DeinitChildren(), FillHostDevices(), OnAudioSetup(), and UpdatePrefs().

◆ mInputChannels

std::unique_ptr<wxMenu> AudioSetupToolBar::mInputChannels

private

Definition at line 79 of file AudioSetupToolBar.h.

Referenced by DeinitChildren(), FillInputChannels(), OnAudioSetup(), OnMenu(), and UpdatePrefs().

◆ mOutput

std::unique_ptr<wxMenu> AudioSetupToolBar::mOutput

private

Definition at line 78 of file AudioSetupToolBar.h.

Referenced by ChangeDevice(), DeinitChildren(), FillHostDevices(), OnAudioSetup(), and UpdatePrefs().

◆ mSizer

wxBoxSizer* AudioSetupToolBar::mSizer {}

private

Definition at line 75 of file AudioSetupToolBar.h.

Referenced by ArrangeButtons(), ReCreateButtons(), and Repaint().

◆ mSubscription

Observer::Subscription AudioSetupToolBar::mSubscription

private

Definition at line 82 of file AudioSetupToolBar.h.

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

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ AudioSetupToolBar()

◆ ~AudioSetupToolBar()

Member Function Documentation

◆ AppendSubMenu()

◆ ArrangeButtons()

◆ ChangeDevice()

◆ ChangeHost()

◆ CloneMenu()

◆ Create()

◆ DeinitChildren()

◆ EnableDisableButtons()

◆ FillHostDevices()

◆ FillHosts()

◆ FillInputChannels()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetSelectedRadioItemLabel()

◆ MakeAudioSetupButton()

◆ OnAudioSetup()

◆ OnFocus()

◆ OnMenu()

◆ OnRescannedDevices()

◆ Populate()

◆ ReCreateButtons()

◆ RegenerateTooltips()

◆ Repaint()

◆ RepopulateMenus()

◆ SetDevices()

◆ UpdatePrefs()

◆ UpdateSelectedPrefs()

Member Data Documentation

◆ mAudioSetup

◆ mHost

◆ mInput

◆ mInputChannels

◆ mOutput

◆ mSizer

◆ mSubscription