Filters¶

Different kinds of audio filtering operations.

An audio filter is designed to amplify, pass or attenuate (negative amplification) some frequency ranges. Common types include low-pass, which pass through frequencies below their cutoff frequencies, and progressively attenuates frequencies above the cutoff frequency. A high-pass filter does the opposite, passing high frequencies above the cutoff frequency, and progressively attenuating frequencies below the cutoff frequency. A bandpass filter passes frequencies between its two cutoff frequencies, while attenuating those outside the range. A band-reject filter, attenuates frequencies between its two cutoff frequencies, while passing those outside the ‘reject’ range.

An all-pass filter, passes all frequencies, but affects the phase of any given sinusoidal component according to its frequency.

Objects in this category¶

Biquad : A sweepable general purpose biquadratic digital filter.
Biquadx : A multi-stages sweepable general purpose biquadratic digital filter.
Biquada : A general purpose biquadratic digital filter (floating-point arguments).
EQ : Equalizer filter.
Tone : A first-order recursive low-pass filter with variable frequency response.
Atone : A first-order recursive high-pass filter with variable frequency response.
Port : Exponential portamento.
DCBlock : Implements the DC blocking filter.
BandSplit : Splits an input signal into multiple frequency bands.
FourBand : Splits an input signal into four frequency bands.
MultiBand : Splits an input signal into multiple frequency bands.
Hilbert : Hilbert transform.
Allpass : Delay line based allpass filter.
Allpass2 : Second-order phase shifter allpass.
Phaser : Multi-stages second-order phase shifter allpass filters.
Vocoder : Applies the spectral envelope of a first sound to the spectrum of a second sound.
IRWinSinc : Windowed-sinc filter using circular convolution.
IRAverage : Moving average filter using circular convolution.
IRPulse : Comb-like filter using circular convolution.
IRFM : Filters a signal with a frequency modulation spectrum using circular convolution.
SVF : Fourth-order state variable filter allowing continuous change of the filter type.
SVF2 : Second-order state variable filter allowing continuous change of the filter type.
Average : Moving average filter.
Reson : A second-order resonant bandpass filter.
Resonx : A multi-stages second-order resonant bandpass filter.
ButLP : A second-order Butterworth lowpass filter.
ButHP : A second-order Butterworth highpass filter.
ButBP : A second-order Butterworth bandpass filter.
ButBR : A second-order Butterworth band-reject filter.
ComplexRes : Complex one-pole resonator filter.
MoogLP : A fourth-order resonant lowpass filter.

Biquad¶

class Biquad(input, freq=1000, q=1, type=0, mul=1, add=0)[source]¶

A sweepable general purpose biquadratic digital filter.

Parent

PyoObject

Args

input: PyoObject

Input signal to process.

freq: float or PyoObject, optional

Cutoff or center frequency of the filter. Defaults to 1000.

q: float or PyoObject, optional

Q of the filter, defined (for bandpass filters) as freq/bandwidth. Should be between 1 and 500. Defaults to 1.

type: int, optional

Filter type. Five possible values :

lowpass (default)
highpass
bandpass
bandstop
allpass

>>> s = Server().boot()
>>> s.start()
>>> a = Noise(mul=.7)
>>> lfo = Sine(freq=[.2, .25], mul=1000, add=1500)
>>> f = Biquad(a, freq=lfo, q=5, type=2).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.
`q`	float or PyoObject.
`type`	int.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, q, type, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setQ`(x)	Replace the q attribute.
`setType`(x)	Replace the type attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

setQ(x)[source]¶

Replace the q attribute. Should be between 1 and 500.

Args

x: float or PyoObject: New q attribute.

setType(x)[source]¶

Replace the type attribute.

Args

x: int

New type attribute.: 0.lowpass 1. highpass 2. bandpass 3. bandstop 4. allpass

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Cutoff or center frequency of the filter.

property q¶: float or PyoObject. Q of the filter.

property type¶: int. Filter type.

Biquadx¶

class Biquadx(input, freq=1000, q=1, type=0, stages=4, mul=1, add=0)[source]¶

A multi-stages sweepable general purpose biquadratic digital filter.

Biquadx is equivalent to a filter consisting of more layers of Biquad with the same arguments, serially connected. It is faster than using a large number of instances of the Biquad object, It uses less memory and allows filters with sharper cutoff.

Parent

PyoObject

Args

input: PyoObject

Input signal to process.

freq: float or PyoObject, optional

Cutoff or center frequency of the filter. Defaults to 1000.

q: float or PyoObject, optional

Q of the filter, defined (for bandpass filters) as freq/bandwidth. Should be between 1 and 500. Defaults to 1.

type: int, optional

Filter type. Five possible values :

lowpass (default)
highpass
bandpass
bandstop
allpass

stages: int, optional

The number of filtering stages in the filter stack. Defaults to 4.

>>> s = Server().boot()
>>> s.start()
>>> a = Noise(mul=.7)
>>> lfo = Sine(freq=[.2, .25], mul=1000, add=1500)
>>> f = Biquadx(a, freq=lfo, q=5, type=2).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.
`q`	float or PyoObject.
`type`	int.
`stages`	int.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, q, type, stages, ...])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setQ`(x)	Replace the q attribute.
`setType`(x)	Replace the type attribute.
`setStages`(x)	Replace the stages attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

setQ(x)[source]¶

Replace the q attribute. Should be between 1 and 500.

Args

x: float or PyoObject: New q attribute.

setType(x)[source]¶

Replace the type attribute.

Args

x: int: New type attribute. 0. lowpass 1. highpass 2. bandpass 3. bandstop 4. allpass

setStages(x)[source]¶

Replace the stages attribute.

Args

x: int: New stages attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Cutoff or center frequency of the filter.

property q¶: float or PyoObject. Q of the filter.

property type¶: int. Filter type.

property stages¶: int. The number of filtering stages.

Biquada¶

class Biquada(input, b0=0.005066, b1=0.010132, b2=0.005066, a0=1.070997, a1=-1.979735, a2=0.929003, mul=1, add=0)[source]¶

A general purpose biquadratic digital filter (floating-point arguments).

A digital biquad filter is a second-order recursive linear filter, containing two poles and two zeros. Biquada is a “Direct Form 1” implementation of a Biquad filter:

y[n] = ( b0*x[n] + b1*x[n-1] + b2*x[n-2] - a1*y[n-1] - a2*y[n-2] ) / a0

This object is directly controlled via the six coefficients, as floating-point values or audio stream, of the filter. There is no clipping of the values given as coefficients, so, unless you know what you do, it is recommended to use the Biquad object, which is controlled with frequency, Q and type arguments.

The default values of the object give a lowpass filter with a 1000 Hz cutoff frequency.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
b0: float or PyoObject, optional: Amplitude of the current sample. Defaults to 0.005066.
b1: float or PyoObject, optional: Amplitude of the first input sample delayed. Defaults to 0.010132.
b2: float or PyoObject, optional: Amplitude of the second input sample delayed. Defaults to 0.005066.
a0: float or PyoObject, optional: Overall gain coefficient. Defaults to 1.070997.
a1: float or PyoObject, optional: Amplitude of the first output sample delayed. Defaults to -1.979735.
a2: float or PyoObject, optional: Amplitude of the second output sample delayed. Defaults to 0.929003.

>>> s = Server().boot()
>>> s.start()
>>> a = Noise(mul=.7)
>>> lf = Sine([1.5, 2], mul=.07, add=-1.9)
>>> f = Biquada(a, 0.005066, 0.010132, 0.005066, 1.070997, lf, 0.929003).out()

Public Data Attributes:

`input`	PyoObject.
`b0`	float or PyoObject.
`b1`	float or PyoObject.
`b2`	float or PyoObject.
`a0`	float or PyoObject.
`a1`	float or PyoObject.
`a2`	float or PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, b0, b1, b2, a0, a1, a2, ...])
`setInput`(x[, fadetime])	Replace the input attribute.
`setB0`(x)	Replace the b0 attribute.
`setB1`(x)	Replace the b1 attribute.
`setB2`(x)	Replace the b2 attribute.
`setA0`(x)	Replace the a0 attribute.
`setA1`(x)	Replace the a1 attribute.
`setA2`(x)	Replace the a2 attribute.
`setCoeffs`(args, *kwds)	Replace all filter coefficients.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setB0(x)[source]¶

Replace the b0 attribute.

Args

x: float or PyoObject: New b0 attribute.

setB1(x)[source]¶

Replace the b1 attribute.

Args

x: float or PyoObject: New b1 attribute.

setB2(x)[source]¶

Replace the b2 attribute.

Args

x: float or PyoObject: New b2 attribute.

setA0(x)[source]¶

Replace the a0 attribute.

Args

x: float or PyoObject: New a0 attribute.

setA1(x)[source]¶

Replace the a1 attribute.

Args

x: float or PyoObject: New a1 attribute.

setA2(x)[source]¶

Replace the a2 attribute.

Args

x: float or PyoObject: New a2 attribute.

setCoeffs(*args, **kwds)[source]¶

Replace all filter coefficients.

Args

b0: float or PyoObject, optional: New b0 attribute.
b1: float or PyoObject, optional: New b1 attribute.
b2: float or PyoObject, optional: New b2 attribute.
a0: float or PyoObject, optional: New a0 attribute.
a1: float or PyoObject, optional: New a1 attribute.
a2: float or PyoObject, optional: New a2 attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property b0¶: float or PyoObject. b0 coefficient.

property b1¶: float or PyoObject. b1 coefficient.

property b2¶: float or PyoObject. b2 coefficient.

property a0¶: float or PyoObject. a0 coefficient.

property a1¶: float or PyoObject. a1 coefficient.

property a2¶: float or PyoObject. a2 coefficient.

EQ¶

class EQ(input, freq=1000, q=1, boost=-3.0, type=0, mul=1, add=0)[source]¶

Equalizer filter.

EQ is a biquadratic digital filter designed for equalization. It provides peak/notch and lowshelf/highshelf filters for building parametric equalizers.

Parent

PyoObject

Args

input: PyoObject

Input signal to process.

freq: float or PyoObject, optional

Cutoff or center frequency of the filter. Defaults to 1000.

q: float or PyoObject, optional

Q of the filter, defined as freq/bandwidth. Should be between 1 and 500. Defaults to 1.

boost: float or PyoObject, optional

Gain, expressed in dB, to add or remove at the center frequency. Default to -3.

type: int, optional

Filter type. Three possible values :

peak/notch (default)
lowshelf
highshelf

>>> s = Server().boot()
>>> s.start()
>>> amp = Fader(1, 1, mul=.15).play()
>>> src = PinkNoise(amp)
>>> fr = Sine(.2, 0, 500, 1500)
>>> boo = Sine([4, 4], 0, 6)
>>> out = EQ(src, freq=fr, q=1, boost=boo, type=0).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.
`q`	float or PyoObject.
`boost`	float or PyoObject.
`type`	int.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, q, boost, type, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setQ`(x)	Replace the q attribute.
`setBoost`(x)	Replace the boost attribute, expressed in dB.
`setType`(x)	Replace the type attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

setQ(x)[source]¶

Replace the q attribute. Should be between 1 and 500.

Args

x: float or PyoObject: New q attribute.

setBoost(x)[source]¶

Replace the boost attribute, expressed in dB.

Args

x: float or PyoObject: New boost attribute.

setType(x)[source]¶

Replace the type attribute.

Args

x: int: New type attribute. 0. peak 1. lowshelf 2. highshelf

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Cutoff or center frequency of the filter.

property q¶: float or PyoObject. Q of the filter.

property boost¶: float or PyoObject. Boost factor of the filter.

property type¶: int. Filter type.

Tone¶

class Tone(input, freq=1000, mul=1, add=0)[source]¶

A first-order recursive low-pass filter with variable frequency response.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
freq: float or PyoObject, optional: Cutoff frequency of the filter in hertz. Default to 1000.

>>> s = Server().boot()
>>> s.start()
>>> n = Noise(.3)
>>> lf = Sine(freq=.2, mul=800, add=1000)
>>> f = Tone(n, lf).mix(2).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Default to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Cutoff frequency of the filter.

Atone¶

class Atone(input, freq=1000, mul=1, add=0)[source]¶

A first-order recursive high-pass filter with variable frequency response.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
freq: float or PyoObject, optional: Cutoff frequency of the filter in hertz. Default to 1000.

>>> s = Server().boot()
>>> s.start()
>>> n = Noise(.3)
>>> lf = Sine(freq=.2, mul=5000, add=6000)
>>> f = Atone(n, lf).mix(2).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Default to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Cutoff frequency of the filter.

Port¶

class Port(input, risetime=0.05, falltime=0.05, init=0, mul=1, add=0)[source]¶

Exponential portamento.

Perform an exponential portamento on an audio signal with different rising and falling times.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
risetime: float or PyoObject, optional: Time to reach upward value in seconds. Defaults to 0.05.
falltime: float or PyoObject, optional: Time to reach downward value in seconds. Defaults to 0.05.
init: float, optional: Initial state of the internal memory. Available at intialization time only. Defaults to 0.

>>> s = Server().boot()
>>> s.start()
>>> from random import uniform
>>> x = Sig(value=500)
>>> p = Port(x, risetime=.1, falltime=1)
>>> a = Sine(freq=[p, p*1.01], mul=.2).out()
>>> def new_freq():
...     x.value = uniform(400, 800)
>>> pat = Pattern(function=new_freq, time=1).play()

Public Data Attributes:

`input`	PyoObject.
`risetime`	float or PyoObject.
`falltime`	float or PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, risetime, falltime, init, ...])
`setInput`(x[, fadetime])	Replace the input attribute.
`setRiseTime`(x)	Replace the risetime attribute.
`setFallTime`(x)	Replace the falltime attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setRiseTime(x)[source]¶

Replace the risetime attribute.

Args

x: float or PyoObject: New risetime attribute.

setFallTime(x)[source]¶

Replace the falltime attribute.

Args

x: float or PyoObject: New falltime attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property risetime¶: float or PyoObject. Time to reach upward value in seconds.

property falltime¶: float or PyoObject. Time to reach downward value in seconds.

DCBlock¶

class DCBlock(input, mul=1, add=0)[source]¶

Implements the DC blocking filter.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.

>>> s = Server().boot()
>>> s.start()
>>> n = Noise(.01)
>>> w = Delay(n, delay=[0.02, 0.01], feedback=.995, mul=.5)
>>> f = DCBlock(w).out()

Public Data Attributes:

input

PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Default to 0.05.

property input¶: PyoObject. Input signal to process.

BandSplit¶

class BandSplit(input, num=6, min=20, max=20000, q=1, mul=1, add=0)[source]¶

Splits an input signal into multiple frequency bands.

The input signal will be separated into num bands between min and max frequencies using second-order bandpass filters. Each band will then be assigned to an independent audio stream. Useful for multiband processing.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
num: int, optional: Number of frequency bands created. Available at initialization time only. Defaults to 6.
min: float, optional: Lowest frequency. Available at initialization time only. Defaults to 20.
max: float, optional: Highest frequency. Available at initialization time only. Defaults to 20000.
q: float or PyoObject, optional: Q of the filters, defined as center frequency / bandwidth. Should be between 1 and 500. Defaults to 1.

FourBand¶

class FourBand(input, freq1=150, freq2=500, freq3=2000, mul=1, add=0)[source]¶

Splits an input signal into four frequency bands.

The input signal will be separated into 4 bands around freqs arguments using fourth-order Linkwitz-Riley lowpass and highpass filters. Each band will then be assigned to an independent audio stream. The sum of the four bands reproduces the same signal as the input. Useful for multiband processing.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
freq1: float or PyoObject, optional: First crossover frequency. First band will contain signal from 0 Hz to freq1 Hz. Defaults to 150.
freq2: float or PyoObject, optional: Second crossover frequency. Second band will contain signal from freq1 Hz to freq2. freq2 is the lower limit of the third band signal. Defaults to 500.
freq3: float or PyoObject, optional: Third crossover frequency. It’s the upper limit of the third band signal and fourth band will contain signal from freq3 to sr/2. Defaults to 2000.

MultiBand¶

class MultiBand(input, num=8, mul=1, add=0)[source]¶

Splits an input signal into multiple frequency bands.

The input signal will be separated into num logarithmically spaced frequency bands using fourth-order Linkwitz-Riley lowpass and highpass filters. Each band will then be assigned to an independent audio stream. The sum of all bands reproduces the same signal as the input. Useful for multiband processing.

User-defined frequencies can be assigned with the setFrequencies() method.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
num: int, optional: Number of frequency bands created, between 2 and 16. Available at initialization time only. Defaults to 8.

Hilbert¶

class Hilbert(input, mul=1, add=0)[source]¶

Hilbert transform.

Hilbert is an IIR filter based implementation of a broad-band 90 degree phase difference network. The outputs of hilbert have an identical frequency response to the input (i.e. they sound the same), but the two outputs have a constant phase difference of 90 degrees, plus or minus some small amount of error, throughout the entire frequency range. The outputs are in quadrature.

Hilbert is useful in the implementation of many digital signal processing techniques that require a signal in phase quadrature. The real part corresponds to the cosine output of hilbert, while the imaginary part corresponds to the sine output. The two outputs have a constant phase difference throughout the audio range that corresponds to the phase relationship between cosine and sine waves.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.

Note

Real and imaginary parts are two separated set of streams. The user should call :

Hilbert[‘real’] to retrieve the real part.

Hilbert[‘imag’] to retrieve the imaginary part.

>>> s = Server().boot()
>>> s.start()
>>> a = SfPlayer(SNDS_PATH + "/accord.aif", loop=True, mul=0.5).out(0)
>>> b = Hilbert(a)
>>> quad = Sine([250, 500], [0, .25])
>>> mod1 = b['real'] * quad[0]
>>> mod2 = b['imag'] * quad[1]
>>> up = (mod1 - mod2) * 0.7
>>> down = mod1 + mod2
>>> up.out(1)

Public Data Attributes:

input

PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, mul, add])
`__getitem__`(str)
`get`([identifier, all])	Return the first sample of the current buffer as a float.
`setInput`(x[, fadetime])	Replace the input attribute.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

get(identifier='real', all=False)[source]¶

Return the first sample of the current buffer as a float.

Can be used to convert audio stream to usable Python data.

“real” or “imag” must be given to identifier to specify which stream to get value from.

Args

identifier: string {“real”, “imag”}: Address string parameter identifying audio stream. Defaults to “real”.
all: boolean, optional: If True, the first value of each object’s stream will be returned as a list. Otherwise, only the value of the first object’s stream will be returned as a float. Defaults to False.

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Default to 0.05.

property input¶: PyoObject. Input signal to process.

Allpass¶

class Allpass(input, delay=0.01, feedback=0, maxdelay=1, mul=1, add=0)[source]¶

Delay line based allpass filter.

Allpass is based on the combination of feedforward and feedback comb filter. This kind of filter is often used in simple digital reverb implementations.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
delay: float or PyoObject, optional: Delay time in seconds. Defaults to 0.01.
feedback: float or PyoObject, optional: Amount of output signal sent back into the delay line. Defaults to 0.
maxdelay: float, optional: Maximum delay length in seconds. Available only at initialization. Defaults to 1.

>>> # SIMPLE REVERB
>>> s = Server().boot()
>>> s.start()
>>> a = SfPlayer(SNDS_PATH + "/transparent.aif", loop=True, mul=0.25).mix(2).out()
>>> b1 = Allpass(a, delay=[.0204,.02011], feedback=0.25)
>>> b2 = Allpass(b1, delay=[.06653,.06641], feedback=0.31)
>>> b3 = Allpass(b2, delay=[.035007,.03504], feedback=0.4)
>>> b4 = Allpass(b3, delay=[.023021 ,.022987], feedback=0.55)
>>> c1 = Tone(b1, 5000, mul=0.2).out()
>>> c2 = Tone(b2, 3000, mul=0.2).out()
>>> c3 = Tone(b3, 1500, mul=0.2).out()
>>> c4 = Tone(b4, 500, mul=0.2).out()

Public Data Attributes:

`input`	PyoObject.
`delay`	float or PyoObject.
`feedback`	float or PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, delay, feedback, maxdelay, ...])
`setInput`(x[, fadetime])	Replace the input attribute.
`setDelay`(x)	Replace the delay attribute.
`setFeedback`(x)	Replace the feedback attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setDelay(x)[source]¶

Replace the delay attribute.

Args

x: float or PyoObject: New delay attribute.

setFeedback(x)[source]¶

Replace the feedback attribute.

Args

x: float or PyoObject: New feedback attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property delay¶: float or PyoObject. Delay time in seconds.

property feedback¶: float or PyoObject. Amount of output signal sent back into the delay line.

Allpass2¶

class Allpass2(input, freq=1000, bw=100, mul=1, add=0)[source]¶

Second-order phase shifter allpass.

This kind of filter is used in phaser implementation. The signal of this filter, when added to original sound, creates a notch in the spectrum at frequencies that are in phase opposition.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
freq: float or PyoObject, optional: Center frequency of the filter. Defaults to 1000.
bw: float or PyoObject, optional: Bandwidth of the filter in Hertz. Defaults to 100.

>>> s = Server().boot()
>>> s.start()
>>> # 3 STAGES PHASER
>>> a = BrownNoise(.025).mix(2).out()
>>> blfo = Sine(freq=.1, mul=250, add=500)
>>> b = Allpass2(a, freq=blfo, bw=125).out()
>>> clfo = Sine(freq=.14, mul=500, add=1000)
>>> c = Allpass2(b, freq=clfo, bw=350).out()
>>> dlfo = Sine(freq=.17, mul=1000, add=2500)
>>> d = Allpass2(c, freq=dlfo, bw=800).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.
`bw`	float or PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, bw, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setBw`(x)	Replace the bw attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

setBw(x)[source]¶

Replace the bw attribute.

Args

x: float or PyoObject: New bw attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to filter.

property freq¶: float or PyoObject. Center frequency of the filter.

property bw¶: float or PyoObject. Bandwidth of the filter.

Phaser¶

class Phaser(input, freq=1000, spread=1.1, q=10, feedback=0, num=8, mul=1, add=0)[source]¶

Multi-stages second-order phase shifter allpass filters.

Phaser implements num number of second-order allpass filters.

Parent

PyoObject

Args

input: PyoObject

Input signal to process.

freq: float or PyoObject, optional

Center frequency of the first notch. Defaults to 1000.

spread: float or PyoObject, optional

Spreading factor for upper notch frequencies. Defaults to 1.1.

q: float or PyoObject, optional

Q of the filter as center frequency / bandwidth. Defaults to 10.

feedback: float or PyoObject, optional

Amount of output signal which is fed back into the input of the allpass chain. Defaults to 0.

num: int, optional

The number of allpass stages in series. Defines the number of notches in the spectrum. Defaults to 8.

Available at initialization only.

>>> s = Server().boot()
>>> s.start()
>>> fade = Fader(fadein=.1, mul=.07).play()
>>> a = Noise(fade).mix(2).out()
>>> lf1 = Sine(freq=[.1, .15], mul=100, add=250)
>>> lf2 = Sine(freq=[.18, .15], mul=.4, add=1.5)
>>> b = Phaser(a, freq=lf1, spread=lf2, q=1, num=20, mul=.5).out(0)

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.
`spread`	float or PyoObject.
`q`	float or PyoObject.
`feedback`	float or PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, spread, q, feedback, ...])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setSpread`(x)	Replace the spread attribute.
`setQ`(x)	Replace the q attribute.
`setFeedback`(x)	Replace the feedback attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

setSpread(x)[source]¶

Replace the spread attribute.

Args

x: float or PyoObject: New spread attribute.

setQ(x)[source]¶

Replace the q attribute.

Args

x: float or PyoObject: New q attribute.

setFeedback(x)[source]¶

Replace the feedback attribute.

Args

x: float or PyoObject: New feedback attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Center frequency of the first notch.

property spread¶: float or PyoObject. Spreading factor for upper notch frequencies.

property q¶: float or PyoObject. Q factor of the filter.

property feedback¶: float or PyoObject. Feedback factor of the filter.

Vocoder¶

class Vocoder(input, input2, freq=60, spread=1.25, q=20, slope=0.5, stages=24, mul=1, add=0)[source]¶

Applies the spectral envelope of a first sound to the spectrum of a second sound.

The vocoder is an analysis/synthesis system, historically used to reproduce human speech. In the encoder, the first input (spectral envelope) is passed through a multiband filter, each band is passed through an envelope follower, and the control signals from the envelope followers are communicated to the decoder. The decoder applies these (amplitude) control signals to corresponding filters modifying the second source (exciter).

Parent

PyoObject

Args

input: PyoObject: Spectral envelope. Gives the spectral properties of the bank of filters. For best results, this signal must have a dynamic spectrum, both for amplitudes and frequencies.
input2: PyoObject: Exciter. Spectrum to filter. For best results, this signal must have a broadband spectrum with few amplitude variations.
freq: float or PyoObject, optional: Center frequency of the first band. This is the base frequency used to compute the upper bands. Defaults to 60.
spread: float or PyoObject, optional: Spreading factor for upper band frequencies. Each band is freq * pow(order, spread), where order is the harmonic rank of the band. Defaults to 1.25.
q: float or PyoObject, optional: Q of the filters as center frequency / bandwidth. Higher values imply more resonance around the center frequency. Defaults to 20.
slope: float or PyoObject, optional: Time response of the envelope follower. Lower values mean smoother changes, while higher values mean a better time accuracy. Defaults to 0.5.
stages: int, optional: The number of bands in the filter bank. Defines the number of notches in the spectrum. Defaults to 24.

Note

Altough parameters can be audio signals, values are sampled only four times per buffer size. To avoid artefacts, it is recommended to keep variations at low rate (< 20 Hz).

>>> s = Server().boot()
>>> s.start()
>>> sf = SfPlayer(SNDS_PATH+'/transparent.aif', loop=True)
>>> ex = BrownNoise(0.5)
>>> voc = Vocoder(sf, ex, freq=80, spread=1.2, q=20, slope=0.5)
>>> out = voc.mix(2).out()

Public Data Attributes:

`input`	PyoObject.
`input2`	PyoObject.
`freq`	float or PyoObject.
`spread`	float or PyoObject.
`q`	float or PyoObject.
`slope`	float or PyoObject.
`stages`	int.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input, input2[, freq, spread, q, ...])
`setInput`(x[, fadetime])	Replace the input attribute.
`setInput2`(x[, fadetime])	Replace the input2 attribute.
`setFreq`(x)	Replace the freq attribute.
`setSpread`(x)	Replace the spread attribute.
`setQ`(x)	Replace the q attribute.
`setSlope`(x)	Replace the slope attribute.
`setStages`(x)	Replace the stages attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: The spectral envelope.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setInput2(x, fadetime=0.05)[source]¶

Replace the input2 attribute.

Args

x: PyoObject: The exciter.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

setSpread(x)[source]¶

Replace the spread attribute.

Args

x: float or PyoObject: New spread attribute.

setQ(x)[source]¶

Replace the q attribute.

Args

x: float or PyoObject: New q attribute.

setSlope(x)[source]¶

Replace the slope attribute.

Args

x: float or PyoObject: New slope attribute.

setStages(x)[source]¶

Replace the stages attribute.

Args

x: int: New stages attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. The spectral envelope.

property input2¶: PyoObject. The exciter.

property freq¶: float or PyoObject. Center frequency of the first band.

property spread¶: float or PyoObject. Spreading factor for upper band frequencies.

property q¶: float or PyoObject. Q factor of the filters.

property slope¶: float or PyoObject. Time response of the envelope follower.

property stages¶: int. The number of bands in the filter bank.

IRWinSinc¶

class IRWinSinc(input, freq=1000, bw=500, type=0, order=256, mul=1, add=0)[source]¶

Windowed-sinc filter using circular convolution.

IRWinSinc uses circular convolution to implement standard filters like lowpass, highpass, bandreject and bandpass with very flat passband response and sharp roll-off. User can defined the length, in samples, of the impulse response, also known as the filter kernel.

Parent

PyoObject

Args

input: PyoObject

Input signal to process.

freq: float or PyoObject, optional

Frequency cutoff for lowpass and highpass and center frequency for bandjrect and bandpass filters, expressed in Hz. Defaults to 1000.

bw: float or PyoObject, optional

Bandwidth, expressed in Hertz, for bandreject and bandpass filters. Defaults to 500.

type: int, optional

Filter type. Four possible values :

lowpass (default)
highpass
bandreject
bandpass

order: int {even number}, optional

Length, in samples, of the filter kernel used for convolution. Available at initialization time only. Defaults to 256.

This value must be even. Higher is the order and sharper is the roll-off of the filter, but it is also more expensive to compute.

Note

Convolution is very expensive to compute, so the length of the impulse response (the order parameter) must be kept very short to run in real time.

Note that although freq and bw can be PyoObjects, the impulse response of the filter is only updated once per buffer size.

>>> s = Server().boot()
>>> s.start()
>>> a = Noise(.3)
>>> lfr = Sine([.15, .2], mul=2000, add=3500)
>>> lbw = Sine([.3, .25], mul=1000, add=1500)
>>> b = IRWinSinc(a, freq=lfr, bw=lbw, type=3, order=256).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.
`bw`	float or PyoObject.
`type`	int.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, bw, type, order, ...])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setBw`(x)	Replace the bw attribute.
`setType`(x)	Replace the type attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Default to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

setBw(x)[source]¶

Replace the bw attribute.

Args

x: float or PyoObject: New bw attribute.

setType(x)[source]¶

Replace the type attribute.

Args

x: int: New type attribute. 0. lowpass 1. highpass 2. bandreject 3. bandpass

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Cutoff or Center frequency of the filter.

property bw¶: float or PyoObject. Bandwidth for bandreject and bandpass filters.

property type¶: int. Filter type {0 = lowpass, 1 = highpass, 2 = bandreject, 3 = bandpass}.

IRAverage¶

class IRAverage(input, order=256, mul=1, add=0)[source]¶

Moving average filter using circular convolution.

IRAverage uses circular convolution to implement an average filter. This filter is designed to reduce the noise in the input signal while keeping as much as possible the step response of the original signal. User can defined the length, in samples, of the impulse response, also known as the filter kernel. This controls the ratio of removed noise vs the fidelity of the original step response.

Parent

PyoObject

Args

input: PyoObject

Input signal to process.

order: int {even number}, optional

Length, in samples, of the filter kernel used for convolution. Available at initialization time only. Defaults to 256.

This value must be even. A high order will reduced more noise and will have a higher damping effect on the step response, but it is also more expensive to compute.

Note

Convolution is very expensive to compute, so the length of the impulse response (the order parameter) must be kept very short to run in real time.

>>> s = Server().boot()
>>> s.start()
>>> nz = Noise(.05)
>>> a = Sine([300, 400], mul=.25, add=nz)
>>> b = IRAverage(a, order=128).out()

Public Data Attributes:

input

PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, order, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Default to 0.05.

property input¶: PyoObject. Input signal to process.

IRPulse¶

class IRPulse(input, freq=500, bw=2500, type=0, order=256, mul=1, add=0)[source]¶

Comb-like filter using circular convolution.

IRPulse uses circular convolution to implement standard comb-like filters consisting of an harmonic series with fundamental freq and a comb filter with the first notch at bw frequency. The type parameter defines variations of this pattern. User can defined the length, in samples, of the impulse response, also known as the filter kernel.

Parent

PyoObject

Args

input: PyoObject

Input signal to process.

freq: float or PyoObject, optional

Fundamental frequency of the spikes in the filter’s spectrum, expressed in Hertz. Defaults to 500.

bw: float or PyoObject, optional

Frequency, expressed in Hertz, of the first notch in the comb filtering. Defaults to 2500.

type: int, optional

Filter type. Four possible values :

Pulse & comb (default)
Pulse & comb & lowpass
Pulse (odd harmonics) & comb
Pulse (odd harmonics) & comb & lowpass

order: int {even number}, optional

Length, in samples, of the filter kernel used for convolution. Available at initialization time only. Defaults to 256.

This value must be even. Higher is the order and sharper is the roll-off of the filter, but it is also more expensive to compute.

Note

Convolution is very expensive to compute, so the length of the impulse response (the order parameter) must be kept very short to run in real time.

Note that although freq and bw can be PyoObjects, the impulse response of the filter is only updated once per buffer size.

>>> s = Server().boot()
>>> s.start()
>>> a = Noise(.5)
>>> b = IRPulse(a, freq=[245, 250], bw=2500, type=3, order=256).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.
`bw`	float or PyoObject.
`type`	int.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, bw, type, order, ...])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setBw`(x)	Replace the bw attribute.
`setType`(x)	Replace the type attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Default to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

setBw(x)[source]¶

Replace the bw attribute.

Args

x: float or PyoObject: New bw attribute.

setType(x)[source]¶

Replace the type attribute.

Args

x: int

New type attribute. Filter type. Four possible values:

Pulse & comb (default)
Pulse & comb & lowpass
Pulse (odd harmonics) & comb
Pulse (odd harmonics) & comb & lowpass

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Cutoff or Center frequency of the filter.

property bw¶: float or PyoObject. Bandwidth for bandreject and bandpass filters.

property type¶: int. Filter type {0 = pulse, 1 = pulse_lp, 2 = pulse_odd, 3 = pulse_odd_lp}.

IRFM¶

class IRFM(input, carrier=1000, ratio=0.5, index=3, order=256, mul=1, add=0)[source]¶

Filters a signal with a frequency modulation spectrum using circular convolution.

IRFM uses circular convolution to implement filtering with a frequency modulation spectrum. User can defined the length, in samples, of the impulse response, also known as the filter kernel. The higher the order, the narrower the bandwidth around each of the FM components.

Parent

PyoObject

Args

input: PyoObject

Input signal to process.

carrier: float or PyoObject, optional

Carrier frequency in cycles per second. Defaults to 1000.

ratio: float or PyoObject, optional

A factor that, when multiplied by the carrier parameter, gives the modulator frequency. Defaults to 0.5.

index: float or PyoObject, optional

The modulation index. This value multiplied by the modulator frequency gives the modulator amplitude. Defaults to 3.

order: int {even number}, optional

Length, in samples, of the filter kernel used for convolution. Available at initialization time only. Defaults to 256.

This value must be even. Higher is the order and sharper is the roll-off of the filter, but it is also more expensive to compute.

Note

Convolution is very expensive to compute, so the length of the impulse response (the order parameter) must be kept very short to run in real time.

Note that although carrier, ratio and index can be PyoObjects, the impulse response of the filter is only updated once per buffer size.

>>> s = Server().boot()
>>> s.start()
>>> nz = Noise(.7)
>>> lf = Sine(freq=[.2, .25], mul=.125, add=.5)
>>> b = IRFM(nz, carrier=3500, ratio=lf, index=3, order=256).out()

Public Data Attributes:

`input`	PyoObject.
`carrier`	float or PyoObject.
`ratio`	float or PyoObject.
`index`	float or PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, carrier, ratio, index, ...])
`setInput`(x[, fadetime])	Replace the input attribute.
`setCarrier`(x)	Replace the carrier attribute.
`setRatio`(x)	Replace the ratio attribute.
`setIndex`(x)	Replace the index attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Default to 0.05.

setCarrier(x)[source]¶

Replace the carrier attribute.

Args

x: float or PyoObject: New carrier attribute.

setRatio(x)[source]¶

Replace the ratio attribute.

Args

x: float or PyoObject: New ratio attribute.

setIndex(x)[source]¶

Replace the index attribute.

Args

x: float or PyoObject: New index attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property carrier¶: float or PyoObject. Carrier frequency in Hz.

property ratio¶: float or PyoObject. Modulator/carrier ratio.

property index¶: float or PyoObject. Modulation index.

SVF¶

class SVF(input, freq=1000, q=1, type=0, mul=1, add=0)[source]¶

Fourth-order state variable filter allowing continuous change of the filter type.

Parent

PyoObject

Args

input: PyoObject

Input signal to process.

freq: float or PyoObject, optional

Cutoff or center frequency of the filter. Defaults to 1000.

Because this filter becomes unstable at higher frequencies, the freq parameter is limited to one-sixth of the sampling rate.

q: float or PyoObject, optional

Q of the filter, defined (for bandpass filters) as freq/bandwidth. Should be between 0.5 and 50. Defaults to 1.

type: float or PyoObject, optional

This value, in the range 0 to 1, controls the filter type crossfade on the continuum lowpass-bandpass-highpass.

0.0 = lowpass (default)
0.5 = bandpass
1.0 = highpass

>>> s = Server().boot()
>>> s.start()
>>> a = Noise(.2)
>>> lf1 = Sine([.22,.25]).range(500, 2000)
>>> lf2 = Sine([.17,.15]).range(1, 4)
>>> lf3 = Sine([.23,.2]).range(0, 1)
>>> b = SVF(a, freq=lf1, q=lf2, type=lf3).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.
`q`	float or PyoObject.
`type`	float or PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, q, type, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setQ`(x)	Replace the q attribute.
`setType`(x)	Replace the type attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setFreq(x)[source]¶

Replace the freq attribute. Limited in the upper bound to one-sixth of the sampling rate.

Args

x: float or PyoObject: New freq attribute.

setQ(x)[source]¶

Replace the q attribute. Should be between 0.5 and 50.

Args

x: float or PyoObject: New q attribute.

setType(x)[source]¶

Replace the type attribute. Must be in the range 0 to 1.

This value allows the filter type to sweep from a lowpass (0) to a bandpass (0.5) and then, from the bandpass to a highpass (1).

Args

x: float or PyoObject: New type attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Cutoff or center frequency of the filter.

property q¶: float or PyoObject. Q of the filter.

property type¶: float or PyoObject. Crossfade between filter types.

SVF2¶

class SVF2(input, freq=1000, q=1, shelf=-3, type=0, mul=1, add=0)[source]¶

Second-order state variable filter allowing continuous change of the filter type.

This 2-pole multimode filter is described in the book “The Art of VA Filter Design” by Vadim Zavalishin (version 2.1.0 when this object was created).

Several filter types are available with continuous change between them. The default order (controlled with the type argument) is:

lowpass

bandpass

highpass

highshelf

bandshelf

lowshelf

notch

peak

allpass

unit gain bandpass

The filter types order can be changed with the setOrder method. The first filter type is always copied at the end of the order list so we can create a glitch-free loop of filter types with a Phasor given as type argument. Ex.:

>>> lfo = Phasor(freq=.5, mul=3)
>>> svf2 = SVF2(Noise(.25), freq=2500, q=2, shelf=-6, type=lfo).out()
>>> svf2.order = [2, 1, 0] # highpass -> bandpass -> lowpass -> highpass

Parent

PyoObject

Args

input: PyoObject

Input signal to process.

freq: float or PyoObject, optional

Cutoff or center frequency of the filter. Defaults to 1000.

q: float or PyoObject, optional

Q of the filter, defined (for bandpass filters) as freq/bandwidth. Should be between 0.5 and 50. Defaults to 1.

shelf: float or PyoObject, optional

Gain, between -24 dB and 24 dB, used by shelving filters. Defaults to -3.

type: float or PyoObject, optional

This value, in the range 0 to 10, controls the filter type crossfade on the continuum defined by the filter types order. The default order (which can be changed with the setOrder method) is:

0 = lowpass
1 = bandpass
2 = highpass
3 = highshelf
4 = bandshelf
5 = lowshelf
6 = notch
7 = peak
8 = allpass
9 = unit gain bandpass

>>> s = Server().boot()
>>> s.start()
>>> n = Noise(0.25).mix(2)
>>> tp = Phasor(.25, mul=10)
>>> fr = Sine(.3).range(500, 5000)
>>> svf2 = SVF2(n, freq=fr, q=3, shelf=-6, type=tp).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.
`q`	float or PyoObject.
`shelf`	float or PyoObject.
`type`	float or PyoObject.
`order`	list of ints.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, q, shelf, type, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setQ`(x)	Replace the q attribute.
`setShelf`(x)	Replace the shelf attribute.
`setType`(x)	Replace the type attribute.
`setOrder`(x)	Change the filter types ordering.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

setQ(x)[source]¶

Replace the q attribute. Should be between 0.5 and 50.

Args

x: float or PyoObject: New q attribute.

setShelf(x)[source]¶

Replace the shelf attribute. Should be between -24 dB and 24 dB.

Args

x: float or PyoObject: New shelf attribute.

setType(x)[source]¶

Replace the type attribute. Must be in the range 0 to 10.

This value allows the filter type to crossfade between several filter types.

Args

x: float or PyoObject: New type attribute.

setOrder(x)[source]¶

Change the filter types ordering.

The ordering is a list of one to ten integers indicating the filter types order used by the type argument to crossfade between them. Types, as integer, are:

0 = lowpass

1 = bandpass

2 = highpass

3 = highshelf

4 = bandshelf

5 = lowshelf

6 = notch

7 = peak

8 = allpass

9 = unit gain bandpass

Args

x: list of ints: New types ordering.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Cutoff or center frequency of the filter.

property q¶: float or PyoObject. Q of the filter.

property shelf¶: float or PyoObject. Shelving gain of the filter.

property type¶: float or PyoObject. Crossfade between filter types.

property order¶: list of ints. Filter types ordering.

Average¶

class Average(input, size=10, mul=1, add=0)[source]¶

Moving average filter.

As the name implies, the moving average filter operates by averaging a number of points from the input signal to produce each point in the output signal. In spite of its simplicity, the moving average filter is optimal for a common task: reducing random noise while retaining a sharp step response.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
size: int, optional: Filter kernel size, which is the number of samples used in the moving average. Default to 10.

>>> s = Server().boot()
>>> s.start()
>>> a = Noise(.025)
>>> b = Sine(250, mul=0.3)
>>> c = Average(a+b, size=100).out()

Public Data Attributes:

`input`	PyoObject.
`size`	int.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, size, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setSize`(x)	Replace the size attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Default to 0.05.

setSize(x)[source]¶

Replace the size attribute.

Args

x: int: New size attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property size¶: int. Filter kernel size in samples.

Reson¶

class Reson(input, freq=1000, q=1, mul=1, add=0)[source]¶

A second-order resonant bandpass filter.

Reson implements a classic resonant bandpass filter, as described in:

Dodge, C., Jerse, T., “Computer Music, Synthesis, Composition and Performance”.

Reson uses less CPU than the equivalent filter with a Biquad object.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
freq: float or PyoObject, optional: Center frequency of the filter. Defaults to 1000.
q: float or PyoObject, optional: Q of the filter, defined as freq/bandwidth. Should be between 1 and 500. Defaults to 1.

>>> s = Server().boot()
>>> s.start()
>>> a = Noise(mul=.7)
>>> lfo = Sine(freq=[.2, .25], mul=1000, add=1500)
>>> f = Reson(a, freq=lfo, q=5).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.
`q`	float or PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, q, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setQ`(x)	Replace the q attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

setQ(x)[source]¶

Replace the q attribute. Should be between 1 and 500.

Args

x: float or PyoObject: New q attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Center frequency of the filter.

property q¶: float or PyoObject. Q of the filter.

Resonx¶

class Resonx(input, freq=1000, q=1, stages=4, mul=1, add=0)[source]¶

A multi-stages second-order resonant bandpass filter.

Resonx implements a stack of the classic resonant bandpass filter, as described in:

Dodge, C., Jerse, T., “Computer Music, Synthesis, Composition and Performance”.

Resonx is equivalent to a filter consisting of more layers of Reson with the same arguments, serially connected. It is faster than using a large number of instances of the Reson object, it uses less memory and allows filters with sharper cutoff.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
freq: float or PyoObject, optional: Center frequency of the filter. Defaults to 1000.
q: float or PyoObject, optional: Q of the filter, defined as freq/bandwidth. Should be between 1 and 500. Defaults to 1.
stages: int, optional: The number of filtering stages in the filter stack. Defaults to 4.

>>> s = Server().boot()
>>> s.start()
>>> a = Noise(mul=.7)
>>> lfo = Sine(freq=[.2, .25], mul=1000, add=1500)
>>> f = Resonx(a, freq=lfo, q=5).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.
`q`	float or PyoObject.
`stages`	int.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, q, stages, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setQ`(x)	Replace the q attribute.
`setStages`(x)	Replace the stages attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

setQ(x)[source]¶

Replace the q attribute. Should be between 1 and 500.

Args

x: float or PyoObject: New q attribute.

setStages(x)[source]¶

Replace the stages attribute.

Args

x: int: New stages attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Center frequency of the filter.

property q¶: float or PyoObject. Q of the filter.

property stages¶: int. The number of filtering stages.

ButLP¶

class ButLP(input, freq=1000, mul=1, add=0)[source]¶

A second-order Butterworth lowpass filter.

ButLP implements a second-order IIR Butterworth lowpass filter, which has a maximally flat passband and a very good precision and stopband attenuation.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
freq: float or PyoObject, optional: Cutoff frequency of the filter in hertz. Default to 1000.

>>> s = Server().boot()
>>> s.start()
>>> n = Noise(.3)
>>> lf = Sine(freq=.2, mul=800, add=1000)
>>> f = ButLP(n, lf).mix(2).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Default to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Cutoff frequency of the filter.

ButHP¶

class ButHP(input, freq=1000, mul=1, add=0)[source]¶

A second-order Butterworth highpass filter.

ButHP implements a second-order IIR Butterworth highpass filter, which has a maximally flat passband and a very good precision and stopband attenuation.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
freq: float or PyoObject, optional: Cutoff frequency of the filter in hertz. Default to 1000.

>>> s = Server().boot()
>>> s.start()
>>> n = Noise(.2)
>>> lf = Sine(freq=.2, mul=1500, add=2500)
>>> f = ButHP(n, lf).mix(2).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Default to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Cutoff frequency of the filter.

ButBP¶

class ButBP(input, freq=1000, q=1, mul=1, add=0)[source]¶

A second-order Butterworth bandpass filter.

ButBP implements a second-order IIR Butterworth bandpass filter, which has a maximally flat passband and a very good precision and stopband attenuation.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
freq: float or PyoObject, optional: Center frequency of the filter. Defaults to 1000.
q: float or PyoObject, optional: Q of the filter, defined as freq/bandwidth. Should be between 1 and 500. Defaults to 1.

>>> s = Server().boot()
>>> s.start()
>>> a = Noise(mul=.7)
>>> lfo = Sine(freq=[.2, .25], mul=1000, add=1500)
>>> f = ButBP(a, freq=lfo, q=5).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.
`q`	float or PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, q, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setQ`(x)	Replace the q attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

setQ(x)[source]¶

Replace the q attribute. Should be between 1 and 500.

Args

x: float or PyoObject: New q attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Center frequency of the filter.

property q¶: float or PyoObject. Q of the filter.

ButBR¶

class ButBR(input, freq=1000, q=1, mul=1, add=0)[source]¶

A second-order Butterworth band-reject filter.

ButBR implements a second-order IIR Butterworth band-reject filter, which has a maximally flat passband and a very good precision and stopband attenuation.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
freq: float or PyoObject, optional: Center frequency of the filter. Defaults to 1000.
q: float or PyoObject, optional: Q of the filter, defined as freq/bandwidth. Should be between 1 and 500. Defaults to 1.

>>> s = Server().boot()
>>> s.start()
>>> a = Noise(mul=.2)
>>> lfo = Sine(freq=[.2, .25], mul=1000, add=1500)
>>> f = ButBR(a, freq=lfo, q=1).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.
`q`	float or PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, q, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setQ`(x)	Replace the q attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

setQ(x)[source]¶

Replace the q attribute. Should be between 1 and 500.

Args

x: float or PyoObject: New q attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Center frequency of the filter.

property q¶: float or PyoObject. Q of the filter.

ComplexRes¶

class ComplexRes(input, freq=1000, decay=0.25, mul=1, add=0)[source]¶

Complex one-pole resonator filter.

ComplexRes implements a resonator derived from a complex multiplication, which is very similar to a digital filter.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
freq: float or PyoObject, optional: Center frequency of the filter. Defaults to 1000.
decay: float or PyoObject, optional: Decay time, in seconds, for the filter’s response. Defaults to 0.25.

>>> s = Server().boot()
>>> s.start()
>>> env = HannTable()
>>> trigs = Metro(.2, poly=4).play()
>>> amp = TrigEnv(trigs, table=env, dur=0.005, mul=2)
>>> im = Noise(mul=amp)
>>> res = ComplexRes(im, freq=[950,530,780,1490], decay=1).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.
`decay`	float or PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, decay, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setDecay`(x)	Replace the decay attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

setDecay(x)[source]¶

Replace the decay attribute.

Args

x: float or PyoObject: New decay attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to filter.

property freq¶: float or PyoObject. Center frequency of the filter.

property decay¶: float or PyoObject. Decay time of the filter’s response.

MoogLP¶

class MoogLP(input, freq=1000, res=0, mul=1, add=0)[source]¶

A fourth-order resonant lowpass filter.

Digital approximation of the Moog VCF, giving a decay of 24dB/oct.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
freq: float or PyoObject, optional: Cutoff frequency of the filter. Defaults to 1000.
res: float or PyoObject, optional: Amount of Resonance of the filter, usually between 0 (no resonance) and 1 (medium resonance). Self-oscillation occurs when the resonance is >= 1. Can go up to 10. Defaults to 0.

>>> s = Server().boot()
>>> s.start()
>>> ph = Phasor(40)
>>> sqr = Round(ph, add=-0.5)
>>> lfo = Sine(freq=[.4, .5], mul=2000, add=2500)
>>> fil = MoogLP(sqr, freq=lfo, res=1.25).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.
`res`	float or PyoObject.

Inherited from PyoObject

`mul`	float or PyoObject.
`add`	float or PyoObject.

Public Methods:

`__init__`(input[, freq, res, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setRes`(x)	Replace the res attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObject

`__init__`([mul, add])
`__add__`(x)
`__radd__`(x)
`__iadd__`(x)
`__sub__`(x)
`__rsub__`(x)
`__isub__`(x)
`__mul__`(x)
`__rmul__`(x)
`__imul__`(x)
`__truediv__`(x)
`__rtruediv__`(x)
`__itruediv__`(x)
`__div__`(x)
`__rdiv__`(x)
`__idiv__`(x)
`__pow__`(x)
`__rpow__`(x)
`__mod__`(x)
`__neg__`()
`__lt__`(x)	Return self<value.
`__le__`(x)	Return self<=value.
`__eq__`(x)	Return self==value.
`__ne__`(x)	Return self!=value.
`__gt__`(x)	Return self>value.
`__ge__`(x)	Return self>=value.
`__do_comp__`(comp, mode[, default])
`isPlaying`([all])	Returns True if the object is currently playing, otherwise, returns False.
`isOutputting`([all])	Returns True if the object is outputting.
`get`([all])	Return the first sample of the current buffer as a float.
`play`([dur, delay])	Start processing without sending samples to output.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`stop`([wait])	Stop processing.
`mix`([voices])	Mix the object's audio streams into voices streams and return a Mix object.
`range`(min, max)	Adjust mul and add attributes according to a given range.
`setMul`(x)	Replace the mul attribute.
`setAdd`(x)	Replace the add attribute.
`setSub`(x)	Replace and inverse the add attribute.
`setDiv`(x)	Replace and inverse the mul attribute.
`set`(attr, value[, port, callback])	Replace any attribute with portamento.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

`__init__`()
`dump`()	Print infos about the current state of the object.
`getBaseObjects`()	Return a list of Stream objects managed by the instance.
`getServer`()	Return a reference to the current Server object.
`getSamplingRate`()	Return the current sampling rate (samples per second), as a float.
`getBufferSize`()	Return the current buffer size (samples per buffer), as an integer.
`allowAutoStart`([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
`useWaitTimeOnStop`()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
`addLinkedObject`(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
`setStopDelay`(x)	Set a specific waiting time when calling the stop method on this object.
`getStopDelay`()	Return the waiting time applied when calling the stop method on this object.
`__iter__`()
`__next__`()
`next`()	Alias for __next__ method.
`__getitem__`(i)
`__setitem__`(i, x)
`__len__`()
`__repr__`()	Return repr(self).
`__dir__`()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

`_init_play`()
`_reset_from_set`([attr])

Inherited from PyoObjectBase

`_autoplay`([dur, delay])
`_autostop`([wait])

setInput(x, fadetime=0.05)[source]¶

Replace the input attribute.

Args

x: PyoObject: New signal to process.
fadetime: float, optional: Crossfade time between old and new input. Defaults to 0.05.

setFreq(x)[source]¶

Replace the freq attribute.

Args

x: float or PyoObject: New freq attribute.

setRes(x)[source]¶

Replace the res attribute.

Args

x: float or PyoObject: New res attribute.

ctrl(map_list=None, title=None, wxnoserver=False)[source]¶

Opens a sliders window to control the parameters of the object. SLMap has a dataOnly attribute to identify parameters that don’t audio signal as control but only discrete values.

If a list of values are given to a parameter, a multisliders will be used to control each stream independently.

Args

map_list: list of SLMap objects, optional: Users defined set of parameters scaling. There is default scaling for each object that accept ctrl method.
title: string, optional: Title of the window. If none is provided, the name of the class is used.
wxnoserver: boolean, optional: With wxPython graphical toolkit, if True, tells the interpreter that there will be no server window.

If wxnoserver is set to True, the interpreter will not wait for the server GUI before showing the controller window.

property input¶: PyoObject. Input signal to process.

property freq¶: float or PyoObject. Cutoff frequency of the filter.

property res¶: float or PyoObject. Amount of resonance of the filter.

`__init__`(input[, freq1, freq2, freq3, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq1`(x)	Replace the freq1 attribute.
`setFreq2`(x)	Replace the freq2 attribute.
`setFreq3`(x)	Replace the freq3 attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

`__init__`(input[, num, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFrequencies`(freqs)	Change the filters splitting frequencies.

Table of Contents

Search

Filters¶

Objects in this category¶

Biquad¶

Biquadx¶

Biquada¶

EQ¶

Tone¶

Atone¶

Port¶

DCBlock¶

BandSplit¶

FourBand¶

MultiBand¶

Hilbert¶

Allpass¶

Allpass2¶

Phaser¶

Vocoder¶

IRWinSinc¶

IRAverage¶

IRPulse¶

IRFM¶

SVF¶

SVF2¶

Average¶

Reson¶

Resonx¶

ButLP¶

ButHP¶

ButBP¶

ButBR¶

ComplexRes¶

MoogLP¶

`__init__`(input[, num, min, max, q, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setQ`(x)	Replace the q attribute.
`ctrl`([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

`input`	PyoObject.
`freq1`	float or PyoObject.
`freq2`	float or PyoObject.
`freq3`	float or PyoObject.