Note

This section shows how the documentation for components will look like in the future. The content is encoded in docstrings in the Python files of the class definitions for Python components, and in the Pythin bindings in case of C++ components. The documentation is extracted and formatted using sphinx.autodoc.

Module overview

VISR default component library.

At the moment, this module contains atomic components (whereas the composite ones are in signalflows) for historic reasons. In the future, however, this will change do a topical orgainisation.

Class rcl.Add

class rcl.Add(self: rcl.Add, context: visr.SignalFlowContext, name: str, parent: visr.CompositeComponent=None, width: int, numInputs: int) → None

Component for adding multichannel multichannel audio signals.

input_<i>”
Audio input signals to be added, numbered from 0..`numInputs`-1. The width is determined by the constructor parameter width.”
output
Multichannel audio output signal, width determined by paramter width.

Constructor, creates an instance of Add.

Parameters:
  • context (visr.SignalFlowContext) – Common audio processing parameters (e.g., sampling rate and block size)
  • name (string) – Name of the component.
  • parent (visr.CompositeComponent or None) – The composite component that contains the present object, or None for a top-level component.
  • numInputs (int) – The number of input ports (addends)
process(self: rcl.Add) → None

Class rcl.BiquadIirFilter

class rcl.BiquadIirFilter(*args, **kwargs)

Multichannel IIR filtering component based on second-order IIR sections (biquads).

Audio ports:
input: Multichannel audio signal, the witdth is determined by the constructor parameter numberOfChannels. output: Multichannel output signal, width is determined by the constructor parameter numberOfChannels.
Parameter ports:
eqInput: Optional parameter input port for receiving updated EQ settings of type pml.BiquadMatrixParameterFloat.
This port is activated by the constructor parameter controlInputs (default: True)

Overloaded function.

  1. __init__(self: rcl.BiquadIirFilter, context: visr.SignalFlowContext, name: str, parent: visr.CompositeComponent, numberOfChannels: int, numberOfBiquads: int, controlInput: bool=True) -> None

Constructor that initialises all biquad IIR sections the default value (flat EQ).

Parameters:
  • context – (visr.SignalFlowContext) Common audio processing parameters (e.g., sampling rate and block size)
  • name – (string) Name of the component.
  • parent – (visr.CompositeComponent or None) The composite component that contains the present object, or None in case of a top-level component.
  • numberOfChannels – (int) The number of individual audio channels processed.
  • numberOfBiquads – (int) The number of second-order sections processed per channels.
  1. __init__(self: rcl.BiquadIirFilter, context: visr.SignalFlowContext, name: str, parent: visr.CompositeComponent, numberOfChannels: int, numberOfBiquads: int, initialBiquad: rbbl.BiquadCoefficientFloat, controlInput: bool=True) -> None

Constructor initialising all biquad IIR sections to the same given value.

  1. __init__(self: rcl.BiquadIirFilter, context: visr.SignalFlowContext, name: str, parent: visr.CompositeComponent, numberOfChannels: int, numberOfBiquads: int, initialBiquads: rbbl.BiquadCoefficientListFloat, controlInput: bool=True) -> None

Constructor initialising all channels to the same sequence of biquad IIR sections

  1. __init__(self: rcl.BiquadIirFilter, context: visr.SignalFlowContext, name: str, parent: visr.CompositeComponent, numberOfChannels: int, numberOfBiquads: int, initialBiquads: rbbl.BiquadCoefficientMatrixFloat, controlInput: bool=True) -> None

Constructor initialising the biquad IIR sections to individual values.

Class rcl.DelayMatrix

class rcl.DelayMatrix(*args, **kwargs)

Overloaded function.

  1. __init__(self: rcl.DelayMatrix, context: visr.SignalFlowContext, name: str, parent: visr.CompositeComponent=None) -> None
  2. __init__(self: rcl.DelayMatrix, context: visr.SignalFlowContext, name: str, parent: visr.CompositeComponent=None, numberOfInputs: int, numberOfOutputs: int, interpolationSteps: int=1024, maxDelay: float=3.0, interpolationType: str, methodDelayPolicy: rcl.DelayMatrix.MethodDelayPolicy=MethodDelayPolicy.Add, controlInputs: rcl.DelayMatrix.ControlPortConfig=ControlPortConfig.No, initialDelay: float=0.0, initialGain: float=1.0) -> None
  3. __init__(self: rcl.DelayMatrix, context: visr.SignalFlowContext, name: str, parent: visr.CompositeComponent=None, numberOfInputs: int, numberOfOutputs: int, interpolationSteps: int=1024, maxDelay: float=3.0, interpolationType: str, methodDelayPolicy: rcl.DelayMatrix.MethodDelayPolicy=MethodDelayPolicy.Add, controlInputs: rcl.DelayMatrix.ControlPortConfig=ControlPortConfig.No, initialDelay: efl.BasicMatrixFloat=0.0, initialGain: efl.BasicMatrixFloat=1.0) -> None
setup(*args, **kwargs)

Overloaded function.

  1. setup(self: rcl.DelayMatrix, numberOfInputs: int, numberOfOutputs: int, interpolationSteps: int=1024, maxDelay: float=3.0, interpolationType: str, methodDelayPolicy: rcl.DelayMatrix.MethodDelayPolicy=MethodDelayPolicy.Add, controlInputs: rcl.DelayMatrix.ControlPortConfig=ControlPortConfig.No, initialDelay: float=0.0, initialGain: float=1.0) -> None
  2. setup(self: rcl.DelayMatrix, numberOfInputs: int, numberOfOutputs: int, interpolationSteps: int=1024, maxDelay: float=3.0, interpolationType: str, methodDelayPolicy: rcl.DelayMatrix.MethodDelayPolicy=MethodDelayPolicy.Add, controlInputs: rcl.DelayMatrix.ControlPortConfig=ControlPortConfig.No, initialDelays: efl.BasicMatrixFloat, initialGains: efl.BasicMatrixFloat) -> None

Class rcl.DelayVector

class rcl.DelayVector(*args, **kwargs)

Overloaded function.

  1. __init__(self: rcl.DelayVector, context: visr.SignalFlowContext, name: str, parent: visr.CompositeComponent=None) -> None
  2. __init__(self: rcl.DelayVector, context: visr.SignalFlowContext, name: str, parent: visr.CompositeComponent, numberOfChannels: int, interpolationSteps: int=1024, maxDelay: float=3.0, interpolationType: str, methodDelayPolicy: rcl.DelayMatrix.MethodDelayPolicy=MethodDelayPolicy.Add, controlInputs: rcl.DelayVector.ControlPortConfig=ControlPortConfig.No, initialDelay: float=0.0, initialGain: float=1.0) -> None
  3. __init__(self: rcl.DelayVector, context: visr.SignalFlowContext, name: str, parent: visr.CompositeComponent, numberOfChannels: int, interpolationSteps: int=1024, maxDelay: float=3.0, interpolationType: str=’lagrangeOrder3’, methodDelayPolicy: rcl.DelayMatrix.MethodDelayPolicy=MethodDelayPolicy.Add, controlInputs: rcl.DelayVector.ControlPortConfig=ControlPortConfig.No, initialDelay: efl.BasicVectorFloat=<pml.VectorParameterFloat object at 0x61376e2d0>, initialGain: efl.BasicVectorFloat=<pml.VectorParameterFloat object at 0x61376e308>) -> None
  4. __init__(self: rcl.DelayVector, context: visr.SignalFlowContext, name: str, parent: visr.CompositeComponent, numberOfChannels: int, interpolationSteps: int=1024, maxDelay: float=3.0, interpolationType: str=’lagrangeOrder3’, methodDelayPolicy: rcl.DelayMatrix.MethodDelayPolicy=MethodDelayPolicy.Add, controlInputs: rcl.DelayVector.ControlPortConfig=ControlPortConfig.No, initialDelay: numpy.ndarray[float32], initialGain: numpy.ndarray[float32]) -> None

Constructor taking Python lists or NumPy arrays as initial gain and delay values.

  1. __init__(self: rcl.DelayVector, context: visr.SignalFlowContext, name: str, parent: visr.CompositeComponent, numberOfChannels: int, interpolationSteps: int=1024, maxDelay: float=3.0, interpolationType: str=’lagrangeOrder3’, methodDelayPolicy: rcl.DelayMatrix.MethodDelayPolicy=MethodDelayPolicy.Add, controlInputs: rcl.DelayVector.ControlPortConfig=ControlPortConfig.No, initialDelay: List[float], initialGain: List[float]) -> None

Constructor taking Python lists or NumPy arrays as initial gain and delay values.

setup(self: rcl.DelayVector, numberOfChannels: int, interpolationSteps: int=1024, maxDelay: float=3.0, interpolationType: str, methodDelayPolicy: rcl.DelayMatrix.MethodDelayPolicy=MethodDelayPolicy.Add, controlInputs: rcl.DelayVector.ControlPortConfig=ControlPortConfig.No, initialDelay: float=0.0, initialGain: float=1.0) → None