cjm-forced-alignment-adapter-interface 0.0.2__tar.gz

cjm_forced_alignment_adapter_interface-0.0.2/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_forced_alignment_adapter_interface-0.0.2/MANIFEST.in

@@ -0,0 +1,5 @@
+include pyproject.toml
+include LICENSE
+include CONTRIBUTING.md
+include README.md
+recursive-exclude * __pycache__

cjm_forced_alignment_adapter_interface-0.0.2/PKG-INFO

@@ -0,0 +1,271 @@
+Metadata-Version: 2.4
+Name: cjm-forced-alignment-adapter-interface
+Version: 0.0.2
+Summary: Typed forced-alignment task-adapter interface — ForcedAlignmentAdapter ABC, ForcedAlignResult/ForcedAlignItem wire DTOs, and forced-alignment persistence helpers.
+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-forced-alignment-adapter-interface
+Project-URL: Documentation, https://cj-mills.github.io/cjm-forced-alignment-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.40
+Dynamic: license-file
+
+# cjm-forced-alignment-adapter-interface
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## Install latest from the GitHub \[repository\]\[repo\]:
+
+``` bash
+pip install cjm_forced_alignment_adapter_interface
+```
+
+## Project Structure
+
+    nbs/
+    ├── adapter.ipynb # The typed forced-alignment task contract — `ForcedAlignmentAdapter` ABC +
+    ├── core.ipynb    # Standardized word-level forced-alignment DTOs — wire-registered so
+    └── storage.ipynb # Standardized SQLite storage for forced alignment results with content hashing
+
+Total: 3 notebooks
+
+## Module Dependencies
+
+``` mermaid
+graph LR
+    adapter["adapter<br/>Forced Alignment Adapter"]
+    core["core<br/>Core Data Structures"]
+    storage["storage<br/>Forced Alignment Storage"]
+
+    adapter --> core
+```
+
+*1 cross-module dependencies detected*
+
+## CLI Reference
+
+No CLI commands found in this project.
+
+## Module Overview
+
+Detailed documentation for each module in the project:
+
+### Forced Alignment Adapter (`adapter.ipynb`)
+
+> The typed forced-alignment task contract — `ForcedAlignmentAdapter`
+> ABC +
+
+#### Import
+
+``` python
+from cjm_forced_alignment_adapter_interface.adapter import (
+    ForcedAlignmentToolProtocol,
+    ForcedAlignmentAdapter
+)
+```
+
+#### Classes
+
+``` python
+@runtime_checkable
+class ForcedAlignmentToolProtocol(Protocol):
+    """
+    PROVISIONAL structural contract for forced-alignment-capable tools.
+    
+    Mirrors the fused-era surface (task-shaped `execute`); re-derived from
+    native tool surfaces when the Option C cascade splits tools (stage 8).
+    """
+    
+    def execute(self, audio: Union[str, Path], text: str, **kwargs) -> Any: ...
+```
+
+``` python
+class ForcedAlignmentAdapter(TaskAdapter):
+    """
+    Typed forced-alignment task adapter: model-ready audio + transcript
+    text in, `ForcedAlignResult` (word-level timings) out.
+    
+    Input contract (carried over from the fused-era ForcedAlignmentPlugin):
+    the caller guarantees MODEL-READY audio; `text` is the transcript to
+    align against the audio.
+    
+    Persistence sits BESIDE the task method: the storage module's
+    `ForcedAlignmentStorage` is the cache / persist seam — note the
+    FOUR-key cache identity (`audio_path`, `audio_hash`, `text_hash`,
+    `config_hash`): the task input is the (audio, transcript) PAIR, so the
+    text hash is part of the cache key (unlike transcription's three-key).
+    
+    The result DTO is wire-registered ("forced_alignment.result"): items
+    arrive at the host as typed `ForcedAlignItem`s, not dicts.
+    """
+    
+    def align(
+            self,
+            audio: Union[str, Path],  # Path to MODEL-READY audio (converted upstream)
+            text: str,                # Transcript text to align against the audio
+            **kwargs,                 # Adapter-specific options (language, ...)
+        ) -> ForcedAlignResult:       # Word-level alignment output
+        "Align transcript text to model-ready audio at word level."
+```
+
+### Core Data Structures (`core.ipynb`)
+
+> Standardized word-level forced-alignment DTOs — wire-registered so
+
+#### Import
+
+``` python
+from cjm_forced_alignment_adapter_interface.core import (
+    ForcedAlignItem,
+    ForcedAlignResult
+)
+```
+
+#### Classes
+
+``` python
+@dataclass
+class ForcedAlignItem:
+    "A single word-level alignment result."
+    
+    text: str  # The aligned word (punctuation typically stripped by model)
+    start_time: float  # Start time in seconds
+    end_time: float  # End time in seconds
+```
+
+``` python
+@dataclass
+class ForcedAlignResult:
+    "Standardized output for all forced alignment plugins."
+    
+    items: List[ForcedAlignItem]  # Word-level alignments
+    metadata: Dict[str, Any] = field(...)  # Plugin-specific metadata
+    
+    def from_dict(
+        "Reconstruct from a wire payload, re-typing nested items.
+
+Nested-DTO reconstruction is why this class defines its own
+`from_dict` instead of relying on @wire_type's flat default
+(which would leave `items` as plain dicts)."
+```
+
+### Forced Alignment Storage (`storage.ipynb`)
+
+> Standardized SQLite storage for forced alignment results with content
+> hashing
+
+#### Import
+
+``` python
+from cjm_forced_alignment_adapter_interface.storage import (
+    ForcedAlignmentRow,
+    ForcedAlignmentStorage
+)
+```
+
+#### Classes
+
+``` python
+@dataclass
+class ForcedAlignmentRow:
+    "A single row from the forced_alignments table."
+    
+    job_id: str  # Unique job identifier
+    audio_path: str  # Path to the source audio file
+    audio_hash: str  # Hash of source audio in "algo:hexdigest" format
+    text: str  # Input transcript text that was aligned
+    text_hash: str  # Hash of input text in "algo:hexdigest" format
+    config_hash: str  # Hash of the effective alignment config used
+    items: Optional[List[Dict[str, Any]]]  # Serialized ForcedAlignItems
+    metadata: Optional[Dict[str, Any]]  # Plugin metadata
+    created_at: Optional[float]  # Unix timestamp
+```
+
+``` python
+class ForcedAlignmentStorage:
+    def __init__(
+        self,
+        db_path: str  # Absolute path to the SQLite database file
+    )
+    "Standardized SQLite storage for forced alignment results."
+    
+    def __init__(
+            self,
+            db_path: str  # Absolute path to the SQLite database file
+        )
+        "Initialize storage, create table, run migrations, and build indexes."
+    
+    def save(
+            self,
+            job_id: str,        # Unique job identifier
+            audio_path: str,    # Path to the source audio file
+            audio_hash: str,    # Hash of source audio in "algo:hexdigest" format
+            text: str,          # Input transcript text
+            text_hash: str,     # Hash of input text in "algo:hexdigest" format
+            config_hash: str,   # Hash of the effective alignment config
+            items: Optional[List[Dict[str, Any]]] = None,  # Serialized ForcedAlignItems
+            metadata: Optional[Dict[str, Any]] = None       # Plugin metadata
+        ) -> None
+        "Save or replace a forced alignment result (upsert by audio_path + text_hash + config_hash)."
+    
+    def save_with_logging(
+            self,
+            *,
+            job_id: str,        # Unique job identifier
+            audio_path: str,    # Path to the source audio file
+            audio_hash: str,    # Hash of source audio in "algo:hexdigest" format
+            text: str,          # Input transcript text
+            text_hash: str,     # Hash of input text in "algo:hexdigest" format
+            config_hash: str,   # Hash of the effective alignment config
+            items: Optional[List[Dict[str, Any]]] = None,  # Serialized ForcedAlignItems
+            metadata: Optional[Dict[str, Any]] = None,      # Plugin 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).
+
+Centralizes the try/save/log/except block every forced-alignment plugin reimplements.
+Returns True on success so callers can gate post-save side effects on the result."
+    
+    def get_cached(
+            self,
+            audio_path: str,   # Path to the source audio file
+            audio_hash: str,   # Content hash of the audio (cache miss if the file changed)
+            text_hash: str,    # Hash of the input transcript text (part of the cache key)
+            config_hash: str   # Hash of the effective alignment config
+        ) -> Optional[ForcedAlignmentRow]:  # Cached row or None
+        "Retrieve a content-correct cached alignment for an (audio, transcript) pair.
+
+Matches on audio_path + audio_hash + text_hash + config_hash. A changed audio
+file (new audio_hash) misses even if a stale row exists at the same
+(audio_path, text_hash, config_hash) — the next save() replaces it."
+    
+    def get_by_job_id(
+            self,
+            job_id: str  # Job identifier to look up
+        ) -> Optional[ForcedAlignmentRow]:  # Row or None if not found
+        "Retrieve a forced alignment result by job ID."
+    
+    def list_jobs(
+            self,
+            limit: int = 100  # Maximum number of rows to return
+        ) -> List[ForcedAlignmentRow]:  # List of forced alignment rows
+        "List forced alignment jobs ordered by creation time (newest first)."
+    
+    def verify_audio(
+            self,
+            job_id: str  # Job identifier to verify
+        ) -> Optional[bool]:  # True if audio matches, False if tampered, None if job not found
+        "Verify the source audio file still matches its stored hash."
+    
+    def verify_text(
+            self,
+            job_id: str  # Job identifier to verify
+        ) -> Optional[bool]:  # True if text matches, False if tampered, None if job not found
+        "Verify the input text still matches its stored hash."
+```