Changelog

v0.6.0

2018-02-17

Bug fixes

• #663 fixed alignment errors in feature.delta. Brian McFee
• #646 effects.trim now correctly handles all-zeros signals. Rimvydas Naktinis
• #634 stft now conjugates the correct half of the spectrum. Brian McFee
• #630 fixed display decoration errors with cqt_note mode. Brian McFee
• #619 effects.split no longer returns out-of-bound sample indices. Brian McFee
• #616 Improved util.valid_audio to avoid integer type errors. Brian McFee
• #600 CQT basis functions are now correctly centered. Brian McFee
• #597 fixed frequency bin centering in display.specshow. Brian McFee
• #594 dtw fixed a bug which ignored weights when step_sizes_sigma did not match length. Jackie Wu
• #593 stft properly checks for valid input signals. Erik Peterson
• #587 show_versions now shows correct module names. Ryuichi Yamamoto

New features

• #648 feature.spectral_flatness. Keunwoo Choi
• #633 feature.tempogram now supports multi-band analysis. Brian McFee
• #439 core.iirt implements the multi-rate filterbank from Chroma Toolbox. Stefan Balke
• #435 core.icqt inverse constant-Q transform (unstable). Brian McFee

Other changes

• #674 Improved write_wav documentation with cross-references to soundfile. Brian McFee
• #671 Warn users when phase information is lost in dB conversion. Carl Thome
• #666 Expanded documentation for load’s resampling behavior. Brian McFee
• #656 Future-proofing numpy data type checks. Carl Thome
• #642 Updated unit tests for compatibility with matplotlib 2.1. Brian McFee
• #637 Improved documentation for advanced I/O. Siddhartha Kumar
• #636 util.normalize now preserves data type. Brian McFee
• #632 refined the validation requirements for util.frame. Brian McFee
• #628 all time/frequency conversion functions preserve input shape. Brian McFee
• #625 Numba is now a hard dependency. Brian McFee
• #622 hz_to_midi documentation corrections. Carl Thome
• #621 dtw is now symmetric with respect to input arguments. Stefan Balke
• #620 Updated requirements to prevent installation with (incompatible) sklearn 0.19.0. Brian McFee
• #609 Improved documentation for segment.recurrence_matrix. Julia Wilkins
• #598 Improved efficiency of decompose.nn_filter. Brian McFee
• #574 dtw now supports pre-computed distance matrices. Curtis Hawthorne

API changes and compatibility

• #627 The following functions and features have been removed:

  • real= parameter in cqt
  • core.logamplitude (replaced by amplitude_to_db)
  • beat.estimate_tempo (replaced by beat.tempo)
  • n_fft= parameter to feature.rmse
  • ref_power= parameter to power_to_db

• The following features have been deprecated, and will be removed in 0.7.0:

  • trim= parameter to feature.delta

• #616 write_wav no longer supports integer-typed waveforms. This is due to enforcing consistency with util.valid_audio checks elsewhere in the codebase. If you have existing code that requires integer-valued output, consider using soundfile.write instead.

v0.5.1

2017-05-08

Bug fixes

• #555 added safety check for frequency bands in spectral_contrast. Brian McFee
• #554 fix interactive display for tonnetz visualization. Brian McFee
• #553 fix bug in feature.spectral_bandwidth. Brian McFee
• #539 fix chroma_cens to support scipy >=0.19. Brian McFee

New features

• #565 feature.stack_memory now supports negative delay. Brian McFee
• #563 expose padding mode in stft/ifgram/cqt. Brian McFee
• #559 explicit length option for istft. Brian McFee
• #557 added show_versions. Brian McFee
• #551 add norm= option to filters.mel. Dan Ellis

Other changes

• #569 feature.rmse now centers frames in the time-domain by default. Brian McFee
• #564 display.specshow now rasterizes images by default. Brian McFee
• #558 updated contributing documentation and issue templates. Brian McFee
• #556 updated tutorial for 0.5 API compatibility. Brian McFee
• #544 efficiency improvement in CQT. Carl Thome
• #523 support reading files with more than two channels. Paul Brossier

v0.5.0

2017-02-17

Bug fixes

• #371 preserve integer hop lengths in constant-Q transforms. Brian McFee
• #386 fixed a length check in librosa.util.frame. Brian McFee
• #416 librosa.output.write_wav only normalizes floating point, and normalization is disabled by default. Brian McFee
• #417 librosa.cqt output is now scaled continuously across octave boundaries. Brian McFee, Eric Humphrey
• #450 enhanced numerical stability for librosa.util.softmask. Brian McFee
• #467 correction to chroma documentation. Seth Kranzler
• #501 fixed a numpy 1.12 compatibility error in pitch_tuning. Hojin Lee

New features

• #323 librosa.dtw dynamic time warping. Stefan Balke
• #404 librosa.cache now supports priority levels, analogous to logging levels. Brian McFee
• #405 librosa.interp_harmonics for estimating harmonics of time-frequency representations. Brian McFee
• #410 librosa.beat.beat_track and librosa.onset.onset_detect can return output in frames, samples, or time units. Brian McFee
• #413 full support for scipy-style window specifications. Brian McFee
• #427 librosa.salience for computing spectrogram salience using harmonic peaks. Rachel Bittner
• #428 librosa.effects.trim and librosa.effects.split for trimming and splitting waveforms. Brian McFee
• #464 librosa.amplitude_to_db, db_to_amplitude, power_to_db, and db_to_power for amplitude conversions. This deprecates logamplitude. Brian McFee
• #471 librosa.util.normalize now supports threshold and fill_value arguments. Brian McFee
• #472 librosa.feature.melspectrogram now supports power argument. Keunwoo Choi
• #473 librosa.onset.onset_backtrack for backtracking onset events to previous local minima of energy. Brian McFee
• #479 librosa.beat.tempo replaces librosa.beat.estimate_tempo, supports time-varying estimation. Brian McFee

Other changes

• #352 removed seaborn integration. Brian McFee
• #368 rewrite of the librosa.display submodule. All plots are now in natural coordinates. Brian McFee
• #402 librosa.display submodule is not automatically imported. Brian McFee
• #403 librosa.decompose.hpss now returns soft masks. Brian McFee
• #407 librosa.feature.rmse can now compute directly in the time domain. Carl Thome
• #432 librosa.feature.rmse renames n_fft to frame_length. Brian McFee
• #446 librosa.cqt now disables tuning estimation by default. Brian McFee
• #452 librosa.filters.__float_window now always uses integer length windows. Brian McFee
• #459 librosa.load now supports res_type argument for resampling. CJ Carr
• #482 librosa.filters.mel now warns if parameters will generate empty filter channels. Brian McFee
• #480 expanded documentation for advanced IO use-cases. Fabian Robert-Stoeter

API changes and compatibility

• The following functions have permanently moved:

  • core.peak_peak to util.peak_pick
  • core.localmax to util.localmax
  • feature.sync to util.sync

• The following functions, classes, and constants have been removed:

  • core.ifptrack
  • feature.chromagram
  • feature.logfsgram
  • filters.logfrequency
  • output.frames_csv
  • segment.structure_Feature
  • display.time_ticks
  • util.FeatureExtractor
  • util.buf_to_int
  • util.SMALL_FLOAT

• The following parameters have been removed:

  • librosa.cqt: resolution
  • librosa.cqt: aggregate
  • feature.chroma_cqt: mode
  • onset_strength: centering

• Seaborn integration has been removed, and the display submodule now requires matplotlib >= 1.5.

  • The use_sns argument has been removed from display.cmap
  • magma is now the default sequential colormap.

• The librosa.display module has been rewritten.

  • librosa.display.specshow now plots using pcolormesh, and supports non-uniform time and frequency axes.
  • All plots can be rendered in natural coordinates (e.g., time or Hz)
  • Interactive plotting is now supported via ticker and formatter objects

• librosa.decompose.hpss with mask=True now returns soft masks, rather than binary masks.
• librosa.filters.get_window wraps scipy.signal.get_window, and handles generic callables as well pre-registered window functions. All windowed analyses (e.g., stft, cqt, or tempogram) now support the full range of window functions and parameteric windows via tuple parameters, e.g., window=('kaiser', 4.0).
• stft windows are now explicitly asymmetric by default, which breaks backwards compatibility with the 0.4 series.
• cqt now returns properly scaled outputs that are continuous across octave boundaries. This breaks backwards compatibility with the 0.4 series.
• cqt now uses tuning=0.0 by default, rather than estimating the tuning from the signal. Tuning estimation is still supported, and enabled by default for chroma analysis (librosa.feature.chroma_cqt).
• logamplitude is deprecated in favor of amplitude_to_db or power_to_db. The ref_power parameter has been renamed to ref.

v0.4.3

2016-05-17

Bug fixes

• #315 fixed a positioning error in display.specshow with logarithmic axes. Brian McFee
• #332 librosa.cqt now throws an exception if the signal is too short for analysis. Brian McFee
• #341 librosa.hybrid_cqt properly matches the scale of librosa.cqt. Brian McFee
• #348 librosa.cqt fixed a bug introduced in v0.4.2. Brian McFee
• #354 Fixed a minor off-by-one error in librosa.beat.estimate_tempo. Brian McFee
• #357 improved numerical stability of librosa.decompose.hpss. Brian McFee

New features

• #312 librosa.segment.recurrence_matrix can now construct sparse self-similarity matrices. Brian McFee
• #337 librosa.segment.recurrence_matrix can now produce weighted affinities and distances. Brian McFee
• #311 librosa.decompose.nl_filter implements several self-similarity based filtering operations including non-local means. Brian McFee
• #320 librosa.feature.chroma_cens implements chroma energy normalized statistics (CENS) features. Stefan Balke
• #354 librosa.core.tempo_frequencies computes tempo (BPM) frequencies for autocorrelation and tempogram features. Brian McFee
• #355 librosa.decompose.hpss now supports harmonic-percussive-residual separation. CJ Carr, Brian McFee
• #357 librosa.util.softmask computes numerically stable soft masks. Brian McFee

Other changes

• librosa.cqt, librosa.hybrid_cqt parameter aggregate is now deprecated.
• Resampling is now handled by the resampy library
• librosa.get_duration can now operate directly on filenames as well as audio buffers and feature matrices.
• librosa.decompose.hpss no longer supports power=0.

v0.4.2

2016-02-20

Bug fixes

• Support for matplotlib 1.5 color properties in the display module
• #308 Fixed a per-octave scaling error in librosa.cqt. Brian McFee

New features

• #279 librosa.cqt now provides complex-valued output with argument real=False. This will become the default behavior in subsequent releases.
• #288 core.resample now supports multi-channel inputs. Brian McFee
• #295 librosa.display.frequency_ticks: like time_ticks. Ticks can now dynamically adapt to scale (mHz, Hz, KHz, MHz, GHz) and use automatic precision formatting (%g). Brian McFee

Other changes

• #277 improved documentation for OSX. Stefan Balke
• #294 deprecated the FeatureExtractor object. Brian McFee
• #300 added dependency version requirements to install script. Brian McFee

• #302, #279 renamed the following parameters

  • librosa.display.time_ticks: fmt is now time_fmt
  • librosa.feature.chroma_cqt: mode is now cqt_mode
  • librosa.cqt, hybrid_cqt, pseudo_cqt, librosa.filters.constant_q: resolution is now filter_scale

• #308 librosa.cqt default filter_scale parameter is now 1 instead of 2.

v0.4.1

2015-10-17

Bug fixes

• Improved safety check in CQT for invalid hop lengths
• Fixed division by zero bug in core.pitch.pip_track
• Fixed integer-type error in util.pad_center on numpy v1.10
• Fixed a context scoping error in librosa.load with some audioread backends
• librosa.autocorrelate now persists type for complex input

New features

• librosa.clicks sonifies timed events such as beats or onsets
• librosa.onset.onset_strength_multi computes onset strength within multiple sub-bands
• librosa.feature.tempogram computes localized onset strength autocorrelation
• librosa.display.specshow now supports *_axis='tempo' for annotating tempo-scaled data
• librosa.fmt implements the Fast Mellin Transform

Other changes

• Rewrote display.waveplot for improved efficiency
• decompose.deompose() now supports pre-trained transformation objects
• Nullified side-effects of optional seaborn dependency
• Moved feature.sync to util.sync and expanded its functionality
• librosa.onset.onset_strength and onset_strength_multi support superflux-style lag and max-filtering
• librosa.core.autocorrelate can now operate along any axis of multi-dimensional input
• the segment module functions now support arbitrary target axis
• Added proper window normalization to librosa.core.istft for better reconstruction (PR #235).
• Standardized n_fft=2048 for piptrack, ifptrack (deprecated), and logfsgram (deprecated)
• onset_strength parameter 'centering' has been deprecated and renamed to 'center'
• onset_strength always trims to match the input spectrogram duration
• added tests for piptrack
• added test support for Python 3.5

v0.4.0

2015-07-08

Bug fixes

• Fixed alignment errors with offset and duration in load()
• Fixed an edge-padding issue with decompose.hpss() which resulted in percussive noise leaking into the harmonic component.
• Fixed stability issues with ifgram(), added options to suppress negative frequencies.
• Fixed scaling and padding errors in feature.delta()
• Fixed some errors in note_to_hz() string parsing
• Added robust range detection for display.cmap
• Fixed tick placement in display.specshow
• Fixed a low-frequency filter alignment error in cqt
• Added aliasing checks for cqt filterbanks
• Fixed corner cases in peak_pick
• Fixed bugs in find_files() with negative slicing
• Fixed tuning estimation errors
• Fixed octave numbering in to conform to scientific pitch notation

New features

• python 3 compatibility
• Deprecation and moved-function warnings
• added norm=None option to util.normalize()
• segment.recurrence_to_lag, lag_to_recurrence
• core.hybrid_cqt() and core.pseudo_cqt()
• segment.timelag_filter
• Efficiency enhancements for cqt
• Major rewrite and reformatting of documentation
• Improvements to display.specshow:
  • added the lag axis format
  • added the tonnetz axis format
  • allow any combination of axis formats
• effects.remix()
• Added new time and frequency converters:
  • note_to_hz(), hz_to_note()
  • frames_to_samples(), samples_to_frames()
  • time_to_samples(), samples_to_time()
• core.zero_crossings
• util.match_events()
• segment.subsegment() for segmentation refinement
• Functional examples in almost all docstrings
• improved numerical stability in normalize()
• audio validation checks
• to_mono()
• librosa.cache for storing pre-computed features
• Stereo output support in write_wav
• Added new feature extraction functions:
  • feature.spectral_contrast
  • feature.spectral_bandwidth
  • feature.spectral_centroid
  • feature.spectral_rolloff
  • feature.poly_features
  • feature.rmse
  • feature.zero_crossing_rate
  • feature.tonnetz
• Added display.waveplot

Other changes

• Internal refactoring and restructuring of submodules
• Removed the chord module
• input validation and better exception reporting for most functions
• Changed the default colormaps in display
• Changed default parameters in onset detection, beat tracking
• Changed default parameters in cqt
• filters.constant_q now returns filter lengths
• Chroma now starts at C by default, instead of A
• pad_center supports multi-dimensional input and axis parameter
• switched from np.fft to scipy.fftpack for FFT operations
• changed all librosa-generated exception to a new class librosa.ParameterError

Deprecated functions

• util.buf_to_int
• output.frames_csv
• segment.structure_feature
• filters.logfrequency
• feature.logfsgram

v0.3.1

2015-02-18

Bug fixes

• Fixed bug #117: librosa.segment.agglomerative now returns a numpy.ndarray instead of a list
• Fixed bug #115: off-by-one error in librosa.core.load with fixed duration
• Fixed numerical underflow errors in librosa.decompose.hpss
• Fixed bug #104: librosa.decompose.hpss failed with silent, complex-valued input
• Fixed bug #103: librosa.feature.estimate_tuning fails when no bins exceed the threshold

Features

• New function librosa.core.get_duration() computes the duration of an audio signal or spectrogram-like input matrix
• librosa.util.pad_center now accepts multi-dimensional input

Other changes

• Adopted the ISC license
• Python 3 compatibility via futurize
• Fixed issue #102: segment.agglomerative no longer depends on the deprecated Ward module of sklearn; it now depends on the newer Agglomerative module.
• Issue #108: set character encoding on all source files
• Added dtype persistence for resample, stft, istft, and effects functions

v0.3.0

2014-06-30

Bug fixes

• Fixed numpy array indices to force integer values
• librosa.util.frame now warns if the input data is non-contiguous
• Fixed a formatting error in librosa.display.time_ticks()
• Added a warning if scikits.samplerate is not detected

Features

• New module librosa.chord for training chord recognition models
• Parabolic interpolation piptracking librosa.feature.piptrack()
• librosa.localmax() now supports multi-dimensional slicing
• New example scripts
• Improved documentation
• Added the librosa.util.FeatureExtractor class, which allows librosa functions to act as feature extraction stages in sklearn
• New module librosa.effects for time-domain audio processing
• Added demo notebooks for the librosa.effects and librosa.util.FeatureExtractor
• Added a full-track audio example, librosa.util.example_audio_file()
• Added peak-frequency sorting of basis elements in librosa.decompose.decompose()

Other changes

• Spectrogram frames are now centered, rather than left-aligned. This removes the need for window correction in librosa.frames_to_time()
• Accelerated constant-Q transform librosa.cqt()
• PEP8 compliance
• Removed normalization from librosa.feature.logfsgram()
• Efficiency improvements by ensuring memory contiguity
• librosa.logamplitude() now supports functional reference power, in addition to scalar values
• Improved librosa.feature.delta()
• Additional padding options to librosa.feature.stack_memory()
• librosa.cqt and librosa.feature.logfsgram now use the same parameter formats (fmin, n_bins, bins_per_octave).
• Updated demo notebook(s) to IPython 2.0
• Moved perceptual_weighting() from librosa.feature into librosa.core
• Moved stack_memory() from librosa.segment into librosa.feature
• Standardized librosa.output.annotation input format to match mir_eval
• Standardized variable names (e.g., onset_envelope).

v0.2.1

2014-01-21

Bug fixes

• fixed an off-by-one error in librosa.onset.onset_strength()
• fixed a sign-flip error in librosa.output.write_wav()
• removed all mutable object default parameters

Features

• added option centering to librosa.onset.onset_strength() to resolve frame-centering issues with sliding window STFT
• added frame-center correction to librosa.core.frames_to_time() and librosa.core.time_to_frames()
• added librosa.util.pad_center()
• added librosa.output.annotation()
• added librosa.output.times_csv()
• accelerated librosa.core.stft() and ifgram()
• added librosa.util.frame for in-place signal framing
• librosa.beat.beat_track now supports user-supplied tempo
• added librosa.util.normalize()
• added librosa.util.find_files()
• added librosa.util.axis_sort()
• new module: librosa.util()
• librosa.filters.constant_q now support padding
• added boolean input support for librosa.display.cmap()
• speedup in librosa.core.cqt()

Other changes

• optimized default parameters for librosa.onset.onset_detect
• set librosa.filters.mel parameter n_mels=128 by default
• librosa.feature.chromagram() and logfsgram() now use power instead of energy
• librosa.display.specshow() with y_axis='chroma' now labels as pitch class
• set librosa.core.cqt parameter resolution=2 by default
• set librosa.feature.chromagram parameter octwidth=2 by default

v0.2.0

2013-12-14

Bug fixes

• fixed default librosa.core.stft, istft, ifgram to match specification
• fixed a float->int bug in peak_pick
• better memory efficiency
• librosa.segment.recurrence_matrix corrects for width suppression
• fixed a divide-by-0 error in the beat tracker
• fixed a bug in tempo estimation with short windows
• librosa.feature.sync now supports 1d arrays
• fixed a bug in beat trimming
• fixed a bug in librosa.core.stft when calculating window size
• fixed librosa.core.resample to support stereo signals

Features

• added filters option to cqt
• added window function support to istft
• added an IPython notebook demo
• added librosa.features.delta for computing temporal difference features
• new examples scripts: tuning, hpss
• added optional trimming to librosa.segment.stack_memory
• librosa.onset.onset_strength now takes generic spectrogram function feature
• compute reference power directly in librosa.core.logamplitude
• color-blind-friendly default color maps in librosa.display.cmap
• librosa.core.onset_strength now accepts an aggregator
• added librosa.feature.perceptual_weighting
• added tuning estimation to librosa.feature.chromagram
• added librosa.core.A_weighting
• vectorized frequency converters
• added librosa.core.cqt_frequencies to get CQT frequencies
• librosa.core.cqt basic constant-Q transform implementation
• librosa.filters.cq_to_chroma to convert log-frequency to chroma
• added librosa.core.fft_frequencies
• librosa.decompose.hpss can now return masking matrices
• added reversal for librosa.segment.structure_feature
• added librosa.core.time_to_frames
• added cent notation to librosa.core.midi_to_note
• added time-series or spectrogram input options to chromagram, logfsgram, melspectrogram, and mfcc
• new module: librosa.display
• librosa.output.segment_csv => librosa.output.frames_csv
• migrated frequency converters to librosa.core
• new module: librosa.filters
• librosa.decompose.hpss now supports complex-valued STFT matrices
• librosa.decompose.decompose() supports sklearn decomposition objects
• added librosa.core.phase_vocoder
• new module: librosa.onset; migrated onset strength from librosa.beat
• added librosa.core.pick_peaks
• librosa.core.load() supports offset and duration parameters
• librosa.core.magphase() to separate magnitude and phase from a complex matrix
• new module: librosa.segment

Other changes

• onset_estimate_bpm => estimate_tempo
• removed n_fft from librosa.core.istft()
• librosa.core.mel_frequencies returns n_mels values by default
• changed default librosa.decompose.hpss window to 31
• disabled onset de-trending by default in librosa.onset.onset_strength
• added complex-value warning to librosa.display.specshow
• broke compatibilty with ifgram.m; librosa.core.ifgram now matches stft
• changed default beat tracker settings
• migrated hpss into librosa.decompose
• changed default librosa.decompose.hpss power parameter to 2.0
• librosa.core.load() now returns single-precision by default
• standardized n_fft=2048, hop_length=512 for most functions
• refactored tempo estimator

v0.1.0

Initial public release.