NyquistBase.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  NyquistBase.h
 
  Dominic Mazzoni
 
**********************************************************************/
#pragma once
 
#include "FileNames.h"
#include "SampleCount.h"
#include "StatefulEffect.h"
#include "WaveChannelViewConstants.h"
 
class wxArrayString;
class wxFileName;
class wxCheckBox;
class wxTextCtrl;
 
class EffectOutputTracks;
 
#define NYQUISTEFFECTS_VERSION wxT("1.0.0.0")
#define NYQUIST_WORKER_ID wxT("Nyquist Worker")
#define UNINITIALIZED_CONTROL ((double)99999999.99)
 
enum NyqControlType
{
   NYQ_CTRL_INT,
   NYQ_CTRL_FLOAT,
   NYQ_CTRL_STRING,
   NYQ_CTRL_CHOICE,
   NYQ_CTRL_INT_TEXT,
   NYQ_CTRL_FLOAT_TEXT,
   NYQ_CTRL_TEXT,
   NYQ_CTRL_TIME,
   NYQ_CTRL_FILE,
};
 
class NyqControl
{
public:
   NyqControl() = default;
   NyqControl(const NyqControl&) = default;
   NyqControl& operator=(const NyqControl&) = default;
   // NyqControl( NyqControl && ) = default;
   // NyqControl &operator = ( NyqControl && ) = default;
 
   int type;
   wxString var;
   wxString name;
   wxString label;
   std::vector<EnumValueSymbol> choices;
   FileNames::FileTypes fileTypes;
   wxString valStr;
   wxString lowStr;
   wxString highStr;
   double val;
   double low;
   double high;
   int ticks;
};
 
struct NyquistSettings
{
   // other settings, for the Nyquist prompt; else null
   EffectSettings proxySettings;
   bool proxyDebug { false };
   std::vector<NyqControl> controls;
 
   // Other fields, to do
};
 
class NYQUIST_EFFECTS_API NyquistBase :
    public EffectWithSettings<NyquistSettings, StatefulEffect>
{
public:
   struct NYQUIST_EFFECTS_API GetEffectHook :
       GlobalHook<
          GetEffectHook, std::unique_ptr<NyquistBase>(const wxString& pluginId)>
   {
   };
 
   struct NYQUIST_EFFECTS_API GetDisplaysHook :
       GlobalHook<
          GetDisplaysHook,
          std::vector<WaveChannelSubViewType>(const WaveTrack*)>
   {
   };
 
   struct NYQUIST_EFFECTS_API ShowDebugOutputHook :
       GlobalHook<
          ShowDebugOutputHook, void(
                                  const TranslatableString& title,
                                  const TranslatableString& message)>
   {
   };
 
   struct NYQUIST_EFFECTS_API ExecFromMainHook :
       GlobalHook<ExecFromMainHook, void(wxString* pIn, wxString* pOut)>
   {
   };
 
   struct YieldIfNeededHook : GlobalHook<YieldIfNeededHook, void()>
   {
   };
 
   NyquistBase(const wxString& fName);
   virtual ~NyquistBase();
 
   // ComponentInterface implementation
 
   PluginPath GetPath() const override;
   ComponentInterfaceSymbol GetSymbol() const override;
   VendorSymbol GetVendor() const override;
   wxString GetVersion() const override;
   TranslatableString GetDescription() const override;
 
   ManualPageID ManualPage() const override;
   FilePath HelpPage() const override;
 
   // EffectDefinitionInterface implementation
 
   EffectType GetType() const override;
   EffectType GetClassification() const override;
   EffectFamilySymbol GetFamily() const override;
   bool IsInteractive() const override;
   bool IsDefault() const override;
   bool EnablesDebug() const override;
 
   bool SaveSettings(
      const EffectSettings& settings, CommandParameters& parms) const override;
   bool LoadSettings(
      const CommandParameters& parms, EffectSettings& settings) const override;
   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);
 
   // Effect implementation
 
   bool Init() override;
   bool Process(EffectInstance& instance, EffectSettings& settings) override;
 
   // NyquistBase implementation
   // For Nyquist Workbench support
   void RedirectOutput();
   void SetCommand(const wxString& cmd);
   void Continue();
   void Break();
   void Stop();
 
   bool IsOk();
 
private:
   static int mReentryCount;
   // NyquistBase implementation
 
   struct NyxContext;
   bool ProcessOne(NyxContext& nyxContext, EffectOutputTracks* pOutputs);
 
   const TranslatableString& InitializationError() const
   {
      return mInitError;
   }
 
   static FilePaths GetNyquistSearchPath();
 
   static wxString NyquistToWxString(const char* nyqString);
   wxString EscapeString(const wxString& inStr);
   static std::vector<EnumValueSymbol> ParseChoice(const wxString& text);
 
   FileExtensions ParseFileExtensions(const wxString& text);
   FileNames::FileType ParseFileType(const wxString& text);
   FileNames::FileTypes ParseFileTypes(const wxString& text);
 
   static void StaticOutputCallback(int c, void* userdata);
   static void StaticOSCallback(void* userdata);
 
   void OutputCallback(int c);
   void OSCallback();
 
   void ParseFile();
 
protected:
   bool ParseCommand(const wxString& cmd);
 
private:
   bool ParseProgram(wxInputStream& stream);
   struct Tokenizer
   {
      bool sl { false };
      bool q { false };
      int paren { 0 };
      wxString tok;
      wxArrayStringEx tokens;
 
      bool Tokenize(
         const wxString& line, bool eof, size_t trimStart, size_t trimEnd);
   };
   bool Parse(Tokenizer& tokenizer, const wxString& line, bool eof, bool first);
 
   static TranslatableString UnQuoteMsgid(
      const wxString& s, bool allowParens = true,
      wxString* pExtraString = nullptr);
   static wxString UnQuote(
      const wxString& s, bool allowParens = true,
      wxString* pExtraString = nullptr);
 
protected:
   static double GetCtrlValue(const wxString& s);
   static void resolveFilePath(wxString& path, FileExtension extension = {});
   bool validatePath(wxString path);
   wxString ToTimeFormat(double t);
 
private:
   std::pair<bool, FilePath> CheckHelpPage() const;
 
protected:
   wxString mXlispPath;
 
   wxFileName
      mFileName; 
   wxDateTime mFileModified; 
 
   bool mStop;
   bool mBreak;
   bool mCont;
 
   bool mFoundType;
   bool mCompiler;
   bool mTrace; // True when *tracenable* or *sal-traceback* are enabled
   bool mIsSal;
   bool mExternal;
   bool mIsSpectral;
   bool mIsTool;
   const bool mIsPrompt;
   bool mOK;
   TranslatableString mInitError;
   wxString mInputCmd;       // history: exactly what the user typed
   wxString mParameters;     // The parameters of to be fed to a nested prompt
   wxString mCmd;            // the command to be processed
   TranslatableString mName; 
   TranslatableString
      mPromptName; // If a prompt, we need to remember original name.
   TranslatableString mAction;
   TranslatableString mInfo;
   TranslatableString mAuthor;
   // Version number of the specific plug-in (not to be confused with mVersion)
   // For shipped plug-ins this will be the same as the Audacity release version
   // when the plug-in was last modified.
   TranslatableString mReleaseVersion;
   TranslatableString mCopyright;
   wxString mManPage; // ONLY use if a help page exists in the manual.
   wxString mHelpFile;
   bool mHelpFileExists;
   FilePath mHelpPage;
   EffectType mType;
   EffectType mPromptType; // If a prompt, need to remember original type.
 
   bool mEnablePreview;
   bool mDebugButton; // Set to false to disable Debug button.
 
   bool mDebug; // When true, debug window is shown.
   bool mRedirectOutput;
   bool mProjectChanged;
   wxString mDebugOutputStr;
   TranslatableString mDebugOutput;
 
   int mVersion; // Syntactic version of Nyquist plug-in (not to be confused
                 // with mReleaseVersion)
public:
   std::vector<NyqControl> mControls;
 
protected:
   sampleCount mMaxLen;
   int mTrackIndex;
   bool mFirstInGroup;
   double mOutputTime;
   unsigned mCount;
   unsigned mNumSelectedChannels;
 
   wxArrayString mCategories;
 
   wxString mProps;
   wxString mPerTrackProps;
 
   bool mRestoreSplits;
   int mMergeClips;
 
   friend class NyquistEffectsModule;
};