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

#include <AudioSetupToolBar.h>

Inheritance diagram for AudioSetupToolBar:

Collaboration diagram for AudioSetupToolBar:

Classes
class	Choices

Public Member Functions
	AudioSetupToolBar (AudacityProject &project)

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, const TranslatableString &label, const Identifier &section, bool resizable=false)

virtual	~ToolBar ()

virtual bool	ShownByDefault () const
	Whether the toolbar should be shown by default. Default implementation returns true. More...

virtual bool	HideAfterReset () const
	Default implementation returns false. More...

virtual DockID	DefaultDockID () const
	Which dock the toolbar defaults into. Default implementation chooses the top dock. More...

bool	AcceptsFocus () const override

bool	AcceptsFocusFromKeyboard () 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	GetIndex () const
	Get a value used for computing cascading positions of undocked bars. More...

void	SetIndex (int index)
	Set a value used for computing cascading positions of undocked bars. More...

TranslatableString	GetTitle ()

TranslatableString	GetLabel ()

Identifier	GetSection ()

ToolDock *	GetDock ()

void	SetPreferredNeighbors (Identifier left, Identifier top={})

void	SetLabel (const TranslatableString &label)

virtual void	SetDocked (ToolDock *dock, bool pushed)

std::pair< Identifier, Identifier >	PreferredNeighbors () const noexcept
	Defaults to (NoBarID, NoBarId) More...

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 Identifier	ID ()
	Methods for AudioSetupToolBar. More...

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 }

using	Callback = void(AudioSetupToolBar::*)(int id)

Private Member Functions
void	OnRescannedDevices (DeviceChangeMessage)

void	OnHost (int id)

void	OnInput (int id)

void	OnChannels (int id)

void	OnOutput (int id)

void	OnAudioDeviceRescan (wxCommandEvent &)

void	OnSettings (wxCommandEvent &event)

void	CommonMenuItemSteps (bool audioSettingsChosen)

bool	ChangeHost (int hostId)

void	ChangeDeviceLabel (int deviceId, Choices &choices, 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 ()

Static Private Member Functions
static void	AppendSubMenu (AudioSetupToolBar &toolbar, wxMenu &menu, const wxArrayString &labels, int checkedItem, Callback callback, const wxString &title)

Private Attributes
AButton *	mAudioSetup {}

Choices	mInput

Choices	mOutput

Choices	mInputChannels

Choices	mHost

Observer::Subscription	mSubscription

Static Private Attributes
static constexpr int	kAudioSettings = 15800

static constexpr int	kAudioDeviceRescan = 15801

Additional Inherited Members
Public Types inherited from ToolBar
enum	DockID { TopDockID = 1 , BotDockID = 2 }
	Identifies one of the docking areas for toolbars. More...

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

Identifier	mSection

int	mIndex {0}

Detailed Description

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

Definition at line 26 of file AudioSetupToolBar.h.

Member Typedef Documentation

◆ Callback

using AudioSetupToolBar::Callback = void (AudioSetupToolBar::*)(int id)

private

Definition at line 75 of file AudioSetupToolBar.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
ID_AUDIO_SETUP_BUTTON
BUTTON_COUNT

Definition at line 84 of file AudioSetupToolBar.h.

        {
      ID_AUDIO_SETUP_BUTTON = 12000,
      BUTTON_COUNT,
   };

Constructor & Destructor Documentation

◆ AudioSetupToolBar()

AudioSetupToolBar::AudioSetupToolBar ( AudacityProject & project )

explicit

Definition at line 81 of file AudioSetupToolBar.cpp.

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

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

Here is the call graph for this function:

◆ ~AudioSetupToolBar()

AudioSetupToolBar::~AudioSetupToolBar ( )

virtual

Definition at line 88 of file AudioSetupToolBar.cpp.

89{

90}

Member Function Documentation

◆ AppendSubMenu()

void AudioSetupToolBar::AppendSubMenu	(	AudioSetupToolBar &	toolbar,
		wxMenu &	menu,
		const wxArrayString &	labels,
		int	checkedItem,
		Callback	callback,
		const wxString &	title
	)

staticprivate

Definition at line 551 of file AudioSetupToolBar.cpp.

{
   auto subMenu = std::make_unique<wxMenu>();
   int ii = 0;
   for (const auto &label : labels) {
      // Assign fresh ID with wxID_ANY
      auto subMenuItem = subMenu->AppendRadioItem(wxID_ANY, label);
      if (ii == checkedItem)
         subMenuItem->Check();
      subMenu->Bind(wxEVT_MENU,
         [&toolbar, callback, ii](wxCommandEvent &){ (toolbar.*callback)(ii); },
         subMenuItem->GetId());
      ++ii;
   }
   auto menuItem = menu.AppendSubMenu(subMenu.release(), title);
   if (checkedItem < 0)
      menuItem->Enable(false);
}

References label, and title.

Referenced by AudioSetupToolBar::Choices::AppendSubMenu().

Here is the caller graph for this function:

◆ ArrangeButtons()

void AudioSetupToolBar::ArrangeButtons ( )

private

Definition at line 165 of file AudioSetupToolBar.cpp.

{
   Add(mAudioSetup, 0, wxALIGN_CENTER | wxALL, toolbarSpacing);
   // Layout the toolbar
   Layout();
   SetMinSize(GetSizer()->GetMinSize());
}

References ToolBar::Add(), ToolBar::GetSizer(), mAudioSetup, and toolbarSpacing.

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ChangeDeviceLabel()

void AudioSetupToolBar::ChangeDeviceLabel	(	int	deviceId,
		Choices &	choices,
		bool	isInput
	)

private

Definition at line 637 of file AudioSetupToolBar.cpp.

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

References AudioIOHost, AudioSetupToolBar::Choices::Get(), DeviceManager::GetInputDeviceMaps(), DeviceManager::GetOutputDeviceMaps(), DeviceManager::Instance(), MakeDeviceSourceString(), name, Setting< T >::Read(), AudioSetupToolBar::Choices::Set(), SetDevices(), and wxT().

Referenced by OnInput(), and OnOutput().

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 587 of file AudioSetupToolBar.cpp.

{
   // Update cache with selected host
   if (!mHost.Set(hostId))
      return false;
   auto name = mHost.Get();
   assert(name); // should not be nullopt if Set succeeded
 
   auto oldHost = AudioIOHost.Read();
   const auto newHost = *name;
 
   if (oldHost == newHost)
      return false;
 
   //change the host and switch to correct devices.
   AudioIOHost.Write(newHost);
   gPrefs->Flush();
 
   // populate the devices and reassign mHost
   FillHostDevices();
 
   return true;
}

References AudioIOHost, FillHostDevices(), audacity::BasicSettings::Flush(), AudioSetupToolBar::Choices::Get(), gPrefs, mHost, name, Setting< T >::Read(), AudioSetupToolBar::Choices::Set(), and Setting< T >::Write().

Referenced by OnHost().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CommonMenuItemSteps()

void AudioSetupToolBar::CommonMenuItemSteps ( bool audioSettingsChosen )

private

Definition at line 704 of file AudioSetupToolBar.cpp.

{
   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, {}, factories, 0);
         dialog.SetSize(600, 420);
         dialog.Center();
 
         if (0 != dialog.ShowModal()) {
            PrefsListener::Broadcast(DeviceToolbarPrefsID());
         }
      }
      else {
         gAudioIO->HandleDeviceChange();
         PrefsListener::Broadcast(DeviceToolbarPrefsID());
      }
   }
}

References PrefsListener::Broadcast(), DevicePrefsFactory(), DeviceToolbarPrefsID(), AudioIOBase::Get(), GetProjectFrame(), and ToolBar::mProject.

Referenced by OnChannels(), OnHost(), OnInput(), OnOutput(), and OnSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Create()

void AudioSetupToolBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 103 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 113 of file AudioSetupToolBar.cpp.

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

References AudioSetupToolBar::Choices::Clear(), mHost, mInput, mInputChannels, and mOutput.

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EnableDisableButtons()

void AudioSetupToolBar::EnableDisableButtons ( )

overridevirtual

Implements ToolBar.

Definition at line 343 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 420 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.Find(host) < 0)
      host = wxT("");
 
   // Try to find a hostIndex, among either inputs or outputs, assumed to be
   // unique among the union of the set of input and output devices
   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.Clear();
   mOutput.Clear();
 
   // 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
   wxArrayStringEx mInputDeviceNames;
   for (size_t i = 0; i < inMaps.size(); ++i) {
      auto& device = inMaps[i];
      if (foundHostIndex == device.hostIndex) {
         mInputDeviceNames.push_back(MakeDeviceSourceString(&device));
         if (host.empty()) {
            host = device.hostString;
            AudioIOHost.Write(host);
            mHost.Set(host);
         }
      }
   }
   mInput.Set(std::move(mInputDeviceNames));
 
   wxArrayStringEx mOutputDeviceNames;
   for (size_t i = 0; i < outMaps.size(); ++i) {
      auto& device = outMaps[i];
      if (foundHostIndex == device.hostIndex) {
         mOutputDeviceNames.push_back(MakeDeviceSourceString(&device));
         if (host.empty()) {
            host = device.hostString;
            AudioIOHost.Write(host);
            mHost.Set(host);
         }
      }
   }
   mOutput.Set(std::move(mOutputDeviceNames));
 
   gPrefs->Flush();
 
   // The setting of the Device is left up to menu handlers
}

References AudioIOHost, AudioSetupToolBar::Choices::Clear(), AudioSetupToolBar::Choices::Find(), audacity::BasicSettings::Flush(), DeviceManager::GetInputDeviceMaps(), DeviceManager::GetOutputDeviceMaps(), gPrefs, DeviceManager::Instance(), MakeDeviceSourceString(), mHost, mInput, mOutput, Setting< T >::Read(), AudioSetupToolBar::Choices::Set(), Setting< T >::Write(), and wxT().

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 396 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.Set(std::move(hosts));
}

References DeviceManager::GetInputDeviceMaps(), DeviceManager::GetOutputDeviceMaps(), DeviceManager::Instance(), make_iterator_range(), mHost, and AudioSetupToolBar::Choices::Set().

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 505 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 = 0;
 
   auto oldChannels = AudioIORecordChannels.Read();
   mInputChannels.Clear();
 
   wxArrayStringEx names;
   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);
            }
            names.push_back(name);
         }
         newChannels = dev.numChannels;
         if (oldChannels <= newChannels && oldChannels >= 1) {
            newChannels = oldChannels;
         }
         AudioIORecordChannels.Write(newChannels);
         break;
      }
   }
   mInputChannels.Set(std::move(names));
   if (newChannels >= 1)
      // Correct to 0-based index in choice
      mInputChannels.Set(newChannels - 1);
}

References _, AudioIOHost, AudioIORecordChannels, AudioIORecordingDevice, AudioIORecordingSource, AudioSetupToolBar::Choices::Clear(), DeviceManager::GetInputDeviceMaps(), DeviceManager::Instance(), mInputChannels, name, names, Setting< T >::Read(), AudioSetupToolBar::Choices::Set(), Setting< T >::Write(), and wxT().

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 92 of file AudioSetupToolBar.cpp.

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

References ToolManager::Get(), ID(), and project.

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 98 of file AudioSetupToolBar.cpp.

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

References Get(), and project.

Here is the call graph for this function:

◆ ID()

Identifier AudioSetupToolBar::ID ( )

static

Methods for AudioSetupToolBar.

Definition at line 75 of file AudioSetupToolBar.cpp.

{
   return wxT("Audio Setup");
}

References wxT().

Referenced by Get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeAudioSetupButton()

void AudioSetupToolBar::MakeAudioSetupButton ( )

private

Definition at line 146 of file AudioSetupToolBar.cpp.

{
   const auto size = wxSize{-1, (toolbarSingle - toolbarMargin ) * 2 };
   mAudioSetup = safenew AButton(this, ID_AUDIO_SETUP_BUTTON);
   //i18n-hint: Audio setup button text, keep as short as possible
   mAudioSetup->SetLabel(XO("Audio Setup"));
   mAudioSetup->SetButtonType(AButton::FrameTextButton);
   mAudioSetup->SetImages(
      theTheme.Image(bmpRecoloredUpSmall),
      theTheme.Image(bmpRecoloredUpHiliteSmall),
      theTheme.Image(bmpRecoloredDownSmall),
      theTheme.Image(bmpRecoloredHiliteSmall),
      theTheme.Image(bmpRecoloredUpSmall));
   mAudioSetup->SetIcon(theTheme.Image(bmpSetup));
   mAudioSetup->SetForegroundColour(theTheme.Colour(clrTrackPanelText));
   mAudioSetup->SetMinSize(size);
   mAudioSetup->SetMaxSize(size);
}

References ThemeBase::Colour(), AButton::FrameTextButton, ID_AUDIO_SETUP_BUTTON, ThemeBase::Image(), mAudioSetup, safenew, AButton::SetButtonType(), AButton::SetIcon(), AButton::SetImages(), AButton::SetLabel(), size, theTheme, toolbarMargin, toolbarSingle, and XO().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnAudioDeviceRescan()

void AudioSetupToolBar::OnAudioDeviceRescan ( wxCommandEvent & )

private

Definition at line 691 of file AudioSetupToolBar.cpp.

{
   BasicUI::CallAfter([]
   {
      DeviceManager::Instance()->Rescan();
   });
}

References BasicUI::CallAfter(), DeviceManager::Instance(), and DeviceManager::Rescan().

Referenced by OnAudioSetup().

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 196 of file AudioSetupToolBar.cpp.

{
   wxMenu menu;
 
   //i18n-hint: Audio setup menu
   mHost.AppendSubMenu(*this, menu, &AudioSetupToolBar::OnHost, _("&Host"));
   menu.AppendSeparator();
 
   //i18n-hint: Audio setup menu
   mOutput.AppendSubMenu(*this, menu,
      &AudioSetupToolBar::OnOutput, _("&Playback Device"));
   menu.AppendSeparator();
 
   //i18n-hint: Audio setup menu
   mInput.AppendSubMenu(*this, menu,
      &AudioSetupToolBar::OnInput, _("&Recording Device"));
   menu.AppendSeparator();
 
   //i18n-hint: Audio setup menu
   mInputChannels.AppendSubMenu(*this,
      menu, &AudioSetupToolBar::OnChannels, _("Recording &Channels"));
   menu.AppendSeparator();
   menu.Append(kAudioDeviceRescan, _("R&escan Audio Devices"));
   menu.Append(kAudioSettings, _("&Audio Settings..."));
 
   menu.Bind(wxEVT_MENU_CLOSE, [this](auto&) { mAudioSetup->PopUp(); });
   menu.Bind(wxEVT_MENU, &AudioSetupToolBar::OnAudioDeviceRescan, this, kAudioDeviceRescan);
   menu.Bind(wxEVT_MENU, &AudioSetupToolBar::OnSettings, this, kAudioSettings);
 
   wxWindow* btn = FindWindow(ID_AUDIO_SETUP_BUTTON);
   wxRect r = btn->GetRect();
   BasicMenu::Handle{ &menu }.Popup(
      wxWidgetsWindowPlacement{ btn },
      { r.GetLeft(), r.GetBottom() }
   );
}

References _, AudioSetupToolBar::Choices::AppendSubMenu(), ID_AUDIO_SETUP_BUTTON, kAudioDeviceRescan, kAudioSettings, mAudioSetup, mHost, mInput, mInputChannels, mOutput, OnAudioDeviceRescan(), OnChannels(), OnHost(), OnInput(), OnOutput(), OnSettings(), AButton::PopUp(), and BasicMenu::Handle::Popup().

Here is the call graph for this function:

◆ OnChannels()

void AudioSetupToolBar::OnChannels ( int id )

private

Definition at line 671 of file AudioSetupToolBar.cpp.

{
   mInputChannels.Set(id);
   // Remember 1-based value in preferences
   AudioIORecordChannels.Write(id + 1);
   CommonMenuItemSteps(false);
}

References AudioIORecordChannels, CommonMenuItemSteps(), mInputChannels, AudioSetupToolBar::Choices::Set(), and Setting< T >::Write().

Referenced by OnAudioSetup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnFocus()

void AudioSetupToolBar::OnFocus ( wxFocusEvent & event )

Definition at line 191 of file AudioSetupToolBar.cpp.

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

References KeyboardCapture::OnFocus().

Here is the call graph for this function:

◆ OnHost()

void AudioSetupToolBar::OnHost ( int id )

private

Definition at line 665 of file AudioSetupToolBar.cpp.

{
   ChangeHost(id);
   CommonMenuItemSteps(false);
}

References ChangeHost(), and CommonMenuItemSteps().

Referenced by OnAudioSetup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnInput()

void AudioSetupToolBar::OnInput ( int id )

private

Definition at line 679 of file AudioSetupToolBar.cpp.

{
   ChangeDeviceLabel(id, mInput, true);
   CommonMenuItemSteps(false);
}

References ChangeDeviceLabel(), CommonMenuItemSteps(), and mInput.

Referenced by OnAudioSetup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnOutput()

void AudioSetupToolBar::OnOutput ( int id )

private

Definition at line 685 of file AudioSetupToolBar.cpp.

{
   ChangeDeviceLabel(id, mOutput, false);
   CommonMenuItemSteps(false);
}

References ChangeDeviceLabel(), CommonMenuItemSteps(), and mOutput.

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 579 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:

◆ OnSettings()

void AudioSetupToolBar::OnSettings ( wxCommandEvent & event )

private

Definition at line 699 of file AudioSetupToolBar.cpp.

{
   CommonMenuItemSteps(true);
}

References CommonMenuItemSteps().

Referenced by OnAudioSetup().

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 121 of file AudioSetupToolBar.cpp.

{
   MakeButtonBackgroundsSmall();
   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(), ToolBar::MakeButtonBackgroundsSmall(), RegenerateTooltips(), RepopulateMenus(), and theTheme.

Here is the call graph for this function:

◆ ReCreateButtons()

void AudioSetupToolBar::ReCreateButtons ( )

overridevirtual

Reimplemented from ToolBar.

Definition at line 173 of file AudioSetupToolBar.cpp.

{
   const auto isAudioSetupDown = mAudioSetup != nullptr
      ? mAudioSetup->IsDown()
      : false;
 
   ToolBar::ReCreateButtons();
 
   if (isAudioSetupDown)
   {
      mAudioSetup->PushDown();
   }
 
   EnableDisableButtons();
 
   RegenerateTooltips();
}

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

Here is the call graph for this function:

◆ RegenerateTooltips()

void AudioSetupToolBar::RegenerateTooltips ( )

overrideprivatevirtual

Implements ToolBar.

Definition at line 359 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(), Verbatim(), and wxT().

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 141 of file AudioSetupToolBar.cpp.

{
   // this was used to draw a bevel and can be removed
}

◆ RepopulateMenus()

void AudioSetupToolBar::RepopulateMenus ( )

private

Definition at line 387 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 611 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();
 
      // updates mInputChannels
      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(), audacity::BasicSettings::Flush(), gPrefs, Setting< T >::Reset(), DeviceSourceMap::sourceIndex, DeviceSourceMap::sourceString, DeviceSourceMap::totalSources, and Setting< T >::Write().

Referenced by ChangeDeviceLabel(), 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 233 of file AudioSetupToolBar.cpp.

{
   wxString desc;
   const std::vector<DeviceSourceMap> &inMaps  = DeviceManager::Instance()->GetInputDeviceMaps();
   const std::vector<DeviceSourceMap> &outMaps = DeviceManager::Instance()->GetOutputDeviceMaps();
 
   auto selectedHost = mHost.Get();
   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)
      // updates mHost and mOutput
      FillHostDevices();
 
   auto devName = AudioIORecordingDevice.Read();
   auto sourceName = AudioIORecordingSource.Read();
   if (sourceName.empty())
      desc = devName;
   else
      desc = devName + wxT(": ") + sourceName;
 
   if (mInput.Get() && *mInput.Get() != desc) {
      if (mInput.Set(desc))
         // updates mInputChannels
         FillInputChannels();
      else if (!mInput.Empty()) {
         for (size_t i = 0; i < inMaps.size(); i++) {
            if (inMaps[i].hostString == hostName &&
               MakeDeviceSourceString(&inMaps[i]) == mInput.GetFirst()) {
               // 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) {
                  mInput.Set(MakeDeviceSourceString(defaultMap));
                  SetDevices(defaultMap, nullptr);
               }
               else {
                  //use the first item (0th index) if we have no familiar devices
                  mInput.Set(0);
                  SetDevices(&inMaps[i], nullptr);
               }
               break;
            }
         }
      }
   }
 
   devName = AudioIOPlaybackDevice.Read();
   sourceName = AudioIOPlaybackSource.Read();
   if (sourceName.empty())
      desc = devName;
   else
      desc = devName + wxT(": ") + sourceName;
 
   if (mOutput.Get() && *mOutput.Get() != desc) {
      if (!mOutput.Set(desc) && !mOutput.Empty()) {
         for (size_t i = 0; i < outMaps.size(); i++) {
            if (outMaps[i].hostString == hostName &&
               MakeDeviceSourceString(&outMaps[i]) == mOutput.GetFirst()) {
               // 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) {
                  mOutput.Set(MakeDeviceSourceString(defaultMap));
                  SetDevices(nullptr, defaultMap);
               }
               else {
                  //use the first item (0th index) if we have no familiar devices
                  mOutput.Set(0);
                  SetDevices(nullptr, &outMaps[i]);
               }
               break;
            }
         }
      }
   }
 
   // 0 based choice id is one less than the number of channels
   long oldChannels = 1 + mInputChannels.GetSmallIntegerId();
 
   // Preferences store the actual number of channels
   auto newChannels = AudioIORecordChannels.ReadWithDefault(0);
   if (newChannels > 0 && oldChannels != newChannels)
      mInputChannels.Set(newChannels - 1);
 
   selectedHost = mHost.Get();
   if (!hostName.empty() && selectedHost && *selectedHost != hostName)
      mHost.Set(hostName);
 
   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, anonymous_namespace{ExportPCM.cpp}::desc, AudioSetupToolBar::Choices::Empty(), FillHostDevices(), FillInputChannels(), AudioSetupToolBar::Choices::Get(), DeviceManager::GetDefaultInputDevice(), AudioSetupToolBar::Choices::GetFirst(), DeviceManager::GetInputDeviceMaps(), DeviceManager::GetOutputDeviceMaps(), AudioSetupToolBar::Choices::GetSmallIntegerId(), DeviceManager::Instance(), MakeDeviceSourceString(), mHost, mInput, mInputChannels, mOutput, Setting< T >::Read(), Setting< T >::ReadWithDefault(), RegenerateTooltips(), AudioSetupToolBar::Choices::Set(), SetDevices(), ToolBar::SetLabel(), ToolBar::UpdatePrefs(), wxT(), 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 335 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

◆ kAudioDeviceRescan

constexpr int AudioSetupToolBar::kAudioDeviceRescan = 15801

staticconstexprprivate

Definition at line 28 of file AudioSetupToolBar.h.

Referenced by OnAudioSetup().

◆ kAudioSettings

constexpr int AudioSetupToolBar::kAudioSettings = 15800

staticconstexprprivate

Definition at line 27 of file AudioSetupToolBar.h.

Referenced by OnAudioSetup().

◆ mAudioSetup

AButton* AudioSetupToolBar::mAudioSetup {}

private

Definition at line 89 of file AudioSetupToolBar.h.

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

◆ mHost

Choices AudioSetupToolBar::mHost

private

Definition at line 142 of file AudioSetupToolBar.h.

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

◆ mInput

Choices AudioSetupToolBar::mInput

private

Definition at line 139 of file AudioSetupToolBar.h.

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

◆ mInputChannels

Choices AudioSetupToolBar::mInputChannels

private

Definition at line 141 of file AudioSetupToolBar.h.

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

◆ mOutput

Choices AudioSetupToolBar::mOutput

private

Definition at line 140 of file AudioSetupToolBar.h.

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

◆ mSubscription

Observer::Subscription AudioSetupToolBar::mSubscription

private

Definition at line 144 of file AudioSetupToolBar.h.

Referenced by AudioSetupToolBar().

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

Classes

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Callback

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ AudioSetupToolBar()

◆ ~AudioSetupToolBar()

Member Function Documentation

◆ AppendSubMenu()

◆ ArrangeButtons()

◆ ChangeDeviceLabel()

◆ ChangeHost()

◆ CommonMenuItemSteps()

◆ Create()

◆ DeinitChildren()

◆ EnableDisableButtons()

◆ FillHostDevices()

◆ FillHosts()

◆ FillInputChannels()

◆ Get() [1/2]

◆ Get() [2/2]

◆ ID()

◆ MakeAudioSetupButton()

◆ OnAudioDeviceRescan()

◆ OnAudioSetup()

◆ OnChannels()

◆ OnFocus()

◆ OnHost()

◆ OnInput()

◆ OnOutput()

◆ OnRescannedDevices()

◆ OnSettings()

◆ Populate()

◆ ReCreateButtons()

◆ RegenerateTooltips()

◆ Repaint()

◆ RepopulateMenus()

◆ SetDevices()

◆ UpdatePrefs()

◆ UpdateSelectedPrefs()

Member Data Documentation

◆ kAudioDeviceRescan

◆ kAudioSettings

◆ mAudioSetup

◆ mHost

◆ mInput

◆ mInputChannels

◆ mOutput

◆ mSubscription