![]() |
AAX SDK
2.4.1
Avid Audio Extensions Development Kit
|
#include <AAX_CEffectParameters.h>
Default implementation of the AAX_IEffectParameters interface.
This class provides a default implementation of the AAX_IEffectParameters interface. In nearly all cases, your plug-in's data model should inherit from this class and override only those functions that you wish to explicitly customize.
Public Member Functions | |
AAX_CEffectParameters (void) | |
~AAX_CEffectParameters (void) AAX_OVERRIDE | |
AAX_CEffectParameters & | operator= (const AAX_CEffectParameters &other) |
Initialization and uninitialization | |
AAX_Result | Initialize (IACFUnknown *iController) AAX_OVERRIDE |
Main data model initialization. Called when plug-in instance is first instantiated. More... | |
AAX_Result | Uninitialize (void) AAX_OVERRIDE |
Main data model uninitialization. More... | |
AAX host and plug-in event notification | |
AAX_Result | NotificationReceived (AAX_CTypeID inNotificationType, const void *inNotificationData, uint32_t inNotificationDataSize) AAX_OVERRIDE |
Notification Hook. More... | |
Parameter information | |
These methods are used by the AAX host to retrieve information about the plug-in's data model. For information about adding parameters to the plug-in and otherwise modifying the plug-in's data model, see AAX_CParameterManager. For information about parameters, see AAX_IParameter. | |
AAX_Result | GetNumberOfParameters (int32_t *oNumControls) const AAX_OVERRIDE |
CALL: Retrieves the total number of plug-in parameters. More... | |
AAX_Result | GetMasterBypassParameter (AAX_IString *oIDString) const AAX_OVERRIDE |
CALL: Retrieves the ID of the plug-in's Master Bypass parameter. More... | |
AAX_Result | GetParameterIsAutomatable (AAX_CParamID iParameterID, AAX_CBoolean *oAutomatable) const AAX_OVERRIDE |
CALL: Retrieves information about a parameter's automatable status. More... | |
AAX_Result | GetParameterNumberOfSteps (AAX_CParamID iParameterID, int32_t *oNumSteps) const AAX_OVERRIDE |
CALL: Retrieves the number of discrete steps for a parameter. More... | |
AAX_Result | GetParameterName (AAX_CParamID iParameterID, AAX_IString *oName) const AAX_OVERRIDE |
CALL: Retrieves the full name for a parameter. More... | |
AAX_Result | GetParameterNameOfLength (AAX_CParamID iParameterID, AAX_IString *oName, int32_t iNameLength) const AAX_OVERRIDE |
CALL: Retrieves an abbreviated name for a parameter. More... | |
AAX_Result | GetParameterDefaultNormalizedValue (AAX_CParamID iParameterID, double *oValue) const AAX_OVERRIDE |
CALL: Retrieves default value of a parameter. More... | |
AAX_Result | SetParameterDefaultNormalizedValue (AAX_CParamID iParameterID, double iValue) AAX_OVERRIDE |
CALL: Sets the default value of a parameter. More... | |
AAX_Result | GetParameterType (AAX_CParamID iParameterID, AAX_EParameterType *oParameterType) const AAX_OVERRIDE |
CALL: Retrieves the type of a parameter. More... | |
AAX_Result | GetParameterOrientation (AAX_CParamID iParameterID, AAX_EParameterOrientation *oParameterOrientation) const AAX_OVERRIDE |
CALL: Retrieves the orientation that should be applied to a parameter's controls. More... | |
AAX_Result | GetParameter (AAX_CParamID iParameterID, AAX_IParameter **oParameter) AAX_OVERRIDE |
CALL: Retrieves an arbitrary setting within a parameter. More... | |
AAX_Result | GetParameterIndex (AAX_CParamID iParameterID, int32_t *oControlIndex) const AAX_OVERRIDE |
CALL: Retrieves the index of a parameter. More... | |
AAX_Result | GetParameterIDFromIndex (int32_t iControlIndex, AAX_IString *oParameterIDString) const AAX_OVERRIDE |
CALL: Retrieves the ID of a parameter. More... | |
AAX_Result | GetParameterValueInfo (AAX_CParamID iParameterID, int32_t iSelector, int32_t *oValue) const AAX_OVERRIDE |
CALL: Retrieves a property of a parameter. More... | |
Parameter setters and getters | |
These methods are used by the AAX host and by the plug-in's UI to retrieve and modify the values of the plug-in's parameters.
| |
AAX_Result | GetParameterValueFromString (AAX_CParamID iParameterID, double *oValue, const AAX_IString &iValueString) const AAX_OVERRIDE |
CALL: Converts a value string to a value. More... | |
AAX_Result | GetParameterStringFromValue (AAX_CParamID iParameterID, double iValue, AAX_IString *oValueString, int32_t iMaxLength) const AAX_OVERRIDE |
CALL: Converts a normalized parameter value into a string representing its corresponding real value. More... | |
AAX_Result | GetParameterValueString (AAX_CParamID iParameterID, AAX_IString *oValueString, int32_t iMaxLength) const AAX_OVERRIDE |
CALL: Retrieves the value string associated with a parameter's current value. More... | |
AAX_Result | GetParameterNormalizedValue (AAX_CParamID iParameterID, double *oValuePtr) const AAX_OVERRIDE |
CALL: Retrieves a parameter's current value. More... | |
AAX_Result | SetParameterNormalizedValue (AAX_CParamID iParameterID, double iValue) AAX_OVERRIDE |
CALL: Sets the specified parameter to a new value. More... | |
AAX_Result | SetParameterNormalizedRelative (AAX_CParamID iParameterID, double iValue) AAX_OVERRIDE |
CALL: Sets the specified parameter to a new value relative to its current value. More... | |
Automated parameter helpers | |
These methods are used to lock and unlock automation system 'resources' when updating automatable parameters.
| |
AAX_Result | TouchParameter (AAX_CParamID iParameterID) AAX_OVERRIDE |
"Touches" (locks) a parameter in the automation system to a particular control in preparation for updates More... | |
AAX_Result | ReleaseParameter (AAX_CParamID iParameterID) AAX_OVERRIDE |
Releases a parameter from a "touched" state. More... | |
AAX_Result | UpdateParameterTouch (AAX_CParamID iParameterID, AAX_CBoolean iTouchState) AAX_OVERRIDE |
Sets a "touched" state on a parameter. More... | |
Asynchronous parameter update methods | |
These methods are called by the AAX host when parameter values have been updated. They are called by the host and can be triggered by other plug-in modules via calls to AAX_IParameter's These methods are responsible for updating parameter values. Do not call these methods directly! To ensure proper synchronization and to avoid problematic dependency chains, other methods (e.g. SetParameterNormalizedValue()) and components (e.g. AAX_IEffectGUI) should always call a | |
AAX_Result | UpdateParameterNormalizedValue (AAX_CParamID iParameterID, double iValue, AAX_EUpdateSource iSource) AAX_OVERRIDE |
Updates a single parameter's state to its current value. More... | |
AAX_Result | UpdateParameterNormalizedRelative (AAX_CParamID iParameterID, double iValue) AAX_OVERRIDE |
Updates a single parameter's state to its current value, as a difference with the parameter's previous value. More... | |
AAX_Result | GenerateCoefficients (void) AAX_OVERRIDE |
Generates and dispatches new coefficient packets. More... | |
State reset handlers | |
AAX_Result | ResetFieldData (AAX_CFieldIndex inFieldIndex, void *oData, uint32_t inDataSize) const AAX_OVERRIDE |
Called by the host to reset a private data field in the plug-in's algorithm. More... | |
Chunk methods | |
These methods are used to save and restore collections of plug-in state information, known as chunks. Chunks are used by the host when saving or restoring presets and session settings and when providing "compare" functionality for plug-ins. The default implementation of these methods in AAX_CEffectParameters supports a single chunk that includes state information for all of the plug-in's registered parameters. Override all of these methods to add support for additional chunks in your plug-in, for example if your plug-ni contains any persistent state that is not encapsulated by its set of registered parameters. For reference, see also: | |
AAX_Result | GetNumberOfChunks (int32_t *oNumChunks) const AAX_OVERRIDE |
Retrieves the number of chunks used by this plug-in. More... | |
AAX_Result | GetChunkIDFromIndex (int32_t iIndex, AAX_CTypeID *oChunkID) const AAX_OVERRIDE |
Retrieves the ID associated with a chunk index. More... | |
AAX_Result | GetChunkSize (AAX_CTypeID iChunkID, uint32_t *oSize) const AAX_OVERRIDE |
Get the size of the data structure that can hold all of a chunk's information. More... | |
AAX_Result | GetChunk (AAX_CTypeID iChunkID, AAX_SPlugInChunk *oChunk) const AAX_OVERRIDE |
Fills a block of data with chunk information representing the plug-in's current state. More... | |
AAX_Result | SetChunk (AAX_CTypeID iChunkID, const AAX_SPlugInChunk *iChunk) AAX_OVERRIDE |
Restores a set of plug-in parameters based on chunk information. More... | |
AAX_Result | CompareActiveChunk (const AAX_SPlugInChunk *iChunkP, AAX_CBoolean *oIsEqual) const AAX_OVERRIDE |
Determine if a chunk represents settings that are equivalent to the plug-in's current state. More... | |
AAX_Result | GetNumberOfChanges (int32_t *oNumChanges) const AAX_OVERRIDE |
Retrieves the number of parameter changes made since the plug-in's creation. More... | |
Threads | |
Threading functions | |
AAX_Result | TimerWakeup () AAX_OVERRIDE |
Periodic wakeup callback for idle-time operations. More... | |
Auxiliary UI methods | |
Methods defining the presentation of the plug-in on auxiliary UIs such as control surfaces | |
AAX_Result | GetCurveData (AAX_CTypeID iCurveType, const float *iValues, uint32_t iNumValues, float *oValues) const AAX_OVERRIDE |
Generate a set of output values based on a set of given input values. More... | |
AAX_Result | GetCurveDataMeterIds (AAX_CTypeID iCurveType, uint32_t *oXMeterId, uint32_t *oYMeterId) const AAX_OVERRIDE |
Indicates which meters correspond to the X and Y axes of the EQ or Dynamics graph. More... | |
AAX_Result | GetCurveDataDisplayRange (AAX_CTypeID iCurveType, float *oXMin, float *oXMax, float *oYMin, float *oYMax) const AAX_OVERRIDE |
Determines the range of the graph shown by the plug-in. More... | |
AAX_Result | UpdatePageTable (uint32_t inTableType, int32_t inTablePageSize, IACFUnknown *iHostUnknown, IACFUnknown *ioPageTableUnknown) const AAX_OVERRIDE AAX_FINAL |
Allow the plug-in to update its page tables. More... | |
Custom Data Methods | |
These functions exist as a proxiable way to move data between different modules (e.g. AAX_IEffectParameters and AAX_IEffectGUI.) Using these, the GUI can query any data through GetCustomData() with a plug-in defined
| |
AAX_Result | GetCustomData (AAX_CTypeID iDataBlockID, uint32_t inDataSize, void *oData, uint32_t *oDataWritten) const AAX_OVERRIDE |
An optional interface hook for getting custom data from another module. More... | |
AAX_Result | SetCustomData (AAX_CTypeID iDataBlockID, uint32_t inDataSize, const void *iData) AAX_OVERRIDE |
An optional interface hook for setting custom data for use by another module. More... | |
MIDI methods | |
AAX_Result | DoMIDITransfers () AAX_OVERRIDE |
MIDI update callback. More... | |
AAX_Result | UpdateMIDINodes (AAX_CFieldIndex inFieldIndex, AAX_CMidiPacket &iPacket) AAX_OVERRIDE |
MIDI update callback. More... | |
AAX_Result | UpdateControlMIDINodes (AAX_CTypeID nodeID, AAX_CMidiPacket &iPacket) AAX_OVERRIDE |
MIDI update callback for control MIDI nodes. More... | |
Hybrid audio methods | |
AAX_Result | RenderAudio_Hybrid (AAX_SHybridRenderInfo *ioRenderInfo) AAX_OVERRIDE |
Hybrid audio render function. More... | |
Private data accessors | |
AAX_IController * | Controller () |
Access to the Effect controller. More... | |
const AAX_IController * | Controller () const |
const access to the Effect controller More... | |
AAX_ITransport * | Transport () |
Access to the Transport object. More... | |
const AAX_ITransport * | Transport () const |
const access to the Transport object More... | |
AAX_IAutomationDelegate * | AutomationDelegate () |
Access to the Effect's automation delegate. More... | |
const AAX_IAutomationDelegate * | AutomationDelegate () const |
const access to the Effect's automation delegate More... | |
![]() | |
ACF_DECLARE_STANDARD_UNKNOWN () ACFMETHOD(InternalQueryInterface)(const acfIID &riid | |
AAX_DELETE (AAX_IEffectParameters &operator=(const AAX_IEffectParameters &)) | |
Auxiliary UI methods | |
Auxiliary UI methods | |
Hybrid audio methods | |
MIDI methods | |
Initialization and uninitialization | |
AAX host and plug-in event notification | |
Parameter information | |
These methods are used by the AAX host to retrieve information about the plug-in's data model.
| |
Parameter setters and getters | |
These methods are used by the AAX host and by the plug-in's UI to retrieve and modify the values of the plug-in's parameters.
| |
Automated parameter helpers | |
These methods are used to lock and unlock automation system 'resources' when updating automatable parameters.
| |
Asynchronous parameter update methods | |
These methods are called by the AAX host when parameter values have been updated. They are called by the host and can be triggered by other plug-in modules via calls to AAX_IParameter's These methods are responsible for updating parameter values. Do not call these methods directly! To ensure proper synchronization and to avoid problematic dependency chains, other methods (e.g. SetParameterNormalizedValue()) and components (e.g. AAX_IEffectGUI) should always call a | |
State reset handlers | |
Chunk methods | |
These methods are used to save and restore collections of plug-in state information, known as chunks. Chunks are used by the host when saving or restoring presets and session settings and when providing "compare" functionality for plug-ins. The default implementation of these methods in AAX_CEffectParameters supports a single chunk that includes state information for all of the plug-in's registered parameters. Override all of these methods to add support for additional chunks in your plug-in, for example if your plug-in contains any persistent state that is not encapsulated by its set of registered parameters.
For reference, see also: | |
Thread methods | |
Auxiliary UI methods | |
Custom data methods | |
These functions exist as a proxiable way to move data between different modules (e.g. AAX_IEffectParameters and AAX_IEffectGUI.) Using these, the GUI can query any data through GetCustomData() with a plug-in defined
| |
MIDI methods | |
![]() | |
virtual BEGIN_ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE | QueryInterface (const acfIID &iid, void **ppOut)=0 |
Returns pointers to supported interfaces. More... | |
virtual acfUInt32 ACFMETHODCALLTYPE | AddRef (void)=0 |
Increments reference count. More... | |
virtual acfUInt32 ACFMETHODCALLTYPE | Release (void)=0 |
Decrements reference count. More... | |
Protected Member Functions | |
Parameter management methods | |
AAX_Result | SetTaperDelegate (AAX_CParamID iParameterID, AAX_ITaperDelegateBase &iTaperDelegate, bool iPreserveValue) |
AAX_Result | SetDisplayDelegate (AAX_CParamID iParameterID, AAX_IDisplayDelegateBase &iDisplayDelegate) |
bool | IsParameterTouched (AAX_CParamID iParameterID) const |
bool | IsParameterLinkReady (AAX_CParamID inParameterID, AAX_EUpdateSource inSource) const |
Convenience functions | |
These convenience functions provide quick access to various aspects of the default AAX_CEffectParameters implementation. | |
int32_t | mNumPlugInChanges |
int32_t | mChunkSize |
AAX_CChunkDataParser | mChunkParser |
int32_t | mNumChunkedParameters |
AAX_CPacketDispatcher | mPacketDispatcher |
AAX_CParameterManager | mParameterManager |
std::set< std::string > | mFilteredParameters |
virtual AAX_Result | EffectInit (void) |
Initialization helper routine. Called from AAX_CEffectParameters::Initialize. More... | |
virtual AAX_Result | UpdatePageTable (uint32_t, int32_t, AAX_IPageTable &) const |
void | FilterParameterIDOnSave (AAX_CParamID controlID) |
CALL: Indicates the indices of parameters that should not be saved in the default AAX_CEffectParameters chunk. More... | |
void | BuildChunkData (void) const |
Clears out the current chunk in Chunk Parser and adds all of the new values. Used by default implementations of GetChunk() and GetChunkSize(). More... | |
Additional Inherited Members | |
![]() | |
void **ppvObjOut | override |
AAX_CEffectParameters::AAX_CEffectParameters | ( | void | ) |
AAX_CEffectParameters::~AAX_CEffectParameters | ( | void | ) |
AAX_CEffectParameters& AAX_CEffectParameters::operator= | ( | const AAX_CEffectParameters & | other | ) |
|
virtual |
Main data model initialization. Called when plug-in instance is first instantiated.
[in] | iController | A versioned reference that resolves to an AAX_IController interface |
This default implementation calls EffectInit(). Only override Initialize() when additional initialization steps must be performed prior to EffectInit().
Implements AAX_IACFEffectParameters.
|
virtual |
Main data model uninitialization.
Implements AAX_IACFEffectParameters.
|
virtual |
Notification Hook.
Called from the host to deliver notifications to this object.
Look at the AAX_ENotificationEvent enumeration to see a description of events you can listen for and the data they come with.
NotificationReceived()
methods.NotificationReceived()
method (e.g. the GUI).[in] | inNotificationType | Type of notification being received. Notifications form the host are one of AAX_ENotificationEvent |
[in] | inNotificationData | Block of incoming notification data |
[in] | inNotificationDataSize | Size of inNotificationData , in bytes |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Retrieves the total number of plug-in parameters.
[out] | oNumControls | The number of parameters in the plug-in's Parameter Manager |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Retrieves the ID of the plug-in's Master Bypass parameter.
This is required if you want our master bypass functionality in the host to hook up to your bypass parameters.
[out] | oIDString | The ID of the plug-in's Master Bypass control |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Retrieves information about a parameter's automatable status.
[in] | iParameterID | The ID of the parameter that is being queried |
[out] | oAutomatable | True if the queried parameter is automatable, false if it is not |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Retrieves the number of discrete steps for a parameter.
oNumSteps
MUST be greater than zero. All other values will be considered an error by the host.[in] | iParameterID | The ID of the parameter that is being queried |
[out] | oNumSteps | The number of steps for this parameter |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Retrieves the full name for a parameter.
[in] | iParameterID | The ID of the parameter that is being queried |
[out] | oName | Reference to an AAX_IString owned by the host. The plug-in must set this string equal to the parameter's full name. |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Retrieves an abbreviated name for a parameter.
In general, lengths of 3 through 8 and 31 should be specifically addressed.
[in] | iParameterID | The ID of the parameter that is being queried |
[out] | oName | Reference to an AAX_IString owned by the host. The plug-in must set this string equal to an abbreviated name for the parameter, using iNameLength characters or fewer. |
[in] | iNameLength | The maximum number of characters in oName |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Retrieves default value of a parameter.
[in] | iParameterID | The ID of the parameter that is being queried |
[out] | oValue | The parameter's default value |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Sets the default value of a parameter.
[in] | iParameterID | The ID of the parameter that is being updated |
[out] | iValue | The parameter's new default value |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Retrieves the type of a parameter.
[in] | iParameterID | The ID of the parameter that is being queried |
[out] | oParameterType | The parameter's type |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Retrieves the orientation that should be applied to a parameter's controls.
This method allows you to specify the orientation of knob controls that are managed by the host (e.g. knobs on an attached control surface.)
Here is an example override of this method that reverses the orientation of a control for a parameter:
The orientation options are set according to AAX_EParameterOrientationBits
[in] | iParameterID | The ID of the parameter that is being queried |
[out] | oParameterOrientation | The orientation of the parameter |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Retrieves an arbitrary setting within a parameter.
This is a convenience function for accessing the richer parameter interface from the plug-in's other modules.
[in] | iParameterID | The ID of the parameter that is being queried |
[out] | oParameter | A pointer to the returned parameter |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Retrieves the index of a parameter.
Although parameters are normally referenced by their AAX_CParamID, each parameter is also associated with a unique numeric index.
[in] | iParameterID | The ID of the parameter that is being queried |
[out] | oControlIndex | The parameter's numeric index |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Retrieves the ID of a parameter.
This method can be used to convert a parameter's unique numeric index to its AAX_CParamID
[in] | iControlIndex | The numeric index of the parameter that is being queried |
[out] | oParameterIDString | Reference to an AAX_IString owned by the host. The plug-in must set this string equal to the parameter's ID. |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Retrieves a property of a parameter.
This is a general purpose query that is specialized based on the value of iSelector
. The currently supported selector values are described by AAX_EParameterValueInfoSelector . The meaning of oValue
is dependent upon iSelector
.
[in] | iParameterID | The ID of the parameter that is being queried |
[in] | iSelector | The selector of the parameter value to retrieve. See AAX_EParameterValueInfoSelector |
[out] | oValue | The value of the specified parameter |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Converts a value string to a value.
This method uses the queried parameter's display delegate and taper to convert a char*
string into its corresponding value. The formatting of valueString must be supported by the parameter's display delegate in order for this call to succeed.
[in] | iParameterID | The ID of the parameter that is being queried |
[out] | oValue | The value associated with valueString |
[in] | iValueString | The formatted value string that will be converted into a value |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Converts a normalized parameter value into a string representing its corresponding real value.
This method uses the queried parameter's display delegate and taper to convert a normalized value into the corresponding char*
value string for its real value.
[in] | iParameterID | The ID of the parameter that is being queried |
[in] | iValue | The normalized value that will be converted to a formatted valueString |
[out] | oValueString | The formatted value string associated with value |
[in] | iMaxLength | The maximum length of valueString |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Retrieves the value string associated with a parameter's current value.
This method uses the queried parameter's display delegate and taper to convert its current value into a corresponding char*
value string.
[in] | iParameterID | The ID of the parameter that is being queried |
[out] | oValueString | The formatted value string associated with the parameter's current value |
[in] | iMaxLength | The maximum length of valueString |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Retrieves a parameter's current value.
[in] | iParameterID | The ID of the parameter that is being queried |
[out] | oValuePtr | The parameter's current value |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Sets the specified parameter to a new value.
SetParameterNormalizedValue() is responsible for initiating any process that is required in order to update all of the parameter's controls (e.g. in the plug-in's GUI, on control surfaces, in automation lanes, etc.) In most cases, the parameter manager will handle this initiation step.
[in] | iParameterID | The ID of the parameter that is being set |
[in] | iValue | The value to which the parameter should be set |
Implements AAX_IACFEffectParameters.
|
virtual |
CALL: Sets the specified parameter to a new value relative to its current value.
This method is used in cases when a relative control value is more convenient, for example when updating a GUI control using a mouse wheel or the arrow keys. Note that the host may apply the parameter's step size prior to calling SetParameterNormalizedRelative() in order to determine the correct value for aValue.
SetParameterNormalizedRelative() can be used to incorporate "wrapping" behavior in a parameter's controls, if desired. If this behavior is not desired, then this method must properly account for overflow of the parameter's normalized value.
SetParameterNormalizedRelative() is responsible for initiating any process that is required in order to update all of the parameter's controls (e.g. in the plug-in's GUI, on control surfaces, in automation lanes, etc.) In most cases, the parameter manager will handle this initiation step.
See also UpdateParameterNormalizedRelative().
[in] | iParameterID | The ID of the parameter that is being queried |
[in] | iValue | The change in value that should be applied to the parameter |
Implements AAX_IACFEffectParameters.
|
virtual |
"Touches" (locks) a parameter in the automation system to a particular control in preparation for updates
This method is called by the Parameter Manager to prime a parameter for receiving new automation data. When an automatable parameter is touched by a control, it will reject input from other controls until it is released.
[in] | iParameterID | The parameter that is being touched |
Implements AAX_IACFEffectParameters.
|
virtual |
Releases a parameter from a "touched" state.
This method is called by the Parameter Manager to release a parameter so that any control may send updates to the parameter.
[in] | iParameterID | The parameter that is being released |
Implements AAX_IACFEffectParameters.
|
virtual |
Sets a "touched" state on a parameter.
[in] | iParameterID | The parameter that is changing touch states. |
[in] | iTouchState | The touch state of the parameter. |
Implements AAX_IACFEffectParameters.
|
virtual |
Updates a single parameter's state to its current value.
[in] | iParameterID | The ID of the parameter that is being updated |
[in] | iValue | The parameter's current value, to which its internal state must be updated |
[in] | iSource | The source of the update |
Implements AAX_IACFEffectParameters.
Reimplemented in AAX_CMonolithicParameters.
Referenced by AAX_CMonolithicParameters::UpdateParameterNormalizedValue().
|
virtual |
Updates a single parameter's state to its current value, as a difference with the parameter's previous value.
UpdateParameterNormalizedRelative() can be used to incorporate "wraparound" behavior in a parameter's controls, if desired. If this behavior is not desired, then this method must properly account for overflow of the parameter's normalized value.
[in] | iParameterID | The ID of the parameter that is being updated |
[in] | iValue | The difference between the parameter's current value and its previous value (normalized). The parameter's state must be updated to reflect this difference. |
Implements AAX_IACFEffectParameters.
|
virtual |
Generates and dispatches new coefficient packets.
This method is responsible for updating the coefficient packets associated with all parameters whose states have changed since the last call to GenerateCoefficients(). The host may call this method once for every parameter update, or it may "batch" parameter updates such that changes for several parameters are all handled by a single call to GenerateCoefficients().
For more information on tracking parameters' statuses using the AAX_CPacketDispatcher, helper class, see AAX_CPacketDispatcher::SetDirty().
Implements AAX_IACFEffectParameters.
Reimplemented in AAX_CMonolithicParameters.
Referenced by AAX_CMonolithicParameters::GenerateCoefficients().
|
virtual |
Called by the host to reset a private data field in the plug-in's algorithm.
This method is called sequentially for all private data fields on Effect initialization and during any "reset" event, such as priming for a non-real-time render. This method is called before the algorithm's optional initialization callback, and the initialized private data will be available within that callback via its context block.
[in] | inFieldIndex | The index of the field that is being initialized |
[out] | oData | The pre-allocated block of data that should be initialized |
[in] | inDataSize | The size of the data block, in bytes |
Implements AAX_IACFEffectParameters.
Reimplemented in AAX_CMonolithicParameters.
Referenced by AAX_CMonolithicParameters::ResetFieldData().
|
virtual |
Retrieves the number of chunks used by this plug-in.
[out] | oNumChunks | The number of distinct chunks used by this plug-in |
Implements AAX_IACFEffectParameters.
|
virtual |
Retrieves the ID associated with a chunk index.
[in] | iIndex | Index of the queried chunk |
[out] | oChunkID | ID of the queried chunk |
Implements AAX_IACFEffectParameters.
|
virtual |
Get the size of the data structure that can hold all of a chunk's information.
If chunkID is one of the plug-in's custom chunks, initialize *size to the size of the chunk's data in bytes.
This method is invoked every time a chunk is saved, therefore it is possible to have dynamically sized chunks. However, note that each call to GetChunkSize() will correspond to a following call to GetChunk(). The chunk provided in GetChunk() must have the same size as the size provided by GetChunkSize().
[in] | iChunkID | ID of the queried chunk |
[out] | oSize | The chunk's size in bytes |
Implements AAX_IACFEffectParameters.
|
virtual |
Fills a block of data with chunk information representing the plug-in's current state.
By calling this method, the host is requesting information about the current state of the plug-in. The following chunk fields should be explicitly populated in this method. Other fields will be populated by the host.
[in] | iChunkID | ID of the chunk that should be provided |
[out] | oChunk | A preallocated block of memory that should be populated with the chunk's data. |
Implements AAX_IACFEffectParameters.
|
virtual |
Restores a set of plug-in parameters based on chunk information.
By calling this method, the host is attempting to update the plug-in's current state to match the data stored in a chunk. The plug-in should initialize itself to this new state by calling SetParameterNormalizedValue() for each of the relevant parameters.
[in] | iChunkID | ID of the chunk that is being set |
[in] | iChunk | The chunk |
Implements AAX_IACFEffectParameters.
|
virtual |
Determine if a chunk represents settings that are equivalent to the plug-in's current state.
aChunkP
then the plug-in's Compare Light will be illuminated in the plug-in header, allowing users to toggle between the plug-in's custom state and its saved state.[in] | iChunkP | The chunk that is to be tested |
[out] | oIsEqual | True if the chunk represents equivalent settings when compared with the plug-in's current state. False if the chunk represents non-equivalent settings |
Implements AAX_IACFEffectParameters.
|
virtual |
Retrieves the number of parameter changes made since the plug-in's creation.
This method is polled regularly by the host, and can additionally be triggered by some events such as mouse clicks. When the number provided by this method changes, the host subsequently calls CompareActiveChunk() to determine if the plug-in's Compare light should be activated.
The value provided by this method should increment with each call to UpdateParameterNormalizedValue()
[out] | oNumChanges | Must be set to indicate the number of parameter changes that have occurred since plug-in initialization. |
Implements AAX_IACFEffectParameters.
|
virtual |
Periodic wakeup callback for idle-time operations.
This method is called from the host using a non-main thread. In general, it should be driven at approximately one call per 30 ms. However, the wakeup is not guaranteed to be called at any regular interval - for example, it could be held off by a high real-time processing load - and there is no host contract regarding maximum latency between wakeup calls.
This wakeup thread runs continuously and cannot be armed/disarmed or by the plug-in.
Implements AAX_IACFEffectParameters.
Reimplemented in AAX_CMonolithicParameters.
Referenced by AAX_CMonolithicParameters::TimerWakeup().
|
virtual |
Generate a set of output values based on a set of given input values.
This method is used by the host to generate graphical curves. Given a set of input values, e.g. frequencies in Hz, this method should generate a corresponding set of output values, e.g. dB gain at each frequency. The semantics of these input and output values are dictated by iCurveType
. See AAX_ECurveType.
Plug-ins may also define custom curve type IDs to use this method internally. For example, the plug-in's GUI could use this method to request curve data in an arbitrary format.
iValues
.oValues
must be allocated by caller with the same size as iValues
(iNumValues
).[in] | iCurveType | One of AAX_ECurveType |
[in] | iValues | An array of input values |
[in] | iNumValues | The size of iValues |
[out] | oValues | An array of ouptut values |
iCurveType
Implements AAX_IACFEffectParameters.
|
virtual |
Indicates which meters correspond to the X and Y axes of the EQ or Dynamics graph.
These meters can be used by attached control surfaces to present an indicator in the same X/Y coordinate plane as the plug-in's curve data.
[in] | iCurveType | One of AAX_ECurveType |
[out] | oXMeterId | Id of the X-axis meter |
[out] | oYMeterId | Id of the Y-axis meter |
Implements AAX_IACFEffectParameters_V3.
|
virtual |
Determines the range of the graph shown by the plug-in.
Min/max arguments define the range of the axes of the graph.
[in] | iCurveType | One of AAX_ECurveType |
[out] | oXMin | Min value of X-axis range |
[out] | oXMax | Max value of X-axis range |
[out] | oYMin | Min value of Y-axis range |
[out] | oYMax | Max value of Y-axis range |
Implements AAX_IACFEffectParameters_V3.
|
virtual |
Allow the plug-in to update its page tables.
Called by the plug-in host, usually in response to a AAX_eNotificationEvent_ParameterMappingChanged notification sent from the plug-in.
Use this method to change the page table mapping for the plug-in instance or to apply other changes to auxiliary UIs which use the plug-in page tables, such as setting focus to a new page.
See Page Table Guide for more information about page tables.
[in] | inTableType | Four-char type identifier for the table type (e.g. 'PgTL' , 'Av81' , etc.) |
[in] | inTablePageSize | Page size for the table |
[in] | iHostUnknown | Unknown interface from the host which may support interfaces providing additional features or information. All interfaces queried from this unknown will be valid only within the scope of this UpdatePageTable() execution and will be relevant for only the current plug-in instance. |
[in,out] | ioPageTableUnknown | Unknown interface which supports AAX_IPageTable. This object represents the page table data which is currently stored by the host for this plug-in instance for the given table type and page size. This data and may be edited within the scope of UpdatePageTable() to change the page table mapping for this plug-in instance. |
Implements AAX_IACFEffectParameters_V4.
|
virtual |
An optional interface hook for getting custom data from another module.
[in] | iDataBlockID | Identifier for the requested block of custom data |
[in] | inDataSize | Size of provided buffer, in bytes |
[out] | oData | Pointer to an allocated buffer. Data will be written here. |
[out] | oDataWritten | The number of bytes actually written |
Implements AAX_IACFEffectParameters.
|
virtual |
An optional interface hook for setting custom data for use by another module.
[in] | iDataBlockID | Identifier for the provided block of custom data |
[in] | inDataSize | Size of provided buffer, in bytes |
[in] | iData | Pointer to the data buffer |
Implements AAX_IACFEffectParameters.
|
inlinevirtual |
MIDI update callback.
Call AAX_IController::GetNextMIDIPacket() from within this method to retrieve and process MIDI packets directly within the Effect's data model. MIDI data will also be delivered to the Effect algorithm.
This method is called regularly by the host, similarly to AAX_IEffectParameters::TimerWakeup()
Implements AAX_IACFEffectParameters.
References AAX_SUCCESS.
|
virtual |
MIDI update callback.
This method is called by the host for each pending MIDI packet for MIDI nodes in algorithm context structure. Overwrite this method in Plug-In's EffectParameter class if you want to receive MIDI data packets directly in the data model. MIDI data will also be delivered to the Effect algorithm.
The host calls this method in Effects that register one or more MIDI nodes using AAX_IComponentDescriptor::AddMIDINode(). Effects that do not require MIDI data to be sent to the plug-in algorithm should override UpdateControlMIDINodes().
[in] | inFieldIndex | MIDI node field index in algorithm context structure |
[in] | iPacket | The incoming MIDI packet for the node |
Implements AAX_IACFEffectParameters_V2.
|
virtual |
MIDI update callback for control MIDI nodes.
This method is called by the host for each pending MIDI packet for Control MIDI nodes. Overwrite this method in Plug-In's EffectParameter class if you want to receive MIDI data packets directly in the data model.
The host calls this method in Effects that register one or more Control MIDI nodes using AAX_IEffectDescriptor::AddControlMIDINode(). Effects with algorithms that use MIDI data nodes should override UpdateMIDINodes().
[in] | nodeID | Identifier for the MIDI node |
[in] | iPacket | The incoming MIDI packet for the node |
Implements AAX_IACFEffectParameters_V2.
|
virtual |
Hybrid audio render function.
This method is called from the host to render audio for the hybrid piece of the algorithm.
Implements AAX_IACFEffectParameters_V2.
AAX_IController* AAX_CEffectParameters::Controller | ( | ) |
Access to the Effect controller.
Referenced by AAX_CMonolithicParameters::GenerateCoefficients().
const AAX_IController* AAX_CEffectParameters::Controller | ( | ) | const |
const
access to the Effect controller
AAX_ITransport* AAX_CEffectParameters::Transport | ( | ) |
Access to the Transport object.
const AAX_ITransport* AAX_CEffectParameters::Transport | ( | ) | const |
const
access to the Transport object
AAX_IAutomationDelegate* AAX_CEffectParameters::AutomationDelegate | ( | ) |
Access to the Effect's automation delegate.
const AAX_IAutomationDelegate* AAX_CEffectParameters::AutomationDelegate | ( | ) | const |
const
access to the Effect's automation delegate
|
protected |
|
protected |
|
protected |
|
protected |
|
inlineprotectedvirtual |
Initialization helper routine. Called from AAX_CEffectParameters::Initialize.
Override to add parameters, packets, meters, and to do any other custom initialization.
Add custom parameters:
Register packets:
References AAX_SUCCESS.
|
inlineprotectedvirtual |
Protected overload of UpdatePageTable()
Override this version of the method for convenience. This allows the default UpdatePageTable() implementation to handle the interface conversion from IACFUnknown to AAX_IPageTable.
References AAX_ERROR_UNIMPLEMENTED.
|
protected |
CALL: Indicates the indices of parameters that should not be saved in the default AAX_CEffectParameters chunk.
Allows specific parameters to filtered out of the default AAX_CEffectParameters "Save Settings" functionality. This call is automatically invoked on the Master Bypass control when specified by the DefineMasterBypassControlIndex() call.
[in] | controlID | The ID of the parameter that should be removed from the default chunk |
|
protected |
Clears out the current chunk in Chunk Parser and adds all of the new values. Used by default implementations of GetChunk() and GetChunkSize().
|
protected |
|
mutableprotected |
|
mutableprotected |
|
protected |
|
protected |
|
protected |
Referenced by AAX_CMonolithicParameters::UpdateParameterNormalizedValue().
|
protected |