Mercurial > hg > xmms-sid

comparison INSTALL @ 251:e9ea4ce4c697

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Muchly improved documentation and installation instructions.
author Matti Hamalainen <ccr@tnsp.org>
date Tue, 21 Dec 2004 18:50:00 +0000
parents b02705a9b2d6
children d8f088079384
comparison
equal deleted inserted replaced
250:295c1b369d2f 251:e9ea4ce4c697
1 This document describes overall requirements and procedure 1 This document describes overall requirements and procedure
2 for installation of XMMS-SID package, please read it carefully! 2 for installation of XMMS-SID package, please read it carefully!
3 For more tips, please also read README and FAQ. 3 For more information and tips, please refer to README and FAQ.
4 4
5 Requirements 5 Requirements
6 ============ 6 ============
7 - XMMS version 1.2.0 or later (http://www.xmms.org/) 7 - XMMS version 1.2.0 or later (http://www.xmms.org/)
8 8
10 10
11 - C and C++-compiler. Preferably GCC along with rest of the 11 - C and C++-compiler. Preferably GCC along with rest of the
12 GNU toolchain. I have no idea whether this compiles with 12 GNU toolchain. I have no idea whether this compiles with
13 any other compiler ... sorry. 13 any other compiler ... sorry.
14 14
15 - You need AT LEAST one emulation library: 15 - You need AT LEAST one of the following emulation libraries:
16 16
17 * libSIDPlay1 17 * libSIDPlay1
18 * libSIDPlay2 18 * libSIDPlay2
19 19
20 Only one is required, but all are supported. You may also need 20 Only one emulator backend library is required, but all are
21 some supplementary libraries, that are required by the emulator 21 supported with run-time configuration. You may also need
22 library. See below for more information. 22 some supplementary libraries for each emulator library.
23 See below for more information.
23 24
24 25
25 NOTICE! Refer to file README for recommendations about which 26 Emulator library selection recommendations
26 emulator libraries you should install! 27 ==========================================
28 Some words on which emulation library you should choose to install
29 and use - it depends somewhat on your system and personal preferences.
27 30
31 - libSIDPlay v1: This is the old SIDPlay v1 emulation library. Its
32 emulation is "frame-based" and not very accurate. The waveforms
33 produced are harsher and emulation of SID filter is far from
34 accurate.
35
36 libSIDPlay v1 requires very little CPU power, it is faster and
37 may have fewer bugs due to being more mature software. Many
38 OS distributions have pre-built packages of it, not something that
39 can be said of libSIDPlay v2. Some people may even like the
40 harsher sound produced by libSIDPlay v1.
41
42 Drawbacks are: worse emulation, eventually weakening compability
43 as new SID-tunes/files are ripped into "RSID"-format which
44 libSIDPlay v1 does NOT support.
45
46
47 - libSIDPlay v2: New, next generation modular SID-emulation framework.
48 Along with reSID-library it produces probably most accurate emulated
49 representation of SID-chip available. This, however, comes at high
50 cost: libSIDPlay2 tends to eat CPU like popcorn, depending on the
51 selected emulation options. It is also less spread, not as many
52 distributions/operating systems come with pre-packaged libSIDPlay2,
53 so you may have to roll your own.
54
55 Also the API-stability of libSIDPlay2 is not yet 100%, there may
56 be changes. Bugs are evident, though many of them will be fixed
57 eventually.
58
59
60 Conclusion thus is as follows: If you are using an old system with not
61 much spare CPU-power, choose libSIDPlay v1. On a relatively recent
62 system (more powerful than Pentium III 500MHz) you may wish to choose
63 libSIDPlay v2, although your mileage may vary.
28 64
29 65
30 Where to get XMMS? 66 Where to get XMMS?
31 ================== 67 ==================
32 Latest version of XMMS should be available from: 68 Latest version of XMMS should be available from:
106 now start or re-start XMMS and configure XMMS-SID's various options. 142 now start or re-start XMMS and configure XMMS-SID's various options.
107 143
108 144
109 Post-installation configuration 145 Post-installation configuration
110 =============================== 146 ===============================
111 To gain full advantages of using XMMS-SID, you need to configure it. 147 To gain full advantage of using XMMS-SID, you need to configure it.
112 XMMS-SID can be configured just like any other XMMS plugin, in XMMS 148 XMMS-SID can be configured just like any other XMMS plugin, in XMMS
113 do as follows: 149 do as follows:
114 150
115 -> Press <ctrl+p> 151 -> Press <ctrl+p>
116 -> Select "Audio I/O Plugins"-tab 152 -> Select "Audio I/O Plugins"-tab