Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/AmpGate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
:description: Absolute amplitude threshold gate detector on a realtime signal

:discussion:
AmpGate outputs a audio-rate, single-channel signal that is either 0, indicating the gate is closed, or 1, indicating the gate is open. The gate detects an onset (opens) when the internal envelope follower (controlled by ``rampUp`` and ``rampDown``) goes above a specified ``onThreshold`` (in dB) for at least ``minLengthAbove`` samples. The gate will stay open until the envelope follower goes below ``offThreshold`` (in dB) for at least ``minLengthBelow`` samples, which triggers an offset.
AmpGate outputs an audio-rate, single-channel signal that is either 0, indicating the gate is closed, or 1, indicating the gate is open. The gate detects an onset (opens) when the internal envelope follower (controlled by ``rampUp`` and ``rampDown``) goes above a specified ``onThreshold`` (in dB) for at least ``minLengthAbove`` samples. The gate will stay open until the envelope follower goes below ``offThreshold`` (in dB) for at least ``minLengthBelow`` samples, which triggers an offset.

The latency between the input and the output is **max(minLengthAbove + lookBack, max(minLengthBelow,lookAhead))**.

Expand Down
2 changes: 1 addition & 1 deletion doc/AudioTransport.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

:control hopSize:

The window hop size in samples. As HPSS relies on spectral frames, we need to move the window forward. It can be any size but low overlap may create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2).
The window hop size in samples. As HPSS relies on spectral frames, we need to move the window forward. It can be any size, but low overlap may create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2).

:control fftSize:

Expand Down
6 changes: 3 additions & 3 deletions doc/BufAmpFeature.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@

:control source:

The index of the buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed.
The buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed.

:control startFrame:

Where in the srcBuf should the slicing process start, in sample.
Where in the srcBuf should the slicing process start, in samples.

:control numFrames:

Expand All @@ -33,7 +33,7 @@

:control features:

The index of the buffer where the amplitude differential feature will be copied to.
The buffer where the amplitude differential feature will be copied to.

:control fastRampUp:

Expand Down
2 changes: 1 addition & 1 deletion doc/BufAmpGate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

:control indices:

The buffer to write the gate information into. Buffer will be resized appropriately so each frame contains an onset (opening) position on channel 0 and the corresponding offset (closing) position on channel 1 (both in samples). The buffer will have as many frames as gate events detected.
The buffer to write the gate information into. Buffer will be resized appropriately so that each frame contains an onset (opening) position on channel 0 and the corresponding offset (closing) position on channel 1 (both in samples). The buffer will have as many frames as gate events detected.

:control rampUp:

Expand Down
8 changes: 4 additions & 4 deletions doc/BufAmpSlice.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@
:discussion:
FluidBufAmpSlice is based on two envelope followers on a high-passed version of the signal: one slow that gives the trend, and one fast. Each has features that will interact. The example code below is unfolding the various possibilities in order of complexity.

The process will return a buffer which contains indices (in sample) of estimated starting points of different slices.
The process will return a buffer which contains indices (in samples) of estimated starting points of different slices.

:output: Nothing, as the destination buffer is declared in the function call.


:control source:

The index of the buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed.
The buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed.

:control startFrame:

Where in the srcBuf should the slicing process start, in sample.
Where in the srcBuf should the slicing process start, in samples.

:control numFrames:

Expand All @@ -35,7 +35,7 @@

:control indices:

The index of the buffer where the indices (in sample) of the estimated starting points of slices will be written. The first and last points are always the boundary points of the analysis.
The buffer where the indices (in samples) of the estimated starting points of slices will be written. The first and last points are always the boundary points of the analysis.

:control fastRampUp:

Expand Down
2 changes: 1 addition & 1 deletion doc/BufAudioTransport.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@

:control hopSize:

The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2).
The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2).

:control fftSize:

Expand Down
6 changes: 3 additions & 3 deletions doc/BufChroma.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@

:control source:

The index of the buffer to use as the source material to be analysed. The different channels of multichannel buffers will be processed sequentially.
The buffer to use as the source material to be analysed. The different channels of multichannel buffers will be processed sequentially.

:control startFrame:

Where in the srcBuf should the process start, in sample.
Where in the srcBuf should the process start, in samples.

:control numFrames:

Expand Down Expand Up @@ -63,7 +63,7 @@

:control hopSize:

The window hop size. As chroma description relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts.
The window hop size. As chroma description relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts.

:control fftSize:

Expand Down
2 changes: 1 addition & 1 deletion doc/BufCompose.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
A utility for manipulating the contents of buffers.

:discussion:
This object is the swiss army knife for manipulating buffers and their contents. By specifying ranges of samples and channels to copy, as well as destination and source gains it can provide a powerful interface for performing actions such as a Left/Right to Mid/Side conversion and mixing down multichannel audio
This object is a low-level tool for manipulating buffers and their contents. By specifying ranges of samples and channels to copy, as well as destination and source gains it can provide a powerful interface for performing actions such as a Left/Right to Mid/Side conversion and mixing down multichannel audio

:process: This method triggers the compositing.

Expand Down
10 changes: 5 additions & 5 deletions doc/BufHPSS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

:control source:

The index of the buffer to use as the source material. The channels of multichannel buffers will be processed sequentially.
The buffer to use as the source material. The channels of multichannel buffers will be processed sequentially.

:control startFrame:

Expand All @@ -49,15 +49,15 @@

:control harmonic:

The index of the buffer where the extracted harmonic component will be reconstructed.
The buffer where the extracted harmonic component will be reconstructed.

:control percussive:

The index of the buffer where the extracted percussive component will be reconstructed.
The buffer where the extracted percussive component will be reconstructed.

:control residual:

The index of the buffer where the residual component will be reconstructed in mode 2.
The buffer where the residual component will be reconstructed in mode 2.

:control harmFilterSize:

Expand Down Expand Up @@ -96,7 +96,7 @@

:control hopSize:

The hop size in samples. As HPSS relies on spectral frames, we need to move the window forward. It can be any size but low overlap may create audible artefacts.
The hop size in samples. As HPSS relies on spectral frames, we need to move the window forward. It can be any size, but low overlap may create audible artefacts.

:control fftSize:

Expand Down
8 changes: 4 additions & 4 deletions doc/BufLoudness.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@

:control source:

The index of the buffer to use as the source material to be described. The different channels of multichannel buffers will be processed sequentially.
The buffer to use as the source material to be described. The different channels of multichannel buffers will be processed sequentially.

:control startFrame:

Where in the srcBuf should the process start, in sample.
Where in the srcBuf should the process start, in samples.

:control numFrames:

Expand Down Expand Up @@ -54,11 +54,11 @@

:control windowSize:

The size of the window on which the computation is done. By default 1024 to be similar with all other FluCoMa objects, the EBU specifies 400ms, which is 17640 samples at 44100.
The size of the window on which the computation is done. By default, 1024 to be similar with all other FluCoMa objects, the EBU specifies 400ms, which is 17640 samples at 44100.

:control hopSize:

How much the buffered window moves forward, in samples. By default 512 to be similar with all other FluCoMa objects, the EBU specifies 100ms, which is 4410 samples at 44100.
How much the buffered window moves forward, in samples. By default, 512 to be similar with all other FluCoMa objects, the EBU specifies 100ms, which is 4410 samples at 44100.

:control padding:

Expand Down
4 changes: 2 additions & 2 deletions doc/BufMFCC.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

:control source:

The index of the buffer to use as the source material to be analysed. The different channels of multichannel buffers will be processed sequentially.
The buffer to use as the source material to be analysed. The different channels of multichannel buffers will be processed sequentially.

:control startFrame:

Expand Down Expand Up @@ -66,7 +66,7 @@

:control hopSize:

The window hop size. As MFCC computation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2).
The window hop size. As MFCC computation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2).

:control fftSize:

Expand Down
4 changes: 2 additions & 2 deletions doc/BufMelBands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

:control source:

The index of the buffer to use as the source material to be analysed. The different channels of multichannel buffers will be processed sequentially.
The buffer to use as the source material to be analysed. The different channels of multichannel buffers will be processed sequentially.

:control startFrame:

Expand Down Expand Up @@ -68,7 +68,7 @@

:control hopSize:

The window hop size. As this analysis relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2).
The window hop size. As this analysis relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2).

:control fftSize:

Expand Down
12 changes: 6 additions & 6 deletions doc/BufNMF.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@

:control source:

The index of the buffer to use as the source material to be decomposed through the NMF process. The different channels of multichannel buffers will be processed sequentially.
The buffer to use as the source material to be decomposed through the NMF process. The different channels of multichannel buffers will be processed sequentially.

:control startFrame:

Where in the srcBuf should the NMF process start, in sample.
Where in the srcBuf should the NMF process start, in samples.

:control numFrames:

Expand All @@ -52,15 +52,15 @@

:control resynth:

The index of the buffer where the different reconstructed components will be reconstructed. The buffer will be resized to ``components * numChannelsProcessed`` channels and ``sourceDuration`` length. If ``nil`` is provided, the reconstruction will not happen.
The buffer where the different reconstructed components will be reconstructed. The buffer will be resized to ``components * numChannelsProcessed`` channels and ``sourceDuration`` length. If ``nil`` is provided, the reconstruction will not happen.

:control resynthMode:

This flag determines if resynthesis from basis and activation is executed.

:control bases:

The index of the buffer where the different bases will be written to and/or read from: the behaviour is set in the following argument. If ``nil`` is provided, no bases will be returned.
The buffer where the different bases will be written to and/or read from: the behaviour is set in the following argument. If ``nil`` is provided, no bases will be returned.

:control basesMode:

Expand All @@ -79,7 +79,7 @@

:control activations:

The index of the buffer where the different activations will be written to and/or read from: the behaviour is set in the following argument. If ``nil`` is provided, no activation will be returned.
The buffer where the different activations will be written to and/or read from: the behaviour is set in the following argument. If ``nil`` is provided, no activation will be returned.

:control actMode:

Expand Down Expand Up @@ -110,7 +110,7 @@

:control hopSize:

The window hop size. As NMF relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts.
The window hop size. As NMF relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts.

:control fftSize:

Expand Down
2 changes: 1 addition & 1 deletion doc/BufNMFSeed.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@

:control hopSize:

The window hop size. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2).
The window hop size. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2).

:control fftSize:

Expand Down
8 changes: 4 additions & 4 deletions doc/BufNoveltyFeature.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@

:control source:

The index of the buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed.
The buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed.

:control startFrame:

Where in the srcBuf should the slicing process start, in sample.
Where in the srcBuf should the slicing process start, in samples.

:control numFrames:

Expand All @@ -40,7 +40,7 @@

:control features:

The index of the buffer where the novelty feature will be written.
The buffer where the novelty feature will be written.

:control algorithm:

Expand Down Expand Up @@ -77,7 +77,7 @@

:control hopSize:

The window hop size. As novelty estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts.
The window hop size. As novelty estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts.

:control fftSize:

Expand Down
10 changes: 5 additions & 5 deletions doc/BufNoveltySlice.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
:discussion:
A novelty curve is derived from running a kernel across the diagonal of the similarity matrix, and looking for peaks of changes. It implements the seminal results published in 'Automatic Audio Segmentation Using a Measure of Audio Novelty' by J Foote.

The process will return a buffer which contains indices (in sample) of estimated starting points of different slices.
The process will return a buffer which contains indices (in samples) of estimated starting points of different slices.

.. only_in:: sc

Expand All @@ -19,11 +19,11 @@

:control source:

The index of the buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed.
The buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed.

:control startFrame:

Where in the srcBuf should the slicing process start, in sample.
Where in the srcBuf should the slicing process start, in samples.

:control numFrames:

Expand All @@ -39,7 +39,7 @@

:control indices:

The index of the buffer where the indices (in sample) of the estimated starting points of slices will be written. The first and last points are always the boundary points of the analysis.
The buffer where the indices (in samples) of the estimated starting points of slices will be written. The first and last points are always the boundary points of the analysis.

:control algorithm:

Expand Down Expand Up @@ -84,7 +84,7 @@

:control hopSize:

The window hop size. As novelty estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts.
The window hop size. As novelty estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts.

:control fftSize:

Expand Down
8 changes: 4 additions & 4 deletions doc/BufOnsetFeature.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@

:control source:

The index of the buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed.
The buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed.

:control startFrame:

Where in the srcBuf should the slicing process start, in sample.
Where in the srcBuf should the slicing process start, in samples.

:control numFrames:

Expand All @@ -38,7 +38,7 @@

:control features:

The index of the buffer where the onset features will be written to.
The buffer where the onset features will be written to.

:control metric:

Expand Down Expand Up @@ -90,7 +90,7 @@

:control hopSize:

The window hop size. As spectral differencing relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2).
The window hop size. As spectral differencing relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2).

:control fftSize:

Expand Down
Loading