annotate README @ 162:d3425d53be3a

Updated documentation, upgraded libtool to 1.5.6 which should fix problems on some platforms <http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=253350>
author Matti Hamalainen <ccr@tnsp.org>
date Wed, 09 Jun 2004 00:00:05 +0000
parents 450fea61cad5
children 78e06aecad7f
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
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
15 from old Commodore computer programs like 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 For the actual playing, XMMS-SID supports numerous emulator
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
18 engines, including the excellent libSIDPlay v1 and v2.
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
19
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
20
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
21 Requirements and installation
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
22 =============================
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
23 See file "INSTALL" for information about what XMMS-SID requires,
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
24 where to get those required packages and how to install.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
25
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
26
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
27 Usage
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
28 =====
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
29 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
30 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
31 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
32
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
33 * 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
34 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
35 highly recommend that you download the database and configure
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
36 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
37 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
38
112
fb16fc1fd506 Minor updates to docs, added reference to IRC-channel
Matti Hamalainen <ccr@tnsp.org>
parents: 93
diff changeset
39 * SIDPlay2-emulation is heavier, but more accurate. So you need to have
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
40 more CPU-power for it.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
41
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
42 * Oversampling is available with SIDPlay2-emulation, it can further
55
e3708b2bbc5f Minor grammar improvement
Matti Hamalainen <ccr@tnsp.org>
parents: 35
diff changeset
43 enchange the audio quality, but you need some really powerful
e3708b2bbc5f Minor grammar improvement
Matti Hamalainen <ccr@tnsp.org>
parents: 35
diff changeset
44 hardware to run it smoothly.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
45
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
46 * 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
47 what you're doing.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
48
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
49 * If the plugin doesn't recognize your SID-tunes, try checking the
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
50 'Determine filetype by contents' option in the XMMS-SID config window.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
51 This is horrendously slow if you're reading a 10000-tune playlist,
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
52 though.
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
53
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
54 * For those who don't know it: Autopanning and stereo are not native to
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
55 the original SID chip on C64&all, but are extra options implemented in
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
56 libsidplay. So if you think that the tune does not sound as it sounds
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
57 on the real C64 (or other SID using machine), use the Mono setting.
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
58
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
59 * 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
60 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
61 option).
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
62
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
63 Also see FAQ for more tips, notes and such.
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
64
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
65
158
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
66 License
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
67 =======
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
68 XMMS-SID is distributed under GNU General Public License version 2,
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
69 see COPYING for more information.
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
70
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
71 If you like XMMS-SID, you can thank me by distributing message
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
72 about it's existence and voting it on freshmeat.net.
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
73
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
74
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
75 Contact, support and new versions
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
76 =================================
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
77 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
78 homepages, see below for address. Bug-reports, suggestions,
158
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
79 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
80 the homepage for latest information.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
81
160
450fea61cad5 Updated IRC-channel information.
Matti Hamalainen <ccr@tnsp.org>
parents: 158
diff changeset
82 IRC : The #xmms-sid on freenode has been TERMINATED.
450fea61cad5 Updated IRC-channel information.
Matti Hamalainen <ccr@tnsp.org>
parents: 158
diff changeset
83 But I do idle on #xmms at irc.freenode.net (see http://www.freenode.net/)
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
84
112
fb16fc1fd506 Minor updates to docs, added reference to IRC-channel
Matti Hamalainen <ccr@tnsp.org>
parents: 93
diff changeset
85 E-mail : ccr@tnsp.org
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
86
112
fb16fc1fd506 Minor updates to docs, added reference to IRC-channel
Matti Hamalainen <ccr@tnsp.org>
parents: 93
diff changeset
87 Homepage : http://www.tnsp.org/xmms-sid.php