#include <VampEffect.h>

Inheritance diagram for VampEffect:

Collaboration diagram for VampEffect:

Public Member Functions
	VampEffect (std::unique_ptr< Vamp::Plugin > &&plugin, const PluginPath &path, int output, bool hasParameters)

virtual	~VampEffect ()

PluginPath	GetPath () override

ComponentInterfaceSymbol	GetSymbol () override

VendorSymbol	GetVendor () override

wxString	GetVersion () override

TranslatableString	GetDescription () override

EffectType	GetType () override
	Type determines how it behaves. More...

EffectFamilySymbol	GetFamily () override
	Report identifier and user-visible name of the effect protocol. More...

bool	IsInteractive () override
	Whether the effect needs a dialog for entry of settings. More...

bool	IsDefault () override
	Whether the effect sorts "above the line" in the menus. More...

bool	GetAutomationParameters (CommandParameters &parms) override
	Save current settings into parms. More...

bool	SetAutomationParameters (CommandParameters &parms) override
	Change settings to those stored in parms. More...

unsigned	GetAudioInCount () override

bool	Init () override

bool	Process () override

void	End () override

void	PopulateOrExchange (ShuttleGui &S) override

bool	TransferDataToWindow () override

bool	TransferDataFromWindow () override

Public Member Functions inherited from Effect
	Effect ()

virtual	~Effect ()

bool	IsLegacy () override

bool	SupportsRealtime () override
	Whether the effect supports realtime previewing (while audio is playing). More...

bool	SupportsAutomation () override
	Whether the effect can be used without the UI, in a macro. More...

bool	LoadUserPreset (const RegistryPath &name) override
	Change settings to a user-named preset. More...

bool	SaveUserPreset (const RegistryPath &name) override
	Save current settings as a user-named preset. More...

RegistryPaths	GetFactoryPresets () override
	Report names of factory presets. More...

bool	LoadFactoryPreset (int id) override
	Change settings to the preset whose name is `GetFactoryPresets()[id]` More...

bool	LoadFactoryDefaults () override
	Change settings back to "factory default". More...

bool	SetHost (EffectHostInterface *host) override

unsigned	GetAudioOutCount () override

int	GetMidiInCount () override

int	GetMidiOutCount () override

sampleCount	GetLatency () override
	Called for destructive, non-realtime effect computation. More...

size_t	GetTailSize () override

void	SetSampleRate (double rate) override

size_t	SetBlockSize (size_t maxBlockSize) override

size_t	GetBlockSize () const override

bool	ProcessInitialize (sampleCount totalLen, ChannelNames chanMap=NULL) override
	Called for destructive, non-realtime effect computation. More...

bool	ProcessFinalize () override
	Called for destructive, non-realtime effect computation. More...

size_t	ProcessBlock (float inBlock, float outBlock, size_t blockLen) override
	Called for destructive, non-realtime effect computation. More...

bool	RealtimeInitialize () override

bool	RealtimeAddProcessor (unsigned numChannels, float sampleRate) override

bool	RealtimeFinalize () override

bool	RealtimeSuspend () override

bool	RealtimeResume () noexcept override

bool	RealtimeProcessStart () override

size_t	RealtimeProcess (int group, float inbuf, float outbuf, size_t numSamples) override

bool	RealtimeProcessEnd () noexcept override

int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal=false) override

bool	PopulateUI (ShuttleGui &S) final
	Adds controls to a panel that is given as the parent window of `S` More...

bool	IsGraphicalUI () override

bool	ValidateUI () override

bool	HideUI () override

bool	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets () override

void	ImportPresets () override

bool	HasOptions () override

void	ShowOptions () override

EffectDefinitionInterface &	GetDefinition () override

double	GetDuration () override

NumericFormatSymbol	GetDurationFormat () override

virtual NumericFormatSymbol	GetSelectionFormat ()

void	SetDuration (double duration) override

RegistryPath	GetUserPresetsGroup (const RegistryPath &name) override

RegistryPath	GetCurrentSettingsGroup () override

RegistryPath	GetFactoryDefaultsGroup () override

virtual wxString	GetSavedStateGroup ()

int	ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, bool forceModal=false) override

unsigned	TestUIFlags (unsigned mask)

void	SetPresetParameters (const wxArrayString Names, const wxArrayString Values)

virtual bool	Startup (EffectUIClientInterface *client)

virtual bool	GetAutomationParametersAsString (wxString &parms)

virtual bool	SetAutomationParametersFromString (const wxString &parms)

virtual bool	IsBatchProcessing ()

virtual void	SetBatchProcessing (bool start)

bool	DoEffect (double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent=nullptr, const EffectDialogFactory &dialogFactory={})

bool	Delegate (Effect &delegate, wxWindow &parent, const EffectDialogFactory &factory)

int	MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})

virtual bool	Startup ()

Public Member Functions inherited from EffectUIClientInterface
virtual	~EffectUIClientInterface ()

Public Member Functions inherited from EffectProcessor
virtual	~EffectProcessor ()

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

virtual EffectType	GetClassification ()
	Determines which menu it appears in; default same as GetType(). More...

virtual bool	EnablesDebug ()
	Whether the effect dialog should have a Debug button; default, always false. More...

virtual ManualPageID	ManualPage ()
	Name of a page in the Audacity alpha manual, default is empty. More...

virtual FilePath	HelpPage ()
	Fully qualified local help file name, default is empty. More...

virtual bool	IsHiddenFromMenus ()
	Default is false. More...

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

TranslatableString	GetName ()

virtual bool	DefineParams (ShuttleParams &WXUNUSED(S))

Public Member Functions inherited from EffectUIHostInterface
virtual	~EffectUIHostInterface ()

Public Member Functions inherited from EffectHostInterface
virtual	~EffectHostInterface ()

Private Member Functions
void	AddFeatures (LabelTrack *track, Vamp::Plugin::FeatureSet &features)

void	UpdateFromPlugin ()

void	OnCheckBox (wxCommandEvent &evt)

void	OnChoice (wxCommandEvent &evt)

void	OnSlider (wxCommandEvent &evt)

void	OnTextCtrl (wxCommandEvent &evt)

Private Attributes
std::unique_ptr< Vamp::Plugin >	mPlugin

PluginPath	mPath

int	mOutput

bool	mHasParameters

Vamp::HostExt::PluginLoader::PluginKey	mKey

wxString	mName

double	mRate

bool	mInSlider

bool	mInText

Vamp::Plugin::ParameterList	mParameters

Floats	mValues

ArrayOf< wxSlider * >	mSliders

ArrayOf< wxTextCtrl * >	mFields

ArrayOf< wxStaticText * >	mLabels

ArrayOf< wxCheckBox * >	mToggles

ArrayOf< wxChoice * >	mChoices

wxChoice *	mProgram

Additional Inherited Members
Public Types inherited from Effect
enum	: long { DefaultMessageBoxStyle = wxOK \| wxCENTRE }

Static Public Member Functions inherited from Effect
static void	IncEffectCounter ()

Static Public Member Functions inherited from EffectDefinitionInterface
static Identifier	GetSquashedName (const Identifier &ident)
	A utility that strips spaces and CamelCases a name. More...

Static Public Attributes inherited from Effect
static const wxString	kUserPresetIdent = wxT("User Preset:")

static const wxString	kFactoryPresetIdent = wxT("Factory Preset:")

static const wxString	kCurrentSettingsIdent = wxT("<Current Settings>")

static const wxString	kFactoryDefaultsIdent = wxT("<Factory Defaults>")

Protected Member Functions inherited from Effect
bool	EnableApply (bool enable=true)

bool	EnablePreview (bool enable=true)

virtual bool	CheckWhetherSkipEffect ()

virtual bool	ProcessPass ()

virtual bool	InitPass1 ()

virtual bool	InitPass2 ()

virtual double	CalcPreviewInputLength (double previewLength)

virtual void	Preview (bool dryOnly)

bool	TotalProgress (double frac, const TranslatableString &={})

bool	TrackProgress (int whichTrack, double frac, const TranslatableString &={})

bool	TrackGroupProgress (int whichGroup, double frac, const TranslatableString &={})

int	GetNumWaveTracks ()

int	GetNumWaveGroups ()

void	GetBounds (const WaveTrack &track, const WaveTrack pRight, sampleCount start, sampleCount *len)

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing ()

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	CopyInputTracks (bool allSyncLockSelected=false)

std::shared_ptr< AddedAnalysisTrack >	AddAnalysisTrack (const wxString &name=wxString())

ModifiedAnalysisTrack	ModifyAnalysisTrack (const LabelTrack *pOrigTrack, const wxString &name=wxString())

void	ReplaceProcessedTracks (const bool bGoodResult)

Track *	AddToOutputTracks (const std::shared_ptr< Track > &t)

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Protected Attributes inherited from Effect
BasicUI::ProgressDialog *	mProgress = nullptr

double	mProjectRate

double	mSampleRate

WaveTrackFactory *	mFactory

std::shared_ptr< TrackList >	mOutputTracks

double	mT0

double	mT1

wxArrayString	mPresetNames

wxArrayString	mPresetValues

int	mPass

wxWeakRef< wxDialog >	mHostUIDialog
	This smart pointer tracks the lifetime of the dialog. More...

wxWeakRef< wxDialog >	mUIDialog
	This weak pointer may be the same as the above, or null. More...

wxWindow *	mUIParent

unsigned	mUIFlags { 0 }

sampleCount	mSampleCnt

Static Protected Attributes inherited from Effect
static int	nEffectsDone =0

Detailed Description

Definition at line 36 of file VampEffect.h.

Constructor & Destructor Documentation

◆ VampEffect()

VampEffect::VampEffect	(	std::unique_ptr< Vamp::Plugin > &&	plugin,
		const PluginPath &	path,
		int	output,
		bool	hasParameters
	)

Definition at line 68 of file VampEffect.cpp.

 :  mPlugin(std::move(plugin)),
    mPath(path),
    mOutput(output),
    mHasParameters(hasParameters),
    mRate(0)
 {
    mKey = mPath.BeforeLast(wxT('/')).ToUTF8();
    mName = mPath.AfterLast(wxT('/'));
 }

◆ ~VampEffect()

VampEffect::~VampEffect ( )

virtual

Definition at line 82 of file VampEffect.cpp.

83 {

84 }

Member Function Documentation

◆ AddFeatures()

void VampEffect::AddFeatures	(	LabelTrack *	track,
		Vamp::Plugin::FeatureSet &	features
	)

private

Definition at line 720 of file VampEffect.cpp.

 {
    for (Vamp::Plugin::FeatureList::iterator fli = features[mOutput].begin();
         fli != features[mOutput].end(); ++fli)
    {
       Vamp::RealTime ftime0 = fli->timestamp;
       double ltime0 = ftime0.sec + (double(ftime0.nsec) / 1000000000.0);
  
       Vamp::RealTime ftime1 = ftime0;
       if (fli->hasDuration) ftime1 = ftime0 + fli->duration;
       double ltime1 = ftime1.sec + (double(ftime1.nsec) / 1000000000.0);
  
       wxString label = LAT1CTOWX(fli->label.c_str());
       if (label == wxString())
       {
          if (fli->values.empty())
          {
             label = wxString::Format(LAT1CTOWX("%.3f"), ltime0);
          }
          else
          {
             label = wxString::Format(LAT1CTOWX("%.3f"), *fli->values.begin());
          }
       }
  
       ltrack->AddLabel(SelectedRegion(ltime0, ltime1), label);
    }
 }

References LabelTrack::AddLabel(), label, LAT1CTOWX, and mOutput.

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ End()

void VampEffect::End ( )

overridevirtual

Reimplemented from Effect.

Definition at line 530 of file VampEffect.cpp.

 {
    mPlugin.reset();
 }

References mPlugin.

◆ GetAudioInCount()

unsigned VampEffect::GetAudioInCount ( )

overridevirtual

Reimplemented from Effect.

Definition at line 143 of file VampEffect.cpp.

 {
    return mPlugin->getMaxChannelCount();
 }

References mPlugin.

◆ GetAutomationParameters()

bool VampEffect::GetAutomationParameters ( CommandParameters & parms )

overridevirtual

Save current settings into parms.

Reimplemented from Effect.

Definition at line 148 of file VampEffect.cpp.

 {
    for (size_t p = 0, paramCount = mParameters.size(); p < paramCount; p++)
    {
       wxString key = wxString::FromUTF8(mParameters[p].identifier.c_str());
       float value = mPlugin->getParameter(mParameters[p].identifier);
       float lower = mParameters[p].minValue;
       float upper = mParameters[p].maxValue;
  
       if (mParameters[p].isQuantized &&
           mParameters[p].quantizeStep == 1.0 &&
           lower == 0.0 &&
           upper == 1.0)
       {
          bool val = value > 0.5;
  
          parms.Write(key, val);
       }
       else if (mParameters[p].isQuantized &&
                mParameters[p].quantizeStep == 1.0 &&
                !mParameters[p].valueNames.empty())
       {
          std::vector<EnumValueSymbol> choices;
          int val = 0;
  
          for (size_t i = 0, choiceCount = mParameters[p].valueNames.size(); i < choiceCount; i++)
          {
             wxString choice = wxString::FromUTF8(mParameters[p].valueNames[i].c_str());
             if (size_t(value - mParameters[p].minValue + 0.5) == i)
             {
                val = i;
             }
             choices.push_back(choice);
          }
  
          parms.WriteEnum(key, val, choices.data(), choices.size());
       }
       else
       {
          parms.Write(key, value);
       }
    }
  
    return true;
 }

References key, mParameters, mPlugin, and CommandParameters::WriteEnum().

Here is the call graph for this function:

◆ GetDescription()

TranslatableString VampEffect::GetDescription ( )

overridevirtual

Reimplemented from Effect.

Definition at line 110 of file VampEffect.cpp.

 {
    return Verbatim(
       wxString::FromUTF8(mPlugin->getCopyright().c_str()) );
 }

References mPlugin, and Verbatim().

Here is the call graph for this function:

◆ GetFamily()

EffectFamilySymbol VampEffect::GetFamily ( )

overridevirtual

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

Reimplemented from Effect.

Definition at line 125 of file VampEffect.cpp.

 {
    return VAMPEFFECTS_FAMILY;
 }

References VAMPEFFECTS_FAMILY.

◆ GetPath()

PluginPath VampEffect::GetPath ( )

overridevirtual

Reimplemented from Effect.

Definition at line 90 of file VampEffect.cpp.

 {
    return mPath;
 }

References mPath.

◆ GetSymbol()

ComponentInterfaceSymbol VampEffect::GetSymbol ( )

overridevirtual

Reimplemented from Effect.

Definition at line 95 of file VampEffect.cpp.

 {
    return mName;
 }

References mName.

Referenced by Process().

Here is the caller graph for this function:

◆ GetType()

EffectType VampEffect::GetType ( )

overridevirtual

Type determines how it behaves.

Reimplemented from Effect.

Definition at line 120 of file VampEffect.cpp.

 {
    return EffectTypeAnalyze;
 }

References EffectTypeAnalyze.

◆ GetVendor()

VendorSymbol VampEffect::GetVendor ( )

overridevirtual

Reimplemented from Effect.

Definition at line 100 of file VampEffect.cpp.

 {
    return { wxString::FromUTF8(mPlugin->getMaker().c_str()) };
 }

References mPlugin.

◆ GetVersion()

wxString VampEffect::GetVersion ( )

overridevirtual

Reimplemented from Effect.

Definition at line 105 of file VampEffect.cpp.

 {
    return wxString::Format(wxT("%d"), mPlugin->getPluginVersion());
 }

References mPlugin.

◆ Init()

bool VampEffect::Init ( )

overridevirtual

Reimplemented from Effect.

Definition at line 299 of file VampEffect.cpp.

 {
    mRate = 0.0;
  
    // PRL: this loop checked that channels of a track have the same rate,
    // but there was no check that all tracks have one rate, and only the first
    // is remembered in mRate.  Is that correct?
  
    for (auto leader : inputTracks()->Leaders<const WaveTrack>()) {
       auto channelGroup = TrackList::Channels( leader );
       auto rate = (*channelGroup.first++) -> GetRate();
       for(auto channel : channelGroup) {
          if (rate != channel->GetRate())
          // PRL:  Track rate might not match individual clip rates.
          // So is this check not adequate?
           {
              // TODO: more-than-two-channels-message
              Effect::MessageBox(
                 XO(
 "Sorry, Vamp Plug-ins cannot be run on stereo tracks where the individual channels of the track do not match.") );
              return false;
          }
       }
       if (mRate == 0.0)
          mRate = rate;
    }
  
    if (mRate <= 0.0)
    {
       mRate = mProjectRate;
    }
  
    // The plugin must be reloaded to allow changing parameters
  
    Vamp::HostExt::PluginLoader *loader = Vamp::HostExt::PluginLoader::getInstance();
    mPlugin.reset(loader->loadPlugin(mKey, mRate, Vamp::HostExt::PluginLoader::ADAPT_ALL));
    if (!mPlugin)
    {
       Effect::MessageBox( XO("Sorry, failed to load Vamp Plug-in.") );
       return false;
    }
  
    return true;
 }

References TrackList::Channels(), anonymous_namespace{TimeTrack.cpp}::GetRate(), Effect::inputTracks(), Effect::MessageBox(), mKey, mPlugin, Effect::mProjectRate, mRate, and XO.

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsDefault()

bool VampEffect::IsDefault ( )

overridevirtual

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

Reimplemented from Effect.

Definition at line 135 of file VampEffect.cpp.

 {
    return false;
 }

◆ IsInteractive()

bool VampEffect::IsInteractive ( )

overridevirtual

Whether the effect needs a dialog for entry of settings.

Reimplemented from Effect.

Definition at line 130 of file VampEffect.cpp.

 {
    return mHasParameters;
 }

References mHasParameters.

◆ OnCheckBox()

void VampEffect::OnCheckBox ( wxCommandEvent & evt )

private

Definition at line 793 of file VampEffect.cpp.

 {
    int p = event.GetId() - ID_Toggles;
  
    mPlugin->setParameter(mParameters[p].identifier, mToggles[p]->GetValue());
 }

References ID_Toggles, mParameters, mPlugin, and mToggles.

◆ OnChoice()

void VampEffect::OnChoice ( wxCommandEvent & evt )

private

Definition at line 800 of file VampEffect.cpp.

 {
    int p = evt.GetId();
  
    // special value for programs
    if (p == ID_Program)
    {
       Vamp::Plugin::ProgramList programs = mPlugin->getPrograms();
       mPlugin->selectProgram(programs[evt.GetInt()]);
       UpdateFromPlugin();
       return;
    }
  
    mPlugin->setParameter(mParameters[p - ID_Choices].identifier, evt.GetInt());
 }

References ID_Choices, ID_Program, mParameters, mPlugin, and UpdateFromPlugin().

Here is the call graph for this function:

◆ OnSlider()

void VampEffect::OnSlider ( wxCommandEvent & evt )

private

Definition at line 816 of file VampEffect.cpp.

 {
    int p = evt.GetId() - ID_Sliders;
  
    float lower = mParameters[p].minValue;
    float upper = mParameters[p].maxValue;
    float range = upper - lower;
    float val = (evt.GetInt() / 1000.0) * range;
  
    if (mParameters[p].isQuantized)
    {
       float qs = mParameters[p].quantizeStep;
  
       if (qs != 0.0)
       {
          val = (int)(val / qs + 0.5) * qs;
       }
    }
  
    val += lower;
  
    mValues[p] = val;
    mFields[p]->GetValidator()->TransferToWindow();
  
    mPlugin->setParameter(mParameters[p].identifier, val);
 }

References ID_Sliders, mFields, mParameters, mPlugin, and mValues.

◆ OnTextCtrl()

void VampEffect::OnTextCtrl ( wxCommandEvent & evt )

private

Definition at line 843 of file VampEffect.cpp.

 {
    int p = evt.GetId() - ID_Texts;
  
    mFields[p]->GetValidator()->TransferFromWindow();
  
    float lower = mParameters[p].minValue;
    float upper = mParameters[p].maxValue;
    float range = upper - lower;
    float val = mValues[p];
  
    if (mParameters[p].isQuantized)
    {
       float qs = mParameters[p].quantizeStep;
  
       if (qs != 0.0)
       {
          val = (int)((val - lower) / qs + 0.5) * qs + lower;
       }
    }
  
    mPlugin->setParameter(mParameters[p].identifier, val);
  
    mSliders[p]->SetValue((int)(((val - lower) / range) * 1000.0 + 0.5));
 }

References ID_Texts, mFields, mParameters, mPlugin, mSliders, and mValues.

◆ PopulateOrExchange()

void VampEffect::PopulateOrExchange ( ShuttleGui & S )

overridevirtual

Reimplemented from Effect.

Definition at line 535 of file VampEffect.cpp.

 {
    Vamp::Plugin::ProgramList programs = mPlugin->getPrograms();
  
    mParameters = mPlugin->getParameterDescriptors();
  
    auto count = mParameters.size();
  
    mToggles.reinit( count );
    mSliders.reinit( count );
    mFields.reinit( count );
    mLabels.reinit( count );
    mChoices.reinit( count );
    mValues.reinit( count );
  
    wxScrolledWindow *scroller = S.Style(wxVSCROLL | wxTAB_TRAVERSAL)
       .StartScroller(2);
    {
       S.StartStatic(XO("Plugin Settings"));
       {
          S.StartMultiColumn(5, wxEXPAND);
          {
             S.SetStretchyCol(3);
  
             if (!programs.empty())
             {
                S.AddPrompt(XXO("Program"));
  
                S.Id(ID_Program);
                mProgram = S.Name(XO("Program"))
                   .MinSize( { -1, -1 } )
                   .Position(wxEXPAND | wxALIGN_CENTER_VERTICAL | wxALL)
                   .AddChoice( {},
                      [&]{
                         TranslatableStrings choices;
                         for (const auto &program : programs)
                            choices.push_back(
                               Verbatim(wxString::FromUTF8(program.c_str())));
                         return choices;
                      }(),
                      Verbatim( wxString::FromUTF8(mPlugin->getCurrentProgram().c_str()) )
                   );
  
                S.AddSpace(1, 1);
                S.AddSpace(1, 1);
                S.AddSpace(1, 1);
             }
  
             for (size_t p = 0; p < count; p++)
             {
                wxString tip = wxString::FromUTF8(mParameters[p].description.c_str());
                wxString unit = wxString::FromUTF8(mParameters[p].unit.c_str());
  
                float value = mPlugin->getParameter(mParameters[p].identifier);
  
                mToggles[p] = NULL;
                mChoices[p] = NULL;
                mSliders[p] = NULL;
                mFields[p] = NULL;
                mValues[p] = 0.0;
  
                wxString labelText = wxString::FromUTF8(mParameters[p].name.c_str());
                if (!unit.empty())
                {
                   labelText += wxT(" (") + unit + wxT(")");
                }
                /* i18n-hint: An item name introducing a value, which is not part of the string but
                appears in a following text box window; translate with appropriate punctuation */
                S.AddPrompt(XXO("%s:").Format( labelText ));
  
                if (mParameters[p].isQuantized &&
                    mParameters[p].quantizeStep == 1.0 &&
                    mParameters[p].minValue == 0.0 &&
                    mParameters[p].maxValue == 1.0)
                {
                   S.Id(ID_Toggles + p);
                   mToggles[p] = S.ToolTip( Verbatim( tip ) )
                      .Name( Verbatim( labelText ) )
                      .Position(wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL | wxALL)
                      .AddCheckBox( {},
                                   value > 0.5 );
  
                   S.AddSpace(1, 1);
                   S.AddSpace(1, 1);
                   S.AddSpace(1, 1);
  
                }
                else if (mParameters[p].isQuantized &&
                         mParameters[p].quantizeStep == 1.0 &&
                         !mParameters[p].valueNames.empty())
                {
                   TranslatableStrings choices;
                   int selected = -1;
  
                   for (size_t i = 0, cnt = mParameters[p].valueNames.size(); i < cnt; i++)
                   {
                      wxString choice = wxString::FromUTF8(mParameters[p].valueNames[i].c_str());
                      if (size_t(value - mParameters[p].minValue + 0.5) == i)
                      {
                         selected = i;
                      }
                      choices.push_back( Verbatim( choice ) );
                   }
  
                   S.Id(ID_Choices + p);
                   mChoices[p] = S.ToolTip( Verbatim( tip ) )
                      .Name( Verbatim( labelText ) )
                      .Position(wxEXPAND | wxALIGN_CENTER_VERTICAL | wxALL)
                      .MinSize( { -1, -1 } )
                      .AddChoice( {}, choices, selected );
  
                   S.AddSpace(1, 1);
                   S.AddSpace(1, 1);
                   S.AddSpace(1, 1);
                }
                else
                {
                   mValues[p] = value;
  
                   float range = mParameters[p].maxValue - mParameters[p].minValue;
  
                   S.Id(ID_Texts + p);
                   mFields[p] = S.ToolTip( Verbatim( tip ) )
                      .Name( Verbatim( labelText ) )
                      .Position(wxALIGN_CENTER_VERTICAL | wxALL)
                      .Validator<FloatingPointValidator<float>>(
                         6, &mValues[p],
                         (range < 10
                            ? NumValidatorStyle::THREE_TRAILING_ZEROES
                            : range < 100
                               ? NumValidatorStyle::TWO_TRAILING_ZEROES
                               : NumValidatorStyle::ONE_TRAILING_ZERO),
                         mParameters[p].minValue, mParameters[p].maxValue)
                      .AddTextBox( {}, wxT(""), 12);
  
                   wxString str = Internat::ToDisplayString(mParameters[p].minValue);
                   S.AddPrompt( Verbatim( str ) );
  
                   S.Id(ID_Sliders + p);
                   mSliders[p] = S.ToolTip( Verbatim( tip ) )
                      .Name( Verbatim( labelText ) )
                      .Style(wxSL_HORIZONTAL)
                      .MinSize( { 150, -1 } )
                      .AddSlider( {}, 0, 1000, 0);
  
                   str = Internat::ToDisplayString(mParameters[p].maxValue);
                   S.AddUnits( Verbatim( str ) );
                }
             }
          }
          S.EndMultiColumn();
       }
       S.EndStatic();
    }
    S.EndScroller();
  
    scroller->SetScrollRate(0, 20);
  
    return;
 }

References ID_Choices, ID_Program, ID_Sliders, ID_Texts, ID_Toggles, mChoices, mFields, mLabels, mParameters, mPlugin, mProgram, mSliders, mToggles, mValues, name, ArrayOf< X >::reinit(), S, str, Internat::ToDisplayString(), Verbatim(), XO, and XXO.

Here is the call graph for this function:

◆ Process()

bool VampEffect::Process ( )

overridevirtual

If Process() is not overridden, it uses ProcessInitialize(), ProcessBlock(), and ProcessFinalize() methods of EffectProcessor, and also GetLatency() to determine how many leading output samples to discard and how many extra samples to produce.

!! todo: retain parameters previously set

Reimplemented from Effect.

Definition at line 344 of file VampEffect.cpp.

 {
    if (!mPlugin)
    {
       return false;
    }
  
    int count = 0;
  
    bool multiple = false;
    unsigned prevTrackChannels = 0;
  
    if (GetNumWaveGroups() > 1)
    {
       // if there is another track beyond this one and any linked one,
       // then we're processing more than one track.  That means we
       // should use the originating track name in each NEW label
       // track's name, to make clear which is which
       multiple = true;
    }
  
    std::vector<std::shared_ptr<Effect::AddedAnalysisTrack>> addedTracks;
  
    for (auto leader : inputTracks()->Leaders<const WaveTrack>())
    {
       auto channelGroup = TrackList::Channels(leader);
       auto left = *channelGroup.first++;
  
       unsigned channels = 1;
  
       // channelGroup now contains all but the first channel
       const WaveTrack *right =
          channelGroup.size() ? *channelGroup.first++ : nullptr;
       if (right)
          channels = 2;
  
       sampleCount start = 0;
       sampleCount len = 0;
       GetBounds(*left, right, &start, &len);
  
       // TODO: more-than-two-channels
  
       size_t step = mPlugin->getPreferredStepSize();
       size_t block = mPlugin->getPreferredBlockSize();
  
       bool initialiseRequired = true;
  
       if (block == 0)
       {
          if (step != 0)
          {
             block = step;
          }
          else
          {
             block = 1024;
          }
       }
  
       if (step == 0)
       {
          step = block;
       }
  
       if (prevTrackChannels > 0)
       {
          // Plugin has already been initialised, so if the number of
          // channels remains the same, we only need to do a reset.
          // Otherwise we need to re-construct the whole plugin,
          // because a Vamp plugin can't be re-initialised.
          if (prevTrackChannels == channels)
          {
             mPlugin->reset();
             initialiseRequired = false;
          }
          else
          {
             Init();
          }
       }
  
       if (initialiseRequired)
       {
          if (!mPlugin->initialise(channels, step, block))
          {
             Effect::MessageBox(
                XO("Sorry, Vamp Plug-in failed to initialize.") );
             return false;
          }
       }
  
       const auto effectName = GetSymbol().Translation();
       addedTracks.push_back(AddAnalysisTrack(
          multiple
          ? wxString::Format( _("%s: %s"), left->GetName(), effectName )
          : effectName
       ));
       LabelTrack *ltrack = addedTracks.back()->get();
  
       FloatBuffers data{ channels, block };
  
       auto originalLen = len;
  
       auto pos = start;
  
       while (len != 0)
       {
          const auto request = limitSampleBufferSize( block, len );
  
          if (left)
          {
             left->GetFloats(data[0].get(), pos, request);
          }
  
          if (right)
          {
             right->GetFloats(data[1].get(), pos, request);
          }
  
          if (request < block)
          {
             for (unsigned int c = 0; c < channels; ++c)
             {
                for (decltype(block) i = request; i < block; ++i)
                {
                   data[c][i] = 0.f;
                }
             }
          }
  
          // UNSAFE_SAMPLE_COUNT_TRUNCATION
          // Truncation in case of very long tracks!
          Vamp::RealTime timestamp = Vamp::RealTime::frame2RealTime(
             long( pos.as_long_long() ),
             (int)(mRate + 0.5)
          );
  
          Vamp::Plugin::FeatureSet features = mPlugin->process(
             reinterpret_cast< float** >( data.get() ), timestamp);
          AddFeatures(ltrack, features);
  
          if (len > (int)step)
          {
             len -= step;
          }
          else
          {
             len = 0;
          }
  
          pos += step;
  
          if (channels > 1)
          {
             if (TrackGroupProgress(count,
                   (pos - start).as_double() /
                   originalLen.as_double() ))
             {
                return false;
             }
          }
          else
          {
             if (TrackProgress(count,
                   (pos - start).as_double() /
                   originalLen.as_double() ))
             {
                return false;
             }
          }
       }
  
       Vamp::Plugin::FeatureSet features = mPlugin->getRemainingFeatures();
       AddFeatures(ltrack, features);
  
       prevTrackChannels = channels;
    }
  
    // All completed without cancellation, so commit the addition of tracks now
    for (auto &addedTrack : addedTracks)
       addedTrack->Commit();
  
    return true;
 }

References _, Effect::AddAnalysisTrack(), AddFeatures(), TrackList::Channels(), Effect::GetBounds(), SampleTrack::GetFloats(), Effect::GetNumWaveGroups(), GetSymbol(), Init(), Effect::inputTracks(), limitSampleBufferSize(), Effect::MessageBox(), mPlugin, mRate, ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::size(), Effect::TrackGroupProgress(), Effect::TrackProgress(), ComponentInterfaceSymbol::Translation(), and XO.

Here is the call graph for this function:

◆ SetAutomationParameters()

bool VampEffect::SetAutomationParameters ( CommandParameters & parms )

overridevirtual

Change settings to those stored in parms.

Reimplemented from Effect.

Definition at line 194 of file VampEffect.cpp.

 {
    // First pass verifies values
    for (size_t p = 0, paramCount = mParameters.size(); p < paramCount; p++)
    {
       wxString key = wxString::FromUTF8(mParameters[p].identifier.c_str());
       float lower = mParameters[p].minValue;
       float upper = mParameters[p].maxValue;
       bool good = false;
  
       if (mParameters[p].isQuantized &&
           mParameters[p].quantizeStep == 1.0 &&
           lower == 0.0 &&
           upper == 1.0)
       {
          bool val;
  
          good = parms.Read(key, &val);
       }
       else if (mParameters[p].isQuantized &&
                mParameters[p].quantizeStep == 1.0 &&
                !mParameters[p].valueNames.empty())
       {
          std::vector<EnumValueSymbol> choices;
          int val;
  
          for (size_t i = 0, choiceCount = mParameters[p].valueNames.size(); i < choiceCount; i++)
          {
             wxString choice = wxString::FromUTF8(mParameters[p].valueNames[i].c_str());
             choices.push_back(choice);
          }
  
          good = parms.ReadEnum(key, &val, choices.data(), choices.size()) && val != wxNOT_FOUND;
       }
       else
       {
          double val;
  
          good = parms.Read(key, &val) && val >= lower && val <= upper;
       }
  
       if (!good)
       {
          return false;
       }
    }
  
    // Second pass sets the variables
    for (size_t p = 0, paramCount = mParameters.size(); p < paramCount; p++)
    {
       wxString key = wxString::FromUTF8(mParameters[p].identifier.c_str());
       float lower = mParameters[p].minValue;
       float upper = mParameters[p].maxValue;
  
       if (mParameters[p].isQuantized &&
           mParameters[p].quantizeStep == 1.0 &&
           lower == 0.0 &&
           upper == 1.0)
       {
          bool val;
  
          parms.Read(key, &val);
  
          mPlugin->setParameter(mParameters[p].identifier, val ? upper : lower);
       }
       else if (mParameters[p].isQuantized &&
                mParameters[p].quantizeStep == 1.0 &&
                !mParameters[p].valueNames.empty())
       {
          std::vector<EnumValueSymbol> choices;
          int val = 0;
  
          for (size_t i = 0, choiceCount = mParameters[p].valueNames.size(); i < choiceCount; i++)
          {
             wxString choice = wxString::FromUTF8(mParameters[p].valueNames[i].c_str());
             choices.push_back(choice);
          }
  
          parms.ReadEnum(key, &val, choices.data(), choices.size());
  
          mPlugin->setParameter(mParameters[p].identifier, (float) val);
       }
       else
       {
          double val;
  
          parms.Read(key, &val);
  
          if (mParameters[p].isQuantized)
          {
             float qs = mParameters[p].quantizeStep;
  
             if (qs != 0.0)
             {
                val = (int)((val - lower) / qs + 0.5) * qs + lower;
             }
          }
  
          mPlugin->setParameter(mParameters[p].identifier, val);
       }
    }
  
    return true;
 }

References key, mParameters, mPlugin, and CommandParameters::ReadEnum().

Here is the call graph for this function:

◆ TransferDataFromWindow()

bool VampEffect::TransferDataFromWindow ( )

overridevirtual

Reimplemented from Effect.

Definition at line 708 of file VampEffect.cpp.

 {
    if (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
    {
       return false;
    }
  
    return true;
 }

References Effect::mUIParent.

◆ TransferDataToWindow()

bool VampEffect::TransferDataToWindow ( )

overridevirtual

Reimplemented from Effect.

Definition at line 696 of file VampEffect.cpp.

 {
    if (!mUIParent->TransferDataToWindow())
    {
       return false;
    }
  
    UpdateFromPlugin();
  
    return true;
 }

References Effect::mUIParent, and UpdateFromPlugin().

Here is the call graph for this function:

◆ UpdateFromPlugin()

void VampEffect::UpdateFromPlugin ( )

private

Definition at line 750 of file VampEffect.cpp.

 {
    for (size_t p = 0, cnt = mParameters.size(); p < cnt; p++)
    {
       float value = mPlugin->getParameter(mParameters[p].identifier);
  
       if (mParameters[p].isQuantized &&
           mParameters[p].quantizeStep == 1.0 &&
           mParameters[p].minValue == 0.0 &&
           mParameters[p].maxValue == 1.0)
       {
          mToggles[p]->SetValue(value > 0.5);
       }
       else if (mParameters[p].isQuantized &&
                mParameters[p].quantizeStep == 1.0 &&
                !mParameters[p].valueNames.empty())
       {
          mChoices[p]->SetSelection(size_t(value - mParameters[p].minValue + 0.5));
       }
       else
       {
          mValues[p] = value;
          mFields[p]->GetValidator()->TransferToWindow();
  
          float lower = mParameters[p].minValue;
          float upper = mParameters[p].maxValue;
          float range = upper - lower;
  
          if (mParameters[p].isQuantized)
          {
             float qs = mParameters[p].quantizeStep;
  
             if (qs != 0.0)
             {
                value = (int)((value - lower) / qs + 0.5) * qs + lower;
             }
          }
  
          mSliders[p]->SetValue((int)(((value - lower) / range) * 1000.0 + 0.5));
       }
    }
 }

References mChoices, mFields, mParameters, mPlugin, mSliders, mToggles, and mValues.

Referenced by OnChoice(), and TransferDataToWindow().

Here is the caller graph for this function:

Member Data Documentation

◆ mChoices

ArrayOf<wxChoice *> VampEffect::mChoices

private

Definition at line 109 of file VampEffect.h.

Referenced by PopulateOrExchange(), and UpdateFromPlugin().

◆ mFields

ArrayOf<wxTextCtrl *> VampEffect::mFields

private

Definition at line 106 of file VampEffect.h.

Referenced by OnSlider(), OnTextCtrl(), PopulateOrExchange(), and UpdateFromPlugin().

◆ mHasParameters

bool VampEffect::mHasParameters

private

Definition at line 92 of file VampEffect.h.

Referenced by IsInteractive().

◆ mInSlider

bool VampEffect::mInSlider

private

Definition at line 98 of file VampEffect.h.

◆ mInText

bool VampEffect::mInText

private

Definition at line 99 of file VampEffect.h.

◆ mKey

Vamp::HostExt::PluginLoader::PluginKey VampEffect::mKey

private

Definition at line 94 of file VampEffect.h.

Referenced by Init().

◆ mLabels

ArrayOf<wxStaticText *> VampEffect::mLabels

private

Definition at line 107 of file VampEffect.h.

Referenced by PopulateOrExchange().

◆ mName

wxString VampEffect::mName

private

Definition at line 95 of file VampEffect.h.

Referenced by GetSymbol().

◆ mOutput

int VampEffect::mOutput

private

Definition at line 91 of file VampEffect.h.

Referenced by AddFeatures().

◆ mParameters

Vamp::Plugin::ParameterList VampEffect::mParameters

private

Definition at line 101 of file VampEffect.h.

Referenced by GetAutomationParameters(), OnCheckBox(), OnChoice(), OnSlider(), OnTextCtrl(), PopulateOrExchange(), SetAutomationParameters(), and UpdateFromPlugin().

◆ mPath

PluginPath VampEffect::mPath

private

Definition at line 90 of file VampEffect.h.

Referenced by GetPath().

◆ mPlugin

std::unique_ptr<Vamp::Plugin> VampEffect::mPlugin

private

Definition at line 89 of file VampEffect.h.

Referenced by End(), GetAudioInCount(), GetAutomationParameters(), GetDescription(), GetVendor(), GetVersion(), Init(), OnCheckBox(), OnChoice(), OnSlider(), OnTextCtrl(), PopulateOrExchange(), Process(), SetAutomationParameters(), and UpdateFromPlugin().

◆ mProgram

wxChoice* VampEffect::mProgram

private

Definition at line 110 of file VampEffect.h.

Referenced by PopulateOrExchange().

◆ mRate

double VampEffect::mRate

private

Definition at line 96 of file VampEffect.h.

Referenced by Init(), and Process().

◆ mSliders

ArrayOf<wxSlider *> VampEffect::mSliders

private

Definition at line 105 of file VampEffect.h.

Referenced by OnTextCtrl(), PopulateOrExchange(), and UpdateFromPlugin().

◆ mToggles

ArrayOf<wxCheckBox *> VampEffect::mToggles

private

Definition at line 108 of file VampEffect.h.

Referenced by OnCheckBox(), PopulateOrExchange(), and UpdateFromPlugin().

◆ mValues

Floats VampEffect::mValues

private

Definition at line 103 of file VampEffect.h.

Referenced by OnSlider(), OnTextCtrl(), PopulateOrExchange(), and UpdateFromPlugin().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VampEffect()

◆ ~VampEffect()

Member Function Documentation

◆ AddFeatures()

◆ End()

◆ GetAudioInCount()

◆ GetAutomationParameters()

◆ GetDescription()

◆ GetFamily()

◆ GetPath()

◆ GetSymbol()

◆ GetType()

◆ GetVendor()

◆ GetVersion()

◆ Init()

◆ IsDefault()

◆ IsInteractive()

◆ OnCheckBox()

◆ OnChoice()

◆ OnSlider()

◆ OnTextCtrl()

◆ PopulateOrExchange()

◆ Process()

◆ SetAutomationParameters()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

◆ UpdateFromPlugin()

Member Data Documentation

◆ mChoices

◆ mFields

◆ mHasParameters

◆ mInSlider

◆ mInText

◆ mKey

◆ mLabels

◆ mName

◆ mOutput

◆ mParameters

◆ mPath

◆ mPlugin

◆ mProgram

◆ mRate

◆ mSliders

◆ mToggles

◆ mValues