rb-edge-tts 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55add763b62d9ac29318185e9ab86a0f2fa34dbb7923710b033127e5a391f2b7
+  data.tar.gz: 709b647bf243f7c51be6412e8449bda7a25d2087ab360c67b02033d74b47f725
+SHA512:
+  metadata.gz: 83792252d3b5556e06169d2501e0f72d2abed2e7590e802621d3fac450726bfadd289c890d878f2837cc676253a48ea7e01df665eef9a565dc27dfa2f4d0ae5c
+  data.tar.gz: 0a6204026e6dcbb5a3a7174f79cc304f81b5356b0ded366a41efe00dae347f15a59cc25243a9924fb42ea4331c75eaee0ed5d7669d80fdc410329b692fe7a81a

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.12'
+  gem 'rubocop', '~> 1.50'
+  gem 'rubocop-rspec', '~> 2.20'
+  gem 'simplecov', '~> 0.22'
+end
+
+group :development, :test do
+  gem 'debug', '~> 1.8'
+end

data/LICENSE

@@ -0,0 +1,195 @@
+The MIT license is used for 'src/edge_tts/srt_composer.py' only. All
+remaining files are licensed under the LGPLv3.
+
+-----------------------------------------------------------------------
+
+The MIT License
+
+Copyright (c) 2014-2023 Christopher Down
+Copyright (c) 2025- rany <rany@riseup.net>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+-----------------------------------------------------------------------
+
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,257 @@
+# rb-edge-tts
+
+[![Gem Version](https://badge.fury.io/rb/rb-edge-tts.svg)](https://badge.fury.io/rb/rb-edge-tts)
+[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
+
+Microsoft Edge Online Text-to-Speech Service (Ruby Gem).
+
+This is a Ruby implementation of the Microsoft Edge Online Text-to-Speech (TTS) service. It provides a simple and easy-to-use interface, allowing you to use high-quality Edge TTS voices directly within your Ruby applications or via the command line.
+
+This project is a port of the Python project [edge-tts](https://github.com/rany2/edge-tts).
+
+## Features
+
+- **High-Quality Voices**: Direct access to Microsoft Edge's online neural voices.
+- **Multi-Language Support**: Supports 100+ languages and 400+ voices.
+- **Highly Customizable**: Adjustable rate, volume, and pitch.
+- **Subtitle Generation**: Supports generating subtitles in SRT format.
+- **Command-Line Tools**: Includes `rb-edge-tts` and `rb-edge-playback` CLI tools.
+- **Lightweight**: Removed unnecessary async dependencies, using standard Ruby libraries and efficient WebSocket handling.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rb-edge-tts'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install rb-edge-tts
+```
+
+## Quick Start
+
+### Command Line Usage
+
+`rb-edge-tts` provides a powerful command-line interface.
+
+**Basic Usage: Generate MP3**
+
+```bash
+$ rb-edge-tts --text 'Hello, world!' --write-media hello.mp3
+```
+
+**Generate Audio and Subtitles**
+
+```bash
+$ rb-edge-tts --text 'Hello, world!' --write-media hello.mp3 --write-subtitles hello.srt
+```
+
+**Use a Specific Voice**
+
+```bash
+$ rb-edge-tts --text 'Hello, world!' --voice en-GB-SoniaNeural --write-media hello.mp3
+$ rb-edge-tts -f test.txt --write-media test.mp3 -v de-DE-AmalaNeural
+```
+
+**Adjust Parameters (Rate, Volume, Pitch)**
+
+```bash
+$ rb-edge-tts --rate=+20% --volume=+10% --pitch=+5Hz --text 'Hello, world!' --write-media output.mp3
+```
+
+**Instant Playback**
+
+Use the `rb-edge-playback` command to play the generated speech immediately (requires `mpv` installed):
+
+```bash
+$ rb-edge-playback --text 'Hello, world!'
+```
+
+**List All Available Voices**
+
+```bash
+$ rb-edge-tts --list-voices
+```
+
+### Ruby Library Usage
+
+**Basic Example**
+
+```ruby
+require 'rb_edge_tts'
+
+# Use default voice
+communicate = RbEdgeTTS::Communicate.new('Hello, world!')
+communicate.save("output.mp3")
+```
+
+**Advanced Example: Custom Parameters**
+
+```ruby
+require 'rb_edge_tts'
+
+communicate = RbEdgeTTS::Communicate.new(
+  'Hello, world!',
+  "en-US-AriaNeural",
+  rate: "+10%",      # Speed
+  volume: "+20%",    # Volume
+  pitch: "+5Hz"      # Pitch
+)
+communicate.save("output.mp3")
+```
+
+**Generating Subtitles**
+
+```ruby
+require 'rb_edge_tts'
+
+communicate = RbEdgeTTS::Communicate.new('Hello, world!')
+submaker = RbEdgeTTS::SubMaker.new
+
+File.open("output.mp3", "wb") do |file|
+  communicate.stream do |chunk|
+    if chunk.type == "audio"
+      file.write(chunk.data)
+    elsif %w[WordBoundary SentenceBoundary].include?(chunk.type)
+      submaker.feed(chunk)
+    end
+  end
+end
+
+File.write("output.srt", submaker.to_srt)
+```
+
+**Streaming**
+
+```ruby
+require 'rb_edge_tts'
+
+communicate = RbEdgeTTS::Communicate.new('Hello, world!')
+
+communicate.stream do |chunk|
+  if chunk.type == "audio"
+    # Process audio data chunk (chunk.data)
+    print "." 
+  end
+end
+```
+
+## Voice Management
+
+You can use `VoicesManager` to find and filter available voices.
+
+```ruby
+require 'rb_edge_tts'
+
+# Get all available voices
+voices = RbEdgeTTS::VoicesManager.create
+
+# Find all Chinese (Simplified) Female voices
+chinese_female_voices = voices.find(locale: "zh-CN", gender: "Female")
+
+chinese_female_voices.each do |voice|
+  puts "#{voice.short_name}: #{voice.friendly_name}"
+end
+```
+
+## Development Guide
+
+This section is for developers who want to contribute to `rb-edge-tts` or build from source.
+
+### Requirements
+
+- Ruby 3.0 or higher
+
+### Local Setup
+
+1.  **Clone the repository**
+
+    ```bash
+    git clone https://github.com/ZPVIP/rb-edge-tts.git
+    cd rb-edge-tts
+    ```
+
+2.  **Install dependencies**
+
+    ```bash
+    bundle install
+    ```
+
+3.  **Run tests**
+
+    We use `rspec` for testing.
+
+    ```bash
+    bundle exec rspec
+    ```
+
+### Local Build and Install
+
+If you modified the code and want to test it locally:
+
+1.  **Build the Gem**
+
+    ```bash
+    gem build rb-edge-tts.gemspec
+    ```
+
+    This will generate an `rb-edge-tts-<version>.gem` file.
+
+2.  **Install the Gem**
+
+    ```bash
+    gem install ./rb-edge-tts-<version>.gem
+    ```
+
+3.  **Verify Installation**
+
+    ```bash
+    rb-edge-tts --version
+    ```
+
+### Publishing
+
+To publish a new version to RubyGems (requires permissions):
+
+1.  Update the version number in `lib/rb_edge_tts/version.rb`.
+2.  Update `CHANGELOG.md`.
+3.  Build and push:
+
+    ```bash
+    gem build rb-edge-tts.gemspec
+    gem push rb-edge-tts-<version>.gem
+    ```
+
+## Dependencies
+
+- `eventmachine`: For WebSocket event loop.
+- `faye-websocket`: WebSocket client implementation.
+- `json`: JSON data processing.
+- `terminal-table`: For formatting CLI output.
+- `net/http`: For fetching voice lists (Standard Library).
+
+## License
+
+This project is licensed under the [GNU Lesser General Public License v3.0 (LGPLv3)](LICENSE).
+
+The `lib/rb_edge_tts/srt_composer.rb` file is licensed under the MIT License.
+
+## Acknowledgments
+
+This project is a Ruby port of the Python project [edge-tts](https://github.com/rany2/edge-tts). Thanks to [rany2](https://github.com/rany2) for developing the original version, making high-quality TTS conversion possible via the Edge interface.
+
+For questions regarding Python implementation details, please refer to the original project.
+
+---
+
+[Fork on GitHub](https://github.com/zpvip/rb-edge-tts) | [Report an Issue](https://github.com/zpvip/rb-edge-tts/issues)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/examples/async_audio_gen_with_dynamic_voice_selection.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rb_edge_tts'
+require 'async'
+
+TEXT = 'Hoy es un buen día.'
+OUTPUT_FILE = 'spanish.mp3'
+
+Async do
+  voices = RbEdgeTTS::VoicesManager.create
+  voice = voices.find(locale: 'es', gender: 'Male')
+
+  if voice.empty?
+    puts 'No male Spanish voice found'
+    exit 1
+  end
+
+  selected_voice = voice.sample
+  puts "Using voice: #{selected_voice.name}"
+
+  communicate = RbEdgeTTS::Communicate.new(TEXT, selected_voice.name)
+  communicate.save(OUTPUT_FILE)
+
+  puts "Audio saved to #{OUTPUT_FILE}"
+end.wait

data/examples/async_audio_gen_with_predefined_voice.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rb_edge_tts'
+
+TEXT = 'Hello World!'
+VOICE = 'en-GB-SoniaNeural'
+OUTPUT_FILE = 'test.mp3'
+
+communicate = RbEdgeTTS::Communicate.new(TEXT, VOICE)
+communicate.save(OUTPUT_FILE)
+
+puts "Audio saved to #{OUTPUT_FILE}"

data/examples/async_audio_gen_with_predefined_voice_async.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rb_edge_tts'
+require 'async'
+
+TEXT = 'Hello World!'
+VOICE = 'en-GB-SoniaNeural'
+OUTPUT_FILE = 'test.mp3'
+
+Async do
+  communicate = RbEdgeTTS::Communicate.new(TEXT, VOICE)
+  communicate.save(OUTPUT_FILE)
+
+  puts "Audio saved to #{OUTPUT_FILE}"
+end.wait

data/examples/async_audio_streaming_with_subtitles.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rb_edge_tts'
+require 'async'
+
+TEXT = 'Hello World!'
+VOICE = 'en-GB-SoniaNeural'
+OUTPUT_FILE = 'test.mp3'
+SRT_FILE = 'test.srt'
+
+Async do
+  communicate = RbEdgeTTS::Communicate.new(TEXT, VOICE)
+  submaker = RbEdgeTTS::SubMaker.new
+
+  File.open(OUTPUT_FILE, 'wb') do |file|
+    communicate.stream do |chunk|
+      if chunk.type == 'audio'
+        file.write(chunk.data)
+      elsif %w[WordBoundary SentenceBoundary].include?(chunk.type)
+        submaker.feed(chunk)
+      end
+    end
+  end
+
+  File.write(SRT_FILE, submaker.get_srt)
+
+  puts "Audio saved to #{OUTPUT_FILE}"
+  puts "Subtitles saved to #{SRT_FILE}"
+end.wait