srtspeak 0.1.0__tar.gz

srtspeak-0.1.0/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 2026 Hirofumi Ukawa
+
+   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.

srtspeak-0.1.0/PKG-INFO

@@ -0,0 +1,434 @@
+Metadata-Version: 2.4
+Name: srtspeak
+Version: 0.1.0
+Summary: SRT multilingual TTS with forced cue-window timing (xAI Grok)
+Author-email: Hirofumi Ukawa <hirofumi@ukawa.biz>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/awaku7/srtspeak
+Project-URL: Repository, https://github.com/awaku7/srtspeak
+Project-URL: Issues, https://github.com/awaku7/srtspeak/issues
+Keywords: srt,tts,xai,grok,ffmpeg,subtitle
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+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: Topic :: Multimedia :: Sound/Audio :: Speech
+Classifier: Topic :: Multimedia :: Video
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: ja
+Requires-Dist: kanjiconv; extra == "ja"
+Provides-Extra: gui
+Requires-Dist: PySide6>=6.6; extra == "gui"
+Provides-Extra: ffmpeg
+Requires-Dist: imageio-ffmpeg>=0.5; extra == "ffmpeg"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: Babel>=2.14; extra == "dev"
+Dynamic: license-file
+
+# srtspeak
+
+Multilingual SRT TTS. Forces each cue into its exact start/end window (xAI Grok TTS + ffmpeg).
+
+Authoritative design: `DESIGN.md`.
+
+**Languages:** [English](README.md) | [日本語](README.ja.md)
+
+## Requirements
+
+| Item | Detail |
+|------|--------|
+| OS | Windows / macOS / Linux (developed and verified on Windows) |
+| Python | 3.11+ |
+| ffmpeg / ffprobe | Prefer on `PATH`; optional fallback via `imageio-ffmpeg` |
+| API key | `XAI_API_KEY` only for real TTS (not needed for dry-run) |
+
+## Install
+
+From the repository root:
+
+```bat
+python -m pip install -e .
+```
+
+With GUI:
+
+```bat
+python -m pip install -e ".[gui]"
+```
+
+Dev extras (pytest / ruff / Babel):
+
+```bat
+python -m pip install -e ".[dev]"
+```
+
+Optional ffmpeg fallback via pip:
+
+```bat
+python -m pip install -e ".[ffmpeg]"
+```
+
+After editable install, the `srtspeak` command is available. Without install:
+
+```bat
+set PYTHONPATH=src
+python -m srtspeak --help
+```
+
+Japanese yomi preprocess (kanji→hiragana via kanjiconv):
+
+```bat
+python -m pip install -e ".[ja]"
+```
+
+Combined extras example:
+
+```bat
+python -m pip install -e ".[gui,ja]"
+```
+
+## Launch (Windows)
+
+Double-click or run from the repo root:
+
+| Script | Action |
+|--------|--------|
+| `run_gui.bat` | Start GUI |
+| `run_doctor.bat` | Environment check |
+| `run_srtspeak.bat …` | CLI passthrough (same args as `srtspeak`) |
+
+Examples:
+
+```bat
+run_gui.bat
+run_doctor.bat
+run_srtspeak.bat --help
+run_srtspeak.bat dry-run --srt GRAN_TENKU_japan.srt --lang ja
+```
+
+Equivalent without bat:
+
+```bat
+srtspeak gui
+python -m srtspeak gui
+```
+
+Notes:
+
+- Scripts `cd` to the repo root automatically.
+- If `srtspeak` is not on `PATH`, they set `PYTHONPATH=src` and use `python -m srtspeak`.
+- If `XAI_API_KEY` is unset and `UAGENT_GROK_API_KEY` is set, it is copied for the session only (not persisted).
+
+## When ffmpeg is missing
+
+Resolution order (`core/ffmpeg_resolve.py`):
+
+1. `ffmpeg` / `ffprobe` on `PATH` (`shutil.which`)
+2. Optional dependency `imageio-ffmpeg` bundled binary (`get_ffmpeg_exe()`)
+3. Otherwise `FFmpegNotFoundError`
+
+| Situation | Behavior |
+|-----------|----------|
+| `srtspeak doctor` | Prints `ffmpeg: MISSING (...)`. Exit code **0** (diagnostics only) |
+| `dry-run` | ffmpeg **not required** (parse + char count + cost estimate only) |
+| Real `build` / `build-all` | Fails at fit stage. CLI: `error: ffmpeg not found on PATH and imageio-ffmpeg is unavailable`, exit code **2** |
+| `imageio-ffmpeg` only | Works, but `ffprobe` may be `(none)`. Full PATH ffmpeg build is **recommended** |
+
+### Install examples (Windows)
+
+WinGet (recommended):
+
+```bat
+winget install Gyan.FFmpeg
+```
+
+Then in a **new** terminal:
+
+```bat
+ffmpeg -version
+ffprobe -version
+srtspeak doctor
+```
+
+If you prefer not to change PATH:
+
+```bat
+python -m pip install -e ".[ffmpeg]"
+srtspeak doctor
+```
+
+`doctor` shows `source: path` for system ffmpeg, or `source: imageio_ffmpeg` for the pip bundle.
+
+## xAI (Grok TTS) signup and API key
+
+TTS is **xAI Grok only** (`POST https://api.x.ai/v1/tts`). Create the key in the console.
+
+### 1. Account
+
+1. Open [https://console.x.ai/](https://console.x.ai/)
+2. Sign up / log in (xAI account)
+3. Accept terms and set up billing / credits as guided  
+   - TTS is usage-based. dry-run estimate uses **$15 / 1M characters** (implementation unit price)
+
+### 2. Create an API key
+
+1. Open **API Keys** (or equivalent) in the console
+2. Create a new key
+3. Copy the value (often starts with `xai-`)  
+   - It may **not be shown again** — put it in an env var immediately
+4. Do not put the key in chat, Git, `report.json`, or screenshots
+
+Official docs:
+
+- [Text to Speech](https://docs.x.ai/developers/model-capabilities/audio/text-to-speech)
+- [Voice](https://docs.x.ai/developers/model-capabilities/audio/voice)
+- API: `https://api.x.ai/v1/tts` / voices: `https://api.x.ai/v1/tts/voices`
+
+### 3. How this tool reads the key
+
+| Rule | Detail |
+|------|--------|
+| Variable | **`XAI_API_KEY` only** |
+| CLI flag | No `--api-key` (avoids shell history) |
+| Persistence | No `.env` read/write; never written to report/logs |
+| dry-run | Key optional |
+| Real TTS | env → (CLI) `getpass` prompt → else exit code 2 |
+| GUI | env first; masked session input if missing |
+
+Windows cmd (current window only):
+
+```bat
+set "XAI_API_KEY=xai-..."
+srtspeak doctor
+```
+
+PowerShell:
+
+```powershell
+$env:XAI_API_KEY = "xai-..."
+srtspeak doctor
+```
+
+Persist for new terminals (cmd):
+
+```bat
+setx XAI_API_KEY "xai-..."
+```
+
+`doctor` shows presence only:
+
+```text
+XAI_API_KEY: set (env)
+```
+
+or:
+
+```text
+XAI_API_KEY: missing
+```
+
+Invalid key / insufficient balance surfaces as `TTS error: ...` during build (exit code 1).
+
+## Commands
+
+```bat
+srtspeak --help
+srtspeak doctor
+srtspeak languages
+srtspeak voices
+srtspeak gui
+srtspeak build --help
+srtspeak build-all --help
+srtspeak dry-run --help
+```
+
+| Command | Purpose |
+|---------|---------|
+| `doctor` | Check `XAI_API_KEY`, ffmpeg/ffprobe, PySide6 |
+| `languages` | Language codes sendable to the API |
+| `voices` | Grok voices (API if key present, else builtin) |
+| `dry-run` | Parse + char count + cost estimate (no key, no ffmpeg) |
+| `build` | Generate one language |
+| `build-all` | Generate multiple languages in sequence |
+| `gui` | PySide6 GUI |
+
+Global options:
+
+```text
+--locale en|ja     UI locale (default: SRTSPEAK_LOCALE → LC_ALL/LANG → system → en)
+--verbose / --quiet
+```
+
+Place `--quiet` / `--verbose` **before** the subcommand:
+
+```bat
+srtspeak --locale ja doctor
+srtspeak --verbose build --srt sample.srt --lang ja --dry-run
+```
+
+## Input / output layout
+
+`--out` is the **output root**. Artifacts always go under `{out}/{lang}/`.
+
+```text
+out/{lang}/
+  cues/                  per-cue audio
+  fitted/                duration-fitted audio
+  GRAN_TENKU_{lang}.wav  final track (fixed name)
+  report.json
+work/{lang}/
+  raw/
+  cache/
+```
+
+- Default root: `out` → e.g. `out/ja/`
+- `--out out/en` with `--lang en` → `out/en/` (no double nesting)
+- `--out artifacts` with `--lang pt` → `artifacts/pt/`
+- `build-all` writes `summary.json` at the out root
+
+## Usage
+
+### Environment check
+
+```bat
+srtspeak doctor
+```
+
+Before a real build you typically want:
+
+- `XAI_API_KEY: set (env)`
+- `ffmpeg:` path with `source: path` (or `imageio_ffmpeg`)
+
+### Cost estimate (no key, no ffmpeg)
+
+```bat
+srtspeak dry-run --srt GRAN_TENKU_japan.srt --lang ja
+```
+
+### Single-language build
+
+```bat
+set "XAI_API_KEY=xai-..."
+
+srtspeak build --srt GRAN_TENKU_japan.srt --lang ja --voice-id leo
+srtspeak build --srt GRAN_TENKU_English.srt --lang en --voice-id leo --out out
+srtspeak build --srt GRAN_TENKU_Portugus.srt --lang pt --voice-id leo
+```
+
+Main options:
+
+| Option | Meaning | Default |
+|--------|---------|---------|
+| `--srt` | Input SRT | required |
+| `--lang` | Internal key `ja` / `en` / `pt` … | may be guessed from filename |
+| `--language-code` | BCP-47 sent to API | lang default (`pt`→`pt-BR`) |
+| `--out` | Output root (lang appended) | `out` |
+| `--work-dir` | Work root | `work` |
+| `--voice-id` | Voice ID | `leo` |
+| `--short-mode` | `pad` / `stretch` | `pad` |
+| `--limit N` | First N cues only | all |
+| `--dry-run` | Estimate only | off |
+| `--also-mp3` | Also write mp3 | off |
+| `--jobs` | Parallelism (MVP: 1 only) | `1` |
+
+Smoke a few cues:
+
+```bat
+srtspeak build --srt GRAN_TENKU_japan.srt --lang ja --limit 3 --voice-id leo
+```
+
+Portuguese as pt-PT:
+
+```bat
+srtspeak build --srt GRAN_TENKU_Portugus.srt --lang pt --language-code pt-PT --voice-id leo
+```
+
+### Multi-language batch
+
+```bat
+srtspeak build-all ^
+  --map ja=GRAN_TENKU_japan.srt ^
+  --map en=GRAN_TENKU_English.srt ^
+  --map pt=GRAN_TENKU_Portugus.srt ^
+  --voice-id leo ^
+  --out out
+```
+
+Per-language voices:
+
+```bat
+srtspeak build-all ^
+  --map ja=GRAN_TENKU_japan.srt ^
+  --map en=GRAN_TENKU_English.srt ^
+  --voice-id ja=leo --voice-id en=orion
+```
+
+### GUI
+
+```bat
+python -m pip install -e ".[gui]"
+srtspeak gui
+```
+
+- Out field is the **root** (default `out`); lang is appended at run time
+- API key: env preferred; masked session input if unset
+
+## Processing notes
+
+- TTS: xAI Grok unary REST only (`speed` always 1.0)
+- Fit: ffmpeg CLI only (`atempo` 0.5–2.0 multi-stage; short cues default to pad)
+- Timeline: silence canvas + PCM placement; half-open window `[start, end)`
+- Track length: aligned to last cue end (±50 ms)
+- Audio: mono s16le 24 kHz WAV
+- Cost estimate (dry-run): $15 / 1M chars
+
+## Exit codes
+
+| Code | Meaning |
+|------|---------|
+| 0 | Success (`doctor` is 0 even if ffmpeg is missing) |
+| 1 | Runtime errors (e.g. TTS) |
+| 2 | Config/args/invalid SRT/**ffmpeg missing**/key missing |
+| 130 | Cancelled (Ctrl+C) |
+
+## Development
+
+```bat
+python -m pip install -e ".[dev]"
+set PYTHONPATH=src
+python -m pytest -q
+python -m ruff check src tests
+python -m ruff format src tests
+```
+
+i18n (when messages change):
+
+```bat
+python scripts/update_i18n.py
+```
+
+## Sample inputs (expected alongside the repo)
+
+| File | lang | Notes |
+|------|------|-------|
+| `GRAN_TENKU_japan.srt` | `ja` | |
+| `GRAN_TENKU_English.srt` | `en` | |
+| `GRAN_TENKU_Portugus.srt` | `pt` | API default `pt-BR` if unspecified |
+
+Timecodes are assumed aligned across the three files (design-time: 293 cues, `00:00:07,600`–`00:12:44,000`).
+
+## License
+
+Apache License 2.0 (see `LICENSE`)
+
+## Author
+
+Hirofumi Ukawa <hirofumi@ukawa.biz>