Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation lacks examples and man page #156

Open
gnbl opened this issue Sep 24, 2016 · 1 comment
Open

Documentation lacks examples and man page #156

gnbl opened this issue Sep 24, 2016 · 1 comment

Comments

@gnbl
Copy link

gnbl commented Sep 24, 2016

https://github.com/espeak-ng/espeak-ng#documentation refers to https://github.com/espeak-ng/espeak-ng/blob/master/docs/index.md but neither provide usage info or examples.
No man pages online yet either.

So here it goes. Man page:

>"C:\Program Files (x86)\eSpeak NG\espeak-ng.exe" --help

eSpeak text-to-speech: 1.48.15  16.Apr.15  Data at: C:\Program Files (x86)\eSpeak NG\\espeak-ng-data

espeak-ng [options] ["<words>"]

-f <text file>   Text file to speak
--stdin    Read text input from stdin instead of a file

If neither -f nor --stdin, then <words> are spoken, or if none then text
is spoken from stdin, each line separately.

-a <integer>
           Amplitude, 0 to 200, default is 100
-d <device>
           Use the specified device to speak the audio on. If not specified, the
           default audio device is used.
-g <integer>
           Word gap. Pause between words, units of 10mS at the default speed
-k <integer>
           Indicate capital letters with: 1=sound, 2=the word "capitals",
           higher values indicate a pitch increase (try -k20).
-l <integer>
           Line length. If not zero (which is the default), consider
           lines less than this length as end-of-clause
-p <integer>
           Pitch adjustment, 0 to 99, default is 50
-s <integer>
           Speed in approximate words per minute. The default is 175
-v <voice name>
           Use voice file of this name from espeak-ng-data/voices
-w <wave file name>
           Write speech to this WAV file, rather than speaking it directly
-b         Input text encoding, 1=UTF8, 2=8 bit, 4=16 bit
-m         Interpret SSML markup, and ignore other < > tags
-q         Quiet, don't produce any speech (may be useful with -x)
-x         Write phoneme mnemonics to stdout
-X         Write phonemes mnemonics and translation trace to stdout
-z         No final sentence pause at the end of the text
--compile=<voice name>
           Compile pronunciation rules and dictionary from the current
           directory. <voice name> specifies the language
--compile-debug=<voice name>
           Compile pronunciation rules and dictionary from the current
           directory, including line numbers for use with -X.
           <voice name> specifies the language
--compile-mbrola=<voice name>
           Compile an MBROLA voice
--compile-intonations
           Compile the intonation data
--compile-phonemes
           Compile the phoneme data
--ipa      Write phonemes to stdout using International Phonetic Alphabet
--path="<path>"
           Specifies the directory containing the espeak-ng-data directory
--pho      Write mbrola phoneme data (.pho) to stdout or to the file in --phonout
--phonout="<filename>"
           Write phoneme output from -x -X --ipa and --pho to this file
--punct="<characters>"
           Speak the names of punctuation characters during speaking.  If
           =<characters> is omitted, all punctuation is spoken.
--sep=<character>
           Separate phonemes (from -x --ipa) with <character>.
           Default is space, z means ZWJN character.
--split=<minutes>
           Starts a new WAV file every <minutes>.  Used with -w
--stdout   Write speech output to stdout
--tie=<character>
           Use a tie character within multi-letter phoneme names.
           Default is U+361, z means ZWJ character.
--version  Shows version number and date, and location of espeak-ng-data
--voices=<language>
           List the available voices for the specified language.
           If <language> is omitted, then list all voices.
-h, --help Show this help.

Example(s):

>"C:\Program Files (x86)\eSpeak NG\espeak-ng.exe"
Hello world. By default, I just read what's typed on the command line after you hit Enter..
Exit with CTRL+C..
^C

List available voices:

>"C:\Program Files (x86)\eSpeak NG\espeak-ng.exe" --voices
Pty Language       Age/Gender VoiceName          File                 Other Languages
 5  af              --/M      afrikaans          gmw\af
 5  am              --/-      amharic            sem\am
 5  an              --/M      aragonese          roa\an
 5  as              --/-      assamese           inc\as
 5  az              --/-      azerbaijani        trk\az
 5  bg              --/-      bulgarian          zls\bg
 5  bn              --/M      bengali            inc\bn
 5  bs              --/M      bosnian            zls\bs
 5  ca              --/M      catalan            roa\ca
 5  cs              --/M      czech              zls\cs
 5  cy              --/M      welsh              cel\cy
 5  da              --/M      danish             gmq\da
 5  de              --/M      german             gmw\de
 5  el              --/M      greek              grk\el
 5  en              --/M      default            default
 5  en-029          --/M      en-westindies      gmw\en-029           (en 10)
 2  en-gb           --/M      english            gmw\en               (en 2)
 5  en-gb-scotland  --/M      en-scottish        gmw\en-GB-scotland   (en 4)
 5  en-gb-x-gbclan  --/M      english-north      gmw\en-GB-x-gbclan   (en-gb 3)(en 5)
 5  en-gb-x-gbcwmd  --/M      english_wmids      gmw\en-GB-x-gbcwmd   (en-gb 9)(en 9)
 5  en-gb-x-rp      --/M      english_rp         gmw\en-GB-x-rp       (en-gb 4)(en 5)
 2  en-us           --/M      english-us         gmw\en-US            (en 3)
 5  eo              --/M      esperanto          art\eo
 5  es              --/M      spanish            roa\es
 5  es-419          --/M      spanish-latin-am   roa\es-419           (es-mx 6)(es 6)
 5  et              --/-      estonian           urj\et
 5  eu              --/-      basque             xaq\eu
 5  fa              --/-      Persian+English-UK ira\fa
 5  fa              --/-      Persian+English-US ira\fa-en-us
 5  fa-Latn         --/-      persian-pinglish   ira\fa-Latn
 5  fi              --/M      finnish            urj\fi
 5  fr-be           --/M      french-Belgium     roa\fr-BE            (fr 8)
 5  fr-fr           --/M      french             roa\fr               (fr 5)
 5  ga              --/-      irish-gaeilge      cel\ga
 5  gd              --/-      scottish-gaelic    cel\gd
 5  gn              --/-      guarani            sai\gn
 5  grc             --/M      greek-ancient      grk\grc
 5  gu              --/-      gujarati           inc\gu
 5  hi              --/M      hindi              inc\hi
 5  hr              --/M      croatian           zls\hr               (hbs 5)
 5  hu              --/M      hungarian          urj\hu
 5  hy              --/M      armenian           axm\hy
 5  hy-arevmda      --/M      armenian-west      axm\hy-arevmda       (hy 8)
 5  ia              --/-      interlingua        art\ia
 5  id              --/M      indonesian         poz\id
 5  is              --/M      icelandic          gmq\is
 5  it              --/M      italian            roa\it
 5  jbo             --/-      lojban             art\jbo
 5  ka              --/-      georgian           ccs\ka
 5  kl              --/-      greenlandic        esx\kl
 5  kn              --/-      kannada            dra\kn
 5  ko              --/M      Korean             ko
 5  ku              --/M      kurdish            ira\ku
 5  ky              --/-      kyrgyz             trk\ky
 5  la              --/M      latin              itc\la
 5  lfn             --/M      lingua_franca_nova art\lfn
 5  lt              --/M      lithuanian         xaq\lt
 5  lv              --/M      latvian            xaq\lv
 5  mk              --/M      macedonian         zls\mk
 5  ml              --/M      malayalam          dra\ml
 5  mr              --/-      marathi            inc\mr
 5  ms              --/M      malay              poz\ms
 5  mt              --/-      maltese            sem\mt
 5  my              --/-      burmese            sit\my
 5  nci             --/M      nahuatl-classical  azc\nci
 5  ne              --/M      nepali             inc\ne
 5  nl              --/M      dutch              gmw\nl
 5  no              --/M      norwegian          gmq\no               (nb 5)
 5  om              --/-      oromo              cus\om
 5  or              --/-      oriya              inc\or
 5  pa              --/-      punjabi            inc\pa
 5  pap             --/-      papiamento         roa\pap
 5  pl              --/M      polish             zls\pl
 5  pt-br           --/M      brazil             roa\pt-BR            (pt 5)
 5  pt-pt           --/M      portugal           roa\pt-PT            (pt 6)
 5  ro              --/M      romanian           roa\ro
 5  ru              --/M      russian            zls\ru
 5  si              --/-      sinhala            inc\si
 5  sk              --/M      slovak             zls\sk
 5  sl              --/-      slovenian          zls\sl
 5  sq              --/M      albanian           ine\sq
 5  sr              --/M      serbian            zls\sr
 5  sv              --/M      swedish            gmq\sv
 5  sw              --/M      swahili            bnt\sw
 5  ta              --/M      tamil              dra\ta
 5  te              --/-      telugu             dra\te
 5  tn              --/M      setswana           bnt\tn
 5  tr              --/M      turkish            trk\tr
 5  tt              --/M      tatar              trk\tt
 5  ur              --/-      urdu               inc\ur
 5  vi              --/M      vietnam            aav\vi
 5  vi-vn-x-central --/M      vietnam_hue        aav\vi-VN-x-central
 5  vi-vn-x-south   --/M      vietnam_sgn        aav\vi-VN-x-south
 5  zh              --/M      Mandarin           sit\cmn
 5  zh-yue          --/M      cantonese          sit\yue              (yue 5)(zhy 5)

No female voices?
https://thomashunter.name/blog/female-voice-using-espeak/

>"C:\Program Files (x86)\eSpeak NG\espeak-ng.exe" -ven-us+f4 -s170 "6 new wireless networks found"

No female voices! (?)

Create WAV audio file:
>"C:\Program Files (x86)\eSpeak NG\espeak-ng.exe" -w spoken.wav "Voice in a wave file"

WAV file info:

>sox-14.4.2\sox.exe --info spoken.wav

Input File     : 'spoken.wav'
Channels       : 1
Sample Rate    : 22050
Precision      : 16-bit
Duration       : 00:00:01.41 = 31025 samples ~ 105.527 CDDA sectors
File Size      : 62.1k
Bit Rate       : 353k
Sample Encoding: 16-bit Signed Integer PCM
@casualdegenerate
Copy link

There is no documentation on what certain arguments are, such as -d --device
All I want is to know how to set the --device to a sink so I can use it with what I made.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants