sound:compute level over time
Version: 0.0.0
Description
Compute level over time of a signal, on a decibel (dB) scale, or a linear, root-mean-square (RMS) scale. In the case of a dB scale, the actual unit of the returned value will depend on the specified reference value, and frequency weighting (Z, A, B, or C).
Inputs
| Input | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 Required | input_signal | field | Input signal for the level computation. |
| Pin 1 | scale_unit | int32 | Expected level scale unit, that is, whether level should be output on a decibel scale, or on a linear, root-mean-square (RMS) scale. Supported values are: * 0: dB * 1: RMS Default: 0 (dB) |
| Pin 2 | reference_value | double | Reference value for dB calculation. For example, 2e-5 Pa is the reference value for dB SPL, dBA, dBB, and dBC. Reference value is ignored if input scale_unit is set to 1 (RMS). If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa. Default: 1.0. |
| Pin 3 | frequency_weighting | int32 | Frequency weighting for dB calculation. Frequency weighting is ignored if input scale_unit is set to 1 (RMS). Supported values are: * 0: Z-weighting (no frequency weighting, use this setting in case dB SPL) * 1: A-weighting * 2: B-weighting * 3: C-weighting Default: 0 (Z-weighting) If frequency_weighting is set to either 1 (A), 2 (B), or 3 (C), reference_value should be 2e-5 Pa. |
| Pin 4 | time_weighting | int32 | Time weighting for dB calculation, as described in the IEC-61672 standard. Supported values are: * 0: Slow * 1: Fast * 2: Impulse * 3: Custom Default: 1 (Fast) |
| Pin 5 | time_step | double | Time step of the level over time calculation, in seconds. Time step is ignored if input time_weighting is not set to 3 (Custom). Default: 0.025 s. |
| Pin 6 | window_size | double | Window size in seconds, that is, the length of the slice of signal used to calculate the level at each time step. Window size is ignored if input time_weighting is not set to 3 (Custom). Default value: 1s. |
| Pin 7 | window_type | string | Type of the window applied to the slice of signal used to calculate the level at each time step. Supported values are: * RECTANGULAR * HANN * HAMMING * BLACKMAN * BLACKMANHARRIS * BARTLETT Default: RECTANGULAR |
Outputs
| Output | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 | maximum_level | double | Maximum level attained by the level over time curve, in the unit specified according to inputs (dB, dB SPL, dBA, dBB, dBC or RMS). |
| Pin 1 | level_over_time | field | Level over time, in a unit that depends on inputs scale_unit, reference_value, and frequency_weighting. |
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_level_over_time
License: avrxp_snd_level1
Changelog
- Version 0.0.0: Initial release.