renderplan 0.1.0__py3-none-any.whl

renderplan/version.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+try:
+    from ._version import __version__
+except ImportError:  # source tree before setuptools-scm generated the module
+    try:
+        from importlib.metadata import PackageNotFoundError, version
+
+        __version__ = version("renderplan")
+    except PackageNotFoundError:  # pragma: no cover - local source tree fallback
+        __version__ = "0.0.dev0"
+
+__all__ = ["__version__"]

renderplan-0.1.0.dist-info/METADATA

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: renderplan
+Version: 0.1.0
+Summary: Engine-neutral render profile, render plan, preflight, and render manifest contracts for speech pipelines.
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: tomli>=2.0; python_version < "3.11"
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: ruff>=0.8; extra == "dev"
+Requires-Dist: mypy>=1.13; extra == "dev"
+Dynamic: license-file
+
+# renderplan MVP
+
+`renderplan` is a deliberately small Python contract package shared by **UtterPlan**, **VoiceRender**, and **AudioCompose**. It contains no SSMD compiler, NLP, TTS engine, G2P, waveform, DSP, or orchestration implementation.
+
+The intended dependency graph is:
+
+```text
+utterplan ──────┐
+voicerender ────┼──> renderplan
+audiocompose ──┘
+```
+
+The applications do not depend on each other; the contract package is their only shared dependency.
+
+## Contracts
+
+The package defines four TOML documents:
+
+1. `renderprofile.toml` — seeded by VoiceRender and user-owned. It contains opaque, self-contained renderer bindings, portable requirements, optional capacity descriptions, split/fallback policy, and explicit pause durations. Shared pause modes are `manual` and `none`; orchestration pass limits do not belong in this contract.
+2. `renderplan.toml` — produced by UtterPlan. Its ordered flow is the exact serial execution contract: numbered speech requests, exact `NNNNNN.wav` names, generic pauses, audio items, controls, tokens, source provenance, and role bindings copied from the profile.
+3. `renderplan-preflight.toml` — produced by VoiceRender for one exact RenderPlan. It has status `ok`, `replan`, or `reject` and refers to speech occurrences by `(segment_number, segment_id)`.
+4. `render-manifest.toml` — produced by VoiceRender. It binds WAV metadata to exact `(segment_number, segment_id)` plan occurrences. A complete manifest contains exactly every plan speech occurrence; an incomplete one may contain only occurrences from that plan.
+
+Consumers can use the shared joins instead of implementing their own parsers:
+
+```python
+plan.validate_against_profile(profile)
+report.validate_against(plan)
+manifest.validate_against(plan)
+```
+
+These are portable contract checks only; they do not resolve engines, inspect WAV files, or orchestrate a pipeline.
+
+## UtterPlan v7 source and token mapping
+
+The first producer uses zero-based v7 provenance locators such as `f000000.s000`, `f000000.s001`, and `f000001.s000`: six digits for the flow index and three for the segment index. A locator is an opaque provenance address, meaningful only together with `RenderPlan.source_plan_id`; it is not a globally stable segment ID. `renderplan` does not parse or resolve locators and has no UtterPlan dependency.
+
+`SourceSpan.start` and `.end` are Python string/code-point offsets into the prepared `FlowSegment.text`. For every speech request, UtterPlan must prove:
+
+```text
+SpeechItem.text == concatenation, in order, of each referenced FlowSegment.text[start:end]
+```
+
+Do not trim request-edge whitespace. These offsets also map source spans and request-local controls/tokens deterministically. Source-to-text equality is proved by UtterPlan against its source document, not by `renderplan`.
+The destination start offset of source span `N` inside the request is the sum of the lengths of all preceding source slices. This preserves a direct mapping without trimming or a second offset table.
+
+`TokenBundle.span` is a dense, ordered list of request-local `[start, end]` character ranges; `pos` and `tag`, when present, are dense parallel arrays. `lemma` and `morph` are sparse arrays of `[token_index, value]`. VoiceRender derives a token surface from `speech.text[start:end]`. Profile-required token fields must be complete under those semantics; available optional fields should be preserved, but `lemma` and `morph` should not be declared required unless an adapter genuinely requires them.
+
+`SpeechControl` is request-local and renderer-neutral: it carries `start`, `end`, `name`, and TOML-safe `params`. Initial semantic names include `pronunciation`, `prosody`, `emphasis`, `say_as`, and `extension:<name>`. Controls participate in `segment_id`; renderers decide support, and unsupported controls must fail preflight rather than be ignored. Control ranges may overlap only when the source semantics permit it. Engine-specific voice selection is resolved into the opaque logical role/binding; audio directives become `AudioItem`s.
+
+Bindings copied into plans must be self-contained enough to execute without reopening the RenderProfile. This contract does not define renderer-specific path keys or local-asset resolution.
+This schema has no generic asset-reference type yet. A VoiceRender profile producer must refuse bindings that depend on profile-local or otherwise uncopied asset state; do not introduce renderer-specific asset-path keys into this shared contract.
+
+## Identity and replan contract
+
+`segment_id` identifies the exact synthesis request: text, language, role, binding, tokens, and controls. It excludes display number and plan provenance such as source spans, split reason, planning level, and semantic end. Duplicate requests may therefore share a `segment_id`; `(segment_number, segment_id)` identifies each occurrence within a plan, report, or manifest.
+
+`plan_id` identifies the complete ordered execution flow, including speech numbers/order, request IDs, provenance and planning semantics, preflight requirements, every pause, and every audio item. Producer package versions do not change semantic profile or plan identity. Exact source-file bytes are not included in RenderPlan identity.
+
+A PreflightReport describes failures only for its concrete RenderPlan; it cannot preserve successful capacity splits from earlier attempts. The replan join is therefore:
+
+```text
+original UtterPlan + RenderProfile + previous RenderPlan
+                           + PreflightReport for that previous RenderPlan
+                              -> new RenderPlan
+```
+
+UtterPlan uses the previous plan as the partition baseline and rebuilds only failed source ranges. Each replan request must correspond to a `too_long` check and exactly match that speech occurrence's source coverage and current planning level. VoiceRender preflight never edits the plan. `replan` is only for recoverable capacity failures; missing engines, unknown voices, unsupported controls, invalid token fields, and frontend/API failures are `reject` conditions.
+
+A `PauseItem` is a generic serial event positioned by `flow`, with duration, reason, and optional provenance; it can lead a flow or follow speech, audio, or another operation. No preceding speech number is required. The ordered flow is authoritative for AudioCompose.
+
+## Example preflight occurrence
+
+```toml
+[[checks]]
+segment_number = 37
+segment_id = "sha256:..."
+status = "too_long"
+metric = "model_tokens"
+measured = 532
+maximum = 510
+source = "pykokoro.prepare"
+
+[[replan]]
+segment_number = 37
+segment_id = "sha256:..."
+current_level = "sentence"
+action = "split"
+reason = "capacity"
+metric = "model_tokens"
+measured = 532
+maximum = 510
+
+[[replan.source]]
+locator = "f000123.s004"
+start = 0
+end = 42
+```
+
+UtterPlan does not need to understand `model_tokens`; the source-plan ID, copied profile ID, exact plan ID, source ranges, and generic split level/action allow stale feedback to be rejected without importing VoiceRender.
+
+## Install for development
+
+This repository intentionally has **no `src/` directory**.
+
+```bash
+python -m pip install -e '.[dev]'
+pytest
+ruff check .
+mypy renderplan
+```
+
+Versioning is dynamic through `setuptools-scm`; create Git tags such as `v0.1.0`. A source tree without Git metadata uses the configured development fallback version.
+
+## Example API
+
+```python
+from renderplan import load_plan, load_preflight
+
+plan = load_plan("chapter.renderplan.toml")
+report = load_preflight("chapter.preflight.toml")
+
+report.validate_against(plan)
+if report.status == "replan":
+    for request in report.replan:
+        print(request.segment_number, request.action, request.source)
+```
+
+## MVP invariants
+
+- Persisted identities are SHA-256 over canonical semantic payloads; producer versions are provenance, not identity.
+- Speech numbers are contiguous starting at 1; speech `N` maps to `NNNNNN.wav`.
+- Speech-request identity is stable across renumbering; full plan identity changes when flow order or execution semantics change.
+- `RenderPlan.validate_against_profile`, `PreflightReport.validate_against`, and `RenderManifest.validate_against` enforce portable joins and exact occurrence matching.
+- VoiceRender preflight never changes the plan, and rendering never introduces unplanned speech segments.
+- AudioCompose consumes RenderPlan flow and RenderManifest artifacts; it does not reconstruct pauses from UtterPlan.
+- Engine-specific binding tables are opaque to UtterPlan and AudioCompose.

renderplan-0.1.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+renderplan/__init__.py,sha256=Z72jU6HSLWgCDwYuBCSVWPhwW_j5wRP5WKMgdoJ6TfU,1476
+renderplan/__main__.py,sha256=k1ocEWawweo1qCJWNFAAvyxz3tcY13dzvCenHszij30,48
+renderplan/_toml.py,sha256=5W6Q3S_ziw_KnE9yQdjcqPnfZQ22_0onoWTZFt7Etqg,2489
+renderplan/_version.py,sha256=-Rr288b4YulcjDfbRh3DEiXUc5JmL7dsYakSJINWxLM,528
+renderplan/cli.py,sha256=f_r7eeUetQULfyZSG0U9I79aVitjEPu1e33x6iRjIj4,2534
+renderplan/codec.py,sha256=vT-9O4L8OlHdH4FaslHnidSn-pxPsV5JgFU9FC4asCs,24954
+renderplan/errors.py,sha256=BTkiVprpPxng8xTnY_Y3SfTDSl-COHJX_AS5EiyPlYs,293
+renderplan/identity.py,sha256=eaPzOg1tnz3JJ7CwX05x_0E_FU4VQM5a_WDX1wlCBDA,2809
+renderplan/model.py,sha256=9JVNOLdzDSOqst2izaEhkog-0U_pCYdj3VYLLLfQu1Q,37600
+renderplan/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+renderplan/version.py,sha256=IzDi8ICwAkCIEAkLEWx-K3-N7lcU_YB_nClnXM1UInI,422
+renderplan-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+renderplan-0.1.0.dist-info/METADATA,sha256=XmOo0vueTXGAim9lcxtqt0g4CYl10N-QdhXi8LzRTCk,9421
+renderplan-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+renderplan-0.1.0.dist-info/entry_points.txt,sha256=kTbANKPjHGMlrlp9cKq2v0W7K9G-HpHKdKQiwcWa9HA,51
+renderplan-0.1.0.dist-info/top_level.txt,sha256=NL_rJqLd91jX20UlU9zknE65JJLajN0sz4qUJ9NxG6o,11
+renderplan-0.1.0.dist-info/RECORD,,

renderplan-0.1.0.dist-info/WHEEL

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

renderplan-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+renderplan = renderplan.cli:main

renderplan-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

renderplan-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+renderplan