Librosa

=====

-------
2023-02-20

New features
- `1485`_ Added support for `"h"` (hours) and `"m"` (minutes) in `librosa.display.TimeFormatter`. *Vincent Lostanlen*
- `1495`_ Expanded options for bandwidth calculation in `librosa.segment.recurrence_matrix` and `librosa.segment.cross_similarity`. *Tom Xi*
- `1529`_ Accelerated utility functions for squared magnitude `librosa.util.abs2` and `librosa.util.phasor`. *Brian McFee*
- `1514`_ `librosa.stft` support for pre-allocated output arrays. *Brian McFee*
- `1533`_ Accelerated `librosa.util.localmax` and `librosa.util.localmin`. *Brian McFee*
- `1552`_ **EXPERIMENTAL** Support for just-intonation based variable-Q transforms `librosa.vqt` and functional just system (FJS) notation. *Brian McFee, Vincent Lostanlen*
- `1579`_ Imports are now done lazily, significantly reducing startup time. It is not longer necessary to explicitly `import librosa.display`. *Brian McFee*
- `1587`_, `1632`_, `1637`_ Type annotations. *Matan Gover, Brian McFee, Fabian Keller*
- `1647`_ Harmonic spectrum interpolation `librosa.f0_harmonics` and tempogram ratio features `librosa.feature.tempogram_ratio`. *Brian McFee*

Bug fixes
- `1560`_ Corrected an error in bandwidth estimation for window functions that take on negative sample values. *Brian McFee*
- `1571`_ Fixed rounding error in multirate filterbank calculation of sampling rates. *Brian McFee*
- `1594`_ Fixed incorrect use of deprecated numpy numerical types. *Mattia Di Gangi*
- `1596`_ Fixed harmonic interpolation for recent scipy releases. *Brian McFee*


API changes
- `1561`_ `librosa.resample` now supports `axis=` for all sample rate conversion backends. *Brian McFee*
- `1572`_ Notation conversion (e.g., `librosa.midi_to_note`) now vectorizes operations, and produces `numpy.ndarray` outputs rather than `list` when given iterable inputs. *Brian McFee*
- `1625`_ Deprecations now raise `FutureWarning` instead of `DeprecationWarning`.
- `1625`_ `librosa.get_duration` parameter `filename` has been renamed to `path`. *Brian McFee*
- `1643`_ Removed support for `threshold=None` in `librosa.zero_crossings`. *Brian McFee*
- `1665`_ Fixed overflow bug in `librosa.feature.rms` on integer inputs. *Brian McFee*



Documentation
- `1520`_ Improved CONTRIBUTING.md documentation. *Kian Eliasi*
- `1531`_ Updated LICENSE.md documentation. *Anton Kostin*
- `1536`_ Added keyword argument (`kwargs`) definitions to docstrings. *Emily Halvachs*
- `1537`_ Improvements to CONTRIBUTING.md. *Juanita Gomez*
- `1545`_ Correction to docstring for `librosa.note_to_midi`. *Helmin Jinoz*
- `1563`_ Improved `librosa.display.specshow` documentation to explain `cmap=` parameter. *Kian Eliasi*
- `1573`_ Improved documentation for `librosa.filters.semitone_filterbank`. *BdeGraff*
- `1586`_ Fixed figure layout in documentation builds. *Brian McFee*
- `1592`_ Fixed incorrect link to the documentation badge in README. *Zvi Baratz*
- `1614`_ Improved documentation for resampling. *Jon Petter Åsen*


Deprecations
- `1521`_ Removed backward compatibility support for positional arguments that are now keyword-only. *Brian McFee*
- `1577`_ Removed official support for python 3.6. *Brian McFee*
- `1625`_ The `audioread` backend is now deprecated and will be removed in a future release. *Brian McFee*


Other changes
- `1501`_ Infer square / equal plot dimensions for compatible x/y axes in `librosa.display.specshow`. *Kian Eliasi*
- `1535`_ Standardized integer type checks throughout the library. *Alexandre Chabot-Leclerc*
- `1539`_ Refactored `librosa.display.AdaptiveWaveplot` to allow callback disconnection. *Brian McFee*
- `1548`_ Removed deprecated `'hanning'` window specification from tests. *Brian McFee*
- `1551`_ Removed dependency on `contextlib2`. *Steve Kowalik*
- `1565`_ Efficiency improvements to `librosa.autocorrelate`. *Brian McFee*
- `1566`_ Changed the default sample rate conversion method from `kaiser_best` (resampy) to `soxr_hq` (soxr). *Brian McFee*
- `1581`_ Updated tests for numpy 1.23 compatibility. *Brian McFee*
- `1617`_ Accelerated `librosa.yin` implementation. *Brian McFee*
- `1640`_ Updated display module dependencies to require matplotlib >= 3.3. *Brian McFee*
- `1643`_ Accelerated `librosa.zero_crossings` implementation. *Brian McFee*
- `1646`_ Added support for transposed (vertical) display of waveforms. *Brian McFee*



.. _1485: https://github.com/librosa/librosa/issues/1485
.. _1495: https://github.com/librosa/librosa/issues/1495
.. _1529: https://github.com/librosa/librosa/issues/1529
.. _1514: https://github.com/librosa/librosa/issues/1514
.. _1533: https://github.com/librosa/librosa/issues/1533
.. _1552: https://github.com/librosa/librosa/issues/1552
.. _1579: https://github.com/librosa/librosa/issues/1579
.. _1637: https://github.com/librosa/librosa/issues/1637
.. _1632: https://github.com/librosa/librosa/issues/1632
.. _1587: https://github.com/librosa/librosa/issues/1587
.. _1647: https://github.com/librosa/librosa/issues/1647
.. _1560: https://github.com/librosa/librosa/issues/1560
.. _1571: https://github.com/librosa/librosa/issues/1571
.. _1594: https://github.com/librosa/librosa/issues/1594
.. _1561: https://github.com/librosa/librosa/issues/1561
.. _1572: https://github.com/librosa/librosa/issues/1572
.. _1520: https://github.com/librosa/librosa/issues/1520
.. _1531: https://github.com/librosa/librosa/issues/1531
.. _1536: https://github.com/librosa/librosa/issues/1536
.. _1537: https://github.com/librosa/librosa/issues/1537
.. _1545: https://github.com/librosa/librosa/issues/1545
.. _1563: https://github.com/librosa/librosa/issues/1563
.. _1586: https://github.com/librosa/librosa/issues/1586
.. _1592: https://github.com/librosa/librosa/issues/1592
.. _1596: https://github.com/librosa/librosa/issues/1596
.. _1521: https://github.com/librosa/librosa/issues/1521
.. _1577: https://github.com/librosa/librosa/issues/1577
.. _1501: https://github.com/librosa/librosa/issues/1501
.. _1535: https://github.com/librosa/librosa/issues/1535
.. _1539: https://github.com/librosa/librosa/issues/1539
.. _1548: https://github.com/librosa/librosa/issues/1548
.. _1551: https://github.com/librosa/librosa/issues/1551
.. _1565: https://github.com/librosa/librosa/issues/1565
.. _1566: https://github.com/librosa/librosa/issues/1566
.. _1581: https://github.com/librosa/librosa/issues/1581
.. _1625: https://github.com/librosa/librosa/issues/1625
.. _1643: https://github.com/librosa/librosa/issues/1643
.. _1573: https://github.com/librosa/librosa/issues/1573
.. _1614: https://github.com/librosa/librosa/issues/1614
.. _1617: https://github.com/librosa/librosa/issues/1617
.. _1640: https://github.com/librosa/librosa/issues/1640
.. _1643: https://github.com/librosa/librosa/issues/1643
.. _1646: https://github.com/librosa/librosa/issues/1646
.. _1665: https://github.com/librosa/librosa/issues/1665

------
2022-06-27

Bug fixes
- `1457`_ Fixed `librosa.show_versions` to match package dependencies. *Brian McFee*
- `1493`_ Fixed a bug in `librosa.effects.split` when applied to multichannel data. *Brian McFee*


Documentation
- `1447`_ Migrated documentation builds to GitHub Actions. *Brian McFee*
- `1469`_ Corrected documentation for `db_to_amplitude` and `amplitude_to_db`. *i-aki-y*
- `1473`_ Readability improvements to package README. *Asmitha Krishnakumar*
- `1475`_ Expanded documentation to `librosa.sequence.viterbi_discriminative`. *Brian McFee*
- `1479`_ Readability improvements to package README. *Chandrashekhar Ramaprasad*
- `1491`_ Pinned sphinx version for documentation builds. *Brian McFee*
- `1511`_ Expanded documentation for `find_files`. *Xiao-Ming*
- `1513`_ Various documentation updates and enhancements. *Brian McFee*


Other changes
- `1453`_ Removed test data from main repository and reduced the git attic. *Brian McFee*
- `1479`_ Accept pre-constructed audioread objects in `librosa.load`. *Brian McFee*
- `1504`_ Accelerate `librosa.magphase`. *Will Monroe*
- `1507`_, `1508`_, `1509`_ Various spelling corrections in documentation, comments, and warnings. *Lorenz Nickel*

.. _1457: https://github.com/librosa/librosa/issues/1457
.. _1493: https://github.com/librosa/librosa/issues/1493
.. _1447: https://github.com/librosa/librosa/issues/1447
.. _1469: https://github.com/librosa/librosa/issues/1469
.. _1473: https://github.com/librosa/librosa/issues/1473
.. _1475: https://github.com/librosa/librosa/issues/1475
.. _1487: https://github.com/librosa/librosa/issues/1487
.. _1491: https://github.com/librosa/librosa/issues/1491
.. _1511: https://github.com/librosa/librosa/issues/1511
.. _1513: https://github.com/librosa/librosa/issues/1513
.. _1453: https://github.com/librosa/librosa/issues/1453
.. _1479: https://github.com/librosa/librosa/issues/1479
.. _1504: https://github.com/librosa/librosa/issues/1504
.. _1507: https://github.com/librosa/librosa/issues/1507
.. _1508: https://github.com/librosa/librosa/issues/1508
.. _1509: https://github.com/librosa/librosa/issues/1509

------
2022-02-15

This release provides partial backward compatibility to the 0.8 series.
The 0.9.0 release introduced restrictions on positional arguments to many functions, requiring
parameters to be passed by keyword arguments instead.
In 0.9.1, positional parameters now trigger warnings instead of errors, so 0.8-compatible code should work again.


Additional changes:

- `1448`_ Documentation for `librosa.effects.trim` and `librosa.effects.split` has been corrected to reflect a semantic change in the `ref` parameter introduced by `1130`_.
Explicit `ref` values now measure amplitude rather than power.

.. _1448: https://github.com/librosa/librosa/issues/1448

- `librosa.util.example_audio_file` is now deprecated in favor of `librosa.util.example`.

Bug fixes
- `1078`_ fixed edge-padding errors in `librosa.feature.stack_memory`. *beantowel*
- `1091`_ fixed joblib version requirements. *Thor Whalen*
- `1094`_ fixed STFT bug when using large window sizes. *Frank Zalkow*
- `1157`_, `1196`_ fixed an alignment bug in `librosa.iirt`. *Frank Zalkow*
- `1159`_ fixed a warm-up glitch in `librosa.effects.preemphasis`. *Brian McFee*
- `1179`_ fixed memory initialization in unit tests. *Brian McFee*

Documentation
- `1068`_ Corrections to `librosa.effects.pitch_shift` documentation. *Keunwoo Choi*

Other changes
- `1064`_ unit test suite modernized to support latest `pytest`. *Brian McFee*
- `1112`_ numba accelerated `librosa.feature.stack_memory`. *Brian McFee*
- `1120`_ added reference tuning for pitch conversion utilities. *Julia Wilkins*
- `1123`_ fixed Python requirement definition in installation script. *Stefan
Sullivan*
- `1125`_ updates to `librosa.util.frame` to remove default parameters and relax
contiguity restrictions. *Brian McFee*
- `1131`_ more stringent shape requirements on `librosa.util.valid_audio`. *Brian McFee*
- `1140`_ removed contiguity requirement for `librosa.util.valid_audio`. *Brian McFee*
- `1147`_ updates to `librosa.display.specshow` documentation. *Brian McFee*
- `1182`_ `librosa.display.specshow` now returns a `QuadMesh` object, rather than the axes handle. *Brian McFee*
- `1183`_ `librosa.feature.chroma_cqt` now uses higher CQT resolution by default. *Brian McFee*
- `1183`_ `librosa.feature.tonnetz` can now pass-through arguments to `librosa.feature.chroma_cqt`. *Brian McFee*
- `1186`_ `librosa.display.cmap` now returns binary colormaps for boolean data. *Brian McFee*

.. _1203: https://github.com/librosa/librosa/issues/1203
.. _1018: https://github.com/librosa/librosa/issues/1018
.. _1059: https://github.com/librosa/librosa/issues/1059
.. _1134: https://github.com/librosa/librosa/issues/1134
.. _1149: https://github.com/librosa/librosa/issues/1149
.. _1150: https://github.com/librosa/librosa/issues/1150
.. _1166: https://github.com/librosa/librosa/issues/1166
.. _1171: https://github.com/librosa/librosa/issues/1171
.. _1062: https://github.com/librosa/librosa/issues/1062
.. _1050: https://github.com/librosa/librosa/issues/1050
.. _1165: https://github.com/librosa/librosa/issues/1165
.. _1078: https://github.com/librosa/librosa/issues/1078
.. _1091: https://github.com/librosa/librosa/issues/1091
.. _1094: https://github.com/librosa/librosa/issues/1094
.. _1157: https://github.com/librosa/librosa/issues/1157
.. _1159: https://github.com/librosa/librosa/issues/1159
.. _1179: https://github.com/librosa/librosa/issues/1179
.. _1068: https://github.com/librosa/librosa/issues/1068
.. _1064: https://github.com/librosa/librosa/issues/1064
.. _1112: https://github.com/librosa/librosa/issues/1112
.. _1120: https://github.com/librosa/librosa/issues/1120
.. _1123: https://github.com/librosa/librosa/issues/1123
.. _1125: https://github.com/librosa/librosa/issues/1125
.. _1131: https://github.com/librosa/librosa/issues/1131
.. _1140: https://github.com/librosa/librosa/issues/1140
.. _1147: https://github.com/librosa/librosa/issues/1147
.. _1182: https://github.com/librosa/librosa/issues/1182
.. _1183: https://github.com/librosa/librosa/issues/1183
.. _1186: https://github.com/librosa/librosa/issues/1186
.. _1196: https://github.com/librosa/librosa/issues/1196
.. _1198: https://github.com/librosa/librosa/issues/1198
.. _1063: https://github.com/librosa/librosa/issues/1063

------

2022-02-07

The main feature of this release is (nearly) full support for arbitrary multi-channel processing, along with several speed and stability enhancements.
A detailed list of changes is provided below.

New Features
- `1130`_ Nearly full support for multi-channel processing. *Brian McFee, Daniel Faronbi, Iran Roman*
- `1331`_ Option to disable unicode characters in display functions. *Brian McFee*
- `1441`_ Significantly expanded the library of example audio clips. *Brian McFee*

API changes
- `1114`_ Most functions now require keyword arguments. *Brian McFee*
- `1382`_ The default padding mode for most functions (including STFT) is now zero-padding. *Brian McFee*
- `1418`_ `librosa.load` and `librosa.stream` can now operate directly on open `soundfile` objects. *Brian McFee*
- `1414`_ `librosa.display.specshow` now uses centered coordinate grids. *Brian McFee*
- `1398`_ `librosa.iirt` now exposes API control over resampling modes. *Brian McFee*
- `1416`_ Removed deprecated functions `librosa.display.waveplot` and `librosa.util.example_audio_file`. *Brian McFee*

Bug fixes
- `1387`_ Fixed errors in support of odd frame lengths in various functions. *Brian McFee*
- `1273`_ Minor corrections to constants in perceptual weighting functions. *Brian McFee*
- `1350`_ Removed uses of deprecated numpy numerical types. *Brian McFee*
- `1361`_ Maximum frequency is now correctly inferred as Nyquist in onset strength calculation. *Brian McFee*
- `1362`_ `librosa.effects.deemphasis` no longer modifies the input signal in-place. *Brian McFee*
- `1375`_ `librosa.util.frame` now correctly works for arbitrary memory layouts and numbers of axes. *Brian McFee*
- `1425`_ Fixed an off-by-one error in `librosa.yin` and `librosa.pyin`. *philstem, Brian McFee*
- `1430`_ Removed unnecessary `__all__` specifications to better support static analysis. *Fabian Keller*
- `1407`_ Corrected a normalization error in inverse CQT. *Brian McFee, Vincent Lostanlen*

Documentation
- `1328`_ Retired the `examples/` folder and expanded the `Advanced Examples` gallery. *Brian McFee*
- `1427`_ Fixed docstring for `librosa.reassigned_spectrogram`. *Fabian Keller*

Other changes
- `418`_ `librosa.cqt` now supports arbitrary hop lengths. *Brian McFee*
- `1405`_ Improvements and generalizations to constant-Q/variable-Q basis construction. *Brian McFee, Vincent Lostanlen*
- `1324`_ Added a run-time check for minimally supported matplotlib versions. *Brian McFee*
- `1325`_ Enhanced continuous integration testing for oldest and newest environments. *Brian McFee*
- `1358`_ Harmonic interpolation now preemptively detects repeated values that produce unstable estimates. *Brian McFee*
- `1432`_ Specify stack levels in warnings to provide more helpful warning messages. *Brian McFee*
- `1404`_, `1406`_ Improved packaging configurations. *Alex Malins*
- `1384`_ Fixed package configuration error for documentation builds. *Adam Weiss*

Deprecations
- `1389`_ The `mono` parameter of `librosa.util.valid_audio` is deprecated and the default is now set to `False`. *Brian McFee*
- `1405`_ CQT filter-bank constructors `librosa.filters.constant_q` are now deprecated in favor of `librosa.filters.wavelet`. *Brian McFee, Vincent Lostanlen*


.. _418: https://github.com/librosa/librosa/issues/418
.. _1114: https://github.com/librosa/librosa/issues/1114
.. _1130: https://github.com/librosa/librosa/issues/1130
.. _1273: https://github.com/librosa/librosa/issues/1273
.. _1324: https://github.com/librosa/librosa/issues/1324
.. _1325: https://github.com/librosa/librosa/issues/1325
.. _1328: https://github.com/librosa/librosa/issues/1328
.. _1331: https://github.com/librosa/librosa/issues/1331
.. _1350: https://github.com/librosa/librosa/issues/1350
.. _1358: https://github.com/librosa/librosa/issues/1358
.. _1361: https://github.com/librosa/librosa/issues/1361
.. _1362: https://github.com/librosa/librosa/issues/1362
.. _1375: https://github.com/librosa/librosa/issues/1375
.. _1382: https://github.com/librosa/librosa/issues/1382
.. _1384: https://github.com/librosa/librosa/issues/1384
.. _1387: https://github.com/librosa/librosa/issues/1387
.. _1389: https://github.com/librosa/librosa/issues/1389
.. _1398: https://github.com/librosa/librosa/issues/1398
.. _1404: https://github.com/librosa/librosa/issues/1404
.. _1405: https://github.com/librosa/librosa/issues/1405
.. _1406: https://github.com/librosa/librosa/issues/1406
.. _1407: https://github.com/librosa/librosa/issues/1407
.. _1414: https://github.com/librosa/librosa/issues/1414
.. _1416: https://github.com/librosa/librosa/issues/1416
.. _1418: https://github.com/librosa/librosa/issues/1418
.. _1425: https://github.com/librosa/librosa/issues/1425
.. _1427: https://github.com/librosa/librosa/issues/1427
.. _1430: https://github.com/librosa/librosa/issues/1430
.. _1432: https://github.com/librosa/librosa/issues/1432
.. _1441: https://github.com/librosa/librosa/issues/1441