Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/quite/celt.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJean-Marc Valin <jean-marc.valin@usherbrooke.ca>2007-12-08 16:55:49 +0300
committerJean-Marc Valin <jean-marc.valin@usherbrooke.ca>2007-12-08 16:55:49 +0300
commit06ee7f9083335128a0ad72c8dcbdad834e823e7b (patch)
treea5218112c3ecebb1ac756a2dd683183fdfd3430b /README
parent1677aa9caaa838793119cdf6af5323b034f2f914 (diff)
Updated README
Diffstat (limited to 'README')
-rw-r--r--README12
1 files changed, 12 insertions, 0 deletions
diff --git a/README b/README
index 0b24b79..8ffe268 100644
--- a/README
+++ b/README
@@ -2,3 +2,15 @@ This is an attempt to write a low-latency audio codec. Don't bother with
this unless you're interested in codec development. Certainly don't expect
this to be ready any time soon. Oh, and don't complain if it sets your house
on fire.
+
+To compile:
+% ./configure
+% make
+
+To test the encoder:
+% testcelt input.sw output.sw
+
+where input.sw is a 16-bit (machine endian) *mono* audio file sampled at
+44.1 kHz or 48 kHz. The output file is already decompressed since we do not
+currently produce compressed files. By default the bit-rate will be around 38 kbps, but replacing "mode1" by "mode2" in testcelt will encode at 58 kbps, which
+is (sort of) suitable for music.