MidiIOPrefs Class Reference

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

#include <MidiIOPrefs.h>

Inheritance diagram for MidiIOPrefs:

Collaboration diagram for MidiIOPrefs:

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

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

Private Attributes
TranslatableStrings	mHostNames
wxArrayStringEx	mHostLabels
wxString	mPlayDevice
wxChoice *	mHost
wxChoice *	mPlay
wxTextCtrl *	mLatency

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

Detailed Description

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

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

Also lets user decide whether or not to record in stereo, and whether or not to play other tracks while recording one (duplex).

Definition at line 25 of file MidiIOPrefs.h.

Constructor & Destructor Documentation

MidiIOPrefs()

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

Definition at line 53 of file MidiIOPrefs.cpp.

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

~MidiIOPrefs()

MidiIOPrefs::~MidiIOPrefs ( )

virtual

Definition at line 60 of file MidiIOPrefs.cpp.

{
}

Member Function Documentation

Commit()

bool MidiIOPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 259 of file MidiIOPrefs.cpp.

{
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
 
   const PmDeviceInfo *info;
 
   info = (const PmDeviceInfo *) mPlay->GetClientData(mPlay->GetSelection());
   if (info) {
      MIDIPlaybackDevice.Write(
         wxString::Format(wxT("%s: %s"),
            wxString(wxSafeConvertMB2WX(info->interf)),
            wxString(wxSafeConvertMB2WX(info->name))));
   }
#ifdef EXPERIMENTAL_MIDI_IN
   info = (const PmDeviceInfo *) mRecord->GetClientData(mRecord->GetSelection());
   if (info) {
      MidiRecordingDevice.Write(
         wxString::Format(wxT("%s: %s"),
            wxString(wxSafeConvertMB2WX(info->interf)),
            wxString(wxSafeConvertMB2WX(info->name))));
   }
#endif
   MIDISynthLatency_ms.Invalidate();
   return gPrefs->Flush();
}

References eIsSavingToPrefs, audacity::BasicSettings::Flush(), gPrefs, Setting< T >::Invalidate(), MIDIPlaybackDevice, MIDISynthLatency_ms, mPlay, PopulateOrExchange(), S, Setting< T >::Write(), and wxT().

Here is the call graph for this function:

GetDescription()

TranslatableString MidiIOPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 69 of file MidiIOPrefs.cpp.

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

References XO().

Here is the call graph for this function:

GetNamesAndLabels()

void MidiIOPrefs::GetNamesAndLabels ( )

private

Gets the lists of names and lists of labels which are used in the choice controls. The names are what the user sees in the wxChoice. The corresponding labels are what gets stored.

Definition at line 107 of file MidiIOPrefs.cpp.

                                    {
   // Gather list of hosts.  Only added hosts that have devices attached.
   Pm_Terminate(); // close and open to refresh device lists
   Pm_Initialize();
   int nDevices = Pm_CountDevices();
   for (int i = 0; i < nDevices; i++) {
      const PmDeviceInfo *info = Pm_GetDeviceInfo(i);
      if (info->output || info->input) { //should always happen
         wxString name = wxSafeConvertMB2WX(info->interf);
         if (!make_iterator_range(mHostNames)
            .contains( Verbatim( name ) )) {
            mHostNames.push_back( Verbatim( name ) );
            mHostLabels.push_back(name);
         }
      }
   }
 
   if (nDevices == 0) {
      mHostNames.push_back(XO("No MIDI interfaces"));
      mHostLabels.push_back(wxT("No MIDI interfaces"));
   }
}

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

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSymbol()

ComponentInterfaceSymbol MidiIOPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 64 of file MidiIOPrefs.cpp.

{
   return MIDI_IO_PREFS_PLUGIN_SYMBOL;
}

References MIDI_IO_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID MidiIOPrefs::HelpPageName ( )

overridevirtual

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

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 74 of file MidiIOPrefs.cpp.

{
   return "MIDI_Devices_Preferences";
}

OnHost()

void MidiIOPrefs::OnHost ( wxCommandEvent &  e )

private

Definition at line 191 of file MidiIOPrefs.cpp.

{
   wxString itemAtIndex;
   int index = mHost->GetCurrentSelection();
   if (index >= 0 && index < (int)mHostNames.size())
      itemAtIndex = mHostLabels[index];
   int nDevices = Pm_CountDevices();
 
   mPlay->Clear();
#ifdef EXPERIMENTAL_MIDI_IN
   mRecord->Clear();
#endif
 
   wxArrayStringEx playnames;
   wxArrayStringEx recordnames;
 
   for (int i = 0; i < nDevices; i++) {
      const PmDeviceInfo *info = Pm_GetDeviceInfo(i);
      wxString interf = wxSafeConvertMB2WX(info->interf);
      if (itemAtIndex == interf) {
         wxString name = wxSafeConvertMB2WX(info->name);
         wxString device = wxString::Format(wxT("%s: %s"),
                                            interf,
                                            name);
         if (info->output) {
            playnames.push_back(name);
            index = mPlay->Append(name, (void *) info);
            if (device == mPlayDevice) {
               mPlay->SetSelection(index);
            }
         }
#ifdef EXPERIMENTAL_MIDI_IN
         if (info->input) {
            recordnames.push_back(name);
            index = mRecord->Append(name, (void *) info);
            if (device == mRecordDevice) {
               mRecord->SetSelection(index);
            }
         }
#endif
      }
   }
 
   if (mPlay->GetCount() == 0) {
      playnames.push_back(_("No devices found"));
      mPlay->Append(playnames[0], (void *) NULL);
   }
#ifdef EXPERIMENTAL_MIDI_IN
   if (mRecord->GetCount() == 0) {
      recordnames.push_back(_("No devices found"));
      mRecord->Append(recordnames[0], (void *) NULL);
   }
#endif
   if (mPlay->GetCount() && mPlay->GetSelection() == wxNOT_FOUND) {
      mPlay->SetSelection(0);
   }
#ifdef EXPERIMENTAL_MIDI_IN
   if (mRecord->GetCount() && mRecord->GetSelection() == wxNOT_FOUND) {
      mRecord->SetSelection(0);
   }
#endif
   ShuttleGui::SetMinSize(mPlay, playnames);
#ifdef EXPERIMENTAL_MIDI_IN
   ShuttleGui::SetMinSize(mRecord, recordnames);
#endif
//   OnDevice(e);
}

References _, mHost, mHostLabels, mHostNames, mPlay, mPlayDevice, name, ShuttleGui::SetMinSize(), and wxT().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

Populate()

void MidiIOPrefs::Populate ( )

private

Definition at line 79 of file MidiIOPrefs.cpp.

{
   // First any pre-processing for constructing the GUI.
   GetNamesAndLabels();
 
   // Get current setting for devices
   mPlayDevice = MIDIPlaybackDevice.Read();
#ifdef EXPERIMENTAL_MIDI_IN
   mRecordDevice = MIDIRecordingDevice.Read();
#endif
//   mRecordChannels = gPrefs->Read(wxT("/MidiIO/RecordChannels"), 2L);
 
   //------------------------- Main section --------------------
   // Now construct the GUI itself.
   // Use 'eIsCreatingFromPrefs' so that the GUI is
   // initialised with values from gPrefs.
   ShuttleGui S(this, eIsCreatingFromPrefs);
   PopulateOrExchange(S);
   // ----------------------- End of main section --------------
 
   wxCommandEvent e;
   OnHost(e);
}

References eIsCreatingFromPrefs, GetNamesAndLabels(), MIDIPlaybackDevice, MIDIRecordingDevice, mPlayDevice, OnHost(), PopulateOrExchange(), Setting< T >::Read(), and S.

Here is the call graph for this function:

PopulateOrExchange()

void MidiIOPrefs::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 130 of file MidiIOPrefs.cpp.

{
   ChoiceSetting Setting{ L"/MidiIO/Host",
      { ByColumns, mHostNames, mHostLabels }
   };
 
   S.SetBorder(2);
   S.StartScroller();
 
   /* i18n-hint Software interface to MIDI */
   S.StartStatic(XC("Interface", "MIDI"));
   {
      S.StartMultiColumn(2);
      {
         S.Id(HostID);
         /* i18n-hint: (noun) */
         mHost = S.TieChoice(XXO("&Host:"), Setting);
 
         S.AddPrompt(XXO("Using: PortMidi"));
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
   S.StartStatic(XO("Playback"));
   {
      S.StartMultiColumn(2);
      {
         S.Id(PlayID);
         mPlay = S.AddChoice(XXO("&Device:"),
                             {} );
         mLatency = S.TieIntegerTextBox(XXO("MIDI Synth L&atency (ms):"),
                                        MIDISynthLatency_ms, 3);
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
#ifdef EXPERIMENTAL_MIDI_IN
   S.StartStatic(XO("Recording"));
   {
      S.StartMultiColumn(2);
      {
         S.Id(RecordID);
         mRecord = S.AddChoice(XO("De&vice:"),
                               {} );
 
         S.Id(ChannelsID);
         /*
         mChannels = S.AddChoice(XO("&Channels:"),
                                 wxEmptyString,
                                 {} );
         */
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
#endif
   S.EndScroller();
 
}

References ByColumns, ChannelsID, HostID, mHost, mHostLabels, mHostNames, MIDISynthLatency_ms, mLatency, mPlay, PlayID, RecordID, S, XC, XO(), and XXO().

Referenced by Commit(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

Validate()

bool MidiIOPrefs::Validate ( )

override

Definition at line 286 of file MidiIOPrefs.cpp.

{
   long latency;
   if (!mLatency->GetValue().ToLong(&latency)) {
      AudacityMessageBox( XO(
"The MIDI Synthesizer Latency must be an integer") );
      return false;
   }
   return true;
}

References AudacityMessageBox(), mLatency, and XO().

Here is the call graph for this function:

Member Data Documentation

mHost

wxChoice* MidiIOPrefs::mHost

private

Definition at line 54 of file MidiIOPrefs.h.

Referenced by OnHost(), and PopulateOrExchange().

mHostLabels

wxArrayStringEx MidiIOPrefs::mHostLabels

private

Definition at line 46 of file MidiIOPrefs.h.

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

mHostNames

TranslatableStrings MidiIOPrefs::mHostNames

private

Definition at line 45 of file MidiIOPrefs.h.

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

mLatency

wxTextCtrl* MidiIOPrefs::mLatency

private

Definition at line 56 of file MidiIOPrefs.h.

Referenced by PopulateOrExchange(), and Validate().

mPlay

wxChoice* MidiIOPrefs::mPlay

private

Definition at line 55 of file MidiIOPrefs.h.

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

mPlayDevice

wxString MidiIOPrefs::mPlayDevice

private

Definition at line 48 of file MidiIOPrefs.h.

Referenced by OnHost(), and Populate().

---

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

• MidiIOPrefs.h
• MidiIOPrefs.cpp