## On this page

  

 

 # sound:xtract

 Last update: 31.07.2026 

**Version: 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

InputNameExpected type(s)Description**Pin 0**   
Requiredinput\_signal[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field)Signal(s) on which to apply the XTRACT processing, as a field or fields\_container.**Pin 1**   
Requiredparameters\_denoiser[`generic_data_container`](../../core-concepts/dpf-types.md#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**   
Requiredparameters\_tonal[`generic_data_container`](../../core-concepts/dpf-types.md#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**   
Requiredparameters\_transient[`generic_data_container`](../../core-concepts/dpf-types.md#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

OutputNameExpected type(s)Description**Pin 0**noise\_signal[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#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`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#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`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#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`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#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

NameExpected type(s)Default valueDescription**mutex**[`bool`](../../core-concepts/dpf-types.md#standard-types)falseIf 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.