Merge pull request #25 from lucianodato/development

Last refining steps before release

.github/workflows/build.yml

@@ -17,7 +17,8 @@ jobs:
       - name: Set up dependencies
         run: |
           sudo apt-get update -qq
-          sudo apt-get install -qq meson libfftw3-dev ninja-build libsndfile1-dev
+          sudo apt-get install -qq python3-pip libfftw3-dev ninja-build libsndfile1-dev
+          sudo pip install meson
       - name: Build library
         shell: bash
         run: |

README.md

@@ -1,12 +1,12 @@
 # libspecbleach
 
-C library for audio noise reduction
+C library for audio noise reduction and other spectral effects
 
 [![build](https://github.com/lucianodato/libspecbleach/actions/workflows/build.yml/badge.svg)](https://github.com/lucianodato/libspecbleach/actions/workflows/build.yml)
 
 ## Background
 
-This library is based on the algorithms that were used in noise-repellent. These were extracted into a this standalone library. It was design to be extensible and modular. It uses the concept of a spectral processor which uses a short time Fourier transform (STFT) to process the audio. There are two initial processors in place, one which uses the adaptive part of noise repellent and one that uses the manual capturing profile based denoising. The library could be extended with more spectral processors using any STFT-based algorithm such as de-crackle, de-click and other audio restoration algorithms.
+This library is based on the algorithms that were used in [noise-repellent](https://github.com/lucianodato/noise-repellent). These were extracted into a this standalone library to remove the lv2 dependency. It was design to be extensible and modular. It uses the concept of a spectral processor which itself uses a short time Fourier transform (STFT) to process the audio. There are two initial processors in place, one which uses the adaptive part of noise repellent and one that uses the manual capturing profile based denoising. The library could be extended with more spectral processors using any STFT-based algorithm such as de-crackle, de-click and other audio restoration algorithms.
 
 ## De-noise algorithms
 
@@ -28,7 +28,7 @@ Installation:
 
 ## Example
 
-A simple console app example is provided to demonstrate how to use the library. It needs libsndfile to compile successfully. Use it as follows:
+A simple console app example is provided to demonstrate how to use the library. It needs libsndfile to compile successfully. The compiled binary won't be installed but you can use it as follows:
 
 ```bash
   adenoise_demo <input file name> <output file name>

include/specbleach_adenoiser.h

@@ -34,11 +34,11 @@ typedef struct SpectralBleachParameters {
   bool residual_listen;   // Enables outputting the residue of the reduction
                           // processing. It's either true or false
   float reduction_amount; // Sets the amount of dBs that the noise will be
-                          // attenuated. It goes from 0 dB to 40 dB
+                          // attenuated. It goes from 0 dB to 20 dB
   float smoothing_factor; // Percentage of smoothing to apply. It goes from 0 to
                           // 100 percent
   float noise_rescale;    // Strenght in which the reduction will be applied. It
-                       // can be a possitive or negative dB value in between -12
+                       // can be a possitive or negative dB value in between 0
                        // dB and 12 dB
 } SpectralBleachParameters;
 

include/specbleach_denoiser.h

@@ -45,7 +45,7 @@ typedef struct SpectralBleachParameters {
                           // to the residue of the reduction. It goes from 0 to
                           // 100 percent
   float noise_rescale;    // Strenght in which the reduction will be applied. It
-                       // can be a possitive or negative dB value in between -12
+                       // can be a possitive or negative dB value in between 0
                        // dB and 12 dB
 } SpectralBleachParameters;