Skip to content

Latest commit

 

History

History
149 lines (122 loc) · 5.8 KB

CHANGELOG.md

File metadata and controls

149 lines (122 loc) · 5.8 KB
Raw

Changelog

Unreleased (yet)

1.6.0 (2024-12-17)

  • dependency updates
  • MSRV bump but only for the tests and examples, not library users
  • Added FFT buffer size of 32768
  • Optimized implementation, resulting in less unnecessary copying of data
  • Removed excessive stack usage for large input data

1.5.0 (2023-09-21)

  • fixed the build by updating the dependencies
  • apart from that, no changes happened
  • BREAKING MSRV is now 1.63.0
  • internal code improvements

1.4.0 (2023-03-04)

  • dropped all optional FFT features (microfft-complex, microfft-real, rustfft-complex) and made microfft::real the default FFT implementation. This is breaking but only for a small percentage of users. There was no benefit from that feature and microfft::real, the default, was already the fastest for no_std as well as std targets.
  • dependency updates

1.3.0 (2023-03-04)

  • MSRV is now 1.63.0
  • FrequencySpectrum::apply_scaling_fn now requires a reference to &mut self: This is breaking but only for a small percentage of users. Performance is slightly improved as less heap allocations are required.
  • FrequencySpectrum is now Send and interior mutability is dropped: You can wrap the struct in a Mutex or similar types now!
  • FrequencySpectrum::to_map doesn't has the scaling_fn parameter anymore. This is breaking but only for a small percentage of users.
  • FrequencySpectrum::to_mel_map added for getting the spectrum in the mel scale.
  • small internal code quality and performance improvements

1.2.6 (2022-07-20)

  • fixed wrong scaling in scaling::divide_by_N_sqrt (#41)

1.2.5 (2022-06-19)

  • dependency update
  • number of sample can now also be 8192 and 16384 (when the feature microfft is used)

1.2.4 (2022-04-06)

  • added scaling fn divide_by_N_sqrt which is the recommended normalization function by the rustfft documentation (but generally applicable)

1.2.2 / 1.2.3 (2021-11-26)

  • typos and small fixes

1.2.1 (2021-11-15)

  • removed FrequencySpectrum::to_log_spectrum (was useless; my understanding was wrong)
  • added example live-visualization that shows how you could visualize a spectrum in real-time
    Example visualization of real-time audio + spectrum analysis
  • removed example live-spectrum-visualization (was really bad)

1.2.0 (2021-11-10)

  • MSRV is now 1.56.1
  • Rust edition 2021

1.1.2 (2021-09-14)

  • example live-spectrum-visualization requires Rust stable 1.55.0 because the ringbuffer-dependency requires it
  • the rest of the crate should still build with the current MSRV 1.52.1
  • if you run tests, you need 1.55.0!

1.1.1

  • bugfix of a bug since v1.0.0

1.1.0

  • added scaling::combined which helps you to combine several scaling functions
  • added FrequencySpectrum::to_log_spectrum which gives you a more usable spectrum when you analyze music for example.
    • this is not optimal yet :(
    • Needs code contributions.. doesn't look as nice and convenient as other implementations. I don't really know what to do here.

v1.0.0

Breaking Changes

  • The library returns now a result and will no longer panic under certain circumstances.
  • removed per_element_scaling_fn in favor of complex_scaling_fn, which is now just called scaling_fn - the old behaviour was more confusing than beneficial
  • renamed ComplexSpectrumScalingFunction to SpectrumScalingFunction and moved it into the scaling-module
  • MSRV is now 1.52.1 stable

Other

  • many internal improvements
  • rust-toolchain.toml for build stability and reproducibility
  • really minor performance improvements (~5 %)
  • added example live-spectrum-visualization.rs (still not perfect, but works)
  • added example bench.rs

v0.5.1

  • Feature "rustfft-complex" uses "rustfft"-crate at version 6 which is faster/more optimized (~25%).
  • improved CI
  • README update

v0.5.0

This crate now uses microfft::real as default FFT implementation. It is by far the fastest implementation and there are no disadvantages, despite (with microfft version 0.4.0) the maximum FFT size is 4096. If you need bigger FFT sizes, use feature rustfft-complex.

This crate now works in no_std-environments by default.

v0.4.5

Added MIT to file headers where it was missing.

v0.4.4

Fixed wrong usage of microfft::real + bumped version of microfft to 0.4.0. Currently it seems like with this implementation you only can get the frequencies zero to sampling_rate/4, i.e. half of Nyquist frequency! I found out so by plotting the values. Wait until https://gitlab.com/ra_kete/microfft-rs/-/issues/9 gets resolved.

v0.4.3

README fix.

v0.4.2

Typo in README.md code example.

v0.4.1

Typo in README.md.

v0.4.0

  • MSRV is now Rust 1.51 (sorry but that's the only way I can make it no_std-compatible)
  • This crate is now really no_std
  • you can choose between three FFT implementations at compile time via Cargo features. The new default feature is rustfft-complex (which is still std) but there are also the two new no_std-compatible targets microfft-complex (more accurate, like rustfft) and microfft-real (faster, less accurate)
  • several small improvements and fixes, see: https://github.com/phip1611/spectrum-analyzer/milestone/3?closed=1

v0.3.0

  • FrequencySpectrum::min() and FrequencySpectrum::max() now return tuples/pairs (issue #6)
  • FrequencySpectrum now has convenient methods to get the value of a desired frequency from the underlying vector of FFT results (issue #8)
  • FrequencySpectrum now has a field + getter for frequency_resolution (issue #5)

For all issues see: https://github.com/phip1611/spectrum-analyzer/milestone/2