Add deprecation notice

Bump rust-ffmpeg to hopefully support rpis.

.github/workflows/rust.yml

@@ -1,80 +0,0 @@
-name: Rust
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-env:
-  CARGO_TERM_COLOR: always
-
-jobs:
-  build-test-lint-linux:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        submodules: recursive
-    - uses: actions-rs/toolchain@v1
-      with:
-        toolchain: nightly-2022-02-16
-        override: false
-    - name: Packages
-      run: sudo apt-get update && sudo apt-get install build-essential yasm libavutil-dev libavcodec-dev libavformat-dev libavfilter-dev libavfilter-dev libavdevice-dev libswresample-dev libfftw3-dev ffmpeg
-    - name: Check format
-      run: cargo fmt -- --check
-    - name: Build
-      run: cargo build --verbose
-    - name: Run tests
-      run: cargo test --verbose
-    - name: Run library tests
-      run: cargo test --verbose --features=library
-    - name: Run example tests
-      run: cargo test --verbose --examples
-    - name: Build benches
-      run: cargo +nightly-2022-02-16 bench --verbose --features=bench --no-run
-    - name: Build examples
-      run: cargo build --examples --verbose --features=serde,library
-    - name: Lint
-      run: cargo clippy --examples --features=serde,library -- -D warnings
-
-  build-test-lint-windows:
-    name: Windows - build, test and lint
-    runs-on: windows-latest
-    strategy:
-      matrix:
-        include:
-          - ffmpeg_version: latest
-            ffmpeg_download_url: https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-full-shared.7z
-      fail-fast: false
-    env:
-      FFMPEG_DOWNLOAD_URL: ${{ matrix.ffmpeg_download_url }}
-    steps:
-      - uses: actions/checkout@v2
-      - name: Install dependencies
-        run: |
-          $VCINSTALLDIR = $(& "${env:ProgramFiles(x86)}\Microsoft Visual Studio\Installer\vswhere.exe" -latest -property installationPath)
-          Add-Content $env:GITHUB_ENV "LIBCLANG_PATH=${VCINSTALLDIR}\VC\Tools\LLVM\x64\bin`n"
-          Invoke-WebRequest "${env:FFMPEG_DOWNLOAD_URL}" -OutFile ffmpeg-release-full-shared.7z
-          7z x ffmpeg-release-full-shared.7z
-          mkdir ffmpeg
-          mv ffmpeg-*/* ffmpeg/
-          Add-Content $env:GITHUB_ENV "FFMPEG_DIR=${pwd}\ffmpeg`n"
-          Add-Content $env:GITHUB_PATH "${pwd}\ffmpeg\bin`n"
-      - name: Set up Rust
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-          override: true
-          components: rustfmt, clippy
-      - name: Build
-        run: cargo build --examples
-      - name: Test
-        run: cargo test --examples --features=serde
-      - name: Lint
-        run: cargo clippy --examples --features=serde -- -D warnings
-      - name: Check format
-        run: cargo fmt -- --check

.gitignore

@@ -0,0 +1,5 @@
+target
+node_modules
+index.node
+index-*.node
+bliss-rs-bliss-rs-*.tgz

CHANGELOG.md

@@ -1,5 +1,28 @@
 #Changelog
 
+## bliss 0.6.11
+* Bump rust-ffmpeg to 6.1.1 to fix build for raspberry pis.
+
+## bliss 0.6.10
+* Make the `analyze` function public, for people who don't want to use
+  ffmpeg
+* Run `cargo update`, bump ffmpeg to 6.1
+* Fix the library module erroring when wrong UTF-8 ends up in the database.
+
+## bliss 0.6.9
+* Add a feature flag for compilation on raspberry pis.
+
+## bliss 0.6.8
+* Add an `update-aubio-bindings` feature.
+
+## bliss 0.6.7
+* Fix compatibility for ffmpeg 6.0, and bump ffmpeg version to 6.0.
+* Update and remove extraneous dependencies.
+
+## bliss 0.6.6
+* Add a `delete_everything_else` function in `library`'s update functions.
+* Use Rust 2021.
+
 ## bliss 0.6.5
 * Fix library update performance issues.
 * Pretty-print JSON in the config file.

Cargo.toml

@@ -1,84 +1,57 @@
 [package]
-name = "bliss-audio"
-version = "0.6.5"
+name = "bliss-rs"
+version = "0.6.11"
+build = "build.rs"
 authors = ["Polochon-street <polochonstreet@gmx.fr>"]
-edition = "2018"
+edition = "2021"
 license = "GPL-3.0-only"
 description = "A song analysis library for making playlists"
 homepage = "https://lelele.io/bliss.html"
 repository = "https://github.com/Polochon-street/bliss-rs"
 keywords = ["audio", "analysis", "MIR", "playlist", "similarity"]
 readme = "README.md"
+exclude = ["data/", "index.node"]
+
+[lib]
+crate-type = ["rlib", "cdylib"]
 
 [package.metadata.docs.rs]
 features = ["bliss-audio-aubio-rs/rustdoc", "library"]
 no-default-features = true
 
-[features]
-default = ["bliss-audio-aubio-rs/static"]
-# Build ffmpeg instead of using the host's.
-build-ffmpeg = ["ffmpeg-next/build"]
-ffmpeg-static = ["ffmpeg-next/static"]
-# Use if you want to build python bindings with maturin.
-python-bindings = ["bliss-audio-aubio-rs/fftw3"]
-# Enable the benchmarks with `cargo +nightly bench --features=bench`
-bench = []
-library = [
-    "serde", "dep:rusqlite", "dep:dirs", "dep:tempdir",
-    "dep:anyhow", "dep:serde_ini", "dep:serde_json",
-    "dep:indicatif",
-]
-serde = ["dep:serde"]
-
 [dependencies]
-ripemd160 = "0.9.0"
-ndarray-npy = "0.8.0"
-ndarray = { version = "0.15.0", features = ["rayon"] }
-num_cpus = "1.13.0"
-ndarray-stats = "0.5.0"
-rustfft = "5.0.1"
-lazy_static = "1.4.0"
-rayon = "1.5.0"
-crossbeam = "0.8.0"
-noisy_float = "0.2.0"
-ffmpeg-next = "5.1.1"
-log = "0.4.14"
-env_logger = "0.8.3"
-thiserror = "1.0.24"
 # Until https://github.com/aubio/aubio/issues/336 is somehow solved
 # Hopefully we'll be able to use the official aubio-rs at some point.
-bliss-audio-aubio-rs = "0.2.0"
-strum = "0.21"
-strum_macros = "0.21"
-rcue = "0.1.1"
+bliss-audio-aubio-rs = { version = "0.2.1", features = ["static"] }
+crossbeam = "0.8.2"
+ffmpeg-next = { version = "6.1.1", features = ["static"] }
+log = "0.4.17"
+# `rayon` is used only by `par_mapv_inplace` in chroma.rs.
+# TODO: is the speed gain that substantial?
+ndarray = { version = "0.15.6", features = ["rayon"] }
+ndarray-stats = "0.5.1"
+noisy_float = "0.2.0"
+adler32 = "1.0.2"
+rustfft = "6.1.0"
+thiserror = "1.0.40"
+strum = "0.24.1"
+strum_macros = "0.24.3"
 
 # Deps for the library feature
 serde = { version = "1.0", optional = true, features = ["derive"] }
 serde_json = { version = "1.0.59", optional = true }
 serde_ini = { version = "0.2.0", optional = true }
-tempdir = { version = "0.3.7", optional = true }
-rusqlite = { version = "0.27.0", optional = true }
-dirs = { version = "4.0.0", optional = true }
-anyhow = { version = "1.0.58", optional = true }
-indicatif = { version = "0.17.0", optional = true }
+
+[dependencies.neon]
+version = "1.0.0-alpha.4"
+default-features = false
+features = ["napi-6", "channel-api", "promise-api", "try-catch-api"]
 
 [dev-dependencies]
+ndarray-npy = { version = "0.8.1", default-features = false }
 mime_guess = "2.0.3"
 glob = "0.3.0"
 anyhow = "1.0.45"
 clap = "2.33.3"
-pretty_assertions = "1.2.1"
+pretty_assertions = "1.3.0"
 serde_json = "1.0.59"
-
-[[example]]
-name = "library"
-required-features = ["library"]
-
-[[example]]
-name = "library_extra_info"
-required-features = ["library"]
-
-
-[[example]]
-name = "playlist"
-required-features = ["serde"]

Dockerfile

@@ -0,0 +1,20 @@
+FROM node:20-slim
+
+RUN apt-get update
+RUN apt-get install -yqq gnupg dirmngr apt-transport-https software-properties-common
+
+RUN gpg -K && gpg --no-default-keyring \
+  --keyring /usr/share/keyrings/deb-multimedia.gpg \
+  --keyserver keyserver.ubuntu.com \
+  --recv-keys 5C808C2B65558117
+RUN echo "deb [signed-by=/usr/share/keyrings/deb-multimedia.gpg] https://www.deb-multimedia.org $(lsb_release -sc) main non-free" \
+  | tee /etc/apt/sources.list.d/deb-multimedia.list
+
+RUN apt-get update
+RUN apt-get install -yqq wget build-essential yasm libavutil-dev libavcodec-dev libavformat-dev libavfilter-dev libavfilter-dev libavdevice-dev libswresample-dev libfftw3-dev libclang-dev ffmpeg
+
+WORKDIR /opt/rust
+RUN wget https://sh.rustup.rs -O rustup-init.sh
+RUN chmod +x rustup-init.sh
+
+RUN ./rustup-init.sh -y -t x86_64-unknown-linux-gnu x86_64-unknown-linux-musl aarch64-unknown-linux-gnu aarch64-unknown-linux-musl

LICENSE

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -2,7 +2,29 @@
 [![build](https://github.com/Polochon-street/bliss-rs/workflows/Rust/badge.svg)](https://github.com/Polochon-street/bliss-rs/actions)
 [![doc](https://docs.rs/bliss-audio/badge.svg)](https://docs.rs/bliss-audio/)
 
-# bliss music analyzer - Rust version
+# Deprecation notice
+This repo is no longer maintained - please refer to [bliss-js](https://gitea.antonlyap.pp.ua/antonlyap/bliss-js) instead.
+
+# Fork notice
+This repo is a fork of [bliss-rs](https://github.com/Polochon-street/bliss-rs) with bindings for Node.js (using N-API and Neon).
+
+## Example usage:
+The package is published to the Gitea registry: https://gitea.antonlyap.pp.ua/antonlyap/-/packages/npm/@bliss-rs%2Fbliss-rs/1.0.0
+```ts
+import { analyze, analyzeSync } from '@bliss-rs/bliss-rs';
+
+await analyze("/path/to/track.mp3") // returns Uint8Array
+```
+
+## Return value
+The output of `bliss-rs` consists of single-precision floats, currently 20 of them. This fork contains code to convert it into an array of 80 bytes in little endian order. An additional version (also comes from `bliss-rs`, currently equal to `1`) is prepended at the start (16-bit unsigned little-endian integer). Therefore, the total output size is 82 bytes.
+
+### Usage
+The output (without the version) is meant to be converted back into floats and used to calculate the [Euclidean distance](https://en.wikipedia.org/wiki/Euclidean_distance#Higher_dimensions) between two songs. Other distance algorithms are being worked on by the Bliss team. 
+
+---
+
+# (Original README) bliss music analyzer - Rust version
 bliss-rs is the Rust improvement of [bliss](https://github.com/Polochon-street/bliss), a
 library used to make playlists by analyzing songs, and computing distance between them.
 
@@ -16,6 +38,9 @@ For now (and if you're looking for an easy-to use smooth play experience),
 [MPD](https://www.musicpd.org/).
 
 There are also [python](https://pypi.org/project/bliss-audio/) bindings.
+The wheels are compiled used [maturin](https://github.com/PyO3/maturin/); the
+sources [are available here](https://github.com/Polochon-street/bliss-python)
+for inspiration.
 
 Note 1: the features bliss-rs outputs is not compatible with the ones
 used by C-bliss, since it uses

build.rs

@@ -0,0 +1,12 @@
+use std::env;
+
+fn main() {
+    for (name, _value) in env::vars() {
+        if name.starts_with("DEP_FFMPEG_") {
+            println!(
+                r#"cargo:rustc-cfg=feature="{}""#,
+                name["DEP_FFMPEG_".len()..name.len()].to_lowercase()
+            );
+        }
+    }
+}

ci_check.sh

@@ -0,0 +1 @@
+cargo fmt -- --check && cargo clippy --examples --features=serde -- -D warnings && cargo build --verbose && cargo test --verbose && cargo test --verbose --examples && cargo +nightly-2023-02-16 bench --verbose --features=bench --no-run && cargo build --examples --verbose --features=serde

examples/analyze.rs

@@ -1,4 +1,4 @@
-use bliss_audio::Song;
+use bliss_rs::bliss_lib::Song;
 use std::env;
 
 /**
@@ -9,9 +9,9 @@ use std::env;
 fn main() {
     let args: Vec<String> = env::args().skip(1).collect();
     for path in &args {
-        match Song::from_path(&path) {
+        match Song::from_path(path) {
             Ok(song) => println!("{}: {:?}", path, song.analysis),
-            Err(e) => println!("{}: {}", path, e),
+            Err(e) => println!("{path}: {e}"),
         }
     }
 }

examples/distance.rs

@@ -1,4 +1,4 @@
-use bliss_audio::Song;
+use bliss_rs::bliss_lib::Song;
 use std::env;
 
 /**
@@ -16,11 +16,18 @@ fn main() -> Result<(), String> {
     let song1 = Song::from_path(&first_path).map_err(|x| x.to_string())?;
     let song2 = Song::from_path(&second_path).map_err(|x| x.to_string())?;
 
+    let mut distance_squared: f64 = 0.0;
+    let analysis1 = song1.analysis.as_bytes();
+    let analysis2 = song2.analysis.as_bytes();
+    for (i, feature1) in analysis1.iter().enumerate() {
+        distance_squared += (feature1 - analysis2[i]).pow(2) as f64;
+    }
+
     println!(
         "d({:?}, {:?}) = {}",
-        song1.path,
-        song2.path,
-        song1.distance(&song2)
+        &first_path,
+        &second_path,
+        distance_squared.sqrt(),
     );
     Ok(())
 }

examples/library.rs

@@ -1,204 +0,0 @@
-/// Basic example of how one would combine bliss with an "audio player",
-/// through [Library].
-///
-/// For simplicity's sake, this example recursively gets songs from a folder
-/// to emulate an audio player library, without handling CUE files.
-use anyhow::Result;
-use bliss_audio::library::{AppConfigTrait, BaseConfig, Library};
-use clap::{App, Arg, SubCommand};
-use glob::glob;
-use serde::{Deserialize, Serialize};
-use std::fs;
-use std::num::NonZeroUsize;
-use std::path::{Path, PathBuf};
-
-#[derive(Serialize, Deserialize, Clone, Debug)]
-// A config structure, that will be serialized as a
-// JSON file upon Library creation.
-pub struct Config {
-    #[serde(flatten)]
-    // The base configuration, containing both the config file
-    // path, as well as the database path.
-    pub base_config: BaseConfig,
-    // An extra field, to store the music library path. Any number
-    // of arbitrary fields (even Serializable structures) can
-    // of course be added.
-    pub music_library_path: PathBuf,
-}
-
-impl Config {
-    pub fn new(
-        music_library_path: PathBuf,
-        config_path: Option<PathBuf>,
-        database_path: Option<PathBuf>,
-        number_cores: Option<NonZeroUsize>,
-    ) -> Result<Self> {
-        let base_config = BaseConfig::new(config_path, database_path, number_cores)?;
-        Ok(Self {
-            base_config,
-            music_library_path,
-        })
-    }
-}
-
-// The AppConfigTrait must know how to access the base config.
-impl AppConfigTrait for Config {
-    fn base_config(&self) -> &BaseConfig {
-        &self.base_config
-    }
-
-    fn base_config_mut(&mut self) -> &mut BaseConfig {
-        &mut self.base_config
-    }
-}
-
-// A trait allowing to implement methods for the Library,
-// useful if you don't need to store extra information in fields.
-// Otherwise, doing
-// ```
-// struct CustomLibrary {
-//    library: Library<Config>,
-//    extra_field: ...,
-// }
-// ```
-// and implementing functions for that struct would be the way to go.
-// That's what the [reference](https://github.com/Polochon-street/blissify-rs)
-// implementation does.
-trait CustomLibrary {
-    fn song_paths(&self) -> Result<Vec<String>>;
-}
-
-impl CustomLibrary for Library<Config> {
-    /// Get all songs in the player library
-    fn song_paths(&self) -> Result<Vec<String>> {
-        let music_path = &self.config.music_library_path;
-        let pattern = Path::new(&music_path).join("**").join("*");
-
-        Ok(glob(&pattern.to_string_lossy())?
-            .map(|e| fs::canonicalize(e.unwrap()).unwrap())
-            .filter(|e| match mime_guess::from_path(e).first() {
-                Some(m) => m.type_() == "audio",
-                None => false,
-            })
-            .map(|x| x.to_string_lossy().to_string())
-            .collect::<Vec<String>>())
-    }
-}
-
-// A simple example of what a CLI-app would look.
-//
-// Note that `Library::new` is used only on init, and subsequent
-// commands use `Library::from_path`.
-fn main() -> Result<()> {
-    let matches = App::new("library-example")
-        .version(env!("CARGO_PKG_VERSION"))
-        .author("Polochon_street")
-        .about("Example binary implementing bliss for an audio player.")
-        .subcommand(
-            SubCommand::with_name("init")
-                .about(
-                    "Initialize a Library, both storing the config and analyzing folders
-                containing songs.",
-                )
-                .arg(
-                    Arg::with_name("FOLDER")
-                        .help("A folder containing the music library to analyze.")
-                        .required(true),
-                )
-                .arg(
-                    Arg::with_name("database-path")
-                        .short("d")
-                        .long("database-path")
-                        .help(
-                            "Optional path where to store the database file containing
-                 the songs' analysis. Defaults to XDG_DATA_HOME/bliss-rs/bliss.db.",
-                        )
-                        .takes_value(true),
-                )
-                .arg(
-                    Arg::with_name("config-path")
-                        .short("c")
-                        .long("config-path")
-                        .help(
-                            "Optional path where to store the config file containing
-                 the library setup. Defaults to XDG_DATA_HOME/bliss-rs/config.json.",
-                        )
-                        .takes_value(true),
-                ),
-        )
-        .subcommand(
-            SubCommand::with_name("update")
-                .about(
-                    "Update a Library's songs, trying to analyze failed songs,
-                    as well as songs not in the library.",
-                )
-                .arg(
-                    Arg::with_name("config-path")
-                        .short("c")
-                        .long("config-path")
-                        .help(
-                            "Optional path where to load the config file containing
-                 the library setup. Defaults to XDG_DATA_HOME/bliss-rs/config.json.",
-                        )
-                        .takes_value(true),
-                ),
-        )
-        .subcommand(
-            SubCommand::with_name("playlist")
-                .about(
-                    "Make a playlist, starting with the song at SONG_PATH, returning
-                       the songs' paths.",
-                )
-                .arg(Arg::with_name("SONG_PATH").takes_value(true))
-                .arg(
-                    Arg::with_name("config-path")
-                        .short("c")
-                        .long("config-path")
-                        .help(
-                            "Optional path where to load the config file containing
-                 the library setup. Defaults to XDG_DATA_HOME/bliss-rs/config.json.",
-                        )
-                        .takes_value(true),
-                )
-                .arg(
-                    Arg::with_name("playlist-length")
-                        .short("l")
-                        .long("playlist-length")
-                        .help("Optional playlist length. Defaults to 20.")
-                        .takes_value(true),
-                ),
-        )
-        .get_matches();
-    if let Some(sub_m) = matches.subcommand_matches("init") {
-        let folder = PathBuf::from(sub_m.value_of("FOLDER").unwrap());
-        let config_path = sub_m.value_of("config-path").map(PathBuf::from);
-        let database_path = sub_m.value_of("database-path").map(PathBuf::from);
-
-        let config = Config::new(folder, config_path, database_path, None)?;
-        let mut library = Library::new(config)?;
-
-        library.analyze_paths(library.song_paths()?, true)?;
-    } else if let Some(sub_m) = matches.subcommand_matches("update") {
-        let config_path = sub_m.value_of("config-path").map(PathBuf::from);
-        let mut library: Library<Config> = Library::from_config_path(config_path)?;
-        library.update_library(library.song_paths()?, true)?;
-    } else if let Some(sub_m) = matches.subcommand_matches("playlist") {
-        let song_path = sub_m.value_of("SONG_PATH").unwrap();
-        let config_path = sub_m.value_of("config-path").map(PathBuf::from);
-        let playlist_length = sub_m
-            .value_of("playlist-length")
-            .unwrap_or("20")
-            .parse::<usize>()?;
-        let library: Library<Config> = Library::from_config_path(config_path)?;
-        let songs = library.playlist_from::<()>(song_path, playlist_length)?;
-        let song_paths = songs
-            .into_iter()
-            .map(|s| s.bliss_song.path.to_string_lossy().to_string())
-            .collect::<Vec<String>>();
-        for song in song_paths {
-            println!("{:?}", song);
-        }
-    }
-
-    Ok(())
-}

examples/library_extra_info.rs

@@ -1,227 +0,0 @@
-/// Basic example of how one would combine bliss with an "audio player",
-/// through [Library], showing how to put extra info in the database for
-/// each song.
-///
-/// For simplicity's sake, this example recursively gets songs from a folder
-/// to emulate an audio player library, without handling CUE files.
-use anyhow::Result;
-use bliss_audio::library::{AppConfigTrait, BaseConfig, Library};
-use clap::{App, Arg, SubCommand};
-use glob::glob;
-use serde::{Deserialize, Serialize};
-use std::fs;
-use std::num::NonZeroUsize;
-use std::path::{Path, PathBuf};
-
-#[derive(Serialize, Deserialize, Clone, Debug)]
-/// A config structure, that will be serialized as a
-/// JSON file upon Library creation.
-pub struct Config {
-    #[serde(flatten)]
-    /// The base configuration, containing both the config file
-    /// path, as well as the database path.
-    pub base_config: BaseConfig,
-    /// An extra field, to store the music library path. Any number
-    /// of arbitrary fields (even Serializable structures) can
-    /// of course be added.
-    pub music_library_path: PathBuf,
-}
-
-impl Config {
-    pub fn new(
-        music_library_path: PathBuf,
-        config_path: Option<PathBuf>,
-        database_path: Option<PathBuf>,
-        number_cores: Option<NonZeroUsize>,
-    ) -> Result<Self> {
-        let base_config = BaseConfig::new(config_path, database_path, number_cores)?;
-        Ok(Self {
-            base_config,
-            music_library_path,
-        })
-    }
-}
-
-// The AppConfigTrait must know how to access the base config.
-impl AppConfigTrait for Config {
-    fn base_config(&self) -> &BaseConfig {
-        &self.base_config
-    }
-
-    fn base_config_mut(&mut self) -> &mut BaseConfig {
-        &mut self.base_config
-    }
-}
-
-// A trait allowing to implement methods for the Library,
-// useful if you don't need to store extra information in fields.
-// Otherwise, doing
-// ```
-// struct CustomLibrary {
-//    library: Library<Config>,
-//    extra_field: ...,
-// }
-// ```
-// and implementing functions for that struct would be the way to go.
-// That's what the [reference](https://github.com/Polochon-street/blissify-rs)
-// implementation does.
-trait CustomLibrary {
-    fn song_paths_info(&self) -> Result<Vec<(String, ExtraInfo)>>;
-}
-
-impl CustomLibrary for Library<Config> {
-    /// Get all songs in the player library, along with the extra info
-    /// one would want to store along with each song.
-    fn song_paths_info(&self) -> Result<Vec<(String, ExtraInfo)>> {
-        let music_path = &self.config.music_library_path;
-        let pattern = Path::new(&music_path).join("**").join("*");
-
-        Ok(glob(&pattern.to_string_lossy())?
-            .map(|e| fs::canonicalize(e.unwrap()).unwrap())
-            .filter_map(|e| {
-                mime_guess::from_path(&e).first().map(|m| {
-                    (
-                        e.to_string_lossy().to_string(),
-                        ExtraInfo {
-                            extension: e.extension().map(|e| e.to_string_lossy().to_string()),
-                            file_name: e.file_name().map(|e| e.to_string_lossy().to_string()),
-                            mime_type: format!("{}/{}", m.type_(), m.subtype()),
-                        },
-                    )
-                })
-            })
-            .collect::<Vec<(String, ExtraInfo)>>())
-    }
-}
-
-#[derive(Deserialize, Serialize, Debug, PartialEq, Clone, Default)]
-// An (somewhat simple) example of what extra metadata one would put, along
-// with song analysis data.
-struct ExtraInfo {
-    extension: Option<String>,
-    file_name: Option<String>,
-    mime_type: String,
-}
-
-// A simple example of what a CLI-app would look.
-//
-// Note that `Library::new` is used only on init, and subsequent
-// commands use `Library::from_path`.
-fn main() -> Result<()> {
-    let matches = App::new("library-example")
-        .version(env!("CARGO_PKG_VERSION"))
-        .author("Polochon_street")
-        .about("Example binary implementing bliss for an audio player.")
-        .subcommand(
-            SubCommand::with_name("init")
-                .about(
-                    "Initialize a Library, both storing the config and analyzing folders
-                containing songs.",
-                )
-                .arg(
-                    Arg::with_name("FOLDER")
-                        .help("A folder containing the music library to analyze.")
-                        .required(true),
-                )
-                .arg(
-                    Arg::with_name("database-path")
-                        .short("d")
-                        .long("database-path")
-                        .help(
-                            "Optional path where to store the database file containing
-                 the songs' analysis. Defaults to XDG_DATA_HOME/bliss-rs/bliss.db.",
-                        )
-                        .takes_value(true),
-                )
-                .arg(
-                    Arg::with_name("config-path")
-                        .short("c")
-                        .long("config-path")
-                        .help(
-                            "Optional path where to store the config file containing
-                 the library setup. Defaults to XDG_DATA_HOME/bliss-rs/config.json.",
-                        )
-                        .takes_value(true),
-                ),
-        )
-        .subcommand(
-            SubCommand::with_name("update")
-                .about(
-                    "Update a Library's songs, trying to analyze failed songs,
-                    as well as songs not in the library.",
-                )
-                .arg(
-                    Arg::with_name("config-path")
-                        .short("c")
-                        .long("config-path")
-                        .help(
-                            "Optional path where to load the config file containing
-                 the library setup. Defaults to XDG_DATA_HOME/bliss-rs/config.json.",
-                        )
-                        .takes_value(true),
-                ),
-        )
-        .subcommand(
-            SubCommand::with_name("playlist")
-                .about(
-                    "Make a playlist, starting with the song at SONG_PATH, returning
-                       the songs' paths.",
-                )
-                .arg(Arg::with_name("SONG_PATH").takes_value(true))
-                .arg(
-                    Arg::with_name("config-path")
-                        .short("c")
-                        .long("config-path")
-                        .help(
-                            "Optional path where to load the config file containing
-                 the library setup. Defaults to XDG_DATA_HOME/bliss-rs/config.json.",
-                        )
-                        .takes_value(true),
-                )
-                .arg(
-                    Arg::with_name("playlist-length")
-                        .short("l")
-                        .long("playlist-length")
-                        .help("Optional playlist length. Defaults to 20.")
-                        .takes_value(true),
-                ),
-        )
-        .get_matches();
-    if let Some(sub_m) = matches.subcommand_matches("init") {
-        let folder = PathBuf::from(sub_m.value_of("FOLDER").unwrap());
-        let config_path = sub_m.value_of("config-path").map(PathBuf::from);
-        let database_path = sub_m.value_of("database-path").map(PathBuf::from);
-
-        let config = Config::new(folder, config_path, database_path, None)?;
-        let mut library = Library::new(config)?;
-
-        library.analyze_paths_extra_info(library.song_paths_info()?, true)?;
-    } else if let Some(sub_m) = matches.subcommand_matches("update") {
-        let config_path = sub_m.value_of("config-path").map(PathBuf::from);
-        let mut library: Library<Config> = Library::from_config_path(config_path)?;
-        library.update_library_extra_info(library.song_paths_info()?, true)?;
-    } else if let Some(sub_m) = matches.subcommand_matches("playlist") {
-        let song_path = sub_m.value_of("SONG_PATH").unwrap();
-        let config_path = sub_m.value_of("config-path").map(PathBuf::from);
-        let playlist_length = sub_m
-            .value_of("playlist-length")
-            .unwrap_or("20")
-            .parse::<usize>()?;
-        let library: Library<Config> = Library::from_config_path(config_path)?;
-        let songs = library.playlist_from::<ExtraInfo>(song_path, playlist_length)?;
-        let playlist = songs
-            .into_iter()
-            .map(|s| {
-                (
-                    s.bliss_song.path.to_string_lossy().to_string(),
-                    s.extra_info.mime_type,
-                )
-            })
-            .collect::<Vec<(String, String)>>();
-        for (path, mime_type) in playlist {
-            println!("{} <{}>", path, mime_type,);
-        }
-    }
-
-    Ok(())
-}

examples/playlist.rs

@@ -1,95 +0,0 @@
-use anyhow::Result;
-use bliss_audio::playlist::{closest_to_first_song, dedup_playlist, euclidean_distance};
-use bliss_audio::{analyze_paths, Song};
-use clap::{App, Arg};
-use glob::glob;
-use std::env;
-use std::fs;
-use std::io::BufReader;
-use std::path::{Path, PathBuf};
-
-/* Analyzes a folder recursively, and make a playlist out of the file
- * provided by the user. */
-// How to use: ./playlist [-o file.m3u] [-a analysis.json] <folder> <file to start the playlist from>
-fn main() -> Result<()> {
-    let matches = App::new("playlist")
-        .version(env!("CARGO_PKG_VERSION"))
-        .author("Polochon_street")
-        .about("Analyze a folder and make a playlist from a target song")
-        .arg(Arg::with_name("output-playlist").short("o").long("output-playlist")
-            .value_name("PLAYLIST.M3U")
-            .help("Outputs the playlist to a file.")
-            .takes_value(true))
-        .arg(Arg::with_name("analysis-file").short("a").long("analysis-file")
-            .value_name("ANALYSIS.JSON")
-            .help("Use the songs that have been analyzed in <analysis-file>, and appends newly analyzed songs to it. Defaults to /tmp/analysis.json.")
-            .takes_value(true))
-        .arg(Arg::with_name("FOLDER").help("Folders containing some songs.").required(true))
-        .arg(Arg::with_name("FIRST-SONG").help("Song to start from (can be outside of FOLDER).").required(true))
-        .get_matches();
-
-    let folder = matches.value_of("FOLDER").unwrap();
-    let file = fs::canonicalize(matches.value_of("FIRST-SONG").unwrap())?;
-    let pattern = Path::new(folder).join("**").join("*");
-
-    let mut songs: Vec<Song> = Vec::new();
-    let analysis_path = matches
-        .value_of("analysis-file")
-        .unwrap_or("/tmp/analysis.json");
-    let analysis_file = fs::File::open(analysis_path);
-    if let Ok(f) = analysis_file {
-        let reader = BufReader::new(f);
-        songs = serde_json::from_reader(reader)?;
-    }
-
-    let analyzed_paths = songs
-        .iter()
-        .map(|s| s.path.to_owned())
-        .collect::<Vec<PathBuf>>();
-
-    let paths = glob(&pattern.to_string_lossy())?
-        .map(|e| fs::canonicalize(e.unwrap()).unwrap())
-        .filter(|e| match mime_guess::from_path(e).first() {
-            Some(m) => m.type_() == "audio",
-            None => false,
-        })
-        .map(|x| x.to_string_lossy().to_string())
-        .collect::<Vec<String>>();
-
-    let song_iterator = analyze_paths(
-        paths
-            .iter()
-            .filter(|p| !analyzed_paths.contains(&PathBuf::from(p)))
-            .map(|p| p.to_owned())
-            .collect::<Vec<String>>(),
-    );
-    let first_song = Song::from_path(file)?;
-    let mut analyzed_songs = vec![first_song.to_owned()];
-    for (path, result) in song_iterator {
-        match result {
-            Ok(song) => analyzed_songs.push(song),
-            Err(e) => println!("error analyzing {}: {}", path.display(), e),
-        };
-    }
-    analyzed_songs.extend_from_slice(&songs);
-    let serialized = serde_json::to_string(&analyzed_songs).unwrap();
-    let mut songs_to_chose_from: Vec<_> = analyzed_songs
-        .into_iter()
-        .filter(|x| x == &first_song || paths.contains(&x.path.to_string_lossy().to_string()))
-        .collect();
-    closest_to_first_song(&first_song, &mut songs_to_chose_from, euclidean_distance);
-    dedup_playlist(&mut songs_to_chose_from, None);
-
-    fs::write(analysis_path, serialized)?;
-    let playlist = songs_to_chose_from
-        .iter()
-        .map(|s| s.path.to_string_lossy().to_string())
-        .collect::<Vec<String>>()
-        .join("\n");
-    if let Some(m) = matches.value_of("output-playlist") {
-        fs::write(m, playlist)?;
-    } else {
-        println!("{}", playlist);
-    }
-    Ok(())
-}

index.d.ts

@@ -0,0 +1,2 @@
+export function analyzeSync(path: string): Uint8Array;
+export function analyze(path: string): Promise<Uint8Array>;

index.js

@@ -0,0 +1,13 @@
+try {
+  module.exports = require('./index.node');
+} catch {
+  const isLinux = process.platform === 'linux';
+
+  if (isLinux && process.arch === 'x64') {
+    module.exports = require('./index-x86_64-unknown-linux-gnu.node');
+  } else if (isLinux && process.arch === 'arm64') {
+    module.exports = require('./index-aarch64-unknown-linux-gnu.node');
+  } else {
+    throw new Error('Bliss: unsupported architecture');
+  }
+}

package-lock.json

@@ -0,0 +1,42 @@
+{
+  "name": "bliss-rs",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "bliss-rs",
+      "version": "1.0.0",
+      "license": "ISC",
+      "dependencies": {
+        "cargo-cp-artifact": "^0.1.8"
+      },
+      "devDependencies": {
+        "@types/node": "^20.10.5"
+      }
+    },
+    "node_modules/@types/node": {
+      "version": "20.10.5",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.10.5.tgz",
+      "integrity": "sha512-nNPsNE65wjMxEKI93yOP+NPGGBJz/PoN3kZsVLee0XMiJolxSekEVD8wRwBUBqkwc7UWop0edW50yrCQW4CyRw==",
+      "dev": true,
+      "dependencies": {
+        "undici-types": "~5.26.4"
+      }
+    },
+    "node_modules/cargo-cp-artifact": {
+      "version": "0.1.8",
+      "resolved": "https://registry.npmjs.org/cargo-cp-artifact/-/cargo-cp-artifact-0.1.8.tgz",
+      "integrity": "sha512-3j4DaoTrsCD1MRkTF2Soacii0Nx7UHCce0EwUf4fHnggwiE4fbmF2AbnfzayR36DF8KGadfh7M/Yfy625kgPlA==",
+      "bin": {
+        "cargo-cp-artifact": "bin/cargo-cp-artifact.js"
+      }
+    },
+    "node_modules/undici-types": {
+      "version": "5.26.5",
+      "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz",
+      "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==",
+      "dev": true
+    }
+  }
+}

package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@bliss-rs/bliss-rs",
+  "version": "0.0.4",
+  "description": "A fork of the bliss-rs library with Node.js bindings",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "directories": {
+    "example": "examples"
+  },
+  "files": ["index.js", "index.d.ts", "index-*.node"],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "cargo-cp-artifact -nc index.node -- cargo build --message-format=json-render-diagnostics"
+  },
+  "author": "antonlyap",
+  "license": "GPL",
+  "dependencies": {
+    "cargo-cp-artifact": "^0.1.8"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.5"
+  }
+}

src/bliss_lib.rs

@@ -0,0 +1,82 @@
+//! # bliss audio library
+//!
+//! bliss is a library for making "smart" audio playlists.
+//!
+//! The core of the library is the [Song] object, which relates to a
+//! specific analyzed song and contains its path, title, analysis, and
+//! other metadata fields (album, genre...).
+//! Analyzing a song is as simple as running `Song::from_path("/path/to/song")`.
+//!
+//! The [analysis](Song::analysis) field of each song is an array of f32, which
+//! makes the comparison between songs easy, by just using e.g. euclidean
+//! distance (see [distance](Song::distance) for instance).
+//!
+//! Once several songs have been analyzed, making a playlist from one Song
+//! is as easy as computing distances between that song and the rest, and ordering
+//! the songs by distance, ascending.
+//!
+//! # Examples
+//!
+//! ### Analyze & compute the distance between two songs
+//! ```no_run
+//! use bliss_audio::{BlissResult, Song};
+//!
+//! fn main() -> BlissResult<()> {
+//!     let song1 = Song::from_path("/path/to/song1")?;
+//!     let song2 = Song::from_path("/path/to/song2")?;
+//!
+//!     println!("Distance between song1 and song2 is {}", song1.distance(&song2));
+//!     Ok(())
+//! }
+//! ```
+#![cfg_attr(feature = "bench", feature(test))]
+#![warn(missing_docs)]
+
+use thiserror::Error;
+
+pub use crate::song::{Analysis, AnalysisIndex, Song, NUMBER_FEATURES};
+
+/// Target channels for ffmpeg
+pub const CHANNELS: u16 = 1;
+
+/// Target sample rate for ffmpeg
+pub const SAMPLE_RATE: u32 = 22050;
+/// Stores the current version of bliss-rs' features.
+/// It is bumped every time one or more feature is added, updated or removed,
+/// so plug-ins can rescan libraries when there is a major change.
+pub const FEATURES_VERSION: u16 = 1;
+
+#[derive(Error, Clone, Debug, PartialEq, Eq)]
+/// Umbrella type for bliss error types
+pub enum BlissError {
+    #[error("error happened while decoding file – {0}")]
+    /// An error happened while decoding an (audio) file.
+    DecodingError(String),
+    #[error("error happened while analyzing file – {0}")]
+    /// An error happened during the analysis of the song's samples by bliss.
+    AnalysisError(String),
+    #[error("error happened with the music library provider - {0}")]
+    /// An error happened with the music library provider.
+    /// Useful to report errors when you implement bliss for an audio player.
+    ProviderError(String),
+}
+
+/// bliss error type
+pub type BlissResult<T> = Result<T, BlissError>;
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_send_song() {
+        fn assert_send<T: Send>() {}
+        assert_send::<Song>();
+    }
+
+    #[test]
+    fn test_sync_song() {
+        fn assert_sync<T: Send>() {}
+        assert_sync::<Song>();
+    }
+}

src/chroma.rs

@@ -7,7 +7,7 @@ extern crate noisy_float;
 
 use crate::utils::stft;
 use crate::utils::{hz_to_octs_inplace, Normalize};
-use crate::{BlissError, BlissResult};
+use crate::bliss_lib::{BlissError, BlissResult};
 use ndarray::{arr1, arr2, concatenate, s, Array, Array1, Array2, Axis, Zip};
 use ndarray_stats::interpolate::Midpoint;
 use ndarray_stats::QuantileExt;
@@ -53,13 +53,7 @@ impl ChromaDesc {
      */
     pub fn do_(&mut self, signal: &[f32]) -> BlissResult<()> {
         let mut stft = stft(signal, ChromaDesc::WINDOW_SIZE, 2205);
-        let tuning = estimate_tuning(
-            self.sample_rate as u32,
-            &stft,
-            ChromaDesc::WINDOW_SIZE,
-            0.01,
-            12,
-        )?;
+        let tuning = estimate_tuning(self.sample_rate, &stft, ChromaDesc::WINDOW_SIZE, 0.01, 12)?;
         let chroma = chroma_stft(
             self.sample_rate,
             &mut stft,
@@ -162,7 +156,7 @@ fn chroma_filter(
     let n_chroma2 = (n_chroma_float / 2.0).round() as u32;
     let n_chroma2_float = f64::from(n_chroma2);
 
-    let frequencies = Array::linspace(0., f64::from(sample_rate), (n_fft + 1) as usize);
+    let frequencies = Array::linspace(0., f64::from(sample_rate), n_fft + 1);
 
     let mut freq_bins = frequencies;
     hz_to_octs_inplace(&mut freq_bins, tuning, n_chroma);
@@ -213,12 +207,12 @@ fn chroma_filter(
     }
     let mut b = Array::from(uninit)
         .into_shape(wts.dim())
-        .map_err(|e| BlissError::AnalysisError(format!("in chroma: {}", e)))?;
+        .map_err(|e| BlissError::AnalysisError(format!("in chroma: {e}")))?;
     b.slice_mut(s![-3.., ..]).assign(&wts.slice(s![..3, ..]));
     b.slice_mut(s![..-3, ..]).assign(&wts.slice(s![3.., ..]));
 
     wts = b;
-    let non_aliased = (1 + n_fft / 2) as usize;
+    let non_aliased = 1 + n_fft / 2;
     Ok(wts.slice_move(s![.., ..non_aliased]))
 }
 
@@ -308,7 +302,7 @@ fn pitch_tuning(
     }
     let max_index = counts
         .argmax()
-        .map_err(|e| BlissError::AnalysisError(format!("in chroma: {}", e)))?;
+        .map_err(|e| BlissError::AnalysisError(format!("in chroma: {e}")))?;
 
     // Return the bin with the most reoccuring frequency.
     Ok((-50. + (100. * resolution * max_index as f64)) / 100.)
@@ -336,7 +330,7 @@ fn estimate_tuning(
 
     let threshold: N64 = Array::from(filtered_mag.to_vec())
         .quantile_axis_mut(Axis(0), n64(0.5), &Midpoint)
-        .map_err(|e| BlissError::AnalysisError(format!("in chroma: {}", e)))?
+        .map_err(|e| BlissError::AnalysisError(format!("in chroma: {e}")))?
         .into_scalar();
     let mut pitch = filtered_pitch
         .iter()
@@ -371,7 +365,7 @@ fn chroma_stft(
 mod test {
     use super::*;
     use crate::utils::stft;
-    use crate::{Song, SAMPLE_RATE};
+    use crate::bliss_lib::{Song, SAMPLE_RATE};
     use ndarray::{arr1, arr2, Array2};
     use ndarray_npy::ReadNpyExt;
     use std::fs::File;
@@ -443,7 +437,7 @@ mod test {
     fn test_chroma_desc() {
         let song = Song::decode(Path::new("data/s16_mono_22_5kHz.flac")).unwrap();
         let mut chroma_desc = ChromaDesc::new(SAMPLE_RATE, 12);
-        chroma_desc.do_(&song.sample_array).unwrap();
+        chroma_desc.do_(&song).unwrap();
         let expected_values = vec![
             -0.35661936,
             -0.63578653,
@@ -463,9 +457,7 @@ mod test {
 
     #[test]
     fn test_chroma_stft_decode() {
-        let signal = Song::decode(Path::new("data/s16_mono_22_5kHz.flac"))
-            .unwrap()
-            .sample_array;
+        let signal = Song::decode(Path::new("data/s16_mono_22_5kHz.flac")).unwrap();
         let mut stft = stft(&signal, 8192, 2205);
 
         let file = File::open("data/chroma.npy").unwrap();
@@ -496,9 +488,7 @@ mod test {
 
     #[test]
     fn test_estimate_tuning_decode() {
-        let signal = Song::decode(Path::new("data/s16_mono_22_5kHz.flac"))
-            .unwrap()
-            .sample_array;
+        let signal = Song::decode(Path::new("data/s16_mono_22_5kHz.flac")).unwrap();
         let stft = stft(&signal, 8192, 2205);
 
         let tuning = estimate_tuning(22050, &stft, 8192, 0.01, 12).unwrap();

src/cue.rs

@@ -1,339 +0,0 @@
-//! CUE-handling module.
-//!
-//! Using [BlissCue::songs_from_path] is most likely what you want.
-
-use crate::{Analysis, BlissError, BlissResult, Song, FEATURES_VERSION, SAMPLE_RATE};
-use rcue::cue::{Cue, Track};
-use rcue::parser::parse_from_file;
-use std::path::{Path, PathBuf};
-use std::time::Duration;
-
-#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
-#[derive(Default, Debug, PartialEq, Eq, Clone)]
-/// A struct populated when the corresponding [Song] has been extracted from an
-/// audio file split with the help of a CUE sheet.
-pub struct CueInfo {
-    /// The path of the original CUE sheet, e.g. `/path/to/album_name.cue`.
-    pub cue_path: PathBuf,
-    /// The path of the audio file the song was extracted from, e.g.
-    /// `/path/to/album_name.wav`. Used because one CUE sheet can refer to
-    /// several audio files.
-    pub audio_file_path: PathBuf,
-}
-
-/// A struct to handle CUEs with bliss.
-/// Use either [analyze_paths](crate::analyze_paths) with CUE files or
-/// [songs_from_path](BlissCue::songs_from_path) to return a list of [Song]s
-/// from CUE files.
-pub struct BlissCue {
-    cue: Cue,
-    cue_path: PathBuf,
-}
-
-#[allow(missing_docs)]
-#[derive(Default, Debug, PartialEq, Clone)]
-struct BlissCueFile {
-    sample_array: Vec<f32>,
-    album: Option<String>,
-    artist: Option<String>,
-    genre: Option<String>,
-    tracks: Vec<Track>,
-    cue_path: PathBuf,
-    audio_file_path: PathBuf,
-}
-
-impl BlissCue {
-    /// Analyze songs from a CUE file, extracting individual [Song] objects
-    /// for each individual song.
-    ///
-    /// Each returned [Song] has a populated [cue_info](Song::cue_info) object, that can be
-    /// be used to retrieve which CUE sheet was used to extract it, as well
-    /// as the corresponding audio file.
-    pub fn songs_from_path<P: AsRef<Path>>(path: P) -> BlissResult<Vec<BlissResult<Song>>> {
-        let cue = BlissCue::from_path(&path)?;
-        let cue_files = cue.files();
-        let mut songs = Vec::new();
-        for cue_file in cue_files.into_iter() {
-            match cue_file {
-                Ok(f) => {
-                    if !f.sample_array.is_empty() {
-                        songs.extend_from_slice(&f.get_songs());
-                    } else {
-                        songs.push(Err(BlissError::DecodingError(
-                            "empty audio file associated to CUE sheet".into(),
-                        )));
-                    }
-                }
-                Err(e) => songs.push(Err(e)),
-            }
-        }
-        Ok(songs)
-    }
-
-    // Extract a BlissCue from a given path.
-    fn from_path<P: AsRef<Path>>(path: P) -> BlissResult<Self> {
-        let cue = parse_from_file(&path.as_ref().to_string_lossy(), false).map_err(|e| {
-            BlissError::DecodingError(format!(
-                "when opening CUE file '{:?}': {:?}",
-                path.as_ref(),
-                e
-            ))
-        })?;
-        Ok(BlissCue {
-            cue,
-            cue_path: path.as_ref().to_owned(),
-        })
-    }
-
-    // List all BlissCueFile from a BlissCue.
-    fn files(&self) -> Vec<BlissResult<BlissCueFile>> {
-        let mut cue_files = Vec::new();
-        for cue_file in self.cue.files.iter() {
-            let audio_file_path = match &self.cue_path.parent() {
-                Some(parent) => parent.join(Path::new(&cue_file.file)),
-                None => PathBuf::from(cue_file.file.to_owned()),
-            };
-            let genre = self
-                .cue
-                .comments
-                .iter()
-                .find(|(c, _)| c == "GENRE")
-                .map(|(_, v)| v.to_owned());
-            let raw_song = Song::decode(Path::new(&audio_file_path));
-            if let Ok(song) = raw_song {
-                let bliss_cue_file = BlissCueFile {
-                    sample_array: song.sample_array,
-                    genre,
-                    artist: self.cue.performer.to_owned(),
-                    album: self.cue.title.to_owned(),
-                    tracks: cue_file.tracks.to_owned(),
-                    audio_file_path,
-                    cue_path: self.cue_path.to_owned(),
-                };
-                cue_files.push(Ok(bliss_cue_file))
-            } else {
-                cue_files.push(Err(raw_song.unwrap_err()));
-            }
-        }
-        cue_files
-    }
-}
-
-impl BlissCueFile {
-    fn create_song(
-        &self,
-        analysis: BlissResult<Analysis>,
-        current_track: &Track,
-        duration: Duration,
-        index: usize,
-    ) -> BlissResult<Song> {
-        if let Ok(a) = analysis {
-            let song = Song {
-                path: PathBuf::from(format!(
-                    "{}/CUE_TRACK{:03}",
-                    self.cue_path.to_string_lossy(),
-                    index,
-                )),
-                album: self.album.to_owned(),
-                artist: current_track.performer.to_owned(),
-                album_artist: self.artist.to_owned(),
-                analysis: a,
-                duration,
-                genre: self.genre.to_owned(),
-                title: current_track.title.to_owned(),
-                track_number: Some(current_track.no.to_owned()),
-                features_version: FEATURES_VERSION,
-                cue_info: Some(CueInfo {
-                    cue_path: self.cue_path.to_owned(),
-                    audio_file_path: self.audio_file_path.to_owned(),
-                }),
-            };
-            Ok(song)
-        } else {
-            Err(analysis.unwrap_err())
-        }
-    }
-
-    // Get all songs from a BlissCueFile, using Song::analyze, each song being
-    // located using the sample_array and the timestamp delimiter.
-    fn get_songs(&self) -> Vec<BlissResult<Song>> {
-        let mut songs = Vec::new();
-        for (index, tuple) in (self.tracks[..]).windows(2).enumerate() {
-            let (current_track, next_track) = (tuple[0].to_owned(), tuple[1].to_owned());
-            if let Some((_, start_current)) = current_track.indices.get(0) {
-                if let Some((_, end_current)) = next_track.indices.get(0) {
-                    let start_current = (start_current.as_secs_f32() * SAMPLE_RATE as f32) as usize;
-                    let end_current = (end_current.as_secs_f32() * SAMPLE_RATE as f32) as usize;
-                    let duration = Duration::from_secs_f32(
-                        (end_current - start_current) as f32 / SAMPLE_RATE as f32,
-                    );
-                    let analysis = Song::analyze(&self.sample_array[start_current..end_current]);
-
-                    let song = self.create_song(analysis, &current_track, duration, index + 1);
-                    songs.push(song);
-                }
-            }
-        }
-        // Take care of the last track, since the windows iterator doesn't.
-        if let Some(last_track) = self.tracks.last() {
-            if let Some((_, start_current)) = last_track.indices.get(0) {
-                let start_current = (start_current.as_secs_f32() * SAMPLE_RATE as f32) as usize;
-                let duration = Duration::from_secs_f32(
-                    (self.sample_array.len() - start_current) as f32 / SAMPLE_RATE as f32,
-                );
-                let analysis = Song::analyze(&self.sample_array[start_current..]);
-                let song = self.create_song(analysis, last_track, duration, self.tracks.len());
-                songs.push(song);
-            }
-        }
-        songs
-    }
-}
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-    use pretty_assertions::assert_eq;
-
-    #[test]
-    fn test_empty_cue() {
-        let songs = BlissCue::songs_from_path("data/empty.cue").unwrap();
-        let error = songs[0].to_owned().unwrap_err();
-        assert_eq!(
-            error,
-            BlissError::DecodingError("empty audio file associated to CUE sheet".to_string())
-        );
-    }
-
-    #[test]
-    fn test_cue_analysis() {
-        let songs = BlissCue::songs_from_path("data/testcue.cue").unwrap();
-        let expected = vec![
-            Ok(Song {
-                path: Path::new("data/testcue.cue/CUE_TRACK001").to_path_buf(),
-                analysis: Analysis {
-                    internal_analysis: [
-                        0.38463724,
-                        -0.85219246,
-                        -0.761946,
-                        -0.8904667,
-                        -0.63892543,
-                        -0.73945934,
-                        -0.8004017,
-                        -0.8237293,
-                        0.33865356,
-                        0.32481194,
-                        -0.35692245,
-                        -0.6355889,
-                        -0.29584837,
-                        0.06431806,
-                        0.21875131,
-                        -0.58104205,
-                        -0.9466792,
-                        -0.94811195,
-                        -0.9820919,
-                        -0.9596871,
-                    ],
-                },
-                album: Some(String::from("Album for CUE test")),
-                artist: Some(String::from("David TMX")),
-                title: Some(String::from("Renaissance")),
-                genre: Some(String::from("Random")),
-                track_number: Some(String::from("01")),
-                features_version: FEATURES_VERSION,
-                album_artist: Some(String::from("Polochon_street")),
-                duration: Duration::from_secs_f32(11.066666603),
-                cue_info: Some(CueInfo {
-                    cue_path: PathBuf::from("data/testcue.cue"),
-                    audio_file_path: PathBuf::from("data/testcue.flac"),
-                }),
-                ..Default::default()
-            }),
-            Ok(Song {
-                path: Path::new("data/testcue.cue/CUE_TRACK002").to_path_buf(),
-                analysis: Analysis {
-                    internal_analysis: [
-                        0.18622077,
-                        -0.5989029,
-                        -0.5554645,
-                        -0.6343865,
-                        -0.24163479,
-                        -0.25766593,
-                        -0.40616858,
-                        -0.23334873,
-                        0.76875293,
-                        0.7785741,
-                        -0.5075115,
-                        -0.5272629,
-                        -0.56706166,
-                        -0.568486,
-                        -0.5639081,
-                        -0.5706943,
-                        -0.96501005,
-                        -0.96501285,
-                        -0.9649896,
-                        -0.96498996,
-                    ],
-                },
-                features_version: FEATURES_VERSION,
-                album: Some(String::from("Album for CUE test")),
-                artist: Some(String::from("Polochon_street")),
-                title: Some(String::from("Piano")),
-                genre: Some(String::from("Random")),
-                track_number: Some(String::from("02")),
-                album_artist: Some(String::from("Polochon_street")),
-                duration: Duration::from_secs_f64(5.853333473),
-                cue_info: Some(CueInfo {
-                    cue_path: PathBuf::from("data/testcue.cue"),
-                    audio_file_path: PathBuf::from("data/testcue.flac"),
-                }),
-                ..Default::default()
-            }),
-            Ok(Song {
-                path: Path::new("data/testcue.cue/CUE_TRACK003").to_path_buf(),
-                analysis: Analysis {
-                    internal_analysis: [
-                        0.0024261475,
-                        0.9874661,
-                        0.97330654,
-                        -0.9724426,
-                        0.99678576,
-                        -0.9961549,
-                        -0.9840142,
-                        -0.9269961,
-                        0.7498772,
-                        0.22429907,
-                        -0.8355152,
-                        -0.9977258,
-                        -0.9977849,
-                        -0.997785,
-                        -0.99778515,
-                        -0.997785,
-                        -0.99999976,
-                        -0.99999976,
-                        -0.99999976,
-                        -0.99999976,
-                    ],
-                },
-                album: Some(String::from("Album for CUE test")),
-                artist: Some(String::from("Polochon_street")),
-                title: Some(String::from("Tone")),
-                genre: Some(String::from("Random")),
-                track_number: Some(String::from("03")),
-                features_version: FEATURES_VERSION,
-                album_artist: Some(String::from("Polochon_street")),
-                duration: Duration::from_secs_f32(5.586666584),
-                cue_info: Some(CueInfo {
-                    cue_path: PathBuf::from("data/testcue.cue"),
-                    audio_file_path: PathBuf::from("data/testcue.flac"),
-                }),
-                ..Default::default()
-            }),
-            Err(BlissError::DecodingError(String::from(
-                "while opening format for file 'data/not-existing.wav': \
-                ffmpeg::Error(2: No such file or directory).",
-            ))),
-        ];
-        assert_eq!(expected, songs);
-    }
-}

src/lib.rs

@@ -1,335 +1,67 @@
-//! # bliss audio library
-//!
-//! bliss is a library for making "smart" audio playlists.
-//!
-//! The core of the library is the [Song] object, which relates to a
-//! specific analyzed song and contains its path, title, analysis, and
-//! other metadata fields (album, genre...).
-//! Analyzing a song is as simple as running `Song::from_path("/path/to/song")`.
-//!
-//! The [analysis](Song::analysis) field of each song is an array of f32, which
-//! makes the comparison between songs easy, by just using e.g. euclidean
-//! distance (see [distance](Song::distance) for instance).
-//!
-//! Once several songs have been analyzed, making a playlist from one Song
-//! is as easy as computing distances between that song and the rest, and ordering
-//! the songs by distance, ascending.
-//!
-//! If you want to implement a bliss plugin for an already existing audio
-//! player, the [Library] struct is a collection of goodies that should prove
-//! useful (it contains utilities to store analyzed songs in a self-contained
-//! database file, to make playlists directly from the database, etc).
-//! [blissify](https://github.com/Polochon-street/blissify-rs/) for both
-//! an example of how the [Library] struct works, and a real-life demo of bliss
-//! implemented for [MPD](https://www.musicpd.org/).
-//!
-//! # Examples
-//!
-//! ### Analyze & compute the distance between two songs
-//! ```no_run
-//! use bliss_audio::{BlissResult, Song};
-//!
-//! fn main() -> BlissResult<()> {
-//!     let song1 = Song::from_path("/path/to/song1")?;
-//!     let song2 = Song::from_path("/path/to/song2")?;
-//!
-//!     println!("Distance between song1 and song2 is {}", song1.distance(&song2));
-//!     Ok(())
-//! }
-//! ```
-//!
-//! ### Make a playlist from a song, discarding failed songs
-//! ```no_run
-//! use bliss_audio::{
-//!     analyze_paths,
-//!     playlist::{closest_to_first_song, euclidean_distance},
-//!     BlissResult, Song,
-//! };
-//!
-//! fn main() -> BlissResult<()> {
-//!     let paths = vec!["/path/to/song1", "/path/to/song2", "/path/to/song3"];
-//!     let mut songs: Vec<Song> = analyze_paths(&paths).filter_map(|(_, s)| s.ok()).collect();
-//!
-//!     // Assuming there is a first song
-//!     let first_song = songs.first().unwrap().to_owned();
-//!
-//!     closest_to_first_song(&first_song, &mut songs, euclidean_distance);
-//!
-//!     println!("Playlist is:");
-//!     for song in songs {
-//!         println!("{}", song.path.display());
-//!     }
-//!     Ok(())
-//! }
-//! ```
-#![cfg_attr(feature = "bench", feature(test))]
-#![warn(missing_docs)]
-#![warn(rustdoc::missing_doc_code_examples)]
+pub mod bliss_lib;
 mod chroma;
-pub mod cue;
-#[cfg(feature = "library")]
-pub mod library;
-mod misc;
-pub mod playlist;
 mod song;
+mod misc;
 mod temporal;
 mod timbral;
 mod utils;
 
-extern crate crossbeam;
-extern crate num_cpus;
-#[cfg(feature = "serde")]
-#[macro_use]
-extern crate serde;
-use crate::cue::BlissCue;
-use log::info;
-use std::num::NonZeroUsize;
-use std::path::{Path, PathBuf};
-use std::sync::mpsc;
-use std::thread;
-use thiserror::Error;
+use neon::{prelude::*, types::buffer::TypedArray};
+use song::Song;
+use bliss_lib::BlissResult;
 
-pub use song::{Analysis, AnalysisIndex, Song, NUMBER_FEATURES};
-
-const CHANNELS: u16 = 1;
-const SAMPLE_RATE: u32 = 22050;
-/// Stores the current version of bliss-rs' features.
-/// It is bumped every time one or more feature is added, updated or removed,
-/// so plug-ins can rescan libraries when there is a major change.
-pub const FEATURES_VERSION: u16 = 1;
-
-#[derive(Error, Clone, Debug, PartialEq, Eq)]
-/// Umbrella type for bliss error types
-pub enum BlissError {
-    #[error("error happened while decoding file – {0}")]
-    /// An error happened while decoding an (audio) file.
-    DecodingError(String),
-    #[error("error happened while analyzing file – {0}")]
-    /// An error happened during the analysis of the song's samples by bliss.
-    AnalysisError(String),
-    #[error("error happened with the music library provider - {0}")]
-    /// An error happened with the music library provider.
-    /// Useful to report errors when you implement bliss for an audio player.
-    ProviderError(String),
+#[neon::main]
+fn main(mut cx: ModuleContext) -> NeonResult<()> {
+    cx.export_function("analyzeSync", analyze)?;
+    cx.export_function("analyze", analyze_async)?;
+    Ok(())
 }
 
-/// bliss error type
-pub type BlissResult<T> = Result<T, BlissError>;
-
-/// Analyze songs in `paths`, and return the analyzed [Song] objects through an
-/// [mpsc::IntoIter].
-///
-/// Returns an iterator, whose items are a tuple made of
-/// the song path (to display to the user in case the analysis failed),
-/// and a Result<Song>.
-///
-/// # Note
-///
-/// This function also works with CUE files - it finds the audio files
-/// mentionned in the CUE sheet, and then runs the analysis on each song
-/// defined by it, returning a proper [Song] object for each one of them.
-///
-/// Make sure that you don't submit both the audio file along with the CUE
-/// sheet if your library uses them, otherwise the audio file will be
-/// analyzed as one, single, long song. For instance, with a CUE sheet named
-/// `cue-file.cue` with the corresponding audio files `album-1.wav` and
-/// `album-2.wav` defined in the CUE sheet, you would just pass `cue-file.cue`
-/// to `analyze_paths`, and it will return [Song]s from both files, with
-/// more information about which file it is extracted from in the
-/// [cue info field](Song::cue_info).
-///
-/// # Example:
-/// ```no_run
-/// use bliss_audio::{analyze_paths, BlissResult};
-///
-/// fn main() -> BlissResult<()> {
-///     let paths = vec![String::from("/path/to/song1"), String::from("/path/to/song2")];
-///     for (path, result) in analyze_paths(&paths) {
-///         match result {
-///             Ok(song) => println!("Do something with analyzed song {} with title {:?}", song.path.display(), song.title),
-///             Err(e) => println!("Song at {} could not be analyzed. Failed with: {}", path.display(), e),
-///         }
-///     }
-///     Ok(())
-/// }
-/// ```
-pub fn analyze_paths<P: Into<PathBuf>, F: IntoIterator<Item = P>>(
-    paths: F,
-) -> mpsc::IntoIter<(PathBuf, BlissResult<Song>)> {
-    let cores = NonZeroUsize::new(num_cpus::get()).unwrap();
-    analyze_paths_with_cores(paths, cores)
-}
-
-/// Analyze songs in `paths`, and return the analyzed [Song] objects through an
-/// [mpsc::IntoIter]. `number_cores` sets the number of cores the analysis
-/// will use, capped by your system's capacity. Most of the time, you want to
-/// use the simpler `analyze_paths` functions, which autodetects the number
-/// of cores in your system.
-///
-/// Return an iterator, whose items are a tuple made of
-/// the song path (to display to the user in case the analysis failed),
-/// and a Result<Song>.
-///
-/// # Note
-///
-/// This function also works with CUE files - it finds the audio files
-/// mentionned in the CUE sheet, and then runs the analysis on each song
-/// defined by it, returning a proper [Song] object for each one of them.
-///
-/// Make sure that you don't submit both the audio file along with the CUE
-/// sheet if your library uses them, otherwise the audio file will be
-/// analyzed as one, single, long song. For instance, with a CUE sheet named
-/// `cue-file.cue` with the corresponding audio files `album-1.wav` and
-/// `album-2.wav` defined in the CUE sheet, you would just pass `cue-file.cue`
-/// to `analyze_paths`, and it will return [Song]s from both files, with
-/// more information about which file it is extracted from in the
-/// [cue info field](Song::cue_info).
-///
-/// # Example:
-/// ```no_run
-/// use bliss_audio::{analyze_paths, BlissResult};
-///
-/// fn main() -> BlissResult<()> {
-///     let paths = vec![String::from("/path/to/song1"), String::from("/path/to/song2")];
-///     for (path, result) in analyze_paths(&paths) {
-///         match result {
-///             Ok(song) => println!("Do something with analyzed song {} with title {:?}", song.path.display(), song.title),
-///             Err(e) => println!("Song at {} could not be analyzed. Failed with: {}", path.display(), e),
-///         }
-///     }
-///     Ok(())
-/// }
-/// ```
-pub fn analyze_paths_with_cores<P: Into<PathBuf>, F: IntoIterator<Item = P>>(
-    paths: F,
-    number_cores: NonZeroUsize,
-) -> mpsc::IntoIter<(PathBuf, BlissResult<Song>)> {
-    let mut cores = NonZeroUsize::new(num_cpus::get()).unwrap();
-    if cores > number_cores {
-        cores = number_cores;
-    }
-    let paths: Vec<PathBuf> = paths.into_iter().map(|p| p.into()).collect();
-    #[allow(clippy::type_complexity)]
-    let (tx, rx): (
-        mpsc::Sender<(PathBuf, BlissResult<Song>)>,
-        mpsc::Receiver<(PathBuf, BlissResult<Song>)>,
-    ) = mpsc::channel();
-    if paths.is_empty() {
-        return rx.into_iter();
-    }
-    let mut handles = Vec::new();
-    let mut chunk_length = paths.len() / cores;
-    if chunk_length == 0 {
-        chunk_length = paths.len();
-    }
-    for chunk in paths.chunks(chunk_length) {
-        let tx_thread = tx.clone();
-        let owned_chunk = chunk.to_owned();
-        let child = thread::spawn(move || {
-            for path in owned_chunk {
-                info!("Analyzing file '{:?}'", path);
-                if let Some(extension) = Path::new(&path).extension() {
-                    let extension = extension.to_string_lossy().to_lowercase();
-                    if extension == "cue" {
-                        match BlissCue::songs_from_path(&path) {
-                            Ok(songs) => {
-                                for song in songs {
-                                    tx_thread.send((path.to_owned(), song)).unwrap();
-                                }
-                            }
-                            Err(e) => tx_thread.send((path.to_owned(), Err(e))).unwrap(),
-                        };
-                        continue;
-                    }
-                }
-                let song = Song::from_path(&path);
-                tx_thread.send((path.to_owned(), song)).unwrap();
-            }
-        });
-        handles.push(child);
-    }
-
-    rx.into_iter()
-}
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-    #[cfg(test)]
-    use pretty_assertions::assert_eq;
-
-    #[test]
-    fn test_send_song() {
-        fn assert_send<T: Send>() {}
-        assert_send::<Song>();
-    }
-
-    #[test]
-    fn test_sync_song() {
-        fn assert_sync<T: Send>() {}
-        assert_sync::<Song>();
-    }
-
-    #[test]
-    fn test_analyze_paths() {
-        let paths = vec![
-            "./data/s16_mono_22_5kHz.flac",
-            "./data/testcue.cue",
-            "./data/white_noise.flac",
-            "definitely-not-existing.foo",
-            "not-existing.foo",
-        ];
-        let mut results = analyze_paths(&paths)
-            .map(|x| match &x.1 {
-                Ok(s) => (true, s.path.to_owned(), None),
-                Err(e) => (false, x.0.to_owned(), Some(e.to_string())),
+#[allow(deprecated)]
+fn analyze_async(mut cx: FunctionContext) -> JsResult<JsPromise> {
+    let path = cx.argument::<JsString>(0)?.value(&mut cx);
+    let promise = cx.task(move || {
+        analyze_raw(&path)
+    }).promise(|mut cx, result| {
+        result
+            .map(|(version_bytes, analysis_bytes)| {
+                let mut buffer_handle = JsUint8Array::new(
+                    &mut cx,
+                    analysis_bytes.len() + version_bytes.len(),
+                ).unwrap();
+                let buffer = buffer_handle.as_mut_slice(&mut cx);
+                
+                buffer[0..version_bytes.len()].copy_from_slice(&version_bytes);
+                buffer[version_bytes.len()..].copy_from_slice(&analysis_bytes);
+                buffer_handle
             })
-            .collect::<Vec<_>>();
-        results.sort();
-        let expected_results = vec![
-            (
-                false,
-                PathBuf::from("./data/testcue.cue"),
-                Some(String::from(
-                    "error happened while decoding file – while \
-                            opening format for file './data/not-existing.wav': \
-                            ffmpeg::Error(2: No such file or directory).",
-                )),
-            ),
-            (
-                false,
-                PathBuf::from("definitely-not-existing.foo"),
-                Some(String::from(
-                    "error happened while decoding file – while \
-                            opening format for file 'definitely-not-existing\
-                            .foo': ffmpeg::Error(2: No such file or directory).",
-                )),
-            ),
-            (
-                false,
-                PathBuf::from("not-existing.foo"),
-                Some(String::from(
-                    "error happened while decoding file – \
-                            while opening format for file 'not-existing.foo': \
-                            ffmpeg::Error(2: No such file or directory).",
-                )),
-            ),
-            (true, PathBuf::from("./data/s16_mono_22_5kHz.flac"), None),
-            (true, PathBuf::from("./data/testcue.cue/CUE_TRACK001"), None),
-            (true, PathBuf::from("./data/testcue.cue/CUE_TRACK002"), None),
-            (true, PathBuf::from("./data/testcue.cue/CUE_TRACK003"), None),
-            (true, PathBuf::from("./data/white_noise.flac"), None),
-        ];
-
-        assert_eq!(results, expected_results);
-
-        let mut results = analyze_paths_with_cores(&paths, NonZeroUsize::new(1).unwrap())
-            .map(|x| match &x.1 {
-                Ok(s) => (true, s.path.to_owned(), None),
-                Err(e) => (false, x.0.to_owned(), Some(e.to_string())),
-            })
-            .collect::<Vec<_>>();
-        results.sort();
-        assert_eq!(results, expected_results);
-    }
+            .or_else(|e| cx.throw_error(e.to_string()))
+    });
+    Ok(promise)
+}
+
+/// Returns a Uint8Array, with the first 2 bytes being the version (16-bit unsigned little endian)
+/// and the rest (currently 80 bytes) being the analysis data in little endian
+fn analyze(mut cx: FunctionContext) -> JsResult<JsUint8Array> {
+    let path = cx.argument::<JsString>(0)?.value(&mut cx);
+    let (version_bytes, analysis_bytes) = analyze_raw(&path)
+        .or_else(|e| cx.throw_error(e.to_string()))?;
+
+    let mut buffer_handle = JsUint8Array::new(
+        &mut cx,
+        analysis_bytes.len() + version_bytes.len(),
+    )?;
+    let buffer = buffer_handle.as_mut_slice(&mut cx);
+    
+    buffer[0..version_bytes.len()].copy_from_slice(&version_bytes);
+    buffer[version_bytes.len()..].copy_from_slice(&analysis_bytes);
+
+    Ok(buffer_handle)
+}
+
+fn analyze_raw(path: &str) -> BlissResult<([u8; 2], [u8; 80])> {
+    let song = Song::from_path(path)?;
+    let version_bytes = song.features_version.to_le_bytes();
+    let analysis_bytes = song.analysis.as_bytes();
+    Ok((version_bytes, analysis_bytes))
 }

src/misc.rs

@@ -63,14 +63,14 @@ impl Normalize for LoudnessDesc {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::Song;
+    use crate::bliss_lib::Song;
     use std::path::Path;
 
     #[test]
     fn test_loudness() {
         let song = Song::decode(Path::new("data/s16_mono_22_5kHz.flac")).unwrap();
         let mut loudness_desc = LoudnessDesc::default();
-        for chunk in song.sample_array.chunks_exact(LoudnessDesc::WINDOW_SIZE) {
+        for chunk in song.chunks_exact(LoudnessDesc::WINDOW_SIZE) {
             loudness_desc.do_(&chunk);
         }
         let expected_values = vec![0.271263, 0.2577181];

src/playlist.rs

@@ -1,984 +0,0 @@
-//! Module containing various functions to build playlists, as well as various
-//! distance metrics.
-//!
-//! All of the distance functions are intended to be used with the
-//! [custom_distance](Song::custom_distance) method, or with
-//!
-//! They will yield different styles of playlists, so don't hesitate to
-//! experiment with them if the default (euclidean distance for now) doesn't
-//! suit you.
-// TODO on the `by_key` functions: maybe Fn(&T) -> &Song is enough? Compared
-// to -> Song
-use crate::{BlissError, BlissResult, Song, NUMBER_FEATURES};
-use ndarray::{Array, Array1, Array2, Axis};
-use ndarray_stats::QuantileExt;
-use noisy_float::prelude::*;
-use std::collections::HashMap;
-
-/// Convenience trait for user-defined distance metrics.
-pub trait DistanceMetric: Fn(&Array1<f32>, &Array1<f32>) -> f32 {}
-impl<F> DistanceMetric for F where F: Fn(&Array1<f32>, &Array1<f32>) -> f32 {}
-
-/// Return the [euclidean
-/// distance](https://en.wikipedia.org/wiki/Euclidean_distance#Higher_dimensions)
-/// between two vectors.
-pub fn euclidean_distance(a: &Array1<f32>, b: &Array1<f32>) -> f32 {
-    // Could be any square symmetric positive semi-definite matrix;
-    // just no metric learning has been done yet.
-    // See https://lelele.io/thesis.pdf chapter 4.
-    let m = Array::eye(NUMBER_FEATURES);
-
-    (a - b).dot(&m).dot(&(a - b)).sqrt()
-}
-
-/// Return the [cosine
-/// distance](https://en.wikipedia.org/wiki/Cosine_similarity#Angular_distance_and_similarity)
-/// between two vectors.
-pub fn cosine_distance(a: &Array1<f32>, b: &Array1<f32>) -> f32 {
-    let similarity = a.dot(b) / (a.dot(a).sqrt() * b.dot(b).sqrt());
-    1. - similarity
-}
-
-/// Sort `songs` in place by putting songs close to `first_song` first
-/// using the `distance` metric.
-pub fn closest_to_first_song(
-    first_song: &Song,
-    #[allow(clippy::ptr_arg)] songs: &mut Vec<Song>,
-    distance: impl DistanceMetric,
-) {
-    songs.sort_by_cached_key(|song| n32(first_song.custom_distance(song, &distance)));
-}
-
-/// Sort `songs` in place by putting songs close to `first_song` first
-/// using the `distance` metric.
-///
-/// Sort songs with a key extraction function, useful for when you have a
-/// structure like `CustomSong { bliss_song: Song, something_else: bool }`
-pub fn closest_to_first_song_by_key<F, T>(
-    first_song: &T,
-    #[allow(clippy::ptr_arg)] songs: &mut Vec<T>,
-    distance: impl DistanceMetric,
-    key_fn: F,
-) where
-    F: Fn(&T) -> Song,
-{
-    let first_song = key_fn(first_song);
-    songs.sort_by_cached_key(|song| n32(first_song.custom_distance(&key_fn(song), &distance)));
-}
-
-/// Sort `songs` in place using the `distance` metric and ordering by
-/// the smallest distance between each song.
-///
-/// If the generated playlist is `[song1, song2, song3, song4]`, it means
-/// song2 is closest to song1, song3 is closest to song2, and song4 is closest
-/// to song3.
-///
-/// Note that this has a tendency to go from one style to the other very fast,
-/// and it can be slow on big libraries.
-pub fn song_to_song(first_song: &Song, songs: &mut Vec<Song>, distance: impl DistanceMetric) {
-    let mut new_songs = Vec::with_capacity(songs.len());
-    let mut song = first_song.to_owned();
-
-    while !songs.is_empty() {
-        let distances: Array1<f32> =
-            Array::from_shape_fn(songs.len(), |i| song.custom_distance(&songs[i], &distance));
-        let idx = distances.argmin().unwrap();
-        song = songs[idx].to_owned();
-        new_songs.push(song.to_owned());
-        songs.retain(|s| s != &song);
-    }
-    *songs = new_songs;
-}
-
-/// Sort `songs` in place using the `distance` metric and ordering by
-/// the smallest distance between each song.
-///
-/// If the generated playlist is `[song1, song2, song3, song4]`, it means
-/// song2 is closest to song1, song3 is closest to song2, and song4 is closest
-/// to song3.
-///
-/// Note that this has a tendency to go from one style to the other very fast,
-/// and it can be slow on big libraries.
-///
-/// Sort songs with a key extraction function, useful for when you have a
-/// structure like `CustomSong { bliss_song: Song, something_else: bool }`
-// TODO: maybe Clone is not needed?
-pub fn song_to_song_by_key<F, T: std::cmp::PartialEq + Clone>(
-    first_song: &T,
-    songs: &mut Vec<T>,
-    distance: impl DistanceMetric,
-    key_fn: F,
-) where
-    F: Fn(&T) -> Song,
-{
-    let mut new_songs: Vec<T> = Vec::with_capacity(songs.len());
-    let mut bliss_song = key_fn(&first_song.to_owned());
-
-    while !songs.is_empty() {
-        let distances: Array1<f32> = Array::from_shape_fn(songs.len(), |i| {
-            bliss_song.custom_distance(&key_fn(&songs[i]), &distance)
-        });
-        let idx = distances.argmin().unwrap();
-        let song = songs[idx].to_owned();
-        bliss_song = key_fn(&songs[idx]).to_owned();
-        new_songs.push(song.to_owned());
-        songs.retain(|s| s != &song);
-    }
-    *songs = new_songs;
-}
-
-/// Remove duplicate songs from a playlist, in place.
-///
-/// Two songs are considered duplicates if they either have the same,
-/// non-empty title and artist name, or if they are close enough in terms
-/// of distance.
-///
-/// # Arguments
-///
-/// * `songs`: The playlist to remove duplicates from.
-/// * `distance_threshold`: The distance threshold under which two songs are
-///   considered identical. If `None`, a default value of 0.05 will be used.
-pub fn dedup_playlist(songs: &mut Vec<Song>, distance_threshold: Option<f32>) {
-    dedup_playlist_custom_distance(songs, distance_threshold, euclidean_distance);
-}
-
-/// Remove duplicate songs from a playlist, in place.
-///
-/// Two songs are considered duplicates if they either have the same,
-/// non-empty title and artist name, or if they are close enough in terms
-/// of distance.
-///
-/// Dedup songs with a key extraction function, useful for when you have a
-/// structure like `CustomSong { bliss_song: Song, something_else: bool }` you
-/// want to deduplicate.
-///
-/// # Arguments
-///
-/// * `songs`: The playlist to remove duplicates from.
-/// * `distance_threshold`: The distance threshold under which two songs are
-///   considered identical. If `None`, a default value of 0.05 will be used.
-/// * `key_fn`: A function used to retrieve the bliss [Song] from `T`.
-pub fn dedup_playlist_by_key<T, F>(songs: &mut Vec<T>, distance_threshold: Option<f32>, key_fn: F)
-where
-    F: Fn(&T) -> Song,
-{
-    dedup_playlist_custom_distance_by_key(songs, distance_threshold, euclidean_distance, key_fn);
-}
-
-/// Remove duplicate songs from a playlist, in place, using a custom distance
-/// metric.
-///
-/// Two songs are considered duplicates if they either have the same,
-/// non-empty title and artist name, or if they are close enough in terms
-/// of distance.
-///
-/// # Arguments
-///
-/// * `songs`: The playlist to remove duplicates from.
-/// * `distance_threshold`: The distance threshold under which two songs are
-///   considered identical. If `None`, a default value of 0.05 will be used.
-/// * `distance`: A custom distance metric.
-pub fn dedup_playlist_custom_distance(
-    songs: &mut Vec<Song>,
-    distance_threshold: Option<f32>,
-    distance: impl DistanceMetric,
-) {
-    songs.dedup_by(|s1, s2| {
-        n32(s1.custom_distance(s2, &distance)) < distance_threshold.unwrap_or(0.05)
-            || (s1.title.is_some()
-                && s2.title.is_some()
-                && s1.artist.is_some()
-                && s2.artist.is_some()
-                && s1.title == s2.title
-                && s1.artist == s2.artist)
-    });
-}
-
-/// Remove duplicate songs from a playlist, in place, using a custom distance
-/// metric.
-///
-/// Two songs are considered duplicates if they either have the same,
-/// non-empty title and artist name, or if they are close enough in terms
-/// of distance.
-///
-/// Dedup songs with a key extraction function, useful for when you have a
-/// structure like `CustomSong { bliss_song: Song, something_else: bool }`
-/// you want to deduplicate.
-///
-/// # Arguments
-///
-/// * `songs`: The playlist to remove duplicates from.
-/// * `distance_threshold`: The distance threshold under which two songs are
-///   considered identical. If `None`, a default value of 0.05 will be used.
-/// * `distance`: A custom distance metric.
-/// * `key_fn`: A function used to retrieve the bliss [Song] from `T`.
-pub fn dedup_playlist_custom_distance_by_key<F, T>(
-    songs: &mut Vec<T>,
-    distance_threshold: Option<f32>,
-    distance: impl DistanceMetric,
-    key_fn: F,
-) where
-    F: Fn(&T) -> Song,
-{
-    songs.dedup_by(|s1, s2| {
-        let s1 = key_fn(s1);
-        let s2 = key_fn(s2);
-        n32(s1.custom_distance(&s2, &distance)) < distance_threshold.unwrap_or(0.05)
-            || (s1.title.is_some()
-                && s2.title.is_some()
-                && s1.artist.is_some()
-                && s2.artist.is_some()
-                && s1.title == s2.title
-                && s1.artist == s2.artist)
-    });
-}
-
-/// Return a list of albums in a `pool` of songs that are similar to
-/// songs in `group`, discarding songs that don't belong to an album.
-/// It basically makes an "album" playlist from the `pool` of songs.
-///
-/// `group` should be ordered by track number.
-///
-/// Songs from `group` would usually just be songs from an album, but not
-/// necessarily - they are discarded from `pool` no matter what.
-///
-/// # Arguments
-///
-/// * `group` - A small group of songs, e.g. an album.
-/// * `pool` - A pool of songs to find similar songs in, e.g. a user's song
-/// library.
-///
-/// # Returns
-///
-/// A vector of songs, including `group` at the beginning, that you
-/// most likely want to plug in your audio player by using something like
-/// `ret.map(|song| song.path.to_owned()).collect::<Vec<String>>()`.
-pub fn closest_album_to_group(group: Vec<Song>, pool: Vec<Song>) -> BlissResult<Vec<Song>> {
-    let mut albums_analysis: HashMap<&str, Array2<f32>> = HashMap::new();
-    let mut albums = Vec::new();
-
-    // Remove songs from the group from the pool.
-    let pool = pool
-        .into_iter()
-        .filter(|s| !group.contains(s))
-        .collect::<Vec<_>>();
-    for song in &pool {
-        if let Some(album) = &song.album {
-            if let Some(analysis) = albums_analysis.get_mut(album as &str) {
-                analysis
-                    .push_row(song.analysis.as_arr1().view())
-                    .map_err(|e| {
-                        BlissError::ProviderError(format!("while computing distances: {}", e))
-                    })?;
-            } else {
-                let mut array = Array::zeros((1, song.analysis.as_arr1().len()));
-                array.assign(&song.analysis.as_arr1());
-                albums_analysis.insert(album, array);
-            }
-        }
-    }
-    let mut group_analysis = Array::zeros((group.len(), NUMBER_FEATURES));
-    for (song, mut column) in group.iter().zip(group_analysis.axis_iter_mut(Axis(0))) {
-        column.assign(&song.analysis.as_arr1());
-    }
-    let first_analysis = group_analysis
-        .mean_axis(Axis(0))
-        .ok_or_else(|| BlissError::ProviderError(String::from("Mean of empty slice")))?;
-    for (album, analysis) in albums_analysis.iter() {
-        let mean_analysis = analysis
-            .mean_axis(Axis(0))
-            .ok_or_else(|| BlissError::ProviderError(String::from("Mean of empty slice")))?;
-        let album = album.to_owned();
-        albums.push((album, mean_analysis.to_owned()));
-    }
-
-    albums.sort_by_key(|(_, analysis)| n32(euclidean_distance(&first_analysis, analysis)));
-    let mut playlist = group;
-    for (album, _) in albums {
-        let mut al = pool
-            .iter()
-            .filter(|s| s.album.is_some() && s.album.as_ref().unwrap() == &album.to_string())
-            .map(|s| s.to_owned())
-            .collect::<Vec<Song>>();
-        al.sort_by(|s1, s2| {
-            let track_number1 = s1
-                .track_number
-                .to_owned()
-                .unwrap_or_else(|| String::from(""));
-            let track_number2 = s2
-                .track_number
-                .to_owned()
-                .unwrap_or_else(|| String::from(""));
-            if let Ok(x) = track_number1.parse::<i32>() {
-                if let Ok(y) = track_number2.parse::<i32>() {
-                    return x.cmp(&y);
-                }
-            }
-            s1.track_number.cmp(&s2.track_number)
-        });
-        playlist.extend_from_slice(&al);
-    }
-    Ok(playlist)
-}
-
-/// Return a list of albums in a `pool` of songs that are similar to
-/// songs in `group`, discarding songs that don't belong to an album.
-/// It basically makes an "album" playlist from the `pool` of songs.
-///
-/// `group` should be ordered by track number.
-///
-/// Songs from `group` would usually just be songs from an album, but not
-/// necessarily - they are discarded from `pool` no matter what.
-///
-/// Order songs with a key extraction function, useful for when you have a
-/// structure like `CustomSong { bliss_song: Song, something_else: bool }`
-/// you want to order.
-///
-/// # Arguments
-///
-/// * `group` - A small group of songs, e.g. an album.
-/// * `pool` - A pool of songs to find similar songs in, e.g. a user's song
-/// library.
-/// * `key_fn`: A function used to retrieve the bliss [Song] from `T`.
-///
-/// # Returns
-///
-/// A vector of T, including `group` at the beginning, that you
-/// most likely want to plug in your audio player by using something like
-/// `ret.map(|song| song.path.to_owned()).collect::<Vec<String>>()`.
-// TODO: maybe Clone is not needed?
-pub fn closest_album_to_group_by_key<T: PartialEq + Clone, F>(
-    group: Vec<T>,
-    pool: Vec<T>,
-    key_fn: F,
-) -> BlissResult<Vec<T>>
-where
-    F: Fn(&T) -> Song,
-{
-    let mut albums_analysis: HashMap<String, Array2<f32>> = HashMap::new();
-    let mut albums = Vec::new();
-
-    // Remove songs from the group from the pool.
-    let pool = pool
-        .into_iter()
-        .filter(|s| !group.contains(s))
-        .collect::<Vec<_>>();
-    for song in &pool {
-        let song = key_fn(song);
-        if let Some(album) = song.album {
-            if let Some(analysis) = albums_analysis.get_mut(&album as &str) {
-                analysis
-                    .push_row(song.analysis.as_arr1().view())
-                    .map_err(|e| {
-                        BlissError::ProviderError(format!("while computing distances: {}", e))
-                    })?;
-            } else {
-                let mut array = Array::zeros((1, song.analysis.as_arr1().len()));
-                array.assign(&song.analysis.as_arr1());
-                albums_analysis.insert(album.to_owned(), array);
-            }
-        }
-    }
-    let mut group_analysis = Array::zeros((group.len(), NUMBER_FEATURES));
-    for (song, mut column) in group.iter().zip(group_analysis.axis_iter_mut(Axis(0))) {
-        let song = key_fn(song);
-        column.assign(&song.analysis.as_arr1());
-    }
-    let first_analysis = group_analysis
-        .mean_axis(Axis(0))
-        .ok_or_else(|| BlissError::ProviderError(String::from("Mean of empty slice")))?;
-    for (album, analysis) in albums_analysis.iter() {
-        let mean_analysis = analysis
-            .mean_axis(Axis(0))
-            .ok_or_else(|| BlissError::ProviderError(String::from("Mean of empty slice")))?;
-        let album = album.to_owned();
-        albums.push((album, mean_analysis.to_owned()));
-    }
-
-    albums.sort_by_key(|(_, analysis)| n32(euclidean_distance(&first_analysis, analysis)));
-    let mut playlist = group;
-    for (album, _) in albums {
-        let mut al = pool
-            .iter()
-            .filter(|s| {
-                let s = key_fn(s);
-                s.album.is_some() && s.album.as_ref().unwrap() == &album.to_string()
-            })
-            .map(|s| s.to_owned())
-            .collect::<Vec<T>>();
-        al.sort_by(|s1, s2| {
-            let s1 = key_fn(s1);
-            let s2 = key_fn(s2);
-            let track_number1 = s1
-                .track_number
-                .to_owned()
-                .unwrap_or_else(|| String::from(""));
-            let track_number2 = s2
-                .track_number
-                .to_owned()
-                .unwrap_or_else(|| String::from(""));
-            if let Ok(x) = track_number1.parse::<i32>() {
-                if let Ok(y) = track_number2.parse::<i32>() {
-                    return x.cmp(&y);
-                }
-            }
-            s1.track_number.cmp(&s2.track_number)
-        });
-        playlist.extend_from_slice(&al);
-    }
-    Ok(playlist)
-}
-
-#[cfg(test)]
-mod test {
-    use super::*;
-    use crate::Analysis;
-    use ndarray::arr1;
-    use std::path::Path;
-
-    #[derive(Debug, Clone, PartialEq)]
-    struct CustomSong {
-        something: bool,
-        bliss_song: Song,
-    }
-
-    #[test]
-    fn test_dedup_playlist_custom_distance() {
-        let first_song = Song {
-            path: Path::new("path-to-first").to_path_buf(),
-            analysis: Analysis::new([
-                1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-        let first_song_dupe = Song {
-            path: Path::new("path-to-dupe").to_path_buf(),
-            analysis: Analysis::new([
-                1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-
-        let second_song = Song {
-            path: Path::new("path-to-second").to_path_buf(),
-            analysis: Analysis::new([
-                2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 1.9, 1., 1., 1.,
-            ]),
-            title: Some(String::from("dupe-title")),
-            artist: Some(String::from("dupe-artist")),
-            ..Default::default()
-        };
-        let third_song = Song {
-            path: Path::new("path-to-third").to_path_buf(),
-            title: Some(String::from("dupe-title")),
-            artist: Some(String::from("dupe-artist")),
-            analysis: Analysis::new([
-                2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2.5, 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-        let fourth_song = Song {
-            path: Path::new("path-to-fourth").to_path_buf(),
-            artist: Some(String::from("no-dupe-artist")),
-            title: Some(String::from("dupe-title")),
-            analysis: Analysis::new([
-                2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 0., 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-        let fifth_song = Song {
-            path: Path::new("path-to-fourth").to_path_buf(),
-            analysis: Analysis::new([
-                2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 0.001, 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-
-        let mut playlist = vec![
-            first_song.to_owned(),
-            first_song_dupe.to_owned(),
-            second_song.to_owned(),
-            third_song.to_owned(),
-            fourth_song.to_owned(),
-            fifth_song.to_owned(),
-        ];
-        dedup_playlist_custom_distance(&mut playlist, None, euclidean_distance);
-        assert_eq!(
-            playlist,
-            vec![
-                first_song.to_owned(),
-                second_song.to_owned(),
-                fourth_song.to_owned(),
-            ],
-        );
-        let mut playlist = vec![
-            first_song.to_owned(),
-            first_song_dupe.to_owned(),
-            second_song.to_owned(),
-            third_song.to_owned(),
-            fourth_song.to_owned(),
-            fifth_song.to_owned(),
-        ];
-        dedup_playlist_custom_distance(&mut playlist, Some(20.), cosine_distance);
-        assert_eq!(playlist, vec![first_song.to_owned()]);
-        let mut playlist = vec![
-            first_song.to_owned(),
-            first_song_dupe.to_owned(),
-            second_song.to_owned(),
-            third_song.to_owned(),
-            fourth_song.to_owned(),
-            fifth_song.to_owned(),
-        ];
-        dedup_playlist(&mut playlist, Some(20.));
-        assert_eq!(playlist, vec![first_song.to_owned()]);
-        let mut playlist = vec![
-            first_song.to_owned(),
-            first_song_dupe.to_owned(),
-            second_song.to_owned(),
-            third_song.to_owned(),
-            fourth_song.to_owned(),
-            fifth_song.to_owned(),
-        ];
-        dedup_playlist(&mut playlist, None);
-        assert_eq!(
-            playlist,
-            vec![
-                first_song.to_owned(),
-                second_song.to_owned(),
-                fourth_song.to_owned(),
-            ]
-        );
-
-        let first_song = CustomSong {
-            bliss_song: first_song,
-            something: true,
-        };
-        let second_song = CustomSong {
-            bliss_song: second_song,
-            something: true,
-        };
-        let first_song_dupe = CustomSong {
-            bliss_song: first_song_dupe,
-            something: true,
-        };
-        let third_song = CustomSong {
-            bliss_song: third_song,
-            something: true,
-        };
-        let fourth_song = CustomSong {
-            bliss_song: fourth_song,
-            something: true,
-        };
-
-        let fifth_song = CustomSong {
-            bliss_song: fifth_song,
-            something: true,
-        };
-
-        let mut playlist = vec![
-            first_song.to_owned(),
-            first_song_dupe.to_owned(),
-            second_song.to_owned(),
-            third_song.to_owned(),
-            fourth_song.to_owned(),
-            fifth_song.to_owned(),
-        ];
-        dedup_playlist_custom_distance_by_key(&mut playlist, None, euclidean_distance, |s| {
-            s.bliss_song.to_owned()
-        });
-        assert_eq!(
-            playlist,
-            vec![
-                first_song.to_owned(),
-                second_song.to_owned(),
-                fourth_song.to_owned(),
-            ],
-        );
-        let mut playlist = vec![
-            first_song.to_owned(),
-            first_song_dupe.to_owned(),
-            second_song.to_owned(),
-            third_song.to_owned(),
-            fourth_song.to_owned(),
-            fifth_song.to_owned(),
-        ];
-        dedup_playlist_custom_distance_by_key(&mut playlist, Some(20.), cosine_distance, |s| {
-            s.bliss_song.to_owned()
-        });
-        assert_eq!(playlist, vec![first_song.to_owned()]);
-        let mut playlist = vec![
-            first_song.to_owned(),
-            first_song_dupe.to_owned(),
-            second_song.to_owned(),
-            third_song.to_owned(),
-            fourth_song.to_owned(),
-            fifth_song.to_owned(),
-        ];
-        dedup_playlist_by_key(&mut playlist, Some(20.), |s| s.bliss_song.to_owned());
-        assert_eq!(playlist, vec![first_song.to_owned()]);
-        let mut playlist = vec![
-            first_song.to_owned(),
-            first_song_dupe.to_owned(),
-            second_song.to_owned(),
-            third_song.to_owned(),
-            fourth_song.to_owned(),
-            fifth_song.to_owned(),
-        ];
-        dedup_playlist_by_key(&mut playlist, None, |s| s.bliss_song.to_owned());
-        assert_eq!(
-            playlist,
-            vec![
-                first_song.to_owned(),
-                second_song.to_owned(),
-                fourth_song.to_owned(),
-            ]
-        );
-    }
-
-    #[test]
-    fn test_song_to_song() {
-        let first_song = Song {
-            path: Path::new("path-to-first").to_path_buf(),
-            analysis: Analysis::new([
-                1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-        let first_song_dupe = Song {
-            path: Path::new("path-to-dupe").to_path_buf(),
-            analysis: Analysis::new([
-                1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-
-        let second_song = Song {
-            path: Path::new("path-to-second").to_path_buf(),
-            analysis: Analysis::new([
-                2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 1.9, 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-        let third_song = Song {
-            path: Path::new("path-to-third").to_path_buf(),
-            analysis: Analysis::new([
-                2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2.5, 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-        let fourth_song = Song {
-            path: Path::new("path-to-fourth").to_path_buf(),
-            analysis: Analysis::new([
-                2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 0., 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-        let mut songs = vec![
-            first_song.to_owned(),
-            third_song.to_owned(),
-            first_song_dupe.to_owned(),
-            second_song.to_owned(),
-            fourth_song.to_owned(),
-        ];
-        song_to_song(&first_song, &mut songs, euclidean_distance);
-        assert_eq!(
-            songs,
-            vec![
-                first_song.to_owned(),
-                first_song_dupe.to_owned(),
-                second_song.to_owned(),
-                third_song.to_owned(),
-                fourth_song.to_owned(),
-            ],
-        );
-
-        let first_song = CustomSong {
-            bliss_song: first_song,
-            something: true,
-        };
-        let second_song = CustomSong {
-            bliss_song: second_song,
-            something: true,
-        };
-        let first_song_dupe = CustomSong {
-            bliss_song: first_song_dupe,
-            something: true,
-        };
-        let third_song = CustomSong {
-            bliss_song: third_song,
-            something: true,
-        };
-        let fourth_song = CustomSong {
-            bliss_song: fourth_song,
-            something: true,
-        };
-
-        let mut songs: Vec<CustomSong> = vec![
-            first_song.to_owned(),
-            first_song_dupe.to_owned(),
-            third_song.to_owned(),
-            fourth_song.to_owned(),
-            second_song.to_owned(),
-        ];
-
-        song_to_song_by_key(&first_song, &mut songs, euclidean_distance, |s| {
-            s.bliss_song.to_owned()
-        });
-
-        assert_eq!(
-            songs,
-            vec![
-                first_song,
-                first_song_dupe,
-                second_song,
-                third_song,
-                fourth_song,
-            ],
-        );
-    }
-
-    #[test]
-    fn test_sort_closest_to_first_song() {
-        let first_song = Song {
-            path: Path::new("path-to-first").to_path_buf(),
-            analysis: Analysis::new([
-                1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-        let first_song_dupe = Song {
-            path: Path::new("path-to-dupe").to_path_buf(),
-            analysis: Analysis::new([
-                1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-
-        let second_song = Song {
-            path: Path::new("path-to-second").to_path_buf(),
-            analysis: Analysis::new([
-                2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 1.9, 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-        let third_song = Song {
-            path: Path::new("path-to-third").to_path_buf(),
-            analysis: Analysis::new([
-                2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2.5, 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-        let fourth_song = Song {
-            path: Path::new("path-to-fourth").to_path_buf(),
-            analysis: Analysis::new([
-                2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 0., 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-        let fifth_song = Song {
-            path: Path::new("path-to-fifth").to_path_buf(),
-            analysis: Analysis::new([
-                2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 0., 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-
-        let mut songs = vec![
-            first_song.to_owned(),
-            first_song_dupe.to_owned(),
-            second_song.to_owned(),
-            third_song.to_owned(),
-            fourth_song.to_owned(),
-            fifth_song.to_owned(),
-        ];
-        closest_to_first_song(&first_song, &mut songs, euclidean_distance);
-
-        let first_song = CustomSong {
-            bliss_song: first_song,
-            something: true,
-        };
-        let second_song = CustomSong {
-            bliss_song: second_song,
-            something: true,
-        };
-        let first_song_dupe = CustomSong {
-            bliss_song: first_song_dupe,
-            something: true,
-        };
-        let third_song = CustomSong {
-            bliss_song: third_song,
-            something: true,
-        };
-        let fourth_song = CustomSong {
-            bliss_song: fourth_song,
-            something: true,
-        };
-
-        let fifth_song = CustomSong {
-            bliss_song: fifth_song,
-            something: true,
-        };
-
-        let mut songs: Vec<CustomSong> = vec![
-            first_song.to_owned(),
-            first_song_dupe.to_owned(),
-            second_song.to_owned(),
-            third_song.to_owned(),
-            fourth_song.to_owned(),
-            fifth_song.to_owned(),
-        ];
-
-        closest_to_first_song_by_key(&first_song, &mut songs, euclidean_distance, |s| {
-            s.bliss_song.to_owned()
-        });
-
-        assert_eq!(
-            songs,
-            vec![
-                first_song,
-                first_song_dupe,
-                second_song,
-                fourth_song,
-                fifth_song,
-                third_song
-            ],
-        );
-    }
-
-    #[test]
-    fn test_euclidean_distance() {
-        let a = arr1(&[
-            1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 0.,
-        ]);
-        let b = arr1(&[
-            0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 1., 0., 0., 0.,
-        ]);
-        assert_eq!(euclidean_distance(&a, &b), 4.242640687119285);
-
-        let a = arr1(&[0.5; 20]);
-        let b = arr1(&[0.5; 20]);
-        assert_eq!(euclidean_distance(&a, &b), 0.);
-        assert_eq!(euclidean_distance(&a, &b), 0.);
-    }
-
-    #[test]
-    fn test_cosine_distance() {
-        let a = arr1(&[
-            1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 0.,
-        ]);
-        let b = arr1(&[
-            0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 1., 0., 0., 0.,
-        ]);
-        assert_eq!(cosine_distance(&a, &b), 0.7705842661294382);
-
-        let a = arr1(&[0.5; 20]);
-        let b = arr1(&[0.5; 20]);
-        assert_eq!(cosine_distance(&a, &b), 0.);
-        assert_eq!(cosine_distance(&a, &b), 0.);
-    }
-
-    #[test]
-    fn test_closest_to_group() {
-        let first_song = Song {
-            path: Path::new("path-to-first").to_path_buf(),
-            analysis: Analysis::new([0.; 20]),
-            album: Some(String::from("Album")),
-            artist: Some(String::from("Artist")),
-            track_number: Some(String::from("01")),
-            ..Default::default()
-        };
-
-        let second_song = Song {
-            path: Path::new("path-to-second").to_path_buf(),
-            analysis: Analysis::new([0.1; 20]),
-            album: Some(String::from("Another Album")),
-            artist: Some(String::from("Artist")),
-            track_number: Some(String::from("10")),
-            ..Default::default()
-        };
-
-        let third_song = Song {
-            path: Path::new("path-to-third").to_path_buf(),
-            analysis: Analysis::new([10.; 20]),
-            album: Some(String::from("Album")),
-            artist: Some(String::from("Another Artist")),
-            track_number: Some(String::from("02")),
-            ..Default::default()
-        };
-
-        let fourth_song = Song {
-            path: Path::new("path-to-fourth").to_path_buf(),
-            analysis: Analysis::new([20.; 20]),
-            album: Some(String::from("Another Album")),
-            artist: Some(String::from("Another Artist")),
-            track_number: Some(String::from("01")),
-            ..Default::default()
-        };
-        let fifth_song = Song {
-            path: Path::new("path-to-fifth").to_path_buf(),
-            analysis: Analysis::new([40.; 20]),
-            artist: Some(String::from("Third Artist")),
-            album: None,
-            ..Default::default()
-        };
-
-        let pool = vec![
-            first_song.to_owned(),
-            fourth_song.to_owned(),
-            third_song.to_owned(),
-            second_song.to_owned(),
-            fifth_song.to_owned(),
-        ];
-        let group = vec![first_song.to_owned(), third_song.to_owned()];
-        assert_eq!(
-            vec![
-                first_song.to_owned(),
-                third_song.to_owned(),
-                fourth_song.to_owned(),
-                second_song.to_owned()
-            ],
-            closest_album_to_group(group, pool.to_owned()).unwrap(),
-        );
-
-        let first_song = CustomSong {
-            bliss_song: first_song,
-            something: true,
-        };
-        let second_song = CustomSong {
-            bliss_song: second_song,
-            something: true,
-        };
-        let third_song = CustomSong {
-            bliss_song: third_song,
-            something: true,
-        };
-        let fourth_song = CustomSong {
-            bliss_song: fourth_song,
-            something: true,
-        };
-
-        let fifth_song = CustomSong {
-            bliss_song: fifth_song,
-            something: true,
-        };
-
-        let pool = vec![
-            first_song.to_owned(),
-            fourth_song.to_owned(),
-            third_song.to_owned(),
-            second_song.to_owned(),
-            fifth_song.to_owned(),
-        ];
-        let group = vec![first_song.to_owned(), third_song.to_owned()];
-        assert_eq!(
-            vec![
-                first_song.to_owned(),
-                third_song.to_owned(),
-                fourth_song.to_owned(),
-                second_song.to_owned()
-            ],
-            closest_album_to_group_by_key(group, pool.to_owned(), |s| s.bliss_song.to_owned())
-                .unwrap(),
-        );
-    }
-}

src/song.rs

@@ -7,24 +7,17 @@
 //! For implementation of plug-ins for already existing audio players,
 //! a look at Library is instead recommended.
 
-extern crate crossbeam;
 extern crate ffmpeg_next as ffmpeg;
 extern crate ndarray;
-extern crate ndarray_npy;
 
 use crate::chroma::ChromaDesc;
-use crate::cue::CueInfo;
 use crate::misc::LoudnessDesc;
-#[cfg(doc)]
-use crate::playlist;
-use crate::playlist::{closest_to_first_song, dedup_playlist, euclidean_distance, DistanceMetric};
 use crate::temporal::BPMDesc;
 use crate::timbral::{SpectralDesc, ZeroCrossingRateDesc};
-use crate::{BlissError, BlissResult, SAMPLE_RATE};
-use crate::{CHANNELS, FEATURES_VERSION};
+use crate::bliss_lib::{BlissError, BlissResult, SAMPLE_RATE};
+use crate::bliss_lib::{CHANNELS, FEATURES_VERSION};
 use ::log::warn;
 use core::ops::Index;
-use crossbeam::thread;
 use ffmpeg_next::codec::threading::{Config, Type as ThreadingType};
 use ffmpeg_next::util::channel_layout::ChannelLayout;
 use ffmpeg_next::util::error::Error;
@@ -38,11 +31,9 @@ use ndarray::{arr1, Array1};
 use std::convert::TryInto;
 use std::fmt;
 use std::path::Path;
-use std::path::PathBuf;
 use std::sync::mpsc;
 use std::sync::mpsc::Receiver;
-use std::thread as std_thread;
-use std::time::Duration;
+use std::thread;
 use strum::{EnumCount, IntoEnumIterator};
 use strum_macros::{EnumCount, EnumIter};
 
@@ -51,35 +42,12 @@ use strum_macros::{EnumCount, EnumIter};
 /// Simple object used to represent a Song, with its path, analysis, and
 /// other metadata (artist, genre...)
 pub struct Song {
-    /// Song's provided file path
-    pub path: PathBuf,
-    /// Song's artist, read from the metadata
-    pub artist: Option<String>,
-    /// Song's title, read from the metadata
-    pub title: Option<String>,
-    /// Song's album name, read from the metadata
-    pub album: Option<String>,
-    /// Song's album's artist name, read from the metadata
-    pub album_artist: Option<String>,
-    /// Song's tracked number, read from the metadata
-    /// TODO normalize this into an integer
-    pub track_number: Option<String>,
-    /// Song's genre, read from the metadata (`""` if empty)
-    pub genre: Option<String>,
     /// bliss analysis results
     pub analysis: Analysis,
-    /// The song's duration
-    pub duration: Duration,
     /// Version of the features the song was analyzed with.
     /// A simple integer that is bumped every time a breaking change
     /// is introduced in the features.
     pub features_version: u16,
-    /// Populated only if the song was extracted from a larger audio file,
-    /// through the use of a CUE sheet.
-    /// By default, such a song's path would be
-    /// `path/to/cue_file.wav/CUE_TRACK00<track_number>`. Using this field,
-    /// you can change `song.path` to fit your needs.
-    pub cue_info: Option<CueInfo>,
 }
 
 #[derive(Debug, EnumIter, EnumCount)]
@@ -158,7 +126,7 @@ impl fmt::Debug for Analysis {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let mut debug_struct = f.debug_struct("Analysis");
         for feature in AnalysisIndex::iter() {
-            debug_struct.field(&format!("{:?}", feature), &self[feature]);
+            debug_struct.field(&format!("{feature:?}"), &self[feature]);
         }
         debug_struct.finish()?;
         f.write_str(&format!(" /* {:?} */", &self.as_vec()))
@@ -192,95 +160,36 @@ impl Analysis {
         self.internal_analysis.to_vec()
     }
 
-    /// Compute distance between two analysis using a user-provided distance
-    /// metric. You most likely want to use `song.custom_distance` directly
-    /// rather than this function.
-    ///
-    /// For this function to be integrated properly with the rest
-    /// of bliss' parts, it should be a valid distance metric, i.e.:
-    /// 1. For X, Y real vectors, d(X, Y) = 0 ⇔ X = Y
-    /// 2. For X, Y real vectors, d(X, Y) >= 0
-    /// 3. For X, Y real vectors, d(X, Y) = d(Y, X)
-    /// 4. For X, Y, Z real vectors d(X, Y) ≤ d(X + Z) + d(Z, Y)
-    ///
-    /// Note that almost all distance metrics you will find obey these
-    /// properties, so don't sweat it too much.
-    pub fn custom_distance(&self, other: &Self, distance: impl DistanceMetric) -> f32 {
-        distance(&self.as_arr1(), &other.as_arr1())
+    /// Returns a little endian byte array representing the analysis' features.
+    pub fn as_bytes(&self) -> [u8; 80] {
+        let mut result = [0; 80];
+        for (i, float) in self.internal_analysis.iter().enumerate() {
+            let [a, b, c, d] = float.to_le_bytes();
+            result[4*i] = a;
+            result[4*i + 1] = b;
+            result[4*i + 2] = c;
+            result[4*i + 3] = d;
+        }
+        result
+    }
+
+    /// Creates an Analysis object from a little endian byte array
+    pub fn from_bytes(bytes: &[u8]) -> Option<Self> {
+        let floats = bytes
+            .chunks(4)
+            .map(|chunk| f32::from_le_bytes([chunk[0], chunk[1], chunk[2], chunk[3]]))
+            .collect::<Vec<_>>();
+        if floats.len() != NUMBER_FEATURES {
+            return None;
+        }
+        match floats.try_into() {
+            Ok(arr) => Some(Analysis { internal_analysis: arr }),
+            Err(_) => None,
+        }
     }
 }
 
 impl Song {
-    #[allow(dead_code)]
-    /// Compute the distance between the current song and any given
-    /// Song.
-    ///
-    /// The smaller the number, the closer the songs; usually more useful
-    /// if compared between several songs
-    /// (e.g. if song1.distance(song2) < song1.distance(song3), then song1 is
-    /// closer to song2 than it is to song3.
-    ///
-    /// Currently uses the euclidean distance, but this can change in an
-    /// upcoming release if another metric performs better.
-    pub fn distance(&self, other: &Self) -> f32 {
-        self.analysis
-            .custom_distance(&other.analysis, euclidean_distance)
-    }
-
-    /// Compute distance between two songs using a user-provided distance
-    /// metric.
-    ///
-    /// For this function to be integrated properly with the rest
-    /// of bliss' parts, it should be a valid distance metric, i.e.:
-    /// 1. For X, Y real vectors, d(X, Y) = 0 ⇔ X = Y
-    /// 2. For X, Y real vectors, d(X, Y) >= 0
-    /// 3. For X, Y real vectors, d(X, Y) = d(Y, X)
-    /// 4. For X, Y, Z real vectors d(X, Y) ≤ d(X + Z) + d(Z, Y)
-    ///
-    /// Note that almost all distance metrics you will find obey these
-    /// properties, so don't sweat it too much.
-    pub fn custom_distance(&self, other: &Self, distance: impl DistanceMetric) -> f32 {
-        self.analysis.custom_distance(&other.analysis, distance)
-    }
-
-    /// Orders songs in `pool` by proximity to `self`, using the distance
-    /// metric `distance` to compute the order.
-    /// Basically return a playlist from songs in `pool`, starting
-    /// from `self`, using `distance` (some distance metrics can
-    /// be found in the [playlist] module).
-    ///
-    /// Note that contrary to [Song::closest_from_pool], `self` is NOT added
-    /// to the beginning of the returned vector.
-    ///
-    /// No deduplication is ran either; if you're looking for something easy
-    /// that works "out of the box", use [Song::closest_from_pool].
-    pub fn closest_from_pool_custom(
-        &self,
-        pool: Vec<Self>,
-        distance: impl DistanceMetric,
-    ) -> Vec<Self> {
-        let mut pool = pool;
-        closest_to_first_song(self, &mut pool, distance);
-        pool
-    }
-
-    /// Order songs in `pool` by proximity to `self`.
-    /// Convenience method to return a playlist from songs in `pool`,
-    /// starting from `self`.
-    ///
-    /// The distance is already chosen, deduplication is ran, and the first song
-    /// is added to the top of the playlist, to make everything easier.
-    ///
-    /// If you want more control over which distance metric is chosen,
-    /// run deduplication manually, etc, use [Song::closest_from_pool_custom].
-    pub fn closest_from_pool(&self, pool: Vec<Self>) -> Vec<Self> {
-        let mut playlist = vec![self.to_owned()];
-        playlist.extend_from_slice(&pool);
-        closest_to_first_song(self, &mut playlist, euclidean_distance);
-        dedup_playlist(&mut playlist, None);
-        playlist
-    }
-
     /// Returns a decoded [Song] given a file path, or an error if the song
     /// could not be analyzed for some reason.
     ///
@@ -298,25 +207,20 @@ impl Song {
     /// decoding ([DecodingError](BlissError::DecodingError)) or an analysis
     /// ([AnalysisError](BlissError::AnalysisError)) error.
     pub fn from_path<P: AsRef<Path>>(path: P) -> BlissResult<Self> {
-        let raw_song = Song::decode(path.as_ref())?;
+        let samples = Song::decode(path.as_ref())?;
 
         Ok(Song {
-            path: raw_song.path,
-            artist: raw_song.artist,
-            album_artist: raw_song.album_artist,
-            title: raw_song.title,
-            album: raw_song.album,
-            track_number: raw_song.track_number,
-            genre: raw_song.genre,
-            duration: raw_song.duration,
-            analysis: Song::analyze(&raw_song.sample_array)?,
+            analysis: Song::analyze(&samples)?,
             features_version: FEATURES_VERSION,
-            cue_info: None,
         })
     }
 
     /**
-     * Analyze a song decoded in `sample_array`, with one channel @ 22050 Hz.
+     * Analyze a song decoded in `sample_array`. This function should NOT
+     * be used manually, unless you want to explore analyzing a sample array you
+     * already decoded yourself. Most people will want to use
+     * [Song::from_path](Song::from_path) instead to just analyze a file from
+     * its path.
      *
      * The current implementation doesn't make use of it,
      * but the song can also be streamed wrt.
@@ -325,8 +229,21 @@ impl Song {
      *
      * Useful in the rare cases where the full song is not
      * completely available.
+     *
+     * If you *do* want to use this with a song already decoded by yourself,
+     * the sample format of `sample_array` should be f32le, one channel, and
+     * the sampling rate 22050 Hz. Anything other than that will yield aberrant
+     * results.
+     * To double-check that your sample array has the right format, you could run
+     * `ffmpeg -i path_to_your_song.flac -ar 22050 -ac 1 -c:a pcm_f32le -f hash -hash addler32 -`,
+     * which will give you the addler32 checksum of the sample array if the song
+     * has been decoded properly. You can then compute the addler32 checksum of your sample
+     * array (see `_test_decode` in the tests) and make sure both are the same.
+     *
+     * (Running `ffmpeg -i path_to_your_song.flac -ar 22050 -ac 1 -c:a pcm_f32le` will simply give
+     * you the raw sample array as it should look like, if you're not into computing checksums)
      **/
-    pub(crate) fn analyze(sample_array: &[f32]) -> BlissResult<Analysis> {
+    pub fn analyze(sample_array: &[f32]) -> BlissResult<Analysis> {
         let largest_window = vec![
             BPMDesc::WINDOW_SIZE,
             ChromaDesc::WINDOW_SIZE,
@@ -342,8 +259,8 @@ impl Song {
             )));
         }
 
-        thread::scope(|s| {
-            let child_tempo: thread::ScopedJoinHandle<'_, BlissResult<f32>> = s.spawn(|_| {
+        thread::scope(|s| -> BlissResult<Analysis> {
+            let child_tempo = s.spawn(|| {
                 let mut tempo_desc = BPMDesc::new(SAMPLE_RATE)?;
                 let windows = sample_array
                     .windows(BPMDesc::WINDOW_SIZE)
@@ -355,17 +272,14 @@ impl Song {
                 Ok(tempo_desc.get_value())
             });
 
-            let child_chroma: thread::ScopedJoinHandle<'_, BlissResult<Vec<f32>>> = s.spawn(|_| {
+            let child_chroma = s.spawn(|| {
                 let mut chroma_desc = ChromaDesc::new(SAMPLE_RATE, 12);
                 chroma_desc.do_(sample_array)?;
                 Ok(chroma_desc.get_values())
             });
 
             #[allow(clippy::type_complexity)]
-            let child_timbral: thread::ScopedJoinHandle<
-                '_,
-                BlissResult<(Vec<f32>, Vec<f32>, Vec<f32>)>,
-            > = s.spawn(|_| {
+            let child_timbral = s.spawn(|| {
                 let mut spectral_desc = SpectralDesc::new(SAMPLE_RATE)?;
                 let windows = sample_array
                     .windows(SpectralDesc::WINDOW_SIZE)
@@ -379,22 +293,21 @@ impl Song {
                 Ok((centroid, rolloff, flatness))
             });
 
-            let child_zcr: thread::ScopedJoinHandle<'_, BlissResult<f32>> = s.spawn(|_| {
+            let child_zcr = s.spawn(|| {
                 let mut zcr_desc = ZeroCrossingRateDesc::default();
                 zcr_desc.do_(sample_array);
                 Ok(zcr_desc.get_value())
             });
 
-            let child_loudness: thread::ScopedJoinHandle<'_, BlissResult<Vec<f32>>> =
-                s.spawn(|_| {
-                    let mut loudness_desc = LoudnessDesc::default();
-                    let windows = sample_array.chunks(LoudnessDesc::WINDOW_SIZE);
+            let child_loudness = s.spawn(|| {
+                let mut loudness_desc = LoudnessDesc::default();
+                let windows = sample_array.chunks(LoudnessDesc::WINDOW_SIZE);
 
-                    for window in windows {
-                        loudness_desc.do_(window);
-                    }
-                    Ok(loudness_desc.get_value())
-                });
+                for window in windows {
+                    loudness_desc.do_(window);
+                }
+                Ok(loudness_desc.get_value())
+            });
 
             // Non-streaming approach for that one
             let tempo = child_tempo.join().unwrap()?;
@@ -418,10 +331,9 @@ impl Song {
             })?;
             Ok(Analysis::new(array))
         })
-        .unwrap()
     }
 
-    pub(crate) fn decode(path: &Path) -> BlissResult<InternalSong> {
+    pub(crate) fn decode(path: &Path) -> BlissResult<Vec<f32>> {
         ffmpeg::init().map_err(|e| {
             BlissError::DecodingError(format!(
                 "ffmpeg init error while decoding file '{}': {:?}.",
@@ -430,10 +342,7 @@ impl Song {
             ))
         })?;
         log::set_level(Level::Quiet);
-        let mut song = InternalSong {
-            path: path.into(),
-            ..Default::default()
-        };
+
         let mut ictx = ffmpeg::format::input(&path).map_err(|e| {
             BlissError::DecodingError(format!(
                 "while opening format for file '{}': {:?}.",
@@ -459,7 +368,7 @@ impl Song {
             context.set_threading(Config {
                 kind: ThreadingType::Frame,
                 count: 0,
-                safe: true,
+                // safe: true,
             });
             let decoder = context.decoder().audio().map_err(|e| {
                 BlissError::DecodingError(format!(
@@ -483,47 +392,12 @@ impl Song {
             (decoder, input.index(), expected_sample_number)
         };
         let sample_array: Vec<f32> = Vec::with_capacity(expected_sample_number as usize);
-        if let Some(title) = ictx.metadata().get("title") {
-            song.title = match title {
-                "" => None,
-                t => Some(t.to_string()),
-            };
-        };
-        if let Some(artist) = ictx.metadata().get("artist") {
-            song.artist = match artist {
-                "" => None,
-                a => Some(a.to_string()),
-            };
-        };
-        if let Some(album) = ictx.metadata().get("album") {
-            song.album = match album {
-                "" => None,
-                a => Some(a.to_string()),
-            };
-        };
-        if let Some(genre) = ictx.metadata().get("genre") {
-            song.genre = match genre {
-                "" => None,
-                g => Some(g.to_string()),
-            };
-        };
-        if let Some(track_number) = ictx.metadata().get("track") {
-            song.track_number = match track_number {
-                "" => None,
-                t => Some(t.to_string()),
-            };
-        };
-        if let Some(album_artist) = ictx.metadata().get("album_artist") {
-            song.album_artist = match album_artist {
-                "" => None,
-                t => Some(t.to_string()),
-            };
-        };
-        let in_channel_layout = {
+
+        let (empty_in_channel_layout, in_channel_layout) = {
             if decoder.channel_layout() == ChannelLayout::empty() {
-                ChannelLayout::default(decoder.channels().into())
+                (true, ChannelLayout::default(decoder.channels().into()))
             } else {
-                decoder.channel_layout()
+                (false, decoder.channel_layout())
             }
         };
         decoder.set_channel_layout(in_channel_layout);
@@ -531,13 +405,14 @@ impl Song {
         let (tx, rx) = mpsc::channel();
         let in_codec_format = decoder.format();
         let in_codec_rate = decoder.rate();
-        let child = std_thread::spawn(move || {
+        let child = thread::spawn(move || {
             resample_frame(
                 rx,
                 in_codec_format,
                 in_channel_layout,
                 in_codec_rate,
                 sample_array,
+                empty_in_channel_layout,
             )
         });
         for (s, packet) in ictx.packets() {
@@ -558,8 +433,7 @@ impl Song {
                         path.display()
                     );
                     drop(tx);
-                    song.sample_array = child.join().unwrap()?;
-                    return Ok(song);
+                    return Ok(child.join().unwrap()?);
                 }
                 Err(e) => warn!("error while decoding file '{}': {}", path.display(), e),
             };
@@ -597,8 +471,7 @@ impl Song {
                     path.display()
                 );
                 drop(tx);
-                song.sample_array = child.join().unwrap()?;
-                return Ok(song);
+                return Ok(child.join().unwrap()?);
             }
             Err(e) => warn!("error while decoding {}: {}", path.display(), e),
         };
@@ -620,32 +493,17 @@ impl Song {
         }
 
         drop(tx);
-        song.sample_array = child.join().unwrap()?;
-        let duration_seconds = song.sample_array.len() as f32 / SAMPLE_RATE as f32;
-        song.duration = Duration::from_nanos((duration_seconds * 1e9_f32).round() as u64);
-        Ok(song)
+        Ok(child.join().unwrap()?)
     }
 }
 
-#[derive(Default, Debug)]
-pub(crate) struct InternalSong {
-    pub path: PathBuf,
-    pub artist: Option<String>,
-    pub album_artist: Option<String>,
-    pub title: Option<String>,
-    pub album: Option<String>,
-    pub track_number: Option<String>,
-    pub genre: Option<String>,
-    pub duration: Duration,
-    pub sample_array: Vec<f32>,
-}
-
 fn resample_frame(
     rx: Receiver<Audio>,
     in_codec_format: Sample,
     in_channel_layout: ChannelLayout,
     in_rate: u32,
     mut sample_array: Vec<f32>,
+    empty_in_channel_layout: bool,
 ) -> BlissResult<Vec<f32>> {
     let mut resample_context = ffmpeg::software::resampling::context::Context::get(
         in_codec_format,
@@ -657,19 +515,20 @@ fn resample_frame(
     )
     .map_err(|e| {
         BlissError::DecodingError(format!(
-            "while trying to allocate resampling context: {:?}",
-            e
+            "while trying to allocate resampling context: {e:?}",
         ))
     })?;
+
     let mut resampled = ffmpeg::frame::Audio::empty();
     let mut something_happened = false;
-    for decoded in rx.iter() {
-        if in_codec_format != decoded.format()
+    for mut decoded in rx.iter() {
+        // If the decoded layout is empty, it means we forced the
+        // "in_channel_layout" to something default, not that
+        // the format is wrong.
+        if empty_in_channel_layout && decoded.channel_layout() == ChannelLayout::empty() {
+            decoded.set_channel_layout(in_channel_layout);
+        } else if in_codec_format != decoded.format()
             || (in_channel_layout != decoded.channel_layout())
-                // If the decoded layout is empty, it means we forced the
-                // "in_channel_layout" to something default, not that
-                // the format is wrong.
-                && (decoded.channel_layout() != ChannelLayout::empty())
             || in_rate != decoded.rate()
         {
             warn!("received decoded packet with wrong format; file might be corrupted.");
@@ -680,7 +539,7 @@ fn resample_frame(
         resample_context
             .run(&decoded, &mut resampled)
             .map_err(|e| {
-                BlissError::DecodingError(format!("while trying to resample song: {:?}", e))
+                BlissError::DecodingError(format!("while trying to resample song: {e:?}"))
             })?;
         push_to_sample_array(&resampled, &mut sample_array);
     }
@@ -691,7 +550,7 @@ fn resample_frame(
     // `resampled` again?
     loop {
         match resample_context.flush(&mut resampled).map_err(|e| {
-            BlissError::DecodingError(format!("while trying to resample song: {:?}", e))
+            BlissError::DecodingError(format!("while trying to resample song: {e:?}"))
         })? {
             Some(_) => {
                 push_to_sample_array(&resampled, &mut sample_array);
@@ -732,8 +591,8 @@ fn push_to_sample_array(frame: &ffmpeg::frame::Audio, sample_array: &mut Vec<f32
 #[cfg(test)]
 mod tests {
     use super::*;
+    use adler32::RollingAdler32;
     use pretty_assertions::assert_eq;
-    use ripemd160::{Digest, Ripemd160};
     use std::path::Path;
 
     #[test]
@@ -782,61 +641,28 @@ mod tests {
         assert_eq!(FEATURES_VERSION, song.features_version);
     }
 
-    fn _test_decode(path: &Path, expected_hash: &[u8]) {
-        let song = Song::decode(path).unwrap();
-        let mut hasher = Ripemd160::new();
-        for sample in song.sample_array.iter() {
-            hasher.update(sample.to_le_bytes().to_vec());
+    fn _test_decode(path: &Path, expected_hash: u32) {
+        let samples = Song::decode(path).unwrap();
+        let mut hasher = RollingAdler32::new();
+        for sample in samples.iter() {
+            hasher.update_buffer(&sample.to_le_bytes());
         }
 
-        assert_eq!(expected_hash, hasher.finalize().as_slice());
-    }
-
-    #[test]
-    fn test_tags() {
-        let song = Song::decode(Path::new("data/s16_mono_22_5kHz.flac")).unwrap();
-        assert_eq!(song.artist, Some(String::from("David TMX")));
-        assert_eq!(
-            song.album_artist,
-            Some(String::from("David TMX - Album Artist"))
-        );
-        assert_eq!(song.title, Some(String::from("Renaissance")));
-        assert_eq!(song.album, Some(String::from("Renaissance")));
-        assert_eq!(song.track_number, Some(String::from("02")));
-        assert_eq!(song.genre, Some(String::from("Pop")));
-        // Test that there is less than 10ms of difference between what
-        // the song advertises and what we compute.
-        assert!((song.duration.as_millis() as f32 - 11070.).abs() < 10.);
-    }
-
-    #[test]
-    fn test_empty_tags() {
-        let song = Song::decode(Path::new("data/no_tags.flac")).unwrap();
-        assert_eq!(song.artist, None);
-        assert_eq!(song.title, None);
-        assert_eq!(song.album, None);
-        assert_eq!(song.track_number, None);
-        assert_eq!(song.genre, None);
+        assert_eq!(expected_hash, hasher.hash());
     }
 
     #[test]
     fn test_resample_multi() {
         let path = Path::new("data/s32_stereo_44_1_kHz.flac");
-        let expected_hash = [
-            0xc5, 0xf8, 0x23, 0xce, 0x63, 0x2c, 0xf4, 0xa0, 0x72, 0x66, 0xbb, 0x49, 0xad, 0x84,
-            0xb6, 0xea, 0x48, 0x48, 0x9c, 0x50,
-        ];
-        _test_decode(&path, &expected_hash);
+        let expected_hash = 0xbbcba1cf;
+        _test_decode(&path, expected_hash);
     }
 
     #[test]
     fn test_resample_stereo() {
         let path = Path::new("data/s16_stereo_22_5kHz.flac");
-        let expected_hash = [
-            0x24, 0xed, 0x45, 0x58, 0x06, 0xbf, 0xfb, 0x05, 0x57, 0x5f, 0xdc, 0x4d, 0xb4, 0x9b,
-            0xa5, 0x2b, 0x05, 0x56, 0x10, 0x4f,
-        ];
-        _test_decode(&path, &expected_hash);
+        let expected_hash = 0x1d7b2d6d;
+        _test_decode(&path, expected_hash);
     }
 
     #[test]
@@ -844,12 +670,9 @@ mod tests {
         let path = Path::new("data/s16_mono_22_5kHz.flac");
         // Obtained through
         // ffmpeg -i data/s16_mono_22_5kHz.flac -ar 22050 -ac 1 -c:a pcm_f32le
-        // -f hash -hash ripemd160 -
-        let expected_hash = [
-            0x9d, 0x95, 0xa5, 0xf2, 0xd2, 0x9c, 0x68, 0xe8, 0x8a, 0x70, 0xcd, 0xf3, 0x54, 0x2c,
-            0x5b, 0x45, 0x98, 0xb4, 0xf3, 0xb4,
-        ];
-        _test_decode(&path, &expected_hash);
+        // -f hash -hash addler32 -
+        let expected_hash = 0x5e01930b;
+        _test_decode(&path, expected_hash);
     }
 
     #[test]
@@ -857,12 +680,9 @@ mod tests {
         let path = Path::new("data/s32_stereo_44_1_kHz.mp3");
         // Obtained through
         // ffmpeg -i data/s16_mono_22_5kHz.mp3 -ar 22050 -ac 1 -c:a pcm_f32le
-        // -f hash -hash ripemd160 -
-        let expected_hash = [
-            0x28, 0x25, 0x6b, 0x7b, 0x6e, 0x37, 0x1c, 0xcf, 0xc7, 0x06, 0xdf, 0x62, 0x8c, 0x0e,
-            0x91, 0xf7, 0xd6, 0x1f, 0xac, 0x5b,
-        ];
-        _test_decode(&path, &expected_hash);
+        // -f hash -hash addler32 -
+        let expected_hash = 0x69ca6906;
+        _test_decode(&path, expected_hash);
     }
 
     #[test]
@@ -874,54 +694,23 @@ mod tests {
     #[test]
     fn test_decode_right_capacity_vec() {
         let path = Path::new("data/s16_mono_22_5kHz.flac");
-        let song = Song::decode(&path).unwrap();
-        let sample_array = song.sample_array;
+        let samples = Song::decode(&path).unwrap();
         assert_eq!(
-            sample_array.len() + SAMPLE_RATE as usize,
-            sample_array.capacity()
+            samples.len() + SAMPLE_RATE as usize,
+            samples.capacity()
         );
 
         let path = Path::new("data/s32_stereo_44_1_kHz.flac");
-        let song = Song::decode(&path).unwrap();
-        let sample_array = song.sample_array;
+        let samples = Song::decode(&path).unwrap();
         assert_eq!(
-            sample_array.len() + SAMPLE_RATE as usize,
-            sample_array.capacity()
+            samples.len() + SAMPLE_RATE as usize,
+            samples.capacity()
         );
 
         let path = Path::new("data/capacity_fix.ogg");
-        let song = Song::decode(&path).unwrap();
-        let sample_array = song.sample_array;
-        assert!(sample_array.len() as f32 / sample_array.capacity() as f32 > 0.90);
-        assert!(sample_array.len() as f32 / (sample_array.capacity() as f32) < 1.);
-    }
-
-    #[test]
-    fn test_analysis_distance() {
-        let mut a = Song::default();
-        a.analysis = Analysis::new([
-            0.16391512, 0.11326739, 0.96868552, 0.8353934, 0.49867523, 0.76532606, 0.63448005,
-            0.82506196, 0.71457147, 0.62395476, 0.69680329, 0.9855766, 0.41369333, 0.13900452,
-            0.68001012, 0.11029723, 0.97192943, 0.57727861, 0.07994821, 0.88993185,
-        ]);
-
-        let mut b = Song::default();
-        b.analysis = Analysis::new([
-            0.5075758, 0.36440256, 0.28888011, 0.43032829, 0.62387977, 0.61894916, 0.99676086,
-            0.11913155, 0.00640396, 0.15943407, 0.33829514, 0.34947174, 0.82927523, 0.18987604,
-            0.54437275, 0.22076826, 0.91232151, 0.29233168, 0.32846024, 0.04522147,
-        ]);
-        assert_eq!(a.distance(&b), 1.9469079)
-    }
-
-    #[test]
-    fn test_analysis_distance_indiscernible() {
-        let mut a = Song::default();
-        a.analysis = Analysis::new([
-            1., 2., 3., 4., 5., 6., 7., 8., 9., 10., 11., 12., 13., 14., 15., 16., 17., 18., 19.,
-            20.,
-        ]);
-        assert_eq!(a.distance(&a), 0.)
+        let samples = Song::decode(&path).unwrap();
+        assert!(samples.len() as f32 / samples.capacity() as f32 > 0.90);
+        assert!(samples.len() as f32 / (samples.capacity() as f32) < 1.);
     }
 
     #[test]
@@ -949,11 +738,8 @@ mod tests {
 
     #[test]
     fn test_decode_wav() {
-        let expected_hash = [
-            0xf0, 0xe0, 0x85, 0x4e, 0xf6, 0x53, 0x76, 0xfa, 0x7a, 0xa5, 0x65, 0x76, 0xf9, 0xe1,
-            0xe8, 0xe0, 0x81, 0xc8, 0xdc, 0x61,
-        ];
-        _test_decode(Path::new("data/piano.wav"), &expected_hash);
+        let expected_hash = 0xde831e82;
+        _test_decode(Path::new("data/piano.wav"), expected_hash);
     }
 
     #[test]
@@ -975,120 +761,4 @@ mod tests {
             format!("{:?}", song.analysis),
         );
     }
-
-    fn dummy_distance(_: &Array1<f32>, _: &Array1<f32>) -> f32 {
-        0.
-    }
-
-    #[test]
-    fn test_custom_distance() {
-        let mut a = Song::default();
-        a.analysis = Analysis::new([
-            0.16391512, 0.11326739, 0.96868552, 0.8353934, 0.49867523, 0.76532606, 0.63448005,
-            0.82506196, 0.71457147, 0.62395476, 0.69680329, 0.9855766, 0.41369333, 0.13900452,
-            0.68001012, 0.11029723, 0.97192943, 0.57727861, 0.07994821, 0.88993185,
-        ]);
-
-        let mut b = Song::default();
-        b.analysis = Analysis::new([
-            0.5075758, 0.36440256, 0.28888011, 0.43032829, 0.62387977, 0.61894916, 0.99676086,
-            0.11913155, 0.00640396, 0.15943407, 0.33829514, 0.34947174, 0.82927523, 0.18987604,
-            0.54437275, 0.22076826, 0.91232151, 0.29233168, 0.32846024, 0.04522147,
-        ]);
-        assert_eq!(a.custom_distance(&b, dummy_distance), 0.);
-    }
-
-    #[test]
-    fn test_closest_from_pool() {
-        let song = Song {
-            path: Path::new("path-to-first").to_path_buf(),
-            analysis: Analysis::new([
-                1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-        let first_song_dupe = Song {
-            path: Path::new("path-to-dupe").to_path_buf(),
-            analysis: Analysis::new([
-                1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-
-        let second_song = Song {
-            path: Path::new("path-to-second").to_path_buf(),
-            analysis: Analysis::new([
-                2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 1.9, 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-        let third_song = Song {
-            path: Path::new("path-to-third").to_path_buf(),
-            analysis: Analysis::new([
-                2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2.5, 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-        let fourth_song = Song {
-            path: Path::new("path-to-fourth").to_path_buf(),
-            analysis: Analysis::new([
-                2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 0., 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-        let fifth_song = Song {
-            path: Path::new("path-to-fifth").to_path_buf(),
-            analysis: Analysis::new([
-                2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 2., 0., 1., 1., 1.,
-            ]),
-            ..Default::default()
-        };
-
-        let songs = vec![
-            song.to_owned(),
-            first_song_dupe.to_owned(),
-            second_song.to_owned(),
-            third_song.to_owned(),
-            fourth_song.to_owned(),
-            fifth_song.to_owned(),
-        ];
-        let playlist = song.closest_from_pool(songs.to_owned());
-        assert_eq!(
-            playlist,
-            vec![
-                song.to_owned(),
-                second_song.to_owned(),
-                fourth_song.to_owned(),
-                third_song.to_owned(),
-            ],
-        );
-        let playlist = song.closest_from_pool_custom(songs, euclidean_distance);
-        assert_eq!(
-            playlist,
-            vec![
-                song,
-                first_song_dupe,
-                second_song,
-                fourth_song,
-                fifth_song,
-                third_song
-            ],
-        );
-    }
-}
-
-#[cfg(all(feature = "bench", test))]
-mod bench {
-    extern crate test;
-    use crate::Song;
-    use std::path::Path;
-    use test::Bencher;
-
-    #[bench]
-    fn bench_resample_multi(b: &mut Bencher) {
-        let path = Path::new("./data/s32_stereo_44_1_kHz.flac");
-        b.iter(|| {
-            Song::decode(&path).unwrap();
-        });
-    }
 }

src/temporal.rs

@@ -4,7 +4,7 @@
 //! of a given Song.
 
 use crate::utils::Normalize;
-use crate::{BlissError, BlissResult};
+use crate::bliss_lib::{BlissError, BlissResult};
 use bliss_audio_aubio_rs::{OnsetMode, Tempo};
 use log::warn;
 use ndarray::arr1;
@@ -48,7 +48,7 @@ impl BPMDesc {
                 sample_rate,
             )
             .map_err(|e| {
-                BlissError::AnalysisError(format!("error while loading aubio tempo object: {}", e))
+                BlissError::AnalysisError(format!("error while loading aubio tempo object: {e}"))
             })?,
             bpms: Vec::new(),
         })
@@ -56,7 +56,7 @@ impl BPMDesc {
 
     pub fn do_(&mut self, chunk: &[f32]) -> BlissResult<()> {
         let result = self.aubio_obj.do_result(chunk).map_err(|e| {
-            BlissError::AnalysisError(format!("aubio error while computing tempo {}", e))
+            BlissError::AnalysisError(format!("aubio error while computing tempo {e}"))
         })?;
 
         if result > 0. {
@@ -94,14 +94,14 @@ impl Normalize for BPMDesc {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::{Song, SAMPLE_RATE};
+    use crate::bliss_lib::{Song, SAMPLE_RATE};
     use std::path::Path;
 
     #[test]
     fn test_tempo_real() {
         let song = Song::decode(Path::new("data/s16_mono_22_5kHz.flac")).unwrap();
         let mut tempo_desc = BPMDesc::new(SAMPLE_RATE).unwrap();
-        for chunk in song.sample_array.chunks_exact(BPMDesc::HOP_SIZE) {
+        for chunk in song.chunks_exact(BPMDesc::HOP_SIZE) {
             tempo_desc.do_(&chunk).unwrap();
         }
         assert!(0.01 > (0.378605 - tempo_desc.get_value()).abs());

src/timbral.rs

@@ -9,7 +9,7 @@ use bliss_audio_aubio_rs::{bin_to_freq, PVoc, SpecDesc, SpecShape};
 use ndarray::{arr1, Axis};
 
 use super::utils::{geometric_mean, mean, number_crossings, Normalize};
-use crate::{BlissError, BlissResult, SAMPLE_RATE};
+use crate::bliss_lib::{BlissError, BlissResult, SAMPLE_RATE};
 
 /**
  * General object holding all the spectral descriptor.
@@ -125,23 +125,20 @@ impl SpectralDesc {
             centroid_aubio_desc: SpecDesc::new(SpecShape::Centroid, SpectralDesc::WINDOW_SIZE)
                 .map_err(|e| {
                     BlissError::AnalysisError(format!(
-                        "error while loading aubio centroid object: {}",
-                        e
+                        "error while loading aubio centroid object: {e}",
                     ))
                 })?,
             rolloff_aubio_desc: SpecDesc::new(SpecShape::Rolloff, SpectralDesc::WINDOW_SIZE)
                 .map_err(|e| {
                     BlissError::AnalysisError(format!(
-                        "error while loading aubio rolloff object: {}",
-                        e
+                        "error while loading aubio rolloff object: {e}",
                     ))
                 })?,
             phase_vocoder: PVoc::new(SpectralDesc::WINDOW_SIZE, SpectralDesc::HOP_SIZE).map_err(
                 |e| {
-                    BlissError::AnalysisError(format!(
-                        "error while loading aubio pvoc object: {}",
-                        e
-                    ))
+                    BlissError::AnalysisError(
+                        format!("error while loading aubio pvoc object: {e}",),
+                    )
                 },
             )?,
             values_centroid: Vec::new(),
@@ -163,7 +160,7 @@ impl SpectralDesc {
         self.phase_vocoder
             .do_(chunk, fftgrain.as_mut_slice())
             .map_err(|e| {
-                BlissError::AnalysisError(format!("error while processing aubio pv object: {}", e))
+                BlissError::AnalysisError(format!("error while processing aubio pv object: {e}"))
             })?;
 
         let bin = self
@@ -171,8 +168,7 @@ impl SpectralDesc {
             .do_result(fftgrain.as_slice())
             .map_err(|e| {
                 BlissError::AnalysisError(format!(
-                    "error while processing aubio centroid object: {}",
-                    e
+                    "error while processing aubio centroid object: {e}",
                 ))
             })?;
 
@@ -262,7 +258,7 @@ impl Normalize for ZeroCrossingRateDesc {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::Song;
+    use crate::bliss_lib::Song;
     use std::path::Path;
 
     #[test]
@@ -287,7 +283,7 @@ mod tests {
     fn test_zcr() {
         let song = Song::decode(Path::new("data/s16_mono_22_5kHz.flac")).unwrap();
         let mut zcr_desc = ZeroCrossingRateDesc::default();
-        for chunk in song.sample_array.chunks_exact(SpectralDesc::HOP_SIZE) {
+        for chunk in song.chunks_exact(SpectralDesc::HOP_SIZE) {
             zcr_desc.do_(&chunk);
         }
         assert!(0.001 > (-0.85036 - zcr_desc.get_value()).abs());
@@ -307,13 +303,14 @@ mod tests {
             assert!(0.0000001 > (expected - actual).abs());
         }
 
-        let song = Song::decode(Path::new("data/white_noise.flac")).unwrap();
+        let song = Song::decode(Path::new("data/white_noise.mp3")).unwrap();
         let mut spectral_desc = SpectralDesc::new(22050).unwrap();
-        for chunk in song.sample_array.chunks_exact(SpectralDesc::HOP_SIZE) {
+        for chunk in song.chunks_exact(SpectralDesc::HOP_SIZE) {
             spectral_desc.do_(&chunk).unwrap();
         }
+        println!("{:?}", spectral_desc.get_flatness());
         // White noise - as close to 1 as possible
-        let expected_values = vec![0.6706717, -0.9685736];
+        let expected_values = vec![0.5785303, -0.9426308];
         for (expected, actual) in expected_values
             .iter()
             .zip(spectral_desc.get_flatness().iter())
@@ -326,7 +323,7 @@ mod tests {
     fn test_spectral_flatness() {
         let song = Song::decode(Path::new("data/s16_mono_22_5kHz.flac")).unwrap();
         let mut spectral_desc = SpectralDesc::new(SAMPLE_RATE).unwrap();
-        for chunk in song.sample_array.chunks_exact(SpectralDesc::HOP_SIZE) {
+        for chunk in song.chunks_exact(SpectralDesc::HOP_SIZE) {
             spectral_desc.do_(&chunk).unwrap();
         }
         // Spectral flatness mean value computed here with phase vocoder before normalization: 0.111949615
@@ -356,7 +353,7 @@ mod tests {
 
         let song = Song::decode(Path::new("data/tone_11080Hz.flac")).unwrap();
         let mut spectral_desc = SpectralDesc::new(SAMPLE_RATE).unwrap();
-        for chunk in song.sample_array.chunks_exact(SpectralDesc::HOP_SIZE) {
+        for chunk in song.chunks_exact(SpectralDesc::HOP_SIZE) {
             spectral_desc.do_(&chunk).unwrap();
         }
         let expected_values = vec![0.9967681, -0.99615175];
@@ -372,7 +369,7 @@ mod tests {
     fn test_spectral_roll_off() {
         let song = Song::decode(Path::new("data/s16_mono_22_5kHz.flac")).unwrap();
         let mut spectral_desc = SpectralDesc::new(SAMPLE_RATE).unwrap();
-        for chunk in song.sample_array.chunks_exact(SpectralDesc::HOP_SIZE) {
+        for chunk in song.chunks_exact(SpectralDesc::HOP_SIZE) {
             spectral_desc.do_(&chunk).unwrap();
         }
         let expected_values = vec![-0.6326486, -0.7260933];
@@ -390,7 +387,7 @@ mod tests {
     fn test_spectral_centroid() {
         let song = Song::decode(Path::new("data/s16_mono_22_5kHz.flac")).unwrap();
         let mut spectral_desc = SpectralDesc::new(SAMPLE_RATE).unwrap();
-        for chunk in song.sample_array.chunks_exact(SpectralDesc::HOP_SIZE) {
+        for chunk in song.chunks_exact(SpectralDesc::HOP_SIZE) {
             spectral_desc.do_(&chunk).unwrap();
         }
         // Spectral centroid mean value computed here with phase vocoder before normalization: 1354.2273
@@ -419,7 +416,7 @@ mod tests {
         }
         let song = Song::decode(Path::new("data/tone_11080Hz.flac")).unwrap();
         let mut spectral_desc = SpectralDesc::new(SAMPLE_RATE).unwrap();
-        for chunk in song.sample_array.chunks_exact(SpectralDesc::HOP_SIZE) {
+        for chunk in song.chunks_exact(SpectralDesc::HOP_SIZE) {
             spectral_desc.do_(&chunk).unwrap();
         }
         let expected_values = vec![0.97266, -0.9609926];

src/utils.rs

@@ -63,7 +63,7 @@ pub(crate) fn stft(signal: &[f32], window_length: usize, hop_length: usize) -> A
 }
 
 pub(crate) fn mean<T: Clone + Into<f32>>(input: &[T]) -> f32 {
-    input.iter().map(|x| x.clone().into() as f32).sum::<f32>() / input.len() as f32
+    input.iter().map(|x| x.clone().into()).sum::<f32>() / input.len() as f32
 }
 
 pub(crate) trait Normalize {
@@ -112,8 +112,7 @@ pub(crate) fn geometric_mean(input: &[f32]) -> f32 {
     }
 
     let n = input.len() as u32;
-    ((((mantissas as f32).log2() + exponents as f32) as f32) / n as f32 - (1023. + 500.) / 8.)
-        .exp2()
+    (((mantissas as f32).log2() + exponents as f32) / n as f32 - (1023. + 500.) / 8.).exp2()
 }
 
 pub(crate) fn hz_to_octs_inplace(
@@ -121,7 +120,7 @@ pub(crate) fn hz_to_octs_inplace(
     tuning: f64,
     bins_per_octave: u32,
 ) -> &mut Array1<f64> {
-    let a440 = 440.0 * (2_f64.powf(tuning / f64::from(bins_per_octave)) as f64);
+    let a440 = 440.0 * 2_f64.powf(tuning / f64::from(bins_per_octave));
 
     *frequencies /= a440 / 16.;
     frequencies.mapv_inplace(f64::log2);
@@ -166,7 +165,7 @@ pub(crate) fn convolve(input: &Array1<f64>, kernel: &Array1<f64>) -> Array1<f64>
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::Song;
+    use crate::bliss_lib::Song;
     use ndarray::Array2;
     use ndarray::{arr1, Array};
     use ndarray_npy::ReadNpyExt;
@@ -499,7 +498,7 @@ mod tests {
 
         let song = Song::decode(Path::new("data/piano.flac")).unwrap();
 
-        let stft = stft(&song.sample_array, 2048, 512);
+        let stft = stft(&song, 2048, 512);
 
         assert!(!stft.is_empty() && !expected_stft.is_empty());
         for (expected, actual) in expected_stft.iter().zip(stft.iter()) {