KokoroSharp

KokoroSharp is a fully-featured inference engine for Kokoro TTS, built entirely in C# with ONNX runtime. It enables developers to perform flexible and fast text-to-speech synthesis utilizing multiple speakers and languages.

• Plug & Play integration via the nuget package. All dependencies are handled automatically.
• Nuget package includes ALL voices released by hexgrad with their Kokoro 82M v1.0 and v1.1-zh releases.
• High-level interface designed to suit both beginners and power users.
• Text-segment streaming for seamless text-to-speech. Responses feel instant.
• Voice mixing with no restrictions on the amounts of voices mixed, and ability to save/load mixed voices.
• Linear job scheduling with background worker as dispatcher.
• Optional multi-platform playback support with pre-integrated audio queue handling.

Supports languages/accents:

• [American English, British English, MandarinChinese, Japanese, Hindi, Spanish, French, Italian, Brazilian/Portuguese].

• On Windows, Linux, and MacOS: Install via Nuget (Package Manager or CLI), and you're set!
• Selecting the correct package: KokoroSharp.CPU is plug-and-play. For GPU support, see RUNNING_ON_GPU.md.
• On Android: KokoroSharp should work on mobile as of v0.8.3, using KokoroSharp.Android.
• On iOS: iOS is supported as of v0.8.1. Full synthesis, and playback with a custom CrossPlatformHelper.CustomAudioPlayer.

KokoroTTS tts = KokoroTTS.LoadModel(); // Load or download the model (~320MB for full precision)
KokoroVoice heartVoice = KokoroVoiceManager.GetVoice("af_heart"); // Grab a voice of your liking,
while (true) { tts.SpeakFast(Console.ReadLine(), heartVoice); } // .. and have it speak your text!
// Note: Language detection is automated based on what the loaded voice supports.

Above is a simple way to get started on the highest level. For more control, check out the example Program, which covers more advanced parts like job scheduling, voice mixing, and long-term, speaker-agnostic playback queuing.

KokoroTTS tts = KokoroTTS.LoadModel(KModel.zh_float32); // Load or download the Kokoro v1.1-zh model,
tts.SpeakFast("你好，世界！", KokoroVoiceManager.GetVoice("zf_001")); // .. and speak with any of its voices!

KokoroWavSynthesizer synth = KokoroWavSynthesizer.LoadModel();
byte[] audioBytes = synth.Synthesize("Hello world!", KokoroVoiceManager.GetVoice("af_heart")); // ..or an async equivalent.
KokoroWavSynthesizer.SaveAudioToFile(audioBytes, "hello.wav"); //.. or play back with your output of choice.

• All communication with the AI model and playback devices happens on background threads, letting the main thread focus on rendering the UI in peace. The library is carefully designed with thread-safety in mind.

• The voices folder is automatically copied to your build path when you build and is ready to be accessed. Developers may opt to remove it when shipping their apps.

• Mind that LoadVoicesFromPath exists as an option, in case developers want to implement their custom voice-loading logic when shipping a project that utilizes KokoroSharp for text-to-speech synthesis.

• In addition, the built-in tokenization (text -> tokens) is NOT mandatory, and can be bypassed for platforms like Android/iOS, given developers provide pre-phonemized input with their phonemization solution of choice.

• KokoroSharp uses MisakiSharp, which can also be used as a standalone phonemization solution, native in C#.

• This project is licensed under the MIT License.
• The Kokoro 82M model and its voices are released under the Apache License.