Skip to content

Commit

Permalink
Added CHANGELOG, CREDITS, and README files
Browse files Browse the repository at this point in the history
  • Loading branch information
TheShadow committed Jan 9, 2012
1 parent 0a8d626 commit 0d4d440
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#Java-Speech-API Changelog

##Changelog
Changelog corresponds with a tagged and signed Git commit. This marks the changes.
A tagged commit may or may not have a corresponding binary version available.
Format: Tag: <Corresponding Tag>

* Version 1.00 (Tag: v1.00)
* Initial Release
20 changes: 20 additions & 0 deletions CREDITS.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#Java-Speech API Credits

##Credits
The following people/organizations have helped provide functionality for the API,

* JavaFlacEncoder Project
* Provided functionality to convert Wave files to FLAC format
* This allowed for the FLAC audio to be sent to Google to be "recognized"
* Created by Preston Lacey
* Homepage: http://sourceforge.net/projects/javaflacencoder/
* Google
* Provided functionality for two main API functions
* Recognizer
* Allows for speech audio to be recognized to text
* Synthesiser
* Allows for text to speech translation
* Homepage: http://google.com

I would like to thank the above so much for your work, this wrapper/API could not have been
created without it.
27 changes: 27 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#Java-Speech-API

This is the project for the Java Speech API written in Java.

## Description
This API is designed to be simple and efficient, using the speech engines created by Google
to provide functionality for parts of the API. Essentially, it is an API written in Java,
including a recognizer, synthesizer, and a microphone capture utility. The project uses
Google services for the synthesizer and recognizer. While this requires an Internet
connection, it provides a complete, modern, and fully functional speech API in Java.

##Features
The API currently provides the following functionality,

* Microphone Capture API (Wrapped around the current Java API for simplicity)
* A speech recognizer using Google's recognizer service
* Converts WAVE files from microphone input to FLAC (using existing API, see CREDITS)
* Retrieves Response from Google, including confidence score and text
* A speech synthesiser using Google's synthesizer service
* Retrieves synthesized text in an InputStream (MP3 data ready to be played)
* Wave to FLAC API (Wrapped around the used API in the project, javaFlacEncoder, see CREDITS)

##Changelog
See CHANGELOG.markdown for Version History/Changelog

##Credits
See CREDITS.markdown for Credits

0 comments on commit 0d4d440

Please sign in to comment.