Skip to content

voxolab/speech-recognition-api

 
 

Repository files navigation

About Build Status

The goal of SG-SpeechWeb-Demo is to provide an online demonstration of various speech recognition systems.

It provides a clean and well documented REST API to interact with. By default, LIUM_SpkDiarization will be used for the diarisation step and CMU Shpinx for the transcribing part.

Installation

API and docs

The REST API is developed with Scala using Play! Framework 2.2.1.

All what you need is a JDK and Play! Framework. You will find how to install Play! on the dedicated website.

Once Play! is installed just launch play run at the root of the project. When all the required libraries will have been downloaded, you should be able to access to the documentation of the API by accessing http://localhost:9000 in your browser.

Dependencies

Glpk, ffmpeg

Locale

Your JVM use the C locale. To do this, before launching play, be sure to set you locale accordingly:

export LC_LANG=C

LIUM_SpkDiarization

The diarization tool used is available on the official Wiki. A version is packaged in ./bin/LIUM_SpkDiarization-4.2.jar. So you don't need to download anything.

CMU Sphinx

TODO

Loading Fixtures

By default, a local SQLite database is used. To create it and load the default fixtures, just run:

./reload-db.sh

Developers

To enter the Play! (SBT) console just type play at the root of the project. Then you'll be able to run multiple commands:

  • compile to compile the source code.
  • ~compile to watch the source code for changes and re-compile when needed.
  • clean to ... clean the source code.
  • test to launch the test suite.
  • ~test to watch the tests source code for changes and launch the test suite when needed.
  • test-only test.AudioFileApiControllerSpec to only launch the test suite contained in the class AudioFileApiControllerSpec of the package named test.
  • run to launch the webserver in order to access the app using http://localhost:9000 in your browser.
  • ~run to watch the source code for changes, re-compile when needed and to launch the webserver.

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 50.3%
  • CSS 31.4%
  • Scala 17.6%
  • Other 0.7%