-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathSharpness_DIN45692_from_wavfile.m
160 lines (157 loc) · 7.15 KB
/
Sharpness_DIN45692_from_wavfile.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
function OUT = Sharpness_DIN45692_from_wavfile(wavfilename, dBFS, weight_type, LoudnessField, LoudnessMethod, time_skip, show_sharpness, show_loudness)
% function OUT = Sharpness_DIN45692_from_wavfile(wavfilename, dBFS, weight_type, LoudnessField, LoudnessMethod, time_skip, show_sharpness, show_loudness)
%
% Stationary and time-varying sharpness calculation according to DIN 45692
% (2009) from a waveform (wav file). The loudness calculation, required
% as pre-processing for sharpness, is included in this code.
%
% This script, Sharpness_DIN45692_from_wavfile, calls internally the main
% sharpness algorithm, Sharpness_DIN45692. The only difference is that
% Sharpness_DIN45692_from_wavfile requires a file name as first input
% argument and the dBFS convention value as the second input argument.
%
% Loudness calculation is conducted according to ISO 532:1-2017
% (type <help Loudness_ISO532_1> for more info)
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% INPUT ARGUMENTS
% wavfilename : file name containing the input signal 'insig' to be
% processed and the sampling frequency 'fs' of insig. Wavfilename
% should be visible to MATLAB.
%
% dBFS: dB sound pressure level equivalent to the full scale value. If
% dBFS is 94 dB SPL (default), the amplitudes of 'insig' are interpreted
% as expressed in pressure units (Pa).
%
% weight_type : string
% sharpness calculation using weighting function according to:
% - 'DIN45692'
% - 'bismarck'
% - 'aures' (dependent on the specific loudness level)
%
% LoudnessField : integer
% type of field used for loudness calculation; free field = 0; diffuse field = 1;
%
% LoudnessMethod : integer
% method used for loudness calculation - method used for loudness
% calculation: stationary (from input 1/3 octave unweighted SPL)=0 (not
% accepted in this context); stationary = 1; time varying = 2;
%
% time_skip : integer
% skip start of the signal in <time_skip> seconds for statistics calculations (method=1 (time-varying) only)
%
% show_loudness : logical(boolean)
% optional parameter to display loudness results (only method=1)
% 'false' (disable, default value) or 'true' (enable).
%
% show_sharpness : logical(boolean)
% optional parameter to display sharpness results (only method=1)
% 'false' (disable, default value) or 'true' (enable).
%
% OUTPUTS (method==0; stationary)
% OUT : struct containing the following fields
%
% * Sharpness: sharpness (acum)
%
% OUTPUTS (method==1; time-varying)
% OUT : struct containing the following fields
%
% * loudness: output struct from loudness calculation (type
% <help loudness_ISO532_1> for more info)
% * InstantaneousSharpness: instantaneous sharpness (acum) vs time
% * time : time vector in seconds
% * Several statistics based on the InstantaneousSharpness (acum)
% ** Smean : mean value of InstantaneousSharpness (acum)
% ** Sstd : standard deviation of InstantaneousSharpness (acum)
% ** Smax : maximum of InstantaneousSharpness (acum)
% ** Smin : minimum of InstantaneousSharpness (acum)
% ** Sx : sharpness value exceeded during x percent of the time (acum)
%
% *** HINT: time-varying loudness calculation takes some time to
% have a steady-response (thus sharpness too!).
% Therefore, it is a good practice to consider a
% time_skip to compute the statistics
%
% % Stand-alone example:
% fname = [basepath_SQAT 'sound_files' filesep 'reference_signals' filesep 'RefSignal_Sharpness_DIN45692.wav'];
% dBFS = 90; % We know this information in advance
% Sharpness_DIN45692_from_wavfile(fname,dBFS);
%
% Author: Alejandro Osses, based on the code by Gil Felix Greco
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
if nargin == 0
help Sharpness_DIN45692_from_wavfile;
return;
end
if nargin < 8
if nargout == 0
show_loudness = 1;
else
show_loudness = 0;
end
end
if nargin < 7
if nargout == 0
show_sharpness = 1;
else
show_sharpness = 0;
end
end
if nargin < 6
pars = psychoacoustic_metrics_get_defaults('Sharpness_DIN45692');
time_skip = pars.time_skip;
fprintf('\n%s.m: Default time_skip value = %.0f is being used\n',mfilename,pars.time_skip);
end
if nargin < 5
pars = psychoacoustic_metrics_get_defaults('Sharpness_DIN45692');
LoudnessMethod = pars.method;
fprintf('\n%s.m: Default method value = %.0f is being used\n',mfilename,pars.method);
end
if nargin < 4
pars = psychoacoustic_metrics_get_defaults('Sharpness_DIN45692');
LoudnessField = pars.field;
fprintf('\n%s.m: Default field value = %.0f is being used\n',mfilename,pars.field);
end
if nargin < 3
pars = psychoacoustic_metrics_get_defaults('Sharpness_DIN45692');
weight_type = pars.weight_type;
fprintf('\n%s.m: Default weight_type value = %s is being used\n',mfilename,pars.weight_type);
end
[insig,fs] = audioread(wavfilename);
if nargin < 2 || isempty(dBFS)
dBFS = 94; % dB
fprintf('\n%s.m: Assuming the default full scale convention, with dBFS = %.0f\n',mfilename,dBFS);
end
gain_factor = 10^((dBFS-94)/20);
insig = gain_factor*insig;
OUT = Sharpness_DIN45692(insig, fs, weight_type, LoudnessField, LoudnessMethod, time_skip, show_sharpness, show_loudness);
end % End of file
%**************************************************************************
%
% Redistribution and use in source and binary forms, with or without
% modification, are permitted provided that the following conditions are
% met:
%
% * Redistributions of source code must retain the above copyright notice,
% this list of conditions and the following disclaimer.
% * Redistributions in binary form must reproduce the above copyright
% notice, this list of conditions and the following disclaimer in the
% documentation and/or other materials provided with the distribution.
% * Neither the name of the <ORGANISATION> nor the names of its contributors
% may be used to endorse or promote products derived from this software
% without specific prior written permission.
%
% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
% "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
% TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
% PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER
% OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
% EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
% PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
% PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
% LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
% NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
% SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
%
%**************************************************************************