"""Low-level feature pipeline components
This library gathers functions that compute popular speech features over
batches of data. All the classes are of type nn.Module. This gives the
possibility to have end-to-end differentiability and to backpropagate the
gradient through them. Our functions are a modified version the ones
in torch audio toolkit (https://github.com/pytorch/audio).
Example
-------
>>> import torch
>>> from speechbrain.dataio.dataio import read_audio
>>> signal =read_audio('tests/samples/single-mic/example1.wav')
>>> signal = signal.unsqueeze(0)
>>> compute_STFT = STFT(
... sample_rate=16000, win_length=25, hop_length=10, n_fft=400
... )
>>> features = compute_STFT(signal)
>>> features = spectral_magnitude(features)
>>> compute_fbanks = Filterbank(n_mels=40)
>>> features = compute_fbanks(features)
>>> compute_mfccs = DCT(input_size=40, n_out=20)
>>> features = compute_mfccs(features)
>>> compute_deltas = Deltas(input_size=20)
>>> delta1 = compute_deltas(features)
>>> delta2 = compute_deltas(delta1)
>>> features = torch.cat([features, delta1, delta2], dim=2)
>>> compute_cw = ContextWindow(left_frames=5, right_frames=5)
>>> features = compute_cw(features)
>>> norm = InputNormalization()
>>> features = norm(features, torch.tensor([1]).float())
Authors
* Mirco Ravanelli 2020
"""
import math
import torch
import logging
from speechbrain.utils.checkpoints import (
mark_as_saver,
mark_as_loader,
mark_as_transfer,
register_checkpoint_hooks,
)
from speechbrain.dataio.dataio import length_to_mask
from speechbrain.utils.filter_analysis import FilterProperties
logger = logging.getLogger(__name__)
[docs]
class STFT(torch.nn.Module):
"""computes the Short-Term Fourier Transform (STFT).
This class computes the Short-Term Fourier Transform of an audio signal.
It supports multi-channel audio inputs (batch, time, channels).
Arguments
---------
sample_rate : int
Sample rate of the input audio signal (e.g 16000).
win_length : float
Length (in ms) of the sliding window used to compute the STFT.
hop_length : float
Length (in ms) of the hope of the sliding window used to compute
the STFT.
n_fft : int
Number of fft point of the STFT. It defines the frequency resolution
(n_fft should be <= than win_len).
window_fn : function
A function that takes an integer (number of samples) and outputs a
tensor to be multiplied with each window before fft.
normalized_stft : bool
If True, the function returns the normalized STFT results,
i.e., multiplied by win_length^-0.5 (default is False).
center : bool
If True (default), the input will be padded on both sides so that the
t-th frame is centered at time t×hop_length. Otherwise, the t-th frame
begins at time t×hop_length.
pad_mode : str
It can be 'constant','reflect','replicate', 'circular', 'reflect'
(default). 'constant' pads the input tensor boundaries with a
constant value. 'reflect' pads the input tensor using the reflection
of the input boundary. 'replicate' pads the input tensor using
replication of the input boundary. 'circular' pads using circular
replication.
onesided : True
If True (default) only returns nfft/2 values. Note that the other
samples are redundant due to the Fourier transform conjugate symmetry.
Example
-------
>>> import torch
>>> compute_STFT = STFT(
... sample_rate=16000, win_length=25, hop_length=10, n_fft=400
... )
>>> inputs = torch.randn([10, 16000])
>>> features = compute_STFT(inputs)
>>> features.shape
torch.Size([10, 101, 201, 2])
"""
def __init__(
self,
sample_rate,
win_length=25,
hop_length=10,
n_fft=400,
window_fn=torch.hamming_window,
normalized_stft=False,
center=True,
pad_mode="constant",
onesided=True,
):
super().__init__()
self.sample_rate = sample_rate
self.win_length = win_length
self.hop_length = hop_length
self.n_fft = n_fft
self.normalized_stft = normalized_stft
self.center = center
self.pad_mode = pad_mode
self.onesided = onesided
# Convert win_length and hop_length from ms to samples
self.win_length = int(
round((self.sample_rate / 1000.0) * self.win_length)
)
self.hop_length = int(
round((self.sample_rate / 1000.0) * self.hop_length)
)
self.window = window_fn(self.win_length)
[docs]
def forward(self, x):
"""Returns the STFT generated from the input waveforms.
Arguments
---------
x : tensor
A batch of audio signals to transform.
"""
# Managing multi-channel stft
or_shape = x.shape
if len(or_shape) == 3:
x = x.transpose(1, 2)
x = x.reshape(or_shape[0] * or_shape[2], or_shape[1])
stft = torch.stft(
x,
self.n_fft,
self.hop_length,
self.win_length,
self.window.to(x.device),
self.center,
self.pad_mode,
self.normalized_stft,
self.onesided,
return_complex=True,
)
stft = torch.view_as_real(stft)
# Retrieving the original dimensionality (batch,time, channels)
if len(or_shape) == 3:
stft = stft.reshape(
or_shape[0],
or_shape[2],
stft.shape[1],
stft.shape[2],
stft.shape[3],
)
stft = stft.permute(0, 3, 2, 4, 1)
else:
# (batch, time, channels)
stft = stft.transpose(2, 1)
return stft
[docs]
def get_filter_properties(self) -> FilterProperties:
if not self.center:
raise ValueError(
"ValueProperties cannot model a non-centered STFT, as it "
"assumes either centering or causality"
)
return FilterProperties(
window_size=self.win_length, stride=self.hop_length
)
[docs]
class ISTFT(torch.nn.Module):
"""Computes the Inverse Short-Term Fourier Transform (ISTFT)
This class computes the Inverse Short-Term Fourier Transform of
an audio signal. It supports multi-channel audio inputs
(batch, time_step, n_fft, 2, n_channels [optional]).
Arguments
---------
sample_rate : int
Sample rate of the input audio signal (e.g. 16000).
win_length : float
Length (in ms) of the sliding window used when computing the STFT.
hop_length : float
Length (in ms) of the hope of the sliding window used when computing
the STFT.
window_fn : function
A function that takes an integer (number of samples) and outputs a
tensor to be used as a window for ifft.
normalized_stft : bool
If True, the function assumes that it's working with the normalized
STFT results. (default is False)
center : bool
If True (default), the function assumes that the STFT result was padded
on both sides.
onesided : True
If True (default), the function assumes that there are n_fft/2 values
for each time frame of the STFT.
epsilon : float
A small value to avoid division by 0 when normalizing by the sum of the
squared window. Playing with it can fix some abnormalities at the
beginning and at the end of the reconstructed signal. The default value
of epsilon is 1e-12.
Example
-------
>>> import torch
>>> compute_STFT = STFT(
... sample_rate=16000, win_length=25, hop_length=10, n_fft=400
... )
>>> compute_ISTFT = ISTFT(
... sample_rate=16000, win_length=25, hop_length=10
... )
>>> inputs = torch.randn([10, 16000])
>>> outputs = compute_ISTFT(compute_STFT(inputs))
>>> outputs.shape
torch.Size([10, 16000])
"""
def __init__(
self,
sample_rate,
n_fft=None,
win_length=25,
hop_length=10,
window_fn=torch.hamming_window,
normalized_stft=False,
center=True,
onesided=True,
epsilon=1e-12,
):
super().__init__()
self.sample_rate = sample_rate
self.n_fft = n_fft
self.win_length = win_length
self.hop_length = hop_length
self.normalized_stft = normalized_stft
self.center = center
self.onesided = onesided
self.epsilon = epsilon
# Convert win_length and hop_length from ms to samples
self.win_length = int(
round((self.sample_rate / 1000.0) * self.win_length)
)
self.hop_length = int(
round((self.sample_rate / 1000.0) * self.hop_length)
)
# Create window using provided function
self.window = window_fn(self.win_length)
[docs]
def forward(self, x, sig_length=None):
"""Returns the ISTFT generated from the input signal.
Arguments
---------
x : tensor
A batch of audio signals in the frequency domain to transform.
sig_length : int
The length of the output signal in number of samples. If not
specified will be equal to: (time_step - 1) * hop_length + n_fft
"""
or_shape = x.shape
# Infer n_fft if not provided
if self.n_fft is None and self.onesided:
n_fft = (x.shape[2] - 1) * 2
elif self.n_fft is None and not self.onesided:
n_fft = x.shape[2]
else:
n_fft = self.n_fft
# Changing the format for (batch, time_step, n_fft, 2, n_channels)
if len(or_shape) == 5:
x = x.permute(0, 4, 2, 1, 3)
# Lumping batch and channel dimension, because torch.istft
# doesn't support batching.
x = x.reshape(-1, x.shape[2], x.shape[3], x.shape[4])
elif len(or_shape) == 4:
x = x.permute(0, 2, 1, 3)
# isft ask complex input
x = torch.complex(x[..., 0], x[..., 1])
istft = torch.istft(
input=x,
n_fft=n_fft,
hop_length=self.hop_length,
win_length=self.win_length,
window=self.window.to(x.device),
center=self.center,
onesided=self.onesided,
length=sig_length,
)
# Convert back to (time, time_step, n_channels)
if len(or_shape) == 5:
istft = istft.reshape(or_shape[0], or_shape[4], -1)
istft = istft.transpose(1, 2)
return istft
[docs]
def spectral_magnitude(
stft, power: int = 1, log: bool = False, eps: float = 1e-14
):
"""Returns the magnitude of a complex spectrogram.
Arguments
---------
stft : torch.Tensor
A tensor, output from the stft function.
power : int
What power to use in computing the magnitude.
Use power=1 for the power spectrogram.
Use power=0.5 for the magnitude spectrogram.
log : bool
Whether to apply log to the spectral features.
Example
-------
>>> a = torch.Tensor([[3, 4]])
>>> spectral_magnitude(a, power=0.5)
tensor([5.])
"""
spectr = stft.pow(2).sum(-1)
# Add eps avoids NaN when spectr is zero
if power < 1:
spectr = spectr + eps
spectr = spectr.pow(power)
if log:
return torch.log(spectr + eps)
return spectr
[docs]
class Filterbank(torch.nn.Module):
"""computes filter bank (FBANK) features given spectral magnitudes.
Arguments
---------
n_mels : float
Number of Mel filters used to average the spectrogram.
log_mel : bool
If True, it computes the log of the FBANKs.
filter_shape : str
Shape of the filters ('triangular', 'rectangular', 'gaussian').
f_min : int
Lowest frequency for the Mel filters.
f_max : int
Highest frequency for the Mel filters.
n_fft : int
Number of fft points of the STFT. It defines the frequency resolution
(n_fft should be<= than win_len).
sample_rate : int
Sample rate of the input audio signal (e.g, 16000)
power_spectrogram : float
Exponent used for spectrogram computation.
amin : float
Minimum amplitude (used for numerical stability).
ref_value : float
Reference value used for the dB scale.
top_db : float
Minimum negative cut-off in decibels.
freeze : bool
If False, it the central frequency and the band of each filter are
added into nn.parameters. If True, the standard frozen features
are computed.
param_change_factor: bool
If freeze=False, this parameter affects the speed at which the filter
parameters (i.e., central_freqs and bands) can be changed. When high
(e.g., param_change_factor=1) the filters change a lot during training.
When low (e.g. param_change_factor=0.1) the filter parameters are more
stable during training
param_rand_factor: float
This parameter can be used to randomly change the filter parameters
(i.e, central frequencies and bands) during training. It is thus a
sort of regularization. param_rand_factor=0 does not affect, while
param_rand_factor=0.15 allows random variations within +-15% of the
standard values of the filter parameters (e.g., if the central freq
is 100 Hz, we can randomly change it from 85 Hz to 115 Hz).
Example
-------
>>> import torch
>>> compute_fbanks = Filterbank()
>>> inputs = torch.randn([10, 101, 201])
>>> features = compute_fbanks(inputs)
>>> features.shape
torch.Size([10, 101, 40])
"""
def __init__(
self,
n_mels=40,
log_mel=True,
filter_shape="triangular",
f_min=0,
f_max=8000,
n_fft=400,
sample_rate=16000,
power_spectrogram=2,
amin=1e-10,
ref_value=1.0,
top_db=80.0,
param_change_factor=1.0,
param_rand_factor=0.0,
freeze=True,
):
super().__init__()
self.n_mels = n_mels
self.log_mel = log_mel
self.filter_shape = filter_shape
self.f_min = f_min
self.f_max = f_max
self.n_fft = n_fft
self.sample_rate = sample_rate
self.power_spectrogram = power_spectrogram
self.amin = amin
self.ref_value = ref_value
self.top_db = top_db
self.freeze = freeze
self.n_stft = self.n_fft // 2 + 1
self.db_multiplier = math.log10(max(self.amin, self.ref_value))
self.device_inp = torch.device("cpu")
self.param_change_factor = param_change_factor
self.param_rand_factor = param_rand_factor
if self.power_spectrogram == 2:
self.multiplier = 10
else:
self.multiplier = 20
# Make sure f_min < f_max
if self.f_min >= self.f_max:
err_msg = "Require f_min: %f < f_max: %f" % (
self.f_min,
self.f_max,
)
logger.error(err_msg, exc_info=True)
# Filter definition
mel = torch.linspace(
self._to_mel(self.f_min), self._to_mel(self.f_max), self.n_mels + 2
)
hz = self._to_hz(mel)
# Computation of the filter bands
band = hz[1:] - hz[:-1]
self.band = band[:-1]
self.f_central = hz[1:-1]
# Adding the central frequency and the band to the list of nn param
if not self.freeze:
self.f_central = torch.nn.Parameter(
self.f_central / (self.sample_rate * self.param_change_factor)
)
self.band = torch.nn.Parameter(
self.band / (self.sample_rate * self.param_change_factor)
)
# Frequency axis
all_freqs = torch.linspace(0, self.sample_rate // 2, self.n_stft)
# Replicating for all the filters
self.all_freqs_mat = all_freqs.repeat(self.f_central.shape[0], 1)
[docs]
def forward(self, spectrogram):
"""Returns the FBANks.
Arguments
---------
x : tensor
A batch of spectrogram tensors.
"""
# Computing central frequency and bandwidth of each filter
f_central_mat = self.f_central.repeat(
self.all_freqs_mat.shape[1], 1
).transpose(0, 1)
band_mat = self.band.repeat(self.all_freqs_mat.shape[1], 1).transpose(
0, 1
)
# Uncomment to print filter parameters
# print(self.f_central*self.sample_rate * self.param_change_factor)
# print(self.band*self.sample_rate* self.param_change_factor)
# Creation of the multiplication matrix. It is used to create
# the filters that average the computed spectrogram.
if not self.freeze:
f_central_mat = f_central_mat * (
self.sample_rate
* self.param_change_factor
* self.param_change_factor
)
band_mat = band_mat * (
self.sample_rate
* self.param_change_factor
* self.param_change_factor
)
# Regularization with random changes of filter central frequency and band
elif self.param_rand_factor != 0 and self.training:
rand_change = (
1.0
+ torch.rand(2) * 2 * self.param_rand_factor
- self.param_rand_factor
)
f_central_mat = f_central_mat * rand_change[0]
band_mat = band_mat * rand_change[1]
fbank_matrix = self._create_fbank_matrix(f_central_mat, band_mat).to(
spectrogram.device
)
sp_shape = spectrogram.shape
# Managing multi-channels case (batch, time, channels)
if len(sp_shape) == 4:
spectrogram = spectrogram.permute(0, 3, 1, 2)
spectrogram = spectrogram.reshape(
sp_shape[0] * sp_shape[3], sp_shape[1], sp_shape[2]
)
# FBANK computation
fbanks = torch.matmul(spectrogram, fbank_matrix)
if self.log_mel:
fbanks = self._amplitude_to_DB(fbanks)
# Reshaping in the case of multi-channel inputs
if len(sp_shape) == 4:
fb_shape = fbanks.shape
fbanks = fbanks.reshape(
sp_shape[0], sp_shape[3], fb_shape[1], fb_shape[2]
)
fbanks = fbanks.permute(0, 2, 3, 1)
return fbanks
@staticmethod
def _to_mel(hz):
"""Returns mel-frequency value corresponding to the input
frequency value in Hz.
Arguments
---------
x : float
The frequency point in Hz.
"""
return 2595 * math.log10(1 + hz / 700)
@staticmethod
def _to_hz(mel):
"""Returns hz-frequency value corresponding to the input
mel-frequency value.
Arguments
---------
x : float
The frequency point in the mel-scale.
"""
return 700 * (10 ** (mel / 2595) - 1)
def _triangular_filters(self, all_freqs, f_central, band):
"""Returns fbank matrix using triangular filters.
Arguments
---------
all_freqs : Tensor
Tensor gathering all the frequency points.
f_central : Tensor
Tensor gathering central frequencies of each filter.
band : Tensor
Tensor gathering the bands of each filter.
"""
# Computing the slops of the filters
slope = (all_freqs - f_central) / band
left_side = slope + 1.0
right_side = -slope + 1.0
# Adding zeros for negative values
zero = torch.zeros(1, device=self.device_inp)
fbank_matrix = torch.max(
zero, torch.min(left_side, right_side)
).transpose(0, 1)
return fbank_matrix
def _rectangular_filters(self, all_freqs, f_central, band):
"""Returns fbank matrix using rectangular filters.
Arguments
---------
all_freqs : Tensor
Tensor gathering all the frequency points.
f_central : Tensor
Tensor gathering central frequencies of each filter.
band : Tensor
Tensor gathering the bands of each filter.
"""
# cut-off frequencies of the filters
low_hz = f_central - band
high_hz = f_central + band
# Left/right parts of the filter
left_side = right_size = all_freqs.ge(low_hz)
right_size = all_freqs.le(high_hz)
fbank_matrix = (left_side * right_size).float().transpose(0, 1)
return fbank_matrix
def _gaussian_filters(
self, all_freqs, f_central, band, smooth_factor=torch.tensor(2)
):
"""Returns fbank matrix using gaussian filters.
Arguments
---------
all_freqs : Tensor
Tensor gathering all the frequency points.
f_central : Tensor
Tensor gathering central frequencies of each filter.
band : Tensor
Tensor gathering the bands of each filter.
smooth_factor: Tensor
Smoothing factor of the gaussian filter. It can be used to employ
sharper or flatter filters.
"""
fbank_matrix = torch.exp(
-0.5 * ((all_freqs - f_central) / (band / smooth_factor)) ** 2
).transpose(0, 1)
return fbank_matrix
def _create_fbank_matrix(self, f_central_mat, band_mat):
"""Returns fbank matrix to use for averaging the spectrum with
the set of filter-banks.
Arguments
---------
f_central : Tensor
Tensor gathering central frequencies of each filter.
band : Tensor
Tensor gathering the bands of each filter.
smooth_factor: Tensor
Smoothing factor of the gaussian filter. It can be used to employ
sharper or flatter filters.
"""
if self.filter_shape == "triangular":
fbank_matrix = self._triangular_filters(
self.all_freqs_mat, f_central_mat, band_mat
)
elif self.filter_shape == "rectangular":
fbank_matrix = self._rectangular_filters(
self.all_freqs_mat, f_central_mat, band_mat
)
else:
fbank_matrix = self._gaussian_filters(
self.all_freqs_mat, f_central_mat, band_mat
)
return fbank_matrix
def _amplitude_to_DB(self, x):
"""Converts linear-FBANKs to log-FBANKs.
Arguments
---------
x : Tensor
A batch of linear FBANK tensors.
"""
x_db = self.multiplier * torch.log10(torch.clamp(x, min=self.amin))
x_db -= self.multiplier * self.db_multiplier
# Setting up dB max. It is the max over time and frequency,
# Hence, of a whole sequence (sequence-dependent)
new_x_db_max = x_db.amax(dim=(-2, -1)) - self.top_db
# Clipping to dB max. The view is necessary as only a scalar is obtained
# per sequence.
x_db = torch.max(x_db, new_x_db_max.view(x_db.shape[0], 1, 1))
return x_db
[docs]
class DCT(torch.nn.Module):
"""Computes the discrete cosine transform.
This class is primarily used to compute MFCC features of an audio signal
given a set of FBANK features as input.
Arguments
---------
input_size : int
Expected size of the last dimension in the input.
n_out : int
Number of output coefficients.
ortho_norm : bool
Whether to use orthogonal norm.
Example
-------
>>> import torch
>>> inputs = torch.randn([10, 101, 40])
>>> compute_mfccs = DCT(input_size=inputs.size(-1))
>>> features = compute_mfccs(inputs)
>>> features.shape
torch.Size([10, 101, 20])
"""
def __init__(
self, input_size, n_out=20, ortho_norm=True,
):
super().__init__()
if n_out > input_size:
raise ValueError(
"Cannot select more DCT coefficients than inputs "
"(n_out=%i, n_in=%i)" % (n_out, input_size)
)
# Generate matix for DCT transformation
n = torch.arange(float(input_size))
k = torch.arange(float(n_out)).unsqueeze(1)
dct = torch.cos(math.pi / float(input_size) * (n + 0.5) * k)
if ortho_norm:
dct[0] *= 1.0 / math.sqrt(2.0)
dct *= math.sqrt(2.0 / float(input_size))
else:
dct *= 2.0
self.dct_mat = dct.t()
[docs]
def forward(self, x):
"""Returns the DCT of the input tensor.
Arguments
---------
x : tensor
A batch of tensors to transform, usually fbank features.
"""
# Managing multi-channels case
input_shape = x.shape
if len(input_shape) == 4:
x = x.reshape(x.shape[0] * x.shape[3], x.shape[1], x.shape[2])
# apply the DCT transform
dct = torch.matmul(x, self.dct_mat.to(x.device))
# Reshape in the case of multi-channels
if len(input_shape) == 4:
dct = dct.reshape(
input_shape[0], dct.shape[1], dct.shape[2], input_shape[3]
)
return dct
[docs]
class Deltas(torch.nn.Module):
"""Computes delta coefficients (time derivatives).
Arguments
---------
win_length : int
Length of the window used to compute the time derivatives.
Example
-------
>>> inputs = torch.randn([10, 101, 20])
>>> compute_deltas = Deltas(input_size=inputs.size(-1))
>>> features = compute_deltas(inputs)
>>> features.shape
torch.Size([10, 101, 20])
"""
def __init__(
self, input_size, window_length=5,
):
super().__init__()
self.n = (window_length - 1) // 2
self.denom = self.n * (self.n + 1) * (2 * self.n + 1) / 3
self.register_buffer(
"kernel",
torch.arange(-self.n, self.n + 1, dtype=torch.float32,).repeat(
input_size, 1, 1
),
)
[docs]
def forward(self, x):
"""Returns the delta coefficients.
Arguments
---------
x : tensor
A batch of tensors.
"""
# Managing multi-channel deltas reshape tensor (batch*channel,time)
x = x.transpose(1, 2).transpose(2, -1)
or_shape = x.shape
if len(or_shape) == 4:
x = x.reshape(or_shape[0] * or_shape[2], or_shape[1], or_shape[3])
# Padding for time borders
x = torch.nn.functional.pad(x, (self.n, self.n), mode="replicate")
# Derivative estimation (with a fixed convolutional kernel)
delta_coeff = (
torch.nn.functional.conv1d(
x, self.kernel.to(x.device), groups=x.shape[1]
)
/ self.denom
)
# Retrieving the original dimensionality (for multi-channel case)
if len(or_shape) == 4:
delta_coeff = delta_coeff.reshape(
or_shape[0], or_shape[1], or_shape[2], or_shape[3],
)
delta_coeff = delta_coeff.transpose(1, -1).transpose(2, -1)
return delta_coeff
[docs]
class ContextWindow(torch.nn.Module):
"""Computes the context window.
This class applies a context window by gathering multiple time steps
in a single feature vector. The operation is performed with a
convolutional layer based on a fixed kernel designed for that.
Arguments
---------
left_frames : int
Number of left frames (i.e, past frames) to collect.
right_frames : int
Number of right frames (i.e, future frames) to collect.
Example
-------
>>> import torch
>>> compute_cw = ContextWindow(left_frames=5, right_frames=5)
>>> inputs = torch.randn([10, 101, 20])
>>> features = compute_cw(inputs)
>>> features.shape
torch.Size([10, 101, 220])
"""
def __init__(
self, left_frames=0, right_frames=0,
):
super().__init__()
self.left_frames = left_frames
self.right_frames = right_frames
self.context_len = self.left_frames + self.right_frames + 1
self.kernel_len = 2 * max(self.left_frames, self.right_frames) + 1
# Kernel definition
self.kernel = torch.eye(self.context_len, self.kernel_len)
if self.right_frames > self.left_frames:
lag = self.right_frames - self.left_frames
self.kernel = torch.roll(self.kernel, lag, 1)
self.first_call = True
[docs]
def forward(self, x):
"""Returns the tensor with the surrounding context.
Arguments
---------
x : tensor
A batch of tensors.
"""
x = x.transpose(1, 2)
if self.first_call is True:
self.first_call = False
self.kernel = (
self.kernel.repeat(x.shape[1], 1, 1)
.view(x.shape[1] * self.context_len, self.kernel_len,)
.unsqueeze(1)
)
# Managing multi-channel case
or_shape = x.shape
if len(or_shape) == 4:
x = x.reshape(or_shape[0] * or_shape[2], or_shape[1], or_shape[3])
# Compute context (using the estimated convolutional kernel)
cw_x = torch.nn.functional.conv1d(
x,
self.kernel.to(x.device),
groups=x.shape[1],
padding=max(self.left_frames, self.right_frames),
)
# Retrieving the original dimensionality (for multi-channel case)
if len(or_shape) == 4:
cw_x = cw_x.reshape(
or_shape[0], cw_x.shape[1], or_shape[2], cw_x.shape[-1]
)
cw_x = cw_x.transpose(1, 2)
return cw_x
[docs]
class GlobalNorm(torch.nn.Module):
"""A global normalization module - computes a single mean and standard deviation
for the entire batch across unmasked positions and uses it to normalize the
inputs to the desired mean and standard deviation.
This normalization is reversible - it is possible to use the .denormalize()
method to reover the original values.
Arguments
---------
norm_mean: float
the desired normalized mean
norm_std: float
the desired normalized standard deviation
update_steps: float
the number of steps over which statistics will be collected
length_dim: int
the dimension used to represent the length
mask_value: float
the value with which to fill masked positions
without a mask_value, the masked positions would be normalized,
which might not be desired
Example
-------
>>> import torch
>>> from speechbrain.processing.features import GlobalNorm
>>> global_norm = GlobalNorm(
... norm_mean=0.5,
... norm_std=0.2,
... update_steps=3,
... length_dim=1
... )
>>> x = torch.tensor([[1., 2., 3.]])
>>> x_norm = global_norm(x)
>>> x_norm
tensor([[0.3000, 0.5000, 0.7000]])
>>> x = torch.tensor([[5., 10., -4.]])
>>> x_norm = global_norm(x)
>>> x_norm
tensor([[0.6071, 0.8541, 0.1623]])
>>> x_denorm = global_norm.denormalize(x_norm)
>>> x_denorm
tensor([[ 5.0000, 10.0000, -4.0000]])
>>> x = torch.tensor([[100., -100., -50.]])
>>> global_norm.freeze()
>>> global_norm(x)
tensor([[ 5.3016, -4.5816, -2.1108]])
>>> global_norm.denormalize(x_norm)
tensor([[ 5.0000, 10.0000, -4.0000]])
>>> global_norm.unfreeze()
>>> global_norm(x)
tensor([[ 5.3016, -4.5816, -2.1108]])
>>> global_norm.denormalize(x_norm)
tensor([[ 5.0000, 10.0000, -4.0000]])
"""
def __init__(
self,
norm_mean=0.0,
norm_std=1.0,
update_steps=None,
length_dim=2,
mask_value=0.0,
):
super().__init__()
running_mean = torch.tensor(0.0)
running_std = torch.tensor(0.0)
weight = torch.tensor(0.0)
self.register_buffer("running_mean", running_mean)
self.register_buffer("running_std", running_std)
self.register_buffer("weight", weight)
self.norm_mean = norm_mean
self.norm_std = norm_std
self.mask_value = mask_value
self.step_count = 0
self.update_steps = update_steps
self.length_dim = length_dim
self.frozen = False
[docs]
def forward(self, x, lengths=None, mask_value=None, skip_update=False):
"""Normalizes the tensor provided
Arguments
---------
x: torch.Tensor
the tensor to normalize
lengths: torch.Tensor
a tensor of relative lengths (padding will not
count towards normalization)
mask_value: float
the value to use for masked positions
skip_update: false
whether to skip updates to the norm
Returns
-------
result: torch.Tensor
the normalized tensor
"""
if lengths is None:
lengths = torch.ones(len(x))
if mask_value is None:
mask_value = self.mask_value
mask = self.get_mask(x, lengths)
if (
not skip_update
and not self.frozen
and (
self.update_steps is None or self.step_count < self.update_steps
)
):
x_masked = x.masked_select(mask)
mean = x_masked.mean()
std = x_masked.std()
weight = lengths.sum()
# TODO: Numerical stability
new_weight = self.weight + weight
self.running_mean.data = (
self.weight * self.running_mean + weight * mean
) / new_weight
self.running_std.data = (
self.weight * self.running_std + weight * std
) / new_weight
self.weight.data = new_weight
x = self.normalize(x)
if not torch.is_tensor(mask_value):
mask_value = torch.tensor(mask_value, device=x.device)
mask_value_norm = self.normalize(mask_value)
x = x.masked_fill(~mask, mask_value_norm)
self.step_count += 1
return x
[docs]
def normalize(self, x):
"""Performs the normalization operation against the running
mean and standard deviation
Arguments
---------
x: torch.Tensor
the tensor to normalize
Returns
-------
result: torch.Tensor
the normalized tensor
"""
x = (x - self.running_mean) / self.running_std
x = (x * self.norm_std) + self.norm_mean
return x
[docs]
def get_mask(self, x, lengths):
"""Returns the length mask for the specified tensor
Arguments
---------
x: torch.Tensor
the tensor for which the mask will be obtained
lengths: torch.Tensor
the length tensor
Returns
-------
mask: torch.Tensor
the mask tensor
"""
max_len = x.size(self.length_dim)
mask = length_to_mask(lengths * max_len, max_len)
for dim in range(1, x.dim()):
if dim != self.length_dim:
mask = mask.unsqueeze(dim)
mask = mask.expand_as(x).bool()
return mask
[docs]
def denormalize(self, x):
"""Reverses the normalization proces
Arguments
---------
x: torch.Tensor
a normalized tensor
Returns
-------
result: torch.Tensor
a denormalized version of x
"""
x = (x - self.norm_mean) / self.norm_std
x = x * self.running_std + self.running_mean
return x
[docs]
def freeze(self):
"""Stops updates to the running mean/std"""
self.frozen = True
[docs]
def unfreeze(self):
"""Resumes updates to the running mean/std"""
self.frozen = False
[docs]
class MinLevelNorm(torch.nn.Module):
"""A commonly used normalization for the decibel scale
The scheme is as follows
x_norm = (x - min_level_db)/-min_level_db * 2 - 1
The rationale behind the scheme is as follows:
The top of the scale is assumed to be 0db.
x_rel = (x - min) / (max - min) gives the relative position on the scale
between the minimum and the maximum where the minimum is 0. and the
maximum is 1.
The subsequent rescaling (x_rel * 2 - 1) puts it on a scale from -1. to 1.
with the middle of the range centered at zero.
Arguments
---------
min_level_db: float
the minimum level
Example
-------
>>> norm = MinLevelNorm(min_level_db=-100.)
>>> x = torch.tensor([-50., -20., -80.])
>>> x_norm = norm(x)
>>> x_norm
tensor([ 0.0000, 0.6000, -0.6000])
"""
def __init__(self, min_level_db):
super().__init__()
self.min_level_db = min_level_db
[docs]
def forward(self, x):
"""Normalizes audio features in decibels (usually spectrograms)
Arguments
---------
x: torch.Tensor
input features
Returns
-------
normalized_features: torch.Tensor
the normalized features
"""
x = (x - self.min_level_db) / -self.min_level_db
x *= 2.0
x = x - 1.0
x = torch.clip(x, -1, 1)
return x
[docs]
def denormalize(self, x):
"""Reverses the min level normalization process
Arguments
---------
x: torch.Tensor
the normalized tensor
Returns
-------
result: torch.Tensor
the denormalized tensor
"""
x = torch.clip(x, -1, 1)
x = (x + 1.0) / 2.0
x *= -self.min_level_db
x += self.min_level_db
return x
[docs]
class DynamicRangeCompression(torch.nn.Module):
"""Dynamic range compression for audio signals - clipped log scale
with an optional multiplier
Arguments
---------
multiplier: float
the multiplier constant
clip_val: float
the minimum accepted value (values below this
minimum will be clipped)
Example
-------
>>> drc = DynamicRangeCompression()
>>> x = torch.tensor([10., 20., 0., 30.])
>>> drc(x)
tensor([ 2.3026, 2.9957, -11.5129, 3.4012])
>>> drc = DynamicRangeCompression(2.)
>>> x = torch.tensor([10., 20., 0., 30.])
>>> drc(x)
tensor([ 2.9957, 3.6889, -10.8198, 4.0943])
"""
def __init__(self, multiplier=1, clip_val=1e-5):
super().__init__()
self.multiplier = multiplier
self.clip_val = clip_val
[docs]
def forward(self, x):
"""Performs the forward pass
Arguments
---------
x: torch.Tensor
the source signal
Returns
-------
result: torch.Tensor
the result
"""
return torch.log(torch.clamp(x, min=self.clip_val) * self.multiplier)