Librosa

-------
2025-03-11

Maintenance
- `1831`_ Numpy 2.0 is now supported.
- `1898`_ Updated codecov action. *Brian McFee*
- `1860`_ Updated GitHub issue templates. *Brian McFee*
- `1921`_ Added linux-arm64 to the test matrix. *Brian McFee*

Enhancements
- `1916`_ The default FFT backend has been changed from `numpy` to `scipy`.
- `1864`_ Accelerated `abs2` calculation on real-typed inputs. *Brian McFee*

Bug fixes
- `1916`_ Utility decorators now preserve type annotations properly. *Brian McFee*
- `1900`_ Fixed an error in pooch registry definition. *Brian McFee*
- `1897`_ Accommodate dependency resolution issues with `uv`. *David Südholt*
- `1878`_ Improved accuracy for `yin` and `pyin`. *David Südholt*
- `1851`_ Fixed sparse matrix compatibility for scipy>=1.14. *Brian McFee*
- `1844`_ Fixed parameter name collision for norm argument in `feature.mfcc`. *Slava Chaunin*

Documentation
- `1899`_ Avoid documentation link-checking failures from unreliable URLs. *Brian McFee*
- `1891`_ Corrected typo in effects module. *Scott VanRavenswaay*
- `1878`_ Numerous documentation updates (spectral centroid, `key_to_notes`, `effects.trim`). *Brian McFee*
- `1866`_ Updated documentation for `dtw`. *Brian McFee*
- `1858`_ Fixed documentation example for onset detection. *BenedictSt*
- `1856`_ Updated documentation example for Fast Mellin Transform. *Anmol Mishra*

Deprecations
- `1916`_ `librosa.set_fftlib` is deprecated and will be removed in version 1.0. Users should transition to using `scipy.fft.set_backend` instead.
- Expired deprecation of `mono=` parameter in `util.valid_audio`.
- `win_length` parameter in `yin` and `pyin`

.. _1921: https://github.com/librosa/librosa/pull/1921
.. _1916: https://github.com/librosa/librosa/pull/1916
.. _1831: https://github.com/librosa/librosa/pull/1831
.. _1898: https://github.com/librosa/librosa/pull/1898
.. _1860: https://github.com/librosa/librosa/pull/1860
.. _1864: https://github.com/librosa/librosa/pull/1864
.. _1900: https://github.com/librosa/librosa/pull/1900
.. _1897: https://github.com/librosa/librosa/pull/1897
.. _1878: https://github.com/librosa/librosa/pull/1878
.. _1851: https://github.com/librosa/librosa/pull/1851
.. _1844: https://github.com/librosa/librosa/pull/1844
.. _1899: https://github.com/librosa/librosa/pull/1899
.. _1891: https://github.com/librosa/librosa/pull/1891
.. _1866: https://github.com/librosa/librosa/pull/1866
.. _1858: https://github.com/librosa/librosa/pull/1858
.. _1856: https://github.com/librosa/librosa/pull/1856

-------------
2024-05-14

Maintenance
- `1839`_ Updated minimum matplotlib to 3.5.0. There are no changes to the code in this release, only package metadata and tests.


.. _1839: https://github.com/librosa/librosa/pull/1839

-------
2024-05-02


New features
- `1829`_ `librosa.cite()` returns a DOI (document object identifier) for citing librosa in academic publications. *Brian McFee*
- `1766`_ `librosa.beat.beat_track`, `librosa.onset.onset_detect`, and `librosa.util.peak_pick` now support multi-channel inputs. *Brian McFee*
- `1739`_, `1756`_, `1762`_ `key_to_degrees` and `key_to_notes` now support multiple accidentals in the tonic, and modes (ionian, dorian, etc). *Eugene Rabinovich*
- `1770`_ Out-of-key notes are now optionally decorated with natural (♮) accidentals. *Eugene Rabinovich*

Bug fixes
- `1814`_ Corrected an off-by-one error when computing phase advance in `librosa.phase_vocoder`. *Brian McFee*
- `1784`_ Improved handling of warnings in the test suite, and fixed a bug in dtype propagation through `ivqt`. *Brian McFee*
- `1733`_ Fixed an off-by-one error in trimming of detected beats. *Brian McFee*
- `1755`_ Avoid deprecated features in matplotlib and ensure compatibility with mpl 3.8. *Brian McFee*

Documentation
- `1827`_ Improvements to example code in documentation to include sampling rate parameters whenever necessary. *Brian McFee*
- `1821`_ Added "copy button" to code examples in documentation. *Brian McFee*
- `1789`_ Fixed type annotations for sampling rate parameters. *Brian McFee*
- `1780`_ Corrected mistake in `util.frame` documentation. *Gao Lei*
- `1783`_ Removed problematic language from test code and documentation. *Dan Ellis*

Other changes and maintenance
- `1826`_ Expanded parameter pass-through support in `effects.hpss` and related functions. *Brian McFee*
- `1822`_ Allow `display.specshow` to control min and max tempo in tempogram plots. *Brian McFee*
- `1820`_ Updated github actions. *Brian McFee*
- `1813`_ Improved performance of `autocorrelate`. *Jize Guo*
- `1808`_, `1769`_ Added python 3.11 and 3.12 to CI test matrix. *Brian McFee*
- `1790`_ Explicitly allow scalar inputs in decibel conversions. *Brian McFee*
- `1782`_ Modernized usage of matplotlib colormaps. *Phillip S.M. Skelton*
- `1765`_ Modernized usage of importlib and package resources. *Matt Pitkin*

.. _1829: https://github.com/librosa/librosa/issues/1829
.. _1766: https://github.com/librosa/librosa/issues/1766
.. _1739: https://github.com/librosa/librosa/issues/1739
.. _1756: https://github.com/librosa/librosa/issues/1756
.. _1762: https://github.com/librosa/librosa/issues/1762
.. _1770: https://github.com/librosa/librosa/issues/1770
.. _1814: https://github.com/librosa/librosa/issues/1814
.. _1784: https://github.com/librosa/librosa/issues/1784
.. _1733: https://github.com/librosa/librosa/issues/1733
.. _1755: https://github.com/librosa/librosa/issues/1755
.. _1827: https://github.com/librosa/librosa/issues/1827
.. _1821: https://github.com/librosa/librosa/issues/1821
.. _1789: https://github.com/librosa/librosa/issues/1789
.. _1780: https://github.com/librosa/librosa/issues/1780
.. _1783: https://github.com/librosa/librosa/issues/1783
.. _1826: https://github.com/librosa/librosa/issues/1826
.. _1822: https://github.com/librosa/librosa/issues/1822
.. _1820: https://github.com/librosa/librosa/issues/1820
.. _1813: https://github.com/librosa/librosa/issues/1813
.. _1808: https://github.com/librosa/librosa/issues/1808
.. _1769: https://github.com/librosa/librosa/issues/1769
.. _1790: https://github.com/librosa/librosa/issues/1790
.. _1782: https://github.com/librosa/librosa/issues/1782
.. _1765: https://github.com/librosa/librosa/issues/1765

-------
2023-08-16

This release consists primarily of corrections to documentation and updates to tests and development
environment specifications.


Bug fixes
- `1677`_ Correct handling of octave boundaries in Variable-Q transform. *Brian McFee*
- `1693`_ Stricter checks on yin and pyin parameters. *Brian McFee*
- `1726`_ Enforce consistency of time-to-sample unit conversion. *Brian McFee*


Documentation
- `1699`_ Update the documentation to support sphinx 6.x. *Brian McFee*
- `1703`_ Corrected `pitch_shift` documentation for `bins_per_octave`. *Shin Hyun*
- `1706`_ Corrected typo on README.md. *Iliya S.*
- `1713`_ Multiple minor documentation updates. *Brian McFee*
- `1718`_ Added continuous integration action for documentation builds. *Brian McFee*
- `1719`_ Added advanced example for patch generation. *Brian McFee*

Other changes
- `1704`_ Added `scale=` parameter to `effects.pitch_shift`. *Shin Hyun*
- `1722`_ Restructured `lazy_loader` usage of matplotlib. *Brian McFee*
- `1727`_ Support `pooch>=1.7.0`. *Brian McFee*
- `1731`_ Update test suite to support `scipy>=1.11`. *Brian McFee*

.. _1677: https://github.com/librosa/librosa/issues/1677
.. _1693: https://github.com/librosa/librosa/issues/1693
.. _1726: https://github.com/librosa/librosa/issues/1726
.. _1699: https://github.com/librosa/librosa/issues/1699
.. _1703: https://github.com/librosa/librosa/issues/1703
.. _1706: https://github.com/librosa/librosa/issues/1706
.. _1713: https://github.com/librosa/librosa/issues/1713
.. _1718: https://github.com/librosa/librosa/issues/1718
.. _1719: https://github.com/librosa/librosa/issues/1719
.. _1704: https://github.com/librosa/librosa/issues/1704
.. _1722: https://github.com/librosa/librosa/issues/1722
.. _1727: https://github.com/librosa/librosa/issues/1727
.. _1731: https://github.com/librosa/librosa/issues/1731

-------------
2023-03-17

This maintenance release updates the dependency specifications to avoid an incompatibility with
pooch >= 1.7.0.
This restriction only affects loading of specific example files, and does not otherwise affect
functionality of the library.

-------------
2023-03-16

This maintenance release updates the dependency specifications to avoid an incompatibility with
numpy versions 1.22.0, 1.22.1, and 1.22.2. Functionality is otherwise identical to librosa version
0.10.0.