sound:xtract
Last update: 31.07.2026Version: 0.0.0
Description
XTRACT processing: in the same way as in Sound SAS, this operator chains a denoising step, followed by a tonal extraction step and then a transient extraction step. It returns the individual signals processed at each step, as well as the remainder.
Inputs
| Input | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 Required |
input_signal | fields_container, field |
Signal(s) on which to apply the XTRACT processing, as a field or fields_container. |
| Pin 1 Required |
parameters_denoiser | generic_data_container |
Structure that contains the parameters of the denoising step: * Noise levels (Field): level vs frequency of the noise. This structure is of type Xtract_denoiser_parameters (see this class for more details). |
| Pin 2 Required |
parameters_tonal | generic_data_container |
Structure that contains the parameters of the tonal extraction step: * Nfft (int) in number of samples * Regularity setting (float) in percent * Maximum slope (float) in dB/Hz * Minimum duration (float) in seconds * Intertonal gap (float) in Hz * Local emergence (float) in dB This structure is of type Xtract_tonal_parameters (see this class for more details). |
| Pin 3 Required |
parameters_transient | generic_data_container |
Structure that contains the parameters of the transient extraction step: * Lower threshold (float), between 0 and 100 percent * Upper threshold (float), between 0 and 100 percent This structure is of type Xtract_transient_parameters (see this class for more details). |
Outputs
| Output | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 | noise_signal | fields_container, field |
Noise signal: signal that contains the noise component, as a field or fields_container (depending on the input). |
| Pin 1 | tonal_signal | fields_container, field |
Tonal signal: signal that contains the tonal components, as a field or fields_container (depending on the input). |
| Pin 2 | transient_signal | fields_container, field |
Tonal signal: signal that contains the transient components, as a field or fields_container (depending on the input). |
| Pin 3 | remainder_signal | fields_container, field |
Remainder: signal that contains everything that has not been classified as noise, tonal or transient signals, as a field or fields_container (depending on the input). |
Configurations
| Name | Expected type(s) | Default value | Description |
|---|---|---|---|
| mutex | bool |
false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
Scripting
Category: sound
Plugin: sound
Scripting name: None
Full name: None
Internal name: xtract
License: avrxp_snd_level1
Changelog
- Version 0.0.0: Initial release.
