sound:compute tonality ISO 1996-2:2007
Last update: 31.07.2026Version: 0.0.0
Description
Compute the tonal audibility and the tonal adjustment of a signal, according to annex C of the ISO 1996-2:2007 standard.
Inputs
| Input | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 Required |
input_signal | field |
Input signal in Pa on which to compute the ISO 1996-2:2007 tonality. |
| Pin 1 | noise_threshold | double |
Noise pause detection threshold (also referred to as level excess) in dB. Must be positive. Default: 1 dB. |
| Pin 2 | effective_analysis_bw | double |
Effective analysis bandwidth in Hz. Must be in the range ]0, 5]. Default: 5 Hz. |
| Pin 3 | noise_bandwidth | double |
Noise bandwidth, in proportion to the critical bandwidth, that is taken into account for the calculation of the masking noise level (the default value 0.75 means that the masking noise level is estimated in a band delimited by 75 % of the critical bandwidth on each side of the tone). Must be in the range [0.75, 2]. Default: 0.75. |
Outputs
| Output | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 | tonality | double |
Tonal audibility, in dB. |
| Pin 1 | tonal_adjustement | double |
Tonal adjustment Kt, in dB. |
| Pin 2 | calculation_details | data_tree |
ISO 1996-2:2007 calculation details. The DataTree elements can be accessed, each as a double, using the following identifiers: |
- Tonal audibility (dB)
- Tonal adjustement (dB)
- Lower critical band limit (Hz)
- Higher critical band limit (Hz)
- Total noise level (dBA)
- Total tonal level (dBA) |
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: compute_tonality_iso1996_2
License: avrxp_snd_level1
Changelog
- Version 0.0.0: Initial release.
