Skip to content

Latest commit

 

History

History
114 lines (74 loc) · 7.37 KB

README.md

File metadata and controls

114 lines (74 loc) · 7.37 KB
Raw

say2file

Text-to-speech, speaks text into a sound file.

Bugs Reliability Rating Maintainability Rating Duplicated Lines (%) Vulnerabilities Security Rating

This utility supports two different AI-based text-to-speech providers:

When enabled with an API key from the provider, it can to convert text to one or more audio files.

API KEY REQUIRED

Both providers require an API key. This utility does not provide the required API key, however you can register for one by:

Configuration

Copy .env-sample to .env and place in the current folder in order to avoid needing to specify configuration parameters on the command line. See the .env-example file:

  • For ElevenLabs, you only need to add the API key from your profile to the .env file. Define a LABSKEY=api-key-here (see above) in the .env file and you're good to go.
  • For IBM Watson, you should define a pair of definitions in the .env file: the IBMKEY (the API key) and the IBMURL (service link) must be defined.

Note: It is also possible to define both providers, and switch back and forth on the command line with the -p option.

With this in place, you can simply run:

  • say2file -l to get a list of available voices, or
  • say2file "Hello there." to generate a corresponding audio.mp3 file.You can also run
  • say2file -f sample.txt to read the sample.txt file and convert it to audio, or
  • say2file -f sample.txt -s to split the file into multiple audio files.

These are just some examples. See the syntax below for more options.

Syntax

say2file [options] [optional text to convert to audio]
Options: --file or -f with filename (input text file)
         --split or -s (split the input text file into multiple output files)
         --out or -o with rootname (produces rootname.type or rootname-n.type)
         --provider or -p with provider(ibm, watson, eleven or 11. default is eleven)
         --list or -l (to list available voices)
         --key or -k with the API key to use (if not in .env)
         --version or -v (show version)
         --help or -h or -? (this help)

Addition options when using the ElevenLabs provider:
         --voice or -w (who), choices: default or voice-ID
         --model or -m, choices: e1, m1, m2 for english/multilingual
         --type or -t with type, choices: mp3 or wav
         --rate or -r with rate, mp3 choices: 64, 96, 128, or 192
                                 wav choices: 16000, 22050, 24000, or 44100

Addition options when using the IBM Watson provider:
         --url or -u with the service URL to use (if not in .env)
         --voice or -w (who), choices: michael olivia kevin lisa allison henry james kate charlotte craig madison
         --type or -t with type, choices: wav, mp3, mpeg, flac, ogg
         --rate or -r with rate, sample rate: default is 44100

For IBM, the voice can can be: michael, olivia, kevin, lisa, allison, henry, james, kate, charlotte, craig, or madison.

For ElevenLabs, please use the --list or -l option to see the available voices and their IDs. You will need to specify the ID when using the --voice or -w option with ElevenLabs.

Note: Free tier users of ElevenLabs are limited to mp3_44100_128 format (MP3 output with 44100 Hz at 128 kbps audio files). If you're a free tier user, for best quality, you should avoid specifying the --format or --rate options and let this utility use the default values. There is also a problem with downloading .wav files from ElevenLabs, so you should avoid specifying the --type option as well, or use --provider ibm to use IBM Watson instead for WAV audio.

Voices

You can sample a list of community voices to add to your collection here: https://elevenlabs.io/voice-library and, once added, they will show up in your --list output. This will provide the ID. For example, if I add the distinguished older British "Edwin" to my library, it shows as custom ID dcvIfKGCH8jXVgG77zhi. Similarly, your custom ones will be at the end of the list. I can then use this ID to generate audio with the --voice option:

say2file -w dcvIfKGCH8jXVgG77zhi "Hello there."

You can do the same with your own custom IDs added to your ElevenLabs library through the ElevenLabs website.

Example Usage

There are two forms of use: simple text on the command line, or text read from a file. Text read from a file can be split into multiple separate audio output files if the -s option is specified:

say2file Hello there, this is some text.

This produces an audio.mp3 output file, using the en-US_MichaelV3Voice (Michael) default voice that says the text provided.

Quotes around the remaining commandline options are not required, but are recommended if you have spaces in your text.

say2file -p ibm -t wav "Hello there, this is some text."

This produces an audio.wav output file, using IBM Watson with the en-US_MichaelV3Voice (Michael) default voice that says the text provided on the rest of the line.

say2file -p 11 "Hello there, this is some text."

This produces an audio.mp3 output file, using the say2file default ElevenLabs voice. Since this is the default provider, the -p option is not actually required.

say2file -f sample.txt -s

This reads a sample.txt input file and for each line splits the file (-s) by lines and finds (in this case) three uncommented lines to produce multiple audio files named audio-1.wav, audio-2.wav and audio-3.wav.

say2file -t mp3 -r 22050 -w kate -o voice Hello there.

This produces a single MP3 file using Kate's voice (en-GB) with a sample rate of 22050 in voice.mp3 where the audio is saying 'Hello there.' from the command line rather than a file.

say2file -t=mp3 -r=22050 -w=kate -o=voice Hello there.

This is the same command with alternate syntax.