diff --git a/auxiliary/scripts/auto-generator.py b/auxiliary/scripts/auto-generator.py index 9cf1aa23..d418624a 100755 --- a/auxiliary/scripts/auto-generator.py +++ b/auxiliary/scripts/auto-generator.py @@ -357,22 +357,30 @@ def generate_node_library(node_classes): cls_doc_abs_path = os.path.join(root_directory, folder, cls_doc_path) cls_doc_abs_folder = os.path.dirname(cls_doc_abs_path) os.makedirs(cls_doc_abs_folder, exist_ok=True) + example_scripts = glob.glob(os.path.join(cls_doc_abs_folder, "*.py")) + example_scripts = [os.path.basename(s) for s in example_scripts] with open(cls_doc_abs_path, "w") as fd: + output_markdown_params = ", ".join(("%s=%s" % (param.name, param.default)) \ + for param in cls.constructors[0]) + output_markdown_params = output_markdown_params.replace("nullptr", "None") + fd.write(f"title: {cls.name} node documentation\n") fd.write(f"description: {cls.name}: {cls.docs}\n\n") fd.write( f"[Reference library](../../index.md) > [{folder_title}](../index.md) > [{cls.name}](index.md)\n\n") - fd.write(f"# {cls.name}\n\n") - fd.write(f"{cls.docs}\n\n") - output_markdown_params = ", ".join( - ("%s=%s" % (param.name, param.default)) for param in cls.constructors[0]) - output_markdown_params = output_markdown_params.replace("nullptr", "None") - fd.write(f"Signature:\n") + fd.write(f"# {cls.name}\n\n") fd.write(f"```python\n") fd.write(f"{cls.name}({output_markdown_params})\n") - fd.write(f"```\n") + fd.write(f"```\n\n") + fd.write(f"{cls.docs}\n\n") + if len(example_scripts): + fd.write(f"### Examples\n\n") + for example_script in example_scripts: + fd.write(f"```python\n") + fd.write('{%% include-markdown "./%s" comments=false %%}\n' % example_script) + fd.write(f"```\n\n") def generate_readme(node_classes) -> None: """ diff --git a/docs/library/analysis/crosscorrelate/index.md b/docs/library/analysis/crosscorrelate/index.md index b59e1167..d5a25770 100644 --- a/docs/library/analysis/crosscorrelate/index.md +++ b/docs/library/analysis/crosscorrelate/index.md @@ -5,9 +5,9 @@ description: CrossCorrelate: Outputs the cross-correlation of the input signal w # CrossCorrelate -Outputs the cross-correlation of the input signal with the given buffer. If hop_size is zero, calculates the cross-correlation every sample. - -Signature: ```python CrossCorrelate(input=None, buffer=None, hop_size=0) ``` + +Outputs the cross-correlation of the input signal with the given buffer. If hop_size is zero, calculates the cross-correlation every sample. + diff --git a/docs/library/analysis/onsetdetector/index.md b/docs/library/analysis/onsetdetector/index.md index d8f4bde5..2c6c3d8f 100644 --- a/docs/library/analysis/onsetdetector/index.md +++ b/docs/library/analysis/onsetdetector/index.md @@ -5,9 +5,9 @@ description: OnsetDetector: Simple time-domain onset detector. Outputs an impuls # OnsetDetector -Simple time-domain onset detector. Outputs an impulse when an onset is detected in the input. Maintains short-time and long-time averages. An onset is registered when the short-time average is threshold x the long-time average. min_interval is the minimum interval between onsets, in seconds. - -Signature: ```python OnsetDetector(input=0.0, threshold=2.0, min_interval=0.1) ``` + +Simple time-domain onset detector. Outputs an impulse when an onset is detected in the input. Maintains short-time and long-time averages. An onset is registered when the short-time average is threshold x the long-time average. min_interval is the minimum interval between onsets, in seconds. + diff --git a/docs/library/analysis/vampanalysis/index.md b/docs/library/analysis/vampanalysis/index.md index 33c24df8..ac95ea4e 100644 --- a/docs/library/analysis/vampanalysis/index.md +++ b/docs/library/analysis/vampanalysis/index.md @@ -5,9 +5,9 @@ description: VampAnalysis: Feature extraction using the Vamp plugin toolkit. # VampAnalysis -Feature extraction using the Vamp plugin toolkit. - -Signature: ```python VampAnalysis(input=0.0, plugin_id="vamp-example-plugins:spectralcentroid:linearcentroid") ``` + +Feature extraction using the Vamp plugin toolkit. + diff --git a/docs/library/buffer/beatcutter/index.md b/docs/library/buffer/beatcutter/index.md index fae6907a..1afef751 100644 --- a/docs/library/buffer/beatcutter/index.md +++ b/docs/library/buffer/beatcutter/index.md @@ -5,9 +5,9 @@ description: BeatCutter: Cuts a buffer into segment_count segments, and stutters # BeatCutter -Cuts a buffer into segment_count segments, and stutters/jumps with the given probabilities. - -Signature: ```python BeatCutter(buffer=None, segment_count=8, stutter_probability=0.0, stutter_count=1, jump_probability=0.0, duty_cycle=1.0, rate=1.0, segment_rate=1.0) ``` + +Cuts a buffer into segment_count segments, and stutters/jumps with the given probabilities. + diff --git a/docs/library/buffer/bufferlooper/index.md b/docs/library/buffer/bufferlooper/index.md index 8deb4050..24cd9090 100644 --- a/docs/library/buffer/bufferlooper/index.md +++ b/docs/library/buffer/bufferlooper/index.md @@ -5,9 +5,9 @@ description: BufferLooper: Read and write from a buffer concurrently, with contr # BufferLooper -Read and write from a buffer concurrently, with controllable overdub. - -Signature: ```python BufferLooper(buffer=None, input=0.0, feedback=0.0, loop_playback=false, loop_record=false) ``` + +Read and write from a buffer concurrently, with controllable overdub. + diff --git a/docs/library/buffer/bufferplayer/index.md b/docs/library/buffer/bufferplayer/index.md index 102bdbd8..4c0b8564 100644 --- a/docs/library/buffer/bufferplayer/index.md +++ b/docs/library/buffer/bufferplayer/index.md @@ -5,9 +5,9 @@ description: BufferPlayer: Plays the contents of the given buffer. start_time/en # BufferPlayer -Plays the contents of the given buffer. start_time/end_time are in seconds. When a clock signal is receives, rewinds to the start_time. - -Signature: ```python BufferPlayer(buffer=None, rate=1.0, loop=0, start_time=None, end_time=None, clock=None) ``` + +Plays the contents of the given buffer. start_time/end_time are in seconds. When a clock signal is receives, rewinds to the start_time. + diff --git a/docs/library/buffer/bufferrecorder/index.md b/docs/library/buffer/bufferrecorder/index.md index 652424f8..2012e352 100644 --- a/docs/library/buffer/bufferrecorder/index.md +++ b/docs/library/buffer/bufferrecorder/index.md @@ -5,9 +5,9 @@ description: BufferRecorder: Records the input to a buffer. feedback controls ov # BufferRecorder -Records the input to a buffer. feedback controls overdub. - -Signature: ```python BufferRecorder(buffer=None, input=0.0, feedback=0.0, loop=false) ``` + +Records the input to a buffer. feedback controls overdub. + diff --git a/docs/library/buffer/feedbackbufferreader/index.md b/docs/library/buffer/feedbackbufferreader/index.md index 89a703c7..b7d9eb12 100644 --- a/docs/library/buffer/feedbackbufferreader/index.md +++ b/docs/library/buffer/feedbackbufferreader/index.md @@ -5,9 +5,9 @@ description: FeedbackBufferReader: Counterpart to FeedbackBufferWriter. # FeedbackBufferReader -Counterpart to FeedbackBufferWriter. - -Signature: ```python FeedbackBufferReader(buffer=None) ``` + +Counterpart to FeedbackBufferWriter. + diff --git a/docs/library/buffer/feedbackbufferwriter/index.md b/docs/library/buffer/feedbackbufferwriter/index.md index adaa82c0..bf733d59 100644 --- a/docs/library/buffer/feedbackbufferwriter/index.md +++ b/docs/library/buffer/feedbackbufferwriter/index.md @@ -5,9 +5,9 @@ description: FeedbackBufferWriter: Counterpart to FeedbackBufferReader. # FeedbackBufferWriter -Counterpart to FeedbackBufferReader. - -Signature: ```python FeedbackBufferWriter(buffer=None, input=0.0, delay_time=0.1) ``` + +Counterpart to FeedbackBufferReader. + diff --git a/docs/library/buffer/grainsegments/index.md b/docs/library/buffer/grainsegments/index.md index 33863e48..2990ade6 100644 --- a/docs/library/buffer/grainsegments/index.md +++ b/docs/library/buffer/grainsegments/index.md @@ -5,9 +5,9 @@ description: GrainSegments: GrainSegments # GrainSegments -GrainSegments - -Signature: ```python GrainSegments(buffer=None, clock=0, target=0, offsets={}, values={}, durations={}) ``` + +GrainSegments + diff --git a/docs/library/buffer/granulator/index.md b/docs/library/buffer/granulator/index.md index 0360982b..874f824d 100644 --- a/docs/library/buffer/granulator/index.md +++ b/docs/library/buffer/granulator/index.md @@ -5,9 +5,9 @@ description: Granulator: Granulator. Generates a grain from the given buffer eac # Granulator -Granulator. Generates a grain from the given buffer each time a clock signal is received, with the given duration/rate/pan parameters. The input buffer can be mono or stereo. - -Signature: ```python Granulator(buffer=None, clock=0, pos=0, duration=0.1, pan=0.0, rate=1.0, max_grains=2048) ``` + +Granulator. Generates a grain from the given buffer each time a clock signal is received, with the given duration/rate/pan parameters. The input buffer can be mono or stereo. + diff --git a/docs/library/buffer/segmentplayer/index.md b/docs/library/buffer/segmentplayer/index.md index ad59f5e9..822e22b1 100644 --- a/docs/library/buffer/segmentplayer/index.md +++ b/docs/library/buffer/segmentplayer/index.md @@ -5,9 +5,9 @@ description: SegmentPlayer: Trigger segments of a buffer at the given onset posi # SegmentPlayer -Trigger segments of a buffer at the given onset positions. - -Signature: ```python SegmentPlayer(buffer=None, onsets={}) ``` + +Trigger segments of a buffer at the given onset positions. + diff --git a/docs/library/control/mousedown/index.md b/docs/library/control/mousedown/index.md index 01fe9ee1..7bd05b8e 100644 --- a/docs/library/control/mousedown/index.md +++ b/docs/library/control/mousedown/index.md @@ -5,9 +5,9 @@ description: MouseDown: Outputs 1 if the left mouse button is down, 0 otherwise. # MouseDown -Outputs 1 if the left mouse button is down, 0 otherwise. Currently only supported on macOS. - -Signature: ```python MouseDown(button_index=0) ``` + +Outputs 1 if the left mouse button is down, 0 otherwise. Currently only supported on macOS. + diff --git a/docs/library/control/mousex/index.md b/docs/library/control/mousex/index.md index a43807cb..c604668f 100644 --- a/docs/library/control/mousex/index.md +++ b/docs/library/control/mousex/index.md @@ -5,9 +5,9 @@ description: MouseX: Outputs the normalised cursor X position, from 0 to 1. Curr # MouseX -Outputs the normalised cursor X position, from 0 to 1. Currently only supported on macOS. - -Signature: ```python MouseX() ``` + +Outputs the normalised cursor X position, from 0 to 1. Currently only supported on macOS. + diff --git a/docs/library/control/mousey/index.md b/docs/library/control/mousey/index.md index 086e6622..eec945da 100644 --- a/docs/library/control/mousey/index.md +++ b/docs/library/control/mousey/index.md @@ -5,9 +5,9 @@ description: MouseY: Outputs the normalised cursor Y position, from 0 to 1. Curr # MouseY -Outputs the normalised cursor Y position, from 0 to 1. Currently only supported on macOS. - -Signature: ```python MouseY() ``` + +Outputs the normalised cursor Y position, from 0 to 1. Currently only supported on macOS. + diff --git a/docs/library/envelope/adsrenvelope/index.md b/docs/library/envelope/adsrenvelope/index.md index 4c75a164..9303f4fc 100644 --- a/docs/library/envelope/adsrenvelope/index.md +++ b/docs/library/envelope/adsrenvelope/index.md @@ -5,9 +5,9 @@ description: ADSREnvelope: Attack-decay-sustain-release envelope. Sustain portio # ADSREnvelope -Attack-decay-sustain-release envelope. Sustain portion is held until gate is zero. - -Signature: ```python ADSREnvelope(attack=0.1, decay=0.1, sustain=0.5, release=0.1, gate=0) ``` + +Attack-decay-sustain-release envelope. Sustain portion is held until gate is zero. + diff --git a/docs/library/envelope/asrenvelope/index.md b/docs/library/envelope/asrenvelope/index.md index 4164e7b5..2bf7beec 100644 --- a/docs/library/envelope/asrenvelope/index.md +++ b/docs/library/envelope/asrenvelope/index.md @@ -5,9 +5,9 @@ description: ASREnvelope: Attack-sustain-release envelope. # ASREnvelope -Attack-sustain-release envelope. - -Signature: ```python ASREnvelope(attack=0.1, sustain=0.5, release=0.1, curve=1.0, clock=None) ``` + +Attack-sustain-release envelope. + diff --git a/docs/library/envelope/detectsilence/index.md b/docs/library/envelope/detectsilence/index.md index fadab308..045dae4b 100644 --- a/docs/library/envelope/detectsilence/index.md +++ b/docs/library/envelope/detectsilence/index.md @@ -5,9 +5,9 @@ description: DetectSilence: Detects blocks of silence below the threshold value. # DetectSilence -Detects blocks of silence below the threshold value. Used as an auto-free node to terminate a Patch after processing is complete. - -Signature: ```python DetectSilence(input=None, threshold=0.00001) ``` + +Detects blocks of silence below the threshold value. Used as an auto-free node to terminate a Patch after processing is complete. + diff --git a/docs/library/envelope/envelope/index.md b/docs/library/envelope/envelope/index.md index 86b2d060..046c4217 100644 --- a/docs/library/envelope/envelope/index.md +++ b/docs/library/envelope/envelope/index.md @@ -5,9 +5,9 @@ description: Envelope: Generic envelope constructor, given an array of levels, t # Envelope -Generic envelope constructor, given an array of levels, times and curves. - -Signature: ```python Envelope(levels=std::vector ( ), times=std::vector ( ), curves=std::vector ( ), clock=None, loop=false) ``` + +Generic envelope constructor, given an array of levels, times and curves. + diff --git a/docs/library/envelope/line/index.md b/docs/library/envelope/line/index.md index dc970e3c..63d414ef 100644 --- a/docs/library/envelope/line/index.md +++ b/docs/library/envelope/line/index.md @@ -5,9 +5,9 @@ description: Line: Line segment with the given start/end values and duration. If # Line -Line segment with the given start/end values and duration. If loop is true, repeats indefinitely. Retriggers on a clock signal. - -Signature: ```python Line(start=0.0, end=1.0, time=1.0, loop=0, clock=None) ``` + +Line segment with the given start/end values and duration. If loop is true, repeats indefinitely. Retriggers on a clock signal. + diff --git a/docs/library/envelope/rectangularenvelope/index.md b/docs/library/envelope/rectangularenvelope/index.md index ef2f33d2..44b6899b 100644 --- a/docs/library/envelope/rectangularenvelope/index.md +++ b/docs/library/envelope/rectangularenvelope/index.md @@ -5,9 +5,9 @@ description: RectangularEnvelope: Rectangular envelope with the given sustain du # RectangularEnvelope -Rectangular envelope with the given sustain duration. - -Signature: ```python RectangularEnvelope(sustain_duration=1.0, clock=None) ``` + +Rectangular envelope with the given sustain duration. + diff --git a/docs/library/fft/fft/index.md b/docs/library/fft/fft/index.md index e382131d..3ca1d757 100644 --- a/docs/library/fft/fft/index.md +++ b/docs/library/fft/fft/index.md @@ -5,9 +5,9 @@ description: FFT: Fast Fourier Transform. Takes a time-domain input, and generat # FFT -Fast Fourier Transform. Takes a time-domain input, and generates a frequency-domain (FFT) output. - -Signature: ```python FFT(input=0.0, fft_size=SIGNALFLOW_DEFAULT_FFT_SIZE, hop_size=SIGNALFLOW_DEFAULT_FFT_HOP_SIZE, window_size=0, do_window=true) ``` + +Fast Fourier Transform. Takes a time-domain input, and generates a frequency-domain (FFT) output. + diff --git a/docs/library/fft/fftcontinuousphasevocoder/index.md b/docs/library/fft/fftcontinuousphasevocoder/index.md index 404f946c..26fa112d 100644 --- a/docs/library/fft/fftcontinuousphasevocoder/index.md +++ b/docs/library/fft/fftcontinuousphasevocoder/index.md @@ -5,9 +5,9 @@ description: FFTContinuousPhaseVocoder: Continuous phase vocoder. Requires an FF # FFTContinuousPhaseVocoder -Continuous phase vocoder. Requires an FFT* input. - -Signature: ```python FFTContinuousPhaseVocoder(input=None, rate=1.0) ``` + +Continuous phase vocoder. Requires an FFT* input. + diff --git a/docs/library/fft/fftconvolve/index.md b/docs/library/fft/fftconvolve/index.md index d74c1b5d..9dc03010 100644 --- a/docs/library/fft/fftconvolve/index.md +++ b/docs/library/fft/fftconvolve/index.md @@ -5,9 +5,9 @@ description: FFTConvolve: Frequency-domain convolution, using overlap-add. Usefu # FFTConvolve -Frequency-domain convolution, using overlap-add. Useful for convolution reverb, with the input buffer containing an impulse response. Requires an FFT* input. - -Signature: ```python FFTConvolve(input=None, buffer=None) ``` + +Frequency-domain convolution, using overlap-add. Useful for convolution reverb, with the input buffer containing an impulse response. Requires an FFT* input. + diff --git a/docs/library/fft/fftfindpeaks/index.md b/docs/library/fft/fftfindpeaks/index.md index 2118bb61..d607dc64 100644 --- a/docs/library/fft/fftfindpeaks/index.md +++ b/docs/library/fft/fftfindpeaks/index.md @@ -5,9 +5,9 @@ description: FFTFindPeaks: Find peaks in the FFT magnitude spectrum. Requires an # FFTFindPeaks -Find peaks in the FFT magnitude spectrum. Requires an FFT* input. - -Signature: ```python FFTFindPeaks(input=0, prominence=1, threshold=0.000001, count=SIGNALFLOW_MAX_CHANNELS, interpolate=true) ``` + +Find peaks in the FFT magnitude spectrum. Requires an FFT* input. + diff --git a/docs/library/fft/fftlpf/index.md b/docs/library/fft/fftlpf/index.md index 306a9315..d6b043fc 100644 --- a/docs/library/fft/fftlpf/index.md +++ b/docs/library/fft/fftlpf/index.md @@ -5,9 +5,9 @@ description: FFTLPF: FFT-based brick wall low pass filter. Requires an FFT* inpu # FFTLPF -FFT-based brick wall low pass filter. Requires an FFT* input. - -Signature: ```python FFTLPF(input=0, frequency=2000) ``` + +FFT-based brick wall low pass filter. Requires an FFT* input. + diff --git a/docs/library/fft/fftnoisegate/index.md b/docs/library/fft/fftnoisegate/index.md index 69680bbd..c9c2e9a6 100644 --- a/docs/library/fft/fftnoisegate/index.md +++ b/docs/library/fft/fftnoisegate/index.md @@ -5,9 +5,9 @@ description: FFTNoiseGate: FFT-based noise gate. Requires an FFT* input. # FFTNoiseGate -FFT-based noise gate. Requires an FFT* input. - -Signature: ```python FFTNoiseGate(input=0, threshold=0.5) ``` + +FFT-based noise gate. Requires an FFT* input. + diff --git a/docs/library/fft/fftphasevocoder/index.md b/docs/library/fft/fftphasevocoder/index.md index 57a7acca..9601924a 100644 --- a/docs/library/fft/fftphasevocoder/index.md +++ b/docs/library/fft/fftphasevocoder/index.md @@ -5,9 +5,9 @@ description: FFTPhaseVocoder: Phase vocoder. Requires an FFT* input. # FFTPhaseVocoder -Phase vocoder. Requires an FFT* input. - -Signature: ```python FFTPhaseVocoder(input=None) ``` + +Phase vocoder. Requires an FFT* input. + diff --git a/docs/library/fft/ffttonality/index.md b/docs/library/fft/ffttonality/index.md index 8230fec3..0611da32 100644 --- a/docs/library/fft/ffttonality/index.md +++ b/docs/library/fft/ffttonality/index.md @@ -5,9 +5,9 @@ description: FFTTonality: Tonality filter. Requires an FFT* input. # FFTTonality -Tonality filter. Requires an FFT* input. - -Signature: ```python FFTTonality(input=0, level=0.5, smoothing=0.9) ``` + +Tonality filter. Requires an FFT* input. + diff --git a/docs/library/fft/fftzerophase/index.md b/docs/library/fft/fftzerophase/index.md index 4a2a47a0..5325540c 100644 --- a/docs/library/fft/fftzerophase/index.md +++ b/docs/library/fft/fftzerophase/index.md @@ -5,9 +5,9 @@ description: FFTZeroPhase: Remove phase information from a frequency-domain inpu # FFTZeroPhase -Remove phase information from a frequency-domain input. Requires an FFT* input. - -Signature: ```python FFTZeroPhase(input=0) ``` + +Remove phase information from a frequency-domain input. Requires an FFT* input. + diff --git a/docs/library/fft/ifft/index.md b/docs/library/fft/ifft/index.md index a4fa3b2e..9c98e7ee 100644 --- a/docs/library/fft/ifft/index.md +++ b/docs/library/fft/ifft/index.md @@ -5,9 +5,9 @@ description: IFFT: Inverse Fast Fourier Transform. Requires an FFT* input, gener # IFFT -Inverse Fast Fourier Transform. Requires an FFT* input, generates a time-domain output. - -Signature: ```python IFFT(input=None, do_window=false) ``` + +Inverse Fast Fourier Transform. Requires an FFT* input, generates a time-domain output. + diff --git a/docs/library/index.md b/docs/library/index.md index 9a61dc52..185e3e0e 100644 --- a/docs/library/index.md +++ b/docs/library/index.md @@ -106,7 +106,7 @@ - **[SquareLFO](oscillators/squarelfo/index.md)**: Produces a pulse wave LFO with the given `frequency` and pulsewidth of `width`, ranging from `min` to `max`, where `width` of `0.5` is a square wave. - **[SquareOscillator](oscillators/squareoscillator/index.md)**: Produces a pulse wave with the given `frequency` and pulse `width`, where `width` of `0.5` is a square wave and other `width` values produce a rectangular wave. - **[TriangleLFO](oscillators/trianglelfo/index.md)**: Produces a triangle LFO with the given `frequency` and `phase` offset, ranging from `min` to `max`. -- **[TriangleOscillator](oscillators/triangleoscillator/index.md)**: TriangleOscillator +- **[TriangleOscillator](oscillators/triangleoscillator/index.md)**: Produces a triangle wave with the given `frequency`. - **[Wavetable](oscillators/wavetable/index.md)**: Plays the wavetable stored in buffer at the given `frequency` and `phase` offset. `sync` can be used to provide a hard sync input, which resets the wavetable's phase at each zero-crossing. - **[Wavetable2D](oscillators/wavetable2d/index.md)**: Wavetable2D diff --git a/docs/library/operators/abs/index.md b/docs/library/operators/abs/index.md index 1736d915..333f9896 100644 --- a/docs/library/operators/abs/index.md +++ b/docs/library/operators/abs/index.md @@ -5,9 +5,9 @@ description: Abs: Outputs the absolute value of a, per sample. Can also be writt # Abs -Outputs the absolute value of a, per sample. Can also be written as abs(a) - -Signature: ```python Abs(a=0) ``` + +Outputs the absolute value of a, per sample. Can also be written as abs(a) + diff --git a/docs/library/operators/add/index.md b/docs/library/operators/add/index.md index 4eb65b40..07d28d10 100644 --- a/docs/library/operators/add/index.md +++ b/docs/library/operators/add/index.md @@ -5,9 +5,9 @@ description: Add: Add each sample of a to each sample of b. Can also be written # Add -Add each sample of a to each sample of b. Can also be written as a + b - -Signature: ```python Add(a=0, b=0) ``` + +Add each sample of a to each sample of b. Can also be written as a + b + diff --git a/docs/library/operators/amplitudetodecibels/index.md b/docs/library/operators/amplitudetodecibels/index.md index fb490448..b3c2d90f 100644 --- a/docs/library/operators/amplitudetodecibels/index.md +++ b/docs/library/operators/amplitudetodecibels/index.md @@ -5,9 +5,9 @@ description: AmplitudeToDecibels: Map a linear amplitude value to decibels. # AmplitudeToDecibels -Map a linear amplitude value to decibels. - -Signature: ```python AmplitudeToDecibels(a=0) ``` + +Map a linear amplitude value to decibels. + diff --git a/docs/library/operators/channelarray/index.md b/docs/library/operators/channelarray/index.md index 559dbddb..74c96842 100644 --- a/docs/library/operators/channelarray/index.md +++ b/docs/library/operators/channelarray/index.md @@ -5,9 +5,9 @@ description: ChannelArray: Takes an array of inputs and spreads them across mult # ChannelArray -Takes an array of inputs and spreads them across multiple channels of output. - -Signature: ```python ChannelArray() ``` + +Takes an array of inputs and spreads them across multiple channels of output. + diff --git a/docs/library/operators/channelcrossfade/index.md b/docs/library/operators/channelcrossfade/index.md index 43c119f7..cab9d028 100644 --- a/docs/library/operators/channelcrossfade/index.md +++ b/docs/library/operators/channelcrossfade/index.md @@ -5,9 +5,9 @@ description: ChannelCrossfade: Given a multichannel input, crossfades between ch # ChannelCrossfade -Given a multichannel input, crossfades between channels based on the given position within the virtual array, producing a single-channel output. - -Signature: ```python ChannelCrossfade(input=None, index=None, num_output_channels=1) ``` + +Given a multichannel input, crossfades between channels based on the given position within the virtual array, producing a single-channel output. + diff --git a/docs/library/operators/channelmixer/index.md b/docs/library/operators/channelmixer/index.md index 8796e5db..e17bef94 100644 --- a/docs/library/operators/channelmixer/index.md +++ b/docs/library/operators/channelmixer/index.md @@ -5,9 +5,9 @@ description: ChannelMixer: Downmix a multichannel input to a lower-channel outpu # ChannelMixer -Downmix a multichannel input to a lower-channel output. If num_channels is greater than one, spreads the input channels across the field. If amplitude_compensation is enabled, scale down the amplitude based on the ratio of input to output channels. - -Signature: ```python ChannelMixer(num_channels=1, input=0, amplitude_compensation=true) ``` + +Downmix a multichannel input to a lower-channel output. If num_channels is greater than one, spreads the input channels across the field. If amplitude_compensation is enabled, scale down the amplitude based on the ratio of input to output channels. + diff --git a/docs/library/operators/channelselect/index.md b/docs/library/operators/channelselect/index.md index f5719a79..4bea4e66 100644 --- a/docs/library/operators/channelselect/index.md +++ b/docs/library/operators/channelselect/index.md @@ -5,9 +5,9 @@ description: ChannelSelect: Select a subset of channels from a multichannel inpu # ChannelSelect -Select a subset of channels from a multichannel input, starting at offset, up to a maximum of maximum, with the given step. - -Signature: ```python ChannelSelect(input=None, offset=0, maximum=0, step=1) ``` + +Select a subset of channels from a multichannel input, starting at offset, up to a maximum of maximum, with the given step. + diff --git a/docs/library/operators/cos/index.md b/docs/library/operators/cos/index.md index 37380946..46cf5894 100644 --- a/docs/library/operators/cos/index.md +++ b/docs/library/operators/cos/index.md @@ -5,9 +5,9 @@ description: Cos: Outputs cos(a), per sample. # Cos -Outputs cos(a), per sample. - -Signature: ```python Cos(a=0) ``` + +Outputs cos(a), per sample. + diff --git a/docs/library/operators/decibelstoamplitude/index.md b/docs/library/operators/decibelstoamplitude/index.md index 429fbb8c..3f209d98 100644 --- a/docs/library/operators/decibelstoamplitude/index.md +++ b/docs/library/operators/decibelstoamplitude/index.md @@ -5,9 +5,9 @@ description: DecibelsToAmplitude: DecibelsToAmplitude # DecibelsToAmplitude -DecibelsToAmplitude - -Signature: ```python DecibelsToAmplitude(a=0) ``` + +DecibelsToAmplitude + diff --git a/docs/library/operators/divide/index.md b/docs/library/operators/divide/index.md index 656d99f8..7c7c7c13 100644 --- a/docs/library/operators/divide/index.md +++ b/docs/library/operators/divide/index.md @@ -5,9 +5,9 @@ description: Divide: Divide each sample of a by each sample of b. Can also be wr # Divide -Divide each sample of a by each sample of b. Can also be written as a / b - -Signature: ```python Divide(a=1, b=1) ``` + +Divide each sample of a by each sample of b. Can also be written as a / b + diff --git a/docs/library/operators/equal/index.md b/docs/library/operators/equal/index.md index e66dcd90..0d15092d 100644 --- a/docs/library/operators/equal/index.md +++ b/docs/library/operators/equal/index.md @@ -5,9 +5,9 @@ description: Equal: Compares the output of a to the output of b. Outputs 1 when # Equal -Compares the output of a to the output of b. Outputs 1 when equal, 0 otherwise. Can also be written as a == b - -Signature: ```python Equal(a=0, b=0) ``` + +Compares the output of a to the output of b. Outputs 1 when equal, 0 otherwise. Can also be written as a == b + diff --git a/docs/library/operators/frequencytomidinote/index.md b/docs/library/operators/frequencytomidinote/index.md index db971016..0f3a3284 100644 --- a/docs/library/operators/frequencytomidinote/index.md +++ b/docs/library/operators/frequencytomidinote/index.md @@ -5,9 +5,9 @@ description: FrequencyToMidiNote: Map a frequency to a MIDI note (where 440Hz = # FrequencyToMidiNote -Map a frequency to a MIDI note (where 440Hz = A4 = 69), with floating-point output. - -Signature: ```python FrequencyToMidiNote(a=0) ``` + +Map a frequency to a MIDI note (where 440Hz = A4 = 69), with floating-point output. + diff --git a/docs/library/operators/greaterthan/index.md b/docs/library/operators/greaterthan/index.md index 5d5d876c..897af930 100644 --- a/docs/library/operators/greaterthan/index.md +++ b/docs/library/operators/greaterthan/index.md @@ -5,9 +5,9 @@ description: GreaterThan: Compares the output of a to the output of b. Outputs 1 # GreaterThan -Compares the output of a to the output of b. Outputs 1 when a > b, 0 otherwise. Can also be written as a > b - -Signature: ```python GreaterThan(a=0, b=0) ``` + +Compares the output of a to the output of b. Outputs 1 when a > b, 0 otherwise. Can also be written as a > b + diff --git a/docs/library/operators/greaterthanorequal/index.md b/docs/library/operators/greaterthanorequal/index.md index 9a26d0ba..e5cccf39 100644 --- a/docs/library/operators/greaterthanorequal/index.md +++ b/docs/library/operators/greaterthanorequal/index.md @@ -5,9 +5,9 @@ description: GreaterThanOrEqual: Compares the output of a to the output of b. Ou # GreaterThanOrEqual -Compares the output of a to the output of b. Outputs 1 when a >= b, 0 otherwise. Can also be written as a >= b - -Signature: ```python GreaterThanOrEqual(a=0, b=0) ``` + +Compares the output of a to the output of b. Outputs 1 when a >= b, 0 otherwise. Can also be written as a >= b + diff --git a/docs/library/operators/if/index.md b/docs/library/operators/if/index.md index c3a87ace..0341042b 100644 --- a/docs/library/operators/if/index.md +++ b/docs/library/operators/if/index.md @@ -5,9 +5,9 @@ description: If: Outputs value_if_true for each non-zero value of a, value_if_fa # If -Outputs value_if_true for each non-zero value of a, value_if_false for all other values. - -Signature: ```python If(a=0, value_if_true=0, value_if_false=0) ``` + +Outputs value_if_true for each non-zero value of a, value_if_false for all other values. + diff --git a/docs/library/operators/lessthan/index.md b/docs/library/operators/lessthan/index.md index b9159c63..f39010d5 100644 --- a/docs/library/operators/lessthan/index.md +++ b/docs/library/operators/lessthan/index.md @@ -5,9 +5,9 @@ description: LessThan: Compares the output of a to the output of b. Outputs 1 wh # LessThan -Compares the output of a to the output of b. Outputs 1 when a < b, 0 otherwise. Can also be written as a < b - -Signature: ```python LessThan(a=0, b=0) ``` + +Compares the output of a to the output of b. Outputs 1 when a < b, 0 otherwise. Can also be written as a < b + diff --git a/docs/library/operators/lessthanorequal/index.md b/docs/library/operators/lessthanorequal/index.md index 25ccc19c..27139994 100644 --- a/docs/library/operators/lessthanorequal/index.md +++ b/docs/library/operators/lessthanorequal/index.md @@ -5,9 +5,9 @@ description: LessThanOrEqual: Compares the output of a to the output of b. Outpu # LessThanOrEqual -Compares the output of a to the output of b. Outputs 1 when a <= b, 0 otherwise. Can also be written as a <= b - -Signature: ```python LessThanOrEqual(a=0, b=0) ``` + +Compares the output of a to the output of b. Outputs 1 when a <= b, 0 otherwise. Can also be written as a <= b + diff --git a/docs/library/operators/midinotetofrequency/index.md b/docs/library/operators/midinotetofrequency/index.md index 3c4289cb..94f4a2a4 100644 --- a/docs/library/operators/midinotetofrequency/index.md +++ b/docs/library/operators/midinotetofrequency/index.md @@ -5,9 +5,9 @@ description: MidiNoteToFrequency: Map a MIDI note to a frequency (where 440Hz = # MidiNoteToFrequency -Map a MIDI note to a frequency (where 440Hz = A4 = 69), supporting floating-point input. - -Signature: ```python MidiNoteToFrequency(a=0) ``` + +Map a MIDI note to a frequency (where 440Hz = A4 = 69), supporting floating-point input. + diff --git a/docs/library/operators/modulo/index.md b/docs/library/operators/modulo/index.md index f086840c..1494ee34 100644 --- a/docs/library/operators/modulo/index.md +++ b/docs/library/operators/modulo/index.md @@ -5,9 +5,9 @@ description: Modulo: Outputs the value of a modulo b, per sample. Supports fract # Modulo -Outputs the value of a modulo b, per sample. Supports fractional values. Can also be written as a % b - -Signature: ```python Modulo(a=0, b=0) ``` + +Outputs the value of a modulo b, per sample. Supports fractional values. Can also be written as a % b + diff --git a/docs/library/operators/multiply/index.md b/docs/library/operators/multiply/index.md index b953379e..9b469af4 100644 --- a/docs/library/operators/multiply/index.md +++ b/docs/library/operators/multiply/index.md @@ -5,9 +5,9 @@ description: Multiply: Multiply each sample of a by each sample of b. Can also b # Multiply -Multiply each sample of a by each sample of b. Can also be written as a * b - -Signature: ```python Multiply(a=1.0, b=1.0) ``` + +Multiply each sample of a by each sample of b. Can also be written as a * b + diff --git a/docs/library/operators/notequal/index.md b/docs/library/operators/notequal/index.md index a9decb6d..9553e96f 100644 --- a/docs/library/operators/notequal/index.md +++ b/docs/library/operators/notequal/index.md @@ -5,9 +5,9 @@ description: NotEqual: Compares the output of a to the output of b. Outputs 0 wh # NotEqual -Compares the output of a to the output of b. Outputs 0 when equal, 1 otherwise. Can also be written as a != b - -Signature: ```python NotEqual(a=0, b=0) ``` + +Compares the output of a to the output of b. Outputs 0 when equal, 1 otherwise. Can also be written as a != b + diff --git a/docs/library/operators/pow/index.md b/docs/library/operators/pow/index.md index 389050ad..74f901dc 100644 --- a/docs/library/operators/pow/index.md +++ b/docs/library/operators/pow/index.md @@ -5,9 +5,9 @@ description: Pow: Outputs a to the power of b, per sample. Can also be written a # Pow -Outputs a to the power of b, per sample. Can also be written as a ** b - -Signature: ```python Pow(a=0, b=0) ``` + +Outputs a to the power of b, per sample. Can also be written as a ** b + diff --git a/docs/library/operators/round/index.md b/docs/library/operators/round/index.md index 4d97d247..2b1135dd 100644 --- a/docs/library/operators/round/index.md +++ b/docs/library/operators/round/index.md @@ -5,9 +5,9 @@ description: Round: Round the input to the nearest integer value. # Round -Round the input to the nearest integer value. - -Signature: ```python Round(a=0) ``` + +Round the input to the nearest integer value. + diff --git a/docs/library/operators/roundtoscale/index.md b/docs/library/operators/roundtoscale/index.md index 20271a4c..0da92a57 100644 --- a/docs/library/operators/roundtoscale/index.md +++ b/docs/library/operators/roundtoscale/index.md @@ -5,9 +5,9 @@ description: RoundToScale: Given a frequency input, generates a frequency output # RoundToScale -Given a frequency input, generates a frequency output that is rounded to the nearest MIDI note. (TODO: Not very well named) - -Signature: ```python RoundToScale(a=0) ``` + +Given a frequency input, generates a frequency output that is rounded to the nearest MIDI note. (TODO: Not very well named) + diff --git a/docs/library/operators/scalelinexp/index.md b/docs/library/operators/scalelinexp/index.md index c955115d..c6477204 100644 --- a/docs/library/operators/scalelinexp/index.md +++ b/docs/library/operators/scalelinexp/index.md @@ -5,9 +5,9 @@ description: ScaleLinExp: Scales the input from a linear range (between a and b) # ScaleLinExp -Scales the input from a linear range (between a and b) to an exponential range (between c and d). - -Signature: ```python ScaleLinExp(input=0, a=0, b=1, c=1, d=10) ``` + +Scales the input from a linear range (between a and b) to an exponential range (between c and d). + diff --git a/docs/library/operators/scalelinlin/index.md b/docs/library/operators/scalelinlin/index.md index b1e6a3d2..9177af5e 100644 --- a/docs/library/operators/scalelinlin/index.md +++ b/docs/library/operators/scalelinlin/index.md @@ -5,9 +5,9 @@ description: ScaleLinLin: Scales the input from a linear range (between a and b) # ScaleLinLin -Scales the input from a linear range (between a and b) to a linear range (between c and d). - -Signature: ```python ScaleLinLin(input=0, a=0, b=1, c=1, d=10) ``` + +Scales the input from a linear range (between a and b) to a linear range (between c and d). + diff --git a/docs/library/operators/sin/index.md b/docs/library/operators/sin/index.md index 0e57996d..e0a970d6 100644 --- a/docs/library/operators/sin/index.md +++ b/docs/library/operators/sin/index.md @@ -5,9 +5,9 @@ description: Sin: Outputs sin(a), per sample. # Sin -Outputs sin(a), per sample. - -Signature: ```python Sin(a=0) ``` + +Outputs sin(a), per sample. + diff --git a/docs/library/operators/subtract/index.md b/docs/library/operators/subtract/index.md index 59991d91..878a2791 100644 --- a/docs/library/operators/subtract/index.md +++ b/docs/library/operators/subtract/index.md @@ -5,9 +5,9 @@ description: Subtract: Subtract each sample of b from each sample of a. Can also # Subtract -Subtract each sample of b from each sample of a. Can also be written as a - b - -Signature: ```python Subtract(a=0, b=0) ``` + +Subtract each sample of b from each sample of a. Can also be written as a - b + diff --git a/docs/library/operators/sum/index.md b/docs/library/operators/sum/index.md index b3cae210..40afd0cd 100644 --- a/docs/library/operators/sum/index.md +++ b/docs/library/operators/sum/index.md @@ -5,9 +5,9 @@ description: Sum: Sums the output of all of the input nodes, by sample. # Sum -Sums the output of all of the input nodes, by sample. - -Signature: ```python Sum() ``` + +Sums the output of all of the input nodes, by sample. + diff --git a/docs/library/operators/tan/index.md b/docs/library/operators/tan/index.md index 9106ba4a..f05ad662 100644 --- a/docs/library/operators/tan/index.md +++ b/docs/library/operators/tan/index.md @@ -5,9 +5,9 @@ description: Tan: Outputs tan(a), per sample. # Tan -Outputs tan(a), per sample. - -Signature: ```python Tan(a=0) ``` + +Outputs tan(a), per sample. + diff --git a/docs/library/operators/tanh/index.md b/docs/library/operators/tanh/index.md index e95581a2..c13d5389 100644 --- a/docs/library/operators/tanh/index.md +++ b/docs/library/operators/tanh/index.md @@ -5,9 +5,9 @@ description: Tanh: Outputs tanh(a), per sample. Can be used as a soft clipper. # Tanh -Outputs tanh(a), per sample. Can be used as a soft clipper. - -Signature: ```python Tanh(a=0) ``` + +Outputs tanh(a), per sample. Can be used as a soft clipper. + diff --git a/docs/library/oscillators/constant/index.md b/docs/library/oscillators/constant/index.md index 270fce23..2c2df89e 100644 --- a/docs/library/oscillators/constant/index.md +++ b/docs/library/oscillators/constant/index.md @@ -5,9 +5,9 @@ description: Constant: Produces a constant value. # Constant -Produces a constant value. - -Signature: ```python Constant(value=0) ``` + +Produces a constant value. + diff --git a/docs/library/oscillators/impulse/index.md b/docs/library/oscillators/impulse/index.md index 12b3c81d..dc463252 100644 --- a/docs/library/oscillators/impulse/index.md +++ b/docs/library/oscillators/impulse/index.md @@ -5,9 +5,9 @@ description: Impulse: Produces a value of 1 at the given `frequency`, with outpu # Impulse -Produces a value of 1 at the given `frequency`, with output of 0 at all other times. If frequency is 0, produces a single impulse. - -Signature: ```python Impulse(frequency=1.0) ``` + +Produces a value of 1 at the given `frequency`, with output of 0 at all other times. If frequency is 0, produces a single impulse. + diff --git a/docs/library/oscillators/index.md b/docs/library/oscillators/index.md index 11c5edbf..88495ddc 100644 --- a/docs/library/oscillators/index.md +++ b/docs/library/oscillators/index.md @@ -11,6 +11,6 @@ - **[SquareLFO](squarelfo/index.md)**: Produces a pulse wave LFO with the given `frequency` and pulsewidth of `width`, ranging from `min` to `max`, where `width` of `0.5` is a square wave. - **[SquareOscillator](squareoscillator/index.md)**: Produces a pulse wave with the given `frequency` and pulse `width`, where `width` of `0.5` is a square wave and other `width` values produce a rectangular wave. - **[TriangleLFO](trianglelfo/index.md)**: Produces a triangle LFO with the given `frequency` and `phase` offset, ranging from `min` to `max`. -- **[TriangleOscillator](triangleoscillator/index.md)**: TriangleOscillator +- **[TriangleOscillator](triangleoscillator/index.md)**: Produces a triangle wave with the given `frequency`. - **[Wavetable](wavetable/index.md)**: Plays the wavetable stored in buffer at the given `frequency` and `phase` offset. `sync` can be used to provide a hard sync input, which resets the wavetable's phase at each zero-crossing. - **[Wavetable2D](wavetable2d/index.md)**: Wavetable2D diff --git a/docs/library/oscillators/sawlfo/index.md b/docs/library/oscillators/sawlfo/index.md index 5168c723..92267521 100644 --- a/docs/library/oscillators/sawlfo/index.md +++ b/docs/library/oscillators/sawlfo/index.md @@ -5,9 +5,9 @@ description: SawLFO: Produces a sawtooth LFO, with output ranging from `min` to # SawLFO -Produces a sawtooth LFO, with output ranging from `min` to `max`. - -Signature: ```python SawLFO(frequency=1.0, min=0.0, max=1.0, phase=0.0) ``` + +Produces a sawtooth LFO, with output ranging from `min` to `max`. + diff --git a/docs/library/oscillators/sawoscillator/index.md b/docs/library/oscillators/sawoscillator/index.md index 05ee57df..4d90e560 100644 --- a/docs/library/oscillators/sawoscillator/index.md +++ b/docs/library/oscillators/sawoscillator/index.md @@ -5,9 +5,9 @@ description: SawOscillator: Produces a (non-band-limited) sawtooth wave, with th # SawOscillator -Produces a (non-band-limited) sawtooth wave, with the given `frequency` and `phase` offset. When a `reset` or trigger is received, resets the phase to zero. - -Signature: ```python SawOscillator(frequency=440, phase=None, reset=None) ``` + +Produces a (non-band-limited) sawtooth wave, with the given `frequency` and `phase` offset. When a `reset` or trigger is received, resets the phase to zero. + diff --git a/docs/library/oscillators/sinelfo/example-0.py b/docs/library/oscillators/sinelfo/example-0.py new file mode 100644 index 00000000..1191df32 --- /dev/null +++ b/docs/library/oscillators/sinelfo/example-0.py @@ -0,0 +1,8 @@ +from signalflow import * +graph = AudioGraph() + +# Siren effect, using a sinewave LFO to modulate a sawtooth's frequency +lfo = SineLFO(1, 200, 1000) +saw = SawOscillator(lfo) +saw.play() +graph.wait() diff --git a/docs/library/oscillators/sinelfo/index.md b/docs/library/oscillators/sinelfo/index.md index e5d8ae85..9ab38848 100644 --- a/docs/library/oscillators/sinelfo/index.md +++ b/docs/library/oscillators/sinelfo/index.md @@ -5,9 +5,15 @@ description: SineLFO: Produces a sinusoidal LFO at the given `frequency` and `ph # SineLFO +```python +SineLFO(frequency=1.0, min=0.0, max=1.0, phase=0.0) +``` + Produces a sinusoidal LFO at the given `frequency` and `phase` offset, with output ranging from `min` to `max`. -Signature: +### Examples + ```python -SineLFO(frequency=1.0, min=0.0, max=1.0, phase=0.0) +{% include-markdown "./example-0.py" comments=false %} ``` + diff --git a/docs/library/oscillators/sineoscillator/index.md b/docs/library/oscillators/sineoscillator/index.md index 0890ccfd..2a7bacd7 100644 --- a/docs/library/oscillators/sineoscillator/index.md +++ b/docs/library/oscillators/sineoscillator/index.md @@ -5,9 +5,9 @@ description: SineOscillator: Produces a sine wave at the given `frequency`. # SineOscillator -Produces a sine wave at the given `frequency`. - -Signature: ```python SineOscillator(frequency=440) ``` + +Produces a sine wave at the given `frequency`. + diff --git a/docs/library/oscillators/squarelfo/index.md b/docs/library/oscillators/squarelfo/index.md index b091110d..5b544c68 100644 --- a/docs/library/oscillators/squarelfo/index.md +++ b/docs/library/oscillators/squarelfo/index.md @@ -5,9 +5,9 @@ description: SquareLFO: Produces a pulse wave LFO with the given `frequency` and # SquareLFO -Produces a pulse wave LFO with the given `frequency` and pulsewidth of `width`, ranging from `min` to `max`, where `width` of `0.5` is a square wave. - -Signature: ```python SquareLFO(frequency=1.0, min=0.0, max=1.0, width=0.5, phase=0.0) ``` + +Produces a pulse wave LFO with the given `frequency` and pulsewidth of `width`, ranging from `min` to `max`, where `width` of `0.5` is a square wave. + diff --git a/docs/library/oscillators/squareoscillator/index.md b/docs/library/oscillators/squareoscillator/index.md index 7c9ec564..37091869 100644 --- a/docs/library/oscillators/squareoscillator/index.md +++ b/docs/library/oscillators/squareoscillator/index.md @@ -5,9 +5,9 @@ description: SquareOscillator: Produces a pulse wave with the given `frequency` # SquareOscillator -Produces a pulse wave with the given `frequency` and pulse `width`, where `width` of `0.5` is a square wave and other `width` values produce a rectangular wave. - -Signature: ```python SquareOscillator(frequency=440, width=0.5) ``` + +Produces a pulse wave with the given `frequency` and pulse `width`, where `width` of `0.5` is a square wave and other `width` values produce a rectangular wave. + diff --git a/docs/library/oscillators/trianglelfo/index.md b/docs/library/oscillators/trianglelfo/index.md index 4c779e8c..dc77239c 100644 --- a/docs/library/oscillators/trianglelfo/index.md +++ b/docs/library/oscillators/trianglelfo/index.md @@ -5,9 +5,9 @@ description: TriangleLFO: Produces a triangle LFO with the given `frequency` and # TriangleLFO -Produces a triangle LFO with the given `frequency` and `phase` offset, ranging from `min` to `max`. - -Signature: ```python TriangleLFO(frequency=1.0, min=0.0, max=1.0, phase=0.0) ``` + +Produces a triangle LFO with the given `frequency` and `phase` offset, ranging from `min` to `max`. + diff --git a/docs/library/oscillators/triangleoscillator/index.md b/docs/library/oscillators/triangleoscillator/index.md index 27c5af36..b305a1a3 100644 --- a/docs/library/oscillators/triangleoscillator/index.md +++ b/docs/library/oscillators/triangleoscillator/index.md @@ -1,13 +1,13 @@ title: TriangleOscillator node documentation -description: TriangleOscillator: TriangleOscillator +description: TriangleOscillator: Produces a triangle wave with the given `frequency`. [Reference library](../../index.md) > [Oscillators](../index.md) > [TriangleOscillator](index.md) # TriangleOscillator -TriangleOscillator - -Signature: ```python TriangleOscillator(frequency=440) ``` + +Produces a triangle wave with the given `frequency`. + diff --git a/docs/library/oscillators/wavetable/index.md b/docs/library/oscillators/wavetable/index.md index ac98b9c5..e4ad42ae 100644 --- a/docs/library/oscillators/wavetable/index.md +++ b/docs/library/oscillators/wavetable/index.md @@ -5,9 +5,9 @@ description: Wavetable: Plays the wavetable stored in buffer at the given `frequ # Wavetable -Plays the wavetable stored in buffer at the given `frequency` and `phase` offset. `sync` can be used to provide a hard sync input, which resets the wavetable's phase at each zero-crossing. - -Signature: ```python Wavetable(buffer=None, frequency=440, phase=0, sync=0, phase_map=None) ``` + +Plays the wavetable stored in buffer at the given `frequency` and `phase` offset. `sync` can be used to provide a hard sync input, which resets the wavetable's phase at each zero-crossing. + diff --git a/docs/library/oscillators/wavetable2d/index.md b/docs/library/oscillators/wavetable2d/index.md index bcad3753..4ac62354 100644 --- a/docs/library/oscillators/wavetable2d/index.md +++ b/docs/library/oscillators/wavetable2d/index.md @@ -5,9 +5,9 @@ description: Wavetable2D: Wavetable2D # Wavetable2D -Wavetable2D - -Signature: ```python Wavetable2D(buffer=None, frequency=440, crossfade=0.0, phase=0.0, sync=0) ``` + +Wavetable2D + diff --git a/docs/library/processors/clip/index.md b/docs/library/processors/clip/index.md index 9b973934..cd2bcac4 100644 --- a/docs/library/processors/clip/index.md +++ b/docs/library/processors/clip/index.md @@ -5,9 +5,9 @@ description: Clip: Clip the input to `min`/`max`. # Clip -Clip the input to `min`/`max`. - -Signature: ```python Clip(input=None, min=-1.0, max=1.0) ``` + +Clip the input to `min`/`max`. + diff --git a/docs/library/processors/delays/allpassdelay/index.md b/docs/library/processors/delays/allpassdelay/index.md index 8633d588..ac4ee275 100644 --- a/docs/library/processors/delays/allpassdelay/index.md +++ b/docs/library/processors/delays/allpassdelay/index.md @@ -5,9 +5,9 @@ description: AllpassDelay: All-pass delay, with `feedback` between 0 and 1. `del # AllpassDelay -All-pass delay, with `feedback` between 0 and 1. `delay_time` must be less than or equal to `max_delay_time`. - -Signature: ```python AllpassDelay(input=0.0, delay_time=0.1, feedback=0.5, max_delay_time=0.5) ``` + +All-pass delay, with `feedback` between 0 and 1. `delay_time` must be less than or equal to `max_delay_time`. + diff --git a/docs/library/processors/delays/combdelay/index.md b/docs/library/processors/delays/combdelay/index.md index 0eef3d5e..c15580ae 100644 --- a/docs/library/processors/delays/combdelay/index.md +++ b/docs/library/processors/delays/combdelay/index.md @@ -5,9 +5,9 @@ description: CombDelay: Comb delay, with `feedback` between 0 and 1. `delay_time # CombDelay -Comb delay, with `feedback` between 0 and 1. `delay_time` must be less than or equal to `max_delay_time`. - -Signature: ```python CombDelay(input=0.0, delay_time=0.1, feedback=0.5, max_delay_time=0.5) ``` + +Comb delay, with `feedback` between 0 and 1. `delay_time` must be less than or equal to `max_delay_time`. + diff --git a/docs/library/processors/delays/onetapdelay/index.md b/docs/library/processors/delays/onetapdelay/index.md index 4612f806..9b917b2f 100644 --- a/docs/library/processors/delays/onetapdelay/index.md +++ b/docs/library/processors/delays/onetapdelay/index.md @@ -5,9 +5,9 @@ description: OneTapDelay: Single-tap delay line. `delay_time` must be less than # OneTapDelay -Single-tap delay line. `delay_time` must be less than or equal to `max_delay_time`. - -Signature: ```python OneTapDelay(input=0.0, delay_time=0.1, max_delay_time=0.5) ``` + +Single-tap delay line. `delay_time` must be less than or equal to `max_delay_time`. + diff --git a/docs/library/processors/delays/stutter/index.md b/docs/library/processors/delays/stutter/index.md index 131144c5..66ce5fb1 100644 --- a/docs/library/processors/delays/stutter/index.md +++ b/docs/library/processors/delays/stutter/index.md @@ -5,9 +5,9 @@ description: Stutter: Stutters the input whenever a trigger is received on `cloc # Stutter -Stutters the input whenever a trigger is received on `clock`. Generates `stutter_count` repeats, with duration of `stutter_time`. - -Signature: ```python Stutter(input=0.0, stutter_time=0.1, stutter_count=1, clock=None, max_stutter_time=1.0) ``` + +Stutters the input whenever a trigger is received on `clock`. Generates `stutter_count` repeats, with duration of `stutter_time`. + diff --git a/docs/library/processors/distortion/resample/index.md b/docs/library/processors/distortion/resample/index.md index 6a18481f..74798faf 100644 --- a/docs/library/processors/distortion/resample/index.md +++ b/docs/library/processors/distortion/resample/index.md @@ -5,9 +5,9 @@ description: Resample: Resampler and bit crusher. `sample_rate` is in Hz, `bit_r # Resample -Resampler and bit crusher. `sample_rate` is in Hz, `bit_rate` is an integer between 0 and 16. - -Signature: ```python Resample(input=0, sample_rate=44100, bit_rate=16) ``` + +Resampler and bit crusher. `sample_rate` is in Hz, `bit_rate` is an integer between 0 and 16. + diff --git a/docs/library/processors/distortion/sampleandhold/index.md b/docs/library/processors/distortion/sampleandhold/index.md index 678b659a..179195c8 100644 --- a/docs/library/processors/distortion/sampleandhold/index.md +++ b/docs/library/processors/distortion/sampleandhold/index.md @@ -5,9 +5,9 @@ description: SampleAndHold: Samples and holds the input each time a trigger is r # SampleAndHold -Samples and holds the input each time a trigger is received on `clock`. - -Signature: ```python SampleAndHold(input=None, clock=None) ``` + +Samples and holds the input each time a trigger is received on `clock`. + diff --git a/docs/library/processors/distortion/squiz/index.md b/docs/library/processors/distortion/squiz/index.md index 52029df5..e1273d9f 100644 --- a/docs/library/processors/distortion/squiz/index.md +++ b/docs/library/processors/distortion/squiz/index.md @@ -5,9 +5,9 @@ description: Squiz: Implementation of Dan Stowell's Squiz algorithm, a kind of d # Squiz -Implementation of Dan Stowell's Squiz algorithm, a kind of downsampler. - -Signature: ```python Squiz(input=0.0, rate=2.0, chunk_size=1) ``` + +Implementation of Dan Stowell's Squiz algorithm, a kind of downsampler. + diff --git a/docs/library/processors/distortion/waveshaper/index.md b/docs/library/processors/distortion/waveshaper/index.md index 01a3d7bb..af7fde83 100644 --- a/docs/library/processors/distortion/waveshaper/index.md +++ b/docs/library/processors/distortion/waveshaper/index.md @@ -5,9 +5,9 @@ description: WaveShaper: Applies wave-shaping as described in `buffer`. # WaveShaper -Applies wave-shaping as described in `buffer`. - -Signature: ```python WaveShaper(input=0.0, buffer=None) ``` + +Applies wave-shaping as described in `buffer`. + diff --git a/docs/library/processors/dynamics/compressor/index.md b/docs/library/processors/dynamics/compressor/index.md index 72f1c826..a5ef1110 100644 --- a/docs/library/processors/dynamics/compressor/index.md +++ b/docs/library/processors/dynamics/compressor/index.md @@ -5,9 +5,9 @@ description: Compressor: Dynamic range compression, with optional `sidechain` in # Compressor -Dynamic range compression, with optional `sidechain` input. When the input amplitude is above `threshold`, compresses the amplitude with the given `ratio`, following the given `attack_time` and `release_time` in seconds. - -Signature: ```python Compressor(input=0.0, threshold=0.1, ratio=2, attack_time=0.01, release_time=0.1, sidechain=None) ``` + +Dynamic range compression, with optional `sidechain` input. When the input amplitude is above `threshold`, compresses the amplitude with the given `ratio`, following the given `attack_time` and `release_time` in seconds. + diff --git a/docs/library/processors/dynamics/gate/index.md b/docs/library/processors/dynamics/gate/index.md index 63370128..9012c2d7 100644 --- a/docs/library/processors/dynamics/gate/index.md +++ b/docs/library/processors/dynamics/gate/index.md @@ -5,9 +5,9 @@ description: Gate: Outputs the input value when it is above the given `threshold # Gate -Outputs the input value when it is above the given `threshold`, otherwise zero. - -Signature: ```python Gate(input=0.0, threshold=0.1) ``` + +Outputs the input value when it is above the given `threshold`, otherwise zero. + diff --git a/docs/library/processors/dynamics/maximiser/index.md b/docs/library/processors/dynamics/maximiser/index.md index 132f8196..c2dfd5e0 100644 --- a/docs/library/processors/dynamics/maximiser/index.md +++ b/docs/library/processors/dynamics/maximiser/index.md @@ -5,9 +5,9 @@ description: Maximiser: Gain maximiser. # Maximiser -Gain maximiser. - -Signature: ```python Maximiser(input=0.0, ceiling=0.5, attack_time=1.0, release_time=1.0) ``` + +Gain maximiser. + diff --git a/docs/library/processors/dynamics/rms/index.md b/docs/library/processors/dynamics/rms/index.md index ae56a42e..09d92e5c 100644 --- a/docs/library/processors/dynamics/rms/index.md +++ b/docs/library/processors/dynamics/rms/index.md @@ -5,9 +5,9 @@ description: RMS: Outputs the root-mean-squared value of the input, in buffers e # RMS -Outputs the root-mean-squared value of the input, in buffers equal to the graph's current buffer size. - -Signature: ```python RMS(input=0.0) ``` + +Outputs the root-mean-squared value of the input, in buffers equal to the graph's current buffer size. + diff --git a/docs/library/processors/filters/biquadfilter/index.md b/docs/library/processors/filters/biquadfilter/index.md index 1af9a88d..63d686a2 100644 --- a/docs/library/processors/filters/biquadfilter/index.md +++ b/docs/library/processors/filters/biquadfilter/index.md @@ -5,9 +5,9 @@ description: BiquadFilter: Biquad filter. filter_type can be 'low_pass', 'band_p # BiquadFilter -Biquad filter. filter_type can be 'low_pass', 'band_pass', 'high_pass', 'notch', 'peak', 'low_shelf', 'high_shelf'. Not recommended for real-time modulation; for this, use SVFilter. - -Signature: ```python BiquadFilter(input=0.0, filter_type=SIGNALFLOW_FILTER_TYPE_LOW_PASS, cutoff=440, resonance=0.0, peak_gain=0.0) ``` + +Biquad filter. filter_type can be 'low_pass', 'band_pass', 'high_pass', 'notch', 'peak', 'low_shelf', 'high_shelf'. Not recommended for real-time modulation; for this, use SVFilter. + diff --git a/docs/library/processors/filters/dcfilter/index.md b/docs/library/processors/filters/dcfilter/index.md index 244f640a..46fcca27 100644 --- a/docs/library/processors/filters/dcfilter/index.md +++ b/docs/library/processors/filters/dcfilter/index.md @@ -5,9 +5,9 @@ description: DCFilter: Remove low-frequency and DC content from a signal. # DCFilter -Remove low-frequency and DC content from a signal. - -Signature: ```python DCFilter(input=0.0) ``` + +Remove low-frequency and DC content from a signal. + diff --git a/docs/library/processors/filters/eq/index.md b/docs/library/processors/filters/eq/index.md index 56e43543..cf687ea1 100644 --- a/docs/library/processors/filters/eq/index.md +++ b/docs/library/processors/filters/eq/index.md @@ -5,9 +5,9 @@ description: EQ: Three-band EQ. # EQ -Three-band EQ. - -Signature: ```python EQ(input=0.0, low_gain=1.0, mid_gain=1.0, high_gain=1.0, low_freq=500, high_freq=5000) ``` + +Three-band EQ. + diff --git a/docs/library/processors/filters/moogvcf/index.md b/docs/library/processors/filters/moogvcf/index.md index 5630d907..9609aeb2 100644 --- a/docs/library/processors/filters/moogvcf/index.md +++ b/docs/library/processors/filters/moogvcf/index.md @@ -5,9 +5,9 @@ description: MoogVCF: Moog ladder low-pass filter. # MoogVCF -Moog ladder low-pass filter. - -Signature: ```python MoogVCF(input=0.0, cutoff=200.0, resonance=0.0) ``` + +Moog ladder low-pass filter. + diff --git a/docs/library/processors/filters/svfilter/index.md b/docs/library/processors/filters/svfilter/index.md index 054cb680..1f221196 100644 --- a/docs/library/processors/filters/svfilter/index.md +++ b/docs/library/processors/filters/svfilter/index.md @@ -5,9 +5,9 @@ description: SVFilter: State variable filter. `filter_type` can be 'low_pass', ' # SVFilter -State variable filter. `filter_type` can be 'low_pass', 'band_pass', 'high_pass', 'notch', 'peak', 'low_shelf', 'high_shelf'. `resonance` should be between `[0..1]`. - -Signature: ```python SVFilter(input=0.0, filter_type=SIGNALFLOW_FILTER_TYPE_LOW_PASS, cutoff=440, resonance=0.0) ``` + +State variable filter. `filter_type` can be 'low_pass', 'band_pass', 'high_pass', 'notch', 'peak', 'low_shelf', 'high_shelf'. `resonance` should be between `[0..1]`. + diff --git a/docs/library/processors/fold/index.md b/docs/library/processors/fold/index.md index c1d32d9e..d811b990 100644 --- a/docs/library/processors/fold/index.md +++ b/docs/library/processors/fold/index.md @@ -5,9 +5,9 @@ description: Fold: Fold the input beyond `min`/`max`, reflecting the excess back # Fold -Fold the input beyond `min`/`max`, reflecting the excess back. - -Signature: ```python Fold(input=None, min=-1.0, max=1.0) ``` + +Fold the input beyond `min`/`max`, reflecting the excess back. + diff --git a/docs/library/processors/panning/azimuthpanner/index.md b/docs/library/processors/panning/azimuthpanner/index.md index f24d9306..816b28c2 100644 --- a/docs/library/processors/panning/azimuthpanner/index.md +++ b/docs/library/processors/panning/azimuthpanner/index.md @@ -5,9 +5,9 @@ description: AzimuthPanner: Pan input around an equally-spaced ring of `num_chan # AzimuthPanner -Pan input around an equally-spaced ring of `num_channels` speakers. `pan` is the pan position from -1..+1, where 0 = centre front. `width` is the source's width, where 1.0 spans exactly between an adjacent pair of channels. - -Signature: ```python AzimuthPanner(num_channels=2, input=0, pan=0.0, width=1.0) ``` + +Pan input around an equally-spaced ring of `num_channels` speakers. `pan` is the pan position from -1..+1, where 0 = centre front. `width` is the source's width, where 1.0 spans exactly between an adjacent pair of channels. + diff --git a/docs/library/processors/panning/channelpanner/index.md b/docs/library/processors/panning/channelpanner/index.md index 7aea0472..9a2ec644 100644 --- a/docs/library/processors/panning/channelpanner/index.md +++ b/docs/library/processors/panning/channelpanner/index.md @@ -5,9 +5,9 @@ description: ChannelPanner: Pan the input between a linear series of channels, w # ChannelPanner -Pan the input between a linear series of channels, where `pan` 0 = channel 0, 1 = channel 1, etc. No wrapping is applied. - -Signature: ```python ChannelPanner(num_channels=2, input=0, pan=0.0, width=1.0) ``` + +Pan the input between a linear series of channels, where `pan` 0 = channel 0, 1 = channel 1, etc. No wrapping is applied. + diff --git a/docs/library/processors/panning/spatialpanner/index.md b/docs/library/processors/panning/spatialpanner/index.md index 82c1a799..dfd41197 100644 --- a/docs/library/processors/panning/spatialpanner/index.md +++ b/docs/library/processors/panning/spatialpanner/index.md @@ -5,9 +5,9 @@ description: SpatialPanner: Implements a spatial panning algorithm, applied to a # SpatialPanner -Implements a spatial panning algorithm, applied to a given SpatialEnvironment. Currently, only DBAP is supported. - -Signature: ```python SpatialPanner(env=None, input=0.0, x=0.0, y=0.0, z=0.0, radius=1.0, algorithm="dbap") ``` + +Implements a spatial panning algorithm, applied to a given SpatialEnvironment. Currently, only DBAP is supported. + diff --git a/docs/library/processors/panning/stereobalance/index.md b/docs/library/processors/panning/stereobalance/index.md index 9338b82d..babb85bf 100644 --- a/docs/library/processors/panning/stereobalance/index.md +++ b/docs/library/processors/panning/stereobalance/index.md @@ -5,9 +5,9 @@ description: StereoBalance: Takes a stereo input and rebalances it, where `balan # StereoBalance -Takes a stereo input and rebalances it, where `balance` of `0` is unchanged, `-1` is hard left, and `1` is hard right. - -Signature: ```python StereoBalance(input=0, balance=0) ``` + +Takes a stereo input and rebalances it, where `balance` of `0` is unchanged, `-1` is hard left, and `1` is hard right. + diff --git a/docs/library/processors/panning/stereopanner/index.md b/docs/library/processors/panning/stereopanner/index.md index 52d446b8..cb30a219 100644 --- a/docs/library/processors/panning/stereopanner/index.md +++ b/docs/library/processors/panning/stereopanner/index.md @@ -5,9 +5,9 @@ description: StereoPanner: Pans a mono input to a stereo output. `pan` should be # StereoPanner -Pans a mono input to a stereo output. `pan` should be between -1 (hard left) to +1 (hard right), with 0 = centre. - -Signature: ```python StereoPanner(input=0, pan=0.0) ``` + +Pans a mono input to a stereo output. `pan` should be between -1 (hard left) to +1 (hard right), with 0 = centre. + diff --git a/docs/library/processors/panning/stereowidth/index.md b/docs/library/processors/panning/stereowidth/index.md index d611ca39..cb3be16c 100644 --- a/docs/library/processors/panning/stereowidth/index.md +++ b/docs/library/processors/panning/stereowidth/index.md @@ -5,9 +5,9 @@ description: StereoWidth: Reduces the width of a stereo signal. When `width` = 1 # StereoWidth -Reduces the width of a stereo signal. When `width` = 1, input is unchanged. When `width` = 0, outputs a pair of identical channels both containing L+R. - -Signature: ```python StereoWidth(input=0, width=1) ``` + +Reduces the width of a stereo signal. When `width` = 1, input is unchanged. When `width` = 0, outputs a pair of identical channels both containing L+R. + diff --git a/docs/library/processors/smooth/index.md b/docs/library/processors/smooth/index.md index 160b158d..18bd6619 100644 --- a/docs/library/processors/smooth/index.md +++ b/docs/library/processors/smooth/index.md @@ -5,9 +5,9 @@ description: Smooth: Smooth the input with a given smoothing coefficient. When ` # Smooth -Smooth the input with a given smoothing coefficient. When `smooth` = 0, applies no smoothing. - -Signature: ```python Smooth(input=None, smooth=0.99) ``` + +Smooth the input with a given smoothing coefficient. When `smooth` = 0, applies no smoothing. + diff --git a/docs/library/processors/wetdry/index.md b/docs/library/processors/wetdry/index.md index 0e823637..5ac8b752 100644 --- a/docs/library/processors/wetdry/index.md +++ b/docs/library/processors/wetdry/index.md @@ -5,9 +5,9 @@ description: WetDry: Takes `wet` and `dry` inputs, and outputs a mix determined # WetDry -Takes `wet` and `dry` inputs, and outputs a mix determined by `wetness`. - -Signature: ```python WetDry(dry_input=None, wet_input=None, wetness=0.0) ``` + +Takes `wet` and `dry` inputs, and outputs a mix determined by `wetness`. + diff --git a/docs/library/processors/wrap/index.md b/docs/library/processors/wrap/index.md index a22b5b1e..9ae39c49 100644 --- a/docs/library/processors/wrap/index.md +++ b/docs/library/processors/wrap/index.md @@ -5,9 +5,9 @@ description: Wrap: Wrap the input beyond `min`/`max`. # Wrap -Wrap the input beyond `min`/`max`. - -Signature: ```python Wrap(input=None, min=-1.0, max=1.0) ``` + +Wrap the input beyond `min`/`max`. + diff --git a/docs/library/sequencing/clockdivider/index.md b/docs/library/sequencing/clockdivider/index.md index 4816bcba..b467a822 100644 --- a/docs/library/sequencing/clockdivider/index.md +++ b/docs/library/sequencing/clockdivider/index.md @@ -5,9 +5,9 @@ description: ClockDivider: When given a `clock` input (e.g., an Impulse), divide # ClockDivider -When given a `clock` input (e.g., an Impulse), divides the clock by the given `factor`. factor must be an integer greater than or equal to 1. - -Signature: ```python ClockDivider(clock=0, factor=1) ``` + +When given a `clock` input (e.g., an Impulse), divides the clock by the given `factor`. factor must be an integer greater than or equal to 1. + diff --git a/docs/library/sequencing/counter/index.md b/docs/library/sequencing/counter/index.md index 70fe74f6..92236710 100644 --- a/docs/library/sequencing/counter/index.md +++ b/docs/library/sequencing/counter/index.md @@ -5,9 +5,9 @@ description: Counter: Count upwards from `min` to `max`, driven by `clock`. # Counter -Count upwards from `min` to `max`, driven by `clock`. - -Signature: ```python Counter(clock=0, min=0, max=2147483647) ``` + +Count upwards from `min` to `max`, driven by `clock`. + diff --git a/docs/library/sequencing/euclidean/index.md b/docs/library/sequencing/euclidean/index.md index f8053df1..26425b2a 100644 --- a/docs/library/sequencing/euclidean/index.md +++ b/docs/library/sequencing/euclidean/index.md @@ -5,9 +5,9 @@ description: Euclidean: Euclidean rhythm as described by Toussaint, with `sequen # Euclidean -Euclidean rhythm as described by Toussaint, with `sequence_length` (n) and `num_events` (k), driven by `clock`. - -Signature: ```python Euclidean(clock=0, sequence_length=0, num_events=0) ``` + +Euclidean rhythm as described by Toussaint, with `sequence_length` (n) and `num_events` (k), driven by `clock`. + diff --git a/docs/library/sequencing/flipflop/index.md b/docs/library/sequencing/flipflop/index.md index 3b74f044..6b51b5f4 100644 --- a/docs/library/sequencing/flipflop/index.md +++ b/docs/library/sequencing/flipflop/index.md @@ -5,9 +5,9 @@ description: FlipFlop: Flips from 0/1 on each `clock`. # FlipFlop -Flips from 0/1 on each `clock`. - -Signature: ```python FlipFlop(clock=0) ``` + +Flips from 0/1 on each `clock`. + diff --git a/docs/library/sequencing/impulsesequence/index.md b/docs/library/sequencing/impulsesequence/index.md index 9eb8b3ac..d5fb212a 100644 --- a/docs/library/sequencing/impulsesequence/index.md +++ b/docs/library/sequencing/impulsesequence/index.md @@ -5,9 +5,9 @@ description: ImpulseSequence: Each time a `clock` or trigger is received, output # ImpulseSequence -Each time a `clock` or trigger is received, outputs the next value in `sequence`. At all other times, outputs zero. - -Signature: ```python ImpulseSequence(sequence=std::vector ( ), clock=None) ``` + +Each time a `clock` or trigger is received, outputs the next value in `sequence`. At all other times, outputs zero. + diff --git a/docs/library/sequencing/index/index.md b/docs/library/sequencing/index/index.md index 4ff7aaf2..e6e2f546 100644 --- a/docs/library/sequencing/index/index.md +++ b/docs/library/sequencing/index/index.md @@ -5,9 +5,9 @@ description: Index: Outputs the value in `list` corresponding to `index`. # Index -Outputs the value in `list` corresponding to `index`. - -Signature: ```python Index(list={}, index=0) ``` + +Outputs the value in `list` corresponding to `index`. + diff --git a/docs/library/sequencing/latch/index.md b/docs/library/sequencing/latch/index.md index f8974bea..b8816d2a 100644 --- a/docs/library/sequencing/latch/index.md +++ b/docs/library/sequencing/latch/index.md @@ -5,9 +5,9 @@ description: Latch: Initially outputs 0. When a trigger is received at `set`, ou # Latch -Initially outputs 0. When a trigger is received at `set`, outputs 1. When a trigger is subsequently received at `reset`, outputs 0, until the next `set`. - -Signature: ```python Latch(set=0, reset=0) ``` + +Initially outputs 0. When a trigger is received at `set`, outputs 1. When a trigger is subsequently received at `reset`, outputs 0, until the next `set`. + diff --git a/docs/library/sequencing/sequence/index.md b/docs/library/sequencing/sequence/index.md index 28bae513..fae4bbc8 100644 --- a/docs/library/sequencing/sequence/index.md +++ b/docs/library/sequencing/sequence/index.md @@ -5,9 +5,9 @@ description: Sequence: Outputs the elements in `sequence`, incrementing position # Sequence -Outputs the elements in `sequence`, incrementing position on each `clock`. - -Signature: ```python Sequence(sequence=std::vector ( ), clock=None) ``` + +Outputs the elements in `sequence`, incrementing position on each `clock`. + diff --git a/docs/library/stochastic/logistic/index.md b/docs/library/stochastic/logistic/index.md index bf4a444b..13c5b1ae 100644 --- a/docs/library/stochastic/logistic/index.md +++ b/docs/library/stochastic/logistic/index.md @@ -5,9 +5,9 @@ description: Logistic: Logistic noise. # Logistic -Logistic noise. - -Signature: ```python Logistic(chaos=3.7, frequency=0.0) ``` + +Logistic noise. + diff --git a/docs/library/stochastic/pinknoise/index.md b/docs/library/stochastic/pinknoise/index.md index 728f31f9..98629358 100644 --- a/docs/library/stochastic/pinknoise/index.md +++ b/docs/library/stochastic/pinknoise/index.md @@ -5,9 +5,9 @@ description: PinkNoise: Pink noise, with specified low/high cutoffs. # PinkNoise -Pink noise, with specified low/high cutoffs. - -Signature: ```python PinkNoise(low_cutoff=20.0, high_cutoff=20000.0, reset=None) ``` + +Pink noise, with specified low/high cutoffs. + diff --git a/docs/library/stochastic/randombrownian/index.md b/docs/library/stochastic/randombrownian/index.md index 0e3ded20..08fcacd4 100644 --- a/docs/library/stochastic/randombrownian/index.md +++ b/docs/library/stochastic/randombrownian/index.md @@ -5,9 +5,9 @@ description: RandomBrownian: Outputs Brownian noise between min/max, with a mean # RandomBrownian -Outputs Brownian noise between min/max, with a mean change of delta between samples. If a clock is passed, only generates a new value on a clock tick. - -Signature: ```python RandomBrownian(min=-1.0, max=1.0, delta=0.01, clock=None, reset=None) ``` + +Outputs Brownian noise between min/max, with a mean change of delta between samples. If a clock is passed, only generates a new value on a clock tick. + diff --git a/docs/library/stochastic/randomchoice/index.md b/docs/library/stochastic/randomchoice/index.md index e25eb323..0d3f0ab7 100644 --- a/docs/library/stochastic/randomchoice/index.md +++ b/docs/library/stochastic/randomchoice/index.md @@ -5,9 +5,9 @@ description: RandomChoice: Pick a random value from the given array. If a clock # RandomChoice -Pick a random value from the given array. If a clock is passed, only picks a new value on a clock tick. - -Signature: ```python RandomChoice(values=std::vector ( ), clock=None, reset=None) ``` + +Pick a random value from the given array. If a clock is passed, only picks a new value on a clock tick. + diff --git a/docs/library/stochastic/randomcoin/index.md b/docs/library/stochastic/randomcoin/index.md index 1b9ade5c..20907dc5 100644 --- a/docs/library/stochastic/randomcoin/index.md +++ b/docs/library/stochastic/randomcoin/index.md @@ -5,9 +5,9 @@ description: RandomCoin: Flip a coin with the given probability. If a clock is p # RandomCoin -Flip a coin with the given probability. If a clock is passed, only picks a new value on a clock tick. - -Signature: ```python RandomCoin(probability=0.5, clock=None, reset=None) ``` + +Flip a coin with the given probability. If a clock is passed, only picks a new value on a clock tick. + diff --git a/docs/library/stochastic/randomexponential/index.md b/docs/library/stochastic/randomexponential/index.md index 735dce27..37b73c5f 100644 --- a/docs/library/stochastic/randomexponential/index.md +++ b/docs/library/stochastic/randomexponential/index.md @@ -5,9 +5,9 @@ description: RandomExponential: Generate an random exponential value between min # RandomExponential -Generate an random exponential value between min/max. If a clock is passed, only picks a new value on a clock tick. - -Signature: ```python RandomExponential(min=0.001, max=1.0, clock=None, reset=None) ``` + +Generate an random exponential value between min/max. If a clock is passed, only picks a new value on a clock tick. + diff --git a/docs/library/stochastic/randomexponentialdist/index.md b/docs/library/stochastic/randomexponentialdist/index.md index d48b00a5..77e585f7 100644 --- a/docs/library/stochastic/randomexponentialdist/index.md +++ b/docs/library/stochastic/randomexponentialdist/index.md @@ -5,9 +5,9 @@ description: RandomExponentialDist: Generate an random value following the expon # RandomExponentialDist -Generate an random value following the exponential distribution. If a clock is passed, only picks a new value on a clock tick. - -Signature: ```python RandomExponentialDist(scale=0.0, clock=None, reset=None) ``` + +Generate an random value following the exponential distribution. If a clock is passed, only picks a new value on a clock tick. + diff --git a/docs/library/stochastic/randomgaussian/index.md b/docs/library/stochastic/randomgaussian/index.md index 521c7402..b7b41d91 100644 --- a/docs/library/stochastic/randomgaussian/index.md +++ b/docs/library/stochastic/randomgaussian/index.md @@ -5,9 +5,9 @@ description: RandomGaussian: Generate an random Gaussian value, with given mean # RandomGaussian -Generate an random Gaussian value, with given mean and sigma. If a clock is passed, only picks a new value on a clock tick. - -Signature: ```python RandomGaussian(mean=0.0, sigma=0.0, clock=None, reset=None) ``` + +Generate an random Gaussian value, with given mean and sigma. If a clock is passed, only picks a new value on a clock tick. + diff --git a/docs/library/stochastic/randomimpulse/index.md b/docs/library/stochastic/randomimpulse/index.md index 7b187574..66866b69 100644 --- a/docs/library/stochastic/randomimpulse/index.md +++ b/docs/library/stochastic/randomimpulse/index.md @@ -5,9 +5,9 @@ description: RandomImpulse: Generate random impulses at the given frequency, wit # RandomImpulse -Generate random impulses at the given frequency, with either uniform or poisson distribution. - -Signature: ```python RandomImpulse(frequency=1.0, distribution=SIGNALFLOW_EVENT_DISTRIBUTION_UNIFORM, reset=None) ``` + +Generate random impulses at the given frequency, with either uniform or poisson distribution. + diff --git a/docs/library/stochastic/randomimpulsesequence/index.md b/docs/library/stochastic/randomimpulsesequence/index.md index 8544c8aa..eb3d49c2 100644 --- a/docs/library/stochastic/randomimpulsesequence/index.md +++ b/docs/library/stochastic/randomimpulsesequence/index.md @@ -5,9 +5,9 @@ description: RandomImpulseSequence: Generates a random sequence of 0/1 bits with # RandomImpulseSequence -Generates a random sequence of 0/1 bits with the given length, and the given probability each each bit = 1. The position of the sequence is incremented on each clock signal. explore and generate are trigger inputs which cause the sequence to mutate and re-generate respectively. - -Signature: ```python RandomImpulseSequence(probability=0.5, length=8, clock=None, explore=None, generate=None, reset=None) ``` + +Generates a random sequence of 0/1 bits with the given length, and the given probability each each bit = 1. The position of the sequence is incremented on each clock signal. explore and generate are trigger inputs which cause the sequence to mutate and re-generate respectively. + diff --git a/docs/library/stochastic/randomuniform/index.md b/docs/library/stochastic/randomuniform/index.md index 1975ba5d..8c6516a7 100644 --- a/docs/library/stochastic/randomuniform/index.md +++ b/docs/library/stochastic/randomuniform/index.md @@ -5,9 +5,9 @@ description: RandomUniform: Generates a uniformly random value between min/max. # RandomUniform -Generates a uniformly random value between min/max. If a clock is passed, only picks a new value on a clock tick. - -Signature: ```python RandomUniform(min=0.0, max=1.0, clock=None, reset=None) ``` + +Generates a uniformly random value between min/max. If a clock is passed, only picks a new value on a clock tick. + diff --git a/docs/library/stochastic/whitenoise/index.md b/docs/library/stochastic/whitenoise/index.md index c0adf372..879008ac 100644 --- a/docs/library/stochastic/whitenoise/index.md +++ b/docs/library/stochastic/whitenoise/index.md @@ -5,9 +5,9 @@ description: WhiteNoise: Generates whitenoise between min/max. If frequency is z # WhiteNoise -Generates whitenoise between min/max. If frequency is zero, generates at audio rate. For frequencies lower than audio rate, interpolate applies linear interpolation between values, and random_interval specifies whether new random values should be equally-spaced or randomly-spaced. - -Signature: ```python WhiteNoise(frequency=0.0, min=-1.0, max=1.0, interpolate=true, random_interval=true, reset=None) ``` + +Generates whitenoise between min/max. If frequency is zero, generates at audio rate. For frequencies lower than audio rate, interpolate applies linear interpolation between values, and random_interval specifies whether new random values should be equally-spaced or randomly-spaced. + diff --git a/mkdocs.yml b/mkdocs.yml index 9e3acf5c..cb0f78ef 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -113,6 +113,7 @@ nav: not_in_nav: | library/*/*.md library/*/*/*.md + library/*/*/*/*.md installation/*/buttons.md installation/command-line-generic.md installation/next-steps.md diff --git a/source/include/signalflow/node/oscillators/triangle.h b/source/include/signalflow/node/oscillators/triangle.h index 72f90b25..c24f0291 100644 --- a/source/include/signalflow/node/oscillators/triangle.h +++ b/source/include/signalflow/node/oscillators/triangle.h @@ -7,7 +7,6 @@ namespace signalflow /**--------------------------------------------------------------------------------* * Produces a triangle wave with the given `frequency`. *---------------------------------------------------------------------------------*/ - class TriangleOscillator : public Node { public: