Special Effects¶

Objects to perform specific audio signal processing effects such as distortions, delays, chorus and reverbs.

Objects in this category¶

Disto : Kind of Arc tangent distortion.
Delay : Sweepable recursive delay.
SDelay : Simple delay without interpolation.
Delay1 : Delays a signal by one sample.
Waveguide : Basic waveguide model.
AllpassWG : Out of tune waveguide model with a recursive allpass network.
Freeverb : Implementation of Jezar’s Freeverb.
Convolve : Implements filtering using circular convolution.
WGVerb : 8 delay lines mono FDN reverb.
Chorus : 8 modulated delay lines chorus processor.
Harmonizer : Generates harmonizing voices in synchrony with its audio input.
FreqShift : Frequency shifting using single sideband amplitude modulation.
STRev : Stereo reverb.
SmoothDelay : Artifact free sweepable recursive delay.

Disto¶

class Disto(input, drive=0.75, slope=0.5, mul=1, add=0)[source]¶

Kind of Arc tangent distortion.

Apply a kind of arc tangent distortion with controllable drive, followed by a one pole lowpass filter, to the input signal.

As of version 0.8.0, this object use a simple but very efficient (4x faster than tanh or atan2 functions) waveshaper formula.

The waveshaper algorithm is:

y[n] = (1 + k) * x[n] / (1 + k * abs(x[n]))

where:

k = (2 * drive) / (1 - drive)

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
drive: float or PyoObject, optional: Amount of distortion applied to the signal, between 0 and 1. Defaults to 0.75.
slope: float or PyoObject, optional: Slope of the lowpass filter applied after distortion, between 0 and 1. Defaults to 0.5.

See also

Degrade, Clip

>>> s = Server().boot()
>>> s.start()
>>> a = SfPlayer(SNDS_PATH + "/transparent.aif", loop=True)
>>> lfo = Sine(freq=[.2,.25], mul=.5, add=.5)
>>> d = Disto(a, drive=lfo, slope=.8, mul=.15).out()

Public Data Attributes:

`input`	PyoObject.
`drive`	float or PyoObject.
`slope`	float or PyoObject.

Inherited from PyoObject

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

Public Methods:

`__init__`(input[, drive, slope, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setDrive`(x)	Replace the drive attribute.
`setSlope`(x)	Replace the slope 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.

setDrive(x)[source]¶

Replace the drive attribute.

Args

x: float or PyoObject: New drive attribute.

setSlope(x)[source]¶

Replace the slope attribute.

Args

x: float or PyoObject: New slope 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 drive¶: float or PyoObject. Amount of distortion.

property slope¶: float or PyoObject. Slope of the lowpass filter.

Delay¶

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

Sweepable recursive delay.

Parent

PyoObject

Args

input: PyoObject: Input signal to delayed.
delay: float or PyoObject, optional: Delay time in seconds. Defaults to 0.25.
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.

Note

The minimum delay time allowed with Delay is one sample. It can be computed with :

onesamp = 1.0 / s.getSamplingRate()

See also

SDelay, SmoothDelay, Waveguide

>>> s = Server().boot()
>>> s.start()
>>> a = SfPlayer(SNDS_PATH + "/transparent.aif", loop=True, mul=.3).mix(2).out()
>>> d = Delay(a, delay=[.15,.2], feedback=.5, mul=.4).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.
`reset`()	Reset the memory buffer to zeros.
`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 delayed.
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.

reset()[source]¶: Reset the memory buffer to zeros.

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 delayed.

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

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

SDelay¶

class SDelay(input, delay=0.25, maxdelay=1, mul=1, add=0)[source]¶

Simple delay without interpolation.

Parent

PyoObject

Args

input: PyoObject: Input signal to delayed.
delay: float or PyoObject, optional: Delay time in seconds. Defaults to 0.25.
maxdelay: float, optional: Maximum delay length in seconds. Available only at initialization. Defaults to 1.

See also

Delay, Delay1

>>> s = Server().boot()
>>> s.start()
>>> srPeriod = 1. / s.getSamplingRate()
>>> dlys = [srPeriod * i * 5 for i in range(1, 7)]
>>> a = SfPlayer(SNDS_PATH + "/transparent.aif", loop=True)
>>> d = SDelay(a, delay=dlys, mul=.1).out(1)

Public Data Attributes:

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

Inherited from PyoObject

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

Public Methods:

`__init__`(input[, delay, maxdelay, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setDelay`(x)	Replace the delay attribute.
`reset`()	Reset the memory buffer to zeros.
`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.

reset()[source]¶: Reset the memory buffer to zeros.

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 delayed.

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

Delay1¶

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

Delays a signal by one sample.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.

>>> s = Server().boot()
>>> s.start()
>>> # 50th order FIR lowpass filter
>>> order = 50
>>> objs = [Noise(.3)]
>>> for i in range(order):
...     objs.append(Delay1(objs[-1], add=objs[-1]))
...     objs.append(objs[-1] * 0.5)
>>> out = Sig(objs[-1]).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 delayed.

Waveguide¶

class Waveguide(input, freq=100, dur=10, minfreq=20, mul=1, add=0)[source]¶

Basic waveguide model.

This waveguide model consisting of one delay-line with a simple lowpass filtering and lagrange interpolation.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
freq: float or PyoObject, optional: Frequency, in cycle per second, of the waveguide (i.e. the inverse of delay time). Defaults to 100.
dur: float or PyoObject, optional: Duration, in seconds, for the waveguide to drop 40 dB below it’s maxima. Defaults to 10.
minfreq: float, optional: Minimum possible frequency, used to initialized delay length. Available only at initialization. Defaults to 20.

See also

Delay, AllpassWG, WGVerb

>>> s = Server().boot()
>>> s.start()
>>> sf = SfPlayer(SNDS_PATH + '/transparent.aif', speed=[.98,1.02], loop=True)
>>> gt = Gate(sf, thresh=-24, risetime=0.005, falltime=0.01, lookahead=5, mul=.2)
>>> w = Waveguide(gt, freq=[60,120.17,180.31,240.53], dur=20, minfreq=20, mul=.4).out()

Public Data Attributes:

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

Inherited from PyoObject

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

Public Methods:

`__init__`(input[, freq, dur, minfreq, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setDur`(x)	Replace the dur attribute.
`reset`()	Reset the memory buffer to zeros.
`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.

setDur(x)[source]¶

Replace the dur attribute.

Args

x: float or PyoObject: New dur attribute.

reset()[source]¶: Reset the memory buffer to zeros.

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. Frequency in cycle per second.

property dur¶: float or PyoObject. Resonance duration in seconds.

AllpassWG¶

class AllpassWG(input, freq=100, feed=0.95, detune=0.5, minfreq=20, mul=1, add=0)[source]¶

Out of tune waveguide model with a recursive allpass network.

This waveguide model consisting of one delay-line with a 3-stages recursive allpass filter which made the resonances of the waveguide out of tune.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
freq: float or PyoObject, optional: Frequency, in cycle per second, of the waveguide (i.e. the inverse of delay time). Defaults to 100.
feed: float or PyoObject, optional: Amount of output signal (between 0 and 1) sent back into the delay line. Defaults to 0.95.
detune: float or PyoObject, optional: Control the depth of the allpass delay-line filter, i.e. the depth of the detuning. Should be in the range 0 to 1. Defaults to 0.5.
minfreq: float, optional: Minimum possible frequency, used to initialized delay length. Available only at initialization. Defaults to 20.

See also

Delay, Waveguide

>>> s = Server().boot()
>>> s.start()
>>> sf = SfPlayer(SNDS_PATH + '/transparent.aif', speed=[.98,1.02], loop=True)
>>> gt = Gate(sf, thresh=-24, risetime=0.005, falltime=0.01, lookahead=5, mul=.2)
>>> rnd = Randi(min=.5, max=1.0, freq=[.13,.22,.155,.171])
>>> rnd2 = Randi(min=.95, max=1.05, freq=[.145,.2002,.1055,.071])
>>> fx = AllpassWG(gt, freq=rnd2*[74.87,75,75.07,75.21], feed=1, detune=rnd, mul=.15).out()

Public Data Attributes:

`input`	PyoObject.
`freq`	float or PyoObject.
`feed`	float or PyoObject.
`detune`	float or PyoObject.

Inherited from PyoObject

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

Public Methods:

`__init__`(input[, freq, feed, detune, ...])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFreq`(x)	Replace the freq attribute.
`setFeed`(x)	Replace the feed attribute.
`setDetune`(x)	Replace the detune attribute.
`reset`()	Reset the memory buffer to zeros.
`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.

setFeed(x)[source]¶

Replace the feed attribute.

Args

x: float or PyoObject: New feed attribute.

setDetune(x)[source]¶

Replace the detune attribute.

Args

x: float or PyoObject: New detune attribute.

reset()[source]¶: Reset the memory buffer to zeros.

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. Frequency in cycle per second.

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

property detune¶: float or PyoObject. Depth of the detuning.

Freeverb¶

class Freeverb(input, size=0.5, damp=0.5, bal=0.5, mul=1, add=0)[source]¶

Implementation of Jezar’s Freeverb.

Freeverb is a reverb unit generator based on Jezar’s public domain C++ sources, composed of eight parallel comb filters, followed by four allpass units in series. Filters on each stream are slightly detuned in order to create multi-channel effects.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
size: float or PyoObject, optional: Controls the length of the reverb, between 0 and 1. A higher value means longer reverb. Defaults to 0.5.
damp: float or PyoObject, optional: High frequency attenuation, between 0 and 1. A higher value will result in a faster decay of the high frequency range. Defaults to 0.5.
bal: float or PyoObject, optional: Balance between wet and dry signal, between 0 and 1. 0 means no reverb. Defaults to 0.5.

See also

WGVerb, STRev, CvlVerb

>>> s = Server().boot()
>>> s.start()
>>> a = SfPlayer(SNDS_PATH + "/transparent.aif", loop=True, mul=.4)
>>> b = Freeverb(a, size=[.79,.8], damp=.9, bal=.3).out()

Public Data Attributes:

`input`	PyoObject.
`size`	float or PyoObject.
`damp`	float or PyoObject.
`bal`	float or PyoObject.

Inherited from PyoObject

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

Public Methods:

`__init__`(input[, size, damp, bal, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setSize`(x)	Replace the size attribute.
`setDamp`(x)	Replace the damp attribute.
`setBal`(x)	Replace the bal attribute.
`reset`()	Reset the memory buffer to zeros.
`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.

setSize(x)[source]¶

Replace the size attribute.

Args

x: float or PyoObject: New size attribute.

setDamp(x)[source]¶

Replace the damp attribute.

Args

x: float or PyoObject: New damp attribute.

setBal(x)[source]¶

Replace the bal attribute.

Args

x: float or PyoObject: New bal attribute.

reset()[source]¶: Reset the memory buffer to zeros.

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¶: float or PyoObject. Room size.

property damp¶: float or PyoObject. High frequency damping.

property bal¶: float or PyoObject. Balance between wet and dry signal.

Convolve¶

class Convolve(input, table, size, mul=1, add=0)[source]¶

Implements filtering using circular convolution.

A circular convolution is defined as the integral of the product of two functions after one is reversed and shifted.

Parent

PyoObject

Args

input: PyoObject

Input signal to process.

table: PyoTableObject

Table containning the impulse response.

size: int

Length, in samples, of the convolution. Available at initialization time only.

If the table changes during the performance, its size must egal or greater than this value.

If greater only the first size samples will be used.

Note

Convolution is very expensive to compute, so the impulse response must be kept very short to run in real time.

Usually convolution generates a high amplitude level, take care of the mul parameter!

See also

Follower

>>> s = Server().boot()
>>> s.start()
>>> snd = SNDS_PATH + '/transparent.aif'
>>> sf = SfPlayer(snd, speed=[.999,1], loop=True, mul=.25).out()
>>> a = Convolve(sf, SndTable(SNDS_PATH+'/accord.aif'), size=512, mul=.2).out()

Public Data Attributes:

`input`	PyoObject.
`table`	PyoTableObject.

Inherited from PyoObject

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

Public Methods:

`__init__`(input, table, size[, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setTable`(x)	Replace the table 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.

setTable(x)[source]¶

Replace the table attribute.

Args

x: PyoTableObject: new table attribute.

property input¶: PyoObject. Input signal to filter.

property table¶: PyoTableObject. Table containing the impulse response.

WGVerb¶

class WGVerb(input, feedback=0.5, cutoff=5000, bal=0.5, mul=1, add=0)[source]¶

8 delay lines mono FDN reverb.

8 delay lines FDN reverb, with feedback matrix based upon physical modeling scattering junction of 8 lossless waveguides of equal characteristic impedance.

Parent

PyoObject

Args

input: PyoObject

Input signal to process.

feedback: float or PyoObject, optional

Amount of output signal sent back into the delay lines. Defaults to 0.5.

0.6 gives a good small “live” room sound, 0.8 a small hall, and 0.9 a large hall.

cutoff: float or PyoObject, optional

cutoff frequency of simple first order lowpass filters in the feedback loop of delay lines, in Hz. Defaults to 5000.

bal: float or PyoObject, optional

Balance between wet and dry signal, between 0 and 1. 0 means no reverb. Defaults to 0.5.

See also

Freeverb, STRev, CvlVerb

>>> s = Server().boot()
>>> s.start()
>>> a = SfPlayer(SNDS_PATH + "/transparent.aif", loop=True)
>>> d = WGVerb(a, feedback=[.74,.75], cutoff=5000, bal=.25, mul=.3).out()

Public Data Attributes:

`input`	PyoObject.
`feedback`	float or PyoObject.
`cutoff`	float or PyoObject.
`bal`	float or PyoObject.

Inherited from PyoObject

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

Public Methods:

`__init__`(input[, feedback, cutoff, bal, ...])
`setInput`(x[, fadetime])	Replace the input attribute.
`setFeedback`(x)	Replace the feedback attribute.
`setCutoff`(x)	Replace the cutoff attribute.
`setBal`(x)	Replace the bal attribute.
`reset`()	Reset the memory buffer to zeros.
`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.

setFeedback(x)[source]¶

Replace the feedback attribute.

Args

x: float or PyoObject: New feedback attribute.

setCutoff(x)[source]¶

Replace the cutoff attribute.

Args

x: float or PyoObject: New cutoff attribute.

setBal(x)[source]¶

Replace the bal attribute.

Args

x: float or PyoObject: New bal attribute.

reset()[source]¶: Reset the memory buffer to zeros.

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 feedback¶: float or PyoObject. Amount of output signal sent back into the delay lines.

property cutoff¶: float or PyoObject. Lowpass filter cutoff in Hz.

property bal¶: float or PyoObject. wet - dry balance.

Chorus¶

class Chorus(input, depth=1, feedback=0.25, bal=0.5, mul=1, add=0)[source]¶

8 modulated delay lines chorus processor.

A chorus effect occurs when individual sounds with roughly the same timbre and nearly (but never exactly) the same pitch converge and are perceived as one.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
depth: float or PyoObject, optional: Chorus depth, between 0 and 5. Defaults to 1.
feedback: float or PyoObject, optional: Amount of output signal sent back into the delay lines. Defaults to 0.25.
bal: float or PyoObject, optional: Balance between wet and dry signals, between 0 and 1. 0 means no chorus. Defaults to 0.5.

>>> s = Server().boot()
>>> s.start()
>>> sf = SfPlayer(SNDS_PATH + '/transparent.aif', loop=True, mul=.5)
>>> chor = Chorus(sf, depth=[1.5,1.6], feedback=0.5, bal=0.5).out()

Public Data Attributes:

`input`	PyoObject.
`depth`	float or PyoObject.
`feedback`	float or PyoObject.
`bal`	float or PyoObject.

Inherited from PyoObject

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

Public Methods:

`__init__`(input[, depth, feedback, bal, mul, add])
`setInput`(x[, fadetime])	Replace the input attribute.
`setDepth`(x)	Replace the depth attribute.
`setFeedback`(x)	Replace the feedback attribute.
`setBal`(x)	Replace the bal attribute.
`reset`()	Reset the memory buffer to zeros.
`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.

setDepth(x)[source]¶

Replace the depth attribute.

Args

x: float or PyoObject: New depth attribute.

setFeedback(x)[source]¶

Replace the feedback attribute.

Args

x: float or PyoObject: New feedback attribute.

setBal(x)[source]¶

Replace the bal attribute.

Args

x: float or PyoObject: New bal attribute.

reset()[source]¶: Reset the memory buffer to zeros.

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 depth¶: float or PyoObject. Chorus depth, between 0 and 5.

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

property bal¶: float or PyoObject. wet - dry balance.

Harmonizer¶

class Harmonizer(input, transpo=-7.0, feedback=0, winsize=0.1, mul=1, add=0)[source]¶

Generates harmonizing voices in synchrony with its audio input.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
transpo: float or PyoObject, optional: Transposition factor in semitone. Defaults to -7.0.
feedback: float or PyoObject, optional: Amount of output signal sent back into the delay line. Defaults to 0.
winsize: float, optional: Window size in seconds (max = 1.0). Defaults to 0.1.

>>> s = Server().boot()
>>> s.start()
>>> sf = SfPlayer(SNDS_PATH + '/transparent.aif', loop=True, mul=.3).out()
>>> harm = Harmonizer(sf, transpo=-5, winsize=0.05).out(1)

Public Data Attributes:

`input`	PyoObject.
`transpo`	float or PyoObject.
`feedback`	float or PyoObject.
`winsize`	float.

Inherited from PyoObject

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

Public Methods:

`__init__`(input[, transpo, feedback, ...])
`setInput`(x[, fadetime])	Replace the input attribute.
`setTranspo`(x)	Replace the transpo attribute.
`setFeedback`(x)	Replace the feedback attribute.
`setWinsize`(x)	Replace the winsize attribute.
`reset`()	Reset the memory buffer to zeros.
`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.

setTranspo(x)[source]¶

Replace the transpo attribute.

Args

x: float or PyoObject: New transpo attribute.

setFeedback(x)[source]¶

Replace the feedback attribute.

Args

x: float or PyoObject: New feedback attribute.

setWinsize(x)[source]¶

Replace the winsize attribute.

Args

x: float: New winsize attribute.

reset()[source]¶: Reset the memory buffer to zeros.

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 delayed.

property transpo¶: float or PyoObject. Transposition factor in semitone.

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

property winsize¶: float. Window size in seconds (max = 1.0).

FreqShift¶

class FreqShift(input, shift=100, mul=1, add=0)[source]¶

Frequency shifting using single sideband amplitude modulation.

Shifting frequencies means that the input signal can be detuned, where the harmonic components of the signal are shifted out of harmonic alignment with each other, e.g. a signal with harmonics at 100, 200, 300, 400 and 500 Hz, shifted up by 50 Hz, will have harmonics at 150, 250, 350, 450, and 550 Hz.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
shift: float or PyoObject, optional: Amount of shifting in Hertz. Defaults to 100.

>>> s = Server().boot()
>>> s.start()
>>> a = SineLoop(freq=300, feedback=.1, mul=.3)
>>> lf1 = Sine(freq=.04, mul=10)
>>> lf2 = Sine(freq=.05, mul=10)
>>> b = FreqShift(a, shift=lf1, mul=.5).out()
>>> c = FreqShift(a, shift=lf2, mul=.5).out(1)

Public Data Attributes:

`input`	PyoObject.
`shift`	float or PyoObject.

Inherited from PyoObject

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

Public Methods:

`__init__`(input[, shift, mul, add])
`play`([dur, delay])	Start processing without sending samples to output.
`stop`([wait])	Stop processing.
`out`([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
`setInput`(x[, fadetime])	Replace the input attribute.
`setShift`(x)	Replace the shift 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])

play(dur=0, delay=0)[source]¶

Start processing without sending samples to output. This method is called automatically at the object creation.

This method returns self, allowing it to be applied at the object creation.

Args

dur: float, optional: Duration, in seconds, of the object’s activation. The default is 0 and means infinite duration.
delay: float, optional: Delay, in seconds, before the object’s activation. Defaults to 0.

stop(wait=0)[source]¶

Stop processing.

This method returns self, allowing it to be applied at the object creation.

Args

wait: float, optional: Delay, in seconds, before the process is actually stopped. If autoStartChildren is activated in the Server, this value is propagated to the children objects. Defaults to 0.

Note

if the method setStopDelay(x) was called before calling stop(wait) with a positive wait value, the wait value won’t overwrite the value given to setStopDelay for the current object, but will be the one propagated to children objects. This allow to set a waiting time for a specific object with setStopDelay whithout changing the global delay time given to the stop method.

Fader and Adsr objects ignore waiting time given to the stop method because they already implement a delayed processing triggered by the stop call.

out(chnl=0, inc=1, dur=0, delay=0)[source]¶

Start processing and send samples to audio output beginning at chnl.

This method returns self, allowing it to be applied at the object creation.

Args

chnl: int, optional: Physical output assigned to the first audio stream of the object. Defaults to 0.
inc: int, optional: Output channel increment value. Defaults to 1.
dur: float, optional: Duration, in seconds, of the object’s activation. The default is 0 and means infinite duration.
delay: float, optional: Delay, in seconds, before the object’s activation. Defaults to 0.

If chnl >= 0, successive streams increment the output number by inc and wrap around the global number of channels.

If chnl is negative, streams begin at 0, increment the output number by inc and wrap around the global number of channels. Then, the list of streams is scrambled.

If chnl is a list, successive values in the list will be assigned to successive streams.

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

Replace the input attribute.

Parameters:

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

setShift(x)[source]¶

Replace the shift attribute.

Parameters:

x: float or PyoObject: New shift 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 pitch shift.

property shift¶: float or PyoObject. Amount of pitch shift in Hertz.

STRev¶

class STRev(input, inpos=0.5, revtime=1, cutoff=5000, bal=0.5, roomSize=1, firstRefGain=-3, mul=1, add=0)[source]¶

Stereo reverb.

Stereo reverb based on WGVerb (8 delay line FDN reverb). A mono input will produce two audio streams, left and right channels. Therefore, a stereo input will produce four audio streams, left and right channels for each input channel. Position of input streams can be set with the inpos argument. To achieve a stereo reverb, delay line lengths are slightly differents on both channels, but also, pre-delays length and filter cutoff of both channels will be affected to reflect the input position.

Parent

PyoObject

Args

input: PyoObject: Input signal to process.
inpos: float or PyoObject, optional: Position of the source, between 0 and 1. 0 means fully left and 1 means fully right. Defaults to 0.5.
revtime: float or PyoObject, optional: Duration, in seconds, of the reverberated sound, defined as the time needed to the sound to drop 40 dB below its peak. Defaults to 1.
cutoff: float or PyoObject, optional: cutoff frequency, in Hz, of a first order lowpass filters in the feedback loop of delay lines. Defaults to 5000.
bal: float or PyoObject, optional: Balance between wet and dry signal, between 0 and 1. 0 means no reverb. Defaults to 0.5.
roomSize: float, optional: Delay line length scaler, between 0.25 and 4. Values higher than 1 make the delay lines longer and simulate larger rooms. Defaults to 1.
firstRefGain: float, optional: Gain, in dB, of the first reflexions of the room. Defaults to -3.

>>> s = Server().boot()
>>> s.start()
>>> t = SndTable(SNDS_PATH + "/transparent.aif")
>>> sf = Looper(t, dur=t.getDur()*2, xfade=0, mul=0.5)
>>> rev = STRev(sf, inpos=0.25, revtime=2, cutoff=5000, bal=0.25, roomSize=1).out()

Public Data Attributes:

`input`	PyoObject.
`inpos`	float or PyoObject.
`revtime`	float or PyoObject.
`cutoff`	float or PyoObject.
`bal`	float or PyoObject.
`roomSize`	float.
`firstRefGain`	float.

Inherited from PyoObject

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

Public Methods:

`__init__`(input[, inpos, revtime, cutoff, ...])
`setInput`(x[, fadetime])	Replace the input attribute.
`setInpos`(x)	Replace the inpos attribute.
`setRevtime`(x)	Replace the revtime attribute.
`setCutoff`(x)	Replace the cutoff attribute.
`setBal`(x)	Replace the bal attribute.
`setRoomSize`(x)	Set the room size scaler, between 0.25 and 4.
`setFirstRefGain`(x)	Set the gain of the first reflexions.
`reset`()	Reset the memory buffer to zeros.
`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.

setInpos(x)[source]¶

Replace the inpos attribute.

Args

x: float or PyoObject: New inpos attribute.

setRevtime(x)[source]¶

Replace the revtime attribute.

Args

x: float or PyoObject: New revtime attribute.

setCutoff(x)[source]¶

Replace the cutoff attribute.

Args

x: float or PyoObject: New cutoff attribute.

setBal(x)[source]¶

Replace the bal attribute.

Args

x: float or PyoObject: New bal attribute.

setRoomSize(x)[source]¶

Set the room size scaler, between 0.25 and 4.

Args

x: float: Room size scaler, between 0.25 and 4.0.

setFirstRefGain(x)[source]¶

Set the gain of the first reflexions.

Args

x: float: Gain, in dB, of the first reflexions.

reset()[source]¶: Reset the memory buffer to zeros.

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 inpos¶: float or PyoObject. Position of the source.

property revtime¶: float or PyoObject. Room size.

property cutoff¶: float or PyoObject. High frequency damping.

property bal¶: float or PyoObject. Balance between wet and dry signal.

property roomSize¶: float. Room size scaler, between 0.25 and 4.0.

property firstRefGain¶: float. Gain, in dB, of the first reflexions.

SmoothDelay¶

class SmoothDelay(input, delay=0.25, feedback=0, crossfade=0.05, maxdelay=1, mul=1, add=0)[source]¶

Artifact free sweepable recursive delay.

SmoothDelay implements a delay line that does not produce clicks or pitch shifting when the delay time is changing.

Parent

PyoObject

Args

input: PyoObject: Input signal to delayed.
delay: float or PyoObject, optional: Delay time in seconds. Defaults to 0.25.
feedback: float or PyoObject, optional: Amount of output signal sent back into the delay line. Defaults to 0.
crossfade: float, optional: Crossfade time, in seconds, between overlaped readers. Defaults to 0.05.
maxdelay: float, optional: Maximum delay length in seconds. Available only at initialization. Defaults to 1.

Note

The minimum delay time allowed with SmoothDelay is one sample. It can be computed with :

onesamp = 1.0 / s.getSamplingRate()

See also

Delay, Waveguide

>>> s = Server().boot()
>>> s.start()
>>> sf = SfPlayer(SNDS_PATH+"/transparent.aif", loop=True, mul=0.3).mix(2).out()
>>> lf = Sine(freq=0.1, mul=0.24, add=0.25)
>>> sd = SmoothDelay(sf, delay=lf, feedback=0.5, crossfade=0.05, mul=0.7).out()

Public Data Attributes:

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

Inherited from PyoObject

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

Public Methods:

`__init__`(input[, delay, feedback, ...])
`setInput`(x[, fadetime])	Replace the input attribute.
`setDelay`(x)	Replace the delay attribute.
`setFeedback`(x)	Replace the feedback attribute.
`setCrossfade`(x)	Replace the crossfade attribute.
`reset`()	Reset the memory buffer to zeros.
`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 delayed.
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.

setCrossfade(x)[source]¶

Replace the crossfade attribute.

Args

x: float: New crossfade attribute.

reset()[source]¶: Reset the memory buffer to zeros.

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 delayed.

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

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

property crossfade¶: float. Crossfade time, in seconds, between overlaps.

Table of Contents

Search

Special Effects¶

Objects in this category¶

Disto¶

Delay¶

SDelay¶

Delay1¶

Waveguide¶

AllpassWG¶

Freeverb¶

Convolve¶

WGVerb¶

Chorus¶

Harmonizer¶

FreqShift¶

STRev¶

SmoothDelay¶