NyquistEffect Class Reference

An Effect that calls up a Nyquist (XLISP) plug-in, i.e. many possible effects from this one class. More...

#include <Nyquist.h>

Inheritance diagram for NyquistEffect:

Collaboration diagram for NyquistEffect:

Classes
struct	Tokenizer

Public Member Functions
	NyquistEffect (const wxString &fName)
virtual	~NyquistEffect ()
PluginPath	GetPath () const override
ComponentInterfaceSymbol	GetSymbol () const override
VendorSymbol	GetVendor () const override
wxString	GetVersion () const override
TranslatableString	GetDescription () const override
ManualPageID	ManualPage () const override
	Name of a page in the Audacity alpha manual, default is empty. More...
FilePath	HelpPage () const override
	Fully qualified local help file name, default is empty. More...
EffectType	GetType () const override
	Type determines how it behaves. More...
EffectType	GetClassification () const override
	Determines which menu it appears in; default same as GetType(). More...
EffectFamilySymbol	GetFamily () const override
	Report identifier and user-visible name of the effect protocol. More...
bool	IsInteractive () const override
	Whether the effect needs a dialog for entry of settings. More...
bool	IsDefault () const override
	Whether the effect sorts "above the line" in the menus. More...
bool	EnablesDebug () const override
	Whether the effect dialog should have a Debug button; default, always false. More...
bool	SaveSettings (const EffectSettings &settings, CommandParameters &parms) const override
	Store settings as keys and values. More...
bool	LoadSettings (const CommandParameters &parms, EffectSettings &settings) const override
	Restore settings from keys and values. More...
bool	DoLoadSettings (const CommandParameters &parms, EffectSettings &settings)
bool	VisitSettings (SettingsVisitor &visitor, EffectSettings &settings) override
bool	VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const override
int	SetLispVarsFromParameters (const CommandParameters &parms, bool bTestOnly)
bool	Init () override
bool	Process (EffectInstance &instance, EffectSettings &settings) override
int	ShowHostInterface (EffectPlugin &plugin, wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false) override
std::unique_ptr< EffectEditor >	PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) override
	Add controls to effect panel; always succeeds. More...
bool	TransferDataToWindow (const EffectSettings &settings) override
bool	TransferDataFromWindow (EffectSettings &settings) override
void	RedirectOutput ()
void	SetCommand (const wxString &cmd)
void	Continue ()
void	Break ()
void	Stop ()
Public Member Functions inherited from EffectWithSettings< NyquistSettings, StatefulEffect >
EffectSettings	MakeSettings () const override
bool	CopySettingsContents (const EffectSettings &src, EffectSettings &dst) const override
Public Member Functions inherited from StatefulEffect
	~StatefulEffect () override
std::shared_ptr< EffectInstance >	MakeInstance () const override
	Make an object maintaining short-term state of an Effect. More...
Public Member Functions inherited from StatefulEffectBase
virtual bool	Init ()
virtual bool	Process (EffectInstance &instance, EffectSettings &settings)=0
virtual bool	RealtimeInitialize (EffectSettings &settings, double sampleRate)
virtual bool	RealtimeAddProcessor (EffectSettings &settings, EffectOutputs *pOutputs, unsigned numChannels, float sampleRate)
virtual bool	RealtimeSuspend ()
virtual bool	RealtimeResume ()
virtual bool	RealtimeProcessStart (MessagePackage &package)
	settings are possibly changed, since last call, by an asynchronous dialog More...
virtual size_t	RealtimeProcess (size_t group, EffectSettings &settings, const float *const *inBuf, float *const *outBuf, size_t numSamples)
virtual bool	RealtimeProcessEnd (EffectSettings &settings) noexcept
	settings can be updated to let a dialog change appearance at idle More...
virtual bool	RealtimeFinalize (EffectSettings &settings) noexcept
virtual size_t	SetBlockSize (size_t maxBlockSize)
virtual size_t	GetBlockSize () const
virtual unsigned	GetAudioInCount () const
	How many input buffers to allocate at once. More...
virtual unsigned	GetAudioOutCount () const
	How many output buffers to allocate at once. More...
virtual sampleCount	GetLatency () const
virtual bool	NeedsDither () const
virtual bool	ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap=nullptr)
virtual bool	ProcessFinalize () noexcept
Public Member Functions inherited from Effect
	Effect ()
virtual	~Effect ()
PluginPath	GetPath () const override
bool	VisitSettings (SettingsVisitor &visitor, EffectSettings &settings) override
bool	VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const override
ComponentInterfaceSymbol	GetSymbol () const override
VendorSymbol	GetVendor () const override
wxString	GetVersion () const override
TranslatableString	GetDescription () const override
EffectType	GetType () const override
	Type determines how it behaves. More...
EffectFamilySymbol	GetFamily () const override
	Report identifier and user-visible name of the effect protocol. More...
bool	IsInteractive () const override
	Whether the effect needs a dialog for entry of settings. More...
bool	IsDefault () const override
	Whether the effect sorts "above the line" in the menus. More...
RealtimeSince	RealtimeSupport () const override
	Since which version of Audacity has the effect supported realtime? More...
bool	SupportsAutomation () const override
	Whether the effect has any automatable controls. More...
bool	SaveSettings (const EffectSettings &settings, CommandParameters &parms) const override
	Store settings as keys and values. More...
bool	LoadSettings (const CommandParameters &parms, EffectSettings &settings) const override
	Restore settings from keys and values. More...
OptionalMessage	LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override
bool	SaveUserPreset (const RegistryPath &name, const EffectSettings &settings) const override
	Save settings in the configuration file as a user-named preset. More...
RegistryPaths	GetFactoryPresets () const override
	Report names of factory presets. More...
OptionalMessage	LoadFactoryPreset (int id, EffectSettings &settings) const override
OptionalMessage	LoadFactoryDefaults (EffectSettings &settings) const override
virtual const EffectParameterMethods &	Parameters () const
bool	CanExportPresets () const override
	Whether the effect supports export of presets to files, and importing too. More...
bool	HasOptions () const override
const EffectSettingsManager &	GetDefinition () const override
virtual NumericFormatSymbol	GetSelectionFormat ()
bool	SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const override
OptionalMessage	LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const override
bool	IsBatchProcessing () const override
void	SetBatchProcessing () override
void	UnsetBatchProcessing () override
unsigned	TestUIFlags (unsigned mask)
bool	Delegate (Effect &delegate, EffectSettings &settings)
	Re-invoke DoEffect on another Effect object that implements the work. More...
Public Member Functions inherited from EffectBase
	EffectBase ()
	~EffectBase () override
void	SetTracks (TrackList *pTracks)
bool	DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess) override
Public Member Functions inherited from EffectPlugin
EffectPlugin &	operator= (EffectPlugin &)=delete
virtual	~EffectPlugin ()
virtual bool	HasOptions () const =0
virtual bool	CanExportPresets () const =0
	Whether the effect supports export of presets to files, and importing too. More...
virtual const EffectSettingsManager &	GetDefinition () const =0
virtual void	Preview (EffectSettingsAccess &access, std::function< void()> updateUI, bool dryOnly)=0
	Calculate temporary tracks of limited length with effect applied and play. More...
virtual bool	SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const =0
virtual OptionalMessage	LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const =0
virtual bool	IsBatchProcessing () const =0
virtual void	SetBatchProcessing ()=0
virtual void	UnsetBatchProcessing ()=0
virtual bool	DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess=nullptr)=0
Public Member Functions inherited from EffectInstanceFactory
virtual	~EffectInstanceFactory ()
virtual std::shared_ptr< EffectInstance >	MakeInstance () const =0
	Make an object maintaining short-term state of an Effect. More...
Public Member Functions inherited from EffectSettingsManager
virtual	~EffectSettingsManager ()
virtual bool	VisitSettings (SettingsVisitor &visitor, EffectSettings &settings)
virtual bool	VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const
virtual std::unique_ptr< EffectOutputs >	MakeOutputs () const
	Produce an object to hold values to send to effect output meters. More...
Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()
virtual EffectType	GetType () const =0
	Type determines how it behaves. More...
virtual EffectType	GetClassification () const
	Determines which menu it appears in; default same as GetType(). More...
virtual EffectFamilySymbol	GetFamily () const =0
	Report identifier and user-visible name of the effect protocol. More...
virtual bool	IsInteractive () const =0
	Whether the effect needs a dialog for entry of settings. More...
virtual bool	IsDefault () const =0
	Whether the effect sorts "above the line" in the menus. More...
virtual RealtimeSince	RealtimeSupport () const =0
	Since which version of Audacity has the effect supported realtime? More...
bool	SupportsRealtime () const
virtual bool	SupportsAutomation () const =0
	Whether the effect has any automatable controls. More...
virtual bool	EnablesDebug () const
	Whether the effect dialog should have a Debug button; default, always false. More...
virtual ManualPageID	ManualPage () const
	Name of a page in the Audacity alpha manual, default is empty. More...
virtual FilePath	HelpPage () const
	Fully qualified local help file name, default is empty. More...
virtual bool	IsHiddenFromMenus () const
	Default is false. More...
Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()
virtual PluginPath	GetPath () const =0
virtual ComponentInterfaceSymbol	GetSymbol () const =0
virtual VendorSymbol	GetVendor () const =0
virtual wxString	GetVersion () const =0
virtual TranslatableString	GetDescription () const =0
TranslatableString	GetName () const
Public Member Functions inherited from StatefulEffectUIServices
	~StatefulEffectUIServices () override
std::unique_ptr< EffectEditor >	PopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const override
	Allows PopulateOrExchange to return null. More...
virtual std::unique_ptr< EffectEditor >	PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs)
	Add controls to effect panel; always succeeds. More...
virtual bool	TransferDataToWindow (const EffectSettings &settings)
virtual bool	TransferDataFromWindow (EffectSettings &settings)
Public Member Functions inherited from BasicEffectUIServices
int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal) const override
void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const override
OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const override
void	ShowOptions (const EffectPlugin &plugin) const override
bool	ValidateUI (const EffectPlugin &context, EffectSettings &) const override
bool	CloseUI () const override
Public Member Functions inherited from EffectUIServices
virtual	~EffectUIServices ()
virtual int	ShowHostInterface (EffectPlugin &plugin, wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false)
virtual int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal=false) const =0
virtual std::unique_ptr< EffectEditor >	PopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const =0
	Adds controls to a panel that is given as the parent window of S More...
virtual void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const =0
virtual OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const =0
virtual void	ShowOptions (const EffectPlugin &plugin) const =0
virtual bool	ValidateUI (const EffectPlugin &context, EffectSettings &settings) const =0
virtual bool	CloseUI () const =0

Private Types
using	Buffer = std::unique_ptr< float[]>

Private Member Functions
bool	ProcessOne ()
void	BuildPromptWindow (ShuttleGui &S)
void	BuildEffectWindow (ShuttleGui &S)
bool	TransferDataToPromptWindow ()
bool	TransferDataToEffectWindow ()
bool	TransferDataFromPromptWindow ()
bool	TransferDataFromEffectWindow ()
bool	IsOk ()
const TranslatableString &	InitializationError () const
wxString	EscapeString (const wxString &inStr)
FileExtensions	ParseFileExtensions (const wxString &text)
FileNames::FileType	ParseFileType (const wxString &text)
FileNames::FileTypes	ParseFileTypes (const wxString &text)
int	GetCallback (float *buffer, int channel, int64_t start, int64_t len, int64_t totlen)
int	PutCallback (float *buffer, int channel, int64_t start, int64_t len, int64_t totlen)
void	OutputCallback (int c)
void	OSCallback ()
void	ParseFile ()
bool	ParseCommand (const wxString &cmd)
bool	ParseProgram (wxInputStream &stream)
bool	Parse (Tokenizer &tokenizer, const wxString &line, bool eof, bool first)
void	OnLoad (wxCommandEvent &evt)
void	OnSave (wxCommandEvent &evt)
void	OnDebug (wxCommandEvent &evt)
void	OnText (wxCommandEvent &evt)
void	OnSlider (wxCommandEvent &evt)
void	OnChoice (wxCommandEvent &evt)
void	OnTime (wxCommandEvent &evt)
void	OnFileButton (wxCommandEvent &evt)
bool	validatePath (wxString path)
wxString	ToTimeFormat (double t)
std::pair< bool, FilePath >	CheckHelpPage () const

Static Private Member Functions
static FilePaths	GetNyquistSearchPath ()
static wxString	NyquistToWxString (const char *nyqString)
static std::vector< EnumValueSymbol >	ParseChoice (const wxString &text)
static int	StaticGetCallback (float *buffer, int channel, int64_t start, int64_t len, int64_t totlen, void *userdata)
static int	StaticPutCallback (float *buffer, int channel, int64_t start, int64_t len, int64_t totlen, void *userdata)
static void	StaticOutputCallback (int c, void *userdata)
static void	StaticOSCallback (void *userdata)
static TranslatableString	UnQuoteMsgid (const wxString &s, bool allowParens=true, wxString *pExtraString=nullptr)
static wxString	UnQuote (const wxString &s, bool allowParens=true, wxString *pExtraString=nullptr)
static double	GetCtrlValue (const wxString &s)
static void	resolveFilePath (wxString &path, FileExtension extension={})

Private Attributes
wxWeakRef< wxWindow >	mUIParent {}
wxString	mXlispPath
wxFileName	mFileName
	Name of the Nyquist script file this effect is loaded from. More...
wxDateTime	mFileModified
	When the script was last modified on disk. More...
bool	mStop
bool	mBreak
bool	mCont
bool	mFoundType
bool	mCompiler
bool	mTrace
bool	mIsSal
bool	mExternal
bool	mIsSpectral
bool	mIsTool
const bool	mIsPrompt
bool	mOK
TranslatableString	mInitError
wxString	mInputCmd
wxString	mParameters
wxString	mCmd
TranslatableString	mName
	Name of the Effect (untranslated) More...
TranslatableString	mPromptName
TranslatableString	mAction
TranslatableString	mInfo
TranslatableString	mAuthor
TranslatableString	mReleaseVersion
TranslatableString	mCopyright
wxString	mManPage
wxString	mHelpFile
bool	mHelpFileExists
FilePath	mHelpPage
EffectType	mType
EffectType	mPromptType
bool	mEnablePreview
bool	mDebugButton
bool	mDebug
bool	mRedirectOutput
bool	mProjectChanged
wxString	mDebugOutputStr
TranslatableString	mDebugOutput
int	mVersion
std::vector< NyqControl >	mControls
unsigned	mCurNumChannels
WaveTrack *	mCurTrack [2]
sampleCount	mCurStart [2]
sampleCount	mCurLen
sampleCount	mMaxLen
int	mTrackIndex
bool	mFirstInGroup
double	mOutputTime
unsigned	mCount
unsigned	mNumSelectedChannels
double	mProgressIn
double	mProgressOut
double	mProgressTot
double	mScale
Buffer	mCurBuffer [2]
sampleCount	mCurBufferStart [2]
size_t	mCurBufferLen [2]
WaveTrack *	mOutputTrack [2]
wxArrayString	mCategories
wxString	mProps
wxString	mPerTrackProps
bool	mRestoreSplits
int	mMergeClips
wxTextCtrl *	mCommandText
std::exception_ptr	mpException {}

Static Private Attributes
static int	mReentryCount = 0

Friends
class	NyquistEffectsModule

Additional Inherited Members
Public Types inherited from StatefulEffectBase
using	MessagePackage = EffectInstance::MessagePackage
Public Types inherited from EffectPlugin
using	EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess >
using	InstancePointer = std::shared_ptr< EffectInstanceEx >
using	InstanceFinder = std::function< std::optional< InstancePointer >(EffectSettings &settings) >
Public Types inherited from EffectDefinitionInterface
enum class	RealtimeSince : unsigned { Never , After_3_1 , Always }
	In which versions of Audacity was an effect realtime capable? More...
Public Types inherited from EffectUIServices
enum	: long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
Static Public Member Functions inherited from EffectWithSettings< NyquistSettings, StatefulEffect >
static NyquistSettings &	GetSettings (EffectSettings &settings)
	Assume settings originated from MakeSettings() and copies thereof. More...
static const NyquistSettings &	GetSettings (const EffectSettings &settings)
	Assume settings originated from MakeSettings() and copies thereof. More...
static NyquistSettings *	FetchParameters (StatefulEffect &, EffectSettings &s)
Static Public Member Functions inherited from Effect
static Effect *	FetchParameters (Effect &e, EffectSettings &)
static void	IncEffectCounter ()
Static Public Member Functions inherited from EffectDefinitionInterface
static Identifier	GetSquashedName (const Identifier &ident)
	A utility that strips spaces and CamelCases a name. More...
Static Public Member Functions inherited from EffectUIServices
static int	DoMessageBox (const EffectPlugin &plugin, const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})
Public Attributes inherited from EffectBase
TrackList *	mTracks {}
Static Public Attributes inherited from EffectPlugin
static const wxString	kUserPresetIdent = wxT("User Preset:")
static const wxString	kFactoryPresetIdent = wxT("Factory Preset:")
static const wxString	kCurrentSettingsIdent = wxT("<Current Settings>")
static const wxString	kFactoryDefaultsIdent = wxT("<Factory Defaults>")
Protected Member Functions inherited from Effect
bool	CheckWhetherSkipEffect (const EffectSettings &settings) const override
	Default implementation returns false. More...
double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const override
	Default implementation returns previewLength More...
bool	TotalProgress (double frac, const TranslatableString &={}) const
bool	TrackProgress (int whichTrack, double frac, const TranslatableString &={}) const
bool	TrackGroupProgress (int whichGroup, double frac, const TranslatableString &={}) const
int	GetNumWaveTracks () const
int	GetNumWaveGroups () const
void	GetBounds (const WaveTrack &track, const WaveTrack *pRight, sampleCount *start, sampleCount *len)
void	CopyInputTracks (bool allSyncLockSelected=false)
Track *	AddToOutputTracks (const std::shared_ptr< Track > &t)
Protected Member Functions inherited from EffectBase
virtual std::any	BeginPreview (const EffectSettings &settings)
	Called when Preview() starts, to allow temporary effect state changes. More...
void	Preview (EffectSettingsAccess &access, std::function< void()> updateUI, bool dryOnly) final
	Calculate temporary tracks of limited length with effect applied and play. More...
virtual bool	CheckWhetherSkipEffect (const EffectSettings &settings) const =0
	After Init(), tell whether Process() should be skipped. More...
virtual double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const =0
void	SetLinearEffectFlag (bool linearEffectFlag)
void	SetPreviewFullSelectionFlag (bool previewDurationFlag)
bool	IsPreviewing () const
void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)
void	ReplaceProcessedTracks (const bool bGoodResult)
const TrackList *	inputTracks () const
const AudacityProject *	FindProject () const
Protected Attributes inherited from EffectBase
BasicUI::ProgressDialog *	mProgress {}
double	mProjectRate {}
WaveTrackFactory *	mFactory {}
std::shared_ptr< TrackList >	mOutputTracks
double	mT0 {}
double	mT1 {}
wxArrayString	mPresetNames
unsigned	mUIFlags { 0 }
Static Protected Attributes inherited from EffectBase
static int	nEffectsDone = 0

Detailed Description

An Effect that calls up a Nyquist (XLISP) plug-in, i.e. many possible effects from this one class.

Definition at line 74 of file Nyquist.h.

Member Typedef Documentation

Buffer

using NyquistEffect::Buffer = std::unique_ptr<float[]>

private

Definition at line 297 of file Nyquist.h.

Constructor & Destructor Documentation

NyquistEffect()

NyquistEffect::NyquistEffect

(

const wxString &

fName

)

Parameters

fName

File name of the Nyquist script defining this effect. If an empty string, then prompt the user for the Nyquist code to interpret.

~NyquistEffect()

NyquistEffect::~NyquistEffect ( )

virtual

Definition at line 201 of file Nyquist.cpp.

{
}

Member Function Documentation

Break()

void NyquistEffect::Break

(

)

Definition at line 1865 of file Nyquist.cpp.

{
   mBreak = true;
}

References mBreak.

BuildEffectWindow()

void NyquistEffect::BuildEffectWindow ( ShuttleGui &  S )

private

Definition at line 2912 of file Nyquist.cpp.

{
   wxScrolledWindow *scroller = S.Style(wxVSCROLL | wxTAB_TRAVERSAL)
      .StartScroller(2);
   {
      S.StartMultiColumn(4);
      {
         for (size_t i = 0; i < mControls.size(); i++)
         {
            NyqControl & ctrl = mControls[i];
 
            if (ctrl.type == NYQ_CTRL_TEXT)
            {
               S.EndMultiColumn();
               S.StartHorizontalLay(wxALIGN_LEFT, 0);
               {
                  S.AddSpace(0, 10);
                  S.AddFixedText( Verbatim( ctrl.label ), false );
               }
               S.EndHorizontalLay();
               S.StartMultiColumn(4);
            }
            else
            {
               auto prompt = XXO("%s:").Format( ctrl.name );
               S.AddPrompt( prompt );
 
               if (ctrl.type == NYQ_CTRL_STRING)
               {
                  S.AddSpace(10, 10);
 
                  auto item = S.Id(ID_Text + i)
                     .Validator<wxGenericValidator>(&ctrl.valStr)
                     .Name( prompt )
                     .AddTextBox( {}, wxT(""), 50);
               }
               else if (ctrl.type == NYQ_CTRL_CHOICE)
               {
                  S.AddSpace(10, 10);
 
                  S.Id(ID_Choice + i).AddChoice( {},
                     Msgids( ctrl.choices.data(), ctrl.choices.size() ) );
               }
               else if (ctrl.type == NYQ_CTRL_TIME)
               {
                  S.AddSpace(10, 10);
 
                  const auto options = NumericTextCtrl::Options{}
                                          .AutoPos(true)
                                          .MenuEnabled(true)
                                          .ReadOnly(false);
 
                  NumericTextCtrl *time = safenew
                     NumericTextCtrl(S.GetParent(), (ID_Time + i),
                                     NumericConverter::TIME,
                                     GetSelectionFormat(),
                                     ctrl.val,
                                     mProjectRate,
                                     options);
                  S
                     .Name( prompt )
                     .Position(wxALIGN_LEFT | wxALL)
                     .AddWindow(time);
               }
               else if (ctrl.type == NYQ_CTRL_FILE)
               {
                  S.AddSpace(10, 10);
 
                  // Get default file extension if specified in wildcards
                  FileExtension defaultExtension;
                  if (!ctrl.fileTypes.empty()) {
                     const auto &type = ctrl.fileTypes[0];
                     if ( !type.extensions.empty() )
                        defaultExtension = type.extensions[0];
                  }
                  resolveFilePath(ctrl.valStr, defaultExtension);
 
                  wxTextCtrl *item = S.Id(ID_Text+i)
                     .Name( prompt )
                     .AddTextBox( {}, wxT(""), 40);
                  item->SetValidator(wxGenericValidator(&ctrl.valStr));
 
                  if (ctrl.label.empty())
                     // We'd expect wxFileSelectorPromptStr to already be translated, but apparently not.
                     ctrl.label = wxGetTranslation( wxFileSelectorPromptStr );
                  S.Id(ID_FILE + i).AddButton(
                     Verbatim(ctrl.label), wxALIGN_LEFT);
               }
               else
               {
                  // Integer or Real
                  if (ctrl.type == NYQ_CTRL_INT_TEXT || ctrl.type == NYQ_CTRL_FLOAT_TEXT)
                  {
                     S.AddSpace(10, 10);
                  }
 
                  S.Id(ID_Text+i);
                  if (ctrl.type == NYQ_CTRL_FLOAT || ctrl.type == NYQ_CTRL_FLOAT_TEXT)
                  {
                     double range = ctrl.high - ctrl.low;
                     S.Validator<FloatingPointValidator<double>>(
                        // > 12 decimal places can cause rounding errors in display.
                        12, &ctrl.val,
                        // Set number of decimal places
                        (range < 10
                           ? NumValidatorStyle::THREE_TRAILING_ZEROES
                           : range < 100
                              ? NumValidatorStyle::TWO_TRAILING_ZEROES
                              : NumValidatorStyle::ONE_TRAILING_ZERO),
                        ctrl.low, ctrl.high
                     );
                  }
                  else
                  {
                     S.Validator<IntegerValidator<double>>(
                        &ctrl.val, NumValidatorStyle::DEFAULT,
                        (int) ctrl.low, (int) ctrl.high);
                  }
                  wxTextCtrl *item = S
                     .Name( prompt )
                     .AddTextBox( {}, wxT(""),
                        (ctrl.type == NYQ_CTRL_INT_TEXT ||
                         ctrl.type == NYQ_CTRL_FLOAT_TEXT) ? 25 : 12);
 
                  if (ctrl.type == NYQ_CTRL_INT || ctrl.type == NYQ_CTRL_FLOAT)
                  {
                     S.Id(ID_Slider + i)
                        .Style(wxSL_HORIZONTAL)
                        .MinSize( { 150, -1 } )
                        .AddSlider( {}, 0, ctrl.ticks, 0);
                  }
               }
 
               if (ctrl.type != NYQ_CTRL_FILE)
               {
                  if (ctrl.type == NYQ_CTRL_CHOICE || ctrl.label.empty())
                  {
                     S.AddSpace(10, 10);
                  }
                  else
                  {
                     S.AddUnits( Verbatim( ctrl.label ) );
                  }
               }
            }
         }
      }
      S.EndMultiColumn();
   }
   S.EndScroller();
 
   scroller->SetScrollRate(0, 20);
 
   // This fools NVDA into not saying "Panel" when the dialog gets focus
   scroller->SetName(wxT("\a"));
   scroller->SetLabel(wxT("\a"));
}

References NumericTextCtrl::Options::AutoPos(), NyqControl::choices, NyqControl::fileTypes, Effect::GetSelectionFormat(), NyqControl::high, ID_Choice, ID_FILE, ID_Slider, ID_Text, ID_Time, NyqControl::label, NyqControl::low, mControls, NumericTextCtrl::Options::MenuEnabled(), EffectBase::mProjectRate, Msgids(), NyqControl::name, NYQ_CTRL_CHOICE, NYQ_CTRL_FILE, NYQ_CTRL_FLOAT, NYQ_CTRL_FLOAT_TEXT, NYQ_CTRL_INT, NYQ_CTRL_INT_TEXT, NYQ_CTRL_STRING, NYQ_CTRL_TEXT, NYQ_CTRL_TIME, NumericTextCtrl::Options::ReadOnly(), resolveFilePath(), S, safenew, NyqControl::ticks, NumericConverter::TIME, NyqControl::type, NyqControl::val, NyqControl::valStr, Verbatim(), wxT(), and XXO().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

BuildPromptWindow()

void NyquistEffect::BuildPromptWindow ( ShuttleGui &  S )

private

Definition at line 2880 of file Nyquist.cpp.

{
   S.StartVerticalLay();
   {
      S.StartMultiColumn(3, wxEXPAND);
      {
         S.SetStretchyCol(1);
 
         S.AddVariableText(XO("Enter Nyquist Command: "));
 
         S.AddSpace(1, 1);
      }
      S.EndMultiColumn();
 
      S.StartHorizontalLay(wxEXPAND, 1);
      {
          mCommandText = S.Focus()
            .MinSize( { 500, 200 } )
            .AddTextWindow(wxT(""));
      }
      S.EndHorizontalLay();
 
      S.StartHorizontalLay(wxALIGN_CENTER, 0);
      {
         S.Id(ID_Load).AddButton(XXO("&Load"));
         S.Id(ID_Save).AddButton(XXO("&Save"));
      }
      S.EndHorizontalLay();
   }
   S.EndVerticalLay();
}

References ID_Load, ID_Save, mCommandText, S, wxT(), XO(), and XXO().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

CheckHelpPage()

std::pair< bool, FilePath > NyquistEffect::CheckHelpPage ( ) const

private

Definition at line 253 of file Nyquist.cpp.

{
   auto paths = NyquistEffect::GetNyquistSearchPath();
   wxString fileName;
 
   for (size_t i = 0, cnt = paths.size(); i < cnt; i++) {
      fileName = wxFileName(paths[i] + wxT("/") + mHelpFile).GetFullPath();
      if (wxFileExists(fileName))
      {
         return { true, fileName };
      }
   }
   return { false, wxEmptyString };
}

References GetNyquistSearchPath(), mHelpFile, and wxT().

Referenced by ParseProgram().

Here is the call graph for this function:

Here is the caller graph for this function:

Continue()

void NyquistEffect::Continue

(

)

Definition at line 1870 of file Nyquist.cpp.

{
   mCont = true;
}

References mCont.

DoLoadSettings()

bool NyquistEffect::DoLoadSettings	(	const CommandParameters &	parms,
		EffectSettings &	settings
	)

Definition at line 430 of file Nyquist.cpp.

{
   // Due to a constness problem that happens when using the prompt, we need
   // to be ready to switch the params to a local instance.
   const CommandParameters* pParms = &parms;
   CommandParameters localParms;
 
   if (mIsPrompt)
   {
      parms.Read(KEY_Command, &mInputCmd, wxEmptyString);
      parms.Read(KEY_Parameters, &mParameters, wxEmptyString);
 
      if (!mInputCmd.empty())
      {
         ParseCommand(mInputCmd);
      }
 
      if (!mParameters.empty())
      {
         pParms = &localParms;
         localParms.SetParameters(mParameters);
      }
 
      if (!IsBatchProcessing())
      {
         mType = EffectTypeTool;
      }
 
      mPromptType = mType;
      mIsTool = (mPromptType == EffectTypeTool);
      mExternal = true;
 
      if (!IsBatchProcessing())
      {
         return true;
      }
   }
 
   // Constants to document what the true/false values mean.
   const auto kTestOnly = true;
   const auto kTestAndSet = false;
 
   // badCount will encompass both actual bad values and missing values.
   // We probably never actually have bad values when using the dialogs
   // since the dialog validation will catch them.
   int badCount;
   // When batch processing, we just ignore missing/bad parameters.
   // We'll end up using defaults in those cases.
   if (!IsBatchProcessing()) {
      badCount = SetLispVarsFromParameters(*pParms, kTestOnly);
      if (badCount > 0)
         return false;
   }
 
   badCount = SetLispVarsFromParameters(*pParms, kTestAndSet);
   // We never do anything with badCount here.
   // It might be non zero, for missing parameters, and we allow that,
   // and don't distinguish that from an out-of-range value.
   return true;
}

References EffectTypeTool, Effect::IsBatchProcessing(), KEY_Command, KEY_Parameters, mExternal, mInputCmd, mIsPrompt, mIsTool, mParameters, mPromptType, mType, ParseCommand(), SetLispVarsFromParameters(), and CommandParameters::SetParameters().

Referenced by LoadSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

EnablesDebug()

bool NyquistEffect::EnablesDebug ( ) const

overridevirtual

Whether the effect dialog should have a Debug button; default, always false.

Reimplemented from EffectDefinitionInterface.

Definition at line 1149 of file Nyquist.cpp.

{
   return mDebugButton;
}

References mDebugButton.

EscapeString()

wxString NyquistEffect::EscapeString ( const wxString &  inStr )

private

Definition at line 1743 of file Nyquist.cpp.

{
   wxString str = inStr;
 
   str.Replace(wxT("\\"), wxT("\\\\"));
   str.Replace(wxT("\""), wxT("\\\""));
 
   return str;
}

References str, and wxT().

Referenced by Process(), and ProcessOne().

Here is the call graph for this function:

Here is the caller graph for this function:

GetCallback()

int NyquistEffect::GetCallback ( float *  buffer, int  channel, int64_t  start, int64_t  len, int64_t  totlen  )

private

Definition at line 2520 of file Nyquist.cpp.

{
   if (mCurBuffer[ch]) {
      if ((mCurStart[ch] + start) < mCurBufferStart[ch] ||
          (mCurStart[ch] + start)+len >
          mCurBufferStart[ch]+mCurBufferLen[ch]) {
         mCurBuffer[ch].reset();
      }
   }
 
   if (!mCurBuffer[ch]) {
      mCurBufferStart[ch] = (mCurStart[ch] + start);
      mCurBufferLen[ch] = mCurTrack[ch]->GetBestBlockSize(mCurBufferStart[ch]);
 
      if (mCurBufferLen[ch] < (size_t) len) {
         mCurBufferLen[ch] = mCurTrack[ch]->GetIdealBlockSize();
      }
 
      mCurBufferLen[ch] =
         limitSampleBufferSize( mCurBufferLen[ch],
                                mCurStart[ch] + mCurLen - mCurBufferStart[ch] );
 
      // C++20
      // mCurBuffer[ch] = std::make_unique_for_overwrite(mCurBufferLen[ch]);
      mCurBuffer[ch] = Buffer{ safenew float[ mCurBufferLen[ch] ] };
      try {
         mCurTrack[ch]->GetFloats( mCurBuffer[ch].get(),
            mCurBufferStart[ch], mCurBufferLen[ch]);
      }
      catch ( ... ) {
         // Save the exception object for re-throw when out of the library
         mpException = std::current_exception();
         return -1;
      }
   }
 
   // We have guaranteed above that this is nonnegative and bounded by
   // mCurBufferLen[ch]:
   auto offset = ( mCurStart[ch] + start - mCurBufferStart[ch] ).as_size_t();
   const void *src = &mCurBuffer[ch][offset];
   std::memcpy(buffer, src, len * sizeof(float));
 
   if (ch == 0) {
      double progress = mScale *
         ( (start+len)/ mCurLen.as_double() );
 
      if (progress > mProgressIn) {
         mProgressIn = progress;
      }
 
      if (TotalProgress(mProgressIn+mProgressOut+mProgressTot)) {
         return -1;
      }
   }
 
   return 0;
}

References sampleCount::as_double(), WaveTrack::GetBestBlockSize(), SampleTrack::GetFloats(), WaveTrack::GetIdealBlockSize(), limitSampleBufferSize(), mCurBuffer, mCurBufferLen, mCurBufferStart, mCurLen, mCurStart, mCurTrack, mpException, mProgressIn, mProgressOut, mProgressTot, mScale, safenew, and Effect::TotalProgress().

Referenced by StaticGetCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

GetClassification()

EffectType NyquistEffect::GetClassification ( ) const

overridevirtual

Determines which menu it appears in; default same as GetType().

Reimplemented from EffectDefinitionInterface.

Definition at line 281 of file Nyquist.cpp.

{
   if (mIsTool)
      return EffectTypeTool;
   return mType;
}

References EffectTypeTool, mIsTool, and mType.

GetCtrlValue()

double NyquistEffect::GetCtrlValue ( const wxString &  s )

staticprivate

Definition at line 1927 of file Nyquist.cpp.

{
   /* For this to work correctly requires that the plug-in header is
    * parsed on each run so that the correct value for "half-srate" may
    * be determined.
    *
   auto project = FindProject();
   if (project && s.IsSameAs(wxT("half-srate"), false)) {
      auto rate =
         TrackList::Get( *project ).Selected< const WaveTrack >()
            .min( &WaveTrack::GetRate );
      return (rate / 2.0);
   }
   */
 
   return Internat::CompatibleToDouble(s);
}

References Internat::CompatibleToDouble().

Referenced by Parse(), SaveSettings(), SetLispVarsFromParameters(), TransferDataFromEffectWindow(), and VisitSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDescription()

TranslatableString NyquistEffect::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 240 of file Nyquist.cpp.

{
   return mCopyright;
}

References mCopyright.

GetFamily()

EffectFamilySymbol NyquistEffect::GetFamily ( ) const

overridevirtual

Report identifier and user-visible name of the effect protocol.

Implements EffectDefinitionInterface.

Definition at line 288 of file Nyquist.cpp.

{
   return NYQUISTEFFECTS_FAMILY;
}

References NYQUISTEFFECTS_FAMILY.

GetNyquistSearchPath()

FilePaths NyquistEffect::GetNyquistSearchPath ( )

staticprivate

Definition at line 2661 of file Nyquist.cpp.

{
   const auto &audacityPathList = FileNames::AudacityPathList();
   FilePaths pathList;
 
   for (size_t i = 0; i < audacityPathList.size(); i++)
   {
      wxString prefix = audacityPathList[i] + wxFILE_SEP_PATH;
      FileNames::AddUniquePathToPathList(prefix + wxT("nyquist"), pathList);
      FileNames::AddUniquePathToPathList(prefix + wxT("plugins"), pathList);
      FileNames::AddUniquePathToPathList(prefix + wxT("plug-ins"), pathList);
   }
   pathList.push_back(FileNames::PlugInDir());
 
   return pathList;
}

References FileNames::AddUniquePathToPathList(), FileNames::AudacityPathList(), FileNames::PlugInDir(), and wxT().

Referenced by NyquistEffectsModule::AutoRegisterPlugins(), CheckHelpPage(), NyquistEffectsModule::FindModulePaths(), and Process().

Here is the call graph for this function:

Here is the caller graph for this function:

GetPath()

PluginPath NyquistEffect::GetPath ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 207 of file Nyquist.cpp.

{
   if (mIsPrompt)
      return NYQUIST_PROMPT_ID;
 
   return mFileName.GetFullPath();
}

References mFileName, mIsPrompt, and NYQUIST_PROMPT_ID.

GetSymbol()

ComponentInterfaceSymbol NyquistEffect::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 215 of file Nyquist.cpp.

{
   if (mIsPrompt)
      return { NYQUIST_PROMPT_ID, NYQUIST_PROMPT_NAME };
 
   return mName;
}

References mIsPrompt, mName, NYQUIST_PROMPT_ID, and NYQUIST_PROMPT_NAME.

GetType()

EffectType NyquistEffect::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 276 of file Nyquist.cpp.

{
   return mType;
}

References mType.

Referenced by Process(), and ProcessOne().

Here is the caller graph for this function:

GetVendor()

VendorSymbol NyquistEffect::GetVendor ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 223 of file Nyquist.cpp.

{
   if (mIsPrompt)
   {
      return XO("Audacity");
   }
 
   return mAuthor;
}

References mAuthor, mIsPrompt, and XO().

Here is the call graph for this function:

GetVersion()

wxString NyquistEffect::GetVersion ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 233 of file Nyquist.cpp.

{
   // Are Nyquist version strings really supposed to be translatable?
   // See commit a06e561 which used XO for at least one of them
   return mReleaseVersion.Translation();
}

References mReleaseVersion, and TranslatableString::Translation().

Here is the call graph for this function:

HelpPage()

FilePath NyquistEffect::HelpPage ( ) const

overridevirtual

Fully qualified local help file name, default is empty.

Reimplemented from EffectDefinitionInterface.

Definition at line 269 of file Nyquist.cpp.

{
   return mHelpPage;
}

References mHelpPage.

Init()

bool NyquistEffect::Init ( )

overridevirtual

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 565 of file Nyquist.cpp.

{
   // When Nyquist Prompt spawns an effect GUI, Init() is called for Nyquist Prompt,
   // and then again for the spawned (mExternal) effect.
 
   // EffectType may not be defined in script, so
   // reset each time we call the Nyquist Prompt.
   if (mIsPrompt) {
      mName = mPromptName;
      // Reset effect type each time we call the Nyquist Prompt.
      mType = mPromptType;
      mIsSpectral = false;
      mDebugButton = true;    // Debug button always enabled for Nyquist Prompt.
      mEnablePreview = true;  // Preview button always enabled for Nyquist Prompt.
      mVersion = 4;
   }
 
   // As of Audacity 2.1.2 rc1, 'spectral' effects are allowed only if
   // the selected track(s) are in a spectrogram view, and there is at
   // least one frequency bound and Spectral Selection is enabled for the
   // selected track(s) - (but don't apply to Nyquist Prompt).
 
   if (!mIsPrompt && mIsSpectral) {
      // Completely skip the spectral editing limitations if there is no
      // project because that is editing of macro parameters
      if (const auto project = FindProject()) {
         bool bAllowSpectralEditing = false;
         bool hasSpectral = false;
         for ( auto t :
                  TrackList::Get( *project ).Selected< const WaveTrack >() ) {
            // Find() not Get() to avoid creation-on-demand of views in case we are
            // only previewing
            auto pView = WaveTrackView::Find( t );
            if ( pView ) {
               const auto displays = pView->GetDisplays();
               if (displays.end() != std::find(
                  displays.begin(), displays.end(),
                  WaveTrackSubView::Type{ WaveTrackViewConstants::Spectrum, {} }))
                  hasSpectral = true;
            }
            if ( hasSpectral &&
                (SpectrogramSettings::Get(*t).SpectralSelectionEnabled())) {
               bAllowSpectralEditing = true;
               break;
            }
         }
 
         if (!bAllowSpectralEditing || ((mF0 < 0.0) && (mF1 < 0.0))) {
            if (!hasSpectral) {
               EffectUIServices::DoMessageBox(*this,
               XO("Enable track spectrogram view before\n"
               "applying 'Spectral' effects."),
               wxOK | wxICON_EXCLAMATION | wxCENTRE,
               XO("Error") );
            } else {
               EffectUIServices::DoMessageBox(*this,
                  XO("To use 'Spectral effects', enable 'Spectral Selection'\n"
                              "in the track Spectrogram settings and select the\n"
                              "frequency range for the effect to act on."),
                  wxOK | wxICON_EXCLAMATION | wxCENTRE,
                  XO("Error") );
            }
            return false;
         }
      }
   }
 
   if (!mIsPrompt && !mExternal)
   {
      //TODO: (bugs):
      // 1) If there is more than one plug-in with the same name, GetModificationTime may pick the wrong one.
      // 2) If the ;type is changed after the effect has been registered, the plug-in will appear in the wrong menu.
 
      //TODO: If we want to auto-add parameters from spectral selection,
      //we will need to modify this test.
      //Note that removing it stops the caching of parameter values,
      //(during this session).
      if (mFileName.GetModificationTime().IsLaterThan(mFileModified))
      {
         // If the effect has internal state, save and restore it.
         // If the effect is stateless, saving and restoring don't matter.
         auto dummySettings = MakeSettings();
         constexpr auto key = L"TemporarySettings";
         SaveUserPreset(key, dummySettings);
 
         mMaxLen = NYQ_MAX_LEN;
         ParseFile();
         mFileModified = mFileName.GetModificationTime();
 
         // Ignore failure
         (void) LoadUserPreset(key, dummySettings);
      }
   }
 
   return true;
}

References EffectUIServices::DoMessageBox(), WaveTrackView::Find(), EffectBase::FindProject(), TrackList::Get(), SpectrogramSettings::Get(), mDebugButton, mEnablePreview, mIsPrompt, mIsSpectral, mName, mPromptName, mPromptType, mType, mVersion, TrackList::Selected(), SpectrogramSettings::SpectralSelectionEnabled(), and XO().

Here is the call graph for this function:

InitializationError()

const TranslatableString & NyquistEffect::InitializationError ( ) const

inlineprivate

Definition at line 159 of file Nyquist.h.

{ return mInitError; }

Referenced by NyquistEffectsModule::DiscoverPluginsAtPath().

Here is the caller graph for this function:

IsDefault()

bool NyquistEffect::IsDefault ( ) const

overridevirtual

Whether the effect sorts "above the line" in the menus.

Implements EffectDefinitionInterface.

Definition at line 303 of file Nyquist.cpp.

{
   return mIsPrompt;
}

References mIsPrompt.

IsInteractive()

bool NyquistEffect::IsInteractive ( ) const

overridevirtual

Whether the effect needs a dialog for entry of settings.

Implements EffectDefinitionInterface.

Definition at line 293 of file Nyquist.cpp.

{
   if (mIsPrompt)
   {
      return true;
   }
 
   return mControls.size() != 0;
}

References mControls, and mIsPrompt.

IsOk()

bool NyquistEffect::IsOk ( )

private

Definition at line 3072 of file Nyquist.cpp.

{
   return mOK;
}

References mOK.

Referenced by NyquistEffectsModule::DiscoverPluginsAtPath().

Here is the caller graph for this function:

LoadSettings()

bool NyquistEffect::LoadSettings ( const CommandParameters &  parms, EffectSettings &  settings  ) const

overridevirtual

Restore settings from keys and values.

Returns

true on success

Implements EffectSettingsManager.

Definition at line 423 of file Nyquist.cpp.

{
   // To do: externalize state so const_cast isn't needed
   return const_cast<NyquistEffect*>(this)->DoLoadSettings(parms, settings);
}

References DoLoadSettings(), and settings().

Referenced by ShowHostInterface(), and VisitSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

ManualPage()

ManualPageID NyquistEffect::ManualPage ( ) const

overridevirtual

Name of a page in the Audacity alpha manual, default is empty.

Reimplemented from EffectDefinitionInterface.

Definition at line 245 of file Nyquist.cpp.

{
      return mIsPrompt
         ? wxString("Nyquist_Prompt")
         : mManPage;
}

References mIsPrompt, and mManPage.

NyquistToWxString()

wxString NyquistEffect::NyquistToWxString ( const char *  nyqString )

staticprivate

Definition at line 1730 of file Nyquist.cpp.

{
    wxString str(nyqString, wxConvUTF8);
    if (nyqString != NULL && nyqString[0] && str.empty()) {
        // invalid UTF-8 string, convert as Latin-1
        str = _("[Warning: Nyquist returned invalid UTF-8 string, converted here as Latin-1]");
       // TODO: internationalization of strings from Nyquist effects, at least
       // from those shipped with Audacity
        str += LAT1CTOWX(nyqString);
    }
    return str;
}

References _, LAT1CTOWX, and str.

Referenced by ProcessOne().

Here is the caller graph for this function:

OnChoice()

void NyquistEffect::OnChoice ( wxCommandEvent &  evt )

private

Definition at line 3181 of file Nyquist.cpp.

{
   mControls[evt.GetId() - ID_Choice].val = (double) evt.GetInt();
}

References ID_Choice, and mControls.

OnDebug()

void NyquistEffect::OnDebug ( wxCommandEvent &  evt )

private

OnFileButton()

void NyquistEffect::OnFileButton ( wxCommandEvent &  evt )

private

Definition at line 3217 of file Nyquist.cpp.

{
   int i = evt.GetId() - ID_FILE;
   NyqControl & ctrl = mControls[i];
 
   // Get style flags:
   // Ensure legal combinations so that wxWidgets does not throw an assert error.
   unsigned int flags = 0;
   if (!ctrl.highStr.empty())
   {
      wxStringTokenizer tokenizer(ctrl.highStr, ",");
      while ( tokenizer.HasMoreTokens() )
      {
         wxString token = tokenizer.GetNextToken().Trim(true).Trim(false);
         if (token.IsSameAs("open", false))
         {
            flags |= wxFD_OPEN;
            flags &= ~wxFD_SAVE;
            flags &= ~wxFD_OVERWRITE_PROMPT;
         }
         else if (token.IsSameAs("save", false))
         {
            flags |= wxFD_SAVE;
            flags &= ~wxFD_OPEN;
            flags &= ~wxFD_MULTIPLE;
            flags &= ~wxFD_FILE_MUST_EXIST;
         }
         else if (token.IsSameAs("overwrite", false) && !(flags & wxFD_OPEN))
         {
            flags |= wxFD_OVERWRITE_PROMPT;
         }
         else if (token.IsSameAs("exists", false) && !(flags & wxFD_SAVE))
         {
            flags |= wxFD_FILE_MUST_EXIST;
         }
         else if (token.IsSameAs("multiple", false) && !(flags & wxFD_SAVE))
         {
            flags |= wxFD_MULTIPLE;
         }
      }
   }
 
   resolveFilePath(ctrl.valStr);
 
   wxFileName fname = ctrl.valStr;
   wxString defaultDir = fname.GetPath();
   wxString defaultFile = fname.GetName();
   auto message = XO("Select a file");
 
   if (flags & wxFD_MULTIPLE)
      message = XO("Select one or more files");
   else if (flags & wxFD_SAVE)
      message = XO("Save file as");
 
   FileDialogWrapper openFileDialog(mUIParent->FindWindow(ID_FILE + i),
                               message,
                               defaultDir,
                               defaultFile,
                               ctrl.fileTypes,
                               flags);       // styles
 
   if (openFileDialog.ShowModal() == wxID_CANCEL)
   {
      return;
   }
 
   wxString path;
   // When multiple files selected, return file paths as a list of quoted strings.
   if (flags & wxFD_MULTIPLE)
   {
      wxArrayString selectedFiles;
      openFileDialog.GetPaths(selectedFiles);
 
      for (size_t sf = 0; sf < selectedFiles.size(); sf++) {
         path += "\"";
         path += selectedFiles[sf];
         path += "\"";
      }
      ctrl.valStr = path;
   }
   else
   {
      ctrl.valStr = openFileDialog.GetPath();
   }
 
   mUIParent->FindWindow(ID_Text + i)->GetValidator()->TransferToWindow();
}

References NyqControl::fileTypes, FileDialog::GetPath(), FileDialog::GetPaths(), NyqControl::highStr, ID_FILE, ID_Text, mControls, mUIParent, resolveFilePath(), FileDialog::ShowModal(), NyqControl::valStr, and XO().

Here is the call graph for this function:

OnLoad()

void NyquistEffect::OnLoad ( wxCommandEvent &  evt )

private

Definition at line 3084 of file Nyquist.cpp.

{
   if (mCommandText->IsModified())
   {
      if (wxNO == EffectUIServices::DoMessageBox(*this,
         XO("Current program has been modified.\nDiscard changes?"),
         wxYES_NO ) )
      {
         return;
      }
   }
 
   FileDialogWrapper dlog(
      mUIParent,
      XO("Load Nyquist script"),
      mFileName.GetPath(),
      wxEmptyString,
      {
         NyquistScripts,
         LispScripts,
         FileNames::TextFiles,
         FileNames::AllFiles
      },
      wxFD_OPEN | wxRESIZE_BORDER);
 
   if (dlog.ShowModal() != wxID_OK)
   {
      return;
   }
 
   mFileName = dlog.GetPath();
 
   if (!mCommandText->LoadFile(mFileName.GetFullPath()))
   {
      EffectUIServices::DoMessageBox(*this, XO("File could not be loaded"));
   }
}

References EffectUIServices::DoMessageBox(), FileDialog::GetPath(), mCommandText, mFileName, mUIParent, FileDialog::ShowModal(), and XO().

Here is the call graph for this function:

OnSave()

void NyquistEffect::OnSave ( wxCommandEvent &  evt )

private

Definition at line 3122 of file Nyquist.cpp.

{
   FileDialogWrapper dlog(
      mUIParent,
      XO("Save Nyquist script"),
      mFileName.GetPath(),
      mFileName.GetFullName(),
      {
         NyquistScripts,
         LispScripts,
         FileNames::AllFiles
      },
      wxFD_SAVE | wxFD_OVERWRITE_PROMPT | wxRESIZE_BORDER);
 
   if (dlog.ShowModal() != wxID_OK)
   {
      return;
   }
 
   mFileName = dlog.GetPath();
 
   if (!mCommandText->SaveFile(mFileName.GetFullPath()))
   {
      EffectUIServices::DoMessageBox(*this, XO("File could not be saved"));
   }
}

References EffectUIServices::DoMessageBox(), FileDialog::GetPath(), mCommandText, mFileName, mUIParent, FileDialog::ShowModal(), and XO().

Here is the call graph for this function:

OnSlider()

void NyquistEffect::OnSlider ( wxCommandEvent &  evt )

private

Definition at line 3149 of file Nyquist.cpp.

{
   int i = evt.GetId() - ID_Slider;
   NyqControl & ctrl = mControls[i];
 
   int val = evt.GetInt();
   double range = ctrl.high - ctrl.low;
   double newVal = (val / (double)ctrl.ticks) * range + ctrl.low;
 
   // Determine precision for displayed number
   int precision = range < 1.0 ? 3 :
                   range < 10.0 ? 2 :
                   range < 100.0 ? 1 :
                   0;
 
   // If the value is at least one tick different from the current value
   // change it (this prevents changes from manually entered values unless
   // the slider actually moved)
   if (fabs(newVal - ctrl.val) >= (1 / (double)ctrl.ticks) * range &&
       fabs(newVal - ctrl.val) >= pow(0.1, precision) / 2)
   {
      // First round to the appropriate precision
      newVal *= pow(10.0, precision);
      newVal = floor(newVal + 0.5);
      newVal /= pow(10.0, precision);
 
      ctrl.val = newVal;
 
      mUIParent->FindWindow(ID_Text + i)->GetValidator()->TransferToWindow();
   }
}

References NyqControl::high, ID_Slider, ID_Text, NyqControl::low, mControls, mUIParent, NyqControl::ticks, and NyqControl::val.

OnText()

void NyquistEffect::OnText ( wxCommandEvent &  evt )

private

Definition at line 3392 of file Nyquist.cpp.

{
   int i = evt.GetId() - ID_Text;
 
   NyqControl & ctrl = mControls[i];
 
   if (wxDynamicCast(evt.GetEventObject(), wxWindow)->GetValidator()->TransferFromWindow())
   {
      if (ctrl.type == NYQ_CTRL_FLOAT || ctrl.type == NYQ_CTRL_INT)
      {
         int pos = (int)floor((ctrl.val - ctrl.low) /
                              (ctrl.high - ctrl.low) * ctrl.ticks + 0.5);
 
         wxSlider *slider = (wxSlider *)mUIParent->FindWindow(ID_Slider + i);
         slider->SetValue(pos);
      }
   }
}

References NyqControl::high, ID_Slider, ID_Text, NyqControl::low, mControls, mUIParent, NYQ_CTRL_FLOAT, NYQ_CTRL_INT, NyqControl::ticks, NyqControl::type, and NyqControl::val.

OnTime()

void NyquistEffect::OnTime ( wxCommandEvent &  evt )

private

Definition at line 3186 of file Nyquist.cpp.

{
   int i = evt.GetId() - ID_Time;
   static double value = 0.0;
   NyqControl & ctrl = mControls[i];
 
   NumericTextCtrl *n = (NumericTextCtrl *) mUIParent->FindWindow(ID_Time + i);
   double val = n->GetValue();
 
   // Observed that two events transmitted on each control change (Linux)
   // so skip if value has not changed.
   if (val != value) {
      if (val < ctrl.low || val > ctrl.high) {
         const auto message = XO("Value range:\n%s to %s")
            .Format( ToTimeFormat(ctrl.low), ToTimeFormat(ctrl.high) );
         EffectUIServices::DoMessageBox(*this,
            message,
            wxOK | wxCENTRE,
            XO("Value Error") );
      }
 
      if (val < ctrl.low)
         val = ctrl.low;
      else if (val > ctrl.high)
         val = ctrl.high;
 
      n->SetValue(val);
      value = val;
   }
}

References EffectUIServices::DoMessageBox(), NumericConverter::GetValue(), NyqControl::high, ID_Time, NyqControl::low, mControls, mUIParent, NumericTextCtrl::SetValue(), ToTimeFormat(), and XO().

Here is the call graph for this function:

OSCallback()

void NyquistEffect::OSCallback ( )

private

Definition at line 2631 of file Nyquist.cpp.

{
   if (mStop) {
      mStop = false;
      nyx_stop();
   }
   else if (mBreak) {
      mBreak = false;
      nyx_break();
   }
   else if (mCont) {
      mCont = false;
      nyx_continue();
   }
 
   // LLL:  STF figured out that yielding while the effect is being applied
   //       produces an EXTREME slowdown.  It appears that yielding is not
   //       really necessary on Linux and Windows.
   //
   //       However, on the Mac, the spinning cursor appears during longer
   //       Nyquist processing and that may cause the user to think Audacity
   //       has crashed or hung.  In addition, yielding or not on the Mac
   //       doesn't seem to make much of a difference in execution time.
   //
   //       So, yielding on the Mac only...
#if defined(__WXMAC__)
   wxYieldIfNeeded();
#endif
}

References mBreak, mCont, and mStop.

OutputCallback()

void NyquistEffect::OutputCallback ( int  c )

private

Definition at line 2615 of file Nyquist.cpp.

{
   // Always collect Nyquist error messages for normal plug-ins
   if (!mRedirectOutput) {
      mDebugOutputStr += (wxChar)c;
      return;
   }
 
   std::cout << (char)c;
}

References mDebugOutputStr, and mRedirectOutput.

Parse()

bool NyquistEffect::Parse ( Tokenizer &  tokenizer, const wxString &  line, bool  eof, bool  first  )

private

Definition at line 2044 of file Nyquist.cpp.

{
   if ( !tzer.Tokenize(line, eof, first ? 1 : 0, 0) )
      return false;
 
   const auto &tokens = tzer.tokens;
   int len = tokens.size();
   if (len < 1) {
      return true;
   }
 
   // Consistency decision is for "plug-in" as the correct spelling
   // "plugin" (deprecated) is allowed as an undocumented convenience.
   if (len == 2 && tokens[0] == wxT("nyquist") &&
      (tokens[1] == wxT("plug-in") || tokens[1] == wxT("plugin"))) {
      mOK = true;
      return true;
   }
 
   if (len >= 2 && tokens[0] == wxT("type")) {
      wxString tok = tokens[1];
      mIsTool = false;
      if (tok == wxT("tool")) {
         mIsTool = true;
         mType = EffectTypeTool;
         // we allow
         // ;type tool
         // ;type tool process
         // ;type tool generate
         // ;type tool analyze
         // The last three are placed in the tool menu, but are processed as
         // process, generate or analyze.
         if (len >= 3)
            tok = tokens[2];
      }
 
      if (tok == wxT("process")) {
         mType = EffectTypeProcess;
      }
      else if (tok == wxT("generate")) {
         mType = EffectTypeGenerate;
      }
      else if (tok == wxT("analyze")) {
         mType = EffectTypeAnalyze;
      }
 
      if (len >= 3 && tokens[2] == wxT("spectral")) {;
         mIsSpectral = true;
      }
      return true;
   }
 
   if (len == 2 && tokens[0] == wxT("codetype")) {
      // This will stop ParseProgram() from doing a best guess as program type.
      if (tokens[1] == wxT("lisp")) {
         mIsSal = false;
         mFoundType = true;
      }
      else if (tokens[1] == wxT("sal")) {
         mIsSal = true;
         mFoundType = true;
      }
      return true;
   }
 
   if (len >= 2 && tokens[0] == wxT("debugflags")) {
      for (int i = 1; i < len; i++) {
         // "trace" sets *tracenable* (LISP) or *sal-traceback* (SAL)
         // and displays debug window IF there is anything to show.
         if (tokens[i] == wxT("trace")) {
            mTrace = true;
         }
         else if (tokens[i] == wxT("notrace")) {
            mTrace = false;
         }
         else if (tokens[i] == wxT("compiler")) {
            mCompiler = true;
         }
         else if (tokens[i] == wxT("nocompiler")) {
            mCompiler = false;
         }
      }
      return true;
   }
 
   // We support versions 1, 2 and 3
   // (Version 2 added support for string parameters.)
   // (Version 3 added support for choice parameters.)
   // (Version 4 added support for project/track/selection information.)
   if (len >= 2 && tokens[0] == wxT("version")) {
      long v;
      tokens[1].ToLong(&v);
      if (v < 1 || v > 4) {
         // This is an unsupported plug-in version
         mOK = false;
         mInitError = XO(
"This version of Audacity does not support Nyquist plug-in version %ld")
            .Format( v );
         return true;
      }
      mVersion = (int) v;
   }
 
   if (len >= 2 && tokens[0] == wxT("name")) {
      // Names do not yet support context strings for translations, or
      // internal names distinct from visible English names.
      // (See also comments in NyquistEffectsModule::AutoRegisterPlugins)
      auto name = UnQuote(tokens[1]);
      // Strip ... from name if it's present, perhaps in third party plug-ins
      // Menu system puts ... back if there are any controls
      // This redundant naming convention must NOT be followed for
      // shipped Nyquist effects with internationalization.  Else the msgid
      // later looked up will lack the ... and will not be found.
      if (name.EndsWith(wxT("...")))
         name = name.RemoveLast(3);
      mName = TranslatableString{ name, {} };
      return true;
   }
 
   if (len >= 2 && tokens[0] == wxT("action")) {
      mAction = TranslatableString{ UnQuote(tokens[1]), {} };
      return true;
   }
 
   if (len >= 2 && tokens[0] == wxT("info")) {
      mInfo = TranslatableString{ UnQuote(tokens[1]), {} };
      return true;
   }
 
   if (len >= 2 && tokens[0] == wxT("preview")) {
      if (tokens[1] == wxT("enabled") || tokens[1] == wxT("true")) {
         mEnablePreview = true;
         SetLinearEffectFlag(false);
      }
      else if (tokens[1] == wxT("linear")) {
         mEnablePreview = true;
         SetLinearEffectFlag(true);
      }
      else if (tokens[1] == wxT("selection")) {
         mEnablePreview = true;
         SetPreviewFullSelectionFlag(true);
      }
      else if (tokens[1] == wxT("disabled") || tokens[1] == wxT("false")) {
         mEnablePreview = false;
      }
      return true;
   }
 
   // Maximum number of samples to be processed. This can help the
   // progress bar if effect does not process all of selection.
   if (len >= 2 && tokens[0] == wxT("maxlen")) {
      long long v; // Note that Nyquist may overflow at > 2^31 samples (bug 439)
      tokens[1].ToLongLong(&v);
      mMaxLen = (sampleCount) v;
   }
 
#if defined(EXPERIMENTAL_NYQUIST_SPLIT_CONTROL)
   if (len >= 2 && tokens[0] == wxT("mergeclips")) {
      long v;
      // -1 = auto (default), 0 = don't merge clips, 1 = do merge clips
      tokens[1].ToLong(&v);
      mMergeClips = v;
      return true;
   }
 
   if (len >= 2 && tokens[0] == wxT("restoresplits")) {
      long v;
      // Splits are restored by default. Set to 0 to prevent.
      tokens[1].ToLong(&v);
      mRestoreSplits = !!v;
      return true;
   }
#endif
 
   if (len >= 2 && tokens[0] == wxT("author")) {
      mAuthor = TranslatableString{ UnQuote(tokens[1]), {} };
      return true;
   }
 
   if (len >= 2 && tokens[0] == wxT("release")) {
      // Value must be quoted if the release version string contains spaces.
      mReleaseVersion =
         TranslatableString{ UnQuote(tokens[1]), {} };
      return true;
   }
 
   if (len >= 2 && tokens[0] == wxT("copyright")) {
      mCopyright = TranslatableString{ UnQuote(tokens[1]), {} };
      return true;
   }
 
   // Page name in Audacity development manual
   if (len >= 2 && tokens[0] == wxT("manpage")) {
      // do not translate
      mManPage = UnQuote(tokens[1], false);
      return true;
   }
 
   // Local Help file
   if (len >= 2 && tokens[0] == wxT("helpfile")) {
      // do not translate
      mHelpFile = UnQuote(tokens[1], false);
      return true;
   }
 
   // Debug button may be disabled for release plug-ins.
   if (len >= 2 && tokens[0] == wxT("debugbutton")) {
      if (tokens[1] == wxT("disabled") || tokens[1] == wxT("false")) {
         mDebugButton = false;
      }
      return true;
   }
 
 
   if (len >= 3 && tokens[0] == wxT("control")) {
      NyqControl ctrl;
 
      if (len == 3 && tokens[1] == wxT("text")) {
         ctrl.var = tokens[1];
         ctrl.label = UnQuote( tokens[2] );
         ctrl.type = NYQ_CTRL_TEXT;
      }
      else if (len >= 5)
      {
         ctrl.var = tokens[1];
         ctrl.name = UnQuote( tokens[2] );
         // 3 is type, below
         ctrl.label = tokens[4];
 
         // valStr may or may not be a quoted string
         ctrl.valStr = len > 5 ? tokens[5] : wxString{};
         ctrl.val = GetCtrlValue(ctrl.valStr);
         if (ctrl.valStr.length() > 0 &&
               (ctrl.valStr[0] == wxT('(') ||
               ctrl.valStr[0] == wxT('"')))
            ctrl.valStr = UnQuote( ctrl.valStr );
 
         // 6 is minimum, below
         // 7 is maximum, below
 
         if (tokens[3] == wxT("string")) {
            ctrl.type = NYQ_CTRL_STRING;
            ctrl.label = UnQuote( ctrl.label );
         }
         else if (tokens[3] == wxT("choice")) {
            ctrl.type = NYQ_CTRL_CHOICE;
            ctrl.choices = ParseChoice(ctrl.label);
            ctrl.label = wxT("");
         }
         else if (tokens[3] == wxT("file")) {
            ctrl.type = NYQ_CTRL_FILE;
            ctrl.fileTypes = ParseFileTypes(tokens[6]);
            // will determine file dialog styles:
            ctrl.highStr = UnQuote( tokens[7] );
            ctrl.label = UnQuote(ctrl.label);
         }
         else {
            ctrl.label = UnQuote( ctrl.label );
 
            if (len < 8) {
               return true;
            }
 
            if ((tokens[3] == wxT("float")) ||
                  (tokens[3] == wxT("real"))) // Deprecated
               ctrl.type = NYQ_CTRL_FLOAT;
            else if (tokens[3] == wxT("int"))
               ctrl.type = NYQ_CTRL_INT;
            else if (tokens[3] == wxT("float-text"))
               ctrl.type = NYQ_CTRL_FLOAT_TEXT;
            else if (tokens[3] == wxT("int-text"))
               ctrl.type = NYQ_CTRL_INT_TEXT;
            else if (tokens[3] == wxT("time"))
                ctrl.type = NYQ_CTRL_TIME;
            else
            {
               wxString str;
               str.Printf(wxT("Bad Nyquist 'control' type specification: '%s' in plug-in file '%s'.\nControl not created."),
                        tokens[3], mFileName.GetFullPath());
 
               // Too disturbing to show alert before Audacity frame is up.
               //    EffectUIServices::DoMessageBox(*this,
               //       str,
               //       wxOK | wxICON_EXCLAMATION,
               //       XO("Nyquist Warning") );
 
               // Note that the AudacityApp's mLogger has not yet been created,
               // so this brings up an alert box, but after the Audacity frame is up.
               wxLogWarning(str);
               return true;
            }
 
            ctrl.lowStr = UnQuote( tokens[6] );
            if (ctrl.type == NYQ_CTRL_INT_TEXT && ctrl.lowStr.IsSameAs(wxT("nil"), false)) {
               ctrl.low = INT_MIN;
            }
            else if (ctrl.type == NYQ_CTRL_FLOAT_TEXT && ctrl.lowStr.IsSameAs(wxT("nil"), false)) {
               ctrl.low = -(FLT_MAX);
            }
            else if (ctrl.type == NYQ_CTRL_TIME && ctrl.lowStr.IsSameAs(wxT("nil"), false)) {
                ctrl.low = 0.0;
            }
            else {
               ctrl.low = GetCtrlValue(ctrl.lowStr);
            }
 
            ctrl.highStr = UnQuote( tokens[7] );
            if (ctrl.type == NYQ_CTRL_INT_TEXT && ctrl.highStr.IsSameAs(wxT("nil"), false)) {
               ctrl.high = INT_MAX;
            }
            else if ((ctrl.type == NYQ_CTRL_FLOAT_TEXT || ctrl.type == NYQ_CTRL_TIME) &&
                      ctrl.highStr.IsSameAs(wxT("nil"), false))
            {
               ctrl.high = FLT_MAX;
            }
            else {
               ctrl.high = GetCtrlValue(ctrl.highStr);
            }
 
            if (ctrl.high < ctrl.low) {
               ctrl.high = ctrl.low;
            }
 
            if (ctrl.val < ctrl.low) {
               ctrl.val = ctrl.low;
            }
 
            if (ctrl.val > ctrl.high) {
               ctrl.val = ctrl.high;
            }
 
            ctrl.ticks = 1000;
            if (ctrl.type == NYQ_CTRL_INT &&
               (ctrl.high - ctrl.low < ctrl.ticks)) {
               ctrl.ticks = (int)(ctrl.high - ctrl.low);
            }
         }
      }
 
      if( ! make_iterator_range( mPresetNames ).contains( ctrl.var ) )
      {
         mControls.push_back(ctrl);
      }
   }
 
   // Deprecated
   if (len >= 2 && tokens[0] == wxT("categories")) {
      for (size_t i = 1; i < tokens.size(); ++i) {
         mCategories.push_back(tokens[i]);
      }
   }
   return true;
}

References NyqControl::choices, EffectTypeAnalyze, EffectTypeGenerate, EffectTypeProcess, EffectTypeTool, NyqControl::fileTypes, GetCtrlValue(), NyqControl::high, NyqControl::highStr, NyqControl::label, NyqControl::low, NyqControl::lowStr, mAction, make_iterator_range(), mAuthor, mCategories, mCompiler, mControls, mCopyright, mDebugButton, mEnablePreview, mFileName, mFoundType, mHelpFile, mInfo, mInitError, mIsSal, mIsSpectral, mIsTool, mManPage, mMaxLen, mMergeClips, mName, mOK, EffectBase::mPresetNames, mReleaseVersion, mRestoreSplits, mTrace, mType, mVersion, name, NyqControl::name, NYQ_CTRL_CHOICE, NYQ_CTRL_FILE, NYQ_CTRL_FLOAT, NYQ_CTRL_FLOAT_TEXT, NYQ_CTRL_INT, NYQ_CTRL_INT_TEXT, NYQ_CTRL_STRING, NYQ_CTRL_TEXT, NYQ_CTRL_TIME, ParseChoice(), ParseFileTypes(), EffectBase::SetLinearEffectFlag(), EffectBase::SetPreviewFullSelectionFlag(), str, NyqControl::ticks, NyquistEffect::Tokenizer::Tokenize(), NyquistEffect::Tokenizer::tokens, NyqControl::type, UnQuote(), NyqControl::val, NyqControl::valStr, NyqControl::var, wxT(), and XO().

Referenced by ParseProgram().

Here is the call graph for this function:

Here is the caller graph for this function:

ParseChoice()

std::vector< EnumValueSymbol > NyquistEffect::ParseChoice ( const wxString &  text )

staticprivate

Definition at line 1753 of file Nyquist.cpp.

{
   std::vector<EnumValueSymbol> results;
   if (text[0] == wxT('(')) {
      // New style:  expecting a Lisp-like list of strings
      Tokenizer tzer;
      tzer.Tokenize(text, true, 1, 1);
      auto &choices = tzer.tokens;
      wxString extra;
      for (auto &choice : choices) {
         auto label = UnQuote(choice, true, &extra);
         if (extra.empty())
            results.push_back( TranslatableString{ label, {} } );
         else
            results.push_back(
               { extra, TranslatableString{ label, {} } } );
      }
   }
   else {
      // Old style: expecting a comma-separated list of
      // un-internationalized names, ignoring leading and trailing spaces
      // on each; and the whole may be quoted
      auto choices = wxStringTokenize(
         text[0] == wxT('"') ? text.Mid(1, text.length() - 2) : text,
         wxT(",")
      );
      for (auto &choice : choices)
         results.push_back( { choice.Trim(true).Trim(false) } );
   }
   return results;
}

References label, NyquistEffect::Tokenizer::Tokenize(), NyquistEffect::Tokenizer::tokens, UnQuote(), and wxT().

Referenced by Parse().

Here is the call graph for this function:

Here is the caller graph for this function:

ParseCommand()

bool NyquistEffect::ParseCommand ( const wxString &  cmd )

private

Definition at line 2505 of file Nyquist.cpp.

{
   wxStringInputStream stream(cmd + wxT(" "));
 
   return ParseProgram(stream);
}

References ParseProgram(), and wxT().

Referenced by DoLoadSettings(), SetCommand(), and TransferDataFromPromptWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

ParseFile()

void NyquistEffect::ParseFile ( )

private

Definition at line 2497 of file Nyquist.cpp.

{
   wxFileInputStream rawStream(mFileName.GetFullPath());
   wxBufferedInputStream stream(rawStream, 10000);
 
   ParseProgram(stream);
}

References mFileName, and ParseProgram().

Here is the call graph for this function:

ParseFileExtensions()

FileExtensions NyquistEffect::ParseFileExtensions ( const wxString &  text )

private

Definition at line 1785 of file Nyquist.cpp.

{
   // todo: error handling
   FileExtensions results;
   if (text[0] == wxT('(')) {
      Tokenizer tzer;
      tzer.Tokenize(text, true, 1, 1);
      for (const auto &token : tzer.tokens)
         results.push_back( UnQuote( token ) );
   }
   return results;
}

References NyquistEffect::Tokenizer::Tokenize(), NyquistEffect::Tokenizer::tokens, UnQuote(), and wxT().

Referenced by ParseFileType().

Here is the call graph for this function:

Here is the caller graph for this function:

ParseFileType()

FileNames::FileType NyquistEffect::ParseFileType ( const wxString &  text )

private

Definition at line 1798 of file Nyquist.cpp.

{
   // todo: error handling
   FileNames::FileType result;
   if (text[0] == wxT('(')) {
      Tokenizer tzer;
      tzer.Tokenize(text, true, 1, 1);
      auto &tokens = tzer.tokens;
      if ( tokens.size() == 2 )
         result =
            { UnQuoteMsgid( tokens[0] ), ParseFileExtensions( tokens[1] ) };
   }
   return result;
}

References ParseFileExtensions(), NyquistEffect::Tokenizer::Tokenize(), NyquistEffect::Tokenizer::tokens, UnQuoteMsgid(), and wxT().

Referenced by ParseFileTypes().

Here is the call graph for this function:

Here is the caller graph for this function:

ParseFileTypes()

FileNames::FileTypes NyquistEffect::ParseFileTypes ( const wxString &  text )

private

Definition at line 1813 of file Nyquist.cpp.

{
   // todo: error handling
   FileNames::FileTypes results;
   if (text[0] == wxT('(')) {
      Tokenizer tzer;
      tzer.Tokenize(text, true, 1, 1);
      auto &types = tzer.tokens;
      if ( !types.empty() && types[0][0] == wxT('(') )
         for (auto &type : types)
            results.push_back( ParseFileType( type ) );
   }
   if ( results.empty() ) {
      // Old-style is a specially formatted string, maybe translated
      // Parse it for compatibility
      auto str = UnQuote( text );
      auto pieces = wxSplit( str, '|' );
      // Should have an even number
      auto size = pieces.size();
      if ( size % 2 == 1 )
         --size, pieces.pop_back();
      for ( size_t ii = 0; ii < size; ii += 2 ) {
         FileExtensions extensions;
         auto extensionStrings = wxSplit( pieces[ii + 1], ';' );
         for ( const auto &extensionString : extensionStrings )
            if ( extensionString.StartsWith( wxT("*.") ) ) {
               auto ext = extensionString.substr( 2 );
               if (ext == wxT("*"))
                  // "*.*" to match all
                  ext.clear();
               extensions.push_back( ext );
            }
         results.push_back( { Verbatim( pieces[ii] ), extensions } );
      }
   }
   return results;
}

References ParseFileType(), size, str, NyquistEffect::Tokenizer::Tokenize(), NyquistEffect::Tokenizer::tokens, UnQuote(), Verbatim(), and wxT().

Referenced by Parse().

Here is the call graph for this function:

Here is the caller graph for this function:

ParseProgram()

bool NyquistEffect::ParseProgram ( wxInputStream &  stream )

private

Definition at line 2399 of file Nyquist.cpp.

{
   if (!stream.IsOk())
   {
      mInitError = XO("Could not open file");
      return false;
   }
 
   wxTextInputStream pgm(stream, wxT(" \t"), wxConvAuto());
 
   mCmd = wxT("");
   mCmd.Alloc(10000);
   mIsSal = false;
   mControls.clear();
   mCategories.clear();
   mIsSpectral = false;
   mManPage = wxEmptyString; // If not wxEmptyString, must be a page in the Audacity manual.
   mHelpFile = wxEmptyString; // If not wxEmptyString, must be a valid HTML help file.
   mHelpFileExists = false;
   mDebug = false;
   mTrace = false;
   mDebugButton = true;    // Debug button enabled by default.
   mEnablePreview = true;  // Preview button enabled by default.
 
   // Bug 1934.
   // All Nyquist plug-ins should have a ';type' field, but if they don't we default to
   // being an Effect.
   mType = EffectTypeProcess;
 
   mFoundType = false;
   while (!stream.Eof() && stream.IsOk())
   {
      wxString line = pgm.ReadLine();
      if (line.length() > 1 &&
          // New in 2.3.0:  allow magic comment lines to start with $
          // The trick is that xgettext will not consider such lines comments
          // and will extract the strings they contain
          (line[0] == wxT(';') || line[0] == wxT('$')) )
      {
         Tokenizer tzer;
         unsigned nLines = 1;
         bool done;
         // Allow continuations within control lines.
         bool control =
            line[0] == wxT('$') || line.StartsWith( wxT(";control") );
         do
            done = Parse(tzer, line, !control || stream.Eof(), nLines == 1);
         while(!done &&
            (line = pgm.ReadLine(), ++nLines, true));
 
         // Don't pass these lines to the interpreter, so it doesn't get confused
         // by $, but pass blanks,
         // so that SAL effects compile with proper line numbers
         while (nLines --)
            mCmd += wxT('\n');
      }
      else
      {
         if(!mFoundType && line.length() > 0) {
            if (line[0] == wxT('(') ||
                (line[0] == wxT('#') && line.length() > 1 && line[1] == wxT('|')))
            {
               mIsSal = false;
               mFoundType = true;
            }
            else if (line.Upper().Find(wxT("RETURN")) != wxNOT_FOUND)
            {
               mIsSal = true;
               mFoundType = true;
            }
         }
         mCmd += line + wxT("\n");
      }
   }
   if (!mFoundType && mIsPrompt)
   {
      /* i1n-hint: SAL and LISP are names for variant syntaxes for the
       Nyquist programming language.  Leave them, and 'return', untranslated. */
      EffectUIServices::DoMessageBox(*this,
         XO(
"Your code looks like SAL syntax, but there is no \'return\' statement.\n\
For SAL, use a return statement such as:\n\treturn *track* * 0.1\n\
or for LISP, begin with an open parenthesis such as:\n\t(mult *track* 0.1)\n ."),
         EffectUIServices::DefaultMessageBoxStyle,
         XO("Error in Nyquist code") );
      /* i18n-hint: refers to programming "languages" */
      mInitError = XO("Could not determine language");
      return false;
      // Else just throw it at Nyquist to see what happens
   }
 
   const auto helpStuff = CheckHelpPage();
   mHelpFileExists = helpStuff.first;
   mHelpPage       = helpStuff.second;
 
   return true;
}

References CheckHelpPage(), EffectUIServices::DefaultMessageBoxStyle, EffectUIServices::DoMessageBox(), EffectTypeProcess, mCategories, mCmd, mControls, mDebug, mDebugButton, mEnablePreview, mFoundType, mHelpFile, mHelpFileExists, mHelpPage, mInitError, mIsPrompt, mIsSal, mIsSpectral, mManPage, mTrace, mType, Parse(), wxT(), and XO().

Referenced by ParseCommand(), and ParseFile().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

std::unique_ptr< EffectEditor > NyquistEffect::PopulateOrExchange ( ShuttleGui &  S, EffectInstance &  instance, EffectSettingsAccess &  access, const EffectOutputs *  pOutputs  )

overridevirtual

Add controls to effect panel; always succeeds.

Returns

if not null, then return it from PopulateUI instead of a DefaultEffectEditor; default implementation returns null

Reimplemented from StatefulEffectUIServices.

Definition at line 1137 of file Nyquist.cpp.

{
   mUIParent = S.GetParent();
   if (mIsPrompt)
      BuildPromptWindow(S);
   else
      BuildEffectWindow(S);
   return nullptr;
}

References BuildEffectWindow(), BuildPromptWindow(), mIsPrompt, mUIParent, and S.

Here is the call graph for this function:

Process()

bool NyquistEffect::Process ( EffectInstance &  instance, EffectSettings &  settings  )

overridevirtual

Implements StatefulEffectBase.

Definition at line 664 of file Nyquist.cpp.

{
   if (mIsPrompt && mControls.size() > 0 && !IsBatchProcessing()) {
      auto &nyquistSettings = GetSettings(settings);
      auto cleanup = finally([&]{
         // Free up memory
         nyquistSettings.proxySettings = {};
      });
      NyquistEffect proxy{ NYQUIST_WORKER_ID };
      proxy.SetCommand(mInputCmd);
      proxy.mDebug = nyquistSettings.proxyDebug;
      proxy.mControls = move(nyquistSettings.controls);
      auto result = Delegate(proxy, nyquistSettings.proxySettings);
      if (result) {
         mT0 = proxy.mT0;
         mT1 = proxy.mT1;
      }
      return result;
   }
 
   // Check for reentrant Nyquist commands.
   // I'm choosing to mark skipped Nyquist commands as successful even though
   // they are skipped.  The reason is that when Nyquist calls out to a chain,
   // and that chain contains Nyquist,  it will be clearer if the chain completes
   // skipping Nyquist, rather than doing nothing at all.
   if( mReentryCount > 0 )
      return true;
 
   // Restore the reentry counter (to zero) when we exit.
   auto countRestorer = valueRestorer( mReentryCount);
   mReentryCount++;
   RegisterFunctions();
 
   bool success = true;
   int nEffectsSoFar = nEffectsDone;
   mProjectChanged = false;
   EffectManager & em = EffectManager::Get();
   em.SetSkipStateFlag(false);
 
   // This code was added in a fix for bug 2392 (no preview for Nyquist)
   // It was commented out in a fix for bug 2428 (no progress dialog from a macro)
   //if (mExternal) {
   //  mProgress->Hide();
   //}
 
   mOutputTime = 0;
   mCount = 0;
   mProgressIn = 0;
   mProgressOut = 0;
   mProgressTot = 0;
   mScale = (GetType() == EffectTypeProcess ? 0.5 : 1.0) / GetNumWaveGroups();
 
   mStop = false;
   mBreak = false;
   mCont = false;
 
   mTrackIndex = 0;
 
   // If in tool mode, then we don't do anything with the track and selection.
   const bool bOnePassTool = (GetType() == EffectTypeTool);
 
   // We must copy all the tracks, because Paste needs label tracks to ensure
   // correct sync-lock group behavior when the timeline is affected; then we just want
   // to operate on the selected wave tracks
   if ( !bOnePassTool )
      CopyInputTracks(true);
 
   mNumSelectedChannels = bOnePassTool
      ? 0
      : mOutputTracks->Selected< const WaveTrack >().size();
 
   mDebugOutput = {};
   if (!mHelpFile.empty() && !mHelpFileExists) {
      mDebugOutput = XO(
"error: File \"%s\" specified in header but not found in plug-in path.\n")
         .Format( mHelpFile );
   }
 
   if (mVersion >= 4)
   {
      auto project = FindProject();
 
      mProps = wxEmptyString;
 
      mProps += wxString::Format(wxT("(putprop '*AUDACITY* (list %d %d %d) 'VERSION)\n"), AUDACITY_VERSION, AUDACITY_RELEASE, AUDACITY_REVISION);
      wxString lang = gPrefs->Read(wxT("/Locale/Language"), wxT(""));
      lang = (lang.empty())
         ? Languages::GetSystemLanguageCode(FileNames::AudacityPathList())
         : lang;
      mProps += wxString::Format(wxT("(putprop '*AUDACITY* \"%s\" 'LANGUAGE)\n"), lang);
 
      mProps += wxString::Format(wxT("(setf *DECIMAL-SEPARATOR* #\\%c)\n"), wxNumberFormatter::GetDecimalSeparator());
 
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-DIR* \"%s\" 'BASE)\n"), EscapeString(FileNames::BaseDir()));
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-DIR* \"%s\" 'DATA)\n"), EscapeString(FileNames::DataDir()));
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-DIR* \"%s\" 'HELP)\n"), EscapeString(FileNames::HtmlHelpDir().RemoveLast()));
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-DIR* \"%s\" 'TEMP)\n"), EscapeString(TempDirectory::TempDir()));
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-DIR* \"%s\" 'SYS-TEMP)\n"), EscapeString(wxStandardPaths::Get().GetTempDir()));
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-DIR* \"%s\" 'DOCUMENTS)\n"), EscapeString(wxStandardPaths::Get().GetDocumentsDir()));
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-DIR* \"%s\" 'HOME)\n"), EscapeString(wxGetHomeDir()));
 
      auto paths = NyquistEffect::GetNyquistSearchPath();
      wxString list;
      for (size_t i = 0, cnt = paths.size(); i < cnt; i++)
      {
         list += wxT("\"") + EscapeString(paths[i]) + wxT("\" ");
      }
      list = list.RemoveLast();
 
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-DIR* (list %s) 'PLUGIN)\n"), list);
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-DIR* (list %s) 'PLUG-IN)\n"), list);
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-DIR* \"%s\" 'USER-PLUG-IN)\n"),
                                 EscapeString(FileNames::PlugInDir()));
 
      // Date and time:
      wxDateTime now = wxDateTime::Now();
      int year = now.GetYear();
      int doy = now.GetDayOfYear();
      int dom = now.GetDay();
      // enumerated constants
      wxDateTime::Month month = now.GetMonth();
      wxDateTime::WeekDay day = now.GetWeekDay();
 
      // Date/time as a list: year, day of year, hour, minute, seconds
      mProps += wxString::Format(wxT("(setf *SYSTEM-TIME* (list %d %d %d %d %d))\n"),
                                 year, doy, now.GetHour(), now.GetMinute(), now.GetSecond());
 
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-TIME* \"%s\" 'DATE)\n"), now.FormatDate());
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-TIME* \"%s\" 'TIME)\n"), now.FormatTime());
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-TIME* \"%s\" 'ISO-DATE)\n"), now.FormatISODate());
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-TIME* \"%s\" 'ISO-TIME)\n"), now.FormatISOTime());
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-TIME* %d 'YEAR)\n"), year);
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-TIME* %d 'DAY)\n"), dom);   // day of month
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-TIME* %d 'MONTH)\n"), month);
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-TIME* \"%s\" 'MONTH-NAME)\n"), now.GetMonthName(month));
      mProps += wxString::Format(wxT("(putprop '*SYSTEM-TIME* \"%s\" 'DAY-NAME)\n"), now.GetWeekDayName(day));
 
      mProps += wxString::Format(wxT("(putprop '*PROJECT* %d 'PROJECTS)\n"),
         (int) AllProjects{}.size());
      mProps += wxString::Format(wxT("(putprop '*PROJECT* \"%s\" 'NAME)\n"), EscapeString(project->GetProjectName()));
 
      int numTracks = 0;
      int numWave = 0;
      int numLabel = 0;
      int numMidi = 0;
      int numTime = 0;
      wxString waveTrackList;   // track positions of selected audio tracks.
 
      {
         auto countRange = TrackList::Get( *project ).Leaders();
         for (auto t : countRange) {
            t->TypeSwitch( [&](const WaveTrack *) {
               numWave++;
               if (t->GetSelected())
                  waveTrackList += wxString::Format(wxT("%d "), 1 + numTracks);
            });
            numTracks++;
         }
         numLabel = countRange.Filter<const LabelTrack>().size();
   #if defined(USE_MIDI)
         numMidi = countRange.Filter<const NoteTrack>().size();
   #endif
         numTime = countRange.Filter<const TimeTrack>().size();
      }
 
      // We use Internat::ToString() rather than "%g" here because we
      // always have to use the dot as decimal separator when giving
      // numbers to Nyquist, whereas using "%g" will use the user's
      // decimal separator which may be a comma in some countries.
      mProps += wxString::Format(wxT("(putprop '*PROJECT* (float %s) 'RATE)\n"),
         Internat::ToString(ProjectRate::Get(*project).GetRate()));
      mProps += wxString::Format(wxT("(putprop '*PROJECT* %d 'TRACKS)\n"), numTracks);
      mProps += wxString::Format(wxT("(putprop '*PROJECT* %d 'WAVETRACKS)\n"), numWave);
      mProps += wxString::Format(wxT("(putprop '*PROJECT* %d 'LABELTRACKS)\n"), numLabel);
      mProps += wxString::Format(wxT("(putprop '*PROJECT* %d 'MIDITRACKS)\n"), numMidi);
      mProps += wxString::Format(wxT("(putprop '*PROJECT* %d 'TIMETRACKS)\n"), numTime);
 
      double previewLen = 6.0;
      gPrefs->Read(wxT("/AudioIO/EffectsPreviewLen"), &previewLen);
      mProps += wxString::Format(wxT("(putprop '*PROJECT* (float %s) 'PREVIEW-DURATION)\n"),
                                 Internat::ToString(previewLen));
 
      // *PREVIEWP* is true when previewing (better than relying on track view).
      wxString isPreviewing = (this->IsPreviewing())? wxT("T") : wxT("NIL");
      mProps += wxString::Format(wxT("(setf *PREVIEWP* %s)\n"), isPreviewing);
 
      mProps += wxString::Format(wxT("(putprop '*SELECTION* (float %s) 'START)\n"),
                                 Internat::ToString(mT0));
      mProps += wxString::Format(wxT("(putprop '*SELECTION* (float %s) 'END)\n"),
                                 Internat::ToString(mT1));
      mProps += wxString::Format(wxT("(putprop '*SELECTION* (list %s) 'TRACKS)\n"), waveTrackList);
      mProps += wxString::Format(wxT("(putprop '*SELECTION* %d 'CHANNELS)\n"), mNumSelectedChannels);
   }
 
   // Nyquist Prompt does not require a selection, but effects do.
   if (!bOnePassTool && (mNumSelectedChannels == 0)) {
      auto message = XO("Audio selection required.");
      EffectUIServices::DoMessageBox(*this,
         message,
         wxOK | wxCENTRE | wxICON_EXCLAMATION,
         XO("Nyquist Error") );
   }
 
   std::optional<TrackIterRange<WaveTrack>> pRange;
   if (!bOnePassTool)
      pRange.emplace(mOutputTracks->Selected< WaveTrack >() + &Track::IsLeader);
 
   // Keep track of whether the current track is first selected in its sync-lock group
   // (we have no idea what the length of the returned audio will be, so we have
   // to handle sync-lock group behavior the "old" way).
   mFirstInGroup = true;
   Track *gtLast = NULL;
 
   for (;
        bOnePassTool || pRange->first != pRange->second;
        (void) (!pRange || (++pRange->first, true))
   ) {
      // Prepare to accumulate more debug output in OutputCallback
      mDebugOutputStr = mDebugOutput.Translation();
      mDebugOutput = Verbatim( "%s" ).Format( std::cref( mDebugOutputStr ) );
 
      mCurTrack[0] = pRange ? *pRange->first : nullptr;
      mCurNumChannels = 1;
      if ( (mT1 >= mT0) || bOnePassTool ) {
         if (bOnePassTool) {
         }
         else {
            auto channels = TrackList::Channels(mCurTrack[0]);
            if (channels.size() > 1) {
               // TODO: more-than-two-channels
               // Pay attention to consistency of mNumSelectedChannels
               // with the running tally made by this loop!
               mCurNumChannels = 2;
 
               mCurTrack[1] = * ++ channels.first;
               if (mCurTrack[1]->GetRate() != mCurTrack[0]->GetRate()) {
                  EffectUIServices::DoMessageBox(*this,
                     XO(
"Sorry, cannot apply effect on stereo tracks where the tracks don't match."),
                     wxOK | wxCENTRE );
                  success = false;
                  goto finish;
               }
               mCurStart[1] = mCurTrack[1]->TimeToLongSamples(mT0);
            }
 
            // Check whether we're in the same group as the last selected track
            Track *gt = *SyncLock::Group(mCurTrack[0]).first;
            mFirstInGroup = !gtLast || (gtLast != gt);
            gtLast = gt;
 
            mCurStart[0] = mCurTrack[0]->TimeToLongSamples(mT0);
            auto end = mCurTrack[0]->TimeToLongSamples(mT1);
            mCurLen = end - mCurStart[0];
 
            if (mCurLen > NYQ_MAX_LEN) {
               float hours = (float)NYQ_MAX_LEN / (44100 * 60 * 60);
               const auto message =
                  XO(
"Selection too long for Nyquist code.\nMaximum allowed selection is %ld samples\n(about %.1f hours at 44100 Hz sample rate).")
                     .Format((long)NYQ_MAX_LEN, hours);
               EffectUIServices::DoMessageBox(*this,
                  message,
                  wxOK | wxCENTRE,
                  XO("Nyquist Error") );
               if (!mProjectChanged)
                  em.SetSkipStateFlag(true);
               return false;
            }
 
            mCurLen = std::min(mCurLen, mMaxLen);
         }
 
         mProgressIn = 0.0;
         mProgressOut = 0.0;
 
         // libnyquist breaks except in LC_NUMERIC=="C".
         //
         // Note that we must set the locale to "C" even before calling
         // nyx_init() because otherwise some effects will not work!
         //
         // MB: setlocale is not thread-safe.  Should use uselocale()
         //     if available, or fix libnyquist to be locale-independent.
         // See also http://bugzilla.audacityteam.org/show_bug.cgi?id=642#c9
         // for further info about this thread safety question.
         wxString prevlocale = wxSetlocale(LC_NUMERIC, NULL);
         wxSetlocale(LC_NUMERIC, wxString(wxT("C")));
 
         nyx_init();
         nyx_set_os_callback(StaticOSCallback, (void *)this);
         nyx_capture_output(StaticOutputCallback, (void *)this);
 
         auto cleanup = finally( [&] {
            nyx_capture_output(NULL, (void *)NULL);
            nyx_set_os_callback(NULL, (void *)NULL);
            nyx_cleanup();
         } );
 
 
         if (mVersion >= 4)
         {
            mPerTrackProps = wxEmptyString;
            wxString lowHz = wxT("nil");
            wxString highHz = wxT("nil");
            wxString centerHz = wxT("nil");
            wxString bandwidth = wxT("nil");
 
#if defined(EXPERIMENTAL_SPECTRAL_EDITING)
            if (mF0 >= 0.0) {
               lowHz.Printf(wxT("(float %s)"), Internat::ToString(mF0));
            }
 
            if (mF1 >= 0.0) {
               highHz.Printf(wxT("(float %s)"), Internat::ToString(mF1));
            }
 
            if ((mF0 >= 0.0) && (mF1 >= 0.0)) {
               centerHz.Printf(wxT("(float %s)"), Internat::ToString(sqrt(mF0 * mF1)));
            }
 
            if ((mF0 > 0.0) && (mF1 >= mF0)) {
               // with very small values, bandwidth calculation may be inf.
               // (Observed on Linux)
               double bw = log(mF1 / mF0) / log(2.0);
               if (!std::isinf(bw)) {
                  bandwidth.Printf(wxT("(float %s)"), Internat::ToString(bw));
               }
            }
 
#endif
            mPerTrackProps += wxString::Format(wxT("(putprop '*SELECTION* %s 'LOW-HZ)\n"), lowHz);
            mPerTrackProps += wxString::Format(wxT("(putprop '*SELECTION* %s 'CENTER-HZ)\n"), centerHz);
            mPerTrackProps += wxString::Format(wxT("(putprop '*SELECTION* %s 'HIGH-HZ)\n"), highHz);
            mPerTrackProps += wxString::Format(wxT("(putprop '*SELECTION* %s 'BANDWIDTH)\n"), bandwidth);
         }
 
         success = ProcessOne();
 
         // Reset previous locale
         wxSetlocale(LC_NUMERIC, prevlocale);
 
         if (!success || bOnePassTool) {
            goto finish;
         }
         mProgressTot += mProgressIn + mProgressOut;
      }
 
      mCount += mCurNumChannels;
   }
 
   if (mOutputTime > 0.0) {
      mT1 = mT0 + mOutputTime;
   }
 
finish:
 
   // Show debug window if trace set in plug-in header and something to show.
   mDebug = (mTrace && !mDebugOutput.Translation().empty())? true : mDebug;
 
   if (mDebug && !mRedirectOutput) {
      NyquistOutputDialog dlog(mUIParent, -1,
                               mName,
                               XO("Debug Output: "),
                               mDebugOutput);
      dlog.CentreOnParent();
      dlog.ShowModal();
   }
 
   // Has rug been pulled from under us by some effect done within Nyquist??
   if( !bOnePassTool && ( nEffectsSoFar == nEffectsDone ))
      ReplaceProcessedTracks(success);
   else{
      ReplaceProcessedTracks(false); // Do not use the results.
      // Selection is to be set to whatever it is in the project.
      auto project = FindProject();
      if (project) {
         auto &selectedRegion = ViewInfo::Get( *project ).selectedRegion;
         mT0 = selectedRegion.t0();
         mT1 = selectedRegion.t1();
      }
      else {
         mT0 = 0;
         mT1 = -1;
      }
 
   }
 
   if (!mProjectChanged)
      em.SetSkipStateFlag(true);
 
   return success;
}

References FileNames::AudacityPathList(), FileNames::BaseDir(), TrackList::Channels(), Effect::CopyInputTracks(), FileNames::DataDir(), Effect::Delegate(), EffectUIServices::DoMessageBox(), EffectTypeProcess, EffectTypeTool, PackedArray::end(), EscapeString(), EffectBase::FindProject(), TranslatableString::Format(), BasicUI::Get(), EffectManager::Get(), ProjectRate::Get(), ViewInfo::Get(), TrackList::Get(), Effect::GetNumWaveGroups(), GetNyquistSearchPath(), anonymous_namespace{TimeTrack.cpp}::GetRate(), ProjectRate::GetRate(), EffectWithSettings< NyquistSettings, StatefulEffect >::GetSettings(), Languages::GetSystemLanguageCode(), GetType(), gPrefs, SyncLock::Group(), FileNames::HtmlHelpDir(), Effect::IsBatchProcessing(), Track::IsLeader(), EffectBase::IsPreviewing(), TrackList::Leaders(), mBreak, mCont, mControls, mCount, mCurLen, mCurNumChannels, mCurStart, mCurTrack, mDebug, mDebugOutput, mDebugOutputStr, mFirstInGroup, mHelpFile, mHelpFileExists, min(), mInputCmd, mIsPrompt, mMaxLen, mName, mNumSelectedChannels, mOutputTime, EffectBase::mOutputTracks, mPerTrackProps, mProgressIn, mProgressOut, mProgressTot, mProjectChanged, mProps, mRedirectOutput, mReentryCount, mScale, mStop, EffectBase::mT0, EffectBase::mT1, mTrace, mTrackIndex, mUIParent, mVersion, EffectBase::nEffectsDone, NYQ_MAX_LEN, NYQUIST_WORKER_ID, FileNames::PlugInDir(), ProcessOne(), RegisterFunctions(), EffectBase::ReplaceProcessedTracks(), ViewInfo::selectedRegion, EffectManager::SetSkipStateFlag(), settings(), size, AllProjects::size(), StaticOSCallback(), StaticOutputCallback(), TempDirectory::TempDir(), SampleTrack::TimeToLongSamples(), Internat::ToString(), TranslatableString::Translation(), valueRestorer(), Verbatim(), wxT(), and XO().

Here is the call graph for this function:

ProcessOne()

bool NyquistEffect::ProcessOne ( )

private

Definition at line 1192 of file Nyquist.cpp.

{
   mpException = {};
 
   nyx_rval rval;
 
   wxString cmd;
   cmd += wxT("(snd-set-latency  0.1)");
 
   // A tool may be using AUD-DO which will potentially invalidate *TRACK*
   // so tools do not get *TRACK*.
   if (GetType() == EffectTypeTool)
      cmd += wxT("(setf S 0.25)\n");  // No Track.
   else if (mVersion >= 4) {
      nyx_set_audio_name("*TRACK*");
      cmd += wxT("(setf S 0.25)\n");
   }
   else {
      nyx_set_audio_name("S");
      cmd += wxT("(setf *TRACK* '*unbound*)\n");
   }
 
   if(mVersion >= 4) {
      cmd += mProps;
      cmd += mPerTrackProps;
   }
 
   if( (mVersion >= 4) && (GetType() != EffectTypeTool) ) {
      // Set the track TYPE and VIEW properties
      wxString type;
      wxString view;
      wxString bitFormat;
      wxString spectralEditp;
 
      mCurTrack[0]->TypeSwitch(
         [&](const WaveTrack *wt) {
            type = wxT("wave");
            spectralEditp = SpectrogramSettings::Get(*mCurTrack[0])
               .SpectralSelectionEnabled()? wxT("T") : wxT("NIL");
            view = wxT("NIL");
            // Find() not Get() to avoid creation-on-demand of views in case we are
            // only previewing
            if ( const auto pView = WaveTrackView::Find( wt ) ) {
               auto displays = pView->GetDisplays();
               auto format = [&]( decltype(displays[0]) display ) {
                  // Get the English name of the view type, without menu codes,
                  // as a string that Lisp can examine
                  return wxString::Format( wxT("\"%s\""),
                     display.name.Stripped().Debug() );
               };
               if (displays.empty())
                  ;
               else if (displays.size() == 1)
                  view = format( displays[0] );
               else {
                  view = wxT("(list");
                  for ( auto display : displays )
                     view += wxString(wxT(" ")) + format( display );
                  view += wxT(")");
               }
            }
         },
#if defined(USE_MIDI)
         [&](const NoteTrack *) {
            type = wxT("midi");
            view = wxT("\"Midi\"");
         },
#endif
         [&](const LabelTrack *) {
            type = wxT("label");
            view = wxT("\"Label\"");
         },
         [&](const TimeTrack *) {
            type = wxT("time");
            view = wxT("\"Time\"");
         }
      );
 
      cmd += wxString::Format(wxT("(putprop '*TRACK* %d 'INDEX)\n"), ++mTrackIndex);
      cmd += wxString::Format(wxT("(putprop '*TRACK* \"%s\" 'NAME)\n"), EscapeString(mCurTrack[0]->GetName()));
      cmd += wxString::Format(wxT("(putprop '*TRACK* \"%s\" 'TYPE)\n"), type);
      // Note: "View" property may change when Audacity's choice of track views has stabilized.
      cmd += wxString::Format(wxT("(putprop '*TRACK* %s 'VIEW)\n"), view);
      cmd += wxString::Format(wxT("(putprop '*TRACK* %d 'CHANNELS)\n"), mCurNumChannels);
 
      //NOTE: Audacity 2.1.3 True if spectral selection is enabled regardless of track view.
      cmd += wxString::Format(wxT("(putprop '*TRACK* %s 'SPECTRAL-EDIT-ENABLED)\n"), spectralEditp);
 
      auto channels = TrackList::Channels( mCurTrack[0] );
      double startTime = channels.min( &Track::GetStartTime );
      double endTime = channels.max( &Track::GetEndTime );
 
      cmd += wxString::Format(wxT("(putprop '*TRACK* (float %s) 'START-TIME)\n"),
                              Internat::ToString(startTime));
      cmd += wxString::Format(wxT("(putprop '*TRACK* (float %s) 'END-TIME)\n"),
                              Internat::ToString(endTime));
      cmd += wxString::Format(wxT("(putprop '*TRACK* (float %s) 'GAIN)\n"),
                              Internat::ToString(mCurTrack[0]->GetGain()));
      cmd += wxString::Format(wxT("(putprop '*TRACK* (float %s) 'PAN)\n"),
                              Internat::ToString(mCurTrack[0]->GetPan()));
      cmd += wxString::Format(wxT("(putprop '*TRACK* (float %s) 'RATE)\n"),
                              Internat::ToString(mCurTrack[0]->GetRate()));
 
      switch (mCurTrack[0]->GetSampleFormat())
      {
         case int16Sample:
            bitFormat = wxT("16");
            break;
         case int24Sample:
            bitFormat = wxT("24");
            break;
         case floatSample:
            bitFormat = wxT("32.0");
            break;
      }
      cmd += wxString::Format(wxT("(putprop '*TRACK* %s 'FORMAT)\n"), bitFormat);
 
      float maxPeakLevel = 0.0;  // Deprecated as of 2.1.3
      wxString clips, peakString, rmsString;
      for (size_t i = 0; i < mCurNumChannels; i++) {
         auto ca = mCurTrack[i]->SortedClipArray();
         float maxPeak = 0.0;
 
         // A list of clips for mono, or an array of lists for multi-channel.
         if (mCurNumChannels > 1) {
            clips += wxT("(list ");
         }
         // Each clip is a list (start-time, end-time)
         // Limit number of clips added to avoid argument stack overflow error (bug 2300).
         for (size_t i=0; i<ca.size(); i++) {
            if (i < 1000) {
               clips += wxString::Format(wxT("(list (float %s) (float %s))"),
                                         Internat::ToString(ca[i]->GetPlayStartTime()),
                                         Internat::ToString(ca[i]->GetPlayEndTime()));
            } else if (i == 1000) {
               // If final clip is NIL, plug-in developer knows there are more than 1000 clips in channel.
               clips += "NIL";
            } else if (i > 1000) {
               break;
            }
         }
         if (mCurNumChannels > 1) clips += wxT(" )");
 
         float min, max;
         auto pair = mCurTrack[i]->GetMinMax(mT0, mT1); // may throw
         min = pair.first, max = pair.second;
         maxPeak = wxMax(wxMax(fabs(min), fabs(max)), maxPeak);
         maxPeakLevel = wxMax(maxPeakLevel, maxPeak);
 
         // On Debian, NaN samples give maxPeak = 3.40282e+38 (FLT_MAX)
         if (!std::isinf(maxPeak) && !std::isnan(maxPeak) && (maxPeak < FLT_MAX)) {
            peakString += wxString::Format(wxT("(float %s) "), Internat::ToString(maxPeak));
         } else {
            peakString += wxT("nil ");
         }
 
         float rms = mCurTrack[i]->GetRMS(mT0, mT1); // may throw
         if (!std::isinf(rms) && !std::isnan(rms)) {
            rmsString += wxString::Format(wxT("(float %s) "), Internat::ToString(rms));
         } else {
            rmsString += wxT("NIL ");
         }
      }
      // A list of clips for mono, or an array of lists for multi-channel.
      cmd += wxString::Format(wxT("(putprop '*TRACK* %s%s ) 'CLIPS)\n"),
                              (mCurNumChannels == 1) ? wxT("(list ") : wxT("(vector "),
                              clips);
 
      (mCurNumChannels > 1)?
         cmd += wxString::Format(wxT("(putprop '*SELECTION* (vector %s) 'PEAK)\n"), peakString) :
         cmd += wxString::Format(wxT("(putprop '*SELECTION* %s 'PEAK)\n"), peakString);
 
      if (!std::isinf(maxPeakLevel) && !std::isnan(maxPeakLevel) && (maxPeakLevel < FLT_MAX)) {
         cmd += wxString::Format(wxT("(putprop '*SELECTION* (float %s) 'PEAK-LEVEL)\n"),
                                 Internat::ToString(maxPeakLevel));
      }
 
      (mCurNumChannels > 1)?
         cmd += wxString::Format(wxT("(putprop '*SELECTION* (vector %s) 'RMS)\n"), rmsString) :
         cmd += wxString::Format(wxT("(putprop '*SELECTION* %s 'RMS)\n"), rmsString);
   }
 
   // If in tool mode, then we don't do anything with the track and selection.
   if (GetType() == EffectTypeTool) {
      nyx_set_audio_params(44100, 0);
   }
   else if (GetType() == EffectTypeGenerate) {
      nyx_set_audio_params(mCurTrack[0]->GetRate(), 0);
   }
   else {
      auto curLen = mCurLen.as_long_long();
      nyx_set_audio_params(mCurTrack[0]->GetRate(), curLen);
 
      nyx_set_input_audio(StaticGetCallback, (void *)this,
                          (int)mCurNumChannels,
                          curLen, mCurTrack[0]->GetRate());
   }
 
   // Restore the Nyquist sixteenth note symbol for Generate plug-ins.
   // See http://bugzilla.audacityteam.org/show_bug.cgi?id=490.
   if (GetType() == EffectTypeGenerate) {
      cmd += wxT("(setf s 0.25)\n");
   }
 
   if (mDebug || mTrace) {
      cmd += wxT("(setf *tracenable* T)\n");
      if (mExternal) {
         cmd += wxT("(setf *breakenable* T)\n");
      }
   }
   else {
      // Explicitly disable backtrace and prevent values
      // from being carried through to the output.
      // This should be the final command before evaluating the Nyquist script.
      cmd += wxT("(setf *tracenable* NIL)\n");
   }
 
   for (unsigned int j = 0; j < mControls.size(); j++) {
      if (mControls[j].type == NYQ_CTRL_FLOAT || mControls[j].type == NYQ_CTRL_FLOAT_TEXT ||
          mControls[j].type == NYQ_CTRL_TIME) {
         // We use Internat::ToString() rather than "%f" here because we
         // always have to use the dot as decimal separator when giving
         // numbers to Nyquist, whereas using "%f" will use the user's
         // decimal separator which may be a comma in some countries.
         cmd += wxString::Format(wxT("(setf %s %s)\n"),
                                 mControls[j].var,
                                 Internat::ToString(mControls[j].val, 14));
      }
      else if (mControls[j].type == NYQ_CTRL_INT ||
            mControls[j].type == NYQ_CTRL_INT_TEXT ||
            mControls[j].type == NYQ_CTRL_CHOICE) {
         cmd += wxString::Format(wxT("(setf %s %d)\n"),
                                 mControls[j].var,
                                 (int)(mControls[j].val));
      }
      else if (mControls[j].type == NYQ_CTRL_STRING || mControls[j].type == NYQ_CTRL_FILE) {
         cmd += wxT("(setf ");
         // restrict variable names to 7-bit ASCII:
         cmd += mControls[j].var;
         cmd += wxT(" \"");
         cmd += EscapeString(mControls[j].valStr); // unrestricted value will become quoted UTF-8
         cmd += wxT("\")\n");
      }
   }
 
   if (mIsSal) {
      wxString str = EscapeString(mCmd);
      // this is tricky: we need SAL to call main so that we can get a
      // SAL traceback in the event of an error (sal-compile catches the
      // error and calls sal-error-output), but SAL does not return values.
      // We will catch the value in a special global aud:result and if no
      // error occurs, we will grab the value with a LISP expression
      str += wxT("\nset aud:result = main()\n");
 
      if (mDebug || mTrace) {
         // since we're about to evaluate SAL, remove LISP trace enable and
         // break enable (which stops SAL processing) and turn on SAL stack
         // trace
         cmd += wxT("(setf *tracenable* nil)\n");
         cmd += wxT("(setf *breakenable* nil)\n");
         cmd += wxT("(setf *sal-traceback* t)\n");
      }
 
      if (mCompiler) {
         cmd += wxT("(setf *sal-compiler-debug* t)\n");
      }
 
      cmd += wxT("(setf *sal-call-stack* nil)\n");
      // if we do not set this here and an error occurs in main, another
      // error will be raised when we try to return the value of aud:result
      // which is unbound
      cmd += wxT("(setf aud:result nil)\n");
      cmd += wxT("(sal-compile-audacity \"") + str + wxT("\" t t nil)\n");
      // Capture the value returned by main (saved in aud:result), but
      // set aud:result to nil so sound results can be evaluated without
      // retaining audio in memory
      cmd += wxT("(prog1 aud:result (setf aud:result nil))\n");
   }
   else {
      cmd += mCmd;
   }
 
   // Put the fetch buffers in a clean initial state
   for (size_t i = 0; i < mCurNumChannels; i++)
      mCurBuffer[i].reset();
 
   // Guarantee release of memory when done
   auto cleanup = finally( [&] {
      for (size_t i = 0; i < mCurNumChannels; i++)
         mCurBuffer[i].reset();
   } );
 
   // Evaluate the expression, which may invoke the get callback, but often does
   // not, leaving that to delayed evaluation of the output sound
   rval = nyx_eval_expression(cmd.mb_str(wxConvUTF8));
 
   // If we're not showing debug window, log errors and warnings:
   const auto output = mDebugOutput.Translation();
   if (!output.empty() && !mDebug && !mTrace) {
      /* i18n-hint: An effect "returned" a message.*/
      wxLogMessage(wxT("\'%s\' returned:\n%s"),
         mName.Translation(), output);
   }
 
   // Audacity has no idea how long Nyquist processing will take, but
   // can monitor audio being returned.
   // Anything other than audio should be returned almost instantly
   // so notify the user that process has completed (bug 558)
   if ((rval != nyx_audio) && ((mCount + mCurNumChannels) == mNumSelectedChannels)) {
      if (mCurNumChannels == 1) {
         TrackProgress(mCount, 1.0, XO("Processing complete."));
      }
      else {
         TrackGroupProgress(mCount, 1.0, XO("Processing complete."));
      }
   }
 
   if ((rval == nyx_audio) && (GetType() == EffectTypeTool)) {
      // Catch this first so that we can also handle other errors.
      mDebugOutput =
         /* i18n-hint: Don't translate ';type tool'.  */
         XO("';type tool' effects cannot return audio from Nyquist.\n")
         + mDebugOutput;
      rval = nyx_error;
   }
 
   if ((rval == nyx_labels) && (GetType() == EffectTypeTool)) {
      // Catch this first so that we can also handle other errors.
      mDebugOutput =
         /* i18n-hint: Don't translate ';type tool'.  */
         XO("';type tool' effects cannot return labels from Nyquist.\n")
         + mDebugOutput;
      rval = nyx_error;
   }
 
   if (rval == nyx_error) {
      // Return value is not valid type.
      // Show error in debug window if trace enabled, otherwise log.
      if (mTrace) {
         /* i18n-hint: "%s" is replaced by name of plug-in.*/
         mDebugOutput = XO("nyx_error returned from %s.\n")
            .Format( mName.empty() ? XO("plug-in") : mName )
         + mDebugOutput;
         mDebug = true;
      }
      else {
         wxLogMessage(
            "Nyquist returned nyx_error:\n%s", mDebugOutput.Translation());
      }
      return false;
   }
 
   if (rval == nyx_list) {
      wxLogMessage("Nyquist returned nyx_list");
      if (GetType() == EffectTypeTool) {
         mProjectChanged = true;
      } else {
         EffectUIServices::DoMessageBox(*this,
            XO("Nyquist returned a list.") );
      }
      return true;
   }
 
   if (rval == nyx_string) {
      // Assume the string has already been translated within the Lisp runtime
      // if necessary, by one of the gettext functions defined below, before it
      // is communicated back to C++
      auto msg = Verbatim( NyquistToWxString(nyx_get_string()) );
      if (!msg.empty()) { // Empty string may be used as a No-Op return value.
         EffectUIServices::DoMessageBox(*this, msg);
      }
      else if (GetType() == EffectTypeTool) {
         // ;tools may change the project with aud-do commands so
         // it is essential that the state is added to history.
         mProjectChanged = true;
         return true;
      }
      else {
         // A true no-op.
         return true;
      }
 
      // True if not process type.
      // If not returning audio from process effect,
      // return first result then stop (disables preview)
      // but allow all output from Nyquist Prompt.
      return (GetType() != EffectTypeProcess || mIsPrompt);
   }
 
   if (rval == nyx_double) {
      auto str = XO("Nyquist returned the value: %f")
         .Format(nyx_get_double());
      EffectUIServices::DoMessageBox(*this, str);
      return (GetType() != EffectTypeProcess || mIsPrompt);
   }
 
   if (rval == nyx_int) {
      auto str = XO("Nyquist returned the value: %d")
         .Format(nyx_get_int());
      EffectUIServices::DoMessageBox(*this, str);
      return (GetType() != EffectTypeProcess || mIsPrompt);
   }
 
   if (rval == nyx_labels) {
      mProjectChanged = true;
      unsigned int numLabels = nyx_get_num_labels();
      unsigned int l;
      auto ltrack = * mOutputTracks->Any< LabelTrack >().begin();
      if (!ltrack) {
         auto newTrack = std::make_shared<LabelTrack>();
         //new track name should be unique among the names in the list of input tracks, not output
         newTrack->SetName(inputTracks()->MakeUniqueTrackName(LabelTrack::GetDefaultName()));
         ltrack = static_cast<LabelTrack*>(
            AddToOutputTracks(newTrack));
      }
 
      for (l = 0; l < numLabels; l++) {
         double t0, t1;
         const char *str;
 
         // PRL:  to do:
         // let Nyquist analyzers define more complicated selections
         nyx_get_label(l, &t0, &t1, &str);
 
         ltrack->AddLabel(SelectedRegion(t0 + mT0, t1 + mT0), UTF8CTOWX(str));
      }
      return (GetType() != EffectTypeProcess || mIsPrompt);
   }
 
   wxASSERT(rval == nyx_audio);
 
   int outChannels = nyx_get_audio_num_channels();
   if (outChannels > (int)mCurNumChannels) {
      EffectUIServices::DoMessageBox(*this,
         XO("Nyquist returned too many audio channels.\n"));
      return false;
   }
 
   if (outChannels == -1) {
      EffectUIServices::DoMessageBox(*this,
         XO("Nyquist returned one audio channel as an array.\n"));
      return false;
   }
 
   if (outChannels == 0) {
      EffectUIServices::DoMessageBox(*this,
         XO("Nyquist returned an empty array.\n"));
      return false;
   }
 
   std::shared_ptr<WaveTrack> outputTrack[2];
 
   double rate = mCurTrack[0]->GetRate();
   for (int i = 0; i < outChannels; i++) {
      if (outChannels == (int)mCurNumChannels) {
         rate = mCurTrack[i]->GetRate();
      }
 
      outputTrack[i] = mCurTrack[i]->EmptyCopy();
      outputTrack[i]->SetRate( rate );
 
      // Clean the initial buffer states again for the get callbacks
      // -- is this really needed?
      mCurBuffer[i].reset();
   }
 
   // Now fully evaluate the sound
   int success;
   {
      auto vr0 = valueRestorer( mOutputTrack[0], outputTrack[0].get() );
      auto vr1 = valueRestorer( mOutputTrack[1], outputTrack[1].get() );
      success = nyx_get_audio(StaticPutCallback, (void *)this);
   }
 
   // See if GetCallback found read errors
   {
      auto pException = mpException;
      mpException = {};
      if (pException)
         std::rethrow_exception( pException );
   }
 
   if (!success)
      return false;
 
   for (int i = 0; i < outChannels; i++) {
      outputTrack[i]->Flush();
      mOutputTime = outputTrack[i]->GetEndTime();
 
      if (mOutputTime <= 0) {
         EffectUIServices::DoMessageBox(
            *this, XO("Nyquist returned nil audio.\n"));
         return false;
      }
   }
 
   for (size_t i = 0; i < mCurNumChannels; i++) {
      WaveTrack *out;
 
      if (outChannels == (int)mCurNumChannels) {
         out = outputTrack[i].get();
      }
      else {
         out = outputTrack[0].get();
      }
 
      if (mMergeClips < 0) {
         // Use sample counts to determine default behaviour - times will rarely be equal.
         bool bMergeClips = (out->TimeToLongSamples(mT0) + out->TimeToLongSamples(mOutputTime) ==
                                                                     out->TimeToLongSamples(mT1));
         mCurTrack[i]->ClearAndPaste(mT0, mT1, out, mRestoreSplits, bMergeClips);
      }
      else {
         mCurTrack[i]->ClearAndPaste(mT0, mT1, out, mRestoreSplits, mMergeClips != 0);
      }
 
      // If we were first in the group adjust non-selected group tracks
      if (mFirstInGroup) {
         for (auto t : SyncLock::Group(mCurTrack[i]))
         {
            if (!t->GetSelected() && SyncLock::IsSyncLockSelected(t)) {
               t->SyncLockAdjust(mT1, mT0 + out->GetEndTime());
            }
         }
      }
 
      // Only the first channel can be first in its group
      mFirstInGroup = false;
   }
 
   mProjectChanged = true;
   return true;
}

References Effect::AddToOutputTracks(), sampleCount::as_long_long(), PackedArray::begin(), TrackList::Channels(), WaveTrack::ClearAndPaste(), EffectUIServices::DoMessageBox(), EffectTypeGenerate, EffectTypeProcess, EffectTypeTool, TranslatableString::empty(), WaveTrack::EmptyCopy(), EscapeString(), WaveTrackView::Find(), floatSample, format, SpectrogramSettings::Get(), LabelTrack::GetDefaultName(), Track::GetEndTime(), WaveTrack::GetEndTime(), WaveTrack::GetMinMax(), ComponentInterface::GetName(), anonymous_namespace{TimeTrack.cpp}::GetRate(), WaveTrack::GetRate(), WaveTrack::GetRMS(), Track::GetStartTime(), GetType(), SyncLock::Group(), EffectBase::inputTracks(), int16Sample, int24Sample, SyncLock::IsSyncLockSelected(), mCmd, mCompiler, mControls, mCount, mCurBuffer, mCurLen, mCurNumChannels, mCurTrack, mDebug, mDebugOutput, mExternal, mFirstInGroup, min(), mIsPrompt, mIsSal, mMergeClips, mName, mNumSelectedChannels, mOutputTime, mOutputTrack, EffectBase::mOutputTracks, mPerTrackProps, mpException, mProjectChanged, mProps, mRestoreSplits, EffectBase::mT0, EffectBase::mT1, mTrace, mTrackIndex, mVersion, NYQ_CTRL_CHOICE, NYQ_CTRL_FILE, NYQ_CTRL_FLOAT, NYQ_CTRL_FLOAT_TEXT, NYQ_CTRL_INT, NYQ_CTRL_INT_TEXT, NYQ_CTRL_STRING, NYQ_CTRL_TIME, NyquistToWxString(), WaveTrack::SortedClipArray(), SpectrogramSettings::SpectralSelectionEnabled(), StaticGetCallback(), StaticPutCallback(), str, SampleTrack::TimeToLongSamples(), Internat::ToString(), Effect::TrackGroupProgress(), Effect::TrackProgress(), TranslatableString::Translation(), Track::TypeSwitch(), UTF8CTOWX, valueRestorer(), Verbatim(), wxT(), and XO().

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

PutCallback()

int NyquistEffect::PutCallback ( float *  buffer, int  channel, int64_t  start, int64_t  len, int64_t  totlen  )

private

Definition at line 2587 of file Nyquist.cpp.

{
   // Don't let C++ exceptions propagate through the Nyquist library
   return GuardedCall<int>( [&] {
      if (channel == 0) {
         double progress = mScale*((float)(start+len)/totlen);
 
         if (progress > mProgressOut) {
            mProgressOut = progress;
         }
 
         if (TotalProgress(mProgressIn+mProgressOut+mProgressTot)) {
            return -1;
         }
      }
 
      mOutputTrack[channel]->Append((samplePtr)buffer, floatSample, len);
 
      return 0; // success
   }, MakeSimpleGuard( -1 ) ); // translate all exceptions into failure
}

References WaveTrack::Append(), floatSample, MakeSimpleGuard(), mOutputTrack, mProgressIn, mProgressOut, mProgressTot, mScale, and Effect::TotalProgress().

Referenced by StaticPutCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

RedirectOutput()

void NyquistEffect::RedirectOutput

(

)

Definition at line 1851 of file Nyquist.cpp.

{
   mRedirectOutput = true;
}

References mRedirectOutput.

Referenced by NyqBench::OnGo().

Here is the caller graph for this function:

resolveFilePath()

void NyquistEffect::resolveFilePath ( wxString &  path, FileExtension  extension = {}  )

staticprivate

A file path given to Nyquist may be a platform-independent canonicalized form using certain abbreviations that are expanded into the platform-dependent equivalent.

If the path names only a directory, also append "/untitled" plus extension

Definition at line 3312 of file Nyquist.cpp.

{
#if defined(__WXMSW__)
   path.Replace("/", wxFileName::GetPathSeparator());
#endif
 
   path.Trim(true).Trim(false);
 
   typedef std::unordered_map<wxString, FilePath> map;
   map pathKeys = {
      {"*home*", wxGetHomeDir()},
      {"~", wxGetHomeDir()},
      {"*default*", FileNames::DefaultToDocumentsFolder("").GetPath()},
      {"*export*", FileNames::FindDefaultPath(FileNames::Operation::Export)},
      {"*save*", FileNames::FindDefaultPath(FileNames::Operation::Save)},
      {"*config*", FileNames::DataDir()}
   };
 
   int characters = path.Find(wxFileName::GetPathSeparator());
   if(characters == wxNOT_FOUND) // Just a path or just a file name
   {
      if (path.empty())
         path = "*default*";
 
      if (pathKeys.find(path) != pathKeys.end())
      {
         // Keyword found, so assume this is the intended directory.
         path = pathKeys[path] + wxFileName::GetPathSeparator();
      }
      else  // Just a file name
      {
         path = pathKeys["*default*"] + wxFileName::GetPathSeparator() + path;
      }
   }
   else  // path + file name
   {
      wxString firstDir = path.Left(characters);
      wxString rest = path.Mid(characters);
 
      if (pathKeys.find(firstDir) != pathKeys.end())
      {
         path = pathKeys[firstDir] + rest;
      }
   }
 
   wxFileName fname = path;
 
   // If the directory is invalid, better to leave it as is (invalid) so that
   // the user sees the error rather than an unexpected file path.
   if (fname.wxFileName::IsOk() && fname.GetFullName().empty())
   {
      path = fname.GetPathWithSep() + _("untitled");
      if (!extension.empty())
         path = path + '.' + extension;
   }
}

References _, FileNames::DataDir(), FileNames::DefaultToDocumentsFolder(), and FileNames::FindDefaultPath().

Referenced by BuildEffectWindow(), OnFileButton(), SaveSettings(), and TransferDataFromEffectWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

SaveSettings()

bool NyquistEffect::SaveSettings ( const EffectSettings &  settings, CommandParameters &  parms  ) const

overridevirtual

Store settings as keys and values.

The override may assume parms is initially empty

Returns

true on success

Implements EffectSettingsManager.

Definition at line 372 of file Nyquist.cpp.

{
   if (mIsPrompt)
   {
      parms.Write(KEY_Command, mInputCmd);
      parms.Write(KEY_Parameters, mParameters);
 
      return true;
   }
 
   for (size_t c = 0, cnt = mControls.size(); c < cnt; c++)
   {
      const NyqControl & ctrl = mControls[c];
      double d = ctrl.val;
 
      if (d == UNINITIALIZED_CONTROL && ctrl.type != NYQ_CTRL_STRING)
      {
         d = GetCtrlValue(ctrl.valStr);
      }
 
      if (ctrl.type == NYQ_CTRL_FLOAT || ctrl.type == NYQ_CTRL_FLOAT_TEXT ||
          ctrl.type == NYQ_CTRL_TIME)
      {
         parms.Write(ctrl.var, d);
      }
      else if (ctrl.type == NYQ_CTRL_INT || ctrl.type == NYQ_CTRL_INT_TEXT)
      {
         parms.Write(ctrl.var, (int) d);
      }
      else if (ctrl.type == NYQ_CTRL_CHOICE)
      {
         // untranslated
         parms.WriteEnum(ctrl.var, (int) d,
                         ctrl.choices.data(), ctrl.choices.size());
      }
      else if (ctrl.type == NYQ_CTRL_STRING)
      {
         parms.Write(ctrl.var, ctrl.valStr);
      }
      else if (ctrl.type == NYQ_CTRL_FILE)
      {
         // Convert the given path string to platform-dependent equivalent
         resolveFilePath(const_cast<wxString&>(ctrl.valStr));
         parms.Write(ctrl.var, ctrl.valStr);
      }
   }
 
   return true;
}

References NyqControl::choices, GetCtrlValue(), KEY_Command, KEY_Parameters, mControls, mInputCmd, mIsPrompt, mParameters, NYQ_CTRL_CHOICE, NYQ_CTRL_FILE, NYQ_CTRL_FLOAT, NYQ_CTRL_FLOAT_TEXT, NYQ_CTRL_INT, NYQ_CTRL_INT_TEXT, NYQ_CTRL_STRING, NYQ_CTRL_TIME, resolveFilePath(), NyqControl::type, UNINITIALIZED_CONTROL, NyqControl::val, NyqControl::valStr, NyqControl::var, and CommandParameters::WriteEnum().

Referenced by ShowHostInterface(), and VisitSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

SetCommand()

void NyquistEffect::SetCommand

(

const wxString &

cmd

)

Definition at line 1856 of file Nyquist.cpp.

{
   mExternal = true;
 
   if (cmd.size()) {
      ParseCommand(cmd);
   }
}

References mExternal, and ParseCommand().

Referenced by NyqBench::OnGo(), and ShowHostInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

SetLispVarsFromParameters()

int NyquistEffect::SetLispVarsFromParameters	(	const CommandParameters &	parms,
		bool	bTestOnly
	)

Definition at line 496 of file Nyquist.cpp.

{
   int badCount = 0;
   // First pass verifies values
   for (size_t c = 0, cnt = mControls.size(); c < cnt; c++)
   {
      NyqControl & ctrl = mControls[c];
      bool good = false;
 
      // This GetCtrlValue code is preserved from former code,
      // but probably is pointless.  The value d isn't used later,
      // and GetCtrlValue does not appear to have important needed
      // side effects.
      if (!bTestOnly) {
         double d = ctrl.val;
         if (d == UNINITIALIZED_CONTROL && ctrl.type != NYQ_CTRL_STRING)
         {
            d = GetCtrlValue(ctrl.valStr);
         }
      }
 
      if (ctrl.type == NYQ_CTRL_FLOAT || ctrl.type == NYQ_CTRL_FLOAT_TEXT ||
         ctrl.type == NYQ_CTRL_TIME)
      {
         double val;
         good = parms.Read(ctrl.var, &val) &&
            val >= ctrl.low &&
            val <= ctrl.high;
         if (good && !bTestOnly)
            ctrl.val = val;
      }
      else if (ctrl.type == NYQ_CTRL_INT || ctrl.type == NYQ_CTRL_INT_TEXT)
      {
         int val;
         good = parms.Read(ctrl.var, &val) &&
            val >= ctrl.low &&
            val <= ctrl.high;
         if (good && !bTestOnly)
            ctrl.val = (double)val;
      }
      else if (ctrl.type == NYQ_CTRL_CHOICE)
      {
         int val;
         // untranslated
         good = parms.ReadEnum(ctrl.var, &val,
            ctrl.choices.data(), ctrl.choices.size()) &&
            val != wxNOT_FOUND;
         if (good && !bTestOnly)
            ctrl.val = (double)val;
      }
      else if (ctrl.type == NYQ_CTRL_STRING || ctrl.type == NYQ_CTRL_FILE)
      {
         wxString val;
         good = parms.Read(ctrl.var, &val);
         if (good && !bTestOnly)
            ctrl.valStr = val;
      }
      else if (ctrl.type == NYQ_CTRL_TEXT)
      {
         // This "control" is just fixed text (nothing to save or restore),
         // Does not count for good/bad counting.
         good = true;
      }
      badCount += !good ? 1 : 0;
   }
   return badCount;
}

References NyqControl::choices, GetCtrlValue(), NyqControl::high, NyqControl::low, mControls, NYQ_CTRL_CHOICE, NYQ_CTRL_FILE, NYQ_CTRL_FLOAT, NYQ_CTRL_FLOAT_TEXT, NYQ_CTRL_INT, NYQ_CTRL_INT_TEXT, NYQ_CTRL_STRING, NYQ_CTRL_TEXT, NYQ_CTRL_TIME, CommandParameters::ReadEnum(), NyqControl::type, UNINITIALIZED_CONTROL, NyqControl::val, NyqControl::valStr, and NyqControl::var.

Referenced by DoLoadSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

ShowHostInterface()

int NyquistEffect::ShowHostInterface ( EffectPlugin &  plugin, wxWindow &  parent, const EffectDialogFactory &  factory, std::shared_ptr< EffectInstance > &  pInstance, EffectSettingsAccess &  access, bool  forceModal = false  )

overridevirtual

The only non-const member function, it usually applies factory to plugin and self and given access

But there are a few unusual overrides for historical reasons that may ignore the factory.

Parameters

pInstance	may be passed to factory, and is only guaranteed to have lifetime suitable for a modal dialog, unless the dialog stores a copy of pInstance
access	is only guaranteed to have lifetime suitable for a modal dialog, unless the dialog stores access.shared_from_this()

Returns

0 if destructive effect processing should not proceed (and there may be a non-modal dialog still opened); otherwise, modal dialog return code

Reimplemented from EffectUIServices.

Definition at line 1057 of file Nyquist.cpp.

{
   int res = wxID_APPLY;
   if (!(Effect::TestUIFlags(EffectManager::kRepeatNyquistPrompt) && mIsPrompt)) {
      // Show the normal (prompt or effect) interface
      res = EffectUIServices::ShowHostInterface(plugin,
         parent, factory, pInstance, access, forceModal);
   }
 
 
   // Remember if the user clicked debug
   mDebug = (res == eDebugID);
 
   // We're done if the user clicked "Close", we are not the Nyquist Prompt,
   // or the program currently loaded into the prompt doesn't have a UI.
   if (!res || !mIsPrompt || mControls.size() == 0 || !pInstance)
      return res;
 
   // Nyquist prompt was OK, but gave us some magic ;control comments to
   // reinterpret into a second dialog
 
   NyquistEffect effect(NYQUIST_WORKER_ID);
   effect.SetCommand(mInputCmd);
   Finally Do{[&]{
      // A second dialog will use effect as a pushed event handler.
      // wxWidgets delays window destruction until idle time.
      // Yield to destroy the dialog while effect is still in scope.
      BasicUI::Yield();
   }};
 
   // Must give effect its own settings to interpret, not those in access
   // Let's also give it its own instance
   auto newSettings = effect.MakeSettings();
   auto pNewInstance = effect.MakeInstance();
   auto newAccess = std::make_shared<SimpleEffectSettingsAccess>(newSettings);
 
   if (IsBatchProcessing()) {
      effect.SetBatchProcessing();
 
      CommandParameters cp;
      cp.SetParameters(mParameters);
      effect.LoadSettings(cp, newSettings);
 
      // Show the normal (prompt or effect) interface
      // Don't pass this as first argument, pass the worker to itself
      res = effect.ShowHostInterface(effect,
         parent, factory, pNewInstance, *newAccess, forceModal);
      if (res) {
         CommandParameters cp;
         effect.SaveSettings(newSettings, cp);
         cp.GetParameters(mParameters);
      }
   }
   else {
      if (!factory)
         return 0;
      // Don't pass this as first argument, pass the worker to itself
      res = effect.ShowHostInterface(effect,
         parent, factory, pNewInstance, *newAccess, false );
      if (!res)
         return 0;
 
      // Wrap the new settings in the old settings
      access.ModifySettings([&](EffectSettings &settings){
         auto &nyquistSettings = GetSettings(settings);
         nyquistSettings.proxySettings = std::move(newSettings);
         nyquistSettings.proxyDebug = this->mDebug;
         nyquistSettings.controls = move(effect.mControls);
         return nullptr;
      });
   }
   if (!pNewInstance)
      // Propagate the failure from nested ShowHostInterface
      pInstance.reset();
   return res;
}

References eDebugID, cloud::factory, CommandParameters::GetParameters(), EffectWithSettings< NyquistSettings, StatefulEffect >::GetSettings(), Effect::IsBatchProcessing(), EffectManager::kRepeatNyquistPrompt, LoadSettings(), StatefulEffect::MakeInstance(), EffectWithSettings< Settings, Base >::MakeSettings(), mControls, mDebug, mInputCmd, mIsPrompt, EffectSettingsAccess::ModifySettings(), mParameters, NYQUIST_WORKER_ID, SaveSettings(), Effect::SetBatchProcessing(), SetCommand(), CommandParameters::SetParameters(), settings(), EffectUIServices::ShowHostInterface(), ShowHostInterface(), Effect::TestUIFlags(), and BasicUI::Yield().

Referenced by ShowHostInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

StaticGetCallback()

int NyquistEffect::StaticGetCallback ( float *  buffer, int  channel, int64_t  start, int64_t  len, int64_t  totlen, void *  userdata  )

staticprivate

Definition at line 2512 of file Nyquist.cpp.

{
   NyquistEffect *This = (NyquistEffect *)userdata;
   return This->GetCallback(buffer, channel, start, len, totlen);
}

References GetCallback().

Referenced by ProcessOne().

Here is the call graph for this function:

Here is the caller graph for this function:

StaticOSCallback()

void NyquistEffect::StaticOSCallback ( void *  userdata )

staticprivate

Definition at line 2626 of file Nyquist.cpp.

{
   ((NyquistEffect *)This)->OSCallback();
}

Referenced by Process().

Here is the caller graph for this function:

StaticOutputCallback()

void NyquistEffect::StaticOutputCallback ( int  c, void *  userdata  )

staticprivate

Definition at line 2610 of file Nyquist.cpp.

{
   ((NyquistEffect *)This)->OutputCallback(c);
}

Referenced by Process().

Here is the caller graph for this function:

StaticPutCallback()

int NyquistEffect::StaticPutCallback ( float *  buffer, int  channel, int64_t  start, int64_t  len, int64_t  totlen, void *  userdata  )

staticprivate

Definition at line 2579 of file Nyquist.cpp.

{
   NyquistEffect *This = (NyquistEffect *)userdata;
   return This->PutCallback(buffer, channel, start, len, totlen);
}

References PutCallback().

Referenced by ProcessOne().

Here is the call graph for this function:

Here is the caller graph for this function:

Stop()

void NyquistEffect::Stop

(

)

Definition at line 1875 of file Nyquist.cpp.

{
   mStop = true;
}

References mStop.

Referenced by NyqBench::OnStop().

Here is the caller graph for this function:

ToTimeFormat()

wxString NyquistEffect::ToTimeFormat ( double  t )

private

Definition at line 3382 of file Nyquist.cpp.

{
   int seconds = static_cast<int>(t);
   int hh = seconds / 3600;
   int mm = seconds % 3600;
   mm = mm / 60;
   return wxString::Format("%d:%d:%.3f", hh, mm, t - (hh * 3600 + mm * 60));
}

Referenced by OnTime().

Here is the caller graph for this function:

TransferDataFromEffectWindow()

bool NyquistEffect::TransferDataFromEffectWindow ( )

private

Definition at line 2740 of file Nyquist.cpp.

{
   if (mControls.size() == 0)
   {
      return true;
   }
 
   for (unsigned int i = 0; i < mControls.size(); i++)
   {
      NyqControl *ctrl = &mControls[i];
 
      if (ctrl->type == NYQ_CTRL_STRING || ctrl->type == NYQ_CTRL_TEXT)
      {
         continue;
      }
 
      if (ctrl->val == UNINITIALIZED_CONTROL)
      {
         ctrl->val = GetCtrlValue(ctrl->valStr);
      }
 
      if (ctrl->type == NYQ_CTRL_CHOICE)
      {
         continue;
      }
 
      if (ctrl->type == NYQ_CTRL_FILE)
      {
         resolveFilePath(ctrl->valStr);
 
         wxString path;
         if (ctrl->valStr.StartsWith("\"", &path))
         {
            // Validate if a list of quoted paths.
            if (path.EndsWith("\"", &path))
            {
               path.Replace("\"\"", "\"");
               wxStringTokenizer tokenizer(path, "\"");
               while (tokenizer.HasMoreTokens())
               {
                  wxString token = tokenizer.GetNextToken();
                  if(!validatePath(token))
                  {
                     const auto message =
                        XO("\"%s\" is not a valid file path.").Format( token );
                     EffectUIServices::DoMessageBox(*this,
                        message,
                        wxOK | wxICON_EXCLAMATION | wxCENTRE,
                        XO("Error") );
                     return false;
                  }
               }
               continue;
            }
            else
            {
               const auto message =
                  /* i18n-hint: Warning that there is one quotation mark rather than a pair.*/
                  XO("Mismatched quotes in\n%s").Format( ctrl->valStr );
               EffectUIServices::DoMessageBox(*this,
                  message,
                  wxOK | wxICON_EXCLAMATION | wxCENTRE,
                  XO("Error") );
               return false;
            }
         }
         // Validate a single path.
         else if (validatePath(ctrl->valStr))
         {
            continue;
         }
 
         // Validation failed
         const auto message =
            XO("\"%s\" is not a valid file path.").Format( ctrl->valStr );
         EffectUIServices::DoMessageBox(*this,
            message,
            wxOK | wxICON_EXCLAMATION | wxCENTRE,
            XO("Error") );
         return false;
      }
 
      if (ctrl->type == NYQ_CTRL_TIME)
      {
         NumericTextCtrl *n = (NumericTextCtrl *) mUIParent->FindWindow(ID_Time + i);
         ctrl->val = n->GetValue();
      }
 
      if (ctrl->type == NYQ_CTRL_INT_TEXT && ctrl->lowStr.IsSameAs(wxT("nil"), false)) {
         ctrl->low = INT_MIN;
      }
      else if ((ctrl->type == NYQ_CTRL_FLOAT_TEXT || ctrl->type == NYQ_CTRL_TIME) &&
               ctrl->lowStr.IsSameAs(wxT("nil"), false))
      {
         ctrl->low = -(FLT_MAX);
      }
      else
      {
         ctrl->low = GetCtrlValue(ctrl->lowStr);
      }
 
      if (ctrl->type == NYQ_CTRL_INT_TEXT && ctrl->highStr.IsSameAs(wxT("nil"), false)) {
         ctrl->high = INT_MAX;
      }
      else if ((ctrl->type == NYQ_CTRL_FLOAT_TEXT || ctrl->type == NYQ_CTRL_TIME) &&
               ctrl->highStr.IsSameAs(wxT("nil"), false))
      {
         ctrl->high = FLT_MAX;
      }
      else
      {
         ctrl->high = GetCtrlValue(ctrl->highStr);
      }
 
      if (ctrl->high < ctrl->low)
      {
         ctrl->high = ctrl->low + 1;
      }
 
      if (ctrl->val < ctrl->low)
      {
         ctrl->val = ctrl->low;
      }
 
      if (ctrl->val > ctrl->high)
      {
         ctrl->val = ctrl->high;
      }
 
      ctrl->ticks = 1000;
      if (ctrl->type == NYQ_CTRL_INT &&
          (ctrl->high - ctrl->low < ctrl->ticks))
      {
         ctrl->ticks = (int)(ctrl->high - ctrl->low);
      }
   }
 
   return true;
}

References EffectUIServices::DoMessageBox(), GetCtrlValue(), NumericConverter::GetValue(), NyqControl::high, NyqControl::highStr, ID_Time, NyqControl::low, NyqControl::lowStr, mControls, mUIParent, NYQ_CTRL_CHOICE, NYQ_CTRL_FILE, NYQ_CTRL_FLOAT_TEXT, NYQ_CTRL_INT, NYQ_CTRL_INT_TEXT, NYQ_CTRL_STRING, NYQ_CTRL_TEXT, NYQ_CTRL_TIME, resolveFilePath(), NyqControl::ticks, NyqControl::type, UNINITIALIZED_CONTROL, NyqControl::val, validatePath(), NyqControl::valStr, wxT(), and XO().

Referenced by TransferDataFromWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

TransferDataFromPromptWindow()

bool NyquistEffect::TransferDataFromPromptWindow ( )

private

Definition at line 2722 of file Nyquist.cpp.

{
   mInputCmd = mCommandText->GetValue();
 
   // Un-correct smart quoting, bothersomely applied in wxTextCtrl by
   // the native widget of MacOS 10.9 SDK
   const wxString left = wxT("\u201c"), right = wxT("\u201d"), dumb = '"';
   mInputCmd.Replace(left, dumb, true);
   mInputCmd.Replace(right, dumb, true);
 
   const wxString leftSingle = wxT("\u2018"), rightSingle = wxT("\u2019"),
      dumbSingle = '\'';
   mInputCmd.Replace(leftSingle, dumbSingle, true);
   mInputCmd.Replace(rightSingle, dumbSingle, true);
 
   return ParseCommand(mInputCmd);
}

References mCommandText, mInputCmd, ParseCommand(), and wxT().

Referenced by TransferDataFromWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

TransferDataFromWindow()

bool NyquistEffect::TransferDataFromWindow ( EffectSettings &  settings )

overridevirtual

Update the given settings from controls; default does nothing, returns true

Reimplemented from StatefulEffectUIServices.

Definition at line 1176 of file Nyquist.cpp.

{
   if (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
   {
      return false;
   }
 
   if (mIsPrompt)
   {
      return TransferDataFromPromptWindow();
   }
   return TransferDataFromEffectWindow();
}

References mIsPrompt, mUIParent, TransferDataFromEffectWindow(), and TransferDataFromPromptWindow().

Here is the call graph for this function:

TransferDataToEffectWindow()

bool NyquistEffect::TransferDataToEffectWindow ( )

private

Definition at line 2685 of file Nyquist.cpp.

{
   for (size_t i = 0, cnt = mControls.size(); i < cnt; i++)
   {
      NyqControl & ctrl = mControls[i];
 
      if (ctrl.type == NYQ_CTRL_CHOICE)
      {
         const auto count = ctrl.choices.size();
 
         int val = (int)ctrl.val;
         if (val < 0 || val >= (int)count)
         {
            val = 0;
         }
 
         wxChoice *c = (wxChoice *) mUIParent->FindWindow(ID_Choice + i);
         c->SetSelection(val);
      }
      else if (ctrl.type == NYQ_CTRL_INT || ctrl.type == NYQ_CTRL_FLOAT)
      {
         // wxTextCtrls are handled by the validators
         double range = ctrl.high - ctrl.low;
         int val = (int)(0.5 + ctrl.ticks * (ctrl.val - ctrl.low) / range);
         wxSlider *s = (wxSlider *) mUIParent->FindWindow(ID_Slider + i);
         s->SetValue(val);
      }
      else if (ctrl.type == NYQ_CTRL_TIME)
      {
         NumericTextCtrl *n = (NumericTextCtrl *) mUIParent->FindWindow(ID_Time + i);
         n->SetValue(ctrl.val);
      }
   }
 
   return true;
}

References NyqControl::choices, NyqControl::high, ID_Choice, ID_Slider, ID_Time, NyqControl::low, mControls, mUIParent, NYQ_CTRL_CHOICE, NYQ_CTRL_FLOAT, NYQ_CTRL_INT, NYQ_CTRL_TIME, NumericTextCtrl::SetValue(), NyqControl::ticks, NyqControl::type, and NyqControl::val.

Referenced by TransferDataToWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

TransferDataToPromptWindow()

bool NyquistEffect::TransferDataToPromptWindow ( )

private

Definition at line 2678 of file Nyquist.cpp.

{
   mCommandText->ChangeValue(mInputCmd);
 
   return true;
}

References mCommandText, and mInputCmd.

Referenced by TransferDataToWindow().

Here is the caller graph for this function:

TransferDataToWindow()

bool NyquistEffect::TransferDataToWindow ( const EffectSettings &  settings )

overridevirtual

Update controls for the settings; default does nothing, returns true

Reimplemented from StatefulEffectUIServices.

Definition at line 1154 of file Nyquist.cpp.

{
   mUIParent->TransferDataToWindow();
 
   bool success;
   if (mIsPrompt)
   {
      success = TransferDataToPromptWindow();
   }
   else
   {
      success = TransferDataToEffectWindow();
   }
 
   if (success)
   {
      EffectEditor::EnablePreview(mUIParent, mEnablePreview);
   }
 
   return success;
}

References EffectEditor::EnablePreview(), mEnablePreview, mIsPrompt, mUIParent, TransferDataToEffectWindow(), and TransferDataToPromptWindow().

Here is the call graph for this function:

UnQuote()

wxString NyquistEffect::UnQuote ( const wxString &  s, bool  allowParens = true, wxString *  pExtraString = nullptr  )

staticprivate

Definition at line 1921 of file Nyquist.cpp.

{
   return UnQuoteMsgid( s, allowParens, pExtraString ).Translation();
}

References TranslatableString::Translation(), and UnQuoteMsgid().

Referenced by Parse(), ParseChoice(), ParseFileExtensions(), ParseFileTypes(), and UnQuoteMsgid().

Here is the call graph for this function:

Here is the caller graph for this function:

UnQuoteMsgid()

TranslatableString NyquistEffect::UnQuoteMsgid ( const wxString &  s, bool  allowParens = true, wxString *  pExtraString = nullptr  )

staticprivate

Definition at line 1880 of file Nyquist.cpp.

{
   if (pExtraString)
      *pExtraString = wxString{};
 
   int len = s.length();
   if (len >= 2 && s[0] == wxT('\"') && s[len - 1] == wxT('\"')) {
      auto unquoted = s.Mid(1, len - 2);
      // Sorry, no context strings, yet
      // (See also comments in NyquistEffectsModule::AutoRegisterPlugins)
      return TranslatableString{ unquoted, {} };
   }
   else if (allowParens &&
            len >= 2 && s[0] == wxT('(') && s[len - 1] == wxT(')')) {
      Tokenizer tzer;
      tzer.Tokenize(s, true, 1, 1);
      auto &tokens = tzer.tokens;
      if (tokens.size() > 1) {
         if (pExtraString && tokens[1][0] == '(') {
            // A choice with a distinct internal string form like
            // ("InternalString" (_ "Visible string"))
            // Recur to find the two strings
            *pExtraString = UnQuote(tokens[0], false);
            return UnQuoteMsgid(tokens[1]);
         }
         else {
            // Assume the first token was _ -- we don't check that
            // And the second is the string, which is internationalized
            // Sorry, no context strings, yet
            return UnQuoteMsgid( tokens[1], false );
         }
      }
      else
         return {};
   }
   else
      // If string was not quoted, assume no translation exists
      return Verbatim( s );
}

References NyquistEffect::Tokenizer::Tokenize(), NyquistEffect::Tokenizer::tokens, UnQuote(), UnQuoteMsgid(), Verbatim(), and wxT().

Referenced by ParseFileType(), UnQuote(), and UnQuoteMsgid().

Here is the call graph for this function:

Here is the caller graph for this function:

validatePath()

bool NyquistEffect::validatePath ( wxString  path )

private

Definition at line 3371 of file Nyquist.cpp.

{
   wxFileName fname = path;
   wxString dir = fname.GetPath();
 
   return (fname.wxFileName::IsOk() &&
           wxFileName::DirExists(dir) &&
           !fname.GetFullName().empty());
}

Referenced by TransferDataFromEffectWindow().

Here is the caller graph for this function:

VisitSettings() [1/2]

bool NyquistEffect::VisitSettings ( ConstSettingsVisitor &  visitor, const EffectSettings &  settings  ) const

overridevirtual

Visit settings (read-only), if defined. false means no defined settings. Default implementation returns false

Reimplemented from EffectSettingsManager.

Definition at line 316 of file Nyquist.cpp.

{
   // For now we assume Nyquist can do get and set better than VisitSettings can,
   // And so we ONLY use it for getting the signature.
   if (auto pGa = dynamic_cast<ShuttleGetAutomation*>(&visitor)) {
      SaveSettings(settings, *pGa->mpEap);
      return true;
   }
   else if (auto pSd = dynamic_cast<ShuttleGetDefinition*>(&visitor);
       !pSd)
      // must be the NullShuttle
      return true;
 
   // Get the "definition," only for the help or info commands
   if (mExternal)
      return true;
 
   if (mIsPrompt) {
      visitor.Define( mInputCmd, KEY_Command, wxString{} );
      visitor.Define( mParameters, KEY_Parameters, wxString{} );
      return true;
   }
 
   for (const auto &ctrl : mControls) {
      double d = ctrl.val;
 
      if (d == UNINITIALIZED_CONTROL && ctrl.type != NYQ_CTRL_STRING)
         d = GetCtrlValue(ctrl.valStr);
 
      if (ctrl.type == NYQ_CTRL_FLOAT || ctrl.type == NYQ_CTRL_FLOAT_TEXT ||
          ctrl.type == NYQ_CTRL_TIME)
         visitor.Define( d, static_cast<const wxChar*>( ctrl.var.c_str() ),
            (double)0.0, ctrl.low, ctrl.high, 1.0);
      else if (ctrl.type == NYQ_CTRL_INT || ctrl.type == NYQ_CTRL_INT_TEXT) {
         int x = d;
         visitor.Define( x, static_cast<const wxChar*>( ctrl.var.c_str() ), 0,
            static_cast<int>(ctrl.low), static_cast<int>(ctrl.high), 1);
         //parms.Write(ctrl.var, (int) d);
      }
      else if (ctrl.type == NYQ_CTRL_CHOICE) {
         // untranslated
         int x = d;
         //parms.WriteEnum(ctrl.var, (int) d, choices);
         visitor.DefineEnum( x, static_cast<const wxChar*>( ctrl.var.c_str() ),
            0, ctrl.choices.data(), ctrl.choices.size() );
      }
      else if (ctrl.type == NYQ_CTRL_STRING || ctrl.type == NYQ_CTRL_FILE) {
         visitor.Define( ctrl.valStr, ctrl.var,
            wxString{}, ctrl.lowStr, ctrl.highStr );
         //parms.Write(ctrl.var, ctrl.valStr);
      }
   }
   return true;
}

References SettingsVisitorBase< Const >::Define(), SettingsVisitorBase< Const >::DefineEnum(), GetCtrlValue(), KEY_Command, KEY_Parameters, mControls, mExternal, mInputCmd, mIsPrompt, mParameters, NYQ_CTRL_CHOICE, NYQ_CTRL_FILE, NYQ_CTRL_FLOAT, NYQ_CTRL_FLOAT_TEXT, NYQ_CTRL_INT, NYQ_CTRL_INT_TEXT, NYQ_CTRL_STRING, NYQ_CTRL_TIME, SaveSettings(), settings(), and UNINITIALIZED_CONTROL.

Here is the call graph for this function:

VisitSettings() [2/2]

bool NyquistEffect::VisitSettings ( SettingsVisitor &  visitor, EffectSettings &  settings  )

overridevirtual

Visit settings (and maybe change them), if defined. false means no defined settings. Default implementation returns false

Reimplemented from EffectSettingsManager.

Definition at line 308 of file Nyquist.cpp.

{
   if (auto pSa = dynamic_cast<ShuttleSetAutomation*>(&visitor))
      LoadSettings(*pSa->mpEap, settings);
   return true;
}

References LoadSettings(), and settings().

Here is the call graph for this function:

Friends And Related Function Documentation

NyquistEffectsModule

friend class NyquistEffectsModule

friend

Definition at line 318 of file Nyquist.h.

Member Data Documentation

mAction

TranslatableString NyquistEffect::mAction

private

Definition at line 255 of file Nyquist.h.

Referenced by Parse().

mAuthor

TranslatableString NyquistEffect::mAuthor

private

Definition at line 257 of file Nyquist.h.

Referenced by GetVendor(), and Parse().

mBreak

bool NyquistEffect::mBreak

private

Definition at line 233 of file Nyquist.h.

Referenced by Break(), OSCallback(), and Process().

mCategories

wxArrayString NyquistEffect::mCategories

private

Definition at line 304 of file Nyquist.h.

Referenced by Parse(), and ParseProgram().

mCmd

wxString NyquistEffect::mCmd

private

Definition at line 252 of file Nyquist.h.

Referenced by ParseProgram(), and ProcessOne().

mCommandText

wxTextCtrl* NyquistEffect::mCommandText

private

Definition at line 312 of file Nyquist.h.

Referenced by BuildPromptWindow(), OnLoad(), OnSave(), TransferDataFromPromptWindow(), and TransferDataToPromptWindow().

mCompiler

bool NyquistEffect::mCompiler

private

Definition at line 237 of file Nyquist.h.

Referenced by Parse(), and ProcessOne().

mCont

bool NyquistEffect::mCont

private

Definition at line 234 of file Nyquist.h.

Referenced by Continue(), OSCallback(), and Process().

mControls

std::vector<NyqControl> NyquistEffect::mControls

private

Definition at line 280 of file Nyquist.h.

Referenced by BuildEffectWindow(), IsInteractive(), OnChoice(), OnFileButton(), OnSlider(), OnText(), OnTime(), Parse(), ParseProgram(), Process(), ProcessOne(), SaveSettings(), SetLispVarsFromParameters(), ShowHostInterface(), TransferDataFromEffectWindow(), TransferDataToEffectWindow(), and VisitSettings().

mCopyright

TranslatableString NyquistEffect::mCopyright

private

Definition at line 262 of file Nyquist.h.

Referenced by GetDescription(), and Parse().

mCount

unsigned NyquistEffect::mCount

private

Definition at line 290 of file Nyquist.h.

Referenced by Process(), and ProcessOne().

mCurBuffer

Buffer NyquistEffect::mCurBuffer[2]

private

Definition at line 298 of file Nyquist.h.

Referenced by GetCallback(), and ProcessOne().

mCurBufferLen

size_t NyquistEffect::mCurBufferLen[2]

private

Definition at line 300 of file Nyquist.h.

Referenced by GetCallback().

mCurBufferStart

sampleCount NyquistEffect::mCurBufferStart[2]

private

Definition at line 299 of file Nyquist.h.

Referenced by GetCallback().

mCurLen

sampleCount NyquistEffect::mCurLen

private

Definition at line 285 of file Nyquist.h.

Referenced by GetCallback(), Process(), and ProcessOne().

mCurNumChannels

unsigned NyquistEffect::mCurNumChannels

private

Definition at line 282 of file Nyquist.h.

Referenced by Process(), and ProcessOne().

mCurStart

sampleCount NyquistEffect::mCurStart[2]

private

Definition at line 284 of file Nyquist.h.

Referenced by GetCallback(), and Process().

mCurTrack

WaveTrack* NyquistEffect::mCurTrack[2]

private

Definition at line 283 of file Nyquist.h.

Referenced by GetCallback(), Process(), and ProcessOne().

mDebug

bool NyquistEffect::mDebug

private

Definition at line 273 of file Nyquist.h.

Referenced by ParseProgram(), Process(), ProcessOne(), and ShowHostInterface().

mDebugButton

bool NyquistEffect::mDebugButton

private

Definition at line 271 of file Nyquist.h.

Referenced by EnablesDebug(), Init(), Parse(), and ParseProgram().

mDebugOutput

TranslatableString NyquistEffect::mDebugOutput

private

Definition at line 277 of file Nyquist.h.

Referenced by Process(), and ProcessOne().

mDebugOutputStr

wxString NyquistEffect::mDebugOutputStr

private

Definition at line 276 of file Nyquist.h.

Referenced by OutputCallback(), and Process().

mEnablePreview

bool NyquistEffect::mEnablePreview

private

Definition at line 270 of file Nyquist.h.

Referenced by Init(), Parse(), ParseProgram(), and TransferDataToWindow().

mExternal

bool NyquistEffect::mExternal

private

Definition at line 240 of file Nyquist.h.

Referenced by DoLoadSettings(), ProcessOne(), SetCommand(), and VisitSettings().

mFileModified

wxDateTime NyquistEffect::mFileModified

private

When the script was last modified on disk.

Definition at line 230 of file Nyquist.h.

mFileName

wxFileName NyquistEffect::mFileName

private

Name of the Nyquist script file this effect is loaded from.

Definition at line 229 of file Nyquist.h.

Referenced by GetPath(), OnLoad(), OnSave(), Parse(), and ParseFile().

mFirstInGroup

bool NyquistEffect::mFirstInGroup

private

Definition at line 288 of file Nyquist.h.

Referenced by Process(), and ProcessOne().

mFoundType

bool NyquistEffect::mFoundType

private

Definition at line 236 of file Nyquist.h.

Referenced by Parse(), and ParseProgram().

mHelpFile

wxString NyquistEffect::mHelpFile

private

Definition at line 264 of file Nyquist.h.

Referenced by CheckHelpPage(), Parse(), ParseProgram(), and Process().

mHelpFileExists

bool NyquistEffect::mHelpFileExists

private

Definition at line 265 of file Nyquist.h.

Referenced by ParseProgram(), and Process().

mHelpPage

FilePath NyquistEffect::mHelpPage

private

Definition at line 266 of file Nyquist.h.

Referenced by HelpPage(), and ParseProgram().

mInfo

TranslatableString NyquistEffect::mInfo

private

Definition at line 256 of file Nyquist.h.

Referenced by Parse().

mInitError

TranslatableString NyquistEffect::mInitError

private

Definition at line 249 of file Nyquist.h.

Referenced by Parse(), and ParseProgram().

mInputCmd

wxString NyquistEffect::mInputCmd

private

Definition at line 250 of file Nyquist.h.

Referenced by DoLoadSettings(), Process(), SaveSettings(), ShowHostInterface(), TransferDataFromPromptWindow(), TransferDataToPromptWindow(), and VisitSettings().

mIsPrompt

const bool NyquistEffect::mIsPrompt

private

True if the code to execute is obtained interactively from the user via the "Nyquist Effect Prompt", or "Nyquist Prompt", false for all other effects (lisp code read from files)

Definition at line 247 of file Nyquist.h.

Referenced by DoLoadSettings(), GetPath(), GetSymbol(), GetVendor(), Init(), IsDefault(), IsInteractive(), ManualPage(), ParseProgram(), PopulateOrExchange(), Process(), ProcessOne(), SaveSettings(), ShowHostInterface(), TransferDataFromWindow(), TransferDataToWindow(), and VisitSettings().

mIsSal

bool NyquistEffect::mIsSal

private

Definition at line 239 of file Nyquist.h.

Referenced by Parse(), ParseProgram(), and ProcessOne().

mIsSpectral

bool NyquistEffect::mIsSpectral

private

Definition at line 241 of file Nyquist.h.

Referenced by Init(), Parse(), and ParseProgram().

mIsTool

bool NyquistEffect::mIsTool

private

Definition at line 242 of file Nyquist.h.

Referenced by DoLoadSettings(), GetClassification(), and Parse().

mManPage

wxString NyquistEffect::mManPage

private

Definition at line 263 of file Nyquist.h.

Referenced by ManualPage(), Parse(), and ParseProgram().

mMaxLen

sampleCount NyquistEffect::mMaxLen

private

Definition at line 286 of file Nyquist.h.

Referenced by Parse(), and Process().

mMergeClips

int NyquistEffect::mMergeClips

private

Definition at line 310 of file Nyquist.h.

Referenced by Parse(), and ProcessOne().

mName

TranslatableString NyquistEffect::mName

private

Name of the Effect (untranslated)

Definition at line 253 of file Nyquist.h.

Referenced by GetSymbol(), Init(), Parse(), Process(), and ProcessOne().

mNumSelectedChannels

unsigned NyquistEffect::mNumSelectedChannels

private

Definition at line 291 of file Nyquist.h.

Referenced by Process(), and ProcessOne().

mOK

bool NyquistEffect::mOK

private

Definition at line 248 of file Nyquist.h.

Referenced by IsOk(), and Parse().

mOutputTime

double NyquistEffect::mOutputTime

private

Definition at line 289 of file Nyquist.h.

Referenced by Process(), and ProcessOne().

mOutputTrack

WaveTrack* NyquistEffect::mOutputTrack[2]

private

Definition at line 302 of file Nyquist.h.

Referenced by ProcessOne(), and PutCallback().

mParameters

wxString NyquistEffect::mParameters

private

Definition at line 251 of file Nyquist.h.

Referenced by DoLoadSettings(),