|
tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications
« « « Anklang Documentation |
Public Types | |
| enum | Channel { left , right } |
Public Types inherited from tracktion::engine::Plugin | |
| enum class | Type { allPlugins , folderTrackPlugins , effectPlugins } |
| using | Ptr = juce::ReferenceCountedObjectPtr< Plugin > |
| using | Array = juce::ReferenceCountedArray< Plugin > |
Public Types inherited from tracktion::engine::Selectable | |
| using | WeakRef = juce::WeakReference< Selectable > |
Public Member Functions | |
| RackInstance (PluginCreationInfo) | |
| juce::String | getName () const override |
| The name of the type, e.g. | |
| juce::String | getPluginType () override |
| juce::String | getTooltip () override |
| default returns the name, others can return special stuff if needed | |
| void | initialise (const PluginInitialisationInfo &) override |
| Gives the plugin a chance to set itself up before being played. | |
| void | deinitialise () override |
| Called after play stops to release resources. | |
| bool | takesAudioInput () override |
| bool | takesMidiInput () override |
| bool | producesAudioWhenNoAudioInput () override |
| bool | isSynth () override |
| bool | canBeAddedToRack () override |
| int | getNumOutputChannelsGivenInputs (int) override |
| This must return the number of output channels that the plugin will produce, given a number of input channels. | |
| double | getLatencySeconds () override |
| bool | needsConstantBufferSize () override |
| void | prepareForNextBlock (TimePosition) override |
| Called between successive rendering blocks. | |
| void | applyToBuffer (const PluginRenderContext &) override |
| Process the next block of data. | |
| void | updateAutomatableParamPosition (TimePosition) override |
| Updates all the auto params to their positions at this time. | |
| juce::String | getSelectableDescription () override |
| Subclasses must return a description of what they are. | |
| void | replaceRackWithPluginSequence (SelectionManager *) |
| juce::StringArray | getInputChoices (bool includeNumberPrefix) |
| juce::StringArray | getOutputChoices (bool includeNumberPrefix) |
| juce::String | getNoPinName () |
| void | setInputName (Channel, const juce::String &inputName) |
| void | setOutputName (Channel, const juce::String &outputName) |
| void | setInputLevel (Channel, float) |
| void | setOutputLevel (Channel, float) |
| juce::String | getInputName (Channel) |
| juce::String | getOutputName (Channel) |
Public Member Functions inherited from tracktion::engine::Plugin | |
| Plugin (PluginCreationInfo) | |
| void | selectableAboutToBeDeleted () override |
| Called just before the selectable is about to be deleted so any subclasses should still be valid at this point. | |
| void | playStartedOrStopped () |
| called by the system to let the plugin manage its automation stuff | |
| virtual void | initialiseFully () |
| Gives the plugin a chance to do extra initialisation when it's been added to an edit. | |
| virtual void | flushPluginStateToValueTree () override |
| virtual juce::String | getVendor () |
| virtual juce::String | getShortName (int) |
| virtual juce::String | getIdentifierString () |
| A unique string to idenitify plugin independant of install location. | |
| virtual void | setEnabled (bool) |
| Enable/disable the plugin. | |
| bool | isEnabled () const noexcept |
| void | setFrozen (bool shouldBeFrozen) |
| This is a bit different to being enabled as when frozen a plugin can't be interacted with. | |
| bool | isFrozen () const noexcept |
| void | setProcessingEnabled (bool p) |
| Enable/Disable processing. | |
| bool | isProcessingEnabled () const noexcept |
| virtual void | initialiseWithoutStopping (const PluginInitialisationInfo &) |
| Tells the plugin that the audio graph has changed but the plugin isn't being re-initialised - i.e. | |
| bool | isInitialising () const |
| virtual void | reset () |
| Should reset synth voices, tails, clear delay buffers, etc. | |
| virtual void | trackPropertiesChanged () |
| Track name or colour has changed. | |
| void | applyToBufferWithAutomation (const PluginRenderContext &) |
| virtual bool | shoulMeasureCpuUsage () const noexcept |
| Plugins can return false if they want to avoid the overhead of measuring the CPU usage. | |
| double | getCpuUsage () const noexcept |
| Returns the proportion of the current buffer size spent processing this plugin. | |
| virtual bool | noTail () |
| virtual void | getChannelNames (juce::StringArray *ins, juce::StringArray *outs) |
| virtual double | getTailLength () const |
| virtual bool | canSidechain () |
| juce::StringArray | getInputChannelNames () |
| juce::StringArray | getSidechainSourceNames (bool allowNone) |
| void | setSidechainSourceByName (const juce::String &name) |
| juce::String | getSidechainSourceName () |
| void | guessSidechainRouting () |
| int | getNumWires () const |
| Wire * | getWire (int index) const |
| void | makeConnection (int srcChannel, int dstChannel, juce::UndoManager *) |
| void | breakConnection (int srcChannel, int dstChannel) |
| virtual bool | hasNameForMidiNoteNumber (int note, int midiChannel, juce::String &name) |
| If it's a synth that names its notes, this can return the name it uses for this note 0-127. | |
| virtual bool | hasNameForMidiProgram (int programNum, int bank, juce::String &name) |
| Returns the name for a midi program, if there is one. | |
| virtual bool | hasNameForMidiBank (int bank, juce::String &name) |
| virtual bool | canBeAddedToClip () |
| virtual bool | canBeAddedToFolderTrack () |
| virtual bool | canBeAddedToMaster () |
| virtual bool | canBeDisabled () |
| virtual bool | canBeMoved () |
| virtual bool | isMissing () |
| for things like VSTs where the DLL is missing. | |
| virtual bool | isDisabled () |
| Plugins can be disabled to avoid them crashing Edits. | |
| bool | isInRack () const |
| juce::ReferenceCountedObjectPtr< RackType > | getOwnerRackType () const |
| bool | isClipEffectPlugin () const |
| virtual juce::AudioProcessor * | getWrappedAudioProcessor () const |
| AutomatableParameter::Ptr | getQuickControlParameter () const |
| void | setQuickControlParameter (AutomatableParameter *) |
| virtual void | deleteFromParent () |
| Attempts to delete this plugin, whether it's a master plugin, track plugin, etc. | |
| void | removeFromParent () |
| Detaches the plugin from any parent it might be in. | |
| Track * | getOwnerTrack () const |
| Returns the track if it's a track or clip plugin. | |
| Clip * | getOwnerClip () const |
| Returns the clip if that's what it's in. | |
| PluginList * | getOwnerList () const |
| Ptr | findPluginThatFeedsIntoThis () const |
| Ptr | findPluginThatThisFeedsInto () const |
| void | changed () override |
| method from Selectable, that's been overridden here to also tell the edit that it's changed. | |
| juce::Array< ReferencedItem > | getReferencedItems () override |
| void | reassignReferencedItem (const ReferencedItem &, ProjectItemID newID, double newStartTime) override |
| virtual void | sourceMediaChanged () |
| Called when ProjectItem sources are re-assigned so you can reload from the new source. | |
| bool | setPluginToMirror (const Plugin::Ptr &) |
| virtual void | updateFromMirroredPluginIfNeeded (Plugin &) |
| Plugin::Ptr | getMirroredPlugin () const |
| bool | baseClassNeedsInitialising () const noexcept |
| void | baseClassInitialise (const PluginInitialisationInfo &) |
| void | baseClassDeinitialise () |
| void | setSidechainSourceID (EditItemID newID) |
| EditItemID | getSidechainSourceID () const |
| virtual std::unique_ptr< EditorComponent > | createEditor () |
| void | showWindowExplicitly () |
| void | hideWindowForShutdown () |
| juce::UndoManager * | getUndoManager () const noexcept |
Public Member Functions inherited from tracktion::engine::Selectable | |
| virtual void | selectionStatusChanged (bool isNowSelected) |
| Can be overridden to tell this object that it has just been selected or deselected. | |
| void | addListener (SelectableListener *) |
| void | removeListener (SelectableListener *) |
| void | addSelectableListener (SelectableListener *) |
| void | removeSelectableListener (SelectableListener *) |
| void | cancelAnyPendingUpdates () |
| If changed() has been called, this will cancel any pending async change notificaions. | |
| void | deselect () |
| void | propertiesChanged () |
| void | notifyListenersOfDeletion () |
| WeakRef | getWeakRef () |
Public Member Functions inherited from juce::ReferenceCountedObject | |
| void | incReferenceCount () noexcept |
| void | decReferenceCount () noexcept |
| bool | decReferenceCountWithoutDeleting () noexcept |
| int | getReferenceCount () const noexcept |
Public Member Functions inherited from tracktion::engine::AutomatableEditItem | |
| AutomatableEditItem (Edit &, const juce::ValueTree &) | |
| virtual void | restorePluginStateFromValueTree (const juce::ValueTree &) |
| juce::Array< AutomatableParameter * > | getAutomatableParameters () const |
| int | getNumAutomatableParameters () const |
| AutomatableParameter::Ptr | getAutomatableParameter (int index) const |
| AutomatableParameter::Ptr | getAutomatableParameterByID (const juce::String ¶mID) const |
| void | visitAllAutomatableParams (const std::function< void(AutomatableParameter &)> &visit) const |
| void | deleteParameter (AutomatableParameter *) |
| void | deleteAutomatableParameters () |
| int | indexOfAutomatableParameter (const AutomatableParameter::Ptr &) const |
| AutomatableParameterTree & | getParameterTree () const |
| juce::ReferenceCountedArray< AutomatableParameter > | getFlattenedParameterTree () const |
| void | addParameterListChangeListener (ParameterListChangeListener *) |
| void | removeParameterListChangeListener (ParameterListChangeListener *) |
| bool | isAutomationNeeded () const noexcept |
| void | setAutomatableParamPosition (TimePosition) |
| bool | isBeingActivelyPlayed () const |
| void | updateParameterStreams (TimePosition) |
| Updates all the parameter streams to their positions at this time. | |
| void | updateActiveParameters () |
| Iterates all the parameters to find out which ones need to be automated. | |
| void | resetRecordingStatus () |
| Marks the end of an automation recording stream. | |
Public Member Functions inherited from tracktion::engine::EditItem | |
| EditItem (EditItemID, Edit &) | |
Public Member Functions inherited from tracktion::engine::MacroParameterElement | |
| MacroParameterElement (Edit &, const juce::ValueTree &) | |
| Constructor. | |
| virtual | ~MacroParameterElement ()=default |
| Destructor. | |
| MacroParameterList * | getMacroParameterList () |
| If no parameters have been created, this may return nullptr. | |
| MacroParameterList & | getMacroParameterListForWriting () |
| This ensures that the list has been created. | |
| juce::ReferenceCountedArray< MacroParameter > | getMacroParameters () const |
Static Public Member Functions | |
| static juce::ValueTree | create (RackType &) |
Static Public Member Functions inherited from tracktion::engine::Plugin | |
| static bool | areSelectedPluginsRackable (SelectionManager &) |
| static RackInstance * | wrapSelectedPluginsInRack (SelectionManager &) |
| static void | sortPlugins (Plugin::Array &) |
| static void | sortPlugins (std::vector< Plugin * > &) |
Static Public Member Functions inherited from tracktion::engine::Selectable | |
| static void | initialise () |
| static bool | isSelectableValid (const Selectable *) noexcept |
| checks whether this object has been deleted. | |
Static Public Member Functions inherited from tracktion::engine::Exportable | |
| static juce::Array< Exportable * > | addAllExportables (Edit &) |
| Returns all the Exportables contained in an Edit. | |
Static Public Attributes | |
| static const char * | xmlTypeName |
| static constexpr double | rackMinDb |
| static constexpr double | rackMaxDb |
Definition at line 14 of file tracktion_RackInstance.h.
| enum tracktion::engine::RackInstance::Channel |
Definition at line 50 of file tracktion_RackInstance.h.
| tracktion::engine::RackInstance::RackInstance | ( | PluginCreationInfo | info | ) |
Definition at line 76 of file tracktion_RackInstance.cpp.
|
override |
Definition at line 112 of file tracktion_RackInstance.cpp.
|
overridevirtual |
Process the next block of data.
The incoming buffer will have an unknown number of channels, and the plugin has to deal with them however it wants to.
The buffer should be resized to the number of output channels that the plugin wants to return (which should be the same or less than the number of output channel names it returns from getChannelNames() - never more than this).
Implements tracktion::engine::Plugin.
Definition at line 319 of file tracktion_RackInstance.cpp.
|
overridevirtual |
Reimplemented from tracktion::engine::Plugin.
Definition at line 36 of file tracktion_RackInstance.h.
|
static |
Definition at line 124 of file tracktion_RackInstance.cpp.
|
overridevirtual |
Called after play stops to release resources.
Don't call this directly or the initialise count will become out of sync.
Implements tracktion::engine::Plugin.
Definition at line 296 of file tracktion_RackInstance.cpp.
| juce::StringArray tracktion::engine::RackInstance::getInputChoices | ( | bool | includeNumberPrefix | ) |
Definition at line 207 of file tracktion_RackInstance.cpp.
| juce::String tracktion::engine::RackInstance::getInputName | ( | Channel | c | ) |
Definition at line 354 of file tracktion_RackInstance.cpp.
|
overridevirtual |
Reimplemented from tracktion::engine::Plugin.
Definition at line 310 of file tracktion_RackInstance.cpp.
|
overridevirtual |
The name of the type, e.g.
"Compressor"
Implements tracktion::engine::Plugin.
Definition at line 141 of file tracktion_RackInstance.cpp.
| juce::String tracktion::engine::RackInstance::getNoPinName | ( | ) |
Definition at line 249 of file tracktion_RackInstance.cpp.
|
overridevirtual |
This must return the number of output channels that the plugin will produce, given a number of input channels.
E.g. some might be able to do mono, so will return 1 if the input is 1, 2 if it is 2, etc.
The default impl just returns the number of items that getChannelNames() returns.
Reimplemented from tracktion::engine::Plugin.
Definition at line 37 of file tracktion_RackInstance.h.
| juce::StringArray tracktion::engine::RackInstance::getOutputChoices | ( | bool | includeNumberPrefix | ) |
Definition at line 228 of file tracktion_RackInstance.cpp.
| juce::String tracktion::engine::RackInstance::getOutputName | ( | Channel | c | ) |
Definition at line 364 of file tracktion_RackInstance.cpp.
|
overridevirtual |
Implements tracktion::engine::Plugin.
Definition at line 26 of file tracktion_RackInstance.h.
|
overridevirtual |
Subclasses must return a description of what they are.
Implements tracktion::engine::Selectable.
Definition at line 323 of file tracktion_RackInstance.cpp.
|
overridevirtual |
default returns the name, others can return special stuff if needed
Reimplemented from tracktion::engine::Plugin.
Definition at line 131 of file tracktion_RackInstance.cpp.
|
overridevirtual |
Gives the plugin a chance to set itself up before being played.
This won't be called concurrently with the process thread.
The sample rate and the average block size - although the blocks won't always be the same, and may be bigger.
Don't call this directly or the initialise count will become out of sync.
Implements tracktion::engine::Plugin.
Definition at line 290 of file tracktion_RackInstance.cpp.
|
overridevirtual |
Reimplemented from tracktion::engine::Plugin.
Definition at line 35 of file tracktion_RackInstance.h.
|
overridevirtual |
Implements tracktion::engine::Plugin.
Definition at line 39 of file tracktion_RackInstance.h.
|
overridevirtual |
Called between successive rendering blocks.
Reimplemented from tracktion::engine::Plugin.
Definition at line 315 of file tracktion_RackInstance.cpp.
|
overridevirtual |
Reimplemented from tracktion::engine::Plugin.
Definition at line 34 of file tracktion_RackInstance.h.
| void tracktion::engine::RackInstance::replaceRackWithPluginSequence | ( | SelectionManager * | sm | ) |
Definition at line 147 of file tracktion_RackInstance.cpp.
| void tracktion::engine::RackInstance::setInputLevel | ( | Channel | c, |
| float | v | ||
| ) |
Definition at line 328 of file tracktion_RackInstance.cpp.
| void tracktion::engine::RackInstance::setInputName | ( | Channel | c, |
| const juce::String & | inputName | ||
| ) |
Definition at line 254 of file tracktion_RackInstance.cpp.
| void tracktion::engine::RackInstance::setOutputLevel | ( | Channel | c, |
| float | v | ||
| ) |
Definition at line 341 of file tracktion_RackInstance.cpp.
| void tracktion::engine::RackInstance::setOutputName | ( | Channel | c, |
| const juce::String & | outputName | ||
| ) |
Definition at line 272 of file tracktion_RackInstance.cpp.
|
overridevirtual |
Reimplemented from tracktion::engine::Plugin.
Definition at line 32 of file tracktion_RackInstance.h.
|
overridevirtual |
Reimplemented from tracktion::engine::Plugin.
Definition at line 33 of file tracktion_RackInstance.h.
|
overridevirtual |
Updates all the auto params to their positions at this time.
Reimplemented from tracktion::engine::AutomatableEditItem.
Definition at line 302 of file tracktion_RackInstance.cpp.
| AutomatableParameter::Ptr tracktion::engine::RackInstance::dryGain |
Definition at line 67 of file tracktion_RackInstance.h.
| juce::CachedValue<float> tracktion::engine::RackInstance::dryValue |
Definition at line 65 of file tracktion_RackInstance.h.
| AutomatableParameter::Ptr tracktion::engine::RackInstance::leftInDb |
Definition at line 68 of file tracktion_RackInstance.h.
| juce::CachedValue<int> tracktion::engine::RackInstance::leftInputGoesTo |
Definition at line 64 of file tracktion_RackInstance.h.
| juce::CachedValue<float> tracktion::engine::RackInstance::leftInValue |
Definition at line 65 of file tracktion_RackInstance.h.
| AutomatableParameter::Ptr tracktion::engine::RackInstance::leftOutDb |
Definition at line 68 of file tracktion_RackInstance.h.
| juce::CachedValue<int> tracktion::engine::RackInstance::leftOutputComesFrom |
Definition at line 64 of file tracktion_RackInstance.h.
| juce::CachedValue<float> tracktion::engine::RackInstance::leftOutValue |
Definition at line 65 of file tracktion_RackInstance.h.
| bool tracktion::engine::RackInstance::linkInputs |
Definition at line 63 of file tracktion_RackInstance.h.
| bool tracktion::engine::RackInstance::linkOutputs |
Definition at line 63 of file tracktion_RackInstance.h.
|
staticconstexpr |
Definition at line 77 of file tracktion_RackInstance.h.
|
staticconstexpr |
Definition at line 76 of file tracktion_RackInstance.h.
| const EditItemID tracktion::engine::RackInstance::rackTypeID |
Definition at line 60 of file tracktion_RackInstance.h.
| AutomatableParameter::Ptr tracktion::engine::RackInstance::rightInDb |
Definition at line 68 of file tracktion_RackInstance.h.
| juce::CachedValue<int> tracktion::engine::RackInstance::rightInputGoesTo |
Definition at line 64 of file tracktion_RackInstance.h.
| juce::CachedValue<float> tracktion::engine::RackInstance::rightInValue |
Definition at line 65 of file tracktion_RackInstance.h.
| AutomatableParameter::Ptr tracktion::engine::RackInstance::rightOutDb |
Definition at line 68 of file tracktion_RackInstance.h.
| juce::CachedValue<int> tracktion::engine::RackInstance::rightOutputComesFrom |
Definition at line 64 of file tracktion_RackInstance.h.
| juce::CachedValue<float> tracktion::engine::RackInstance::rightOutValue |
Definition at line 65 of file tracktion_RackInstance.h.
| const RackType::Ptr tracktion::engine::RackInstance::type |
Definition at line 61 of file tracktion_RackInstance.h.
| AutomatableParameter::Ptr tracktion::engine::RackInstance::wetGain |
Definition at line 67 of file tracktion_RackInstance.h.
| juce::CachedValue<float> tracktion::engine::RackInstance::wetValue |
Definition at line 65 of file tracktion_RackInstance.h.
|
static |
Definition at line 23 of file tracktion_RackInstance.h.