aes70
Version:
A controller library for the AES70 protocol.
296 lines (293 loc) • 11.3 kB
JavaScript
import { OcaDBr } from '../../OCP1/OcaDBr.js';
import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
import { OcaList } from '../../OCP1/OcaList.js';
import { OcaParameterMask } from '../../OCP1/OcaParameterMask.js';
import { OcaUint8 } from '../../OCP1/OcaUint8.js';
import { make_control_class } from '../make_control_class.js';
import { OcaActuator } from './OcaActuator.js';
/**
* Dynamic compression / expansion curve. **Curve** means a function that
* expresses the relationship of output level to input level. The dependent
* variable (Y) of the curve is output level; the independent variable (X) is
* input level. Every curve is composed of **(n+1)** straight-line **segments**
* joined by **(n)** small fillets called **knees**. Each knee occurs at a
* particular input level value called the **threshold.** Each segment is
* characterized by its **slope.** ** ** | ** / ** | S3 ** / ** | S2 ** / ** |
* T1**-------------**T2 | ** / ** | S1 ** / ** | ** / ** | ** / **
* +------------------------------------ This "drawing" shows a three-segment
* curve. The horizontal axis is input level, vertical axis is output level.
* Algebraically, a curve is a function ** Out = Curve( In, T[1..n-1], S[1..n],
* K[1..n-1] )** where **n** is the number of segments, and **In** is input
* level in dBr **Out** is output level in dBr **T[1...n-1]** is an array of
* **thresholds** in dBr **S[1...n]** is an array of **slopes** in dBr per dBr,
* i.e. unitless **K[1..n]** is the **knee parameter**, an
* implementation-dependant parameter that specifies the shape of the curve
* around the knee. Each segment has a slope that expresses its ratio of output
* level to input level. Note that this slope is the inverse of what dynamics
* processors call "ratio". For example, a ratio of 2:1 is represented by a
* curve segment with slope 1/2 = 0.5. This model can represent familiar audio
* dynamics elements (we ignore **K[]** in these examples): - Compressor with
* ratio of 2:1 and threshold of 10dBr: ** n = 2** ** T[1] = 10** ** S[1] = 1**
* ** S[2] = 0.5** - Hard limiter with threshold of 18dBr: ** n = 2** T[1] = 18
* S[1] = 1 S[2] = 0 - Upward expander with ratio of 1.5:1 and threshold of
* -12dBr: ** n = 2** T[1] = -12 S[1] = 1 S[2] = 1.5 - Downward expander (gate)
* with ratio of 50:1 and threshold of -45dBr: ** n = 2** T[1] = -45 S[1] = 50
* S[2] = 1 This class, **OcaDynamicsCurve,** adds two additional parameters to
* the basic curve mechanism. **Out = Curve( In, T[1..n-1], S[1..n], K[1..n-1] ,
* Floor, Ceiling)** where **In, T[], and S[],** and **K[]** are as defined
* above. **Floor** is the lowest gain (in dBr) that the dynamics element is
* allowed to produce. **Ceiling** is the highest gain (in dBr) that the
* dynamics element is allowed to produce. To show the use of **Floor** and
* **Ceiling**, we revisit some of the examples above (again, **K[]** is
* ignored): - Compressor with ratio of 2:1, threshold of 10dBr, and max gain
* reduction of 20dB: ** n = 2** ** T[1] = 10** ** S[1] = 1** ** S[2] = 0.5** **
* Floor = -20** ** Ceiling = 0** - Upward expander with ratio of 1.5:1,
* threshold of -12dBr, and max gain boost of 4dB: ** n = 2** T[1] = -12 S[1] =
* 1 S[2] = 1.5 Floor = 0 Ceiling = 4.0 More complex dynamics curves can be
* modeled by using more segments (**n > 2)**.
* @extends OcaActuator
* @class OcaDynamicsCurve
*/
export const OcaDynamicsCurve = make_control_class(
'OcaDynamicsCurve',
4,
'\u0001\u0001\u0001\u0010',
2,
OcaActuator,
[
['GetNSegments', 4, 1, [], [OcaUint8, OcaUint8, OcaUint8]],
['SetNSegments', 4, 2, [OcaUint8], []],
['GetThreshold', 4, 3, [], [OcaList(OcaDBr), OcaFloat32, OcaFloat32]],
['SetThreshold', 4, 4, [OcaList(OcaDBr)], []],
[
'GetSlope',
4,
5,
[],
[OcaList(OcaFloat32), OcaList(OcaFloat32), OcaList(OcaFloat32)],
],
['SetSlope', 4, 6, [OcaList(OcaFloat32)], []],
[
'GetKneeParameter',
4,
7,
[],
[OcaList(OcaFloat32), OcaList(OcaFloat32), OcaList(OcaFloat32)],
],
['SetKneeParameter', 4, 8, [OcaList(OcaFloat32)], []],
['GetDynamicGainCeiling', 4, 9, [], [OcaFloat32, OcaFloat32, OcaFloat32]],
['SetDynamicGainCeiling', 4, 10, [OcaFloat32], []],
['GetDynamicGainFloor', 4, 11, [], [OcaFloat32, OcaFloat32, OcaFloat32]],
['SetDynamicGainFloor', 4, 12, [OcaFloat32], []],
[
'SetMultiple',
4,
13,
[
OcaParameterMask,
OcaUint8,
OcaList(OcaDBr),
OcaList(OcaFloat32),
OcaList(OcaFloat32),
OcaFloat32,
OcaFloat32,
],
[],
],
],
[
['NSegments', [OcaUint8], 4, 1, false, false, null],
['Threshold', [OcaList(OcaDBr)], 4, 2, false, false, null],
['Slope', [OcaList(OcaFloat32)], 4, 3, false, false, null],
['KneeParameter', [OcaList(OcaFloat32)], 4, 4, false, false, null],
['DynamicGainFloor', [OcaFloat32], 4, 5, false, false, null],
['DynamicGainCeiling', [OcaFloat32], 4, 6, false, false, null],
],
[]
);
/**
* Gets the number of curve segments. The return value indicates whether the
* value was successfully retrieved.
* The return values of this method are
*
* - n of type ``number``
* - minN of type ``number``
* - maxN of type ``number``
*
* @method OcaDynamicsCurve#GetNSegments
* @returns {Promise<Arguments<number,number,number>>}
*/
/**
* Sets the number of curve segments. The return value indicates whether the
* data was successfully set. If this method increases the value of n, the data
* in properties **Threshold**, **Slope**, and **KneeParameter** of the new
* segment are by default set to the values of the previous segment.
*
* @method OcaDynamicsCurve#SetNSegments
* @param {number} Slope
*
* @returns {Promise<void>}
*/
/**
* Gets the list of Threshold values. The return value indicates whether the
* data was successfully retrieved.
* The return values of this method are
*
* - Threshold of type ``IOcaDBr[]``
* - minThreshold of type ``number``
* - maxThreshold of type ``number``
*
* @method OcaDynamicsCurve#GetThreshold
* @returns {Promise<Arguments<OcaDBr[],number,number>>}
*/
/**
* Sets the list of Threshold values. The return value indicates whether the
* values were successfully set.
*
* @method OcaDynamicsCurve#SetThreshold
* @param {IOcaDBr[]} Threshold
*
* @returns {Promise<void>}
*/
/**
* Gets the list of Slope values. The return value indicates whether the list
* was successfully retrieved.
* The return values of this method are
*
* - slope of type ``number[]``
* - minSlope of type ``number[]``
* - maxSlope of type ``number[]``
*
* @method OcaDynamicsCurve#GetSlope
* @returns {Promise<Arguments<number[],number[],number[]>>}
*/
/**
* Sets the list of Slope values. The return value indicates whether the values
* were successfully set.
*
* @method OcaDynamicsCurve#SetSlope
* @param {number[]} slope
*
* @returns {Promise<void>}
*/
/**
* Gets the list of KneeParameter valuess. The return value indicates whether
* the list was successfully retrieved.
* The return values of this method are
*
* - parameter of type ``number[]``
* - minParameter of type ``number[]``
* - maxParameter of type ``number[]``
*
* @method OcaDynamicsCurve#GetKneeParameter
* @returns {Promise<Arguments<number[],number[],number[]>>}
*/
/**
* Sets the list of KneeParameter values. The return value indicates whether the
* values were successfully set.
*
* @method OcaDynamicsCurve#SetKneeParameter
* @param {number[]} parameter
*
* @returns {Promise<void>}
*/
/**
* Gets the value of the DynamicGainCeiling property. The return value indicates
* whether the data was successfully retrieved.
* The return values of this method are
*
* - gain of type ``number``
* - minGain of type ``number``
* - maxGain of type ``number``
*
* @method OcaDynamicsCurve#GetDynamicGainCeiling
* @returns {Promise<Arguments<number,number,number>>}
*/
/**
* Sets the value of the DynamicGainCeiling property. The return value indicates
* whether the data was successfully set.
*
* @method OcaDynamicsCurve#SetDynamicGainCeiling
* @param {number} gain
*
* @returns {Promise<void>}
*/
/**
* Gets the value of the DynamicGainFloor property. The return value indicates
* whether the data was successfully retrieved.
* The return values of this method are
*
* - Gain of type ``number``
* - minGain of type ``number``
* - maxGain of type ``number``
*
* @method OcaDynamicsCurve#GetDynamicGainFloor
* @returns {Promise<Arguments<number,number,number>>}
*/
/**
* Sets the value of the DynamicGainFloor property. The return value indicates
* whether the data was successfully set.
*
* @method OcaDynamicsCurve#SetDynamicGainFloor
* @param {number} Gain
*
* @returns {Promise<void>}
*/
/**
* Sets some or all dynamics curve parameters. The return value indicates if the
* parameters were successfully set. The action of this method is atomic - if
* any of the value changes fails, none of the changes are made.
*
* @method OcaDynamicsCurve#SetMultiple
* @param {IOcaParameterMask} Mask
* @param {number} nSegments
* @param {IOcaDBr[]} Threshold
* @param {number[]} Slope
* @param {number[]} KneeParameter
* @param {number} DynamicGainFloor
* @param {number} DynamicGainCeiling
*
* @returns {Promise<void>}
*/
/**
* This event is emitted when the property ``NSegments`` changes in the remote object.
* The property ``NSegments`` is described in the AES70 standard as follows.
* Number of curve segments.
*
* @member {PropertyEvent<number>} OcaDynamicsCurve#OnNSegmentsChanged
*/
/**
* This event is emitted when the property ``Threshold`` changes in the remote object.
* The property ``Threshold`` is described in the AES70 standard as follows.
* **T[1..n-1]**. See class description for details.
*
* @member {PropertyEvent<OcaDBr[]>} OcaDynamicsCurve#OnThresholdChanged
*/
/**
* This event is emitted when the property ``Slope`` changes in the remote object.
* The property ``Slope`` is described in the AES70 standard as follows.
* **S[1..n]**. See class description for details.
*
* @member {PropertyEvent<number[]>} OcaDynamicsCurve#OnSlopeChanged
*/
/**
* This event is emitted when the property ``KneeParameter`` changes in the remote object.
* The property ``KneeParameter`` is described in the AES70 standard as follows.
* **K[1..n]**. See class description for details.
*
* @member {PropertyEvent<number[]>} OcaDynamicsCurve#OnKneeParameterChanged
*/
/**
* This event is emitted when the property ``DynamicGainFloor`` changes in the remote object.
* The property ``DynamicGainFloor`` is described in the AES70 standard as follows.
* Lowest allowed dynamic gain value. See class description for details.
*
* @member {PropertyEvent<number>} OcaDynamicsCurve#OnDynamicGainFloorChanged
*/
/**
* This event is emitted when the property ``DynamicGainCeiling`` changes in the remote object.
* The property ``DynamicGainCeiling`` is described in the AES70 standard as follows.
* Highest allowed dynamic gain value. See class description for details.
*
* @member {PropertyEvent<number>} OcaDynamicsCurve#OnDynamicGainCeilingChanged
*/