 |
Audacity 3.2.0
|
|
Audacity 3.2.0
|
#include <Effect.h>
Classes | |
| class | Instance |
Public Member Functions | |
| std::shared_ptr< EffectInstance > | MakeInstance () const override |
| Make an object maintaining short-term state of an Effect. More... | |
 Public Member Functions inherited from StatefulEffectBase | |
| virtual bool | Init () |
| virtual bool | Process (EffectInstance &instance, EffectSettings &settings)=0 |
| virtual bool | RealtimeInitialize (EffectSettings &settings, double sampleRate) |
| virtual bool | RealtimeAddProcessor (EffectSettings &settings, EffectOutputs *pOutputs, unsigned numChannels, float sampleRate) |
| virtual bool | RealtimeSuspend () |
| virtual bool | RealtimeResume () |
| virtual bool | RealtimeProcessStart (MessagePackage &package) |
| settings are possibly changed, since last call, by an asynchronous dialog More... | |
| virtual size_t | RealtimeProcess (size_t group, EffectSettings &settings, const float *const *inBuf, float *const *outBuf, size_t numSamples) |
| virtual bool | RealtimeProcessEnd (EffectSettings &settings) noexcept |
| settings can be updated to let a dialog change appearance at idle More... | |
| virtual bool | RealtimeFinalize (EffectSettings &settings) noexcept |
| virtual size_t | SetBlockSize (size_t maxBlockSize) |
| virtual size_t | GetBlockSize () const |
| virtual unsigned | GetAudioInCount () const |
| How many input buffers to allocate at once. More... | |
| virtual unsigned | GetAudioOutCount () const |
| How many output buffers to allocate at once. More... | |
| virtual sampleCount | GetLatency () const |
| virtual bool | NeedsDither () const |
| virtual bool | ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap=nullptr) |
| virtual bool | ProcessFinalize () noexcept |
| Public Member Functions inherited from Effect | |
| Effect () | |
| virtual | ~Effect () |
| PluginPath | GetPath () const override |
| bool | VisitSettings (SettingsVisitor &visitor, EffectSettings &settings) override |
| bool | VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const override |
| ComponentInterfaceSymbol | GetSymbol () const override |
| VendorSymbol | GetVendor () const override |
| wxString | GetVersion () const override |
| TranslatableString | GetDescription () const override |
| EffectType | GetType () const override |
| Type determines how it behaves. More... | |
| EffectFamilySymbol | GetFamily () const override |
| Report identifier and user-visible name of the effect protocol. More... | |
| bool | IsInteractive () const override |
| Whether the effect needs a dialog for entry of settings. More... | |
| bool | IsDefault () const override |
| Whether the effect sorts "above the line" in the menus. More... | |
| RealtimeSince | RealtimeSupport () const override |
| Since which version of Audacity has the effect supported realtime? More... | |
| bool | SupportsAutomation () const override |
| Whether the effect has any automatable controls. More... | |
| bool | SaveSettings (const EffectSettings &settings, CommandParameters &parms) const override |
| Store settings as keys and values. More... | |
| bool | LoadSettings (const CommandParameters &parms, EffectSettings &settings) const override |
| Restore settings from keys and values. More... | |
| OptionalMessage | LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override |
| bool | SaveUserPreset (const RegistryPath &name, const EffectSettings &settings) const override |
| Save settings in the configuration file as a user-named preset. More... | |
| RegistryPaths | GetFactoryPresets () const override |
| Report names of factory presets. More... | |
| OptionalMessage | LoadFactoryPreset (int id, EffectSettings &settings) const override |
| OptionalMessage | LoadFactoryDefaults (EffectSettings &settings) const override |
| virtual const EffectParameterMethods & | Parameters () const |
| int | ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal) override |
| EffectUIClientInterface * | GetEffectUIClientInterface () override |
| Returns the EffectUIClientInterface instance for this effect. More... | |
| std::unique_ptr< EffectUIValidator > | PopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) override |
Adds controls to a panel that is given as the parent window of S More... | |
| bool | IsGraphicalUI () override |
| bool | ValidateUI (EffectSettings &) override |
| bool | CloseUI () override |
| bool | CanExportPresets () override |
| void | ExportPresets (const EffectSettings &settings) const override |
| OptionalMessage | ImportPresets (EffectSettings &settings) override |
| bool | HasOptions () override |
| void | ShowOptions () override |
| const EffectSettingsManager & | GetDefinition () const override |
| virtual NumericFormatSymbol | GetSelectionFormat () |
| int | ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false) override |
| Usually applies factory to self and given access. More... | |
| 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 |
| bool | TransferDataToWindow (const EffectSettings &settings) override |
| Update controls for the settings. More... | |
| bool | TransferDataFromWindow (EffectSettings &settings) override |
| Update the given settings from controls. More... | |
| unsigned | TestUIFlags (unsigned mask) |
| bool | Delegate (Effect &delegate, EffectSettings &settings) |
| Re-invoke DoEffect on another Effect object that implements the work. More... | |
| int | MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={}) const |
| Public Member Functions inherited from EffectBase | |
| EffectBase () | |
| ~EffectBase () override | |
| void | SetTracks (TrackList *pTracks) |
| Public Member Functions inherited from EffectUIClientInterface | |
| virtual | ~EffectUIClientInterface () |
| virtual int | ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal=false)=0 |
| virtual bool | IsGraphicalUI ()=0 |
| virtual std::unique_ptr< EffectUIValidator > | PopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs)=0 |
Adds controls to a panel that is given as the parent window of S More... | |
| virtual bool | CanExportPresets ()=0 |
| virtual void | ExportPresets (const EffectSettings &settings) const =0 |
| virtual OptionalMessage | ImportPresets (EffectSettings &settings)=0 |
| virtual bool | HasOptions ()=0 |
| virtual void | ShowOptions ()=0 |
| virtual bool | ValidateUI (EffectSettings &settings)=0 |
| virtual bool | CloseUI ()=0 |
| Public Member Functions inherited from EffectPlugin | |
| EffectPlugin & | operator= (EffectPlugin &)=delete |
| virtual | ~EffectPlugin () |
| virtual const EffectSettingsManager & | GetDefinition () const =0 |
| virtual int | ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false)=0 |
| Usually applies factory to self and given access. More... | |
| virtual EffectUIClientInterface * | GetEffectUIClientInterface ()=0 |
| Returns the EffectUIClientInterface instance for this effect. More... | |
| virtual void | Preview (EffectSettingsAccess &access, bool dryOnly)=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, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent=nullptr, const EffectDialogFactory &dialogFactory={}, const EffectSettingsAccessPtr &pAccess=nullptr)=0 |
| Unfortunately complicated dual-use function. More... | |
| virtual bool | TransferDataToWindow (const EffectSettings &settings)=0 |
| Update controls for the settings. More... | |
| virtual bool | TransferDataFromWindow (EffectSettings &settings)=0 |
| Update the given settings from controls. More... | |
| 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 EffectSettings | MakeSettings () const |
| virtual bool | CopySettingsContents (const EffectSettings &src, EffectSettings &dst) const |
| Update one settings object from another. More... | |
| 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 |
Additional Inherited Members | |
| Public Types inherited from StatefulEffectBase | |
| using | MessagePackage = EffectInstance::MessagePackage |
| Public Types inherited from Effect | |
| enum | : long { DefaultMessageBoxStyle = wxOK | wxCENTRE } |
| Public Types inherited from EffectPlugin | |
| using | EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess > |
| 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 Effect | |
| static Effect * | FetchParameters (Effect &e, EffectSettings &) |
| static void | IncEffectCounter () |
| Static Public Member Functions inherited from EffectDefinitionInterface | |
| static Identifier | GetSquashedName (const Identifier &ident) |
| A utility that strips spaces and CamelCases a name. More... | |
| Static Public Attributes inherited from EffectPlugin | |
| static const wxString | kUserPresetIdent = wxT("User Preset:") |
| static const wxString | kFactoryPresetIdent = wxT("Factory Preset:") |
| static const wxString | kCurrentSettingsIdent = wxT("<Current Settings>") |
| static const wxString | kFactoryDefaultsIdent = wxT("<Factory Defaults>") |
| Protected Member Functions inherited from Effect | |
| bool | CheckWhetherSkipEffect (const EffectSettings &settings) const override |
| Default implementation returns false. More... | |
| double | CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const override |
Default implementation returns previewLength More... | |
| virtual std::unique_ptr< EffectUIValidator > | PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) |
| Add controls to effect panel; always succeeds. More... | |
| bool | TotalProgress (double frac, const TranslatableString &={}) const |
| bool | TrackProgress (int whichTrack, double frac, const TranslatableString &={}) const |
| bool | TrackGroupProgress (int whichGroup, double frac, const TranslatableString &={}) const |
| int | GetNumWaveTracks () const |
| int | GetNumWaveGroups () const |
| void | GetBounds (const WaveTrack &track, const WaveTrack *pRight, sampleCount *start, sampleCount *len) |
| void | CopyInputTracks (bool allSyncLockSelected=false) |
| std::shared_ptr< AddedAnalysisTrack > | AddAnalysisTrack (const wxString &name=wxString()) |
| ModifiedAnalysisTrack | ModifyAnalysisTrack (const LabelTrack *pOrigTrack, const wxString &name=wxString()) |
| Track * | AddToOutputTracks (const std::shared_ptr< Track > &t) |
| Protected Member Functions inherited from EffectBase | |
| void | Preview (EffectSettingsAccess &access, bool dryOnly) override |
| bool | DoEffect (EffectSettings &settings, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent, const EffectDialogFactory &dialogFactory, const EffectSettingsAccessPtr &pAccess) override |
| Unfortunately complicated dual-use function. More... | |
| virtual bool | CheckWhetherSkipEffect (const EffectSettings &settings) const =0 |
| After Init(), tell whether Process() should be skipped. More... | |
| virtual double | CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const =0 |
| void | SetLinearEffectFlag (bool linearEffectFlag) |
| void | SetPreviewFullSelectionFlag (bool previewDurationFlag) |
| bool | IsPreviewing () const |
| void | IncludeNotSelectedPreviewTracks (bool includeNotSelected) |
| void | ReplaceProcessedTracks (const bool bGoodResult) |
| const TrackList * | inputTracks () const |
| const AudacityProject * | FindProject () const |
| Protected Attributes inherited from Effect | |
| wxWeakRef< wxDialog > | mHostUIDialog |
| This smart pointer tracks the lifetime of the dialog. More... | |
| Protected Attributes inherited from EffectBase | |
| BasicUI::ProgressDialog * | mProgress {} |
| double | mProjectRate {} |
| WaveTrackFactory * | mFactory {} |
| std::shared_ptr< TrackList > | mOutputTracks |
| double | mT0 {} |
| double | mT1 {} |
| wxArrayString | mPresetNames |
| unsigned | mUIFlags { 0 } |
| Static Protected Attributes inherited from EffectBase | |
| static int | nEffectsDone = 0 |
Subclass of Effect, to be eliminated after all of its subclasses are rewritten to be stateless
|
overridevirtual |
Make an object maintaining short-term state of an Effect.
One effect may have multiple instances extant simultaneously. Instances have state, may be implemented in foreign code, and are temporary, whereas EffectSettings represents persistent effect state that can be saved and reloaded from files.
| settings | may be assumed to have a lifetime enclosing the instance's |
true (no promises that the result isn't null) Implements EffectInstanceFactory.
Definition at line 139 of file Effect.cpp.
Referenced by EffectNoiseReduction::ShowHostInterface(), EffectNoiseRemoval::ShowHostInterface(), and NyquistEffect::ShowHostInterface().
1.9.3