Version 4.0.0

CONTRIBUTING.md

@@ -1,7 +1,17 @@
 # Contributing
 
-!> Please note that this is a hobby project that I work on in my free time.
+I kindly request that you only [open an issue](https://github.com/hvianna/audioMotion-analyzer/issues) for submitting a **bug report**.
 
-- If you want to send some feedback or ask a question, please drop me an e-mail at hvianna@gmail.com
-- If you have a feature request, feel free to [open an issue](https://github.com/hvianna/audioMotion-analyzer/issues)
-- If you want to submit a Pull Request, please branch it off the project's `develop` branch - that makes it easier for me to incorporate your changes in a future release.
+If you need help integrating *audioMotion-analyzer* with your project, have ideas for **new features** or any other questions or feedback,
+please use the [**Discussions**](https://github.com/hvianna/audioMotion-analyzer/discussions) section on GitHub.
+
+Additionally, I would love it if you could showcase your project using *audioMotion-analyzer* in [**Show and Tell**](https://github.com/hvianna/audioMotion-analyzer/discussions/categories/show-and-tell),
+and share your custom gradients with the community in [**Gradients**](https://github.com/hvianna/audioMotion-analyzer/discussions/categories/gradients)!
+
+When submitting a **Pull Request**, please branch it off the project's `develop` branch.
+
+And if you're feeling generous, maybe:
+
+* [Buy me a coffee](https://ko-fi.com/Q5Q6157GZ) on Ko-fi ☕😁
+* Gift me something from my [Bandcamp wishlist](https://bandcamp.com/henriquevianna/wishlist) 🎁🎶🥰
+* Tip me via [Brave Rewards](https://brave.com/brave-rewards/) using Brave browser 🤓

Changelog.md

@@ -1,11 +1,61 @@
 Changelog
 =========
 
+## version 4.0.0 (2023-03-26)
+
+### 🚨 BREAKING CHANGES: <!-- {docsify-ignore} -->
+
++ Removed deprecated properties:
+  + ~`energy`~ - use [`getEnergy()`](README.md#getenergy-preset-startfreq-endfreq-) instead
+  + ~`isLedDisplay`~ - use [`isLedBars`](README.md#isledbars-boolean-read-only) instead
+  + ~`peakEnergy`~ - use [`getEnergy('peak')`](README.md#getenergy-preset-startfreq-endfreq-) instead
+  + ~`showLeds`~ - use [`ledBars`](README.md#ledbars-boolean) instead
+
++ [`getBars()`](README.md#getbars) now includes an additional `freq` property for each element, representing the center frequency of the band.
+In addition, the range of each band has been adjusted so that frequencies that were previously at the lower edge (`freqLo`) are now located at the center of the band.
+
++ **`stereo` has been DEPRECATED** and will be removed in version 5 - use [`channelLayout`](README.md#channellayout-string) instead.
+
+### Added: <!-- {docsify-ignore} -->
+
++ [`ansiBands`](README.md#ansibands-boolean) - use ANSI/IEC preferred frequencies for the octave bands;
++ [`channelLayout`](README.md#channellayout-string) - adds option for dual channel combined spectrum, with both channel graphs overlaid;
++ [`frequencyScale`](README.md#frequencyscale-string) - adds linear and perceptual (Bark/Mel) frequency scales;
++ [`gradientLeft`](README.md#gradientleft-string) and [`gradientRight`](README.md#gradientright-string) - allow to select different gradients for each channel;
++ [`isBandsMode`](README.md#isbandsmode-boolean-read-only) read-only property;
++ [`linearAmplitude`](README.md#linearamplitude-boolean) - use linear values instead of dB for spectrum amplitudes;
++ [`linearBoost`](README.md#linearboost-number) - amplify low energy values when using linear amplitude;
++ [`noteLabels`](README.md#notelabels-boolean) - display musical note labels instead of frequency values on the X-axis;
++ [`weightingFilter`](README.md#weightingfilter-string) - select from five different weighting filters for improved spectrum visualization;
++ Two new built-in [gradients](README.md#gradient-string): _orangered_ and _steelblue_.
+
+Thank you **@jonathan-annett** [(#28)](https://github.com/hvianna/audioMotion.js/issues/28) and **@TF3RDL** ([#30](https://github.com/hvianna/audioMotion-analyzer/issues/30) and [#38](https://github.com/hvianna/audioMotion-analyzer/issues/38))
+for the suggestions that led to the implementation of several of these new features.
+
+### Fixed: <!-- {docsify-ignore} -->
+
++ LED peaks showing below zero level when `reflexRatio` > 0.
+
+### Changed and improved: <!-- {docsify-ignore} -->
+
++ Optimized generation of octave bands, with more accurate ranges and center frequencies;
++ Frequency labels on the X-axis now show different values depending on the value of [`ansiBands`](README.md#ansibands-boolean), to properly match the bands' center frequencies;
++ The [`onCanvasDraw`](README.md#oncanvasdraw-function) callback is now passed an additional object with timestamp and gradients information;
++ The _prism_ and _rainbow_ gradients were recreated using the beautiful [12-bit rainbow palette](https://iamkate.com/data/12-bit-rainbow/) by Kate Morley - If you need the old colors [check this post](https://github.com/hvianna/audioMotion-analyzer/discussions/44);
++ Custom gradients can now register a single color;
++ [`splitGradient`](README.md#splitgradient-boolean) now works for horizontal gradients in [`radial`](README.md#radial-boolean) visualization;
++ [`maxFreq`](README.md#maxfreq-number) is now capped to half the AudioContext's sample rate (Nyquist frequency);
++ Export additional types and interfaces in the TypeScript definition file;
++ Code optimizations, minor fixes and clean-up;
++ Revised and improved demos and documentation.
+
+
 ## version 3.6.1 (2022-12-09)
 
 + Minor update to fix wrong property names in the `LedParameters` interface in the TS definition file;
 + Improved documentation of [`registerGradient()`](README.md#registergradient-name-options-) usage in TypeScript projects [(#37)](https://github.com/hvianna/audioMotion-analyzer/issues/37).
 
+
 ## version 3.6.0 (2021-10-10)
 
 ### Added: <!-- {docsify-ignore} -->
@@ -290,8 +340,3 @@ and creates a consistent effect, whether overlay mode is on or off~~ **(reverted
 ## version 1.0.0 (2019-10-07)
 
 + First stable release.
-
-
-## version 1.0.0-rc.1 (2019-10-05)
-
-+ Release candidate for v1.0.0