Mercurial > hg > xmms-sid
annotate INSTALL @ 646:5f2682738867
Oops.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Tue, 04 Sep 2007 23:33:03 +0000 |
parents | 80f7cafcda0a |
children | 36a2d95e4644 |
rev | line source |
---|---|
123
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
1 This document describes overall requirements and procedure |
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
2 for installation of XMMS-SID package, please read it carefully! |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
3 For more information and tips, please refer to README and FAQ. |
123
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
4 |
1 | 5 Requirements |
6 ============ | |
7 - XMMS version 1.2.0 or later (http://www.xmms.org/) | |
7 | 8 |
145 | 9 - Gtk+ and Glib 1.2.5 or later (http://www.gtk.org/) |
7 | 10 |
304
512e3ef3fc63
Document problems with gcc vs g++
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
11 - ANSI-C and C++-compiler. Preferably GCC along with rest of |
512e3ef3fc63
Document problems with gcc vs g++
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
12 the GNU toolchain. I have no idea whether this compiles with |
171 | 13 any other compiler ... sorry. |
123
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
14 |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
15 - You need AT LEAST one of the following emulation libraries: |
7 | 16 |
123
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
17 * libSIDPlay1 |
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
18 * libSIDPlay2 |
7 | 19 |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
20 Only one emulator backend library is required, but all are |
336 | 21 supported with compile & run-time configuration. You may also |
22 need some supplementary libraries for each emulator library. | |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
23 See below for more information. |
171 | 24 |
25 | |
336 | 26 Emulator library selection hints |
27 ================================ | |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
28 Some words on which emulation library you should choose to install |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
29 and use - it depends somewhat on your system and personal preferences. |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
30 |
416 | 31 - libSIDPlay v1: This is the old and original emulation library. Its |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
32 emulation is "frame-based" and not very accurate. The waveforms |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
33 produced are harsher and emulation of SID filter is far from |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
34 accurate. |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
35 |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
36 libSIDPlay v1 requires very little CPU power, it is faster and |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
37 may have fewer bugs due to being more mature software. Many |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
38 OS distributions have pre-built packages of it, not something that |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
39 can be said of libSIDPlay v2. Some people may even like the |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
40 harsher sound produced by libSIDPlay v1. |
171 | 41 |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
42 Drawbacks are: worse emulation, eventually weakening compability |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
43 as new SID-tunes/files are ripped into "RSID"-format which |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
44 libSIDPlay v1 does NOT support. |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
45 |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
46 |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
47 - libSIDPlay v2: New, next generation modular SID-emulation framework. |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
48 Along with reSID-library it produces probably most accurate emulated |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
49 representation of SID-chip available. This, however, comes at high |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
50 cost: libSIDPlay2 tends to eat CPU like popcorn, depending on the |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
51 selected emulation options. It is also less spread, not as many |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
52 distributions/operating systems come with pre-packaged libSIDPlay2, |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
53 so you may have to roll your own. |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
54 |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
55 Also the API-stability of libSIDPlay2 is not yet 100%, there may |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
56 be changes. Bugs are evident, though many of them will be fixed |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
57 eventually. |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
58 |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
59 |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
60 Conclusion thus is as follows: If you are using an old system with not |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
61 much spare CPU-power, choose libSIDPlay v1. On a relatively recent |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
62 system (more powerful than Pentium III 500MHz) you may wish to choose |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
63 libSIDPlay v2, although your mileage may vary. |
1 | 64 |
65 | |
66 Where to get XMMS? | |
67 ================== | |
123
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
68 Latest version of XMMS should be available from: |
1 | 69 |
123
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
70 http://www.xmms.org/ |
1 | 71 |
171 | 72 Please refer to XMMS documentation for information on its usage |
73 and installation, etc. You probably have XMMS already installed, | |
74 but if you installed from a pre-built package, make sure that | |
75 you have corresponding xmms-devel -package also. | |
1 | 76 |
77 | |
123
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
78 Where to get libSIDPlay1? |
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
79 ========================= |
559
80f7cafcda0a
Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents:
483
diff
changeset
|
80 Typically your OS distribution or some supplementary package |
80f7cafcda0a
Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents:
483
diff
changeset
|
81 repository may contain libSIDPlay1 packages. Usually those work |
391
3cc7455360ad
Improve documentation: Talk more about libSIDPlay1, document problems of
Matti Hamalainen <ccr@tnsp.org>
parents:
350
diff
changeset
|
82 well, but remember to also install the corresponding -dev/-devel |
559
80f7cafcda0a
Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents:
483
diff
changeset
|
83 package so that XMMS-SID can be compiled. |
391
3cc7455360ad
Improve documentation: Talk more about libSIDPlay1, document problems of
Matti Hamalainen <ccr@tnsp.org>
parents:
350
diff
changeset
|
84 |
559
80f7cafcda0a
Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents:
483
diff
changeset
|
85 If you can't find pre-made packages for your OS, source tarballs |
80f7cafcda0a
Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents:
483
diff
changeset
|
86 for libSIDPlay1 are available at SIDPlay's homepage: |
1 | 87 |
145 | 88 http://www.geocities.com/SiliconValley/Lakes/5147/sidplay/linux.html |
1 | 89 |
123
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
90 You only need libsidplay, the sidplay-base is not necessary |
559
80f7cafcda0a
Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents:
483
diff
changeset
|
91 for building or using XMMS-SID (it contains a command-line |
80f7cafcda0a
Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents:
483
diff
changeset
|
92 SID-player). |
1 | 93 |
23 | 94 |
559
80f7cafcda0a
Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents:
483
diff
changeset
|
95 Where to get and how to install libSIDPlay2? |
80f7cafcda0a
Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents:
483
diff
changeset
|
96 ============================================ |
80f7cafcda0a
Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents:
483
diff
changeset
|
97 Please read the following web-page: |
391
3cc7455360ad
Improve documentation: Talk more about libSIDPlay1, document problems of
Matti Hamalainen <ccr@tnsp.org>
parents:
350
diff
changeset
|
98 |
559
80f7cafcda0a
Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents:
483
diff
changeset
|
99 http://www.tnsp.org/?p=libsidplay2 |
123
9ab0c2fff794
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
80
diff
changeset
|
100 |
80
7047a6390b08
Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents:
41
diff
changeset
|
101 |
36 | 102 Building a CVS-version |
103 ====================== | |
104 To build a CVS-version of XMMS-SID, you need to have latest | |
41 | 105 (STABLE) versions of following tools installed, including: |
34
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
106 |
171 | 107 - GNU autoconf 2.56 or newer |
391
3cc7455360ad
Improve documentation: Talk more about libSIDPlay1, document problems of
Matti Hamalainen <ccr@tnsp.org>
parents:
350
diff
changeset
|
108 - GNU automake 1.9 (older and newer versions MAY be incompatible!) |
3cc7455360ad
Improve documentation: Talk more about libSIDPlay1, document problems of
Matti Hamalainen <ccr@tnsp.org>
parents:
350
diff
changeset
|
109 - GNU libtool 1.5.20 or newer |
41 | 110 - Glade for Gtk+ 1.2 programs (I use Glade 0.6.4) |
34
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
111 |
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
112 If you have all required tools installed, just run the |
171 | 113 "bootstrap.sh"-script which generates all necessary build-files. |
114 After successfull bootstrapping, you should be able to install | |
115 the package normally, following steps described in next chapter. | |
34
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
116 |
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
117 |
7 | 118 Installing XMMS-SID |
1 | 119 =================== |
171 | 120 When you have the requirements installed and working succesfully, |
559
80f7cafcda0a
Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents:
483
diff
changeset
|
121 you may try compilation and installation of XMMS-SID. |
7 | 122 |
559
80f7cafcda0a
Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents:
483
diff
changeset
|
123 Invoke configure script (use 'configure --help' for help) |
7 | 124 |
125 $ ./configure | |
1 | 126 |
559
80f7cafcda0a
Updated installation instructions, also moved libSIDPlay2
Matti Hamalainen <ccr@tnsp.org>
parents:
483
diff
changeset
|
127 The configure script will print out lots of information and in |
34
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
128 the end it tells you some of the selected build options. |
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
129 |
304
512e3ef3fc63
Document problems with gcc vs g++
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
130 NOTICE! On some systems it may be necessary to force 'configure' |
512e3ef3fc63
Document problems with gcc vs g++
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
131 to use gcc instead of g++ with following syntax: |
512e3ef3fc63
Document problems with gcc vs g++
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
132 |
512e3ef3fc63
Document problems with gcc vs g++
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
133 $ CC=gcc CXX=g++ ./configure |
512e3ef3fc63
Document problems with gcc vs g++
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
134 |
512e3ef3fc63
Document problems with gcc vs g++
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
135 |
34
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
136 If configure passed without errors, try compilation. (Depending |
0e1189b94a7f
Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents:
31
diff
changeset
|
137 on your system, you may need to invoke 'gmake' instead of 'make'.) |
1 | 138 |
7 | 139 $ make |
140 | |
198 | 141 If that went OK too, then you may try installation. Again, you |
142 may need to invoke 'gmake' instead of 'make'. Install globally | |
143 to whole system (as root): | |
7 | 144 |
145 # make install | |
1 | 146 |
483 | 147 or install for current user only: (NOTICE! Locales and data files |
148 will not be installed with this method) | |
181
be1cf864f28e
Added install-user and uninstall-user targets which install to current
Matti Hamalainen <ccr@tnsp.org>
parents:
171
diff
changeset
|
149 |
be1cf864f28e
Added install-user and uninstall-user targets which install to current
Matti Hamalainen <ccr@tnsp.org>
parents:
171
diff
changeset
|
150 $ make install-user |
be1cf864f28e
Added install-user and uninstall-user targets which install to current
Matti Hamalainen <ccr@tnsp.org>
parents:
171
diff
changeset
|
151 |
249 | 152 Assuming all went correctly, XMMS-SID is now installed. You should |
153 now start or re-start XMMS and configure XMMS-SID's various options. | |
199 | 154 |
155 | |
156 Post-installation configuration | |
157 =============================== | |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
249
diff
changeset
|
158 To gain full advantage of using XMMS-SID, you need to configure it. |
199 | 159 XMMS-SID can be configured just like any other XMMS plugin, in XMMS |
160 do as follows: | |
161 | |
162 -> Press <ctrl+p> | |
163 -> Select "Audio I/O Plugins"-tab | |
164 -> Choose "XMMS-SID x.y.z [libxmmssid.so]" from the list | |
165 -> Click "Configure" | |
166 | |
167 Please refer to README for more information about configuration. | |
168 |