diff --git a/CHANGELOG.md b/CHANGELOG.md index cee4f9e..f9dad84 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log +## [1.3.0] 2024 - 06 - 02 + +### Changed + +- Migrated to pyproject.toml +- Extracted noisereduce and visrecognize to optional dependencies + ## [1.2.4] 2024 - 01 - 07 ### Added diff --git a/README.md b/README.md index 57d488f..f1a4e2f 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,11 @@ pip install audalign in the directory +### Optional dependencies + +- visrecognize: additional recognizer based on spectrogram image comparison. `pip install audalign[visrecognize]` +- noisereduce: wrapper utils around [timsainb/noisereduce](https://github.com/timsainb/noisereduce). `pip install audalign[noisereduce]` + ## Recognizers There are currently four included recognizers, each with their own config objects. @@ -64,7 +69,7 @@ import audalign as ad fingerprint_rec = ad.FingerprintRecognizer() correlation_rec = ad.CorrelationRecognizer() cor_spec_rec = ad.CorrelationSpectrogramRecognizer() -visual_rec = ad.VisualRecognizer() +visual_rec = ad.VisualRecognizer() # requires installting optional visrecognize dependencies fingerprint_rec.config.set_accuracy(3) # recognizer.config.some_item @@ -108,7 +113,7 @@ Correlation is more precise than fingerprints and will always give a best alignm ## Other Functions ```python -# wrapper for timsainb/noisereduce +# wrapper for timsainb/noisereduce, optional dependency ad.remove_noise_file( "target/file", "5", # noise start in seconds diff --git a/pyproject.toml b/pyproject.toml index a0f5478..4fc5d3f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "hatchling.build" [project] name = "audalign" -version = "1.2.4" +version = "1.3.0" description = "Audio Alignment and Recognition in Python" requires-python = ">= 3.8" readme = "README.md"