Skip to content

Home

Jump to bottom
Henry Kroll III edited this page Dec 4, 2016 · 4 revisions

Update: Python3 branch supporting gstreamer-1.0 is available for checkout. Some dependencies may need to be updated. These instructions may need updates as well.

About

FreeSpeech is a free and open-source (FOSS), cross-platform desktop application front-end for PocketSphinx dictation, voice transcription, and realtime speech recognition. FreeSpeech enables speaker-independent voice recognition with dynamic language learning capability using the PocketSphinx speech recognition engine. Get FreeSpeech via git from Github (https://github.com/themanyone/freespeech-vr).

In addition to dictation, FreeSpeech now provides voice commands and keyboard emulation, so users can dictate into other apps, remote terminals, and virtual machines.

Installation

Windows: Installation might work using ossbuild (http://code.google.com/p/ossbuild/) for gstreamer. Will update this once we get a windows machine to test it.

Linux/Cygwin

Update: Python3 branch is available. Some packages listed here need updates versions if planning to check out new python3 branch.

The following packages may be installed through the package manager.

Fedora

su -c 'yum groupinstall "C Development Tools and Libraries"'
su -c 'yum -y install gstreamer-python sphinxbase-libs \
pocketsphinx-libs pocketsphinx sphinxbase pocketsphinx-plugin \
python-simplejson python-xlib pygtk2 git'

Ubuntu

Open a terminal and install the pocketsphinx repository: Todo: PPA is outdated. Search for a new repository PPA containing cmusphinx.

sudo add-apt-repository ppa:dhuggins/cmusphinx

Enter password and press Enter twice.

Get updates and install dependencies.

sudo apt-get update

sudo apt-get python-xlib python-simplejson python-gtk2 python-gst0.1 \
gstreamer0.10-pocketsphinx sphinx-common python-sphinxbase \
python-pocketsphinx sphinxbase-utils git

If installation balks and says it can't find /media/cdrom the location may be different. The trick is to use the mount command from a terminal to discover where the cd is mounted and make it a link to /media/cdrom

sudo ln -s (location, change this) /media/cdrom

Testing

Before we begin, open volume control, pavucontrol, Audacity (or some other audio recording program that has a recording monitor) and check sound levels. Users should be able to record and play back audio at good volume, but not so high that it's noisy or clipping.

arecord temp.wav -r 16000
aplay temp.wav

Test pocketsphinx

pocketsphinx_continuous

Say something. (It should print lots of spam while doing some (very basic) speech recognition). Don't stop until it recognizes some speech. Our software depends on a working pocketsphinx installation.

[Download CMU-Cam_Toolkit_v2] (http://www.speech.cs.cmu.edu/SLM/CMU-Cam_Toolkit_v2.tar.gz) and unpack it. Read the instructions in the README and edit the Makefile. To summarize, most PC hardware is what they call "little-endian" and it requires this change: Edit CMU-Cam_Toolkit_v2/src/Makefile and remove the # sign in front of this line:

BYTESWAP_FLAG	= -DSLM_SWAP_BYTES

Run make to build the tools.

cd CMU-Cam_Toolkit_v2/src
make

Manually copy the tools from ../bin to somewhere in $PATH like: /usr/local/bin

sudo cp ../bin/* /usr/local/bin/

The tools expect to write to /usr/tmp so create one if it isn't there.

sudo ln -s /tmp /usr/tmp

Language files and preferences are copied to /home/$USER/.config but the location may be changed by changing or adding the environment variable, $XDG_CONFIG_HOME

export XDG_CONFIG_HOME=$HOME/.config

Get FreeSpeech Using Git.

cd ~/Downloads
git clone https://github.com/themanyone/freespeech-vr.git

Optionally check out the python3 branch. View the new README.md and install python3 dependencies before using.

git checkout python3

Using FreeSpeech

There is no desktop icon yet. Right-click on the desktop to create one. Launching the program may be done via the Python interpreter.

cd ~/Downloads/frees*
python freespeech.py

Position the microphone somewhere near enough and begin talking. To end of the sentence, say "period" (or "colon", "question-mark", "exclamation-point") Look at the dictionary, "custom.dic" for ideas.

Voice commands are included. A list of commands pops up at start-up or say "show commands" to show them again. The following voice commands are supported (except only "scratch that" is available when using sendkeys X keyboard emulation).

  • file quit - quits the program
  • file open - open a text file in the editor
  • file save (as) - save the file
  • show commands - pops up a customize-able list of spoken commands
  • editor clear - clears all text in the editor and starts over
  • delete - delete [text] or erase selected text
  • insert - move cursor after word or punctuation example: "Insert after period"
  • select - select [text] example: "select the states"
  • go to the end - put cursor at end of document
  • scratch that - erase last spoken text
  • back space - erase one character
  • new paragraph - equivalent to pressing Enter twice

Troubleshooting

Prior to blaming freespeech, make sure audio recording and pocksphinx works. Run pocketsphinx_continuous from the command line in a terminal window and make sure that it works. If not, check your pocketsphinx installation. We regret that we are not affiliated with pocketsphinx and do not have the resources to support it.

In case of messages like this:

Trouble writing /home/*/.config/FreeSpeech/freespeech.idngram
Trouble writing...

It usually means nobody installed [CMU-Cambridge Statistical Language Modeling Toolkit v2] (http://www.speech.cs.cmu.edu/SLM/CMU-Cam_Toolkit_v2.tar.gz) or there is a problem with the tools themselves. Edit the Makefile and follow the instructions therein before running make. Manually copy the files in the bin directory somewhere in your $PATH like /usr/local/bin on Linux or C:\windows\system32 on Windows.

For some reason, the toolkit expects to be able to write to /usr/tmp. The tmpfile() function uses the P_tmpdir defined in <stdio.h>, but the Makefile installs everything under /usr. The quick-fix is to provide /usr/tmp for machines that don't have it.

sudo ln -s /tmp /usr/tmp

Improving accuracy

The biggest improvements in accuracy have been achieved by adjusting the microphone position. Open up the volume control app. On systems that use pulseaudio (Fedora) volume level and microphone selection may be found using pavucontrol. Try making a recording with Audacity (http://audacity.sourceforge.net) and checking the noise levels to make sure it sounds like intelligible speech when played back. Make sure freespeech is using the same mic levels in the volume controls recording tab.

Adapt PocketSphinx to a particular voice or accent for better accuracy. See http://cmusphinx.sourceforge.net/wiki/tutorialadapt

Language corpus

The language corpus that ships with this download, "freespeech.ref.txt" is likely to be very limited. Our excuse is that the small size saves memory while providing room to learn spoken grammar. Don't be surprised if it does not work very well at first. Use the keyboard to manually edit the text in the box until it says what was intended to say. Then hit the "Learn" button. It will try to do better at understanding next time! One may also train personalized grammar by pasting in gobs of text from previously authored websites and documents.

It seems that the PocketSphinx folks were trying to add support for capitalized words. If there is a word like "new" in the dictionary which could also be capitalized, as in "New Mexico" it is enough to make a capitalized copy like so:

    new  N UW
    New  N UW

Now train the new grammar, by using the capatalized form in a few sentences and pressing the Learn button. PocketSphinx will henceforth decide the capitalization depending on the context in which it appears. We tested it and it works! It capitalizes words like "New Mexico" and "The United States of America" but does not capitalize "altered states" nor "new pants". This is a wild idea, but maybe we could make a dictionary containing both capitalized and un-capitalized words. That would save us the effort of going through and capitalizing all the proper names. The only question is would the resulting dictionary be too big? The solution is probably to propose a patch to make PocketSphinx ignore case in the dictionary, using capitalization as it is found in the corpus, not the dictionary.

Don't worry if PocketSphinx learns bad grammar. It's not strictly necessary, but our corpus file, "lm/freespeech.ref.txt" may be manually corrected if it develops poor speech habits. Changes will apply next time anybody presses the "Learn" button.

The language model may be further [tweaked and improved] (http://www.speech.cs.cmu.edu/SLM/toolkit_documentation.html#evallm).

Dictionary

If there is a word that it stubbornly refuses to recognize, even after teaching it with several sentences, edit the dictionary: "freespeech.dic"

Sometimes the dictionary pronunciation can be a little bit off. Notice that some other words have alternate pronunciations denoted with (2). Go ahead and change the pronunciation or add an alternate and see if it doesn't improve immediately the next time the program starts.

This dictionary is based on Pocketsphinx's cmu07a.dic because it contains punctuation, such as ".full-stop" and "?question-mark"). See "freespeech.dic" for the list of punctuation and their pronunciations. Adding new words to the dictionary may be done manually, along with their phonetic representation, but we are working on incorporating a word trainer.

About the CMU Pronouncing Dictionary http://www.speech.cs.cmu.edu/cgi-bin/cmudict

Security and privacy

FreeSpeech does not send any information over the network. Speech recognition is done locally using pocketsphinx. Learned speech patterns are stored in "plain text" format in "$HOME/.config/FreeSpeech/freespeech.ref.txt". Although the file should not be accessible to other users, it is nevertheless good practice not to teach FreeSpeech sensitive or private information like passwords, especially if others share access to the PC.

Clone this wiki locally