summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLorry <lorry@roadtrain.codethink.co.uk>2012-07-18 21:35:23 +0100
committerLorry <lorry@roadtrain.codethink.co.uk>2012-07-18 21:35:23 +0100
commit54068aa116eb79cf0e02296b763318ad65ead724 (patch)
tree9881e0ae8b0f117aa857117e0009f50c70e01782 /README
downloadspeex-54068aa116eb79cf0e02296b763318ad65ead724.tar.gz
Tarball conversion
Diffstat (limited to 'README')
-rw-r--r--README9
1 files changed, 9 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..84fe74a
--- /dev/null
+++ b/README
@@ -0,0 +1,9 @@
+See INSTALL file for instruction on how to install Speex.
+
+The Speex is a patent-free, Open Source/Free Software voice codec. Unlike other codecs like MP3 and Ogg Vorbis, Speex is designed to compress voice at bitrates in the 2-45 kbps range. Possible applications include VoIP, internet audio streaming, archiving of speech data (e.g. voice mail), and audio books. In some sense, it is meant to be complementary to the Ogg Vorbis codec.
+
+To use the Speex command line tools:
+
+% speexenc [options] input_file.wav compressed_file.spx
+
+% speexdec [options] compressed_file.spx output_file.wav