pyo documentation
pyo is a Python module written in C to help digital signal processing script creation.
pyo is a Python module containing classes for a wide variety of audio signal processing types. With pyo, user will be
able to include signal processing chains directly in Python scripts or projects, and to manipulate them in real time
through the interpreter. Tools in pyo module offer primitives, like mathematical operations on audio signal, basic
signal processing (filters, delays, synthesis generators, etc.), but also complex algorithms to create sound granulation
and others creative sound manipulations. pyo supports OSC protocol (Open Sound Control), to ease communications
between softwares, and MIDI protocol, for generating sound events and controlling process parameters. pyo allows
creation of sophisticated signal processing chains with all the benefits of a mature, and wild used, general programming language.
- Map : Converts value between 0 and 1 on various scales.
- SLMap : Base Map class used to manage control sliders.
- SLMapDur : SLMap with normalized values for a 'dur' slider.
- SLMapFreq : SLMap with normalized values for a 'freq' slider.
- SLMapMul : SLMap with normalized values for a 'mul' slider.
- SLMapPan : SLMap with normalized values for a 'pan' slider.
- SLMapPhase : SLMap with normalized values for a 'phase' slider.
- SLMapQ : SLMap with normalized values for a 'q' slider.
- PyoMatrixObject : Base class for all pyo matrix objects.
- NewMatrix : Create a new matrix ready for recording.
- PyoObject : Base class for all pyo objects that manipulate vectors of samples.
- analysis : Tools to analyze audio signals.
- arithmetic : Tools to perform arithmetic operations on audio signals.
- Abs : Performs a absolute function on audio signal.
- Cos : Performs a cosine function on audio signal.
- Log : Performs a natural log function on audio signal.
- Log10 : Performs a base 10 log function on audio signal.
- Log2 : Performs a base 2 log function on audio signal.
- Pow : Performs a power function on audio signal.
- Sin : Performs a sine function on audio signal.
- Sqrt : Performs a square-root function on audio signal.
- Tan : Performs a tangent function on audio signal.
- controls : Objects designed to create parameter's control at audio rate.
- Adsr : Attack - Decay - Sustain - Release envelope generator.
- Expseg : Trace a series of exponential segments between specified break-points.
- Fader : Fadein - fadeout envelope generator.
- Linseg : Trace a series of line segments between specified break-points.
- Sig : Convert numeric value to PyoObject signal.
- SigTo : Convert numeric value to PyoObject signal with portamento.
- dynamics : Objects to modify the dynamic range and sample quality of audio streams.
- Clip : Clips a signal to a predefined limit.
- Compress : Reduces the dynamic range of an audio signal.
- Degrade : Signal quality reducer.
- effects : Objects to perform specific audio signal processing effects.
- Chorus : 8 modulated delay lines chorus processor.
- Convolve : Implements filtering using circular convolution.
- Delay : Sweepable recursive delay.
- Disto : Arc tangent distortion.
- Freeverb : Implementation of Jezar's Freeverb.
- Harmonizer : Generates harmonizing voices in synchrony with its input.
- SDelay : Simple delay without interpolation.
- WGVerb : 8 delay line mono FDN reverb.
- Waveguide : Basic waveguide model.
- filters : Different kinds of audio filtering operations.
- Allpass : Delay line based allpass filter.
- Allpass2 : Second-order phase shifter allpass.
- BandSplit : Splits an input signal into multiple frequency bands.
- Biquad : A sweepable general purpose biquadratic digital filter.
- Biquadx : A multi-stages sweepable general purpose biquadratic digital filter.
- DCBlock : Implements the DC blocking filter.
- EQ : Equalizer filter.
- Hilbert : Hilbert transform.
- Phaser : Multi-stages second-order phase shifter allpass filters.
- Port : Exponential portamento.
- Tone : A first-order recursive low-pass filter with variable frequency response.
- generators : Synthesis generators.
- FM : A simple frequency modulation generator.
- Input : Read from a numbered channel in an external audio signal.
- Noise : A white noise generator.
- Phasor : A simple phase incrementor.
- Sine : A simple sine wave oscillator.
- SineLoop : A simple sine wave oscillator with feedback.
- internal objects :
- Dummy : Dummy object used to perform arithmetics on PyoObject.
- InputFader : Audio streams crossfader.
- Mix : Mix audio streams to arbitrary number of streams.
- VarPort : Convert numeric value to PyoObject signal with portamento.
- matrixprocess : PyoObjects to perform operations on PyoMatrixObjects.
- MatrixMorph : Morphs between multiple PyoMatrixObjects.
- MatrixPointer : Matrix reader with control on the 2D pointer position.
- MatrixRec : MatrixRec is for writing samples into a previously created NewMatrix.
- midi : Objects to retrieve Midi informations for a specific Midi port.
- Midictl : Get the current value of a Midi channel controller.
- Notein : Generates Midi note messages.
- opensoundcontrol : Objects to manage values on an Open Sound Control port.
- OscReceive : Receives values over a network via the Open Sound Control protocol.
- OscSend : Sends values over a network via the Open Sound Control protocol.
- pan : Objects to place the sound on an arbitrary set of speakers.
- Pan : Cosinus panner with control on the spread factor.
- SPan : Simple equal power panner.
- Selector : Audio selector.
- Switch : Audio switcher.
- patterns :
- CallAfter : Calls a Python function after a given time.
- Pattern : Periodically calls a Python function.
- Score : Calls functions by incrementation of a preformatted name.
- players : Play soundfiles from the disk.
- randoms : Random noise generators.
- Choice : Periodically choose a new value from a user list.
- RandInt : Periodic pseudo-random integer generator.
- Randh : Periodic pseudo-random generator.
- Randi : Periodic pseudo-random generator with interpolation.
- Xnoise : X-class pseudo-random generator.
- XnoiseMidi : X-class midi notes pseudo-random generator.
- tableprocess : PyoObjects to perform operations on PyoTableObjects.
- Granulator : Granular synthesis generator.
- Lookup : Uses table to do waveshaping on an audio signal.
- Looper : Crossfading looper.
- Osc : A simple oscillator reading a waveform table.
- Pointer : Table reader with control on the pointer position.
- Pulsar : Pulsar synthesis oscillator.
- TableIndex : Table reader by sample position without interpolation.
- TableMorph : Morphs between multiple PyoTableObjects.
- TableRead : Simple waveform table reader.
- TableRec : TableRec is for writing samples into a previously created NewTable.
- triggers : Objects to manage triggers streams.
- Beat : Generates algorithmic trigger patterns.
- Change : Sends trigger that informs when input value has changed.
- Cloud : Generates random triggers.
- Counter : Integer count generator.
- Metro : Generates isochronous trigger signals.
- Percent : Lets pass a certain percentage of the input triggers.
- Select : Sends trigger on matching integer values.
- Seq : Generates a rhythmic sequence of trigger signals.
- Thresh : Informs when a signal crosses a threshold.
- Trig : Sends one trigger.
- TrigChoice : Random generator from user's defined values.
- TrigEnv : Envelope reader generator.
- TrigExpseg : Exponential segments trigger.
- TrigFunc : Python function callback.
- TrigLinseg : Line segments trigger.
- TrigRand : Pseudo-random number generator.
- TrigRandInt : Pseudo-random integer generator.
- TrigXnoise : Triggered X-class pseudo-random generator.
- TrigXnoiseMidi : Triggered X-class midi notes pseudo-random generator.
- utils : Miscellaneous objects.
- Clean_objects : Stops and deletes PyoObjects after a given time.
- Compare : Comparison object.
- Interp : Interpolates between two signals.
- Print : Print PyoObject's current value.
- Record : Writes input sound in an audio file on the disk.
- SampHold : Performs a sample-and-hold operation on its input.
- Snap : Snap input values on a user's defined midi scale.
- PyoTableObject : Base class for all pyo table objects.
- ChebyTable : Chebyshev polynomials of the first kind.
- CosTable : Construct a table from cosine interpolated segments.
- CurveTable : Construct a table from curve interpolated segments.
- DataTable : Create an empty table ready for data recording.
- ExpTable : Construct a table from exponential interpolated segments.
- HannTable : Generates Hanning window.
- HarmTable : Harmonic waveform generator.
- LinTable : Construct a table from segments of straight lines in breakpoint fashion.
- NewTable : Create an empty table ready for recording.
- SawTable : Sawtooth waveform generator.
- SndTable : Load data from a soundfile into a function table.
- SquareTable : Square waveform generator.
- Server : Main processing audio loop callback handler.
- Stream : Audio stream objects. For internal use only.
- TableStream : TableStream objects. For internal use only. Must never be instantiated by the user.
- functions :