Skip to content

Commit

Permalink
Release v0.39.0
Browse files Browse the repository at this point in the history
  • Loading branch information
iver56 committed Feb 12, 2025
1 parent ce8d52a commit f9c8bbb
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 27 deletions.
32 changes: 10 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,36 +94,24 @@ The API documentation, along with guides, example code, illustrations and exampl

# Changelog

## [0.38.0] - 2024-12-06

### Added

* Add/improve parameter validation in `AddGaussianSNR`, `GainTransition`, `LoudnessNormalization` and `AddShortNoises`
* Add/update type hints for consistency
* Add human-readable string representation of audiomentations class instances
## [0.39.0] - 2025-02-12

### Changed

* Improve documentation with respect to consistency, clarity and grammar
* Adjust Python version compatibility range, so all patches of Python 3.12 are supported

### Removed
* Place an upper distance limit of 2500 meters in `AirAbsorption` in order to avoid numerical issues
* Expand the allowed shift range in `PitchShift` from [-12, 12] to [-24, 24]
* Switch to a higher quality method, `"signalsmith_stretch"`, in `PitchShift` and `TimeStretch`. It sounds significantly better (e.g. less smearing) and is 50-100% faster than `"librosa_phase_vocoder"`

* Remove deprecated *_in_db args in [Gain](https://iver56.github.io/audiomentations/waveform_transforms/gain/), [AddBackgroundNoise](https://iver56.github.io/audiomentations/waveform_transforms/add_background_noise/), [AddGaussianSNR](https://iver56.github.io/audiomentations/waveform_transforms/add_gaussian_snr/), [GainTransition](https://iver56.github.io/audiomentations/waveform_transforms/gain_transition/), [LoudnessNormalization](https://iver56.github.io/audiomentations/waveform_transforms/loudness_normalization/) and [AddShortNoises](https://iver56.github.io/audiomentations/waveform_transforms/add_short_noises/). Those args were deprecated since v0.31.0, and now they are gone. For details, check the documentation page of each transform.
If you want to keep using the old method, `"librosa_phase_vocoder"`, it can be done like this:

For example:

| Old (deprecated since v0.31.0) | New |
|--------------------------------|---------------------------|
| `Gain(min_gain_in_db=-12.0)` | `Gain(min_gain_db=-12.0)` |
```
PitchShift(method="librosa_phase_vocoder")
TimeStretch(method="librosa_phase_vocoder")
```

### Fixed

* Fix a bug where `AirAbsorption` often chose the wrong humidity bucket
* Fix wrong logic in validation check of relation between `crossfade_duration` and `min_part_duration` in `RepeatPart`
* Fix default value of `max_absolute_rms_db` in `AddBackgroundNoises`. It was incorrectly set to -45.0, but is now -15.0. This bug was introduced in v0.31.0.
* Fix various errors in the documentation of `AddShortNoises` and `AirAbsorption`
* Fix a bug where `AddShortNoises` sometimes raised a `ValueError` because of an empty array. This bug was introduced in v0.36.1.
* Fix a bug where `AddShortNoises(include_silence_in_noise_rms_estimation=False)` sometimes raised a `ValueError` due to digital silence in a portion of a short noise. This bug was introduced in v0.36.1.

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

Expand Down
2 changes: 1 addition & 1 deletion audiomentations/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@
from .spec_augmentations.spec_channel_shuffle import SpecChannelShuffle
from .spec_augmentations.spec_frequency_mask import SpecFrequencyMask

__version__ = "0.38.0"
__version__ = "0.39.0"
8 changes: 4 additions & 4 deletions demo/demo.py
Original file line number Diff line number Diff line change
Expand Up @@ -361,8 +361,8 @@ def __exit__(self, type, value, traceback):
{"instance": LowShelfFilter(p=1.0), "num_runs": 5},
{
"instance": PitchShift(
min_semitones=-24,
max_semitones=-24,
min_semitones=-4,
max_semitones=4,
method="librosa_phase_vocoder",
p=1.0,
),
Expand All @@ -371,8 +371,8 @@ def __exit__(self, type, value, traceback):
},
{
"instance": PitchShift(
min_semitones=-24,
max_semitones=-24,
min_semitones=-4,
max_semitones=4,
method="signalsmith_stretch",
p=1.0,
),
Expand Down
20 changes: 20 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.39.0] - 2025-02-12

### Changed

* Place an upper distance limit of 2500 meters in `AirAbsorption` in order to avoid numerical issues
* Expand the allowed shift range in `PitchShift` from [-12, 12] to [-24, 24]
* Switch to a higher quality method, `"signalsmith_stretch"`, in `PitchShift` and `TimeStretch`. It sounds significantly better (e.g. less smearing) and is 50-100% faster than `"librosa_phase_vocoder"`

If you want to keep using the old method, `"librosa_phase_vocoder"`, it can be done like this:

```
PitchShift(method="librosa_phase_vocoder")
TimeStretch(method="librosa_phase_vocoder")
```

### Fixed

* Fix a bug where `AddShortNoises(include_silence_in_noise_rms_estimation=False)` sometimes raised a `ValueError` due to digital silence in a portion of a short noise. This bug was introduced in v0.36.1.

## [0.38.0] - 2024-12-06

### Added
Expand Down Expand Up @@ -561,6 +580,7 @@ Thanks to karpnv

* Initial release. Includes only one transform: `AddGaussianNoise`

[0.39.0]: https://github.com/iver56/audiomentations/compare/v0.38.0...v0.39.0
[0.38.0]: https://github.com/iver56/audiomentations/compare/v0.37.0...v0.38.0
[0.37.0]: https://github.com/iver56/audiomentations/compare/v0.36.1...v0.37.0
[0.36.1]: https://github.com/iver56/audiomentations/compare/v0.36.0...v0.36.1
Expand Down

0 comments on commit f9c8bbb

Please sign in to comment.