zseriesguy / speakreader

Streaming Speech-to-Text Web Server. Share transcript to many in realtime.

SpeakReader

What is SpeakReader

There is someone that attends my church that is hearing impaired. We no longer have someone to sign for her. That was the inspiration for the development of this project.

There seems to be many speech-to-text applications out there. But they all seem to be designed for input and output on the same device. I wanted something that could output the speech-to-text transcription to many in realtime.

SpeakReader is a web server application that takes microphone or line-in input and transcribes it to text in realtime. It then sends the transcription text to listening web clients. Anyone with a smart device (smart phone, tablet, laptop, etc.) can connect to the web server and read what is being spoken.

SpeakReader can be used anywhere that spoken words need to be transcribed to text and shared to many such as churches, conferences, meetings, etc. It is written in Python and can run on any platform that supports Python. As a very low cost solution, I am running SpeakReader in production at my church on a Raspberry Pi 3.

SpeakReader supports the following speech-to-text transcription services:

• Google Speech-to-Text
• IBM Watson Speech-to-Text
• Microsoft Azure Speech-to-Text

Not all transcription service providers are available on all platforms. For example, Microsoft Azure Speech Services is currently only available for Windows 32-bit and 64-bit, MacOS, and Linux 64-bit on non-ARM processors.

If you find value in this project, please consider making a donation via PayPal. 80% of your donation will go to the Ladonia Baptist Church building debt-retirement fund. You may also make a donation directly to the church building fund through their online-giving system.

Requirements

SpeakReader requires Python 3.6 or higher.

Installation

Installation instructions can be found in the wiki.

Usage

The default port for SpeakReader after installation is 8880. This can be changed in the configuration on the settings page or by editing the config.ini file.

Connect a microphone or line-in to the server that you are running SpeakReader on and start SpeakReader. The recommendation is to have a good clean input feed. For my production server, I use a line feed directly off of the church sound board. The cleaner the input feed, the more accurate the transcription results will be.

The transcription services do not have to be "trained" to the speaker. It gets the majority of the words correct. But due to differences in speaking style, clarity, accents, the transcription services may not get every word correct.

Profanity filters have been enabled by default in the transcription services to mask any intentional or unintentional profanity. This can be changed on the settings page as well as editing a custom list of censored words.

User Interface

Access the web server. Be sure to include the port if you are not using the standard 80 or 443 (http://speakreaderURL:8880).

The home page on the SpeakReader web server is the transcription text. The web page automatically scrolls to bottom. To pause auto scroll, just scroll back in the transcription text. A bottom button will appear in the upper right that, when clicked, will resume auto scrolling at the bottom position in the transcript.

To adjust the font, tap or click in the transcription window. A tab will slide up from the bottom allowing font size and color theme adjustment.

Management Console

To manage SpeakReader, access the web server's /manage page.

There are four tabs on the management page: Status, Settings, Transcripts, and Logs.

Status Page

The Status page:

• Shows the current status of the transcription engine.
• Shows the current input device.
• Allows for starting and stopping the transcription engine.
• Allows for restarting and shutting down the SpeakReader server.
• View list of connected listeners
• Monitor the active transcript or console log.

Settings Page

The Settings page allows you to make and save changes to the configuration which are stored in the config.ini file.

Settings include:

• Select the microphone or line-in input device.
• Create a userid/password for restricting access to the management console.
• Upload your GoogleAPI credentials file.
• Whether or not to start the transcribe engine on server start up.
• Whether or not to launch a web browser to the server on server start up.
• Set the folder where to store transcripts.
• Set the port the server will listen on.
• Enable HTTPS for secure communications.
• Enable/disable censorship and add additional words to the censored words list.

Transcripts Page

The Transcripts page shows a list of all transcript files in the Transcripts folder. From the list, you can view, download, or delete the transcript.

Logs Page

The Logs page shows a list of all log files in the Logs folder. From the list, you can view, download, or delete the log.