dawdreamer.FaustProcessor

class dawdreamer.FaustProcessor

A Faust Processor can compile and execute FAUST code. See https://faust.grame.fr for more information.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)

add_midi_note(self, note, velocity, ...[, beats])

Add a single MIDI note whose note and velocity are integers between 0 and 127.

clear_midi(self)

Remove all MIDI notes.

compile(self)

Compile the FAUST object.

compile_box(self, box[, argv])

compile_signals(self, signals[, argv])

get_audio(self)

Get the audio data of the processor after a render, assuming recording was enabled.

get_automation(*args, **kwargs)

Overloaded function.

get_name(self)

Get the user-defined name of a processor instance.

get_num_input_channels(self)

Get the total number of input channels (2 indicates stereo input).

get_num_output_channels(self)

Get the total number of output channels (2 indicates stereo output).

get_parameter(*args, **kwargs)

Overloaded function.

get_parameters_description(self)

Get a list of dictionaries describing the parameters of the most recently compiled FAUST code.

load_midi(self, filepath, *[, ...])

Load MIDI from a file.

save_midi(self, filepath)

After rendering, you can save the MIDI to a file using absolute times (SMPTE format).

set_automation(self, parameter_name, data, *)

Set a parameter's automation with a numpy array.

set_dsp(self, filepath)

Set the FAUST box process with a file.

set_dsp_string(self, faust_code)

Set the FAUST box process with a string containing FAUST code.

set_parameter(*args, **kwargs)

Overloaded function.

set_soundfiles(self, soundfile_dict)

Set the audio data that the FaustProcessor can use with the soundfile primitive.

Attributes

auto_import

The auto import string.

code

Get the most recently compiled Faust DSP code.

compile_flags

List of compilation flags.

compiled

Did the most recent DSP code compile?

dynamic_voices

If enabled (default), voices are dynamically enabled and disabled to save computation.

faust_assets_path

Absolute path to directory containing audio files to be used by Faust.

faust_assets_paths

List of absolute paths to directories containing audio files to be used by Faust.

faust_libraries_path

Absolute path to directory containing your custom ".lib" files containing Faust code.

faust_libraries_paths

List of absolute paths to directories containing your custom ".lib" files containing Faust code.

group_voices

If grouped, all polyphonic voices will share the same parameters.

n_midi_events

The number of MIDI events stored in the buffer.

num_voices

The number of voices for polyphony.

opt_level

LLVM IR to IR optimization level (from -1 to 4, -1 means 'maximum possible value' * since the maximum value may change with new LLVM versions)

record

Whether recording of this processor is enabled.

record_automation

Whether recording of this processor's automation is enabled.

release_length

If using polyphony, specifying the release length accurately can help avoid warnings about voices being stolen.