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

#include <NyquistBase.h>

Inheritance diagram for NyquistBase:

Collaboration diagram for NyquistBase:

Classes
struct	ExecFromMainHook

struct	GetDisplaysHook

struct	GetEffectHook

struct	NyxContext

struct	ShowDebugOutputHook

struct	Tokenizer

struct	YieldIfNeededHook

Public Member Functions
	NyquistBase (const wxString &fName)

virtual	~NyquistBase ()

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

void	RedirectOutput ()

void	SetCommand (const wxString &cmd)

void	Continue ()

void	Break ()

void	Stop ()

bool	IsOk ()

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

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 NumericFormatID	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, InstanceFinder finder={})
	Re-invoke DoEffect on another Effect object that implements the work. More...

Public Member Functions inherited from EffectBase
	EffectBase ()

	~EffectBase () override

bool	IsLinearEffect () const

bool	PreviewsFullSelection () const

void	SetTracks (TrackList *pTracks)

double	GetDefaultDuration ()

virtual std::any	BeginPreview (const EffectSettings &settings)
	Called when Preview() starts, to allow temporary effect state changes. More...

bool	DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess) override

virtual double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const =0

void	CountWaveTracks ()

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 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 Attributes
std::vector< NyqControl >	mControls

Public Attributes inherited from EffectBase
std::shared_ptr< TrackList >	mTracks {}

int	mNumTracks {}

BasicUI::ProgressDialog *	mProgress {}

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

double	mT0 {}

double	mT1 {}

bool	mIsPreview { false }

Protected Member Functions
bool	ParseCommand (const wxString &cmd)

bool	validatePath (wxString path)

wxString	ToTimeFormat (double t)

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, sampleCount start, sampleCount len)

Protected Member Functions inherited from EffectBase
virtual bool	CheckWhetherSkipEffect (const EffectSettings &settings) const =0
	After Init(), tell whether Process() should be skipped. More...

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing () const

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Static Protected Member Functions
static double	GetCtrlValue (const wxString &s)

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

Protected Attributes
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

sampleCount	mMaxLen

int	mTrackIndex

bool	mFirstInGroup

double	mOutputTime

unsigned	mCount

unsigned	mNumSelectedChannels

wxArrayString	mCategories

wxString	mProps

wxString	mPerTrackProps

bool	mRestoreSplits

int	mMergeClips

Protected Attributes inherited from EffectBase
double	mF0 {}

double	mF1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Private Member Functions
bool	ProcessOne (NyxContext &nyxContext, EffectOutputTracks *pOutputs)

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)

void	OutputCallback (int c)

void	OSCallback ()

void	ParseFile ()

bool	ParseProgram (wxInputStream &stream)

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

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 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 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...

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 Public Member Functions inherited from EffectBase
static std::optional< InstancePointer >	FindInstance (EffectPlugin &plugin)

static InstanceFinder	DefaultInstanceFinder (EffectPlugin &plugin)

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

Detailed Description

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

Definition at line 75 of file NyquistBase.h.

Constructor & Destructor Documentation

◆ NyquistBase()

NyquistBase::NyquistBase ( 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.

Definition at line 56 of file NyquistBase.cpp.

    : mIsPrompt { fName == NYQUIST_PROMPT_ID }
{
   mAction = XO("Applying Nyquist Effect...");
   mExternal = false;
   mCompiler = false;
   mTrace = false;
   mRedirectOutput = false;
   mDebug = false;
   mIsSal = false;
   mOK = false;
   mAuthor = XO("n/a");
   mReleaseVersion = XO("n/a");
   mCopyright = XO("n/a");
 
   // set clip/split handling when applying over clip boundary.
   mRestoreSplits = true; // Default: Restore split lines.
   mMergeClips = -1;      // Default (auto):  Merge if length remains unchanged.
 
   mVersion = 4;
 
   mStop = false;
   mBreak = false;
   mCont = false;
   mIsTool = false;
 
   mMaxLen = NYQ_MAX_LEN;
 
   // Interactive Nyquist
   if (mIsPrompt)
   {
      mName = NYQUIST_PROMPT_NAME;
      mType = EffectTypeTool;
      mIsTool = true;
      mPromptName = mName;
      mPromptType = mType;
      mOK = true;
      return;
   }
 
   if (fName == NYQUIST_WORKER_ID)
   {
      // Effect spawned from Nyquist Prompt
      /* i18n-hint: It is acceptable to translate this the same as for "Nyquist
       * Prompt" */
      mName = XO("Nyquist Worker");
      return;
   }
 
   mFileName = fName;
   // Use the file name verbatim as effect name.
   // This is only a default name, overridden if we find a $name line:
   mName = Verbatim(mFileName.GetName());
   mFileModified = mFileName.GetModificationTime();
   ParseFile();
 
   if (!mOK && mInitError.empty())
      mInitError = XO("Ill-formed Nyquist plug-in header");
}

References EffectTypeTool, mAction, mAuthor, mBreak, mCompiler, mCont, mCopyright, mDebug, mExternal, mFileModified, mFileName, mIsPrompt, mIsSal, mIsTool, mMaxLen, mMergeClips, mName, mOK, mPromptName, mPromptType, mRedirectOutput, mReleaseVersion, mRestoreSplits, mStop, mTrace, mType, mVersion, NYQ_MAX_LEN, NYQUIST_PROMPT_NAME, NYQUIST_WORKER_ID, ParseFile(), Verbatim(), and XO().

Here is the call graph for this function:

◆ ~NyquistBase()

NyquistBase::~NyquistBase ( )

virtual

Definition at line 116 of file NyquistBase.cpp.

117{

118}

Member Function Documentation

◆ Break()

void NyquistBase::Break ( )

Definition at line 1875 of file NyquistBase.cpp.

{
   mBreak = true;
}

References mBreak.

◆ CheckHelpPage()

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

private

Definition at line 165 of file NyquistBase.cpp.

{
   auto paths = NyquistBase::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 NyquistBase::Continue ( )

Definition at line 1880 of file NyquistBase.cpp.

{
   mCont = true;
}

References mCont.

◆ DoLoadSettings()

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

Definition at line 354 of file NyquistBase.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 NyquistBase::EnablesDebug ( ) const

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 220 of file NyquistBase.cpp.

{
   return mDebugButton;
}

References mDebugButton.

◆ EscapeString()

wxString NyquistBase::EscapeString ( const wxString & inStr )

private

Definition at line 1747 of file NyquistBase.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:

◆ GetClassification()

EffectType NyquistBase::GetClassification ( ) const

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 193 of file NyquistBase.cpp.

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

References EffectTypeTool, mIsTool, and mType.

◆ GetCtrlValue()

double NyquistBase::GetCtrlValue ( const wxString & s )

staticprotected

Definition at line 1942 of file NyquistBase.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(), NyquistEffect::TransferDataFromEffectWindow(), and VisitSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDescription()

TranslatableString NyquistBase::GetDescription ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 155 of file NyquistBase.cpp.

{
   return mCopyright;
}

References mCopyright.

◆ GetFamily()

EffectFamilySymbol NyquistBase::GetFamily ( ) const

overridevirtual

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

Reimplemented from Effect.

Definition at line 200 of file NyquistBase.cpp.

{
   return NYQUISTEFFECTS_FAMILY;
}

References NYQUISTEFFECTS_FAMILY.

◆ GetNyquistSearchPath()

FilePaths NyquistBase::GetNyquistSearchPath ( )

staticprivate

Definition at line 2750 of file NyquistBase.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 NyquistBase::GetPath ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 122 of file NyquistBase.cpp.

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

References mFileName, mIsPrompt, and NYQUIST_PROMPT_ID.

◆ GetSymbol()

ComponentInterfaceSymbol NyquistBase::GetSymbol ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 130 of file NyquistBase.cpp.

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

References mIsPrompt, mName, NYQUIST_PROMPT_ID, and NYQUIST_PROMPT_NAME.

◆ GetType()

EffectType NyquistBase::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 188 of file NyquistBase.cpp.

{
   return mType;
}

References mType.

Referenced by Process(), and ProcessOne().

Here is the caller graph for this function:

◆ GetVendor()

VendorSymbol NyquistBase::GetVendor ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 138 of file NyquistBase.cpp.

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

References mAuthor, mIsPrompt, and XO().

Here is the call graph for this function:

◆ GetVersion()

wxString NyquistBase::GetVersion ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 148 of file NyquistBase.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 NyquistBase::HelpPage ( ) const

overridevirtual

Fully qualified local help file name, default is empty.

Reimplemented from EffectDefinitionInterface.

Definition at line 181 of file NyquistBase.cpp.

{
   return mHelpPage;
}

References mHelpPage.

◆ Init()

bool NyquistBase::Init ( )

overridevirtual

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 491 of file NyquistBase.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
            const auto displays = GetDisplaysHook::Call(t);
            hasSpectral |= displays.end() !=
                           std::find(
                              displays.begin(), displays.end(),
                              WaveChannelSubViewType {
                                 WaveChannelViewConstants::Spectrum, {} });
 
            if (
               hasSpectral &&
               (SpectrogramSettings::Get(*t).SpectralSelectionEnabled()))
            {
               bAllowSpectralEditing = true;
               break;
            }
         }
 
         if (!bAllowSpectralEditing || ((mF0 < 0.0) && (mF1 < 0.0)))
         {
            using namespace BasicUI;
            if (!hasSpectral)
               ShowMessageBox(
                  XO("Enable track spectrogram view before\n"
                     "applying 'Spectral' effects."),
                  MessageBoxOptions {}.IconStyle(Icon::Error));
            else
               ShowMessageBox(
                  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 von."),
                  MessageBoxOptions {}.IconStyle(Icon::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 GlobalHook< GetDisplaysHook, std::vector< WaveChannelSubViewType >(const WaveTrack *)>::Call(), EffectBase::FindProject(), TrackList::Get(), SpectrogramSettings::Get(), BasicUI::MessageBoxOptions::IconStyle(), mDebugButton, mEnablePreview, EffectBase::mF0, EffectBase::mF1, mIsPrompt, mIsSpectral, mName, mPromptName, mPromptType, mType, mVersion, project, TrackList::Selected(), BasicUI::ShowMessageBox(), SpectrogramSettings::SpectralSelectionEnabled(), and XO().

Here is the call graph for this function:

◆ InitializationError()

const TranslatableString & NyquistBase::InitializationError ( ) const

inlineprivate

Definition at line 172 of file NyquistBase.h.

   {
      return mInitError;
   }

Referenced by NyquistEffectsModule::DiscoverPluginsAtPath().

Here is the caller graph for this function:

◆ IsDefault()

bool NyquistBase::IsDefault ( ) const

overridevirtual

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

Reimplemented from Effect.

Definition at line 215 of file NyquistBase.cpp.

{
   return mIsPrompt;
}

References mIsPrompt.

◆ IsInteractive()

bool NyquistBase::IsInteractive ( ) const

overridevirtual

Whether the effect needs a dialog for entry of settings.

Reimplemented from Effect.

Definition at line 205 of file NyquistBase.cpp.

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

References mControls, and mIsPrompt.

◆ IsOk()

bool NyquistBase::IsOk ( )

Definition at line 2767 of file NyquistBase.cpp.

{
   return mOK;
}

References mOK.

Referenced by NyquistEffectsModule::DiscoverPluginsAtPath().

Here is the caller graph for this function:

◆ LoadSettings()

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

overridevirtual

Restore settings from keys and values.

Returns: true on success

Reimplemented from Effect.

Definition at line 347 of file NyquistBase.cpp.

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

References DoLoadSettings(), and settings().

Referenced by EVT_COMMAND_RANGE(), and VisitSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ManualPage()

ManualPageID NyquistBase::ManualPage ( ) const

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 160 of file NyquistBase.cpp.

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

References mIsPrompt, and mManPage.

◆ NyquistToWxString()

wxString NyquistBase::NyquistToWxString ( const char * nyqString )

staticprivate

Definition at line 1732 of file NyquistBase.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:

◆ OSCallback()

void NyquistBase::OSCallback ( )

private

Definition at line 2729 of file NyquistBase.cpp.

{
   if (mStop)
   {
      mStop = false;
      nyx_stop();
   }
   else if (mBreak)
   {
      mBreak = false;
      nyx_break();
   }
   else if (mCont)
   {
      mCont = false;
      nyx_continue();
   }
 
   YieldIfNeededHook::Call();
}

References GlobalHook< YieldIfNeededHook, void()>::Call(), mBreak, mCont, and mStop.

Here is the call graph for this function:

◆ OutputCallback()

void NyquistBase::OutputCallback ( int c )

private

Definition at line 2712 of file NyquistBase.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 NyquistBase::Parse	(	Tokenizer &	tokenizer,
		const wxString &	line,
		bool	eof,
		bool	first
	)

private

Definition at line 2069 of file NyquistBase.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 (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;
   }
 
   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, NyqControl::name, 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, NyquistBase::Tokenizer::Tokenize(), NyquistBase::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 > NyquistBase::ParseChoice ( const wxString & text )

staticprivate

Definition at line 1757 of file NyquistBase.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, NyquistBase::Tokenizer::Tokenize(), NyquistBase::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 NyquistBase::ParseCommand ( const wxString & cmd )

protected

Definition at line 2601 of file NyquistBase.cpp.

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

References ParseProgram(), and wxT().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseFile()

void NyquistBase::ParseFile ( )

private

Definition at line 2593 of file NyquistBase.cpp.

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

References mFileName, and ParseProgram().

Referenced by NyquistBase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseFileExtensions()

FileExtensions NyquistBase::ParseFileExtensions ( const wxString & text )

private

Definition at line 1789 of file NyquistBase.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 NyquistBase::Tokenizer::Tokenize(), NyquistBase::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 NyquistBase::ParseFileType ( const wxString & text )

private

Definition at line 1803 of file NyquistBase.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(), NyquistBase::Tokenizer::Tokenize(), NyquistBase::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 NyquistBase::ParseFileTypes ( const wxString & text )

private

Definition at line 1818 of file NyquistBase.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, NyquistBase::Tokenizer::Tokenize(), NyquistBase::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 NyquistBase::ParseProgram ( wxInputStream & stream )

private

Definition at line 2492 of file NyquistBase.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)
   {
      using namespace BasicUI;
      /* i1n-hint: SAL and LISP are names for variant syntaxes for the
       Nyquist programming language.  Leave them, and 'return', untranslated. */
      BasicUI::ShowMessageBox(
         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 ."),
         MessageBoxOptions {}.IconStyle(Icon::Error));
      /* 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(), EffectTypeProcess, BasicUI::MessageBoxOptions::IconStyle(), mCategories, mCmd, mControls, mDebug, mDebugButton, mEnablePreview, mFoundType, mHelpFile, mHelpFileExists, mHelpPage, mInitError, mIsPrompt, mIsSal, mIsSpectral, mManPage, mTrace, mType, Parse(), BasicUI::ShowMessageBox(), wxT(), and XO().

Referenced by ParseCommand(), and ParseFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Process()

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

overridevirtual

Implements StatefulEffectBase.

Definition at line 644 of file NyquistBase.cpp.

{
   if (mIsPrompt && mControls.size() > 0 && !IsBatchProcessing())
   {
      auto& nyquistSettings = GetSettings(settings);
      auto cleanup = finally([&] {
         // Free up memory
         nyquistSettings.proxySettings = {};
      });
      NyquistBase 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 = EffectOutputTracks::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;
   const auto scale =
      (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
   std::optional<EffectOutputTracks> oOutputs;
   if (!bOnePassTool)
      oOutputs.emplace(
         *mTracks, GetType(), EffectOutputTracks::TimeInterval { mT0, mT1 },
         true, false);
 
   mNumSelectedChannels =
      bOnePassTool ?
         0 :
         oOutputs->Get().Selected<const WaveTrack>().sum(&WaveTrack::NChannels);
 
   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(PlatformCompatibility::GetTempDir()));
      mProps += wxString::Format(
         wxT("(putprop '*SYSTEM-DIR* \"%s\" 'DOCUMENTS)\n"),
         EscapeString(PlatformCompatibility::GetDocumentsDir()));
      mProps += wxString::Format(
         wxT("(putprop '*SYSTEM-DIR* \"%s\" 'HOME)\n"),
         EscapeString(PlatformCompatibility::GetHomeDir()));
 
      auto paths = NyquistBase::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).Any();
         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* (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.");
      using namespace BasicUI;
      BasicUI::ShowMessageBox(
         message, MessageBoxOptions {}.IconStyle(Icon::Error));
   }
 
   std::optional<TrackIterRange<WaveTrack>> pRange;
   if (!bOnePassTool)
      pRange.emplace(oOutputs->Get().Selected<WaveTrack>());
 
   // 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;
   double progressTot {};
 
   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));
 
      // New context for each channel group of input
      NyxContext nyxContext {
         [this](double frac) { return TotalProgress(frac); }, scale, progressTot
      };
      auto& mCurNumChannels = nyxContext.mCurNumChannels;
      auto& mCurChannelGroup = nyxContext.mCurChannelGroup;
      auto& mCurTrack = nyxContext.mCurTrack;
      auto& mCurStart = nyxContext.mCurStart;
      auto& mCurLen = nyxContext.mCurLen;
 
      mCurChannelGroup = pRange ? *pRange->first : nullptr;
      mCurTrack[0] = mCurChannelGroup ?
                        (*mCurChannelGroup->Channels().begin()).get() :
                        nullptr;
      mCurNumChannels = 1;
      assert(mCurChannelGroup != nullptr || bOnePassTool);
      if ((mT1 >= mT0) || bOnePassTool)
      {
         if (bOnePassTool)
         {
         }
         else
         {
            if (auto channels = mCurChannelGroup->Channels();
                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).get();
            }
 
            // Check whether we're in the same group as the last selected track
            Track* gt = *SyncLock::Group(*mCurChannelGroup).first;
            mFirstInGroup = !gtLast || (gtLast != gt);
            gtLast = gt;
 
            mCurStart = mCurChannelGroup->TimeToLongSamples(mT0);
            auto end = mCurChannelGroup->TimeToLongSamples(mT1);
            mCurLen = end - mCurStart;
 
            wxASSERT(mCurLen <= NYQ_MAX_LEN);
 
            mCurLen = std::min(mCurLen, mMaxLen);
         }
 
         // 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 (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));
               }
            }
 
            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);
 
            const auto t0 =
               mCurChannelGroup ? mCurChannelGroup->SnapToSample(mT0) : mT0;
            const auto t1 =
               mCurChannelGroup ? mCurChannelGroup->SnapToSample(mT1) : mT1;
            mPerTrackProps += wxString::Format(
               wxT("(putprop '*SELECTION* (float %s) 'START)\n"),
               Internat::ToString(t0));
            mPerTrackProps += wxString::Format(
               wxT("(putprop '*SELECTION* (float %s) 'END)\n"),
               Internat::ToString(t1));
         }
 
         success = ProcessOne(nyxContext, oOutputs ? &*oOutputs : nullptr);
 
         // Reset previous locale
         wxSetlocale(LC_NUMERIC, prevlocale);
 
         if (!success || bOnePassTool)
         {
            goto finish;
         }
         progressTot += nyxContext.mProgressIn + nyxContext.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)
      ShowDebugOutputHook::Call(mName, mDebugOutput);
 
   // Has rug been pulled from under us by some effect done within Nyquist??
   if (!bOnePassTool && (nEffectsSoFar == EffectOutputTracks::nEffectsDone))
   {
      if (success)
         oOutputs->Commit();
   }
   else
   {
      // 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 TrackList::Any(), FileNames::AudacityPathList(), FileNames::BaseDir(), GlobalHook< ShowDebugOutputHook, void(const TranslatableString &title, const TranslatableString &message)>::Call(), FileNames::DataDir(), Effect::Delegate(), EffectTypeProcess, EffectTypeTool, details::end(), EscapeString(), EffectBase::FindProject(), TranslatableString::Format(), EffectManager::Get(), ProjectRate::Get(), ViewInfo::Get(), TrackList::Get(), PlatformCompatibility::GetDocumentsDir(), PlatformCompatibility::GetHomeDir(), Effect::GetNumWaveGroups(), GetNyquistSearchPath(), ProjectRate::GetRate(), EffectWithSettings< NyquistSettings, StatefulEffect >::GetSettings(), Languages::GetSystemLanguageCode(), PlatformCompatibility::GetTempDir(), GetType(), gPrefs, SyncLock::Group(), FileNames::HtmlHelpDir(), BasicUI::MessageBoxOptions::IconStyle(), Effect::IsBatchProcessing(), EffectBase::IsPreviewing(), mBreak, mCont, mControls, mCount, mDebug, mDebugOutput, mDebugOutputStr, EffectBase::mF0, EffectBase::mF1, mFirstInGroup, mHelpFile, mHelpFileExists, min(), mInputCmd, mIsPrompt, mMaxLen, mName, mNumSelectedChannels, mOutputTime, mPerTrackProps, mProjectChanged, mProps, mRedirectOutput, mReentryCount, mStop, EffectBase::mT0, EffectBase::mT1, mTrace, mTrackIndex, EffectBase::mTracks, mVersion, WaveTrack::NChannels(), EffectOutputTracks::nEffectsDone, NYQ_MAX_LEN, NYQUIST_WORKER_ID, FileNames::PlugInDir(), ProcessOne(), project, audacity::BasicSettings::Read(), RegisterFunctions(), ViewInfo::selectedRegion, EffectManager::SetSkipStateFlag(), settings(), BasicUI::ShowMessageBox(), AllProjects::size(), size, staffpad::audio::simd::sqrt(), StaticOSCallback(), StaticOutputCallback(), TempDirectory::TempDir(), Internat::ToString(), Effect::TotalProgress(), TranslatableString::Translation(), valueRestorer(), Verbatim(), wxT(), and XO().

Here is the call graph for this function:

◆ ProcessOne()

bool NyquistBase::ProcessOne	(	NyxContext &	nyxContext,
		EffectOutputTracks *	pOutputs
	)

private

Definition at line 1139 of file NyquistBase.cpp.

{
   const auto mCurNumChannels = nyxContext.mCurNumChannels;
   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;
   }
 
   const auto& mCurChannelGroup = nyxContext.mCurChannelGroup;
 
   if ((mVersion >= 4) && (GetType() != EffectTypeTool))
   {
      // Set the track TYPE and VIEW properties
      wxString type;
      wxString view;
      wxString bitFormat;
      wxString spectralEditp;
 
      mCurChannelGroup->TypeSwitch(
         [&](const WaveTrack& wt) {
            type = wxT("wave");
            spectralEditp = SpectrogramSettings::Get(*mCurChannelGroup)
                                  .SpectralSelectionEnabled() ?
                               wxT("T") :
                               wxT("NIL");
            view = wxT("NIL");
            // Find() not Get() to avoid creation-on-demand of views in case we
            // are only previewing
            const auto displays = GetDisplaysHook::Call(&wt);
            const 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(mCurChannelGroup->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);
 
      const double startTime = mCurChannelGroup->GetStartTime();
      const double endTime = mCurChannelGroup->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"), // https://github.com/audacity/audacity/issues/7097:
                                                      // not to break all
                                                      // nyquist scripts out
                                                      // there, we keep the old
                                                      // name.
         Internat::ToString(mCurChannelGroup->GetVolume()));
      cmd += wxString::Format(
         wxT("(putprop '*TRACK* (float %s) 'PAN)\n"),
         Internat::ToString(mCurChannelGroup->GetPan()));
      cmd += wxString::Format(
         wxT("(putprop '*TRACK* (float %s) 'RATE)\n"),
         Internat::ToString(mCurChannelGroup->GetRate()));
 
      switch (mCurChannelGroup->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
      const auto inClipBoundaries = GetClipBoundaries(
         pOutputs ? pOutputs->GetMatchingInput(*mCurChannelGroup) : nullptr);
      const auto outClipBoundaries = GetClipBoundaries(mCurChannelGroup);
      wxString inClips, outClips, peakString, rmsString;
      auto& mCurTrack = nyxContext.mCurTrack;
      for (size_t i = 0; i < mCurNumChannels; i++)
      {
         float maxPeak = 0.0;
         if (mCurNumChannels > 1)
         {
            inClips += wxT("(list ");
            outClips += wxT("(list ");
         }
         inClips += inClipBoundaries;
         outClips += outClipBoundaries;
         if (mCurNumChannels > 1)
         {
            inClips += wxT(" )");
            outClips += wxT(" )");
         }
         float min, max;
         auto pair = WaveChannelUtilities::GetMinMax(
            *mCurTrack[i], mT0, mT1); // may throw
         min = pair.first, max = pair.second;
         maxPeak = std::max(std::max(fabs(min), fabs(max)), maxPeak);
         maxPeakLevel = std::max(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 =
            WaveChannelUtilities::GetRMS(*mCurTrack[i], 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 ) 'INCLIPS)\n"),
         (mCurNumChannels == 1) ? wxT("(list ") : wxT("(vector "), inClips);
      cmd += wxString::Format(
         wxT("(putprop '*TRACK* %s%s ) 'CLIPS)\n"),
         (mCurNumChannels == 1) ? wxT("(list ") : wxT("(vector "), outClips);
 
      (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(mCurChannelGroup->GetRate(), 0);
   else
   {
      auto curLen = nyxContext.mCurLen.as_long_long();
      nyx_set_audio_params(mCurChannelGroup->GetRate(), curLen);
      nyx_set_input_audio(
         NyxContext::StaticGetCallback, &nyxContext, (int)mCurNumChannels,
         curLen, mCurChannelGroup->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;
   }
 
   // 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
      {
         BasicUI::ShowMessageBox(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.
         BasicUI::ShowMessageBox(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());
      BasicUI::ShowMessageBox(str);
      return (GetType() != EffectTypeProcess || mIsPrompt);
   }
 
   if (rval == nyx_int)
   {
      auto str = XO("Nyquist returned the value: %d").Format(nyx_get_int());
      BasicUI::ShowMessageBox(str);
      return (GetType() != EffectTypeProcess || mIsPrompt);
   }
 
   if (rval == nyx_labels)
   {
      assert(GetType() != EffectTypeTool); // Guaranteed above
      // Therefore bOnePassTool was false in Process()
      // Therefore output tracks were allocated
      assert(pOutputs);
 
      mProjectChanged = true;
      unsigned int numLabels = nyx_get_num_labels();
      unsigned int l;
      auto ltrack = *pOutputs->Get().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*>(pOutputs->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)
   {
      BasicUI::ShowMessageBox(
         XO("Nyquist returned too many audio channels.\n"));
      return false;
   }
 
   if (outChannels == -1)
   {
      BasicUI::ShowMessageBox(
         XO("Nyquist returned one audio channel as an array.\n"));
      return false;
   }
 
   if (outChannels == 0)
   {
      BasicUI::ShowMessageBox(XO("Nyquist returned an empty array.\n"));
      return false;
   }
 
   nyxContext.mOutputTrack = mCurChannelGroup->EmptyCopy();
   auto out = nyxContext.mOutputTrack;
 
   // Now fully evaluate the sound
   int success = nyx_get_audio(NyxContext::StaticPutCallback, &nyxContext);
 
   // See if GetCallback found read errors
   if (auto pException = nyxContext.mpException)
      std::rethrow_exception(pException);
 
   if (!success)
      return false;
 
   mOutputTime = out->GetEndTime();
   if (mOutputTime <= 0)
   {
      BasicUI::ShowMessageBox(XO("Nyquist returned nil audio.\n"));
      return false;
   }
 
   WaveTrack::Holder tempTrack;
   if (outChannels < static_cast<int>(mCurNumChannels))
   {
      // Be careful to do this before duplication
      out->Flush();
      // Must destroy one temporary list before repopulating another with
      // correct channel grouping
      nyxContext.mOutputTrack.reset();
      tempTrack = out->MonoToStereo();
   }
   else
   {
      tempTrack = move(nyxContext.mOutputTrack);
      out->Flush();
   }
 
   {
      const bool bMergeClips = (mMergeClips < 0)
                                  // Use sample counts to determine default
                                  // behaviour - times will rarely be equal.
                                  ?
                                  (out->TimeToLongSamples(mT0) +
                                      out->TimeToLongSamples(mOutputTime) ==
                                   out->TimeToLongSamples(mT1)) :
                                  mMergeClips != 0;
      PasteTimeWarper warper { mT1, mT0 + tempTrack->GetEndTime() };
      mCurChannelGroup->ClearAndPaste(
         mT0, mT1, *tempTrack, mRestoreSplits, bMergeClips, &warper);
   }
 
   // If we were first in the group adjust non-selected group tracks
   if (mFirstInGroup)
   {
      for (auto t : SyncLock::Group(*mCurChannelGroup))
         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;
}

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RedirectOutput()

void NyquistBase::RedirectOutput ( )

Definition at line 1860 of file NyquistBase.cpp.

{
   mRedirectOutput = true;
}

References mRedirectOutput.

Referenced by NyqBench::OnGo().

Here is the caller graph for this function:

◆ resolveFilePath()

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

staticprotected

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 2779 of file NyquistBase.cpp.

{
#if defined(__WXMSW__)
   path.Replace("/", wxFileName::GetPathSeparator());
#endif
 
   path.Trim(true).Trim(false);
 
   typedef std::unordered_map<wxString, FilePath> map;
   map pathKeys = {
      { "*home*", PlatformCompatibility::GetHomeDir() },
      { "~", PlatformCompatibility::GetHomeDir() },
      { "*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(), anonymous_namespace{CloudProjectFileIOExtensions.cpp}::extension, FileNames::FindDefaultPath(), and PlatformCompatibility::GetHomeDir().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveSettings()

bool NyquistBase::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

Reimplemented from Effect.

Definition at line 295 of file NyquistBase.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 EVT_COMMAND_RANGE(), and VisitSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetCommand()

void NyquistBase::SetCommand ( const wxString & cmd )

Definition at line 1865 of file NyquistBase.cpp.

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

References mExternal, and ParseCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetLispVarsFromParameters()

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

Definition at line 421 of file NyquistBase.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:

◆ StaticOSCallback()

void NyquistBase::StaticOSCallback ( void * userdata )

staticprivate

Definition at line 2724 of file NyquistBase.cpp.

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

Referenced by Process().

Here is the caller graph for this function:

◆ StaticOutputCallback()

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

staticprivate

Definition at line 2707 of file NyquistBase.cpp.

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

Referenced by Process().

Here is the caller graph for this function:

◆ Stop()

void NyquistBase::Stop ( )

Definition at line 1885 of file NyquistBase.cpp.

{
   mStop = true;
}

References mStop.

Referenced by NyqBench::OnStop().

Here is the caller graph for this function:

◆ ToTimeFormat()

wxString NyquistBase::ToTimeFormat ( double t )

protected

Definition at line 2847 of file NyquistBase.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 NyquistEffect::OnTime().

Here is the caller graph for this function:

◆ UnQuote()

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

staticprivate

Definition at line 1936 of file NyquistBase.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 NyquistBase::UnQuoteMsgid	(	const wxString &	s,
		bool	allowParens = `true`,
		wxString *	pExtraString = `nullptr`
	)

staticprivate

Definition at line 1890 of file NyquistBase.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 NyquistBase::Tokenizer::Tokenize(), NyquistBase::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 NyquistBase::validatePath ( wxString path )

protected

Definition at line 2837 of file NyquistBase.cpp.

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

Referenced by NyquistEffect::TransferDataFromEffectWindow().

Here is the caller graph for this function:

◆ VisitSettings() [1/2]

bool NyquistBase::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 Effect.

Definition at line 233 of file NyquistBase.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;
   }
 
   // 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 NyquistBase::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 Effect.

Definition at line 225 of file NyquistBase.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 305 of file NyquistBase.h.

Member Data Documentation

◆ mAction

TranslatableString NyquistBase::mAction

protected

Definition at line 260 of file NyquistBase.h.

Referenced by NyquistBase(), and Parse().

◆ mAuthor

TranslatableString NyquistBase::mAuthor

protected

Definition at line 262 of file NyquistBase.h.

Referenced by GetVendor(), NyquistBase(), and Parse().

◆ mBreak

bool NyquistBase::mBreak

protected

Definition at line 237 of file NyquistBase.h.

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

◆ mCategories

wxArrayString NyquistBase::mCategories

protected

Definition at line 297 of file NyquistBase.h.

Referenced by Parse(), and ParseProgram().

◆ mCmd

wxString NyquistBase::mCmd

protected

Definition at line 256 of file NyquistBase.h.

Referenced by ParseProgram(), and ProcessOne().

◆ mCompiler

bool NyquistBase::mCompiler

protected

Definition at line 241 of file NyquistBase.h.

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

◆ mCont

bool NyquistBase::mCont

protected

Definition at line 238 of file NyquistBase.h.

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

◆ mControls

std::vector<NyqControl> NyquistBase::mControls

Definition at line 287 of file NyquistBase.h.

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

◆ mCopyright

TranslatableString NyquistBase::mCopyright

protected

Definition at line 267 of file NyquistBase.h.

Referenced by GetDescription(), NyquistBase(), and Parse().

◆ mCount

unsigned NyquistBase::mCount

protected

Definition at line 294 of file NyquistBase.h.

Referenced by Process(), and ProcessOne().

◆ mDebug

bool NyquistBase::mDebug

protected

Definition at line 278 of file NyquistBase.h.

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

◆ mDebugButton

bool NyquistBase::mDebugButton

protected

Definition at line 276 of file NyquistBase.h.

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

◆ mDebugOutput

TranslatableString NyquistBase::mDebugOutput

protected

Definition at line 282 of file NyquistBase.h.

Referenced by Process(), and ProcessOne().

◆ mDebugOutputStr

wxString NyquistBase::mDebugOutputStr

protected

Definition at line 281 of file NyquistBase.h.

Referenced by OutputCallback(), and Process().

◆ mEnablePreview

bool NyquistBase::mEnablePreview

protected

Definition at line 275 of file NyquistBase.h.

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

◆ mExternal

bool NyquistBase::mExternal

protected

Definition at line 244 of file NyquistBase.h.

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

◆ mFileModified

wxDateTime NyquistBase::mFileModified

protected

When the script was last modified on disk.

Definition at line 234 of file NyquistBase.h.

Referenced by NyquistBase().

◆ mFileName

wxFileName NyquistBase::mFileName

protected

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

Definition at line 233 of file NyquistBase.h.

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

◆ mFirstInGroup

bool NyquistBase::mFirstInGroup

protected

Definition at line 292 of file NyquistBase.h.

Referenced by Process(), and ProcessOne().

◆ mFoundType

bool NyquistBase::mFoundType

protected

Definition at line 240 of file NyquistBase.h.

Referenced by Parse(), and ParseProgram().

◆ mHelpFile

wxString NyquistBase::mHelpFile

protected

Definition at line 269 of file NyquistBase.h.

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

◆ mHelpFileExists

bool NyquistBase::mHelpFileExists

protected

Definition at line 270 of file NyquistBase.h.

Referenced by ParseProgram(), and Process().

◆ mHelpPage

FilePath NyquistBase::mHelpPage

protected

Definition at line 271 of file NyquistBase.h.

Referenced by HelpPage(), and ParseProgram().

◆ mInfo

TranslatableString NyquistBase::mInfo

protected

Definition at line 261 of file NyquistBase.h.

Referenced by Parse().

◆ mInitError

TranslatableString NyquistBase::mInitError

protected

Definition at line 253 of file NyquistBase.h.

Referenced by Parse(), and ParseProgram().

◆ mInputCmd

wxString NyquistBase::mInputCmd

protected

Definition at line 254 of file NyquistBase.h.

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

◆ mIsPrompt

const bool NyquistBase::mIsPrompt

protected

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 251 of file NyquistBase.h.

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

◆ mIsSal

bool NyquistBase::mIsSal

protected

Definition at line 243 of file NyquistBase.h.

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

◆ mIsSpectral

bool NyquistBase::mIsSpectral

protected

Definition at line 245 of file NyquistBase.h.

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

◆ mIsTool

bool NyquistBase::mIsTool

protected

Definition at line 246 of file NyquistBase.h.

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

◆ mManPage

wxString NyquistBase::mManPage

protected

Definition at line 268 of file NyquistBase.h.

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

◆ mMaxLen

sampleCount NyquistBase::mMaxLen

protected

Definition at line 290 of file NyquistBase.h.

Referenced by NyquistBase(), Parse(), and Process().

◆ mMergeClips

int NyquistBase::mMergeClips

protected

Definition at line 303 of file NyquistBase.h.

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

◆ mName

TranslatableString NyquistBase::mName

protected

Name of the Effect (untranslated)

Definition at line 257 of file NyquistBase.h.

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

◆ mNumSelectedChannels

unsigned NyquistBase::mNumSelectedChannels

protected

Definition at line 295 of file NyquistBase.h.

Referenced by Process(), and ProcessOne().

◆ mOK

bool NyquistBase::mOK

protected

Definition at line 252 of file NyquistBase.h.

Referenced by IsOk(), NyquistBase(), and Parse().

◆ mOutputTime

double NyquistBase::mOutputTime

protected

Definition at line 293 of file NyquistBase.h.

Referenced by Process(), and ProcessOne().

◆ mParameters

wxString NyquistBase::mParameters

protected

Definition at line 255 of file NyquistBase.h.

Referenced by DoLoadSettings(), SaveSettings(), and VisitSettings().

◆ mPerTrackProps

wxString NyquistBase::mPerTrackProps

protected

Definition at line 300 of file NyquistBase.h.

Referenced by Process(), and ProcessOne().

◆ mProjectChanged

bool NyquistBase::mProjectChanged

protected

Definition at line 280 of file NyquistBase.h.

Referenced by Process(), and ProcessOne().

◆ mPromptName

TranslatableString NyquistBase::mPromptName

protected

Definition at line 259 of file NyquistBase.h.

Referenced by Init(), and NyquistBase().

◆ mPromptType

EffectType NyquistBase::mPromptType

protected

Definition at line 273 of file NyquistBase.h.

Referenced by DoLoadSettings(), Init(), and NyquistBase().

◆ mProps

wxString NyquistBase::mProps

protected

Definition at line 299 of file NyquistBase.h.

Referenced by Process(), and ProcessOne().

◆ mRedirectOutput

bool NyquistBase::mRedirectOutput

protected

Definition at line 279 of file NyquistBase.h.

Referenced by NyquistBase(), OutputCallback(), Process(), and RedirectOutput().

◆ mReentryCount

int NyquistBase::mReentryCount = 0

staticprivate

Definition at line 166 of file NyquistBase.h.

Referenced by Process().

◆ mReleaseVersion

TranslatableString NyquistBase::mReleaseVersion

protected

Definition at line 266 of file NyquistBase.h.

Referenced by GetVersion(), NyquistBase(), and Parse().

◆ mRestoreSplits

bool NyquistBase::mRestoreSplits

protected

Definition at line 302 of file NyquistBase.h.

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

◆ mStop

bool NyquistBase::mStop

protected

Definition at line 236 of file NyquistBase.h.

Referenced by NyquistBase(), OSCallback(), Process(), and Stop().

◆ mTrace

bool NyquistBase::mTrace

protected

Definition at line 242 of file NyquistBase.h.

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

◆ mTrackIndex

int NyquistBase::mTrackIndex

protected

Definition at line 291 of file NyquistBase.h.

Referenced by Process(), and ProcessOne().

◆ mType

EffectType NyquistBase::mType

protected

Definition at line 272 of file NyquistBase.h.

Referenced by DoLoadSettings(), GetClassification(), GetType(), Init(), NyquistBase(), Parse(), and ParseProgram().

◆ mVersion

int NyquistBase::mVersion

protected

Definition at line 284 of file NyquistBase.h.

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

◆ mXlispPath

wxString NyquistBase::mXlispPath

protected

Definition at line 230 of file NyquistBase.h.

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

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NyquistBase()

◆ ~NyquistBase()

Member Function Documentation

◆ Break()

◆ CheckHelpPage()

◆ Continue()

◆ DoLoadSettings()

◆ EnablesDebug()

◆ EscapeString()

◆ GetClassification()

◆ GetCtrlValue()

◆ GetDescription()

◆ GetFamily()

◆ GetNyquistSearchPath()

◆ GetPath()

◆ GetSymbol()

◆ GetType()

◆ GetVendor()

◆ GetVersion()

◆ HelpPage()

◆ Init()

◆ InitializationError()

◆ IsDefault()

◆ IsInteractive()

◆ IsOk()

◆ LoadSettings()

◆ ManualPage()

◆ NyquistToWxString()

◆ OSCallback()

◆ OutputCallback()

◆ Parse()

◆ ParseChoice()

◆ ParseCommand()

◆ ParseFile()

◆ ParseFileExtensions()

◆ ParseFileType()

◆ ParseFileTypes()

◆ ParseProgram()

◆ Process()

◆ ProcessOne()

◆ RedirectOutput()

◆ resolveFilePath()

◆ SaveSettings()

◆ SetCommand()

◆ SetLispVarsFromParameters()

◆ StaticOSCallback()

◆ StaticOutputCallback()

◆ Stop()

◆ ToTimeFormat()

◆ UnQuote()

◆ UnQuoteMsgid()

◆ validatePath()

◆ VisitSettings() [1/2]

◆ VisitSettings() [2/2]

Friends And Related Function Documentation

◆ NyquistEffectsModule

Member Data Documentation

◆ mAction

◆ mAuthor

◆ mBreak

◆ mCategories

◆ mCmd

◆ mCompiler

◆ mCont

◆ mControls

◆ mCopyright

◆ mCount