vocaloid-integrity-check 1.0.0__tar.gz

vocaloid_integrity_check-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 vocaloid-integrity-check contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

vocaloid_integrity_check-1.0.0/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: vocaloid-integrity-check
+Version: 1.0.0
+Summary: Check the integrity of a Vocaloid voicebank by verifying the name digest in its .ddi index
+Author: vocaloid-integrity-check contributors
+License: MIT
+Project-URL: Homepage, https://github.com/Vsynth-Tools/vocaloid-integrity-check
+Project-URL: Issues, https://github.com/Vsynth-Tools/vocaloid-integrity-check/issues
+Keywords: vocaloid,voicebank,ddi,ddb,integrity,md5
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Security
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# vocaloid-integrity-check
+
+Check a Vocaloid voicebank when you’re concerned that it may be corrupted or was renamed.
+
+Standard library only. Python 3.10+.
+
+## Install
+
+```console
+$ pip install vocaloid-integrity-check
+```
+
+## Usage
+
+```console
+$ vocaloid-integrity-check Yuki.ddi --ddb Yuki.ddb
+hash verified
+  name   : Yuki  (root ARR4)
+  stored : 92942a5a960cdf938b3d742d8a75f5df
+  expect : 92942a5a960cdf938b3d742d8a75f5df
+```
+
+`--json` prints machine-readable output. If `--ddb` is omitted, the `.ddi` filename is used.
+
+## Results
+
+- `hash verified` — the check succeeded.
+- `hash fail` — the check found a mismatch.
+- `hash present, not checkable` — a value is present, but cannot be judged from the files alone (Vocaloid 3/4).
+- `hash not present` — no value was found.
+- `hash not verifiable` — the name cannot be checked in the current environment.
+
+Exit status: `0` verified, `1` fail, `2` inconclusive or invalid input.
+
+Vocaloid 2 banks are checked. Vocaloid 3/4 banks are recognized, but reported as not checkable rather than verified or failed.
+
+## Notes
+
+This is an integrity check, not an authenticity check. `unity-chan_for_Unity` is a known exception; treat a mismatch for it as unknown.
+
+## License
+
+MIT.

vocaloid_integrity_check-1.0.0/README.md

@@ -0,0 +1,43 @@
+# vocaloid-integrity-check
+
+Check a Vocaloid voicebank when you’re concerned that it may be corrupted or was renamed.
+
+Standard library only. Python 3.10+.
+
+## Install
+
+```console
+$ pip install vocaloid-integrity-check
+```
+
+## Usage
+
+```console
+$ vocaloid-integrity-check Yuki.ddi --ddb Yuki.ddb
+hash verified
+  name   : Yuki  (root ARR4)
+  stored : 92942a5a960cdf938b3d742d8a75f5df
+  expect : 92942a5a960cdf938b3d742d8a75f5df
+```
+
+`--json` prints machine-readable output. If `--ddb` is omitted, the `.ddi` filename is used.
+
+## Results
+
+- `hash verified` — the check succeeded.
+- `hash fail` — the check found a mismatch.
+- `hash present, not checkable` — a value is present, but cannot be judged from the files alone (Vocaloid 3/4).
+- `hash not present` — no value was found.
+- `hash not verifiable` — the name cannot be checked in the current environment.
+
+Exit status: `0` verified, `1` fail, `2` inconclusive or invalid input.
+
+Vocaloid 2 banks are checked. Vocaloid 3/4 banks are recognized, but reported as not checkable rather than verified or failed.
+
+## Notes
+
+This is an integrity check, not an authenticity check. `unity-chan_for_Unity` is a known exception; treat a mismatch for it as unknown.
+
+## License
+
+MIT.

vocaloid_integrity_check-1.0.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vocaloid-integrity-check"
+version = "1.0.0"
+description = "Check the integrity of a Vocaloid voicebank by verifying the name digest in its .ddi index"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+authors = [{ name = "vocaloid-integrity-check contributors" }]
+keywords = ["vocaloid", "voicebank", "ddi", "ddb", "integrity", "md5"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: End Users/Desktop",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Multimedia :: Sound/Audio",
+    "Topic :: Security",
+]
+
+[project.urls]
+Homepage = "https://github.com/Vsynth-Tools/vocaloid-integrity-check"
+Issues = "https://github.com/Vsynth-Tools/vocaloid-integrity-check/issues"
+
+[project.scripts]
+vocaloid-integrity-check = "vocaloid_integrity_check.cli:main"
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]

vocaloid_integrity_check-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vocaloid_integrity_check-1.0.0/src/vocaloid_integrity_check/__init__.py

@@ -0,0 +1,42 @@
+"""Vocaloid integrity checker.
+
+Locates and, where the scheme is known, verifies the name digest stored in a
+Vocaloid voicebank index (``.ddi``).
+"""
+
+from .checker import (
+    ABSENT,
+    BLOCK_LEN,
+    DIGEST_LEN,
+    FAIL,
+    PHDC_OFFSET,
+    SALTS,
+    UNCHECKED,
+    UNVERIFIABLE,
+    V3V4_PHDC_OFFSET,
+    VERIFIED,
+    check,
+    expected_digest,
+    locate_phdc,
+    read_digest,
+)
+
+__version__ = "1.0.0"
+
+__all__ = [
+    "check",
+    "expected_digest",
+    "locate_phdc",
+    "read_digest",
+    "SALTS",
+    "PHDC_OFFSET",
+    "V3V4_PHDC_OFFSET",
+    "BLOCK_LEN",
+    "DIGEST_LEN",
+    "VERIFIED",
+    "FAIL",
+    "ABSENT",
+    "UNVERIFIABLE",
+    "UNCHECKED",
+    "__version__",
+]

vocaloid_integrity_check-1.0.0/src/vocaloid_integrity_check/__main__.py

@@ -0,0 +1,5 @@
+import sys
+
+from .cli import main
+
+sys.exit(main())

vocaloid_integrity_check-1.0.0/src/vocaloid_integrity_check/checker.py

@@ -0,0 +1,124 @@
+"""Core integrity check for Vocaloid voicebank indexes (``.ddi``)."""
+
+import hashlib
+import re
+import struct
+
+# Vocaloid 2 root tag -> (salt prefix, salt suffix) for the name digest.
+SALTS = {
+    b"ARR2": ("K2ho", "nF"),
+    b"ARR3": ("K2ho", "nF"),
+    b"ARR4": ("1m5Pj", "qFE"),
+}
+
+V3V4_ROOTS = {b"DBSe"}  # retail V3/V4 library
+DEV_ROOTS = {b"DBS "}   # development tree, deliberately unsupported
+
+PHDC_OFFSET = 0x18       # pos(8) + tag(4) + size(4) + flags(8)
+V3V4_PHDC_OFFSET = 0x1C  # as above plus a u32 version after the flags
+DIGEST_LEN = 32
+BLOCK_LEN = 260
+
+VERIFIED = "hash verified"
+FAIL = "hash fail"
+ABSENT = "hash not present"
+UNVERIFIABLE = "hash not verifiable"
+UNCHECKED = "hash present, not checkable"
+
+
+def expected_digest(stem, root):
+    """Return the expected digest for *stem* under *root*, or None if unknown."""
+    salts = SALTS.get(root)
+    if salts is None or not stem.isascii():
+        return None
+    return hashlib.md5(
+        (salts[0] + stem.upper() + salts[1]).encode("ascii")
+    ).hexdigest()
+
+
+def locate_phdc(data, offset=PHDC_OFFSET):
+    """Return (offset, size) of the PHDC chunk, or raise ValueError."""
+    if len(data) < offset + 8:
+        raise ValueError("file too short to contain a voicebank index")
+    if data[offset:offset + 4] != b"PHDC":
+        raise ValueError(
+            f"no PHDC chunk at {hex(offset)}; not a Vocaloid voicebank index"
+        )
+    size = struct.unpack("<I", data[offset + 4:offset + 8])[0]
+    if size < 12 or offset + size > len(data):
+        raise ValueError("PHDC size is invalid or runs past end of file")
+    return offset, size
+
+
+def read_digest(data):
+    """Return (root, stored digest or None, status note)."""
+    root = data[8:12]
+
+    if root in DEV_ROOTS:
+        return root, None, "development tree; not supported"
+    if root in V3V4_ROOTS:
+        off, size = locate_phdc(data, V3V4_PHDC_OFFSET)
+        block = data[off + size:off + size + BLOCK_LEN]
+        if len(block) < BLOCK_LEN:
+            return root, None, "Vocaloid 3/4 hash store is truncated"
+        return root, block[:DIGEST_LEN].decode("ascii", "replace"), ""
+
+    off, size = locate_phdc(data)
+    if root not in SALTS:
+        return root, None, "root has no digest block"
+    block = data[off + size:off + size + BLOCK_LEN]
+    if len(block) < BLOCK_LEN:
+        return root, None, "digest block truncated"
+    stored = block[:DIGEST_LEN]
+    if not re.fullmatch(rb"[0-9a-f]{32}", stored):
+        return root, None, "digest block is not lowercase hex"
+    return root, stored.decode("ascii"), ""
+
+
+def check(data, stem):
+    """Check *data* against the bank name *stem* and return a result dict."""
+    root, stored, note = read_digest(data)
+    root_name = root.decode("ascii", "replace")
+
+    if stored is None:
+        return {
+            "status": ABSENT,
+            "root": root_name,
+            "stem": stem,
+            "note": note,
+            "exit_code": 2,
+        }
+
+    # Vocaloid 3/4: the store is present and readable, but it is derived from the
+    # licence volume and the voice name, neither of which is recoverable from the
+    # index. Report the value; do not judge it.
+    if root in V3V4_ROOTS:
+        return {
+            "status": UNCHECKED,
+            "root": root_name,
+            "stem": stem,
+            "stored": stored,
+            "note": "Vocaloid 3/4 store is licence-derived; value reported, not judged",
+            "exit_code": 2,
+        }
+
+    computed = expected_digest(stem, root)
+    if computed is None:
+        return {
+            "status": UNVERIFIABLE,
+            "root": root_name,
+            "stem": stem,
+            "stored": stored,
+            "note": "non-ASCII name: expected digest depends on engine locale",
+            "exit_code": 2,
+        }
+    ok = computed == stored
+    return {
+        "status": VERIFIED if ok else FAIL,
+        "root": root_name,
+        "stem": stem,
+        "stored": stored,
+        "computed": computed,
+        "note": "" if ok else "digest does not match this name",
+        "exit_code": 0 if ok else 1,
+    }

vocaloid_integrity_check-1.0.0/src/vocaloid_integrity_check/cli.py

@@ -0,0 +1,44 @@
+"""Command-line interface for the Vocaloid integrity checker."""
+
+import argparse
+import json
+import ntpath
+import sys
+
+from .checker import check
+
+
+def main(argv=None):
+    parser = argparse.ArgumentParser(
+        prog="vocaloid-integrity-check",
+        description="Vocaloid integrity checker. Checks the integrity of a Vocaloid voicebank.",
+    )
+    parser.add_argument("ddi", help="path to the .ddi file")
+    parser.add_argument("--ddb", help="the .ddb filename or path in the same voicebank")
+    parser.add_argument("--json", action="store_true", help="output JSON")
+    args = parser.parse_args(argv)
+
+    stem = ntpath.splitext(ntpath.basename(args.ddb or args.ddi))[0]
+    try:
+        with open(args.ddi, "rb") as fh:
+            result = check(fh.read(), stem)
+    except (OSError, ValueError) as exc:
+        print(f"error: {exc}", file=sys.stderr)
+        return 2
+
+    if args.json:
+        print(json.dumps(result, indent=2))
+    else:
+        print(result["status"])
+        if result.get("stored"):
+            print(f'  name   : {result["stem"]}  (root {result["root"]})')
+            print(f'  stored : {result["stored"]}')
+        if result.get("computed"):
+            print(f'  expect : {result["computed"]}')
+        if result.get("note"):
+            print(f'  note   : {result["note"]}')
+    return result["exit_code"]
+
+
+if __name__ == "__main__":
+    sys.exit(main())

vocaloid_integrity_check-1.0.0/src/vocaloid_integrity_check.egg-info/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: vocaloid-integrity-check
+Version: 1.0.0
+Summary: Check the integrity of a Vocaloid voicebank by verifying the name digest in its .ddi index
+Author: vocaloid-integrity-check contributors
+License: MIT
+Project-URL: Homepage, https://github.com/Vsynth-Tools/vocaloid-integrity-check
+Project-URL: Issues, https://github.com/Vsynth-Tools/vocaloid-integrity-check/issues
+Keywords: vocaloid,voicebank,ddi,ddb,integrity,md5
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Security
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# vocaloid-integrity-check
+
+Check a Vocaloid voicebank when you’re concerned that it may be corrupted or was renamed.
+
+Standard library only. Python 3.10+.
+
+## Install
+
+```console
+$ pip install vocaloid-integrity-check
+```
+
+## Usage
+
+```console
+$ vocaloid-integrity-check Yuki.ddi --ddb Yuki.ddb
+hash verified
+  name   : Yuki  (root ARR4)
+  stored : 92942a5a960cdf938b3d742d8a75f5df
+  expect : 92942a5a960cdf938b3d742d8a75f5df
+```
+
+`--json` prints machine-readable output. If `--ddb` is omitted, the `.ddi` filename is used.
+
+## Results
+
+- `hash verified` — the check succeeded.
+- `hash fail` — the check found a mismatch.
+- `hash present, not checkable` — a value is present, but cannot be judged from the files alone (Vocaloid 3/4).
+- `hash not present` — no value was found.
+- `hash not verifiable` — the name cannot be checked in the current environment.
+
+Exit status: `0` verified, `1` fail, `2` inconclusive or invalid input.
+
+Vocaloid 2 banks are checked. Vocaloid 3/4 banks are recognized, but reported as not checkable rather than verified or failed.
+
+## Notes
+
+This is an integrity check, not an authenticity check. `unity-chan_for_Unity` is a known exception; treat a mismatch for it as unknown.
+
+## License
+
+MIT.

vocaloid_integrity_check-1.0.0/src/vocaloid_integrity_check.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+src/vocaloid_integrity_check/__init__.py
+src/vocaloid_integrity_check/__main__.py
+src/vocaloid_integrity_check/checker.py
+src/vocaloid_integrity_check/cli.py
+src/vocaloid_integrity_check.egg-info/PKG-INFO
+src/vocaloid_integrity_check.egg-info/SOURCES.txt
+src/vocaloid_integrity_check.egg-info/dependency_links.txt
+src/vocaloid_integrity_check.egg-info/entry_points.txt
+src/vocaloid_integrity_check.egg-info/top_level.txt

vocaloid_integrity_check-1.0.0/src/vocaloid_integrity_check.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

vocaloid_integrity_check-1.0.0/src/vocaloid_integrity_check.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+vocaloid-integrity-check = vocaloid_integrity_check.cli:main

vocaloid_integrity_check-1.0.0/src/vocaloid_integrity_check.egg-info/top_level.txt

@@ -0,0 +1 @@
+vocaloid_integrity_check