index :: dyn

dyn.comp_peak~

aliases: [comp.peak~]

mono dynamic range peak feed forward compressor

available since version: 0.9.7

---

information

It uses a strength parameter instead of the traditional ratio, in order to be able to function as a hard limiter or overcompressor

arguments:

• STRENGTH compression strength (0: no compression, 1: hard limiting, >1: overcompression)
  type: float
  

• THRESHOLD level threshold above which compression kicks in
  type: float
  units: db
  

• ATTACK attack time = time constant when level & compression going up
  type: float
  units: ms
  

• RELEASE release time = time constant coming out of compression
  type: float
  units: ms
  

methods:

• reset reset to initial state
  

properties:

• @strength Get/set compression ratio (0: no compression, 1: hard limiting, >1: overcompression)
  type: float
  range: 0..2
  default: 0
  

• @threshold Get/set level threshold above which compression kicks in (100 dB = max level)
  type: float
  units: db
  range: -60..0
  default: -10
  

• @attack Get/set time constant when level & compression going up
  type: float
  units: ms
  range: 0.1..100
  default: 10
  

• @release Get/set release time = time constant coming out of compression
  type: float
  units: ms
  range: 1..500
  default: 50
  

• @gain Get/set make up gain: applied to the signal after the compression takes place
  type: float
  units: db
  range: -18..18
  default: 0
  

• @knee Get/set a gradual increase in gain reduction around the threshold: below thresh-(knee/2) there is no gain reduction, above thresh+(knee/2) there is the same gain reduction as without a knee, and in between there is a gradual increase in gain reduction
  type: float
  units: db
  range: 0..24
  default: 3
  

• @bypass Get/set bypass flag. If true: bypass 'effected' signal.
  type: bool
  default: 0
  

• @level (readonly) Get current level of compression
  type: float
  range: 0..1
  default: 0
  

• @refresh Get/set compression level output time interval. If 0 - no output
  type: int
  units: ms
  range: 0..1000
  default: 100
  

• @active Get/set on/off dsp processing
  type: bool
  default: 1
  

• @osc (initonly) Get/set OSC server name to listen
  type: symbol
  

• @id (initonly) Get/set OSC address id. If specified, bind all properties to /ID/dyn_comp_peak/PROP_NAME osc address, if empty bind to /dyn_comp_peak/PROP_NAME.
  type: symbol
  

inlets:

• input signal
  type: audio
• set compression strength
  type: control

outlets:

• output compressed signal
  type: audio
• float: output current compression level in [0..1]
  type: control

keywords:

compressor

See also: [dyn.comp_peak2~]

Authors: Serge Poltavsky

License: GPL3 or later