index :: dyn

dyn.comp2~

stereo dynamic range compressor

available since version: 0.1

---

arguments:

• RATIO compression ratio (1 = no compression, >1 means compression)
  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:

• preset choose predefined preset
  parameters:
  • PRESET name
    type: symbol
    required: True
    
• reset reset to initial state
  

properties:

• @ratio Get/set compression ratio (1 = no compression, >1 means compression)
  type: float
  range: 1..16
  default: 1
  

• @threshold Get/set level threshold above which compression kicks in
  type: float
  units: db
  range: -90..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
  

• @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
  

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

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

• @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_comp2/PROP_NAME osc address, if empty bind to /dyn_comp2/PROP_NAME.
  type: symbol
  

inlets:

• left input signal
  type: audio
• right input signal
  type: audio

outlets:

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

keywords:

compressor

See also: [dyn.comp~]

Authors: Alex Nadzharov, Serge Poltavsky

License: GPL3 or later