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

#include <DeviceToolBar.h>

Inheritance diagram for DeviceToolBar:

Collaboration diagram for DeviceToolBar:

Public Member Functions
	DeviceToolBar (AudacityProject &project)

virtual	~DeviceToolBar ()

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

void	Create (wxWindow *parent) override

void	UpdatePrefs () override

void	UpdateSelectedPrefs (int) override

void	DeinitChildren ()

void	Populate () override

void	Repaint (wxDC *WXUNUSED(dc)) override

void	EnableDisableButtons () override

void	OnFocus (wxFocusEvent &event)

void	OnCaptureKey (wxCommandEvent &event)

void	OnChoice (wxCommandEvent &event)

int	GetInitialWidth () override

int	GetMinToolbarWidth () override

void	ShowInputDialog ()

void	ShowOutputDialog ()

void	ShowHostDialog ()

void	ShowChannelsDialog ()

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 ()

static DeviceToolBar &	Get (AudacityProject &project)

static const DeviceToolBar &	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 Member Functions
void	OnRescannedDevices (DeviceChangeMessage)

int	ChangeHost ()

void	ChangeDevice (bool isInput)

void	RefillCombos ()

void	FillHosts ()

void	FillHostDevices ()

void	FillInputChannels ()

void	SetDevices (const DeviceSourceMap in, const DeviceSourceMap out)

void	SetNames ()

void	RegenerateTooltips () override

void	ShowComboDialog (wxChoice *combo, const TranslatableString &title)

Private Attributes
wxChoice *	mInput

wxChoice *	mOutput

wxChoice *	mInputChannels

wxChoice *	mHost

Observer::Subscription	mSubscription

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 toobar to allow easier changing of input and output devices .

Definition at line 27 of file DeviceToolBar.h.

Constructor & Destructor Documentation

◆ DeviceToolBar()

DeviceToolBar::DeviceToolBar ( AudacityProject & project )

Definition at line 79 of file DeviceToolBar.cpp.

: ToolBar( project, XO("Device"), ID(), true )
{
   mSubscription = DeviceManager::Instance()->Subscribe(
      *this, &DeviceToolBar::OnRescannedDevices );
}

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

Here is the call graph for this function:

◆ ~DeviceToolBar()

DeviceToolBar::~DeviceToolBar ( )

virtual

Definition at line 86 of file DeviceToolBar.cpp.

87{

88}

Member Function Documentation

◆ ChangeDevice()

void DeviceToolBar::ChangeDevice ( bool isInput )

private

Definition at line 620 of file DeviceToolBar.cpp.

{
   int newIndex = -1;
   wxChoice *combo = isInput ? mInput :mOutput;
   size_t i;
 
   int selectionIndex  = combo->GetSelection();
   auto host = AudioIOHost.Read();
   const std::vector<DeviceSourceMap> &maps = isInput ? DeviceManager::Instance()->GetInputDeviceMaps()
                                                      : DeviceManager::Instance()->GetOutputDeviceMaps();
 
   // Find device indices for input and output
   if (selectionIndex >= 0 ) {
      wxString newDevice = combo->GetStringSelection();
      for (i = 0; i < maps.size(); ++i) {
         wxString name;
         name = MakeDeviceSourceString(&maps[i]);
         if (name == newDevice && maps[i].hostString == host) {
            newIndex = i;
         }
      }
   }
 
   if (newIndex < 0) {
      wxLogDebug(wxT("DeviceToolBar::OnChoice(): couldn't find device indices"));
      return;
   }
 
   SetDevices(isInput ? &maps[newIndex] : NULL,
              isInput ? NULL            : &maps[newIndex]);
}

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

Referenced by OnChoice().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ChangeHost()

int DeviceToolBar::ChangeHost ( )

private

Definition at line 573 of file DeviceToolBar.cpp.

{
   int hostSelectionIndex;
   hostSelectionIndex = mHost->GetSelection();
 
   auto oldHost = AudioIOHost.Read();
   wxString newHost = hostSelectionIndex >= 0 ? mHost->GetString(hostSelectionIndex) :
                                                oldHost;
 
   if (oldHost == newHost)
      return 0;
 
   //change the host and switch to correct devices.
   AudioIOHost.Write(newHost);
   gPrefs->Flush();
 
   // populate the devices
   FillHostDevices();
 
   return 1;
}

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

Referenced by OnChoice().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Create()

void DeviceToolBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 106 of file DeviceToolBar.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 DeviceToolBar::DeinitChildren ( )

Definition at line 116 of file DeviceToolBar.cpp.

{
   mInput         = NULL;
   mOutput        = NULL;
   mInputChannels = NULL;
   mHost          = NULL;
}

References mHost, mInput, mInputChannels, and mOutput.

Referenced by Populate().

Here is the caller graph for this function:

◆ EnableDisableButtons()

void DeviceToolBar::EnableDisableButtons ( )

overridevirtual

Implements ToolBar.

Definition at line 354 of file DeviceToolBar.cpp.

{
   auto gAudioIO = AudioIOBase::Get();
   if (gAudioIO) {
      // we allow changes when monitoring, but not when recording
      bool audioStreamActive = gAudioIO->IsStreamActive() && !gAudioIO->IsMonitoring();
 
      // Here we should relinquish focus
      if (audioStreamActive) {
         wxWindow *focus = wxWindow::FindFocus();
         if (focus == mHost || focus == mInput || focus == mOutput || focus == mInputChannels)
            TrackPanel::Get( mProject ).SetFocus();
      }
 
      mHost->Enable(!audioStreamActive);
      mInput->Enable(!audioStreamActive);
      mOutput->Enable(!audioStreamActive);
      mInputChannels->Enable(!audioStreamActive);
   }
}

References BasicUI::FindFocus(), AudioIOBase::Get(), TrackPanel::Get(), mHost, mInput, mInputChannels, mOutput, and ToolBar::mProject.

Here is the call graph for this function:

◆ FillHostDevices()

void DeviceToolBar::FillHostDevices ( )

private

Definition at line 436 of file DeviceToolBar.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->FindString(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->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
   for (auto & device : inMaps) {
      if (foundHostIndex == device.hostIndex) {
         mInput->Append(MakeDeviceSourceString(&device));
         if (host.empty()) {
            host = device.hostString;
            AudioIOHost.Write(host);
            mHost->SetStringSelection(host);
         }
      }
   }
   mInput->Enable(mInput->GetCount() ? true : false);
 
   mInput->SetMinSize(wxSize(50, wxDefaultCoord));
 
   for (auto & device : outMaps) {
      if (foundHostIndex == device.hostIndex) {
         mOutput->Append(MakeDeviceSourceString(&device));
         if (host.empty()) {
            host = device.hostString;
            AudioIOHost.Write(host);
            gPrefs->Flush();
            mHost->SetStringSelection(host);
         }
      }
   }
   mOutput->Enable(mOutput->GetCount() ? true : false);
 
   mOutput->SetMinSize(wxSize(50, wxDefaultCoord));
 
   // The setting of the Device is left up to OnChoice
}

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FillHosts()

void DeviceToolBar::FillHosts ( )

private

Definition at line 405 of file DeviceToolBar.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->Clear();
   mHost->Append(hosts);
 
   if (hosts.size() == 0) {
      mHost->Enable(false);
   }
 
   mHost->SetMinSize(wxSize(50, wxDefaultCoord));
}

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

Referenced by RefillCombos().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FillInputChannels()

void DeviceToolBar::FillInputChannels ( )

private

Definition at line 519 of file DeviceToolBar.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->Clear();
   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->Append(name);
         }
         newChannels = dev.numChannels;
         if (oldChannels <= newChannels && oldChannels >= 1) {
            newChannels = oldChannels;
         }
         if (newChannels >= 1) {
            mInputChannels->SetSelection(newChannels - 1);
         }
         AudioIORecordChannels.Write(newChannels);
         break;
      }
   }
   mInputChannels->Enable(mInputChannels->GetCount() ? true : false);
 
   mInputChannels->SetMinSize(wxSize(50, wxDefaultCoord));
}

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [1/2]

DeviceToolBar & DeviceToolBar::Get ( AudacityProject & project )

static

Definition at line 95 of file DeviceToolBar.cpp.

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

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

Referenced by Get(), anonymous_namespace{DeviceToolBar.cpp}::OnAudioHost(), anonymous_namespace{DeviceToolBar.cpp}::OnInputChannels(), anonymous_namespace{DeviceToolBar.cpp}::OnInputDevice(), and anonymous_namespace{DeviceToolBar.cpp}::OnOutputDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [2/2]

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

static

Definition at line 101 of file DeviceToolBar.cpp.

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

References Get(), and project.

Here is the call graph for this function:

◆ GetInitialWidth()

int DeviceToolBar::GetInitialWidth ( )

inlineoverridevirtual

When the prefs don't exist this value is used. 883 takes a complete row in the default initial size of Audacity.

Reimplemented from ToolBar.

Definition at line 57 of file DeviceToolBar.h.

57{ return 883; }

◆ GetMinToolbarWidth()

int DeviceToolBar::GetMinToolbarWidth ( )

inlineoverridevirtual

Reimplemented from ToolBar.

Definition at line 58 of file DeviceToolBar.h.

58{ return 350; }

◆ ID()

Identifier DeviceToolBar::ID ( )

static

Definition at line 73 of file DeviceToolBar.cpp.

{
   return wxT("Device");
}

References wxT().

Referenced by Get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnCaptureKey()

void DeviceToolBar::OnCaptureKey ( wxCommandEvent & event )

Definition at line 228 of file DeviceToolBar.cpp.

{
   wxKeyEvent *kevent = (wxKeyEvent *)event.GetEventObject();
   int keyCode = kevent->GetKeyCode();
 
   // Pass UP/DOWN/LEFT/RIGHT through for input/output choice
   if (FindFocus() == mInput && (keyCode == WXK_LEFT || keyCode == WXK_RIGHT
                                 || keyCode == WXK_UP || keyCode == WXK_DOWN)) {
      return;
   }
 
   if (FindFocus() == mOutput && (keyCode == WXK_LEFT || keyCode == WXK_RIGHT
                                 || keyCode == WXK_UP || keyCode == WXK_DOWN)) {
      return;
   }
   event.Skip();
 
   return;
}

References BasicUI::FindFocus(), mInput, and mOutput.

Here is the call graph for this function:

◆ OnChoice()

void DeviceToolBar::OnChoice ( wxCommandEvent & event )

Definition at line 652 of file DeviceToolBar.cpp.

{
   wxObject *eventObject = event.GetEventObject();
   //if we've changed hosts, we've handled the device switching already.
   if (eventObject == mHost) {
      ChangeHost();
   } else if (eventObject == mInputChannels) {
      int channelsSelectionIndex = mInputChannels->GetSelection();
      if (channelsSelectionIndex >= 0)
         AudioIORecordChannels.Write(channelsSelectionIndex + 1);
   } else if (eventObject == mInput) {
      ChangeDevice(true);
   }
   else if (eventObject == mOutput) {
      ChangeDevice(false);
   }
 
   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);
         }
      }
      gAudioIO->HandleDeviceChange();
   }
 
   PrefsListener::Broadcast(DeviceToolbarPrefsID());
}

References AudioIORecordChannels, PrefsListener::Broadcast(), ChangeDevice(), ChangeHost(), DeviceToolbarPrefsID(), AudioIOBase::Get(), mHost, mInput, mInputChannels, mOutput, and Setting< T >::Write().

Referenced by ShowComboDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnFocus()

void DeviceToolBar::OnFocus ( wxFocusEvent & event )

Definition at line 223 of file DeviceToolBar.cpp.

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

References KeyboardCapture::OnFocus().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnRescannedDevices()

void DeviceToolBar::OnRescannedDevices ( DeviceChangeMessage m )

private

Definition at line 565 of file DeviceToolBar.cpp.

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

References RefillCombos(), and Rescan.

Referenced by DeviceToolBar().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Populate()

void DeviceToolBar::Populate ( )

overridevirtual

Implements ToolBar.

Definition at line 124 of file DeviceToolBar.cpp.

{
   SetBackgroundColour( theTheme.Colour( clrMedium  ) );
   DeinitChildren();
 
   // Hosts
   mHost = safenew wxChoice(this,
                            wxID_ANY,
                            wxDefaultPosition,
                            wxDefaultSize);
#if wxUSE_ACCESSIBILITY
   // so that name can be set on a standard control
   mHost->SetAccessible(safenew WindowAccessible(mHost));
#endif
   Add(mHost, 15, wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT, 1);
 
   // Input device
   Add(safenew AStaticBitmap(this,
                             wxID_ANY,
                             theTheme.Bitmap(bmpMic)), 0, wxALIGN_CENTER_VERTICAL);
   mInput = safenew wxChoice(this,
                             wxID_ANY,
                             wxDefaultPosition,
                             wxDefaultSize);
#if wxUSE_ACCESSIBILITY
   // so that name can be set on a standard control
   mInput->SetAccessible(safenew WindowAccessible(mInput));
#endif
   Add(mInput, 30, wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT, 1);
 
   // Input channels
   mInputChannels = safenew wxChoice(this,
                                     wxID_ANY,
                                     wxDefaultPosition,
                                     wxDefaultSize);
#if wxUSE_ACCESSIBILITY
   // so that name can be set on a standard control
   mInputChannels->SetAccessible(safenew WindowAccessible(mInputChannels));
#endif
   Add(mInputChannels, 20, wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT, 1);
 
   // Output device
   Add(safenew AStaticBitmap(this,
                             wxID_ANY,
                             theTheme.Bitmap(bmpSpeaker)), 0, wxALIGN_CENTER_VERTICAL);
   mOutput = safenew wxChoice(this,
                              wxID_ANY,
                              wxDefaultPosition,
                              wxDefaultSize);
#if wxUSE_ACCESSIBILITY
   // so that name can be set on a standard control
   mOutput->SetAccessible(safenew WindowAccessible(mOutput));
#endif
   Add(mOutput, 30, wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT, 1);
 
#if defined(__WXGTK3__)
   // Nothing special
#elif defined(__WXGTK__)
   // Scale the font to fit inside (hopefully)
   wxFont font = mHost->GetFont();
   font.Scale((double) toolbarSingle / mHost->GetSize().GetHeight());
 
   // Set it
   mHost->SetFont(font);
   mInput->SetFont(font);
   mInputChannels->SetFont(font);
   mOutput->SetFont(font);
#endif
 
   mHost->Bind(wxEVT_SET_FOCUS,
               &DeviceToolBar::OnFocus,
               this);
   mHost->Bind(wxEVT_KILL_FOCUS,
               &DeviceToolBar::OnFocus,
               this);
   mOutput->Bind(wxEVT_SET_FOCUS,
                 &DeviceToolBar::OnFocus,
                 this);
   mOutput->Bind(wxEVT_KILL_FOCUS,
                 &DeviceToolBar::OnFocus,
                 this);
   mInput->Bind(wxEVT_SET_FOCUS,
                 &DeviceToolBar::OnFocus,
                 this);
   mInput->Bind(wxEVT_KILL_FOCUS,
                 &DeviceToolBar::OnFocus,
                 this);
   mInputChannels->Bind(wxEVT_SET_FOCUS,
                 &DeviceToolBar::OnFocus,
                 this);
   mInputChannels->Bind(wxEVT_KILL_FOCUS,
                 &DeviceToolBar::OnFocus,
                 this);
 
   SetNames();
 
   RefillCombos();
}

References ToolBar::Add(), ThemeBase::Bitmap(), ThemeBase::Colour(), DeinitChildren(), mHost, mInput, mInputChannels, mOutput, OnFocus(), RefillCombos(), safenew, SetNames(), theTheme, and toolbarSingle.

Here is the call graph for this function:

◆ RefillCombos()

void DeviceToolBar::RefillCombos ( )

private

Definition at line 396 of file DeviceToolBar.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:

◆ RegenerateTooltips()

void DeviceToolBar::RegenerateTooltips ( )

overrideprivatevirtual

Implements ToolBar.

Definition at line 385 of file DeviceToolBar.cpp.

{
#if wxUSE_TOOLTIPS
   SetNames();
   mOutput->SetToolTip(mOutput->GetName() + wxT(" - ") + mOutput->GetStringSelection());
   mInput->SetToolTip(mInput->GetName() + wxT(" - ") + mInput->GetStringSelection());
   mHost->SetToolTip(mHost->GetName() + wxT(" - ") + mHost->GetStringSelection());
   mInputChannels->SetToolTip(mInputChannels->GetName() + wxT(" - ") + mInputChannels->GetStringSelection());
#endif
}

References mHost, mInput, mInputChannels, mOutput, SetNames(), and wxT().

Referenced by UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Repaint()

void DeviceToolBar::Repaint ( wxDC * WXUNUSEDdc )

inlineoverride

Definition at line 48 of file DeviceToolBar.h.

48{};

◆ SetDevices()

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

private

Definition at line 595 of file DeviceToolBar.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(), audacity::BasicSettings::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:

◆ SetNames()

void DeviceToolBar::SetNames ( )

private

Definition at line 375 of file DeviceToolBar.cpp.

{
   /* i18n-hint: (noun) It's the device used for playback.*/
   mOutput->SetName(_("Playback Device"));
   /* i18n-hint: (noun) It's the device used for recording.*/
   mInput->SetName(_("Recording Device"));
   mHost->SetName(_("Audio Host"));
   mInputChannels->SetName(_("Recording Channels"));
}

References _, mHost, mInput, mInputChannels, and mOutput.

Referenced by Populate(), and RegenerateTooltips().

Here is the caller graph for this function:

◆ ShowChannelsDialog()

void DeviceToolBar::ShowChannelsDialog ( )

Definition at line 710 of file DeviceToolBar.cpp.

{
   ShowComboDialog(mInputChannels, XO("Select Recording Channels"));
}

References mInputChannels, ShowComboDialog(), and XO().

Here is the call graph for this function:

◆ ShowComboDialog()

void DeviceToolBar::ShowComboDialog	(	wxChoice *	combo,
		const TranslatableString &	title
	)

private

Definition at line 715 of file DeviceToolBar.cpp.

{
   if (!combo || combo->GetCount() == 0) {
      AudacityMessageBox( XO("Device information is not available.") );
      return;
   }
 
#if USE_PORTMIXER
   wxArrayStringEx inputSources = combo->GetStrings();
 
   wxDialogWrapper dlg(nullptr, wxID_ANY, title);
   dlg.SetName();
   ShuttleGui S(&dlg, eIsCreating);
   wxChoice *c;
 
   S.StartVerticalLay(true);
   {
      S.StartHorizontalLay(wxCENTER, false);
      {
         c = S.AddChoice( Verbatim( combo->GetName() ),
            transform_container<TranslatableStrings>( inputSources, Verbatim ),
            combo->GetSelection());
         c->SetMinSize(c->GetBestSize());
      }
      S.EndHorizontalLay();
   }
   S.EndVerticalLay();
   S.AddStandardButtons();
 
   dlg.GetSizer()->SetSizeHints(&dlg);
   dlg.Center();
 
   if (dlg.ShowModal() == wxID_OK)
   {
      wxCommandEvent dummyEvent;
      dummyEvent.SetEventObject(combo);
      // SetSelection() doesn't send an event, so we call OnChoice explicitly
      combo->SetSelection(c->GetSelection());
      OnChoice(dummyEvent);
   }
#endif
}

References AudacityMessageBox(), eIsCreating, OnChoice(), S, wxDialogWrapper::SetName(), title, Verbatim(), and XO().

Referenced by ShowChannelsDialog(), ShowHostDialog(), ShowInputDialog(), and ShowOutputDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ShowHostDialog()

void DeviceToolBar::ShowHostDialog ( )

Definition at line 706 of file DeviceToolBar.cpp.

{
   ShowComboDialog(mHost, XO("Select Audio Host"));
}

References mHost, ShowComboDialog(), and XO().

Here is the call graph for this function:

◆ ShowInputDialog()

void DeviceToolBar::ShowInputDialog ( )

Definition at line 698 of file DeviceToolBar.cpp.

{
   ShowComboDialog(mInput, XO("Select Recording Device"));
}

References mInput, ShowComboDialog(), and XO().

Here is the call graph for this function:

◆ ShownByDefault()

bool DeviceToolBar::ShownByDefault ( ) const

overridevirtual

Whether the toolbar should be shown by default. Default implementation returns true.

Reimplemented from ToolBar.

Definition at line 90 of file DeviceToolBar.cpp.

{
   return false;
}

◆ ShowOutputDialog()

void DeviceToolBar::ShowOutputDialog ( )

Definition at line 702 of file DeviceToolBar.cpp.

{
   ShowComboDialog(mOutput, XO("Select Playback Device"));
}

References mOutput, ShowComboDialog(), and XO().

Here is the call graph for this function:

◆ UpdatePrefs()

void DeviceToolBar::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 248 of file DeviceToolBar.cpp.

{
   wxString desc;
   const std::vector<DeviceSourceMap> &inMaps  = DeviceManager::Instance()->GetInputDeviceMaps();
   const std::vector<DeviceSourceMap> &outMaps = DeviceManager::Instance()->GetOutputDeviceMaps();
 
 
   int hostSelectionIndex = mHost->GetSelection();
   wxString oldHost = hostSelectionIndex >= 0 ? mHost->GetString(hostSelectionIndex) :
                                                wxString{};
   auto hostName = AudioIOHost.Read();
 
   // if the prefs host name doesn't match the one displayed, it changed
   // in another project's DeviceToolBar, 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;
 
   if (mInput->GetStringSelection() != desc &&
       mInput->FindString(desc) != wxNOT_FOUND) {
      mInput->SetStringSelection(desc);
      FillInputChannels();
   } else if (mInput->GetStringSelection() != desc && mInput->GetCount()) {
      for (size_t i = 0; i < inMaps.size(); i++) {
         if (inMaps[i].hostString == hostName &&
             MakeDeviceSourceString(&inMaps[i]) == mInput->GetString(0)) {
            // 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->SetStringSelection(MakeDeviceSourceString(defaultMap));
               SetDevices(defaultMap, NULL);
            } else {
               //use the first item (0th index) if we have no familiar devices
               mInput->SetSelection(0);
               SetDevices(&inMaps[i], NULL);
            }
            break;
         }
      }
   }
 
   devName = AudioIOPlaybackDevice.Read();
   sourceName = AudioIOPlaybackSource.Read();
   if (sourceName.empty())
      desc = devName;
   else
      desc = devName + wxT(": ") + sourceName;
 
   if (mOutput->GetStringSelection() != desc &&
       mOutput->FindString(desc) != wxNOT_FOUND) {
      mOutput->SetStringSelection(desc);
   } else if (mOutput->GetStringSelection() != desc &&
              mOutput->GetCount()) {
      for (size_t i = 0; i < outMaps.size(); i++) {
         if (outMaps[i].hostString == hostName &&
             MakeDeviceSourceString(&outMaps[i]) == mOutput->GetString(0)) {
            // use the default.  It should exist but check just in case, falling back on the 0 index.
            DeviceSourceMap *defaultMap = DeviceManager::Instance()->GetDefaultOutputDevice(outMaps[i].hostIndex);
            if (defaultMap) {
               mOutput->SetStringSelection(MakeDeviceSourceString(defaultMap));
               SetDevices(NULL, defaultMap);
            } else {
               //use the first item (0th index) if we have no familiar devices
               mOutput->SetSelection(0);
               SetDevices(NULL, &outMaps[i]);
            }
            break;
         }
      }
   }
 
   long oldChannels;
   oldChannels = mInputChannels->GetSelection() + 1;
   auto newChannels = AudioIORecordChannels.ReadWithDefault(0);
   if (newChannels > 0 && oldChannels != newChannels)
      mInputChannels->SetSelection(newChannels - 1);
 
   if (!hostName.empty() && mHost->GetStringSelection() != hostName)
      mHost->SetStringSelection(hostName);
 
   RegenerateTooltips();
 
   // Set label to pull in language change
   SetLabel(XO("Device"));
 
   // Give base class a chance
   ToolBar::UpdatePrefs();
 
   Layout();
   Refresh();
}

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

Referenced by RefillCombos(), and UpdateSelectedPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateSelectedPrefs()

void DeviceToolBar::UpdateSelectedPrefs ( int id )

overridevirtual

Reimplemented from PrefsListener.

Definition at line 346 of file DeviceToolBar.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

◆ mHost

wxChoice* DeviceToolBar::mHost

private

Definition at line 82 of file DeviceToolBar.h.

Referenced by ChangeHost(), DeinitChildren(), EnableDisableButtons(), FillHostDevices(), FillHosts(), OnChoice(), Populate(), RegenerateTooltips(), SetNames(), ShowHostDialog(), and UpdatePrefs().

◆ mInput

wxChoice* DeviceToolBar::mInput

private

Definition at line 79 of file DeviceToolBar.h.

Referenced by ChangeDevice(), DeinitChildren(), EnableDisableButtons(), FillHostDevices(), OnCaptureKey(), OnChoice(), Populate(), RegenerateTooltips(), SetNames(), ShowInputDialog(), and UpdatePrefs().

◆ mInputChannels

wxChoice* DeviceToolBar::mInputChannels

private

Definition at line 81 of file DeviceToolBar.h.

Referenced by DeinitChildren(), EnableDisableButtons(), FillInputChannels(), OnChoice(), Populate(), RegenerateTooltips(), SetNames(), ShowChannelsDialog(), and UpdatePrefs().

◆ mOutput

wxChoice* DeviceToolBar::mOutput

private

Definition at line 80 of file DeviceToolBar.h.

Referenced by ChangeDevice(), DeinitChildren(), EnableDisableButtons(), FillHostDevices(), OnCaptureKey(), OnChoice(), Populate(), RegenerateTooltips(), SetNames(), ShowOutputDialog(), and UpdatePrefs().

◆ mSubscription

Observer::Subscription DeviceToolBar::mSubscription

private

Definition at line 84 of file DeviceToolBar.h.

Referenced by DeviceToolBar().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DeviceToolBar()

◆ ~DeviceToolBar()

Member Function Documentation

◆ ChangeDevice()

◆ ChangeHost()

◆ Create()

◆ DeinitChildren()

◆ EnableDisableButtons()

◆ FillHostDevices()

◆ FillHosts()

◆ FillInputChannels()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetInitialWidth()

◆ GetMinToolbarWidth()

◆ ID()

◆ OnCaptureKey()

◆ OnChoice()

◆ OnFocus()

◆ OnRescannedDevices()

◆ Populate()

◆ RefillCombos()

◆ RegenerateTooltips()

◆ Repaint()

◆ SetDevices()

◆ SetNames()

◆ ShowChannelsDialog()

◆ ShowComboDialog()

◆ ShowHostDialog()

◆ ShowInputDialog()

◆ ShownByDefault()

◆ ShowOutputDialog()

◆ UpdatePrefs()

◆ UpdateSelectedPrefs()

Member Data Documentation

◆ mHost

◆ mInput

◆ mInputChannels

◆ mOutput

◆ mSubscription