Mercurial > hg > xmms-sid

comparison INSTALL @ 1015:d8c1c1c5f609

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update installation instructions.
author Matti Hamalainen <ccr@tnsp.org>
date Sat, 28 Feb 2015 02:57:33 +0200
parents 7527468689e7
children
comparison
equal deleted inserted replaced
1014:7527468689e7 1015:d8c1c1c5f609
54 SID-emulation framework. Along with reSID-library it produces 54 SID-emulation framework. Along with reSID-library it produces
55 probably most accurate software-emulated representation of 55 probably most accurate software-emulated representation of
56 SID-chip available. This, however, comes at high cost: 56 SID-chip available. This, however, comes at high cost:
57 libSIDPlayFP tends to eat CPU like popcorn. 57 libSIDPlayFP tends to eat CPU like popcorn.
58 58
59 It is also less spread, not packaged in distributions (that I know of, 59
60 at the time of writing of this), so you may have to roll your own. 60 Conclusion thus is as follows: If you are using a VERY old system without
61 much spare CPU-power, choose libSIDPlay v1. On any system that is not
62 older than a decade, you probably want libSIDPlayFP.
61 63
62 Also the API-stability of libSIDPlayFP is not yet 100%, there may 64 There isn't any reason to choose libSIDPlay v2 over "FP" nowadays,
63 be changes. Bugs are evident, though many of them will be fixed 65 unless you are somehow stuck with a system that can't handle FP.
64 eventually.
65
66
67 Conclusion thus is as follows: If you are using a VERY old system with not
68 much spare CPU-power, choose libSIDPlay v1. On a relatively "recent"
69 system (Pentium-M, Pentium4 1GHz+) you may wish to choose libSIDPlay v2.
70
71 On a Intel Core2 or Intel Core i5/7 level system you could choose
72 libSIDPlayFP, if you have approximately ~20% CPU to spare for
73 playing the tunes.
74 66
75 67
76 Where to get XMMS? 68 Where to get XMMS?
77 ================== 69 ==================
78 Latest version of XMMS should be available from: 70 Latest version of XMMS should be available from:
95 For example, in Debian (or Ubuntu): 87 For example, in Debian (or Ubuntu):
96 88
97 $ apt-get install libsidplay1-dev 89 $ apt-get install libsidplay1-dev
98 90
99 91
100 Where to get and how to install libSIDPlay2?
101 ============================================
102 You might have it in your $OS_DISTRIBUTION of preference. For example
103 Debian should have a compatible set of packages available, try:
104
105 $ apt-get install libsidplay2-dev libresid-builder-dev
106
107
108 Where to get libSIDPlayFP? 92 Where to get libSIDPlayFP?
109 ========================== 93 ==========================
110 94
111 $ apt-get install libsidplayfp-dev 95 $ apt-get install libsidplayfp-dev
112 96
114 98
115 http://sourceforge.net/projects/sidplay-residfp/ 99 http://sourceforge.net/projects/sidplay-residfp/
116 100
117 Versions 0.3.8, 1.0.1 - 1.5.x should be compatible with XMMS-SID. 101 Versions 0.3.8, 1.0.1 - 1.5.x should be compatible with XMMS-SID.
118 Earlier and later ones might not, there is no guarantee. 102 Earlier and later ones might not, there is no guarantee.
103
104
105 Where to get and how to install libSIDPlay2?
106 ============================================
107 You might have it in your $OS_DISTRIBUTION of preference. For example
108 Debian should have a compatible set of packages available, try:
109
110 $ apt-get install libsidplay2-dev libresid-builder-dev
119 111
120 112
121 Building a Mercurial-version 113 Building a Mercurial-version
122 ============================ 114 ============================
123 To build a version of XMMS-SID from Mercurial repository, 115 To build a version of XMMS-SID from Mercurial repository,
183 175
184 176
185 Post-installation configuration 177 Post-installation configuration
186 =============================== 178 ===============================
187 To gain full advantage of using XMMS-SID, you need to configure it. 179 To gain full advantage of using XMMS-SID, you need to configure it.
188 XMMS-SID can be configured just like any other XMMS plugin, in XMMS 180 When running for the first time, XMMS-SID will show its configuration
189 do as follows: 181 dialog automatically.
182
183 Afterwards it can be configured just like any other XMMS plugin,
184 in XMMS do as follows:
190 185
191 -> Press <ctrl+p> 186 -> Press <ctrl+p>
192 -> Select "Audio I/O Plugins"-tab 187 -> Select "Audio I/O Plugins"-tab
193 -> Choose "XMMS-SID x.y.z [libxmmssid.so]" from the list 188 -> Choose "XMMS-SID x.y.z [libxmmssid.so]" from the list
194 -> Click "Configure" 189 -> Click "Configure"