![]() |
AAX SDK
2.4.1
Avid Audio Extensions Development Kit
|
Displaying EQ and Dynamics curves in Pro Tools, control surfaces, and other auxiliary graphical interfaces.
dsh> load_dish aaxh dsh> loadpi "/path/to/your/plug-in.aaxplugin" dsh> listeffects View the list of effects in your plug-in and determine which effect you want to test, if there are more than one dsh> instantiateforcontext {plugin: 0, effect: 0, plat: native, in: mono, out: mono, rate: 48000, alg: true} Use whatever context parameterization is appropriate for the plug-in configuration you want to test dsh> getcurvedata {plugin: 0, inst: 0, display: graph} Experiment with other display values to get other kinds of information You can edit the instance's parameter values within DSH using the "setparameter" command to see the effects of various parameter changes on the curve
cmd_result: curve_data: AXdr: values: supported: false AXdy: values: ascii_art: | 0| | | | | | ******** | ************ | ************ | **** | ***** | ***** | ***** | ***** | ***** | ***** | ***** | ***** | ***** | ***** -60|**** ---------------------------------------------------------------------------------------- | -60 0 supported: true AXeq: values: supported: false instanceID: 0 pluginID: 0 message_type: cmd_result ...
Enumerations | |
enum | AAX_ECurveType { AAX_eCurveType_None = 0 , AAX_eCurveType_EQ = 'AXeq' , AAX_eCurveType_Dynamics = 'AXdy' , AAX_eCurveType_Reduction = 'AXdr' } |
Different Curve Types that can be queried from the Host. More... | |
Auxiliary UI methods | |
virtual AAX_Result | AAX_IACFEffectParameters::GetCurveData (AAX_CTypeID iCurveType, const float *iValues, uint32_t iNumValues, float *oValues) const =0 |
Generate a set of output values based on a set of given input values. More... | |
Auxiliary UI methods | |
virtual AAX_Result | AAX_IACFEffectParameters_V3::GetCurveDataMeterIds (AAX_CTypeID iCurveType, uint32_t *oXMeterId, uint32_t *oYMeterId) const =0 |
Indicates which meters correspond to the X and Y axes of the EQ or Dynamics graph. More... | |
virtual AAX_Result | AAX_IACFEffectParameters_V3::GetCurveDataDisplayRange (AAX_CTypeID iCurveType, float *oXMin, float *oXMax, float *oYMin, float *oYMax) const =0 |
Determines the range of the graph shown by the plug-in. More... | |
enum AAX_ECurveType |
Different Curve Types that can be queried from the Host.
Enumerator | |
---|---|
AAX_eCurveType_None | |
AAX_eCurveType_EQ | EQ Curve, input values are in Hz, output values are in dB.
|
AAX_eCurveType_Dynamics | Dynamics Curve showing input vs. output, input and output values are in dB.
|
AAX_eCurveType_Reduction | Gain-reduction curve showing input vs. gain reduction, input and output values are in dB.
|
|
pure 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
Implemented in AAX_CEffectParameters.
|
pure 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 |
Implemented in AAX_CEffectParameters.
|
pure 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 |
Implemented in AAX_CEffectParameters.