summaryrefslogtreecommitdiff
path: root/apps/codecs/demac/README
diff options
context:
space:
mode:
authorDave Chapman <dave@dchapman.com>2007-06-05 16:58:29 +0000
committerDave Chapman <dave@dchapman.com>2007-06-05 16:58:29 +0000
commit520274219a0745384cb9bc6df4d7ee7905090f5d (patch)
tree8d6f4536b6758d00e72a2a9457f892ce28a591bd /apps/codecs/demac/README
parent887b31c01aebb46c0fcc6910241a4a64d9e7991e (diff)
downloadrockbox-520274219a0745384cb9bc6df4d7ee7905090f5d.zip
rockbox-520274219a0745384cb9bc6df4d7ee7905090f5d.tar.gz
rockbox-520274219a0745384cb9bc6df4d7ee7905090f5d.tar.bz2
rockbox-520274219a0745384cb9bc6df4d7ee7905090f5d.tar.xz
Initial commit of Monkey's Audio (.ape/.mac) support. Note that Monkey's is an extremely CPU-intensive codec, and that the decoding speed is directly related to the compression level (-c1000, -c2000, -c3000, -c4000 or -c5000) used when encoding the file. Current performance is: -c1000 to -c3000 are realtime on a Gigabeat, -c1000 is realtime on Coldfire targets (H100, H300 and Cowon), and nothing is realtime on PortalPlayer targets (iPods, H10, Sansa). Hopefully this can be improved. More information at FS #7256.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@13562 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'apps/codecs/demac/README')
-rw-r--r--apps/codecs/demac/README69
1 files changed, 69 insertions, 0 deletions
diff --git a/apps/codecs/demac/README b/apps/codecs/demac/README
new file mode 100644
index 0000000..2fcdd95
--- /dev/null
+++ b/apps/codecs/demac/README
@@ -0,0 +1,69 @@
+demac - a decoder for Monkey's Audio files.
+
+Introduction
+
+demac is an implementation in portable ANSI C of a decoder for the
+Monkey's Audio lossless compression format. It has the following
+features:
+
+ * Open source (GNU GPL)
+ * Written in portable ANSI C
+ * Designed for use on low memory and embedded devices. All internal
+ buffers are statically declared - the core library doesn't require
+ malloc/free. This has the disadvantage that the library isn't
+ re-entrant.
+
+
+Compatibility
+
+
+libdemac is still in the early stages of development but has been
+relatively well tested with v3.99 files at all compression levels.
+
+v3.97 files have received less testing - 16-bit files seem to work,
+but 24-bit files are causing problems in the range decoder.
+
+Files earlier than v3.97 are not supported by libdemac, but support
+might be added in the future.
+
+
+Source Code
+
+The source code in this directory is structured as follows:
+
+demac/Makefile - Makefile for the standalone demac decoder
+demac/demac.c - Simple standalone test program to decoder an APE file to WAV
+demac/wavwrite.[ch] - Helper functions for demac.c
+demac/libdemac/Makefile - A Makefile for use in Rockbox
+demac/libdemac/*.[ch] - The main libdemac code
+
+
+Latest Version
+
+The latest version of demac and libdemac can always be found in the
+"apps/codecs/demac/" directory in the Rockbox source. You can check
+this out from svn with the command:
+
+svn co svn://svn.rockbox.org/rockbox/trunk/apps/codecs/demac demac
+
+Or browse the source code online here:
+
+http://svn.rockbox.org/viewvc.cgi/trunk/apps/codecs/demac
+
+
+
+Acknowledgements
+
+Thanks to Matt. T. Ashland for writing Monkey's Audio. His website
+can be found here: http://www.monkeysaudio.com
+
+
+Copyright and license
+
+
+libdemac is (C) 2007 Dave Chapman and is licensed under the GNU
+GPL. See the COPYING file in this directory.
+
+The exception is the majority of rangecoding.h, which is (C) 1997,
+1998, 1999, 2000 Michael Schindler and is also licensed under the GPL.
+See that source file for full details.