annotate README @ 205:de47d797ee33

Updates to contact information.
author Matti Hamalainen <ccr@tnsp.org>
date Wed, 15 Dec 2004 10:18:00 +0000
parents 69de64975d18
children e9ea4ce4c697
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
1 XMMS-SID - SIDPlay input plugin for X MultiMedia System (XMMS)
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
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
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
5
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
6 MD5 Algorithm code for song-length database handling
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
7 by L. Peter Deutsch <ghost@aladdin.com>
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
8 (C) Copyright 1999 Aladdin Enterprises. All rights reserved.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
9
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
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
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
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
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 193
diff changeset
15 from old Commodore computer software including games, demos, etc.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
16
146
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
17
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
18
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
19 Installation requirements and recommendations
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
20 =============================================
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
21 Refer to file "INSTALL" for information about what XMMS-SID requires,
146
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
22 where to get those required packages and how to install.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
23
199
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 193
diff changeset
24 Some words on which emulation library you should choose to install
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 193
diff changeset
25 and use - it depends somewhat on your system and personal preferences.
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
26
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
27
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
28 - libSIDPlay v1: This is the old SIDPlay v1 emulation library. Its
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
29 emulation is "frame-based" and not very accurate. The waveforms
204
69de64975d18 Updates
Matti Hamalainen <ccr@tnsp.org>
parents: 200
diff changeset
30 produced are harsher and emulation of SID filter is far from
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
31 accurate.
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
32
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
33 libSIDPlay v1 requires very little CPU power, it is faster and
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
34 may have fewer bugs due to being more mature software. Many
204
69de64975d18 Updates
Matti Hamalainen <ccr@tnsp.org>
parents: 200
diff changeset
35 OS distributions have pre-built packages of it, not something that
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
36 can be said of libSIDPlay v2. Some people may even like the
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
37 harsher sound produced by libSIDPlay v1.
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
38
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
39 Drawbacks are: worse emulation, eventually weakening compability
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
40 as new SID-tunes/files are ripped into "RSID"-format which
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
41 libSIDPlay v1 does NOT support.
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
42
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
43
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
44 - libSIDPlay v2: New, next generation modular SID-emulation framework.
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
45 Along with reSID-library it produces probably most accurate emulated
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
46 representation of SID-chip available. This, however, comes at high
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
47 cost: libSIDPlay2 tends to eat CPU like popcorn, depending on the
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
48 selected emulation options. It is also less spread, not as many
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
49 distributions/operating systems come with pre-packaged libSIDPlay2,
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
50 so you may have to roll your own.
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
51
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
52 Also the API-stability of libSIDPlay2 is not yet 100%, there may
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
53 be changes. Bugs are evident, though many of them will be fixed
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
54 eventually.
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
55
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
56
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
57 Conclusion thus is as follows: If you are using an old system with not
193
5cb9c9e9a020 Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 191
diff changeset
58 much spare CPU-power, choose libSIDPlay v1. On a relatively recent
5cb9c9e9a020 Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 191
diff changeset
59 system (more powerful than Pentium III 500MHz) you may wish to choose
5cb9c9e9a020 Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 191
diff changeset
60 libSIDPlay v2, although your mileage may vary.
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
61
200
ec8b735f5418 Support for libNanoSID dropped.
Matti Hamalainen <ccr@tnsp.org>
parents: 199
diff changeset
62
ec8b735f5418 Support for libNanoSID dropped.
Matti Hamalainen <ccr@tnsp.org>
parents: 199
diff changeset
63
ec8b735f5418 Support for libNanoSID dropped.
Matti Hamalainen <ccr@tnsp.org>
parents: 199
diff changeset
64 Configuration
ec8b735f5418 Support for libNanoSID dropped.
Matti Hamalainen <ccr@tnsp.org>
parents: 199
diff changeset
65 =============
ec8b735f5418 Support for libNanoSID dropped.
Matti Hamalainen <ccr@tnsp.org>
parents: 199
diff changeset
66
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
67
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
68
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
69 Usage
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
70 =====
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
71 Using the plugin is quite simple: if you are familiar with XMMS and
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
72 SIDPlay, then you already know how to use XMMS-SID. Configuration
146
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
73 should be self-explanatory for most part, here are few tips:
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
74
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
75 * 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
76 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
77 highly recommend that you download the database and configure
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
78 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
79 http://www.geocities.com/SiliconValley/Lakes/5147/sidplay/sldb.html
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
80
193
5cb9c9e9a020 Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 191
diff changeset
81 * SIDPlay2-emulation is heavier, but more accurate. So you need to
5cb9c9e9a020 Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 191
diff changeset
82 have more CPU-power for it.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
83
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
84 * Oversampling is available with SIDPlay2-emulation, it can further
55
e3708b2bbc5f Minor grammar improvement
Matti Hamalainen <ccr@tnsp.org>
parents: 35
diff changeset
85 enchange the audio quality, but you need some really powerful
e3708b2bbc5f Minor grammar improvement
Matti Hamalainen <ccr@tnsp.org>
parents: 35
diff changeset
86 hardware to run it smoothly.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
87
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
88 * Filter-settings can be usually left as they are, unless you know
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
89 what you're doing.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
90
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
91 * If the plugin doesn't recognize your SID-tunes, try checking the
193
5cb9c9e9a020 Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 191
diff changeset
92 'Determine filetype by contents' option in the XMMS-SID config
5cb9c9e9a020 Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 191
diff changeset
93 window. This is horrendously slow if you're reading a 10000-tune
5cb9c9e9a020 Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 191
diff changeset
94 playlist, though.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
95
193
5cb9c9e9a020 Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 191
diff changeset
96 * For those who don't know it: Autopanning and stereo are not native
5cb9c9e9a020 Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 191
diff changeset
97 to the original SID chip, but are extra options implemented in
5cb9c9e9a020 Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 191
diff changeset
98 libSIDPlay. So if you think that the tune does not sound as it
5cb9c9e9a020 Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 191
diff changeset
99 sounds on real C64, use the Mono setting.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
100
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
101 * The "kb/s rate" box is actually the play rate in Hz, so you can
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
102 see if it's an NTSC or PAL song (if you haven't set the Force Speed
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
103 option).
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
104
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
105 Also see FAQ for more tips, notes and such.
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
106
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
107
158
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
108 License
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
109 =======
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
110 XMMS-SID is distributed under GNU General Public License version 2,
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
111 see COPYING for more information.
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
112
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
113 If you like XMMS-SID, you can thank me by distributing message
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
114 about it's existence and voting it on freshmeat.net.
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
115
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
116
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
117 Contact, support and new versions
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
118 =================================
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
119 New releases of this plugin should be available at TNSP's WWW-
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
120 homepages, see below for address. Bug-reports, suggestions,
158
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
121 patches, etc. should be sent to ccr at least for now, please see
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
122 the homepage for latest information.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
123
191
bdf3d81fb937 Cleanup too long line
Matti Hamalainen <ccr@tnsp.org>
parents: 173
diff changeset
124
205
de47d797ee33 Updates to contact information.
Matti Hamalainen <ccr@tnsp.org>
parents: 204
diff changeset
125 IRC : The #xmms-sid on freenode has been TERMINATED, so
de47d797ee33 Updates to contact information.
Matti Hamalainen <ccr@tnsp.org>
parents: 204
diff changeset
126 don't bother going there. After 2 years of idling
de47d797ee33 Updates to contact information.
Matti Hamalainen <ccr@tnsp.org>
parents: 204
diff changeset
127 alone on that channel, I got bored.
204
69de64975d18 Updates
Matti Hamalainen <ccr@tnsp.org>
parents: 200
diff changeset
128
205
de47d797ee33 Updates to contact information.
Matti Hamalainen <ccr@tnsp.org>
parents: 204
diff changeset
129 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
130 unsurprising nickname "ccr".
204
69de64975d18 Updates
Matti Hamalainen <ccr@tnsp.org>
parents: 200
diff changeset
131 (see http://www.freenode.net/ for more information)
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
132
112
fb16fc1fd506 Minor updates to docs, added reference to IRC-channel
Matti Hamalainen <ccr@tnsp.org>
parents: 93
diff changeset
133 E-mail : ccr@tnsp.org
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
134
112
fb16fc1fd506 Minor updates to docs, added reference to IRC-channel
Matti Hamalainen <ccr@tnsp.org>
parents: 93
diff changeset
135 Homepage : http://www.tnsp.org/xmms-sid.php
191
bdf3d81fb937 Cleanup too long line
Matti Hamalainen <ccr@tnsp.org>
parents: 173
diff changeset
136