Mercurial > hg > xmms-sid
annotate README @ 251:e9ea4ce4c697
Muchly improved documentation and installation instructions.
| author | Matti Hamalainen <ccr@tnsp.org> |
|---|---|
| date | Tue, 21 Dec 2004 18:50:00 +0000 |
| parents | de47d797ee33 |
| children | d3a4d35f2a8f |
| rev | line source |
|---|---|
| 7 | 1 XMMS-SID - SIDPlay input plugin for X MultiMedia System (XMMS) |
| 1 | 2 ============================================================== |
|
162
d3425d53be3a
Updated documentation, upgraded libtool to 1.5.6 which should fix problems
Matti Hamalainen <ccr@tnsp.org>
parents:
160
diff
changeset
|
3 Programmed and designed by Matti 'ccr' Hamalainen |
|
d3425d53be3a
Updated documentation, upgraded libtool to 1.5.6 which should fix problems
Matti Hamalainen <ccr@tnsp.org>
parents:
160
diff
changeset
|
4 (C) Copyright 1999-2004 Tecnic Software productions (TNSP) |
| 1 | 5 |
| 7 | 6 MD5 Algorithm code for song-length database handling |
| 7 by L. Peter Deutsch <ghost@aladdin.com> | |
| 8 (C) Copyright 1999 Aladdin Enterprises. All rights reserved. | |
| 1 | 9 |
| 10 | |
|
146
d9d776c6f4cd
Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents:
134
diff
changeset
|
11 Short Introduction |
|
d9d776c6f4cd
Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents:
134
diff
changeset
|
12 ================== |
| 7 | 13 XMMS-SID is a plugin for XMMS (X MultiMedia System) which provides |
|
146
d9d776c6f4cd
Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents:
134
diff
changeset
|
14 support for playing Commodore 64 "SID tunes", which are music |
| 199 | 15 from old Commodore computer software including games, demos, etc. |
| 1 | 16 |
|
146
d9d776c6f4cd
Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents:
134
diff
changeset
|
17 |
|
200
ec8b735f5418
Support for libNanoSID dropped.
Matti Hamalainen <ccr@tnsp.org>
parents:
199
diff
changeset
|
18 Configuration |
|
ec8b735f5418
Support for libNanoSID dropped.
Matti Hamalainen <ccr@tnsp.org>
parents:
199
diff
changeset
|
19 ============= |
|
ec8b735f5418
Support for libNanoSID dropped.
Matti Hamalainen <ccr@tnsp.org>
parents:
199
diff
changeset
|
20 |
|
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
21 Audio-tab |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
22 --------- |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
23 - Resolution: 8 or 16-bit. Usually you should select 16-bit, unless |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
24 your audio hardware/drivers do not support it for some reason. |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
25 Speed benefit from using 8-bit audio is minimal, audio quality |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
26 is much worse than 16-bit. |
| 171 | 27 |
|
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
28 - Channels: Mono is the way to go. Original SID (single chip) output |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
29 is mono, the "stereo" and "autopanning" settings are just |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
30 artificial additions. |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
31 |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
32 - Samplerate: High samplerate means better quality sound. Usually |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
33 you'll set this to 44.1kHz (44100 Hz), but latest audio hardware |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
34 may support rates up to 48kHz (48000 Hz) and sometimes 96kHz. |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
35 |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
36 Bigger samplerate means also more work for the emulator and |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
37 thus requires more CPU power. |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
38 |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
39 - Oversampling: Some emulator backends (currently only SIDPlay 2) |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
40 support technique called "oversampling", which further enhances |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
41 audio quality. Oversampling is done by computing audio data to |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
42 higher rate (factor * samplerate) and then downsampling with |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
43 rate-conversion filter. |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
44 |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
45 This results in smoother waveforms, BUT consumes very much CPU! |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
46 |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
47 Emu#1-tab |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
48 --------- |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
49 - Emulator library selection: Here you can choose a emulator |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
50 backend from those which for support has been compiled in |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
51 XMMS-SID. Refer to discussion about emulator libraries in file |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
52 "INSTALL" for more information. |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
53 |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
54 - Memory mode: libSIDPlay supports several different memory modes |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
55 for SID emulation, most of those are for compatibility, though. |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
56 For SIDPlay 2 emulation, select "Real C64" unless you know better. |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
57 For SIDPlay 1 emulation, select "Bank switching". |
| 1 | 58 |
|
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
59 Emu#2-tab |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
60 --------- |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
61 - Clock Speed: Sets default clockspeed and can also "force" the |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
62 emulator backend to use it. Usually the tune's clockspeed is |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
63 automatically detected, so do not set "Force speed" unless you |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
64 know what you're doing. |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
65 |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
66 - SID Type: Sets default SID-chip type. Most fileformats contain |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
67 information about the preferred SID-chip type to emulate, but |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
68 here you can select a default for those situations when it is |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
69 not known. |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
70 |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
71 - SIDPlay 2 options: |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
72 - Optimization mode: If enabled and SIDPlay 2 emulator library |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
73 has been selected, the emulator is run in "optimization" mode |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
74 which is partial frame-emulation. Results in faster, but |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
75 inaccurate emulation. |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
76 |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
77 - reSID-emulation / HardSID: Select SIDPlay 2 backend. reSID |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
78 is a software SID-chip simulation and currently the only |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
79 option available. HardSID is backend for HardSID card, |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
80 but it is not supported yet by XMMS-SID. |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
81 |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
82 Filters-tab |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
83 ----------- |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
84 - Emulate filters: Enable filter emulation. Usually you will want |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
85 to enable this option, unless you are running on very slow CPU. |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
86 SID filters affect outcome of most tunes very much. |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
87 |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
88 - Filter settings: Unless you are advanced user (and thus know what |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
89 these are), the defaults will work very well and there is no need |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
90 to touch filter settings. |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
91 |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
92 Songlength-tab |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
93 -------------- |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
94 Most of song length settings should be self-explanatory. The |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
95 respective "Only when song-length is unknown" options make |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
96 maximum/minimum playtime limits work only when song length |
|
146
d9d776c6f4cd
Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents:
134
diff
changeset
|
97 |
|
d9d776c6f4cd
Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents:
134
diff
changeset
|
98 * XSIDPLAY-compatible song-length database is a file that contains |
|
d9d776c6f4cd
Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents:
134
diff
changeset
|
99 lengths for most songs in High Voltage SID Collection (HVSC). I |
|
d9d776c6f4cd
Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents:
134
diff
changeset
|
100 highly recommend that you download the database and configure |
|
d9d776c6f4cd
Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents:
134
diff
changeset
|
101 XMMS-SID to use it. The SLDB is available at |
|
d9d776c6f4cd
Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents:
134
diff
changeset
|
102 http://www.geocities.com/SiliconValley/Lakes/5147/sidplay/sldb.html |
| 7 | 103 |
|
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
104 |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
105 |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
106 Miscellaneous tips |
|
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
107 ================== |
| 193 | 108 * SIDPlay2-emulation is heavier, but more accurate. So you need to |
| 109 have more CPU-power for it. | |
| 1 | 110 |
| 7 | 111 * Oversampling is available with SIDPlay2-emulation, it can further |
| 55 | 112 enchange the audio quality, but you need some really powerful |
| 113 hardware to run it smoothly. | |
| 1 | 114 |
| 7 | 115 * Filter-settings can be usually left as they are, unless you know |
| 116 what you're doing. | |
| 1 | 117 |
| 7 | 118 * If the plugin doesn't recognize your SID-tunes, try checking the |
| 193 | 119 'Determine filetype by contents' option in the XMMS-SID config |
|
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
120 window. This is EXTREMELY slow if you're reading a 10000-tune |
| 193 | 121 playlist, though. |
| 1 | 122 |
| 193 | 123 * For those who don't know it: Autopanning and stereo are not native |
| 124 to the original SID chip, but are extra options implemented in | |
| 125 libSIDPlay. So if you think that the tune does not sound as it | |
| 126 sounds on real C64, use the Mono setting. | |
| 1 | 127 |
| 128 * The "kb/s rate" box is actually the play rate in Hz, so you can | |
| 129 see if it's an NTSC or PAL song (if you haven't set the Force Speed | |
| 130 option). | |
| 131 | |
|
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
132 Also see FAQ for more tips, gotchas and such. |
| 7 | 133 |
| 1 | 134 |
| 158 | 135 License |
| 136 ======= | |
| 137 XMMS-SID is distributed under GNU General Public License version 2, | |
| 138 see COPYING for more information. | |
| 139 | |
| 140 If you like XMMS-SID, you can thank me by distributing message | |
| 141 about it's existence and voting it on freshmeat.net. | |
| 142 | |
| 143 | |
| 144 Contact, support and new versions | |
| 145 ================================= | |
| 7 | 146 New releases of this plugin should be available at TNSP's WWW- |
| 147 homepages, see below for address. Bug-reports, suggestions, | |
| 158 | 148 patches, etc. should be sent to ccr at least for now, please see |
| 149 the homepage for latest information. | |
| 1 | 150 |
| 191 | 151 |
|
205
de47d797ee33
Updates to contact information.
Matti Hamalainen <ccr@tnsp.org>
parents:
204
diff
changeset
|
152 IRC : The #xmms-sid on freenode has been TERMINATED, so |
|
de47d797ee33
Updates to contact information.
Matti Hamalainen <ccr@tnsp.org>
parents:
204
diff
changeset
|
153 don't bother going there. After 2 years of idling |
|
de47d797ee33
Updates to contact information.
Matti Hamalainen <ccr@tnsp.org>
parents:
204
diff
changeset
|
154 alone on that channel, I got bored. |
| 204 | 155 |
|
205
de47d797ee33
Updates to contact information.
Matti Hamalainen <ccr@tnsp.org>
parents:
204
diff
changeset
|
156 But I do hang on #xmms at irc.freenode.net by |
|
de47d797ee33
Updates to contact information.
Matti Hamalainen <ccr@tnsp.org>
parents:
204
diff
changeset
|
157 unsurprising nickname "ccr". |
| 204 | 158 (see http://www.freenode.net/ for more information) |
| 1 | 159 |
|
112
fb16fc1fd506
Minor updates to docs, added reference to IRC-channel
Matti Hamalainen <ccr@tnsp.org>
parents:
93
diff
changeset
|
160 E-mail : ccr@tnsp.org |
| 1 | 161 |
|
112
fb16fc1fd506
Minor updates to docs, added reference to IRC-channel
Matti Hamalainen <ccr@tnsp.org>
parents:
93
diff
changeset
|
162 Homepage : http://www.tnsp.org/xmms-sid.php |
| 191 | 163 |