Readme.htm
1<html>
2
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<meta name="GENERATOR" content="Microsoft FrontPage 4.0">
6<meta name="ProgId" content="FrontPage.Editor.Document">
7<title>Monkey</title>
8</head>
9
10<body>
11
12<p align="center"><font size="4" face="Verdana">Monkey's Audio Source Code
13Readme<br>
14</font><font face="Verdana" size="2">(last updated July 7, 2002)</font></p>
15<p><b><font size="2" face="Verdana">Introduction</font></b></p>
16<p><font size="2" face="Verdana">First off, just to be clear, you have to fully
17agree with the included license agreement before using / viewing any of the
18included materials. The big points are that you can't steal code or try to
19make money with it (without permission) and that you have to submit changes and
20improvements back to the Monkey's Audio project. With that out of the way,
21I'm hoping that by releasing the source code, we'll be able to work together to
22make Monkey's Audio better. Please direct any suggestions or improvements
23to the Monkey's Audio developer's forum or to me personally when appropriate.
24(email @ monkeysaudio.com) And thank you for taking the time to help.</font></p>
25<p><b><font size="2" face="Verdana">Important Note</font></b></p>
26<p><font size="2" face="Verdana">The Monkey's Audio format is not
27"finalized". In fact, the compression / decompression engines
28are continually being improved. This is what makes MAC fun to work on, and
29it's what makes progress possible. I realize that this can be a pain for
303rd party developers, but it's the only way to avoid stagnation. So, you
31can not hard code Monkey's Audio support and expect it to work with the newest
32versions of MAC forever. Either use a DLL or else accept that you'll have
33to re-link to MACLib once in a while.</font></p>
34<p><b><font size="2" face="Verdana">Things that it'd be great if you worked on</font></b></p>
35<p><font face="Verdana" size="2">1. It would be nice to have makefiles for gcc
36or any other compilers that people commonly use.</font></p>
37<p><font size="2" face="Verdana">2. Pour through the code and look for bone-head
38maneuvers.</font></p>
39<p><font size="2" face="Verdana">3. Submit any necessary changes for
40cross-platform compilation. </font></p>
41<p><font size="2" face="Verdana">4. XMMS, Lame DLL, PocketPC, etc. plugins /
42implementations.</font></p>
43<p><font size="2" face="Verdana">5. A console front-end that doesn't suck. (more
44options, etc.) Also, don't worry about maintaining compatibility with the
45current parameter passing scheme -- just use whatever makes sense.</font></p>
46<p><b><font size="2" face="Verdana">Tips for building MACLib outside of Windows</font></b></p>
47<p><font face="Verdana" size="2">1. in "Shared/All.h" do this:</font></p>
48<ul>
49 <li><font size="2" face="Verdana">#define BUILD_CROSS_PLATFORM</font></li>
50 <li><font face="Verdana" size="2">look through "Shared/All.h" and
51 "Shared/NoWindows.h" to make sure all the defines are acceptable</font></li>
52</ul>
53<p><font face="Verdana" size="2">2. You need to use NASM to build the assembly
54if you want it. (helps speed a lot) Check out "MacLib/Assembly/..."
55for more information.</font></p>
56<p><b><font size="2" face="Verdana">Known non-Windows problems (help fixing them
57would be great)</font></b></p>
58<p><font size="2" face="Verdana">2. The macros PUMP_MESSAGE_LOOP, MESSAGEBOX, and a few others don't work.</font></p>
59<p> </p>
60<p align="center" style="margin:0in;margin-bottom:.0001pt;text-align:center"><font face="Verdana" size="2">-
61All materials and programs copyrighted �2000-2002 by Matthew T. Ashland -</font></p>
62<p align="center" style="margin:0in;margin-bottom:.0001pt;text-align:center"><font face="Verdana" size="2">-
63All rights reserved. -</font></p>
64
65</body>
66
67</html>
68