Compressor Expander control
[Mixer and Controls]

The compander multiplies its input signal by a factor that is dependent on the amplitude of that signal. More...

Functions
HPI_ERR	HPI_Compander_Set (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 wAttack, HW16 wDecay, short wRatio100, short nThreshold0_01dB, short nMakeupGain0_01dB)
	Set up a compressor expander.
HPI_ERR	HPI_Compander_Get (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 *pwAttack, HW16 *pwDecay, short *pwRatio100, short *pnThreshold0_01dB, short *pnMakeupGain0_01dB)
HPI_ERR	HPI_Compander_SetEnable (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 Enable)
	Enable or disable the compander.
HPI_ERR	HPI_Compander_GetEnable (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 *Enable)
	Get the enable state of the compander.
HPI_ERR	HPI_Compander_SetMakeupGain (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, short nMakeupGain0_01dB)
	Set the makeup gain of a compander control.
HPI_ERR	HPI_Compander_GetMakeupGain (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, short *nMakeupGain0_01dB)
	Get the makeup gain of a compander control.
HPI_ERR	HPI_Compander_SetAttackTimeConstant (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, unsigned int index, HW32 wAttack)
	Set the attack timeconstants.
HPI_ERR	HPI_Compander_GetAttackTimeConstant (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, unsigned int index, HW32 *Attack)
	Get the compander attack timeconstant.
HPI_ERR	HPI_Compander_SetDecayTimeConstant (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, unsigned int index, HW32 Decay)
	Set the decay timeconstants.
HPI_ERR	HPI_Compander_GetDecayTimeConstant (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, unsigned int index, HW32 *Decay)
	Get the compander attack timeconstant.
HPI_ERR	HPI_Compander_SetThreshold (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, unsigned int index, short nThreshold0_01dB)
	Set the threshold for one of the compander knee points.
HPI_ERR	HPI_Compander_GetThreshold (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, unsigned int index, short *nThreshold0_01dB)
	Get the threshold for one of the compander knee points.
HPI_ERR	HPI_Compander_SetRatio (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 index, HW32 wRatio100)
	Set the ratio for one of the compander knee points.
HPI_ERR	HPI_Compander_GetRatio (const HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 index, HW32 *wRatio100)
	Set the ratio for one of the compander knee points.

---

Detailed Description

The compander multiplies its input signal by a factor that is dependent on the amplitude of that signal.

---

Function Documentation

HPI_ERR HPI_Compander_Set (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW16  wAttack, HW16  wDecay, short  wRatio100, short  nThreshold0_01dB, short  nMakeupGain0_01dB )

Set up a compressor expander. Returns: 0 on success, or one of the HPI_ERROR_CODES. Deprecated: Please use individual HPI_Compander functions instead Parameters: phSubSys  HPI subsystem handle hControl  Compander control handle wAttack  attack time in milliseconds wDecay  decay time in milliseconds wRatio100  gain ratio * 100 nThreshold0_01dB  threshold in 100ths of a dB nMakeupGain0_01dB  makeup gain in 100ths of a dB

HPI_ERR HPI_Compander_Get (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW16 *  pwAttack, HW16 *  pwDecay, short *  pwRatio100, short *  pnThreshold0_01dB, short *  pnMakeupGain0_01dB )

Get the settings of a compressor expander Returns: 0 on success, or one of the HPI_ERROR_CODES. Deprecated: Please use individual HPI_Compander functions instead Parameters: phSubSys  HPI subsystem handle hControl  Compander control handle pwAttack  attack time in milliseconds pwDecay  decay time in milliseconds pwRatio100  gain ratio * 100 pnThreshold0_01dB  threshold in 100ths of a dB pnMakeupGain0_01dB  makeup gain in 100ths of a dB

HPI_ERR HPI_Compander_SetEnable (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW32  Enable )

Enable or disable the compander. Parameters: phSubSys  HPI subsystem handle hControl  Compander control handle Enable  1=enable, 0=disable

HPI_ERR HPI_Compander_GetEnable (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW32 *  Enable )

Get the enable state of the compander. Parameters: phSubSys  HPI subsystem handle hControl  Compander control handle Enable  1=enabled, 0=disabled

HPI_ERR HPI_Compander_SetMakeupGain (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, short  nMakeupGain0_01dB )

Set the makeup gain of a compander control. The makeup gain is applied independent of signal level, usually to compensate for level loss from compression. Parameters: phSubSys  HPI subsystem handle hControl  Compander control handle nMakeupGain0_01dB  makeup gain in 100ths of a dB

HPI_ERR HPI_Compander_GetMakeupGain (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, short *  nMakeupGain0_01dB )

Get the makeup gain of a compander control. Parameters: phSubSys  HPI subsystem handle hControl  Compander control handle nMakeupGain0_01dB  makeup gain in 100ths of a dB

HPI_ERR HPI_Compander_SetAttackTimeConstant (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, unsigned int  index, HW32  wAttack )

Set the attack timeconstants. The attack timeconstant applies to the RMS detector on the compander or noise gate input. Parameters: phSubSys  HPI subsystem handle hControl  Compander control handle index  index of knee point wAttack  attack time in milliseconds

HPI_ERR HPI_Compander_GetAttackTimeConstant (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, unsigned int  index, HW32 *  Attack )

Get the compander attack timeconstant. Parameters: phSubSys  HPI subsystem handle hControl  Compander control handle index  index of knee point Attack  attack time in milliseconds

HPI_ERR HPI_Compander_SetDecayTimeConstant (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, unsigned int  index, HW32  Decay )

Set the decay timeconstants. The decay timeconstant applies to the RMS detector on the compander or noise gate input. Parameters: phSubSys  HPI subsystem handle hControl  Compander control handle index  index of knee point Decay  decay time in milliseconds

HPI_ERR HPI_Compander_GetDecayTimeConstant (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, unsigned int  index, HW32 *  Decay )

Get the compander attack timeconstant. Parameters: phSubSys  HPI subsystem handle hControl  Compander control handle index  index of knee point Decay  decay time in milliseconds

HPI_ERR HPI_Compander_SetThreshold (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, unsigned int  index, short  nThreshold0_01dB )

Set the threshold for one of the compander knee points. When index==0, the ratio is applied below the set threshold, otherwise the ratio is applied above the set threshold and below threshold with higher index (if any). The threshold for index 0 must be less than that for index 1 etc. /retval HPI_ERROR_INVALID_CONTROL_VALUE threshold outside valid range -100 to 0dB /retval HPI_ERROR_INVALID_OPERATION trying to set threshold 0 > threshold 1 Parameters: phSubSys  HPI subsystem handle hControl  Compander control handle index  index of knee point nThreshold0_01dB  threshold in 100ths of a dB

HPI_ERR HPI_Compander_GetThreshold (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, unsigned int  index, short *  nThreshold0_01dB )

Get the threshold for one of the compander knee points. Parameters: phSubSys  HPI subsystem handle hControl  Compander control handle index  index of nThreshold0_01dB  threshold in 100ths of a dB

HPI_ERR HPI_Compander_SetRatio (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW32  index, HW32  wRatio100 )

Set the ratio for one of the compander knee points. The actual ratio R is wRatio100/100.0 if index==0, for every R dB below the threshold, the output decreases by 1dB, else for every R dB above the threshold, the output increases by 1dB Parameters: phSubSys  HPI subsystem handle hControl  Compander control handle index  index of knee point wRatio100  gain ratio * 100

HPI_ERR HPI_Compander_GetRatio (  const HPI_HSUBSYS *  phSubSys, HPI_HCONTROL  hControl, HW32  index, HW32 *  wRatio100 )

Set the ratio for one of the compander knee points. Parameters: phSubSys  HPI subsystem handle hControl  Compander control handle index  index of wRatio100  gain ratio * 100

---