Changelog

Generated by releaseledger. Manual edits may be overwritten. Update releaseledger entries and rebuild this file instead.

[0.8.4] - Unreleased

Added

  • Added configurable emphasis gain scaling with numeric dB resolution and a bounded emphasis_gain_scale setting

[0.8.3] - 2026-08-06

Added

  • Added a spoken-form showcase for raw structured text through the PyKokoro pipeline

  • Added configurable SSMD emphasis gain scaling for gain-only automatic emphasis approximation

Changed

  • Changed the kokorog2p minimum to 0.8.0 and enabled source-aware Spokenform preparation

Documentation

  • Documented automatic kokorog2p spoken-form preparation separately from explicit SSMD say-as overrides

[0.8.2] - 2026-08-05

Changed

  • German synthesis defaults to the verified Martin v1.2 fp32 profile with automatic language-aware model and voice resolution

  • GitHub v1.0 model assets use the embedded vocabulary and no longer require a HuggingFace config download

Fixed

  • Fixed managed HuggingFace voice loading to retain the canonical archive file path instead of the containing directory

[0.8.1] - 2026-08-04

Added

  • Added paragraph-unit preparation and streaming for bounded, resumable document rendering

  • Added tri-state spaCy model policy with automatic local model discovery and with_spacy_model() helper

Changed

  • Changed documentation to pipeline-first API and archived legacy examples

Fixed

  • Fixed SSMD pause precedence for explicit zero durations and voice-change boundaries

[0.8.0] - 2026-08-01

Added

  • Added compact AudioResult retention controls and explicit audio-release methods

  • Added configurable AudioSig WSOLA, ESOLA, TD-PSOLA, and phase-vocoder prosody backends with a strict comparison harness

Changed

  • Changed pipeline result finalization to preserve markers while releasing optional segment audio

  • Changed Kokoro teardown to release dependent backend resources deterministically and idempotently

  • Changed combined speech prosody processing to one AudioSig compositor pass with WSOLA as the default and configured fallback behavior

Documentation

  • Documented compact result memory behavior, ownership, release semantics, and the limits of non-streaming generation

  • Documented prosody backend constraints, experimental status, comparison workflow, and segment-level speech-quality limitations

[0.7.4] - 2026-07-30

Changed

  • Changed SSMD emphasis to metadata-preserving by default with opt-in audio approximation

  • Added explicit SSMD emphasis policies and diagnostics for plain, approximate, warning, and error handling

Documentation

  • Fixed the tokenizer configuration example in the basic usage documentation

  • Improved user documentation examples and installation guidance across the supported workflows

[0.7.2] - 2026-07-29

Added

  • Added default-safe SSMD 0.8 front-matter parsing with title and document metadata

  • Added portable provider voice bindings, deterministic pause-default precedence, marker offsets, resolver-based audio annotations, and explicit capability diagnostics

Changed

  • Raised the SSMD dependency window to >=0.8.0,<0.9 and documented literal-header migration

[0.7.1] - 2026-07-28

Added

  • Added capability-driven ONNX execution-provider resolution for runtime-reported providers including NNAPI and XNNPACK

  • Added source-, variant-, and quality-aware model asset inspection APIs

Fixed

  • Fixed Kokoro downloads and status checks to use exact model, config, and voice archive paths

Documentation

  • Documented Android/Termux provider selection and dependency-light asset inspection

[0.7.0] - 2026-07-27

Added

  • Added phrase-based short-sentence handling with energy-valley cutting for improved annunciation of short phrases

  • Added SHA256 verification, pinned HF revisions with offline mode, and stale download lock recovery

Changed

  • Changed SSMD syntax to [text]{key=”value”} annotation format, replacing legacy shorthand notations

  • Changed HuggingFace v1.0 ONNX repository to use timestamped model variant

Fixed

  • Fixed Windows download cache path handling for model and voice files

  • Fixed voice name in English example script

Documentation

  • Changed documentation format from reStructuredText to Markdown for improved readability and GitHub rendering

[0.6.5] - 2026-02-11

Added

  • Added better support for spaCy models across all languages

[0.6.4] - 2026-01-31

Added

  • Added automatic pause mode that adds pauses after sentences

Documentation

  • Changed documentation with updated usage examples

[0.6.3] - 2026-01-28

Added

  • Added German language support with ONNX model files

[0.6.2] - 2026-01-27

Added

  • Added threading support for concurrent audio generation

Fixed

  • Fixed Windows cache path handling and default backend selection

[0.6.1] - 2026-01-25

Fixed

  • Fixed unit tests and mypy type errors

[0.6.0] - 2026-01-25

Added

  • Added integrated splitter into doc parsers, removing separate splitter pipeline

  • Added automatic language detection based on voice selection

  • Added improved SSMD parsing with better span handling

Changed

  • Changed pipeline lifecycle and audio generator for better stability

Fixed

  • Fixed paragraph splitting, pause parsing, and voice downloading

[0.5.1] - 2026-01-23

Added

  • Added model_path and voices_path settings in pipeline

Fixed

  • Fixed missing espeak and soundfile dependencies

Removed

  • Removed deprecated _phoneme_dictionary

[0.5.0] - 2026-01-23

Added

  • Added new pipeline architecture with improved phoneme handling

  • Added improved PhonemeSegment with better prosody support

  • Added improved pipeline architecture with multiple fixes

Changed

  • Changed pipeline to drop legacy tokenizer in favor of new architecture

  • Changed all examples to use new pipeline format

Fixed

  • Fixed phrasplit splitter and kokorog2p issues

[0.4.0] - 2026-01-17

Added

  • Added audio transcript support for better unit testing and debugging

Changed

  • Changed SSMD parser to adapt to new phoneme syntax in kokorog2p

Fixed

  • Fixed SSMD parser and detection logic

[0.3.0] - 2026-01-14

Added

  • Added GenerationConfig dataclass to simplify TTS API

  • Added heading support from SSMD markup

  • Added configurable short sentence handler with multiple strategies

Fixed

  • Fixed SSMD phoneme override bug in segment merging

  • Fixed short sentence handling and unit tests

[0.2.0] - 2026-01-11

Added

  • Added SSMD syntax support with voice switching and prosody control

  • Added says-as implementation for cardinal, ordinal, and telephone numbers

  • Added optimal phoneme length calculation

Changed

  • Changed tokenizer and improved backend stability

[0.1.0] - 2026-01-07

Added

  • Added model and voice download with manager classes for better code organization

  • Added configurable pause times for clause, sentence, and paragraph boundaries

  • Added session parameter configuration and pause variance support

  • Added HuggingFace Kokoro v1.1-zh model support

  • Added automatic splitting when max token limit is reached