sonicproof 0.1.0__tar.gz

sonicproof-0.1.0/.gitignore

@@ -0,0 +1,30 @@
+# Python
+__pycache__/
+*.py[cod]
+.venv/
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+
+# Models / media / outputs (never commit)
+.cache/
+samples/
+out/
+*.wav
+*.flac
+*.mp3
+*.ogg
+*.mp4
+!tests/fixtures/**
+
+# OS / runtime
+.DS_Store
+Thumbs.db
+.claude/
+
+# Web UI sources (the build in src/sonicproof/web is shipped)
+web/node_modules/
+

sonicproof-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sonicproof-0.1.0/NOTICE

@@ -0,0 +1,18 @@
+Sonicproof
+Copyright 2026 Sonicproof contributors
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+Reference bank
+--------------
+src/sonicproof/data/refbank.npz contains embeddings computed with Google's
+EmbeddingGemma 2 from short clips generated with Stable Audio 3 Medium.
+No audio is included, only the embeddings and short text titles.
+
+Model
+-----
+The EmbeddingGemma 2 model (google/embeddinggemma-2) is not bundled with
+Sonicproof. It is downloaded from Hugging Face on first run. The model is
+released by Google under the Apache License, Version 2.0; its model card asks
+that deployments follow the Gemma Prohibited Use Policy:
+https://ai.google.dev/gemma/prohibited_use_policy

sonicproof-0.1.0/PKG-INFO

@@ -0,0 +1,341 @@
+Metadata-Version: 2.5
+Name: sonicproof
+Version: 0.1.0
+Summary: The audio QA layer for generative audio — check, rank and QC AI-generated sound with EmbeddingGemma 2.
+Project-URL: Homepage, https://github.com/kanaworksai-hue/sonicproof
+Project-URL: Repository, https://github.com/kanaworksai-hue/sonicproof
+Project-URL: Issues, https://github.com/kanaworksai-hue/sonicproof/issues
+Project-URL: Changelog, https://github.com/kanaworksai-hue/sonicproof/releases
+Author: Sonicproof contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: audio,audio-qa,embeddinggemma,embeddings,generative-audio,loudness,mcp,sound-effects,sound-library,stable-audio
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.11
+Requires-Dist: fastapi>=0.115
+Requires-Dist: mcp>=2.3
+Requires-Dist: numpy>=2.1
+Requires-Dist: pyloudnorm>=0.1.1
+Requires-Dist: python-multipart>=0.0.9
+Requires-Dist: rich>=13
+Requires-Dist: scipy>=1.11
+Requires-Dist: soundfile>=0.12
+Requires-Dist: typer>=0.12
+Requires-Dist: uvicorn>=0.30
+Provides-Extra: model
+Requires-Dist: sentence-transformers[image]>=6.1; extra == 'model'
+Requires-Dist: torch>=2.6; extra == 'model'
+Requires-Dist: transformers<6,>=5; extra == 'model'
+Description-Content-Type: text/markdown
+
+# Sonicproof
+
+**Does your AI-generated sound match what you asked for?**
+
+Sonicproof is a local QA tool for generative audio — sound effects, music and ambience from Stable Audio and
+friends. It listens with one multilingual model, Google's
+[EmbeddingGemma 2](https://huggingface.co/google/embeddinggemma-2), which puts text, sound, images and video in
+one shared space:
+
+- **check** — does this clip sound like the prompt? Prompts can be English, 中文, 日本語 or any other language.
+- **rank** — you generated four seeds; which one should you keep?
+- **qc** — is it technically clean? Loudness, true peak, clipping, DC, silence, cut-off tails, clicks, phase,
+  loop seams — with a one-line fix for every problem.
+- **fit** — does this sound suit the picture? A frame, a piece of concept art, a video clip, or a video's own
+  soundtrack.
+- **search** — find sounds in your own library by words (any language), by example, or by picture.
+- **dedupe** — find the re-encoded, re-levelled and trimmed copies cluttering your library, and which one to keep.
+
+Everything runs on your machine. No uploads, no API keys. Use it three ways:
+
+- **Workbench** — `sonicproof serve` opens a local web app: drop files in, see waveforms, spectrograms,
+  scores and one-line fixes. English and 日本語.
+- **Agents** — an MCP server and an agent skill, so Claude Code, Codex and friends can listen to what they
+  generate. See [Use it from your AI agent](#use-it-from-your-ai-agent).
+- **CLI / Python** — every analysis command has `--json`.
+
+![The Sonicproof workbench: generated takes grouped by prompt, the best take of each group marked “Use this one”](https://raw.githubusercontent.com/kanaworksai-hue/sonicproof/main/docs/images/workbench.jpg)
+
+```text
+$ sp check dog_bark.wav "狗在叫"          # output trimmed: 3 of the 5 "Heard as" lines
+╭─ dog_bark.wav ─────────────────────────────────────────────────────╮
+│                                                                    │
+│   STRONG   +2.97σ  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━                    │
+│  clearly sounds like the prompt                                    │
+│                                                                    │
+│    prompt  “狗在叫”                                                │
+│   ranking  #2 of 438 descriptions for this clip                    │
+│  evidence  cos 0.736 · clip-side +3.19σ · prompt-side +2.74σ       │
+│                                                                    │
+│  Heard as                                                          │
+│  +3.24σ  a dog barking  ✓  animals                                 │
+│  +2.85σ  a dog whining  ✓  animals                                 │
+│  +2.69σ  a dog growling  ✓  animals                                │
+│                                                                    │
+╰────────────────────────────────────────────────────────────────────╯
+```
+
+## Install
+
+```bash
+uv tool install "sonicproof[model]"        # or: pip install "sonicproof[model]"
+sonicproof doctor --load                   # first run downloads the model once (~1.5 GB)
+```
+
+Until the first release, install from source: `git clone https://github.com/kanaworksai-hue/sonicproof`, run
+`uv sync --extra model` inside it,
+and run commands with `uv run sp …` (or `uv run --project /path/to/sonicproof sp …` from any other folder).
+
+- **Python 3.11+.** Apple Silicon (MPS), CUDA and CPU all work. `sp` is a short alias for `sonicproof`.
+- **The model** — [EmbeddingGemma 2](https://huggingface.co/google/embeddinggemma-2), about 1.5 GB — is
+  downloaded from Hugging Face into its usual cache on first use. No Hugging Face account or token is needed.
+- **ffmpeg** is only needed for M4A / AAC / MP4 and other formats libsndfile can't read, and for video in
+  `fit` / `search`. WAV, FLAC, OGG and MP3 work without it.
+- **Windows + NVIDIA GPU:** the PyPI build of PyTorch for Windows is CPU-only. Install PyTorch with CUDA first,
+  following [pytorch.org](https://pytorch.org/get-started/locally/), then install Sonicproof.
+- `qc` needs no model at all: `pip install sonicproof` (without `[model]`) is enough for technical checks.
+
+## Use
+
+```bash
+# Prompt adherence. Omit the prompt to read it from a Stable Audio .json sidecar.
+sp check explosion.wav "a huge explosion with debris"
+sp check door_v2.wav "木の扉がきしみながら開く"
+sp check thunder.wav
+
+# Pick the best take
+sp rank "a wooden door creaking open" door_v1.wav door_v2.wav door_v3.wav door_v4.wav
+
+# Technical checks (no model needed). Exit code 1 if anything fails — handy in scripts.
+sp qc *.wav
+sp qc ambience_loop.wav --loop --target-lufs -16
+
+# Everything in one scorecard: SHIP / REVIEW / REDO. --strict exits 1 unless it is SHIP.
+sp report footsteps.wav "footsteps on gravel"
+sp report footsteps.wav "footsteps on gravel" --strict
+
+# Does the sound suit the picture? Words about the scene are optional, any language.
+sp fit sizzle.wav --image kitchen.png
+sp fit rumble.wav --video storm.mp4 "暴风雨夜，雷声"
+sp fit trailer.mp4                          # a video's own soundtrack against its own picture
+```
+
+### Your sound library
+
+```bash
+sp index ~/SFX                              # once; re-runs only read new or changed files
+sp search "rain on a tin roof" --in ~/SFX
+sp search "木の床を歩く足音" --in ~/SFX
+sp search --like take_03.wav --in ~/SFX     # sounds like this one
+sp search --image frame.png --in ~/SFX      # sounds that suit this picture
+sp dedupe ~/SFX                             # duplicates and near-duplicates (nothing is deleted)
+```
+
+The library folder is always given explicitly: `index DIR`, `search … --in DIR`, `dedupe DIR` (your home
+folder or a drive root are refused — point at the folder that holds your sounds).
+The index lives in `~/SFX/.sonicproof/` (use `--in-cache` to keep it in `~/.cache/sonicproof` instead, e.g. for
+read-only folders). `search` and `dedupe` bring it up to date on the fly, so `sp index` is optional.
+The workbench always keeps its indexes in the cache, so opening a folder there never writes into it.
+
+### Scripting: `--json` and exit codes
+
+The analysis commands — `check`, `rank`, `qc`, `report`, `fit`, `index`, `search`, `dedupe` — take `--json` for scripts and agents (`doctor`, `serve`, `mcp` and `skill` are for people). `qc --json` always prints an array, one record per file,
+even for a single file. A file that can't be read gets `"status": "error"` in that array and the rest are
+still checked.
+
+| Exit code | Meaning |
+|---|---|
+| `0` | Done. `check` / `rank` / `fit` exit 0 whatever the verdict — read the verdict. |
+| `1` | `qc` found a failure, or `report --strict` did not say SHIP. |
+| `2` | A problem with the input: missing or unreadable file, empty audio, bad option value. |
+| `3` | A problem with the setup: model extra not installed, model not downloaded and offline, ffmpeg needed, port busy. |
+
+With `--json`, errors are JSON too — `{"error": {"code": "not_found", "message": "…", "file": "…"}}` on stdout
+— so a script never has to parse a traceback. Set `SONICPROOF_DEBUG=1` to see the full traceback.
+
+Silent clips (nothing above −60 dBFS) are never scored as a match: `check`, `rank`, `fit` and `search` give
+them `"verdict": "miss"` with `"note": "silent"` and rank them last. Short one-shots such as UI clicks are
+judged normally.
+
+## Workbench
+
+```bash
+sonicproof serve                            # opens http://localhost:7788
+```
+
+- **Inbox** — drop audio files or whole folders. Prompts are read from Stable Audio `.json` sidecars (or type
+  your own, in any language). Takes of the same prompt are grouped, ranked, and the best one is marked
+  **Use this one**. When nothing in a group sounds right, it says so and suggests a wording to try next.
+  Each card shows the waveform over a spectrogram, a plain verdict (◎ Very close · ○ Close · △ Somewhat ·
+  ✕ Not a match), a 0–100 match bar and a dot per technical check; technical findings are spelled out in
+  plain words with the fix.
+- **Library** — choose a folder, index it (with progress), then search by words, by dropping a sound, or by
+  picture. The **Duplicates** tab lists copies and which one to keep (nothing is deleted).
+- **Picture** — drop an image or a video: see what it shows in sound words, score your Inbox sounds against
+  it, find matching sounds in your library, or judge a video's own soundtrack.
+
+The raw numbers (σ scores, cosines, every measurement) are one click away under **Details**, or everywhere
+with **Settings → Pro mode**. Settings also shows how much the cache uses and clears it; removing files from the
+Inbox deletes the copies made when they were dropped (your originals are never touched).
+
+The language follows your browser and can be switched (English / 日本語). Sound only plays when you press play.
+The server listens on `localhost` only and refuses requests from other sites.
+
+![The workbench in Japanese](https://raw.githubusercontent.com/kanaworksai-hue/sonicproof/main/docs/images/workbench-ja.jpg)
+
+## Use it from your AI agent
+
+The quickest way: give your agent the link to this repository (or the skill below) and ask it to check the
+sounds it generates. Everything it needs is in this section.
+
+**1. Download the model once, in a terminal.** The MCP server never starts a 1.5 GB download inside a tool
+call (it would look like a hang); it asks you to run this instead:
+
+```bash
+uvx --from "sonicproof[model]" sonicproof doctor --load
+```
+
+**2. Add the MCP server** — tools `check`, `rank`, `qc`, `report`, `fit`, `search`, `dedupe`, `index`. Each returns
+the same records the matching CLI command prints with `--json`. The model loads once and stays loaded.
+
+```bash
+# Claude Code
+claude mcp add sonicproof -e HF_HOME="${HF_HOME:-$HOME/.cache/huggingface}" -- uvx --from "sonicproof[model]" sonicproof mcp
+# Codex
+codex mcp add sonicproof --env HF_HOME="${HF_HOME:-$HOME/.cache/huggingface}" -- uvx --from "sonicproof[model]" sonicproof mcp
+# any client: streamable HTTP at http://127.0.0.1:7789/mcp
+sonicproof mcp --http --port 7789
+```
+
+Other clients take the same command in their JSON config (write out the absolute path of your cache):
+
+```json
+{ "mcpServers": { "sonicproof": {
+    "command": "uvx", "args": ["--from", "sonicproof[model]", "sonicproof", "mcp"],
+    "env": { "HF_HOME": "/Users/you/.cache/huggingface" } } } }
+```
+
+- **Why `HF_HOME`:** MCP clients start servers with a reduced environment. Passing it makes the server use
+  the same Hugging Face cache as your terminal, so the model is not downloaded a second time.
+- **Use absolute paths** in tool calls. A relative path resolves against the server's working directory, which
+  is usually not yours.
+- **HTTP mode** listens on `127.0.0.1` only and refuses requests from web pages on other sites, but it has no
+  authentication: any process on your machine can call it. Use stdio when that matters.
+- **Before the PyPI release**, run from a clone: `uv sync --extra model` inside it, then use
+  `uv run --project /absolute/path/to/sonicproof --extra model sonicproof mcp` as the server command
+  (`--project` keeps the caller's working directory; `--directory` would change it).
+
+**If you are an agent reading this repository:** install with `uv tool install "sonicproof[model]"` (or
+`uv sync --extra model` inside a clone and prefix commands with `uv run --project /absolute/path/to/sonicproof`),
+run `sonicproof doctor --load` once, then follow the skill (`sp skill show` prints it). Without MCP, every
+analysis command works from the shell with `--json` — `sp rank "prompt" a.wav b.wav --json`,
+`sp report take.wav "prompt" --json`, `sp qc *.wav --json`. Pass absolute local file paths; never play audio
+to "listen" — Sonicproof is your ears.
+
+**Agent skill** — the skill teaches an agent the loop that makes generated audio trustworthy: *generate
+several takes → rank them → check the best one → rephrase or reseed when nothing matches → deliver the pick
+with its scorecard*. It ships with the package:
+
+```bash
+sp skill install              # → ~/.claude/skills/sonicproof/SKILL.md
+sp skill install --project    # → ./.claude/skills/sonicproof/SKILL.md (this project only)
+sp skill show                 # print it, for agents that read skills from elsewhere
+```
+
+In a clone it lives at [`src/sonicproof/skill/SKILL.md`](https://github.com/kanaworksai-hue/sonicproof/blob/main/src/sonicproof/skill/SKILL.md).
+
+[`examples/stable_audio_loop.py`](https://github.com/kanaworksai-hue/sonicproof/blob/main/examples/stable_audio_loop.py) runs the same loop as a script, with one MCP
+client for a Stable Audio server and one for Sonicproof.
+
+## How to read a score
+
+Raw similarity between a prompt and a clip is not very informative — almost any caption scores about the same
+against any clip. Sonicproof turns it into a **calibrated score in σ** by asking two relative questions:
+
+1. **Clip side** — compared with ~440 everyday sound descriptions, how well does *your prompt* describe *this clip*?
+2. **Prompt side** — compared with a bank of 110 reference sounds, how much closer is *this clip* to *your prompt*?
+
+The two are averaged:
+
+| Verdict | Score | Meaning |
+|---|---|---|
+| **strong** | ≥ 2.0σ | clearly sounds like the prompt |
+| **plausible** | ≥ 1.1σ | sounds like the prompt |
+| **weak** | ≥ 0.3σ | only loosely matches |
+| **miss** | < 0.3σ | does not sound like the prompt |
+
+**Heard as** lists what the clip sounds most like; ✓ marks descriptions that agree with your prompt. When a
+verdict surprises you, that list usually explains why.
+
+### fit
+
+`fit` weighs two pieces of evidence, both calibrated the same way and read on the same verdict scale:
+
+- **direct** — how much closer is the picture to *this clip* than to the reference sounds?
+- **described** — the picture is first described in words (**Pictured as**), and the clip is checked against
+  those descriptions as if they were the prompt. Add your own words about the scene and they count too.
+
+**Pictured as** marks with ✓ what the clip also sounds like; **Heard as** marks what the picture also shows.
+When the fit is weak, Sonicproof suggests a prompt drawn from the picture — useful for regenerating.
+Videos are sampled at one frame per second (up to 32 frames, spread evenly over longer clips).
+
+### dedupe
+
+Two sounds can be close in meaning without being the same file — four seeds of the same prompt, say.
+`dedupe` therefore uses the embeddings only to find candidates, then compares the signals themselves
+(time-aligned spectral fingerprints), so it groups copies that differ in format, codec, level, sample rate,
+channel count or trimmed ends, and leaves different takes alone. In each group it keeps the best copy —
+lossless over lossy, not clipped, higher sample rate, more channels, longest — and says why.
+
+Sonicproof is a second opinion, not a judge: short, concrete prompts ("glass shattering") work better than long
+ones full of mixing notes, and very short transient sounds are the hardest to tell apart. Always listen
+before you ship.
+
+## Python
+
+```python
+from sonicproof.judge import Judge
+
+judge = Judge(vision=True)    # one model for everything; Judge() alone is lighter but can't see pictures
+result = judge.check("door.wav", "a creaky wooden door")
+print(result.verdict, result.score, [a.text for a in result.heard_as])
+
+fit = judge.fit("sizzle.wav", "kitchen.png", "image")
+print(fit.verdict, [a.text for a in fit.pictured_as])
+
+from sonicproof.library import Library, find_duplicates, search_text
+
+lib = Library("~/SFX")
+lib.update(lambda wave: judge.embedder.embed_audio([wave])[0])
+for hit in search_text(lib, judge, "rain on a tin roof"):
+    print(hit.path, hit.score, hit.verdict)
+```
+
+## Development
+
+```bash
+uv sync --extra model --group dev && uv run pytest
+cd web && npm ci && npm run dev             # UI with hot reload; proxies /api to `sp serve` on :7788
+npm run build                               # writes the bundled UI into src/sonicproof/web
+```
+
+UI strings live in `web/src/i18n/` (`en.ts`, `ja.ts`); the type checker makes sure both have the same keys.
+See [CONTRIBUTING.md](https://github.com/kanaworksai-hue/sonicproof/blob/main/CONTRIBUTING.md) for tests, linting and pull requests.
+
+## License
+
+Sonicproof is licensed under the [Apache License 2.0](https://github.com/kanaworksai-hue/sonicproof/blob/main/LICENSE) (see also [NOTICE](https://github.com/kanaworksai-hue/sonicproof/blob/main/NOTICE)). It downloads
+EmbeddingGemma 2 from Hugging Face on first run — the model is not bundled. The model is released by Google
+under Apache 2.0, and its model card asks that deployments follow the
+[Gemma Prohibited Use Policy](https://ai.google.dev/gemma/prohibited_use_policy).