sound:compute overall level

Version: 0.0.0

Description

Compute the overall level of a signal, on a decibel 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-weigthing (no frequency weighting, use this setting in case dB SPL) * 1: A-weigthing * 2: B-weigthing * 3: C-weigthing 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.

Outputs

Output	Name	Expected type(s)	Description
Pin 0	output_level	double	Overall level, 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_overall_level

License: avrxp_snd_level1

Changelog

• Version 0.0.0: Initial release.