unrender 0.2.1__tar.gz

unrender-0.2.1/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 Muhammad Hadi Yusufali
+
+   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.

unrender-0.2.1/NOTICE

@@ -0,0 +1,18 @@
+Unrender
+Copyright 2026 Muhammad Hadi Yusufali
+
+This product includes software developed by Muhammad Hadi Yusufali.
+
+Licensed under the Apache License, Version 2.0. See the LICENSE file for the
+full license text.
+
+Optional, separately installed components are governed by their own licenses,
+including but not limited to:
+
+  - Music-Source-Separation-Training (BandIt/MSST) backend
+  - pyannote.audio voice embedding models
+  - WhisperX transcription models
+  - InsightFace face models
+
+These dependencies are not bundled with Unrender. Review each project's license
+and model terms before use, particularly for commercial applications.

unrender-0.2.1/PKG-INFO

@@ -0,0 +1,478 @@
+Metadata-Version: 2.4
+Name: unrender
+Version: 0.2.1
+Summary: Reconstruct editor-friendly timelines from flattened final renders.
+Author: Muhammad Hadi Yusufali
+Maintainer: Muhammad Hadi Yusufali
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/mhadifilms/unrender
+Project-URL: Repository, https://github.com/mhadifilms/unrender
+Project-URL: Issues, https://github.com/mhadifilms/unrender/issues
+Project-URL: Changelog, https://github.com/mhadifilms/unrender/blob/main/CHANGELOG.md
+Keywords: audio,video,source-separation,diarization,speaker-identification,post-production,film,dubbing,media
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: numpy>=1.24
+Requires-Dist: opencv-python>=4.8
+Requires-Dist: Pillow>=10
+Requires-Dist: requests>=2.31
+Requires-Dist: scikit-learn>=1.3
+Requires-Dist: scipy>=1.10
+Provides-Extra: face
+Requires-Dist: insightface; extra == "face"
+Requires-Dist: onnxruntime; extra == "face"
+Provides-Extra: voice
+Requires-Dist: pyannote.audio; extra == "voice"
+Requires-Dist: torchaudio; extra == "voice"
+Provides-Extra: transcription
+Requires-Dist: whisperx; extra == "transcription"
+Provides-Extra: scripts
+Requires-Dist: openpyxl; extra == "scripts"
+Requires-Dist: python-docx; extra == "scripts"
+Provides-Extra: clone
+Requires-Dist: mlx-audio>=0.4.4; extra == "clone"
+Provides-Extra: timeline
+Requires-Dist: opentimelineio>=0.17; extra == "timeline"
+Provides-Extra: dev
+Requires-Dist: black>=24.0; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: mypy>=1.8; extra == "dev"
+Requires-Dist: opentimelineio>=0.17; extra == "dev"
+Requires-Dist: pre-commit>=3.5; extra == "dev"
+Requires-Dist: pytest>=7.4; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Dynamic: license-file
+
+# Unrender
+
+[![CI](https://github.com/mhadifilms/unrender/actions/workflows/ci.yml/badge.svg)](https://github.com/mhadifilms/unrender/actions/workflows/ci.yml)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.10%2B-blue.svg)](pyproject.toml)
+
+Unrender reconstructs an editor-friendly set of media artifacts from a flattened
+final render. It separates the final mix into useful layers, identifies speakers,
+cuts dialogue into reusable units, maps those units back onto shots, and writes
+JSON/CSV plans plus stem files that an editor or downstream tool can consume.
+
+The target shape is:
+
+- video organized by shot
+- dialogue as dialogue-line and shot-level stems
+- music as its own source layer
+- effects as their own source layer
+- speaker identity tracked through one shared speaker database
+
+## Install
+
+Unrender requires Python 3.10+ and a working `ffmpeg` on your `PATH`.
+
+Install the latest version directly from GitHub:
+
+```bash
+python3 -m pip install "git+https://github.com/mhadifilms/unrender.git"
+```
+
+For development from a local checkout:
+
+```bash
+python3 -m venv .venv
+./.venv/bin/python -m pip install -e ".[dev]"
+```
+
+Install only the media extras you need:
+
+```bash
+./.venv/bin/python -m pip install -e ".[face,voice,transcription,scripts]"
+```
+
+Optional extras:
+
+- `face`: real face detection and embeddings
+- `voice`: real voice embeddings
+- `transcription`: WhisperX dialogue transcription
+- `scripts`: XLSX/DOCX dub script parsing
+- `clone`: MLX/Qwen3-TTS voice clone synthesis on Apple Silicon
+- `timeline`: OpenTimelineIO timeline reconstruction (`unrender timeline build`)
+
+The optional BandIt/MSST source separation backend is installed separately
+(its dependency is not on PyPI, so it cannot be a package extra).
+
+AudioShake separation requires an API key:
+
+```bash
+export AUDIOSHAKE_API_KEY=...
+```
+
+The BandIt backend installs upstream Music-Source-Separation-Training and does
+not require a local checkout:
+
+```bash
+./.venv/bin/python -m pip install "music-source-separation-training[bandit] @ git+https://github.com/ZFTurbo/Music-Source-Separation-Training.git@ccc011abf7f89dd7922bb2888d48493b575c0289"
+unrender audio separate -p show-a --source-backend bandit
+```
+
+By default, `unrender` uses the BandIt/MSST package config and downloads the
+BandIt Plus checkpoint into the user cache, verifying its checksum before use.
+Use `--bandit-config` or `--bandit-checkpoint` to override those paths. On Apple
+Silicon, the runtime casts unsupported float64 model state to float32 before
+moving the model to MPS, so no patched MSST checkout is required.
+
+## Inputs
+
+Most runs start from these inputs:
+
+- `speakers.json`: canonical speaker names and aliases
+- `proxy_master.mov`: reviewable master/proxy for face matching
+- `full_audio.wav`: full mix or full audio stem
+- `shots.csv`: shot IDs, video paths, and start/end seconds
+
+If you already have an isolated dialogue stem, use `dx_stem` or `--dx-stem`
+instead of `full_audio`.
+
+Example `speakers.json`:
+
+```json
+{
+  "speakers": {
+    "JORDAN": { "aliases": [] },
+    "ALEX": { "aliases": ["ALEKS"] }
+  }
+}
+```
+
+Manual labels are constrained to the configured speaker set. Aliases resolve to
+canonical names.
+
+Example `shots.csv`:
+
+```csv
+shot_id,video_path,start_sec,end_sec
+001,/path/to/shot_001_proxy.mov,102.25,106.75
+002,/path/to/shot_002_proxy.mov,215.10,218.30
+```
+
+For tighter face matching, add a target face box:
+
+```csv
+shot_id,video_path,start_sec,end_sec,target_face_box
+001,/path/to/shot_001_proxy.mov,102.25,106.75,"[320, 140, 180, 220]"
+```
+
+Supported target box columns are `target_face_box`, `face_box`, `bbox`, or split
+columns `target_x,target_y,target_w,target_h`.
+
+## Project Config
+
+Use `-p` / `--project` to avoid repeating paths. Project configs live under
+`config/` by default, and the `.json` suffix is optional.
+
+```bash
+unrender doctor -p demo-spanish
+unrender audio separate -p demo-spanish
+unrender shots match -p demo-*
+```
+
+Example `config/demo-spanish.json`:
+
+```json
+{
+  "speakers": {
+    "JORDAN": { "aliases": [] },
+    "ALEX": { "aliases": [] }
+  },
+  "paths": {
+    "run_dir": "runs/demo-spanish",
+    "proxy_master": "/path/to/proxy_master.mov",
+    "full_audio": "/path/to/full_audio.wav",
+    "dx_stem": "/path/to/dialogue_stem.wav",
+    "dub_script": "/path/to/dub_script.csv",
+    "shots": "config/demo-spanish-shots.csv",
+    "separated_stems": "/path/to/stems/*.wav"
+  },
+  "stem_map": {
+    "JORDAN": "/path/to/stems/JORDAN_stem.wav",
+    "ALEX": "/path/to/stems/ALEX_stem.wav"
+  },
+  "audio": {
+    "audioshake_variant": "n_speaker",
+    "silence_threshold_db": -100,
+    "max_gap_sec": 0.5,
+    "handle_sec": 0.18,
+    "clip_resolver": "cluster",
+    "min_margin": 0.05,
+    "override_sec": 1.5,
+    "override_margin": 0.15,
+    "cut_shot_stems": false
+  },
+  "face": {
+    "interval": 2.0,
+    "min_confidence": 0.5,
+    "min_face_px": 36
+  },
+  "shots": {
+    "samples_per_shot": 8,
+    "sim_threshold": 0.45,
+    "min_confidence": 0.5,
+    "min_votes": 2,
+    "min_margin": 0.05
+  },
+  "voice": {
+    "cluster_threshold": 0.35,
+    "min_cluster_size": 2
+  },
+  "timeline": {
+    "dialogue": "auto",
+    "shot_dx": false,
+    "no_markers": false
+  }
+}
+```
+
+Every CLI tuning flag can also be set in the matching config section
+(`audio`, `face`, `shots`, `voice`, `voice_clone`, `timeline`); explicit CLI
+flags always win.
+
+If `speakers` is omitted and `paths.dub_script` is set, Unrender derives the
+speaker list from the script. CSV, TSV, JSON, XLSX, and DOCX dub scripts are
+supported when the relevant extras are installed.
+
+Explicit CLI flags override project config values.
+
+## Main Workflow
+
+With a project config:
+
+```bash
+unrender doctor -p demo-spanish
+unrender face build -p demo-spanish
+unrender audio separate -p demo-spanish
+unrender audio transcribe-lines -p demo-spanish
+unrender audio build-clips -p demo-spanish
+unrender voice build -p demo-spanish
+unrender labels interactive -p demo-spanish
+unrender shots match -p demo-spanish
+unrender audio resolve-clips -p demo-spanish
+unrender audio map-dialogue -p demo-spanish
+unrender voice clone -p demo-spanish
+unrender timeline build -p demo-spanish
+unrender export artifacts -p demo-spanish
+unrender status -p demo-spanish
+```
+
+Without a project config:
+
+```bash
+RUN=/tmp/unrender-show
+
+unrender face build --video proxy_master.mov --run-dir "$RUN"
+unrender audio separate --full-audio full_audio.wav --run-dir "$RUN"
+unrender audio transcribe-lines --dx-stem dialogue.wav --shots shots.csv --run-dir "$RUN"
+unrender audio build-clips --run-dir "$RUN"
+unrender voice build --run-dir "$RUN"
+unrender labels interactive --run-dir "$RUN" --config speakers.json
+unrender shots match --shots shots.csv --speaker-db "$RUN/speaker_db.json" --run-dir "$RUN"
+unrender audio resolve-clips --speaker-db "$RUN/speaker_db.json" --run-dir "$RUN"
+unrender audio map-dialogue --shots shots.csv --run-dir "$RUN"
+unrender timeline build --shots shots.csv --run-dir "$RUN"
+unrender export artifacts --run-dir "$RUN"
+unrender status --run-dir "$RUN"
+```
+
+The primary deliverable is per-speaker full stems split into labeled,
+speaker-named dialogue-line clips — that is what the timeline carries.
+
+## Optional Per-Shot Outputs
+
+Two optional final steps produce per-shot artifacts on top of the primary
+dialogue-line flow:
+
+```bash
+# One DX clip per shot, cut from the full dialogue stem. The DX source is
+# resolved automatically: an explicit --dx-stem, the source-separation
+# output, or (when neither exists) a stem merged from the separated
+# per-speaker stems. Add to the timeline as one track with --shot-dx.
+unrender audio shot-dx -p demo-spanish
+unrender timeline build -p demo-spanish --shot-dx
+
+# Per-shot speaker stems: one file per dialogue line overlapping each shot,
+# cut exactly to the shot timecode (2+ files when 2+ lines fall in a shot).
+# Include them in the timeline explicitly with --dialogue shots.
+unrender audio map-dialogue -p demo-spanish --cut-shot-stems
+```
+
+## Commands
+
+```text
+unrender audio separate         Separate full audio/DX into source and speaker stems
+unrender audio transcribe-lines Build dialogue_lines.json from WhisperX or a dub script
+unrender audio build-clips      Cut per-line voice clips from full-length speaker stems
+unrender audio resolve-clips    Resolve dialogue clips to labeled voices. The default
+                                cluster resolver groups every line's voice globally and
+                                jointly assigns clusters to speakers (long, confident
+                                clips can override); --resolver clip matches each clip
+                                independently with a similarity threshold and margin
+unrender audio map-dialogue     Map resolved dialogue lines onto shots; optionally cut
+                                shot-timecode-accurate per-line stems (--cut-shot-stems)
+unrender audio shot-dx          Cut a per-shot DX stem from the full dialogue stem
+                                (given, separated, or merged from speaker stems)
+
+unrender face build             Build face_db.json and face review grids
+unrender voice build            Build voice_db.json and voice review samples
+unrender voice match            Match arbitrary clips to labeled voices
+unrender voice clone            Build voice clone references and optional samples
+
+unrender labels template        Write labels.csv for manual review
+unrender labels apply           Apply labels.csv to speaker_db.json
+unrender labels interactive     Prompt through unlabeled face/voice clusters
+
+unrender shots match            Identify on-screen speakers per shot
+unrender timeline build         Reconstruct an OpenTimelineIO timeline (.otio)
+unrender export artifacts       Copy final JSON artifacts under exports/
+unrender status                 Show expected run artifacts
+unrender doctor                 Validate inputs and local prerequisites
+```
+
+Run `unrender <group> <command> --help` for command-specific flags.
+
+## Run Directory
+
+A run directory is the working output area for one project:
+
+```text
+runs/show/
+  face_db.json
+  voice_db.json
+  speaker_db.json
+  dialogue_lines.json
+  dialogue_lines.csv
+  labels.csv
+  shot_speaker_matches.json
+  shot_speaker_matches.csv
+  voice_speaker_matches.json
+  clip_stem_plan.json
+  dialogue_stem_plan.json
+  shot_dialogue_map.json
+  shot_stem_plan.json
+  timeline.otio
+  audio/
+    source_stems/
+    unmapped_speakers/
+    voice_clips/
+    dialogue_mapped/
+    _unmapped/
+    mapped/
+    voice_clone_data/
+  review/
+    face/
+    voice/
+  voice_clones/
+  exports/
+```
+
+Build steps are restartable. Existing artifacts are reused by default; pass
+`--force` when you intentionally want to rebuild a step.
+
+## Timeline Reconstruction
+
+The final step reassembles the reconstructed media into an editor timeline using
+[OpenTimelineIO](https://opentimeline.io):
+
+```bash
+./.venv/bin/python -m pip install -e ".[timeline]"
+unrender timeline build -p demo-spanish
+```
+
+The resulting `timeline.otio` contains:
+
+- a video track per shot, placed at each shot's `start_sec`/`end_sec`, marked
+  with the matched on-screen speaker(s)
+- one dialogue track per speaker, ordered by speaking time, with line-level
+  stems (or per-shot stems) placed at their global time; overlapping lines fan
+  out onto additional lanes
+- music (`MX`) and effects (`FX`) tracks from the full-length source stems
+- editorial markers on each dialogue clip showing the speaker and spoken line,
+  color-coded: green (matched), orange (off-screen / unresolved), red (missing
+  stem)
+- a program start timecode and provenance metadata (Unrender version, run
+  directory, fps, dialogue source) on the timeline
+
+Clip durations are probed from the real media with `ffprobe` (falling back to
+the stdlib `wave` module for `.wav` stems, then to artifact timing if `ffprobe`
+is unavailable), so each clip carries an accurate `available_range`. Clips
+reference the stem and proxy files on disk; OTIO stores the cut, not the media.
+Lines without a matched stem are kept as placeholders so the editorial
+structure stays intact.
+
+Useful flags:
+
+- `--dialogue {auto,lines,shots}` — choose the dialogue source granularity
+- `--fps` — edit rate (default 24, or `audio.fps` from the project config)
+- `--start-timecode HH:MM:SS:FF` — set the timeline origin (e.g. `01:00:00:00`)
+- `--dialogue-bed` — add the full-length dialogue source stem as a track
+- `--no-source-stems` / `--no-markers` — drop music/effects tracks or markers
+- `--dry-run` — report the plan without writing
+- `--bundle` — also write a self-contained `.otiod` media bundle
+
+`.otio` is written by the built-in adapter. To export other formats (EDL,
+Final Cut Pro XML, AAF), install the adapters and pass a matching `--out`
+suffix:
+
+```bash
+pip install OpenTimelineIO-Plugins
+unrender timeline build -p demo-spanish --out runs/demo-spanish/cut.edl
+```
+
+## Development
+
+Run checks:
+
+```bash
+./.venv/bin/ruff check .
+./.venv/bin/black --check .
+./.venv/bin/pytest -q
+```
+
+Format:
+
+```bash
+./.venv/bin/black src tests
+```
+
+Type-check:
+
+```bash
+./.venv/bin/mypy
+```
+
+## Contributing
+
+Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for setup and
+the checks that must pass, and [SECURITY.md](SECURITY.md) for how to report
+vulnerabilities privately.
+
+## License
+
+Unrender is licensed under the [Apache License 2.0](LICENSE).
+
+Optional, separately installed backends (BandIt/MSST, pyannote.audio, WhisperX,
+InsightFace, and others) are governed by their own licenses and model
+terms. They are not bundled with Unrender; review each project's terms before
+use, especially for commercial work. See [NOTICE](NOTICE) for details.