initial import
[dosrtxon] / libs / mikmod / dos / README
1   Hello folks !\r
2 \r
3 \r
4 This is libmikmod, version 3.3.10, a portable sound library for DOS.\r
5 Comments & feedback are welcome.\r
6 \r
7 \r
8 >> BUILDING LIBMIKMOD\r
9 ---------------------\r
10 \r
11 - If you're not building libmikmod for DOS, then you're lost in the sources.\r
12   Go up one directory, and read the main README file.\r
13 \r
14 This port has been designed to work only with DJGPP compiler. However, it\r
15 should not be too complex to make it compile with any other compiler. If you\r
16 manage to make libmikmod compile and work with another compiler, we'd like to\r
17 hear from you. You'll likely have to write an appropiate makefile, or build\r
18 things manually ...\r
19 \r
20 If you have all proper tools installed, just type\r
21 \r
22         make -f Makefile.dj\r
23 \r
24 To make your library ready to use, copy the files 'libmikmod.a' and\r
25 'include/mikmod.h' to your '%DJGPP%/lib' and '%DJGPP%/include' directories\r
26 respectively.\r
27 \r
28 HTML documentation of the library, for programmers, is located in the doc\r
29 directory.\r
30 \r
31 \r
32 >> SUPPORTED SOUNDCARDS\r
33 -----------------------\r
34 \r
35 Currently three brands of sound cards are supported under DOS:\r
36 \r
37 - Gravis Ultrasound and compatibles. Not tested with Interwave cards. If\r
38   somebody has one and can debug the code under Interwave, please drop us a note\r
39   (see email at bottom).\r
40 \r
41 - SoundBlaster and compatibles. There is only one driver that supports all\r
42   flavours of SoundBlasters:\r
43 \r
44         + SB original (8-bit mono, 22KHz)\r
45         + SB 2.0 (DMA autoinit mode -> less clicks, 44KHz 8-bit mono).\r
46         + SB Pro (8-bit 22KHz stereo, 8-bit 44KHz mono)\r
47         + SB 16+ (8- and 16-bit stereo, up to 44Khz both)\r
48 \r
49   Note that SB16 should cover AWE32/64 as well...\r
50 \r
51 - Windows Sound System and compatibles. Most today SoundBlaster clones\r
52   (including the CS4236B card used for testing) emulates (in hardware) WSS.\r
53   That's because Creative Labs copyrighted the SB16 interface and thus\r
54   clonemakers cannot do similar hardware without violating their rights, so\r
55   most of them only emulate SB Pro (see above).\r
56 \r
57   WSS supports up to 44KHz 16-bit stereo. The following playback rates (in both\r
58   8- and 16-bit) are supported: 5510, 6620, 8000, 9600, 11025, 16000, 18900,\r
59   22050, 27420, 32000, 33075, 37800, 44100 and 48000 Hz.\r
60 \r
61 \r
62 >> THANKS\r
63 ---------\r
64 \r
65 We would like to thank everyone who contributed to libmikmod. Their names\r
66 are in the AUTHORS file for the significative contributions, but some other\r
67 names can be found in the NEWS file. Thanks a lot ! Keeping libmikmod alive\r
68 wouldn't be much fun without you.\r
69 \r
70 \r
71 >> LICENSE\r
72 ----------\r
73 \r
74 The libmikmod sound library is covered by the GNU Library General Public\r
75 License as published by the Free Software Fundation (you'll find it in the\r
76 file COPYING.LIB) ; either version 2 of the licence, or (at your option)\r
77 any later version.\r
78 \r
79 The GNU Lesser General Public License, version 2.1, in file COPYING.LESSER, can\r
80 be considered as a later version of the LGPL, and is strongly recommended for\r
81 people who will embed libmikmod in their application as a shared library.\r
82 \r
83 \r
84 >> CONTACT AND DOWNLOAD INFO\r
85 ----------------------------\r
86 \r
87 libmikmod home page is located at SourceForge:\r
88 \r
89     http://mikmod.sourceforge.net/\r
90     http://sourceforge.net/projects/mikmod/\r
91 \r
92 There's a mailing list (mikmod-public) for discussing the development\r
93 of MikMod (new features, bugs, ideas...) Look for more information on\r
94 the web site.\r
95 \r
96 Things related to the DOS port should also be forwarded to the DOS\r
97 ``portmaster'', Andrew Zabolotny, at: bit@eltech.ru\r
98 \r
99 \r
100 >> LAST NOTES\r
101 -------------\r
102 \r
103 We hope you'll enjoy using this version of libmikmod as well as we enjoyed\r
104 debugging and improving it.\r
105 \r
106 -- Miodrag ("Miod") Vallat, 10/19/1999\r
107    miodrag@mikmod.darkorb.net\r
108 \r
109    Andrew Zabolotny\r
110    bit@eltech.ru\r