cjm-vad-adapter-interface 0.0.2__py3-none-any.whl

cjm_vad_adapter_interface/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.2"

cjm_vad_adapter_interface/_modidx.py

@@ -0,0 +1,41 @@
+# Autogenerated by nbdev
+
+d = { 'settings': { 'branch': 'main',
+                'doc_baseurl': '/cjm-vad-adapter-interface',
+                'doc_host': 'https://cj-mills.github.io',
+                'git_url': 'https://github.com/cj-mills/cjm-vad-adapter-interface',
+                'lib_path': 'cjm_vad_adapter_interface'},
+  'syms': { 'cjm_vad_adapter_interface.adapter': { 'cjm_vad_adapter_interface.adapter.VADAdapter': ( 'adapter.html#vadadapter',
+                                                                                                     'cjm_vad_adapter_interface/adapter.py'),
+                                                   'cjm_vad_adapter_interface.adapter.VADAdapter.__init__': ( 'adapter.html#vadadapter.__init__',
+                                                                                                              'cjm_vad_adapter_interface/adapter.py'),
+                                                   'cjm_vad_adapter_interface.adapter.VADAdapter.detect_speech': ( 'adapter.html#vadadapter.detect_speech',
+                                                                                                                   'cjm_vad_adapter_interface/adapter.py'),
+                                                   'cjm_vad_adapter_interface.adapter.VADToolProtocol': ( 'adapter.html#vadtoolprotocol',
+                                                                                                          'cjm_vad_adapter_interface/adapter.py'),
+                                                   'cjm_vad_adapter_interface.adapter.VADToolProtocol.detect_speech': ( 'adapter.html#vadtoolprotocol.detect_speech',
+                                                                                                                        'cjm_vad_adapter_interface/adapter.py'),
+                                                   'cjm_vad_adapter_interface.adapter.VADToolProtocol.get_current_config': ( 'adapter.html#vadtoolprotocol.get_current_config',
+                                                                                                                             'cjm_vad_adapter_interface/adapter.py')},
+            'cjm_vad_adapter_interface.generic': { 'cjm_vad_adapter_interface.generic.GenericVADAdapter': ( 'generic.html#genericvadadapter',
+                                                                                                            'cjm_vad_adapter_interface/generic.py'),
+                                                   'cjm_vad_adapter_interface.generic.GenericVADAdapter._get_storage': ( 'generic.html#genericvadadapter._get_storage',
+                                                                                                                         'cjm_vad_adapter_interface/generic.py'),
+                                                   'cjm_vad_adapter_interface.generic.GenericVADAdapter.detect_speech': ( 'generic.html#genericvadadapter.detect_speech',
+                                                                                                                          'cjm_vad_adapter_interface/generic.py')},
+            'cjm_vad_adapter_interface.storage': { 'cjm_vad_adapter_interface.storage.VADRow': ( 'storage.html#vadrow',
+                                                                                                 'cjm_vad_adapter_interface/storage.py'),
+                                                   'cjm_vad_adapter_interface.storage.VADStorage': ( 'storage.html#vadstorage',
+                                                                                                     'cjm_vad_adapter_interface/storage.py'),
+                                                   'cjm_vad_adapter_interface.storage.VADStorage.__init__': ( 'storage.html#vadstorage.__init__',
+                                                                                                              'cjm_vad_adapter_interface/storage.py'),
+                                                   'cjm_vad_adapter_interface.storage.VADStorage.get_cached': ( 'storage.html#vadstorage.get_cached',
+                                                                                                                'cjm_vad_adapter_interface/storage.py'),
+                                                   'cjm_vad_adapter_interface.storage.VADStorage.list_jobs': ( 'storage.html#vadstorage.list_jobs',
+                                                                                                               'cjm_vad_adapter_interface/storage.py'),
+                                                   'cjm_vad_adapter_interface.storage.VADStorage.save': ( 'storage.html#vadstorage.save',
+                                                                                                          'cjm_vad_adapter_interface/storage.py'),
+                                                   'cjm_vad_adapter_interface.storage.VADStorage.save_with_logging': ( 'storage.html#vadstorage.save_with_logging',
+                                                                                                                       'cjm_vad_adapter_interface/storage.py'),
+                                                   'cjm_vad_adapter_interface.storage.VADStorage.verify_file': ( 'storage.html#vadstorage.verify_file',
+                                                                                                                 'cjm_vad_adapter_interface/storage.py')}}}

cjm_vad_adapter_interface/adapter.py

@@ -0,0 +1,71 @@
+"""The typed voice-activity-detection task contract — the `VADAdapter` ABC + the `VADToolProtocol` structural contract (capability-unit Option C, pass-2 Thread 3).
+
+Docs: https://cj-mills.github.io/cjm-vad-adapter-interfaceadapter.html.md"""
+
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/adapter.ipynb.
+
+# %% auto #0
+__all__ = ['VADToolProtocol', 'VADAdapter']
+
+# %% ../nbs/adapter.ipynb #a7b39b97
+from abc import abstractmethod
+from pathlib import Path
+from typing import Any, ClassVar, Dict, Protocol, Union, runtime_checkable
+
+from cjm_plugin_system.core.adapter import TaskAdapter
+
+# Canonical home (stage 8 / PILLAR 1c): the data noun lives in
+# cjm-capability-primitives, so the pure-compute tool depends on it, never on
+# this adapter machinery.
+from cjm_capability_primitives.vad import VADResult
+
+# %% ../nbs/adapter.ipynb #edacb217
+@runtime_checkable
+class VADToolProtocol(Protocol):
+    """Structural contract for voice-activity-detection tool capabilities
+    (born-final at stage 8 — derived from the native tool surface).
+
+    Pure compute: `detect_speech` reads the model-ready audio + runs inference +
+    builds the typed result. `get_current_config` supplies the effective config
+    the generic adapter hashes for its cache key. Persistence is NOT here — the
+    adapter owns it (the native-surface seam)."""
+    def detect_speech(self, audio: Union[str, Path], **kwargs) -> VADResult: ...
+    def get_current_config(self) -> Dict[str, Any]: ...
+
+# %% ../nbs/adapter.ipynb #9c358302
+class VADAdapter(TaskAdapter):
+    """Typed voice-activity-detection task adapter: model-ready audio in,
+    `VADResult` out.
+
+    Input contract: the caller guarantees MODEL-READY audio — format /
+    sample-rate / channel handling happens upstream (ffmpeg `convert`), never
+    in the adapter or tool.
+
+    Native-surface model (stage 8 / PILLAR 1c): the TOOL is pure compute; the
+    ADAPTER owns the cache + persistence bookends (see `GenericVADAdapter`) +
+    the per-call `force` control. Storage resolves from the substrate-injected
+    `PLUGIN_DATA_DIR`; `db_path` is not on the tool protocol.
+
+    Implementations run in-worker beside their tool capability and are
+    constructed with the bound tool instance: `AdapterClass(tool)` (mirrors
+    `GraphStorageAdapter`). The result DTO is wire-registered ("vad.result"):
+    returned values cross the worker boundary typed.
+    """
+
+    task_name: ClassVar[str] = "vad"
+    required_tool_protocol: ClassVar[type] = VADToolProtocol
+
+    def __init__(
+        self,
+        tool: VADToolProtocol,  # The bound tool capability instance (worker-side binding)
+    ):
+        self.tool = tool
+
+    @abstractmethod
+    def detect_speech(
+        self,
+        audio: Union[str, Path],  # Path to MODEL-READY audio (converted upstream)
+        **kwargs,                 # Provenance + tool options
+    ) -> VADResult:               # Typed VAD output
+        """Detect speech segments in model-ready audio."""
+        ...

cjm_vad_adapter_interface/generic.py

@@ -0,0 +1,80 @@
+"""The generic (tool-agnostic) VAD adapter — cache-check, invoke the bound tool's pure-compute `detect_speech`, persist. Reused across every tool capability satisfying `VADToolProtocol`, exactly as `GenericTranscriptionAdapter` is reused across transcribers.
+
+Docs: https://cj-mills.github.io/cjm-vad-adapter-interfacegeneric.html.md"""
+
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/generic.ipynb.
+
+# %% auto #0
+__all__ = ['GenericVADAdapter']
+
+# %% ../nbs/generic.ipynb #81d6c059
+import os
+from pathlib import Path
+from typing import Union
+
+from cjm_plugin_system.core.wire import get_call_envelope
+from cjm_plugin_system.utils.hashing import hash_file, hash_dict_canonical
+
+from cjm_capability_primitives.vad import VADResult, TimeRange
+from .adapter import VADAdapter
+from .storage import VADStorage
+
+# %% ../nbs/generic.ipynb #a11b0d2b
+class GenericVADAdapter(VADAdapter):
+    """Generic VAD adapter: cache-check -> pure-compute tool -> persist.
+
+    Works against ANY tool satisfying `VADToolProtocol`. The bookends:
+
+      1. cache check (file_path + file_hash + config_hash) BEFORE invoking the
+         tool, so a hit never loads the model;
+      2. the tool's pure-compute `detect_speech` on a miss / forced call;
+      3. `save_with_logging` (upsert by file_path + config_hash).
+
+    `config_hash` reuses `hash_dict_canonical(get_current_config())` (the SAME
+    canonical hash the fused-era plugin used). `force` rides
+    `CallEnvelope.control` (not a task kwarg, keeping `detect_speech(audio)`
+    pure). Storage lives at `<PLUGIN_DATA_DIR>/vad.db`; the substrate injects
+    the per-capability `PLUGIN_DATA_DIR` at spawn, so the adapter neither
+    hard-codes a path nor asks the tool for one.
+    """
+
+    def _get_storage(self) -> VADStorage:
+        """Lazily open the per-capability cache DB under the substrate-injected
+        PLUGIN_DATA_DIR (created at worker spawn)."""
+        if getattr(self, "_storage", None) is None:
+            db_path = os.path.join(os.environ["PLUGIN_DATA_DIR"], "vad.db")
+            self._storage = VADStorage(db_path)
+        return self._storage
+
+    def detect_speech(
+        self,
+        audio: Union[str, Path],  # Path to MODEL-READY audio (converted upstream)
+        **kwargs,                 # Provenance + tool options
+    ) -> VADResult:               # Typed VAD output
+        """Cache-check, invoke the bound tool's pure-compute `detect_speech`, persist."""
+        file_path = str(audio)
+        file_hash = hash_file(file_path)
+        config_hash = hash_dict_canonical(self.tool.get_current_config())
+
+        env = get_call_envelope()
+        force = bool(env.control.get("force")) if env is not None else False
+
+        storage = self._get_storage()
+        if not force:
+            cached = storage.get_cached(file_path, file_hash, config_hash)
+            if cached is not None:
+                return VADResult(
+                    ranges=[TimeRange(**r) for r in (cached.ranges or [])],
+                    metadata=cached.metadata or {},
+                )
+
+        # Pure compute on the tool (cache miss / forced).
+        result = self.tool.detect_speech(audio, **kwargs)
+
+        # Persist. Content-addressed row (no job_id); cache key is
+        # (file_path, config_hash) with file_hash for content-correctness.
+        storage.save_with_logging(
+            file_path=file_path, file_hash=file_hash, config_hash=config_hash,
+            ranges=[r.to_dict() for r in result.ranges], metadata=result.metadata,
+        )
+        return result

cjm_vad_adapter_interface/storage.py

@@ -0,0 +1,202 @@
+"""Standardized SQLite storage for voice-activity-detection results with content hashing.
+
+Docs: https://cj-mills.github.io/cjm-vad-adapter-interfacestorage.html.md"""
+
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/storage.ipynb.
+
+# %% auto #0
+__all__ = ['VADRow', 'VADStorage']
+
+# %% ../nbs/storage.ipynb #80a9ba21
+import json
+import logging
+import sqlite3
+import time
+from dataclasses import dataclass
+from typing import Any, Dict, List, Optional
+
+from cjm_plugin_system.utils.hashing import hash_file
+# CR-14 follow-up: storage events are substrate-family accounts. The helpers
+# below RECORD them (no-op outside a worker call span); the host journals
+# them off the response header with worker_reported=True.
+from cjm_plugin_system.core.journal_store import SubstrateEventType
+from cjm_plugin_system.core.wire import record_account
+
+# %% ../nbs/storage.ipynb #f4d22588
+@dataclass
+class VADRow:
+    """A single row from the vad_results table."""
+    file_path: str       # Path to the analyzed (model-ready) audio file
+    file_hash: str       # Hash of the analyzed file in "algo:hexdigest" format
+    config_hash: str     # Hash of the VAD detection config used
+    ranges: Optional[List[Dict[str, Any]]] = None  # Detected speech segments (serialized TimeRanges)
+    metadata: Optional[Dict[str, Any]] = None       # VAD metadata
+    created_at: Optional[float] = None               # Unix timestamp
+
+# %% ../nbs/storage.ipynb #b11a2421
+class VADStorage:
+    """Standardized SQLite storage for voice-activity-detection results."""
+
+    SCHEMA = """
+        CREATE TABLE IF NOT EXISTS vad_results (
+            id INTEGER PRIMARY KEY AUTOINCREMENT,
+            file_path TEXT NOT NULL,
+            file_hash TEXT NOT NULL,
+            config_hash TEXT NOT NULL,
+            ranges JSON,
+            metadata JSON,
+            created_at REAL NOT NULL,
+            UNIQUE(file_path, config_hash)
+        )
+    """
+
+    INDEX = "CREATE INDEX IF NOT EXISTS idx_vad_file_path ON vad_results(file_path);"
+
+    def __init__(
+        self,
+        db_path: str  # Absolute path to the SQLite database file
+    ):
+        """Initialize storage and create table if needed."""
+        self.db_path = db_path
+        with sqlite3.connect(self.db_path) as con:
+            con.execute(self.SCHEMA)
+            con.execute(self.INDEX)
+
+    def save(
+        self,
+        file_path: str,     # Path to the analyzed audio file
+        file_hash: str,     # Hash of the analyzed file in "algo:hexdigest" format
+        config_hash: str,   # Hash of the VAD detection config
+        ranges: Optional[List[Dict[str, Any]]] = None,  # Detected speech segments
+        metadata: Optional[Dict[str, Any]] = None        # VAD metadata
+    ) -> None:
+        """Save or replace a VAD result (upsert by file_path + config_hash)."""
+        with sqlite3.connect(self.db_path) as con:
+            con.execute(
+                """INSERT OR REPLACE INTO vad_results
+                   (file_path, file_hash, config_hash, ranges, metadata, created_at)
+                   VALUES (?, ?, ?, ?, ?, ?)""",
+                (
+                    file_path,
+                    file_hash,
+                    config_hash,
+                    json.dumps(ranges) if ranges else None,
+                    json.dumps(metadata) if metadata else None,
+                    time.time()
+                )
+            )
+
+    def save_with_logging(
+        self,
+        *,
+        file_path: str,     # Path to the analyzed audio file
+        file_hash: str,     # Hash of the analyzed file in "algo:hexdigest" format
+        config_hash: str,   # Hash of the VAD detection config
+        ranges: Optional[List[Dict[str, Any]]] = None,  # Detected speech segments
+        metadata: Optional[Dict[str, Any]] = None,       # VAD metadata
+        logger: Optional[logging.Logger] = None           # Optional logger for success/failure messages
+    ) -> bool:  # True if saved; False if the save failed (error logged, not raised)
+        """Save a result, logging success/failure. Failures are logged and swallowed (returns False).
+
+        CR-14 follow-up: records a RESULT_SAVED account either way (ok flag +
+        file/config references — the journal never carries content) so saves AND
+        swallowed save-failures become auditable journal rows."""
+        try:
+            self.save(
+                file_path=file_path,
+                file_hash=file_hash,
+                config_hash=config_hash,
+                ranges=ranges,
+                metadata=metadata,
+            )
+            record_account(SubstrateEventType.RESULT_SAVED.value, {
+                "ok": True, "file_path": file_path, "file_hash": file_hash,
+                "config_hash": config_hash,
+            })
+            if logger:
+                logger.info(f"Saved VAD result to DB ({file_path})")
+            return True
+        except Exception as e:
+            record_account(SubstrateEventType.RESULT_SAVED.value, {
+                "ok": False, "file_path": file_path, "file_hash": file_hash,
+                "config_hash": config_hash, "error": str(e),
+            })
+            if logger:
+                logger.error(f"Failed to save to DB: {e}")
+            return False
+
+    def get_cached(
+        self,
+        file_path: str,   # Path to the audio file
+        file_hash: str,   # Content hash of the file (cache miss if the file changed)
+        config_hash: str  # Config hash to match
+    ) -> Optional[VADRow]:  # Cached row or None
+        """Retrieve a content-correct cached VAD result.
+
+        Matches on file_path + file_hash + config_hash, so a changed file (new
+        file_hash) misses the cache even though a stale row may still exist at the
+        same (file_path, config_hash) — the next save() replaces it.
+
+        CR-14 follow-up: a hit records a CACHE_HIT account (the cache-serving
+        decision is an account-of-action)."""
+        with sqlite3.connect(self.db_path) as con:
+            cur = con.execute(
+                """SELECT file_path, file_hash, config_hash, ranges, metadata, created_at
+                   FROM vad_results WHERE file_path = ? AND file_hash = ? AND config_hash = ?""",
+                (file_path, file_hash, config_hash)
+            )
+            row = cur.fetchone()
+            if not row:
+                return None
+            record_account(SubstrateEventType.CACHE_HIT.value, {
+                "file_path": file_path, "file_hash": file_hash,
+                "config_hash": config_hash,
+            })
+            return VADRow(
+                file_path=row[0],
+                file_hash=row[1],
+                config_hash=row[2],
+                ranges=json.loads(row[3]) if row[3] else None,
+                metadata=json.loads(row[4]) if row[4] else None,
+                created_at=row[5]
+            )
+
+    def list_jobs(
+        self,
+        limit: int = 100  # Maximum number of rows to return
+    ) -> List[VADRow]:  # List of VAD rows
+        """List VAD results ordered by creation time (newest first)."""
+        results = []
+        with sqlite3.connect(self.db_path) as con:
+            cur = con.execute(
+                """SELECT file_path, file_hash, config_hash, ranges, metadata, created_at
+                   FROM vad_results ORDER BY created_at DESC LIMIT ?""",
+                (limit,)
+            )
+            for row in cur:
+                results.append(VADRow(
+                    file_path=row[0],
+                    file_hash=row[1],
+                    config_hash=row[2],
+                    ranges=json.loads(row[3]) if row[3] else None,
+                    metadata=json.loads(row[4]) if row[4] else None,
+                    created_at=row[5]
+                ))
+        return results
+
+    def verify_file(
+        self,
+        file_path: str,   # Path to the audio file
+        config_hash: str  # Config hash to look up
+    ) -> Optional[bool]:  # True if file matches, False if changed, None if not found
+        """Verify the analyzed file still matches the hash stored for (file_path, config_hash)."""
+        with sqlite3.connect(self.db_path) as con:
+            cur = con.execute(
+                """SELECT file_hash FROM vad_results
+                   WHERE file_path = ? AND config_hash = ?""",
+                (file_path, config_hash)
+            )
+            row = cur.fetchone()
+        if not row:
+            return None
+        return hash_file(file_path) == row[0]

cjm_vad_adapter_interface-0.0.2.dist-info/METADATA

@@ -0,0 +1,276 @@
+Metadata-Version: 2.4
+Name: cjm-vad-adapter-interface
+Version: 0.0.2
+Summary: Typed voice-activity-detection task-adapter interface — VADAdapter ABC + GenericVADAdapter (cache/persist bookends around a pure-compute tool), the VADToolProtocol, and VAD persistence helpers. The VADResult data noun lives in cjm-capability-primitives.
+Author-email: "Christian J. Mills" <9126128+cj-mills@users.noreply.github.com>
+License: Apache-2.0
+Project-URL: Repository, https://github.com/cj-mills/cjm-vad-adapter-interface
+Project-URL: Documentation, https://cj-mills.github.io/cjm-vad-adapter-interface/
+Keywords: nbdev
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cjm_plugin_system>=0.0.46
+Requires-Dist: cjm_capability_primitives>=0.0.3
+Dynamic: license-file
+
+# cjm-vad-adapter-interface
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## Install
+
+``` bash
+pip install cjm_vad_adapter_interface
+```
+
+## Project Structure
+
+    nbs/
+    ├── adapter.ipynb # The typed voice-activity-detection task contract — the `VADAdapter` ABC + the `VADToolProtocol` structural contract (capability-unit Option C, pass-2 Thread 3).
+    ├── generic.ipynb # The generic (tool-agnostic) VAD adapter — cache-check, invoke the bound tool's pure-compute `detect_speech`, persist. Reused across every tool capability satisfying `VADToolProtocol`, exactly as `GenericTranscriptionAdapter` is reused across transcribers.
+    └── storage.ipynb # Standardized SQLite storage for voice-activity-detection results with content hashing.
+
+Total: 3 notebooks
+
+## Module Dependencies
+
+``` mermaid
+graph LR
+    adapter["adapter<br/>VAD Adapter"]
+    generic["generic<br/>Generic VAD Adapter"]
+    storage["storage<br/>VAD Storage"]
+
+    generic --> adapter
+    generic --> storage
+```
+
+*2 cross-module dependencies detected*
+
+## CLI Reference
+
+No CLI commands found in this project.
+
+## Module Overview
+
+Detailed documentation for each module in the project:
+
+### VAD Adapter (`adapter.ipynb`)
+
+> The typed voice-activity-detection task contract — the `VADAdapter`
+> ABC + the `VADToolProtocol` structural contract (capability-unit
+> Option C, pass-2 Thread 3).
+
+#### Import
+
+``` python
+from cjm_vad_adapter_interface.adapter import (
+    VADToolProtocol,
+    VADAdapter
+)
+```
+
+#### Classes
+
+``` python
+@runtime_checkable
+class VADToolProtocol(Protocol):
+    """
+    Structural contract for voice-activity-detection tool capabilities
+    (born-final at stage 8 — derived from the native tool surface).
+    
+    Pure compute: `detect_speech` reads the model-ready audio + runs inference +
+    builds the typed result. `get_current_config` supplies the effective config
+    the generic adapter hashes for its cache key. Persistence is NOT here — the
+    adapter owns it (the native-surface seam).
+    """
+    
+    def detect_speech(self, audio: Union[str, Path], **kwargs) -> VADResult: ...
+        def get_current_config(self) -> Dict[str, Any]: ...
+    
+    def get_current_config(self) -> Dict[str, Any]: ...
+```
+
+``` python
+class VADAdapter:
+    def __init__(
+        self,
+        tool: VADToolProtocol,  # The bound tool capability instance (worker-side binding)
+    )
+    """
+    Typed voice-activity-detection task adapter: model-ready audio in,
+    `VADResult` out.
+    
+    Input contract: the caller guarantees MODEL-READY audio — format /
+    sample-rate / channel handling happens upstream (ffmpeg `convert`), never
+    in the adapter or tool.
+    
+    Native-surface model (stage 8 / PILLAR 1c): the TOOL is pure compute; the
+    ADAPTER owns the cache + persistence bookends (see `GenericVADAdapter`) +
+    the per-call `force` control. Storage resolves from the substrate-injected
+    `PLUGIN_DATA_DIR`; `db_path` is not on the tool protocol.
+    
+    Implementations run in-worker beside their tool capability and are
+    constructed with the bound tool instance: `AdapterClass(tool)` (mirrors
+    `GraphStorageAdapter`). The result DTO is wire-registered ("vad.result"):
+    returned values cross the worker boundary typed.
+    """
+    
+    def __init__(
+            self,
+            tool: VADToolProtocol,  # The bound tool capability instance (worker-side binding)
+        )
+    
+    def detect_speech(
+            self,
+            audio: Union[str, Path],  # Path to MODEL-READY audio (converted upstream)
+            **kwargs,                 # Provenance + tool options
+        ) -> VADResult:               # Typed VAD output
+        "Detect speech segments in model-ready audio."
+```
+
+### Generic VAD Adapter (`generic.ipynb`)
+
+> The generic (tool-agnostic) VAD adapter — cache-check, invoke the
+> bound tool’s pure-compute `detect_speech`, persist. Reused across
+> every tool capability satisfying `VADToolProtocol`, exactly as
+> `GenericTranscriptionAdapter` is reused across transcribers.
+
+#### Import
+
+``` python
+from cjm_vad_adapter_interface.generic import (
+    GenericVADAdapter
+)
+```
+
+#### Classes
+
+``` python
+class GenericVADAdapter(VADAdapter):
+    """
+    Generic VAD adapter: cache-check -> pure-compute tool -> persist.
+    
+    Works against ANY tool satisfying `VADToolProtocol`. The bookends:
+    
+      1. cache check (file_path + file_hash + config_hash) BEFORE invoking the
+         tool, so a hit never loads the model;
+      2. the tool's pure-compute `detect_speech` on a miss / forced call;
+      3. `save_with_logging` (upsert by file_path + config_hash).
+    
+    `config_hash` reuses `hash_dict_canonical(get_current_config())` (the SAME
+    canonical hash the fused-era plugin used). `force` rides
+    `CallEnvelope.control` (not a task kwarg, keeping `detect_speech(audio)`
+    pure). Storage lives at `<PLUGIN_DATA_DIR>/vad.db`; the substrate injects
+    the per-capability `PLUGIN_DATA_DIR` at spawn, so the adapter neither
+    hard-codes a path nor asks the tool for one.
+    """
+    
+    def detect_speech(
+            self,
+            audio: Union[str, Path],  # Path to MODEL-READY audio (converted upstream)
+            **kwargs,                 # Provenance + tool options
+        ) -> VADResult:               # Typed VAD output
+        "Cache-check, invoke the bound tool's pure-compute `detect_speech`, persist."
+```
+
+### VAD Storage (`storage.ipynb`)
+
+> Standardized SQLite storage for voice-activity-detection results with
+> content hashing.
+
+#### Import
+
+``` python
+from cjm_vad_adapter_interface.storage import (
+    VADRow,
+    VADStorage
+)
+```
+
+#### Classes
+
+``` python
+@dataclass
+class VADRow:
+    "A single row from the vad_results table."
+    
+    file_path: str  # Path to the analyzed (model-ready) audio file
+    file_hash: str  # Hash of the analyzed file in "algo:hexdigest" format
+    config_hash: str  # Hash of the VAD detection config used
+    ranges: Optional[List[Dict[str, Any]]]  # Detected speech segments (serialized TimeRanges)
+    metadata: Optional[Dict[str, Any]]  # VAD metadata
+    created_at: Optional[float]  # Unix timestamp
+```
+
+``` python
+class VADStorage:
+    def __init__(
+        self,
+        db_path: str  # Absolute path to the SQLite database file
+    )
+    "Standardized SQLite storage for voice-activity-detection results."
+    
+    def __init__(
+            self,
+            db_path: str  # Absolute path to the SQLite database file
+        )
+        "Initialize storage and create table if needed."
+    
+    def save(
+            self,
+            file_path: str,     # Path to the analyzed audio file
+            file_hash: str,     # Hash of the analyzed file in "algo:hexdigest" format
+            config_hash: str,   # Hash of the VAD detection config
+            ranges: Optional[List[Dict[str, Any]]] = None,  # Detected speech segments
+            metadata: Optional[Dict[str, Any]] = None        # VAD metadata
+        ) -> None
+        "Save or replace a VAD result (upsert by file_path + config_hash)."
+    
+    def save_with_logging(
+            self,
+            *,
+            file_path: str,     # Path to the analyzed audio file
+            file_hash: str,     # Hash of the analyzed file in "algo:hexdigest" format
+            config_hash: str,   # Hash of the VAD detection config
+            ranges: Optional[List[Dict[str, Any]]] = None,  # Detected speech segments
+            metadata: Optional[Dict[str, Any]] = None,       # VAD metadata
+            logger: Optional[logging.Logger] = None           # Optional logger for success/failure messages
+        ) -> bool:  # True if saved; False if the save failed (error logged, not raised)
+        "Save a result, logging success/failure. Failures are logged and swallowed (returns False).
+
+CR-14 follow-up: records a RESULT_SAVED account either way (ok flag +
+file/config references — the journal never carries content) so saves AND
+swallowed save-failures become auditable journal rows."
+    
+    def get_cached(
+            self,
+            file_path: str,   # Path to the audio file
+            file_hash: str,   # Content hash of the file (cache miss if the file changed)
+            config_hash: str  # Config hash to match
+        ) -> Optional[VADRow]:  # Cached row or None
+        "Retrieve a content-correct cached VAD result.
+
+Matches on file_path + file_hash + config_hash, so a changed file (new
+file_hash) misses the cache even though a stale row may still exist at the
+same (file_path, config_hash) — the next save() replaces it.
+
+CR-14 follow-up: a hit records a CACHE_HIT account (the cache-serving
+decision is an account-of-action)."
+    
+    def list_jobs(
+            self,
+            limit: int = 100  # Maximum number of rows to return
+        ) -> List[VADRow]:  # List of VAD rows
+        "List VAD results ordered by creation time (newest first)."
+    
+    def verify_file(
+            self,
+            file_path: str,   # Path to the audio file
+            config_hash: str  # Config hash to look up
+        ) -> Optional[bool]:  # True if file matches, False if changed, None if not found
+        "Verify the analyzed file still matches the hash stored for (file_path, config_hash)."
+```

cjm_vad_adapter_interface-0.0.2.dist-info/RECORD

@@ -0,0 +1,11 @@
+cjm_vad_adapter_interface/__init__.py,sha256=QvlVh4JTl3JL7jQAja76yKtT-IvF4631ASjWY1wS6AQ,22
+cjm_vad_adapter_interface/_modidx.py,sha256=iinf7Q-Nl57nr8ntxOlyUd1PJLa7LD5COIwn_DOsb18,5459
+cjm_vad_adapter_interface/adapter.py,sha256=_gSHnymILAg4PKdESs0zRM5kG76iaK2b3xjKtQc5vIM,2987
+cjm_vad_adapter_interface/generic.py,sha256=xf9c7F5O7qblB8kTYLpUFwIY-586lgD-RJe5BDEOavc,3530
+cjm_vad_adapter_interface/storage.py,sha256=HGfV6kDsvTrMDyUI11TDqrAmg6htXuxiwrxYUBCmMyE,8444
+cjm_vad_adapter_interface-0.0.2.dist-info/licenses/LICENSE,sha256=xV8xoN4VOL0uw9X8RSs2IMuD_Ss_a9yAbtGNeBWZwnw,11337
+cjm_vad_adapter_interface-0.0.2.dist-info/METADATA,sha256=59uwvqM1rVnigLP_KVqK5w6zx4graeF9JkxmYC8oNmQ,10172
+cjm_vad_adapter_interface-0.0.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+cjm_vad_adapter_interface-0.0.2.dist-info/entry_points.txt,sha256=GQMGeeaMpvhurqAf0_YAvBOcPvCt68mulFT6LTDG5F4,72
+cjm_vad_adapter_interface-0.0.2.dist-info/top_level.txt,sha256=RiHRnpS0UJUNYsKvGcwtCYv0-WafF84rVofUIo00p6I,26
+cjm_vad_adapter_interface-0.0.2.dist-info/RECORD,,

cjm_vad_adapter_interface-0.0.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

cjm_vad_adapter_interface-0.0.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[nbdev]
+cjm_vad_adapter_interface = cjm_vad_adapter_interface._modidx:d

cjm_vad_adapter_interface-0.0.2.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2022, fastai
+
+   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.

cjm_vad_adapter_interface-0.0.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+cjm_vad_adapter_interface