subreel 0.1.0__tar.gz

subreel-0.1.0/CHANGELOG.md

@@ -0,0 +1,56 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-10-10
+
+### Added
+
+- `subreel tts` — synthesize speech with edge-tts and capture per-word timings
+  from `WordBoundary` events (zero ASR error), written as a documented
+  `words.json` file.
+- `subreel render` — render word-by-word karaoke subtitles over a green or
+  transparent canvas in three flavours:
+  - `green`: opaque H.264 MP4 on a `0x00B140` chroma-key background,
+  - `webm`: transparent VP9 (`yuva420p`) WebM,
+  - `mov`: transparent ProRes 4444 (`yuva444p10le`) MOV.
+- `--asr` mode — derive word-level timings for any audio with faster-whisper,
+  with an on-disk cache and a Hugging Face mirror hint on download failure.
+- Line-breaking with CJK-aware width budgeting, punctuation-priority wrapping
+  and a configurable karaoke hold.
+- ASS generation with a correct light-on-key colour model, `\kf` per-word
+  sweep, optional fade and selectable font/size/alignment/colours.
+- Clear, actionable errors: ffmpeg/ffprobe discovery with per-platform install
+  commands, and exit code `2` for every recoverable failure.
+- Fully offline test suite (76+ tests) covering line-breaking, ASS output,
+  words.json validation, the CLI surface and mocked TTS/ASR/ffmpeg paths.
+- GitHub Actions CI (`.github/workflows/ci.yml`): pytest on Python 3.9–3.13,
+  byte-compile check, plus a packaging job that builds the sdist + wheel,
+  runs `twine check --strict` and smoke-installs the wheel.
+- Release workflow (`.github/workflows/release.yml`): pushing a `v*` tag
+  publishes to PyPI via OIDC trusted publishing (no stored token) and opens a
+  GitHub Release with the artefacts attached.
+- `docs/releasing.md` — one-time PyPI trusted-publisher setup and the release
+  checklist.
+
+### Changed
+
+- Relicensed from MIT to Apache-2.0.
+- Packaging metadata modernised to PEP 639: `license = "Apache-2.0"` and
+  `license-files` replace the legacy table form; the build backend now requires
+  `setuptools>=77`.
+
+### Fixed
+
+- Punctuation re-attachment keeps its alignment when a spoken token contains an
+  intra-word `.` or `-` (`4.1`, `e-mail`); previously such a token made the
+  alignment check fail and silently disabled punctuation-aware line breaking
+  for the whole script.
+
+[Unreleased]: https://github.com/paxoscn/subreel/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/paxoscn/subreel/releases/tag/v0.1.0

subreel-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 paxoscn
+
+   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.

subreel-0.1.0/MANIFEST.in

@@ -0,0 +1,7 @@
+# Files that belong in the sdist on top of what setuptools auto-includes
+# (README.md, LICENSE, pyproject.toml and the package sources).
+include CHANGELOG.md
+include README.zh-CN.md
+recursive-include docs *.md
+recursive-include tests *.py
+exclude .github

subreel-0.1.0/PKG-INFO

@@ -0,0 +1,370 @@
+Metadata-Version: 2.4
+Name: subreel
+Version: 0.1.0
+Summary: Turn speech audio into subtitle reels: green-screen H.264, transparent WebM/ProRes, with word-by-word karaoke highlight.
+Author: paxoscn
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/paxoscn/subreel
+Project-URL: Repository, https://github.com/paxoscn/subreel
+Project-URL: Issues, https://github.com/paxoscn/subreel/issues
+Project-URL: Changelog, https://github.com/paxoscn/subreel/blob/main/CHANGELOG.md
+Keywords: subtitles,captions,karaoke,tts,asr,whisper,ffmpeg,ass,green-screen,chroma-key,video,cli
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Classifier: Topic :: Multimedia :: Video :: Non-Linear Editor
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: tts
+Requires-Dist: edge-tts>=6; extra == "tts"
+Provides-Extra: asr
+Requires-Dist: faster-whisper>=1.0; extra == "asr"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+# subreel
+
+**Turn speech audio into subtitle reels: green-screen H.264, transparent
+WebM/ProRes, with word-by-word karaoke highlight.**
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![CI](https://github.com/paxoscn/subreel/actions/workflows/ci.yml/badge.svg)](https://github.com/paxoscn/subreel/actions/workflows/ci.yml)
+[![Python](https://img.shields.io/badge/python-3.9%2B-blue.svg)](https://www.python.org/)
+<!-- Uncomment once the first release is on PyPI (see docs/releasing.md):
+[![PyPI](https://img.shields.io/pypi/v/subreel.svg)](https://pypi.org/project/subreel/)
+-->
+[![No runtime deps](https://img.shields.io/badge/runtime%20deps-none-success.svg)](#installation)
+
+subreel is a small, dependency-free CLI that turns a voice-over into a subtitle
+clip you can drop straight onto a video timeline. It renders the subtitles onto
+a chroma-key green background (for editors that key out green) or onto a
+transparent canvas (for editors that take alpha directly), and it lights up each
+word as it is spoken — classic karaoke style.
+
+Two ways to get the timeline:
+
+1. **`subreel tts` — the accurate path.** Synthesize the speech with
+   [edge-tts](https://github.com/rany2/edge-tts) and capture the per-word
+   timestamps straight from the synthesis events. The subtitle timing is exact,
+   because it comes from the same engine that produced the audio — **zero ASR
+   error**.
+2. **`subreel render --asr` — the any-audio path.** Run
+   [faster-whisper](https://github.com/SYSTRAN/faster-whisper) on any existing
+   audio file to get word-level timestamps.
+
+---
+
+## Features
+
+- **Three output flavours** from one command:
+  - **Green-screen MP4** — H.264 / `yuv420p`, ready for chroma key in 剪映, Premiere, DaVinci, Final Cut.
+  - **Transparent WebM** — VP9 with an alpha channel (`yuva420p`).
+  - **Transparent ProRes 4444 MOV** — with alpha (`yuva444p10le`), for Premiere / Final Cut / DaVinci.
+- **Per-word karaoke highlight** — each word is wrapped in an ASS `\kf` sweep,
+  so the current and already-sung words are drawn in the highlight colour.
+- **edge-tts precise timelines** — word timings captured from `WordBoundary`
+  events, no speech recognition involved.
+- **Whisper ASR fallback** — word-level recognition for audio you did not
+  synthesize, with caching.
+- **Zero mandatory Python dependencies** — ffmpeg is the only system
+  requirement; `edge-tts` and `faster-whisper` are opt-in extras.
+- **A documented, portable timeline format** — the [`words.json`](#wordsjson-timing-format) file.
+
+<!-- Demo — uncomment and add the files when they are recorded.
+<p align="center">
+  <img src="docs/demo-green.gif"   alt="Green-screen karaoke subtitles" width="640">
+  <img src="docs/demo-alpha.gif"   alt="Transparent karaoke subtitles"  width="640">
+</p>
+-->
+
+---
+
+## Installation
+
+### 1. ffmpeg (required)
+
+subreel shells out to `ffmpeg` / `ffprobe` and checks for them at startup.
+
+| Platform        | Command                                    |
+| --------------- | ------------------------------------------ |
+| Ubuntu / Debian | `sudo apt install ffmpeg`                  |
+| macOS           | `brew install ffmpeg`                      |
+| Windows         | `winget install Gyan.FFmpeg`               |
+| Conda           | `conda install -c conda-forge ffmpeg`      |
+
+For CJK subtitles, install a CJK font as well (e.g. `fonts-noto-cjk` on Debian
+/ Ubuntu); the default style uses `Noto Sans CJK SC`.
+
+### 2. subreel
+
+Packaging is CI-verified: `pip install subreel` works as soon as the first
+release lands on PyPI (see [`docs/releasing.md`](docs/releasing.md)). Until then
+install straight from GitHub:
+
+```bash
+pip install "git+https://github.com/paxoscn/subreel.git"
+```
+
+With the optional features:
+
+```bash
+# edge-tts synthesis (subreel tts)
+pip install "git+https://github.com/paxoscn/subreel.git#egg=subreel[tts]"
+
+# faster-whisper ASR (subreel render --asr)
+pip install "git+https://github.com/paxoscn/subreel.git#egg=subreel[asr]"
+
+# both
+pip install "git+https://github.com/paxoscn/subreel.git#egg=subreel[tts,asr]"
+```
+
+---
+
+## Quick start
+
+### A. Synthesize *and* render (most accurate)
+
+```bash
+# 1. make the voice-over plus its exact word timings
+subreel tts \
+  --text script.txt \
+  --voice zh-CN-XiaoxiaoNeural \
+  --rate +15% \
+  --out voice.mp3
+# -> voice.mp3  and  voice.words.json
+
+# 2. render all three flavours
+subreel render voice.mp3 \
+  --timings voice.words.json \
+  --formats green,webm,mov \
+  --out-dir out
+# -> out/subs-green.mp4, out/subs-alpha.webm, out/subs-alpha.mov
+```
+
+### B. You already have audio — let Whisper transcribe it
+
+```bash
+subreel render narration.m4a --asr --asr-model small --formats green,webm
+```
+
+The recognised timings are cached to `out/narration.words.json` and reused on
+the next run (pass `--force-asr` to re-run).
+
+### C. You already have timings
+
+Any tool that emits the [`words.json`](#wordsjson-timing-format) format can
+drive subreel:
+
+```bash
+subreel render voice.mp3 --timings my-alignment.json --formats mov
+```
+
+### Decoding the transparent WebM from the command line
+
+`subs-alpha.webm` carries its alpha channel as a VP9 *BlockAdditional* layer
+(`alpha_mode=1`).  NLEs and browsers handle this natively, but ffmpeg's
+**native** `vp9` decoder silently drops that layer, so a plain
+`ffmpeg -i subs-alpha.webm frame.png` yields an opaque black frame.  Decode
+with libvpx instead:
+
+```bash
+ffmpeg -c:v libvpx-vp9 -i subs-alpha.webm -frames:v 1 frame.png   # RGBA, alpha intact
+```
+
+The ProRes `.mov` needs no such flag — every ffmpeg/ProRes toolchain reads its
+alpha directly.
+
+---
+
+## Compositing guide
+
+All three outputs are subtitle *overlays*: they contain only the text (and the
+audio), so you place them on top of your footage and key out the background.
+
+### 剪映 (CapCut / JianYing)
+
+1. Import `subs-green.mp4` and drop it on a track above your video.
+2. Select the clip → **画面 (Picture)** → **抠像 (Key)** → **色度抠图 (Chroma key)**.
+3. Pick the key colour from the green background — it is `0x00B140`
+   (RGB `0, 177, 64`). Use the eyedropper on the green area.
+4. Raise **强度 (Strength)** until the green is fully gone, then adjust
+   **阴影 (Shadow)** to clean up the antialiased edges around the glyphs.
+
+### Adobe Premiere Pro
+
+- **Green MP4**: apply **Ultra Key**, eyedrop the green, set *Matte Generation*
+  → *Tolerance* ~ 30–40 % and *Pedestal* ~ 10 %.
+- **Transparent WebM / MOV**: just drop `subs-alpha.webm` (VP9 with alpha) or
+  `subs-alpha.mov` (ProRes 4444) onto the timeline — no keying needed.
+
+### DaVinci Resolve
+
+- **Green MP4**: add a **3D Keyer** node, eyedrop the green, then refine with
+  the *Clean Black* / *Clean White* controls.
+- **Transparent MOV**: import `subs-alpha.mov` and place it on a higher track;
+  Resolve honours the ProRes 4444 alpha directly.
+
+### Final Cut Pro
+
+- **Green MP4**: apply the **Keyer** effect and pick the green.
+- **Transparent MOV**: add `subs-alpha.mov` above your footage — the alpha is
+  used automatically.
+
+### Any NLE
+
+Transparent WebM (VP9 `yuva420p`) and transparent MOV (ProRes 4444) can be
+dragged straight onto the timeline in Premiere, DaVinci and Final Cut with no
+keying. If your editor is unhappy with VP9 alpha, use the MOV.
+
+---
+
+## `words.json` timing format
+
+subreel's public interchange format. Times are in **seconds** (`float`).
+
+```json
+{
+  "language": "zh",
+  "source": "edge-tts",
+  "words": [
+    { "text": "你", "start": 0.12, "end": 0.31 },
+    { "text": "好", "start": 0.31, "end": 0.58 }
+  ]
+}
+```
+
+| Field      | Type   | Required | Notes                                                        |
+| ---------- | ------ | -------- | ------------------------------------------------------------ |
+| `words`    | array  | yes      | Non-empty list of word objects.                              |
+| `words[].text`  | string | yes | The word or character as it should be displayed.        |
+| `words[].start` | number | yes | Start time in seconds.                                  |
+| `words[].end`   | number | yes | End time in seconds; must be strictly greater than `start`. |
+| `language` | string | no       | Best-effort language tag (e.g. `zh`, `en`).                  |
+| `source`   | string | no       | Free-form provenance (`edge-tts`, `faster-whisper`, …).      |
+
+Validation rules (enforced on load, with a clear error otherwise):
+
+- `words` must be present and non-empty;
+- every word needs `text` (string) and numeric `start` / `end`;
+- `start < end` for every word;
+- `start` values are monotonically non-decreasing (equal is allowed, so two
+  words may share a boundary).
+
+---
+
+## CLI reference
+
+```
+subreel [-h] [--version] [-v] [-q] {tts,render} ...
+```
+
+Global options: `--version`, `-v/--verbose` (INFO logging), `-q/--quiet`.
+
+### `subreel tts`
+
+```
+subreel tts (--text FILE | --text-inline STR) [--voice VOICE]
+            [--rate RATE] [--pitch PITCH] --out AUDIO [--timings JSON]
+```
+
+| Option              | Default                  | Description                                   |
+| ------------------- | ------------------------ | --------------------------------------------- |
+| `--text FILE`       | —                        | Read the script from a UTF-8 file.            |
+| `--text-inline STR` | —                        | Use the given text directly.                  |
+| `--voice`           | `zh-CN-XiaoxiaoNeural`   | edge-tts voice name.                          |
+| `--rate`            | `+0%`                    | Speaking rate, e.g. `+30%`.                   |
+| `--pitch`           | `+0Hz`                   | Pitch shift, e.g. `+8Hz`.                     |
+| `--out`             | *(required)*             | Output audio file.                            |
+| `--timings`         | next to `--out`          | words.json output path.                       |
+
+### `subreel render`
+
+```
+subreel render AUDIO [--timings JSON] [--asr] [--asr-model M] [--language L]
+               [--force-asr] [--formats F] [--out-dir DIR] [--size WxH]
+               [--fps N] [--green HEX] [--no-audio] [--fontsdir DIR]
+               [--font NAME] [--fontsize N] [--align POS] [--highlight HEX]
+               [--color HEX] [--no-fade] [--max-chars N] [--max-lines N]
+               [--hold SEC]
+```
+
+| Option          | Default             | Description                                                    |
+| --------------- | ------------------- | -------------------------------------------------------------- |
+| `AUDIO`         | *(required)*        | Source audio file.                                             |
+| `--timings`     | —                   | words.json word timings (takes precedence over `--asr`).       |
+| `--asr`         | off                 | Derive timings with faster-whisper.                            |
+| `--asr-model`   | `base`              | faster-whisper model size / name.                              |
+| `--language`    | auto                | Force the ASR language (e.g. `zh`, `en`).                      |
+| `--force-asr`   | off                 | Re-run ASR even if a cached words.json exists.                |
+| `--formats`     | `green`             | Comma-separated subset of `green`, `webm`, `mov`.              |
+| `--out-dir`     | `./out`             | Output directory (created if missing).                        |
+| `--size`        | `1280x720`          | Canvas size.                                                   |
+| `--fps`         | `30`                | Frame rate.                                                    |
+| `--green`       | `0x00B140`          | Chroma-key green colour for the `green` format.               |
+| `--no-audio`    | off                 | Omit the audio track from the outputs.                        |
+| `--fontsdir`    | —                   | Extra font directory for libass.                              |
+| `--font`        | `Noto Sans CJK SC`  | Subtitle font name.                                            |
+| `--fontsize`    | `64`                | Subtitle font size.                                            |
+| `--align`       | `bottom`            | `bottom`, `center`/`middle` or `top`.                          |
+| `--highlight`   | `#FFE500`           | Karaoke highlight colour (sung words), `#RRGGBB`.              |
+| `--color`       | `#FFFFFF`           | Base colour (not-yet-sung words).                             |
+| `--no-fade`     | off                 | Disable the per-line fade in/out.                             |
+| `--max-chars`   | `22`                | Per-line width budget, in CJK cells.                          |
+| `--max-lines`   | `2`                 | Soft maximum lines per sentence.                              |
+| `--hold`        | `0.3`               | Karaoke hold tail, in seconds.                                |
+
+**Exit codes:** `0` on success, `2` for every recoverable error (missing
+ffmpeg, missing audio, no timing source, bad words.json, ffmpeg failure).
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/paxoscn/subreel.git
+cd subreel
+pip install -e ".[dev,tts,asr]"
+
+# run the offline test suite (no network, no model downloads)
+python3 -m pytest tests/ -q
+
+# byte-compile check
+python3 -m compileall src/
+```
+
+The tests mock `edge-tts`, `faster-whisper` and `ffmpeg`, so they run anywhere.
+
+CI ([`.github/workflows/ci.yml`](.github/workflows/ci.yml)) runs the suite on
+Python 3.9–3.13, then builds the sdist + wheel, `twine check --strict`s the
+metadata and smoke-installs the wheel. Release automation (tag → PyPI via OIDC
+trusted publishing) is documented in [`docs/releasing.md`](docs/releasing.md).
+
+---
+
+## License
+
+[Apache-2.0](LICENSE) © 2026 paxoscn
+
+---
+
+## Credits
+
+subreel stands on the shoulders of these projects:
+
+- [**ffmpeg**](https://ffmpeg.org/) — probing, filtering and encoding;
+- [**libass**](https://github.com/libass/libass) — ASS subtitle rendering (via
+  ffmpeg's `ass` filter);
+- [**edge-tts**](https://github.com/rany2/edge-tts) — neural text-to-speech and
+  word-boundary timings;
+- [**faster-whisper**](https://github.com/SYSTRAN/faster-whisper) — fast
+  word-level speech recognition.