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