diff --git a/.codespellignore b/.codespellignore new file mode 100644 index 0000000..f5d1b08 --- /dev/null +++ b/.codespellignore @@ -0,0 +1,4 @@ +# SPDX-FileCopyrightText: The audio-viz authors +# SPDX-License-Identifier: CC0-1.0 + +crate diff --git a/.commitlintrc.json b/.commitlintrc.json new file mode 100644 index 0000000..bad5427 --- /dev/null +++ b/.commitlintrc.json @@ -0,0 +1,33 @@ +{ + "rules": { + "subject-min-length": [ + 2, + "always", + 8 + ], + "subject-max-length": [ + 2, + "always", + 50 + ], + "subject-case": [ + 2, + "always", + "sentence-case" + ], + "subject-full-stop": [ + 2, + "never", + "." + ], + "body-max-line-length": [ + 2, + "always", + 72 + ], + "footer-leading-blank": [ + 2, + "always" + ] + } +} diff --git a/.commitlintrc.json.license b/.commitlintrc.json.license new file mode 100644 index 0000000..7605e02 --- /dev/null +++ b/.commitlintrc.json.license @@ -0,0 +1,2 @@ +SPDX-FileCopyrightText: The audio-viz authors +SPDX-License-Identifier: CC0-1.0 diff --git a/.deny.toml b/.deny.toml new file mode 100644 index 0000000..71f35e8 --- /dev/null +++ b/.deny.toml @@ -0,0 +1,29 @@ +# SPDX-FileCopyrightText: The audio-viz authors +# SPDX-License-Identifier: CC0-1.0 + +[advisories] +db-path = "~/.cargo/advisory-db" +db-urls = ["https://github.com/rustsec/advisory-db"] +vulnerability = "deny" +unmaintained = "warn" +yanked = "warn" +notice = "warn" + +[licenses] +default = "deny" +unlicensed = "deny" +copyleft = "warn" +allow = [ + "Apache-2.0", + "ISC", + "MIT", + "MPL-2.0", + "Unicode-DFS-2016", +] + +[bans] +multiple-versions = "warn" +wildcards = "allow" +highlight = "all" +workspace-default-features = "allow" +external-default-features = "allow" diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml new file mode 100644 index 0000000..a94bbdd --- /dev/null +++ b/.github/dependabot.yaml @@ -0,0 +1,10 @@ +# SPDX-FileCopyrightText: The audio-viz authors +# SPDX-License-Identifier: CC0-1.0 + +version: 2 + +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" diff --git a/.github/workflows/dependency-audit.yaml b/.github/workflows/dependency-audit.yaml new file mode 100644 index 0000000..8c1d4d8 --- /dev/null +++ b/.github/workflows/dependency-audit.yaml @@ -0,0 +1,37 @@ +# SPDX-FileCopyrightText: The audio-viz authors +# SPDX-License-Identifier: CC0-1.0 + +# yaml-language-server: $schema=https://json.schemastore.org/github-workflow + +# Same as file name +name: dependency-audit + +permissions: + contents: read + +on: + push: + paths: + - "**/Cargo.toml" + - ".deny.toml" + schedule: + # Weekly, i.e. on Sunday at 13:37 UTC + - cron: "37 13 * * 0" + workflow_dispatch: + +jobs: + run: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Generate Cargo.lock + run: cargo generate-lockfile + + - uses: EmbarkStudios/cargo-deny-action@v1 + with: + command: check + arguments: >- + --all-features + --locked diff --git a/.github/workflows/pre-commit.yaml b/.github/workflows/pre-commit.yaml new file mode 100644 index 0000000..43bc613 --- /dev/null +++ b/.github/workflows/pre-commit.yaml @@ -0,0 +1,65 @@ +# SPDX-FileCopyrightText: The audio-viz authors +# SPDX-License-Identifier: CC0-1.0 + +# yaml-language-server: $schema=https://json.schemastore.org/github-workflow + +# Same as file name +name: pre-commit + +permissions: + contents: read + +on: + pull_request: + push: + branches: + - "*" + workflow_dispatch: + +env: + CARGO_TERM_COLOR: always + +jobs: + run: + runs-on: ubuntu-latest + + steps: + - name: Install ALSA and Jack dependencies + run: >- + sudo apt-get update && + sudo apt-get install -y + libasound2-dev + libjack-jackd2-dev + libudev-dev + + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: "3.x" + + - name: Install Rust toolchain + uses: dtolnay/rust-toolchain@stable + with: + components: clippy, rustfmt + + - name: Check out repository + uses: actions/checkout@v4 + + - name: Generate Cargo.lock + run: cargo generate-lockfile + + - name: Cache Rust toolchain and build artifacts + uses: Swatinem/rust-cache@v2 + with: + # The cache should not be shared between different workflows and jobs. + shared-key: ${{ github.workflow }}-${{ github.job }} + + - name: Detect code style issues (push) + uses: pre-commit/action@v3.0.0 + if: github.event_name == 'push' + + - name: Detect code style issues (pull_request) + uses: pre-commit/action@v3.0.0 + if: github.event_name == 'pull_request' + env: + SKIP: no-commit-to-branch diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml new file mode 100644 index 0000000..316d998 --- /dev/null +++ b/.github/workflows/test.yaml @@ -0,0 +1,61 @@ +# SPDX-FileCopyrightText: The audio-viz authors +# SPDX-License-Identifier: CC0-1.0 + +# yaml-language-server: $schema=https://json.schemastore.org/github-workflow + +# Same as file name +name: test + +permissions: + contents: read + +on: + pull_request: + push: + branches: + - main + workflow_dispatch: + +env: + CARGO_INCREMENTAL: 0 + CARGO_TERM_COLOR: always + RUST_BACKTRACE: short + +jobs: + run: + runs-on: ubuntu-latest + + steps: + - name: Install ALSA and Jack dependencies + run: >- + sudo apt-get update && + sudo apt-get install -y + libasound2-dev + libjack-jackd2-dev + libudev-dev + + - name: Install Rust toolchain + uses: dtolnay/rust-toolchain@stable + with: + targets: wasm32-unknown-unknown + + - name: Check out repository + uses: actions/checkout@v4 + + - name: Generate Cargo.lock + run: cargo generate-lockfile + + - name: Cache Rust toolchain and build artifacts + uses: Swatinem/rust-cache@v2 + with: + # The cache should not be shared between different workflows and jobs. + shared-key: ${{ github.workflow }}-${{ github.job }} + + - name: Check WASM target with default features + run: >- + cargo check --locked --target wasm32-unknown-unknown + + - name: Run tests with all features enabled + run: >- + cargo test --locked --all-features + -- --nocapture --quiet diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8a0eb9d --- /dev/null +++ b/.gitignore @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: The audio-viz authors +# SPDX-License-Identifier: CC0-1.0 + +# Don't add any custom patterns for platform-specific files like .DS_Store +# or generated by custom development tools like .vscode or .idea that don't +# affect other developers. Instead add those custom patterns to your global +# .gitignore file that can be configured by setting core.excludesFile. +# See also: https://git-scm.com/docs/gitignore + +# Cargo artifacts +Cargo.lock + +# Build directories (or a symbolic link, i.e. without a trailing slash) +/target diff --git a/.justfile b/.justfile new file mode 100644 index 0000000..af5692f --- /dev/null +++ b/.justfile @@ -0,0 +1,44 @@ +# SPDX-FileCopyrightText: The audio-viz authors +# SPDX-License-Identifier: CC0-1.0 + +# just manual: https://github.com/casey/just/#readme + +_default: + @just --list + +# Format source code +fmt: + cargo fmt --all + +# Run clippy with various feature combinations +clippy: + cargo clippy --locked --workspace --all-targets --no-default-features + cargo clippy --locked --workspace --all-targets --no-default-features --features all-controllers + cargo clippy --locked --workspace --no-deps --all-targets --all-features -- -D warnings --cap-lints warn + +# Run cargo check for the WASM target with default features enabled +check-wasm: + cargo check --locked --workspace --target wasm32-unknown-unknown + +# Run unit tests +test: + RUST_BACKTRACE=1 cargo test --locked --all-features -- --nocapture + +# Set up (and update) tooling +setup: + # Ignore rustup failures, because not everyone might use it + rustup self update || true + # cargo-edit is needed for `cargo upgrade` + cargo install cargo-edit just + pip install -U pre-commit + #pre-commit install --hook-type commit-msg --hook-type pre-commit + +# Upgrade (and update) dependencies +upgrade: setup + pre-commit autoupdate + cargo upgrade --incompatible --pinned + cargo update + +# Run pre-commit hooks +pre-commit: + pre-commit run --all-files diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml new file mode 100644 index 0000000..cfd4e48 --- /dev/null +++ b/.markdownlint-cli2.yaml @@ -0,0 +1,41 @@ +# SPDX-FileCopyrightText: The audio-viz authors +# SPDX-License-Identifier: CC0-1.0 + +# Disable some built-in rules +config: + default: true + + # The same headline in different nested sections is okay (and necessary for + # CHANGELOG.md). + no-duplicate-header: + allow_different_nesting: true + + # We use ordered lists to make stuff easier to read in a text editor. + ol-prefix: + style: ordered + + # Not wrapping long lines makes diffs easier to read, especially for prose. + # Instead, we should follow the "one sentence per line" pattern. + line-length: false + + # Dollar signs are useful to indicate shell commands/type and help + # distinguishing wrapped lines from new commands. + commands-show-output: false + + # Indented code blocks are easier to read in a text editor, but don't allow + # specifying a language for syntax highlighting. Therefore both indented and + # fenced code block should be allowed depending on the use case. + code-block-style: false + + # MD026/no-trailing-punctuation: Trailing punctuation in heading + # Used in README.md + no-trailing-punctuation: false + +# Fix any fixable errors +fix: true + +# Disable inline config comments +noInlineConfig: true + +# Disable progress on stdout (only valid at root) +noProgress: true diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..5770199 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,87 @@ +# SPDX-FileCopyrightText: The audio-viz authors +# SPDX-License-Identifier: CC0-1.0 + +default_stages: + # Prevent that hooks run twice, triggered by both + # the Git commit-msg and the pre-commit hook. + - commit + +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 + hooks: + - id: check-case-conflict + - id: check-json + - id: check-merge-conflict + - id: check-symlinks + - id: check-toml + - id: check-xml + - id: check-yaml + - id: destroyed-symlinks + - id: detect-private-key + - id: end-of-file-fixer + - id: fix-byte-order-marker + - id: forbid-new-submodules + - id: mixed-line-ending + - id: trailing-whitespace + - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook + rev: v9.11.0 + hooks: + - id: commitlint + stages: + - commit-msg + - repo: https://github.com/DavidAnson/markdownlint-cli2 + rev: v0.12.1 + hooks: + - id: markdownlint-cli2 + exclude: ^LICENSE\.md$ + - repo: https://github.com/shellcheck-py/shellcheck-py + rev: v0.9.0.6 + hooks: + - id: shellcheck + - repo: https://github.com/codespell-project/codespell + rev: v2.2.6 + hooks: + - id: codespell + args: [--ignore-words=.codespellignore] + - repo: https://github.com/sirosen/check-jsonschema + rev: 0.27.3 + hooks: + - id: check-github-actions + - id: check-github-workflows + - repo: https://github.com/doublify/pre-commit-rust + rev: v1.0 + hooks: + - id: fmt + args: [--all, --] + - id: clippy + args: + [ + --locked, + --workspace, + --all-features, + --all-targets, + --, + -D, + warnings, + ] + - repo: https://github.com/pre-commit/mirrors-prettier + rev: v3.1.0 + hooks: + - id: prettier + types_or: + - markdown + - yaml + # https://reuse.software + - repo: https://github.com/fsfe/reuse-tool + rev: v2.1.0 + hooks: + - id: reuse + - repo: local + hooks: + - id: cargo-doc + name: cargo-doc + entry: env RUSTDOCFLAGS=-Dwarnings cargo + language: system + pass_filenames: false + args: [doc, --locked, --workspace, --no-deps, --all-features] diff --git a/.prettierrc.yaml b/.prettierrc.yaml new file mode 100644 index 0000000..ce02fcd --- /dev/null +++ b/.prettierrc.yaml @@ -0,0 +1,15 @@ +# SPDX-FileCopyrightText: The audio-viz authors +# SPDX-License-Identifier: CC0-1.0 + +overrides: + - files: + - "**/*.yaml" + options: + tabWidth: 2 + # in double quotes you can use escapes + singleQuote: false + - files: + - "**/*.md" + options: + printWidth: 100 + proseWrap: always diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..8508b2b --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,47 @@ +# SPDX-FileCopyrightText: The audio-viz authors +# SPDX-License-Identifier: MPL-2.0 + +[package] +name = "audio-viz" +description = "Colorful audio waveform visualization" +version = "0.1.0" +license = "MPL-2.0" +readme = "README.md" +repository = "https://github.com/uklotzde/audio-viz" +keywords = ["audio", "waveform", "visualization", "color"] +categories = ["audio"] +rust-version = "1.75" +edition = "2021" +include = ["/src", "/README.md", "/LICENSES"] + +[dependencies] +biquad = "0.4.2" +palette = { version = "0.7.3", default-features = false, features = ["std"] } + +[lints.rust] +future_incompatible = "warn" +let_underscore = "warn" +missing_debug_implementations = "warn" +rust_2018_idioms = "warn" +rust_2021_compatibility = "warn" +unreachable_pub = "warn" +unsafe_code = "warn" +unused = "warn" + +[lints.clippy] +pedantic = "warn" +clone_on_ref_ptr = "warn" +missing_const_for_fn = "warn" +self_named_module_files = "warn" + +# Repetitions of module/type names occur frequently when using many +# modules for keeping the size of the source files handy. Often +# types have the same name as their parent module. +module_name_repetitions = "allow" + +# Repeating the type name in `Default::default()` expressions +# is not needed as long as the context is obvious. +default_trait_access = "allow" + +# The error types returned should be self-explanatory. +missing_errors_doc = "allow" diff --git a/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt new file mode 100644 index 0000000..0e259d4 --- /dev/null +++ b/LICENSES/CC0-1.0.txt @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/LICENSES/MPL-2.0.txt b/LICENSES/MPL-2.0.txt new file mode 100644 index 0000000..a612ad9 --- /dev/null +++ b/LICENSES/MPL-2.0.txt @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 index 0000000..714e160 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ + + + +# audio-viz + +[![Crates.io](https://img.shields.io/crates/v/audio-viz.svg)](https://crates.io/crates/audio-viz) +[![Docs.rs](https://docs.rs/audio-viz/badge.svg)](https://docs.rs/audio-viz) +[![Deps.rs](https://deps.rs/repo/github/uklotzde/audio-viz/status.svg)](https://deps.rs/repo/github/uklotzde/audio-viz) +[![Security audit](https://github.com/uklotzde/audio-viz/actions/workflows/security-audit.yaml/badge.svg)](https://github.com/uklotzde/audio-viz/actions/workflows/security-audit.yaml) +[![Continuous integration](https://github.com/uklotzde/audio-viz/actions/workflows/test.yaml/badge.svg)](https://github.com/uklotzde/audio-viz/actions/workflows/test.yaml) +[![License: MPL 2.0](https://img.shields.io/badge/License-MPL_2.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0) + +Colorful audio waveform visualization. + +## License + +Licensed under the Mozilla Public License 2.0 (MPL-2.0) (see [MPL-2.0.txt](LICENSES/MPL-2.0.txt) or +). + +Permissions of this copyleft license are conditioned on making available source code of licensed +files and modifications of those files under the same license (or in certain cases, one of the GNU +licenses). Copyright and license notices must be preserved. Contributors provide an express grant of +patent rights. However, a larger work using the licensed work may be distributed under different +terms and without source code for files added in the larger work. + +### Contribution + +Any contribution intentionally submitted for inclusion in the work by you shall be licensed under +the Mozilla Public License 2.0 (MPL-2.0). + +It is required to add the following header with the corresponding +[SPDX short identifier](https://spdx.dev/ids/) to the top of each file: + +```rust +// SPDX-License-Identifier: MPL-2.0 +``` diff --git a/src/filter.rs b/src/filter.rs new file mode 100644 index 0000000..6d473b2 --- /dev/null +++ b/src/filter.rs @@ -0,0 +1,273 @@ +// SPDX-FileCopyrightText: The audio-viz authors +// SPDX-License-Identifier: MPL-2.0 + +use biquad::{Biquad as _, Coefficients, DirectForm2Transposed, Hertz, Q_BUTTERWORTH_F32}; + +use super::{FilteredWaveformBin, WaveformBin, WaveformVal}; + +// Only needed for initialization of the filter bank +const DEFAULT_SAMPLE_RATE_HZ: f32 = 44_100.0; + +/// Crossover low/mid (high pass) +/// +/// Same boundary as used by both Rekordbox and +/// [Superpowered](https://docs.superpowered.com/reference/latest/analyzer>) +/// and also used by Rekordbox. +const LOW_LP_FILTER_HZ: f32 = 200.0; + +/// Crossover low/mid (low pass) +/// +/// Overlapping mids with lows. +const LOW_HP_FILTER_HZ: f32 = LOW_LP_FILTER_HZ / 2.0; + +/// Crossover mid/high (low pass) +/// +/// Same boundary as used by +/// [Superpowered](https://docs.superpowered.com/reference/latest/analyzer>) +/// whereas Rekordbox uses 2000 Hz. +const HIGH_LP_FILTER_HZ: f32 = 1600.0; + +/// Crossover mid/high (high pass) +/// +/// Overlapping highs with mids. +const HIGH_HP_FILTER_HZ: f32 = HIGH_LP_FILTER_HZ / 2.0; // Overlap with mid + +const MIN_SAMPLES_PER_BIN: u32 = 64; + +// 3-band crossover using 4th-order Linkwitz-Riley (LR4) filters (2 cascaded 2nd-order Butterworth) +struct FilterBank { + low_lp_lr4: [DirectForm2Transposed; 2], + low_hp_lr4: [DirectForm2Transposed; 2], + high_lp_lr4: [DirectForm2Transposed; 2], + high_hp_lr4: [DirectForm2Transposed; 2], +} + +impl Default for FilterBank { + fn default() -> Self { + Self::new(Hertz::::from_hz(DEFAULT_SAMPLE_RATE_HZ).expect("valid sample rate")) + } +} + +#[derive(Debug)] +struct FilteredSample { + all: f32, + low: f32, + mid: f32, + high: f32, +} + +impl FilterBank { + fn new(fs: Hertz) -> Self { + let low_lp_f0 = Hertz::::from_hz(LOW_LP_FILTER_HZ).expect("valid frequency"); + let low_lp = DirectForm2Transposed::::new( + Coefficients::::from_params( + biquad::Type::LowPass, + fs, + low_lp_f0, + Q_BUTTERWORTH_F32, + ) + .expect("valid params"), + ); + let low_hp_f0 = Hertz::::from_hz(LOW_HP_FILTER_HZ).expect("valid frequency"); + let low_hp = DirectForm2Transposed::::new( + Coefficients::::from_params( + biquad::Type::HighPass, + fs, + low_hp_f0, + Q_BUTTERWORTH_F32, + ) + .expect("valid params"), + ); + let high_lp_f0 = Hertz::::from_hz(HIGH_LP_FILTER_HZ).expect("valid frequency"); + let high_lp = DirectForm2Transposed::::new( + Coefficients::::from_params( + biquad::Type::LowPass, + fs, + high_lp_f0, + Q_BUTTERWORTH_F32, + ) + .expect("valid params"), + ); + let high_hp_f0 = Hertz::::from_hz(HIGH_HP_FILTER_HZ).expect("valid frequency"); + let high_hp = DirectForm2Transposed::::new( + Coefficients::::from_params( + biquad::Type::HighPass, + fs, + high_hp_f0, + Q_BUTTERWORTH_F32, + ) + .expect("valid params"), + ); + Self { + low_lp_lr4: [low_lp, low_lp], + low_hp_lr4: [low_hp, low_hp], + high_lp_lr4: [high_lp, high_lp], + high_hp_lr4: [high_hp, high_hp], + } + } + + fn shape_input_signal(&mut self, sample: f32) -> f32 { + // TODO: Apply filtering to shape the input signal according to the + // ISO 226:2003 equal-loudness-level contour at 40 phons (A-weighting). + sample + } + + pub fn run(&mut self, sample: f32) -> FilteredSample { + let all = self.shape_input_signal(sample); + let Self { + low_lp_lr4, + low_hp_lr4, + high_lp_lr4, + high_hp_lr4, + } = self; + let low = low_lp_lr4 + .iter_mut() + .fold(all, |sample, filter| filter.run(sample)); + let mid_high = low_hp_lr4 + .iter_mut() + .fold(all, |sample, filter| filter.run(sample)); + let mid = high_lp_lr4 + .iter_mut() + .fold(mid_high, |sample, filter| filter.run(sample)); + let high = high_hp_lr4 + .iter_mut() + .fold(mid_high, |sample, filter| filter.run(sample)); + FilteredSample { + all, + low, + mid, + high, + } + } +} + +#[derive(Debug, Default)] +struct WaveformBinAccumulator { + pub rms_sum: f64, + pub peak: f32, +} + +impl WaveformBinAccumulator { + fn add_sample(&mut self, sample: f32) { + let sample_f64 = f64::from(sample); + self.rms_sum += sample_f64 * sample_f64; + self.peak = self.peak.max(sample.abs()); + } + + fn finish(self, rms_div: f64) -> WaveformBin { + debug_assert!(rms_div > 0.0); + let Self { rms_sum, peak } = self; + let ratio = (1.0 + (rms_sum / rms_div).sqrt()).log2() as f32; + WaveformBin { + ratio: WaveformVal::from_f32(ratio), + peak: WaveformVal::from_f32(peak), + } + } +} + +#[derive(Debug, Default)] +struct FilteredWaveformBinAccumulator { + sample_count: u32, + all: WaveformBinAccumulator, + low: WaveformBinAccumulator, + mid: WaveformBinAccumulator, + high: WaveformBinAccumulator, +} + +impl FilteredWaveformBinAccumulator { + fn add_sample(&mut self, filter_bank: &mut FilterBank, sample: f32) { + self.sample_count += 1; + let FilteredSample { + all, + low, + mid, + high, + } = filter_bank.run(sample); + self.all.add_sample(all); + self.low.add_sample(low); + self.mid.add_sample(mid); + self.high.add_sample(high); + } + + fn finish(self) -> Option { + let Self { + sample_count, + all, + low, + mid, + high, + } = self; + if sample_count == 0 { + return None; + } + let rms_div = sample_count as f64; + let all = all.finish(rms_div); + let low = low.finish(rms_div); + let mid = mid.finish(rms_div); + let high = high.finish(rms_div); + Some(FilteredWaveformBin { + all, + low, + mid, + high, + }) + } +} + +pub struct WaveformFilter { + samples_per_bin: u32, + filter_bank: FilterBank, + filtered_accumulator: FilteredWaveformBinAccumulator, +} + +impl Default for WaveformFilter { + fn default() -> Self { + Self::new( + Hertz::::from_hz(DEFAULT_SAMPLE_RATE_HZ).expect("valid default sample rate"), + 0, + ) + } +} + +impl WaveformFilter { + fn new(sample_rate: Hertz, samples_per_bin: u32) -> Self { + Self { + samples_per_bin, + filter_bank: FilterBank::new(sample_rate), + filtered_accumulator: Default::default(), + } + } + + fn finish_bin(&mut self) -> Option { + std::mem::take(&mut self.filtered_accumulator).finish() + } + + fn add_sample(&mut self, sample: f32) -> Option { + let next_bin = if self.filtered_accumulator.sample_count >= self.samples_per_bin { + self.finish_bin() + } else { + None + }; + self.filtered_accumulator + .add_sample(&mut self.filter_bank, sample); + next_bin + } + + fn finish(mut self) -> Option { + self.finish_bin() + } +} + +pub type WaveformFiltered = [FilteredWaveformBin]; + +pub struct WaveformAnalyzer<'a> { + file_path: &'a Path, + file_type: Option<&'a Mime>, + bins_per_sec: NonZeroU8, + filter: WaveformFilter, + waveform: FilteredWaveform, +} + +fn samples_per_bin(bins_per_sec: NonZeroU8, sample_rate: Hertz) -> u32 { + (sample_rate.hz() / f32::from(bins_per_sec.get())).floor() as u32 +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..bc6db7b --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,11 @@ +// SPDX-FileCopyrightText: The audio-viz authors +// SPDX-License-Identifier: MPL-2.0 + +#![allow(rustdoc::invalid_rust_codeblocks)] +#![doc = include_str!("../README.md")] + +mod filter; +pub use filter::WaveformFilter; + +mod waveform; +pub use waveform::{FilteredWaveform, FilteredWaveformBin, WaveformBin, WaveformVal}; diff --git a/src/waveform.rs b/src/waveform.rs new file mode 100644 index 0000000..1932daf --- /dev/null +++ b/src/waveform.rs @@ -0,0 +1,129 @@ +// SPDX-FileCopyrightText: The audio-viz authors +// SPDX-License-Identifier: MPL-2.0 + +use palette::{FromColor, Hsv, Srgb}; + +#[derive(Debug, Clone, Copy, Eq, PartialEq, PartialOrd, Ord, Default)] +#[repr(transparent)] +pub struct WaveformVal(pub u8); + +impl WaveformVal { + const MAX_VAL: u8 = u8::MAX; + + pub(crate) fn from_f32(val: f32) -> Self { + debug_assert!(val >= f32::from(u8::MIN)); + let mapped = (val * (f32::from(Self::MAX_VAL) + 1.0)).min(f32::from(Self::MAX_VAL)); + debug_assert!(mapped >= f32::from(u8::MIN)); + debug_assert!(mapped <= f32::from(u8::MAX)); + Self(mapped as u8) + } + + pub fn to_f32(self) -> f32 { + f32::from(self.0) / f32::from(Self::MAX_VAL) + } + + pub const fn is_zero(self) -> bool { + self.0 == 0 + } +} + +impl From for u8 { + fn from(value: WaveformVal) -> Self { + value.0 + } +} + +#[derive(Debug, Clone, Copy, Default)] +pub struct WaveformBin { + /// Clamped, logarithmic ratio in the range `0..=1` + /// + /// Calculated from the Root Mean Square (RMS) of all samples. + pub ratio: WaveformVal, + + /// Clamped, absolute peak value in the range `0..=1` + pub peak: WaveformVal, +} + +#[derive(Debug, Clone, Copy, Default)] +pub struct FilteredWaveformBin { + pub all: WaveformBin, + pub low: WaveformBin, + pub mid: WaveformBin, + pub high: WaveformBin, +} + +// TODO: Encapsulate in a dedicated (new)type +pub type FilteredWaveform = Vec; + +impl FilteredWaveformBin { + /// + pub fn ratio_flatness(&self) -> f32 { + let Self { low, mid, high, .. } = self; + let low = 1.0 + low.ratio.to_f32(); // [1, 256] + let mid = 1.0 + mid.ratio.to_f32(); // [1, 256] + let high = 1.0 + high.ratio.to_f32(); // [1, 256] + let geometric_mean = (low * mid * high).powf(1.0 / 3.0); + let arithmetic_mean = (low + mid + high) / 3.0; + geometric_mean / arithmetic_mean + } + + fn ratio_spectral_rgb(&self) -> Srgb { + let Self { + all, + low, + mid, + high, + } = self; + let all = all.ratio.to_f32(); + if all == 0.0 { + return Srgb::new(0.0, 0.0, 0.0); + } + let low = low.ratio.to_f32(); + let mid = mid.ratio.to_f32(); + let high = high.ratio.to_f32(); + let red = low.min(all) / all; + let green = mid.min(all) / all; + let blue = high.min(all) / all; + Srgb::new(red, green, blue) + } + + pub fn rgb_color(&self, flatness_to_saturation: f32) -> (f32, f32, f32) { + let mut rgb = self.ratio_spectral_rgb(); + debug_assert!(flatness_to_saturation >= 0.0); + debug_assert!(flatness_to_saturation <= 1.0); + if flatness_to_saturation > 0.0 { + let mut hsv = Hsv::from_color(rgb); + let flatness = self.ratio_flatness(); + hsv.saturation = 1.0 - flatness * flatness_to_saturation; + rgb = Srgb::from_color(hsv); + } + (rgb.red, rgb.green, rgb.blue) + } + + pub fn amplitude(&self) -> f32 { + let all = self.all.ratio.to_f32(); + (all * std::f32::consts::SQRT_2).min(1.0) + } +} + +#[cfg(test)] +mod tests { + use super::WaveformVal; + + #[test] + fn waveform_val_from_f32() { + assert_eq!(WaveformVal::from_f32(0.0), WaveformVal(0)); + assert_eq!(WaveformVal::from_f32(0.25), WaveformVal(64)); + assert_eq!(WaveformVal::from_f32(0.5), WaveformVal(128)); + assert_eq!(WaveformVal::from_f32(0.75), WaveformVal(192)); + assert_eq!(WaveformVal::from_f32(1.0), WaveformVal(255)); + } + + #[test] + fn waveform_val_to_from_f32() { + for val in u8::MIN..=u8::MAX { + let val = WaveformVal(val); + assert_eq!(val, WaveformVal::from_f32(val.to_f32())); + } + } +}