audiomentations 0.33.0

A Python library for audio data augmentation. Inspired by albumentations. Useful for machine learning.

Audiomentations

A Python library for audio data augmentation. Inspired by albumentations. Useful for deep learning. Runs on CPU. Supports mono audio and multichannel audio. Can be integrated in training pipelines in e.g. Tensorflow/Keras or Pytorch. Has helped people get world-class results in Kaggle competitions. Is used by companies making next-generation audio products.

Need a Pytorch-specific alternative with GPU support? Check out torch-audiomentations!

Setup

pip install audiomentations

Usage example

from audiomentations import Compose, AddGaussianNoise, TimeStretch, PitchShift, Shift
import numpy as np

augment = Compose([
    AddGaussianNoise(min_amplitude=0.001, max_amplitude=0.015, p=0.5),
    TimeStretch(min_rate=0.8, max_rate=1.25, p=0.5),
    PitchShift(min_semitones=-4, max_semitones=4, p=0.5),
    Shift(min_fraction=-0.5, max_fraction=0.5, p=0.5),
])

# Generate 2 seconds of dummy audio for the sake of example
samples = np.random.uniform(low=-0.2, high=0.2, size=(32000,)).astype(np.float32)

# Augment/transform/perturb the audio data
augmented_samples = augment(samples=samples, sample_rate=16000)

Documentation

The API documentation, along with guides, example code, illustrations and example sounds, is available at https://iver56.github.io/audiomentations/

Transforms

• AddBackgroundNoise: Mixes in another sound to add background noise
• AddGaussianNoise: Adds gaussian noise to the audio samples
• AddGaussianSNR: Injects gaussian noise using a randomly chosen signal-to-noise ratio
• AddShortNoises: Mixes in various short noise sounds
• AdjustDuration: Trims or pads the audio to fit a target duration
• AirAbsorption: Applies frequency-dependent attenuation simulating air absorption
• ApplyImpulseResponse: Convolves the audio with a randomly chosen impulse response
• BandPassFilter: Applies band-pass filtering within randomized parameters
• BandStopFilter: Applies band-stop (notch) filtering within randomized parameters
• Clip: Clips audio samples to specified minimum and maximum values
• ClippingDistortion: Distorts the signal by clipping a random percentage of samples
• Gain: Multiplies the audio by a random gain factor
• GainTransition: Gradually changes the gain over a random time span
• HighPassFilter: Applies high-pass filtering within randomized parameters
• HighShelfFilter: Applies a high shelf filter with randomized parameters
• Lambda: Applies a user-defined transform
• Limiter: Applies dynamic range compression limiting the audio signal
• LoudnessNormalization: Applies gain to match a target loudness
• LowPassFilter: Applies low-pass filtering within randomized parameters
• LowShelfFilter: Applies a low shelf filter with randomized parameters
• Mp3Compression: Compresses the audio to lower the quality
• Normalize: Applies gain so that the highest signal level becomes 0 dBFS
• Padding: Replaces a random part of the beginning or end with padding
• PeakingFilter: Applies a peaking filter with randomized parameters
• PitchShift: Shifts the pitch up or down without changing the tempo
• PolarityInversion: Flips the audio samples upside down, reversing their polarity
• RepeatPart: Repeats a subsection of the audio a number of times
• Resample: Resamples the signal to a randomly chosen sampling rate
• Reverse: Reverses the audio along its time axis
• RoomSimulator: Simulates the effect of a room on an audio source
• SevenBandParametricEQ: Adjusts the volume of 7 frequency bands
• Shift: Shifts the samples forwards or backwards
• SpecChannelShuffle: Shuffles channels in the spectrogram
• SpecFrequencyMask: Applies a frequency mask to the spectrogram
• TanhDistortion: Applies tanh distortion to distort the signal
• TimeMask: Makes a random part of the audio silent
• TimeStretch: Changes the speed without changing the pitch
• Trim: Trims leading and trailing silence from the audio

Changelog

[0.33.0] - 2023-08-30

Changed

• Bump min numpy version from 1.16 to 1.18
• Bump min scipy version from 1.3 to 1.4
• Bump min python version from 3.7 to 3.8, because 3.7 is beyond end-of-life already
• Change some AssertionError exceptions to ValueError

:warning: The Shift transform has been changed:

• Removed fade parameter. fade_duration=0.0 now denotes disabled fading.
• Rename min_fraction to min_shift and max_fraction to max_shift
• Add shift_unit parameter
• Smoother fade curve

These are breaking changes. The following example shows how you can adapt your code when upgrading from <=v0.32.0 to >=v0.33.0:

<= 0.32.0	>= 0.33.0
Shift(min_fraction=-0.5, max_fraction=0.5, fade=True, fade_duration=0.01)	Shift(min_shift=-0.5, max_shift=0.5, shift_unit="fraction", fade_duration=0.01)

Fixed

• Correct some wrong type hints

For the full changelog, including older versions, see https://iver56.github.io/audiomentations/changelog/

Acknowledgements

Thanks to Nomono for backing audiomentations.

Thanks to all contributors who help improving audiomentations.