tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications

« « « Anklang Documentation
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
tracktion::engine::MIDITrackerModifier Class Reference
Inheritance diagram for tracktion::engine::MIDITrackerModifier:
tracktion::engine::Modifier tracktion::engine::ValueTreeAllEventListener tracktion::engine::AutomatableEditItem tracktion::engine::Selectable tracktion::engine::AutomatableParameter::ModifierSource juce::ReferenceCountedObject tracktion::engine::EditItem

Classes

struct  Assignment
 

Public Types

enum  Type { pitch , velocity }
 
enum  Mode { absolute , relative }
 
using Ptr = juce::ReferenceCountedObjectPtr< MIDITrackerModifier >
 
using Array = juce::ReferenceCountedArray< MIDITrackerModifier >
 
- Public Types inherited from tracktion::engine::Modifier
enum class  ProcessingPosition { none , preFX , postFX }
 Determines the position in the FX chain where the modifier should be processed. More...
 
using Ptr = juce::ReferenceCountedObjectPtr< Modifier >
 
using Array = juce::ReferenceCountedArray< Modifier >
 
- Public Types inherited from tracktion::engine::Selectable
using WeakRef = juce::WeakReference< Selectable >
 

Public Member Functions

 MIDITrackerModifier (Edit &, const juce::ValueTree &)
 
void initialise () override
 Call this once after construction to connect it to the audio graph.
 
juce::String getName () const override
 
float getCurrentValue () override
 Returns the current value of the modifier.
 
int getCurrentMIDIValue () const noexcept
 Returns the MIDI value, either a pitch or velocity.
 
AutomatableParameter::ModifierAssignmentcreateAssignment (const juce::ValueTree &) override
 Must return a new ModifierAssignment for a given state.
 
juce::StringArray getMidiInputNames () override
 Can return an array of names represeting MIDI inputs.
 
ProcessingPosition getProcessingPosition () override
 Should return the position in the plugin chain that this Modifier should be processed.
 
void applyToBuffer (const PluginRenderContext &) override
 Sub classes should implement this to process the Modifier.
 
juce::String getSelectableDescription () override
 Subclasses must return a description of what they are.
 
juce::ValueTree getNodeState () const
 Returns a ValueTree representing the absolute nodes of the map.
 
virtual void initialise ()=0
 Call this once after construction to connect it to the audio graph.
 
virtual void initialise (double, int)
 Sub classes should implement this to initialise the Modifier.
 
- Public Member Functions inherited from tracktion::engine::Modifier
 Modifier (Edit &, const juce::ValueTree &)
 Creates a Modifier for a given state.
 
 ~Modifier () override
 Destructor.
 
void remove ()
 Removes this Modifier from its parent Track.
 
virtual juce::StringArray getAudioInputNames ()
 Can return an array of names represeting audio inputs.
 
virtual void deinitialise ()
 Sub classes should implement this to deinitialise the Modifier.
 
bool baseClassNeedsInitialising () const noexcept
 Returns true if the Modifier needs initialising.
 
void baseClassInitialise (double sampleRate, int blockSizeSamples)
 Initialises the Modifier.
 
void baseClassDeinitialise ()
 Deinitialises the Modifier.
 
void baseClassApplyToBuffer (const PluginRenderContext &)
 Updates internal value history and calls the subclass's applyToBuffer method.
 
TimePosition getCurrentTime () const
 Returns the edit time of the current value.
 
float getValueAt (TimeDuration numSecondsBeforeNow) const
 Returns the value of the at a given time in the past.
 
std::vector< floatgetValues (TimeDuration numSecondsBeforeNow) const
 Returns a vector of previous sample values.
 
double getSampleRate () const
 Returns the sample rate the Modifier has been initialised with.
 
void selectableAboutToBeDeleted () override
 Called just before the selectable is about to be deleted so any subclasses should still be valid at this point.
 
- Public Member Functions inherited from tracktion::engine::AutomatableEditItem
 AutomatableEditItem (Edit &, const juce::ValueTree &)
 
virtual void flushPluginStateToValueTree ()
 
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 &paramID) const
 
void visitAllAutomatableParams (const std::function< void(AutomatableParameter &)> &visit) const
 
void deleteParameter (AutomatableParameter *)
 
void deleteAutomatableParameters ()
 
int indexOfAutomatableParameter (const AutomatableParameter::Ptr &) const
 
AutomatableParameterTreegetParameterTree () const
 
juce::ReferenceCountedArray< AutomatableParametergetFlattenedParameterTree () const
 
void addParameterListChangeListener (ParameterListChangeListener *)
 
void removeParameterListChangeListener (ParameterListChangeListener *)
 
bool isAutomationNeeded () const noexcept
 
void setAutomatableParamPosition (TimePosition)
 
bool isBeingActivelyPlayed () const
 
virtual void updateAutomatableParamPosition (TimePosition)
 Updates all the auto params to their positions at this time.
 
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::Selectable
virtual void selectionStatusChanged (bool isNowSelected)
 Can be overridden to tell this object that it has just been selected or deselected.
 
virtual void changed ()
 This should be called to send a change notification to any SelectableListeners that are registered with this object.
 
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
 

Static Public Member Functions

static juce::StringArray getTypeNames ()
 
static juce::StringArray getModeNames ()
 
- 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.
 

Public Attributes

juce::CachedValue< floattype
 
juce::CachedValue< floatmode
 
juce::CachedValue< floatrelativeRoot
 
juce::CachedValue< floatrelativeSpread
 
AutomatableParameter::Ptr typeParam
 
AutomatableParameter::Ptr modeParam
 
AutomatableParameter::Ptr relativeRootParam
 
AutomatableParameter::Ptr relativeSpreadParam
 
- Public Attributes inherited from tracktion::engine::Modifier
juce::ValueTree state
 Modifier internal state.
 
juce::CachedValue< juce::Colourcolour
 Colour property.
 
juce::CachedValue< floatenabled
 Enabled property.
 
AutomatableParameter::Ptr enabledParam
 Parameter to change the enabled state.
 
- Public Attributes inherited from tracktion::engine::AutomatableEditItem
juce::ValueTree elementState
 
juce::CachedValue< bool > remapOnTempoChange
 
- Public Attributes inherited from tracktion::engine::EditItem
Editedit
 
const EditItemID itemID
 Every EditItem has an ID which is unique within the edit.
 
- Public Attributes inherited from tracktion::engine::Selectable
WeakRef::Master masterReference
 

Additional Inherited Members

- Static Public Attributes inherited from tracktion::engine::Modifier
static constexpr TimeDuration maxHistoryTime
 The max number of seconds of modifier value history that is stored.
 
- Protected Member Functions inherited from tracktion::engine::Modifier
void setEditTime (TimePosition newEditTime)
 Subclasses can call this to update the edit time of the current value.
 
- Protected Member Functions inherited from tracktion::engine::AutomatableEditItem
virtual void buildParameterTree () const
 
void updateLastPlaybackTime ()
 
void clearParameterList ()
 
void addAutomatableParameter (const AutomatableParameter::Ptr &)
 
void rebuildParameterTree ()
 
void saveChangedParametersToState ()
 Saves the explicit value of any parameters that have deviated to the state.
 
void restoreChangedParametersFromState ()
 Restores the value of any explicitly set parameters.
 
- Protected Member Functions inherited from juce::ReferenceCountedObject
 ReferenceCountedObject (const ReferenceCountedObject &) noexcept
 
 ReferenceCountedObject (ReferenceCountedObject &&) noexcept
 
ReferenceCountedObjectoperator= (const ReferenceCountedObject &) noexcept
 
ReferenceCountedObjectoperator= (ReferenceCountedObject &&) noexcept
 
void resetReferenceCount () noexcept
 

Detailed Description

Definition at line 15 of file tracktion_MIDITrackerModifier.h.

Member Typedef Documentation

◆ Array

Definition at line 24 of file tracktion_MIDITrackerModifier.h.

◆ Ptr

Definition at line 23 of file tracktion_MIDITrackerModifier.h.

Member Enumeration Documentation

◆ Mode

enum tracktion::engine::MIDITrackerModifier::Mode

Definition at line 69 of file tracktion_MIDITrackerModifier.h.

◆ Type

enum tracktion::engine::MIDITrackerModifier::Type

Definition at line 61 of file tracktion_MIDITrackerModifier.h.

Constructor & Destructor Documentation

◆ MIDITrackerModifier()

tracktion::engine::MIDITrackerModifier::MIDITrackerModifier ( Edit e,
const juce::ValueTree v 
)

Definition at line 15 of file tracktion_MIDITrackerModifier.cpp.

◆ ~MIDITrackerModifier()

tracktion::engine::MIDITrackerModifier::~MIDITrackerModifier ( )
override

Definition at line 66 of file tracktion_MIDITrackerModifier.cpp.

Member Function Documentation

◆ applyToBuffer()

void tracktion::engine::MIDITrackerModifier::applyToBuffer ( const PluginRenderContext )
overridevirtual

Sub classes should implement this to process the Modifier.

Reimplemented from tracktion::engine::Modifier.

Definition at line 103 of file tracktion_MIDITrackerModifier.cpp.

◆ createAssignment()

AutomatableParameter::ModifierAssignment * tracktion::engine::MIDITrackerModifier::createAssignment ( const juce::ValueTree )
overridevirtual

Must return a new ModifierAssignment for a given state.

Implements tracktion::engine::Modifier.

Definition at line 93 of file tracktion_MIDITrackerModifier.cpp.

◆ getCurrentMIDIValue()

int tracktion::engine::MIDITrackerModifier::getCurrentMIDIValue ( ) const
noexcept

Returns the MIDI value, either a pitch or velocity.

Definition at line 88 of file tracktion_MIDITrackerModifier.cpp.

◆ getCurrentValue()

float tracktion::engine::MIDITrackerModifier::getCurrentValue ( )
overridevirtual

Returns the current value of the modifier.

Implements tracktion::engine::Modifier.

Definition at line 83 of file tracktion_MIDITrackerModifier.cpp.

◆ getMidiInputNames()

juce::StringArray tracktion::engine::MIDITrackerModifier::getMidiInputNames ( )
overridevirtual

Can return an array of names represeting MIDI inputs.

Reimplemented from tracktion::engine::Modifier.

Definition at line 98 of file tracktion_MIDITrackerModifier.cpp.

◆ getModeNames()

juce::StringArray tracktion::engine::MIDITrackerModifier::getModeNames ( )
static

Definition at line 143 of file tracktion_MIDITrackerModifier.cpp.

◆ getName()

juce::String tracktion::engine::MIDITrackerModifier::getName ( ) const
overridevirtual

Implements tracktion::engine::EditItem.

Definition at line 28 of file tracktion_MIDITrackerModifier.h.

◆ getNodeState()

juce::ValueTree tracktion::engine::MIDITrackerModifier::getNodeState ( ) const

Returns a ValueTree representing the absolute nodes of the map.

This will have 5 children each with a midi and value property which you can adjust.

Definition at line 80 of file tracktion_MIDITrackerModifier.h.

◆ getProcessingPosition()

ProcessingPosition tracktion::engine::MIDITrackerModifier::getProcessingPosition ( )
overridevirtual

Should return the position in the plugin chain that this Modifier should be processed.

Reimplemented from tracktion::engine::Modifier.

Definition at line 40 of file tracktion_MIDITrackerModifier.h.

◆ getSelectableDescription()

juce::String tracktion::engine::MIDITrackerModifier::getSelectableDescription ( )
overridevirtual

Subclasses must return a description of what they are.

Implements tracktion::engine::Selectable.

Definition at line 58 of file tracktion_MIDITrackerModifier.h.

◆ getTypeNames()

juce::StringArray tracktion::engine::MIDITrackerModifier::getTypeNames ( )
static

Definition at line 137 of file tracktion_MIDITrackerModifier.cpp.

◆ initialise() [1/3]

void tracktion::engine::MIDITrackerModifier::initialise ( )
overridevirtual

Call this once after construction to connect it to the audio graph.

Implements tracktion::engine::Modifier.

Definition at line 77 of file tracktion_MIDITrackerModifier.cpp.

◆ initialise() [2/3]

virtual void tracktion::engine::Modifier::initialise ( )
virtual

Call this once after construction to connect it to the audio graph.

Implements tracktion::engine::Modifier.

◆ initialise() [3/3]

virtual void tracktion::engine::Modifier::initialise ( double  ,
int   
)
virtual

Sub classes should implement this to initialise the Modifier.

Reimplemented from tracktion::engine::Modifier.

Definition at line 81 of file tracktion_Modifier.h.

Member Data Documentation

◆ mode

juce::CachedValue<float> tracktion::engine::MIDITrackerModifier::mode

Definition at line 82 of file tracktion_MIDITrackerModifier.h.

◆ modeParam

AutomatableParameter::Ptr tracktion::engine::MIDITrackerModifier::modeParam

Definition at line 84 of file tracktion_MIDITrackerModifier.h.

◆ relativeRoot

juce::CachedValue<float> tracktion::engine::MIDITrackerModifier::relativeRoot

Definition at line 82 of file tracktion_MIDITrackerModifier.h.

◆ relativeRootParam

AutomatableParameter::Ptr tracktion::engine::MIDITrackerModifier::relativeRootParam

Definition at line 84 of file tracktion_MIDITrackerModifier.h.

◆ relativeSpread

juce::CachedValue<float> tracktion::engine::MIDITrackerModifier::relativeSpread

Definition at line 82 of file tracktion_MIDITrackerModifier.h.

◆ relativeSpreadParam

AutomatableParameter::Ptr tracktion::engine::MIDITrackerModifier::relativeSpreadParam

Definition at line 84 of file tracktion_MIDITrackerModifier.h.

◆ type

juce::CachedValue<float> tracktion::engine::MIDITrackerModifier::type

Definition at line 82 of file tracktion_MIDITrackerModifier.h.

◆ typeParam

AutomatableParameter::Ptr tracktion::engine::MIDITrackerModifier::typeParam

Definition at line 84 of file tracktion_MIDITrackerModifier.h.


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