Mercurial > hg > xmms-sid

annotate README @ 984:2b6184fa7e4a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated.
author Matti Hamalainen <ccr@tnsp.org>
date Sun, 31 Mar 2013 11:43:27 +0300
parents 1cd7dead1b56
children cfc879a562c3
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
979
9bd29db2d1bf Update copyrights.
Matti Hamalainen <ccr@tnsp.org>
parents: 902
diff changeset
4 (C) Copyright 1999-2013 Tecnic Software productions (TNSP)
740
aa8f054e27a3 Updated the documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 701
diff changeset
5
aa8f054e27a3 Updated the documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 701
diff changeset
6 XMMS-SID is distributed under GNU General Public License version 2,
aa8f054e27a3 Updated the documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 701
diff changeset
7 see COPYING for more information, except for:
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
8
815
303a2bfe1805 Remove reference to 0.8.
Matti Hamalainen <ccr@tnsp.org>
parents: 749
diff changeset
9 "Kummatti City", theme of XMMS-SID
254
d3a4d35f2a8f Themetune, at least temporarily. Haven't asked Agemixer yet for permission.
Matti Hamalainen <ccr@tnsp.org>
parents: 251
diff changeset
10 by Ari 'Agemixer' Yliaho
268
ca84c55003db Cleanups
Matti Hamalainen <ccr@tnsp.org>
parents: 266
diff changeset
11 (C) Copyright 1998 Scallop
254
d3a4d35f2a8f Themetune, at least temporarily. Haven't asked Agemixer yet for permission.
Matti Hamalainen <ccr@tnsp.org>
parents: 251
diff changeset
12
d3a4d35f2a8f Themetune, at least temporarily. Haven't asked Agemixer yet for permission.
Matti Hamalainen <ccr@tnsp.org>
parents: 251
diff changeset
13 NOTICE! "Kummatti City" song is freely distributable as part
d3a4d35f2a8f Themetune, at least temporarily. Haven't asked Agemixer yet for permission.
Matti Hamalainen <ccr@tnsp.org>
parents: 251
diff changeset
14 of XMMS-SID, but it is not distributed under GNU General Public
d3a4d35f2a8f Themetune, at least temporarily. Haven't asked Agemixer yet for permission.
Matti Hamalainen <ccr@tnsp.org>
parents: 251
diff changeset
15 License like the rest of XMMS-SID package is, but "copyrighted
d3a4d35f2a8f Themetune, at least temporarily. Haven't asked Agemixer yet for permission.
Matti Hamalainen <ccr@tnsp.org>
parents: 251
diff changeset
16 freeware". Contact mr. Ari Yliaho if you wish to use this
d3a4d35f2a8f Themetune, at least temporarily. Haven't asked Agemixer yet for permission.
Matti Hamalainen <ccr@tnsp.org>
parents: 251
diff changeset
17 song in any other way.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
18
560
c90cebde0907 Remove the MD5 code (C) notice, because it was replaced.
Matti Hamalainen <ccr@tnsp.org>
parents: 422
diff changeset
19 ---------------------------------------------------------------------
c90cebde0907 Remove the MD5 code (C) notice, because it was replaced.
Matti Hamalainen <ccr@tnsp.org>
parents: 422
diff changeset
20 This release is dedicated
571
c46b3c94c528 Adjustments
Matti Hamalainen <ccr@tnsp.org>
parents: 560
diff changeset
21 to the memory of
c46b3c94c528 Adjustments
Matti Hamalainen <ccr@tnsp.org>
parents: 560
diff changeset
22
601
45ac346884d6 Grammar.
Matti Hamalainen <ccr@tnsp.org>
parents: 571
diff changeset
23 Richard Joseph
560
c90cebde0907 Remove the MD5 code (C) notice, because it was replaced.
Matti Hamalainen <ccr@tnsp.org>
parents: 422
diff changeset
24 (RIP, March 4th 2007)
c90cebde0907 Remove the MD5 code (C) notice, because it was replaced.
Matti Hamalainen <ccr@tnsp.org>
parents: 422
diff changeset
25
641
a5e42ce2988a Dedicated also to memory of Xoxxo :/
Matti Hamalainen <ccr@tnsp.org>
parents: 601
diff changeset
26 He was one of the old C64 music legends,
a5e42ce2988a Dedicated also to memory of Xoxxo :/
Matti Hamalainen <ccr@tnsp.org>
parents: 601
diff changeset
27 now gone, but forever in our hearts.
a5e42ce2988a Dedicated also to memory of Xoxxo :/
Matti Hamalainen <ccr@tnsp.org>
parents: 601
diff changeset
28 ---------------------------------------------------------------------
a5e42ce2988a Dedicated also to memory of Xoxxo :/
Matti Hamalainen <ccr@tnsp.org>
parents: 601
diff changeset
29 Also dedicated
a5e42ce2988a Dedicated also to memory of Xoxxo :/
Matti Hamalainen <ccr@tnsp.org>
parents: 601
diff changeset
30 to the memory of
a5e42ce2988a Dedicated also to memory of Xoxxo :/
Matti Hamalainen <ccr@tnsp.org>
parents: 601
diff changeset
31
a5e42ce2988a Dedicated also to memory of Xoxxo :/
Matti Hamalainen <ccr@tnsp.org>
parents: 601
diff changeset
32 Lauri 'Enochian' Sipila
a5e42ce2988a Dedicated also to memory of Xoxxo :/
Matti Hamalainen <ccr@tnsp.org>
parents: 601
diff changeset
33 (3.5.1979 - 26.7.2007)
a5e42ce2988a Dedicated also to memory of Xoxxo :/
Matti Hamalainen <ccr@tnsp.org>
parents: 601
diff changeset
34
a5e42ce2988a Dedicated also to memory of Xoxxo :/
Matti Hamalainen <ccr@tnsp.org>
parents: 601
diff changeset
35 A friend, who will be sorely missed.
560
c90cebde0907 Remove the MD5 code (C) notice, because it was replaced.
Matti Hamalainen <ccr@tnsp.org>
parents: 422
diff changeset
36 ---------------------------------------------------------------------
830
e3b293c5b8b3 Add Kitania to the list of people remembered. :(
Matti Hamalainen <ccr@tnsp.org>
parents: 815
diff changeset
37 And
e3b293c5b8b3 Add Kitania to the list of people remembered. :(
Matti Hamalainen <ccr@tnsp.org>
parents: 815
diff changeset
38
e3b293c5b8b3 Add Kitania to the list of people remembered. :(
Matti Hamalainen <ccr@tnsp.org>
parents: 815
diff changeset
39 Jessica 'Kitania' Lanier
e3b293c5b8b3 Add Kitania to the list of people remembered. :(
Matti Hamalainen <ccr@tnsp.org>
parents: 815
diff changeset
40 (23.10.1963 - 30.7.2012)
e3b293c5b8b3 Add Kitania to the list of people remembered. :(
Matti Hamalainen <ccr@tnsp.org>
parents: 815
diff changeset
41
e3b293c5b8b3 Add Kitania to the list of people remembered. :(
Matti Hamalainen <ccr@tnsp.org>
parents: 815
diff changeset
42 She was wonderful, and most poingy.
e3b293c5b8b3 Add Kitania to the list of people remembered. :(
Matti Hamalainen <ccr@tnsp.org>
parents: 815
diff changeset
43 ---------------------------------------------------------------------
980
1cd7dead1b56 Add dedication to Taneli, as well. :(
Matti Hamalainen <ccr@tnsp.org>
parents: 979
diff changeset
44 And
1cd7dead1b56 Add dedication to Taneli, as well. :(
Matti Hamalainen <ccr@tnsp.org>
parents: 979
diff changeset
45
1cd7dead1b56 Add dedication to Taneli, as well. :(
Matti Hamalainen <ccr@tnsp.org>
parents: 979
diff changeset
46 Taneli 'Nuane' Lampela
1cd7dead1b56 Add dedication to Taneli, as well. :(
Matti Hamalainen <ccr@tnsp.org>
parents: 979
diff changeset
47 (5.4.1980 - 7.3.2013)
1cd7dead1b56 Add dedication to Taneli, as well. :(
Matti Hamalainen <ccr@tnsp.org>
parents: 979
diff changeset
48
1cd7dead1b56 Add dedication to Taneli, as well. :(
Matti Hamalainen <ccr@tnsp.org>
parents: 979
diff changeset
49 I wish you had stayed longer.
1cd7dead1b56 Add dedication to Taneli, as well. :(
Matti Hamalainen <ccr@tnsp.org>
parents: 979
diff changeset
50 ---------------------------------------------------------------------
1cd7dead1b56 Add dedication to Taneli, as well. :(
Matti Hamalainen <ccr@tnsp.org>
parents: 979
diff changeset
51
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
52
275
Matti Hamalainen <ccr@tnsp.org>
parents: 268
diff changeset
53 Short introduction
146
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
54 ==================
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
55 XMMS-SID is a plugin for XMMS (X MultiMedia System) which provides
601
45ac346884d6 Grammar.
Matti Hamalainen <ccr@tnsp.org>
parents: 571
diff changeset
56 support for playing "SID tunes", which are music from old Commodore
45ac346884d6 Grammar.
Matti Hamalainen <ccr@tnsp.org>
parents: 571
diff changeset
57 64/128 computer series software, including games, demos, etc.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
58
146
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
59
200
ec8b735f5418 Support for libNanoSID dropped.
Matti Hamalainen <ccr@tnsp.org>
parents: 199
diff changeset
60 Configuration
ec8b735f5418 Support for libNanoSID dropped.
Matti Hamalainen <ccr@tnsp.org>
parents: 199
diff changeset
61 =============
ec8b735f5418 Support for libNanoSID dropped.
Matti Hamalainen <ccr@tnsp.org>
parents: 199
diff changeset
62
251
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
63 Audio-tab
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
64 ---------
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
65 - 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
66 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
67 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
68 is much worse than 16-bit.
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 162
diff changeset
69
251
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
70 - 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
71 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
72 artificial additions.
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
73
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
74 - Samplerate: High samplerate means better quality sound. Usually
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
75 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
76 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
77
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
78 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
79 thus requires more CPU power.
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
80
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 Emu#1-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 - 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
85 backend from those which for support has been compiled in
254
d3a4d35f2a8f Themetune, at least temporarily. Haven't asked Agemixer yet for permission.
Matti Hamalainen <ccr@tnsp.org>
parents: 251
diff changeset
86 XMMS-SID. Refer to file "INSTALL" for discussion about
d3a4d35f2a8f Themetune, at least temporarily. Haven't asked Agemixer yet for permission.
Matti Hamalainen <ccr@tnsp.org>
parents: 251
diff changeset
87 emulator libraries and their aspects.
251
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
88
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
89 - Memory mode: libSIDPlay supports several different memory modes
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
90 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
91 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
92 For SIDPlay 1 emulation, select "Bank switching".
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
93
256
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
94
251
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
95 Emu#2-tab
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
96 ---------
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
97 - 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
98 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
99 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
100 know what you're doing.
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
101
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
102 - 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
103 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
104 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
105 not known.
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
106
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
107 - SIDPlay 2 options:
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
108 - 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
109 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
110 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
111 inaccurate emulation.
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
112
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
113 - reSID-emulation / HardSID: Select SIDPlay 2 backend. reSID
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
114 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
115 option available. HardSID is backend for HardSID card,
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
116 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
117
902
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
118 - C64 Kernal/Basic/Chargen ROM image paths. Currently required
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
119 only by libSIDPlay-FP backend. Set the path to a directory that
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
120 contains these 3 ROM image files:
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
121
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
122 Filename | Size | Description
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
123 ----------+------+-------------------------------------
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
124 kernal | 8192 | C64 KERNAL ROM
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
125 basic | 8192 | C64 BASIC v2.0 ROM
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
126 chargen | 4096 | C64 character data ROM
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
127
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
128 These files can be found, for example, from Versatile Commodore
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
129 Emulator (VICE)'s tarballs. There are other sources as well.
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
130
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
131 For example, if you have VICE installed under /usr/local, the
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
132 usual path to ROM directories would be:
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
133
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
134 /usr/local/lib/vice/C64
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
135
256
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
136
251
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
137 Filters-tab
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
138 -----------
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
139 - Emulate filters: Enable filter emulation. Usually you will want
902
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
140 to enable this option, unless you are running on very slow CPU,
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
141 or on purpose. SID filters affect outcome of most tunes very much.
251
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
142
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
143 - 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
144 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
145 to touch filter settings.
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
146
256
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
147
251
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
148 Songlength-tab
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
149 --------------
308
ae5795ba5c77 Remove "only when song-length unknown" option from minimum playtime, it
Matti Hamalainen <ccr@tnsp.org>
parents: 286
diff changeset
150 Most of song length settings should be self-explanatory.
ae5795ba5c77 Remove "only when song-length unknown" option from minimum playtime, it
Matti Hamalainen <ccr@tnsp.org>
parents: 286
diff changeset
151 The "Only when song-length is unknown" option makes
ae5795ba5c77 Remove "only when song-length unknown" option from minimum playtime, it
Matti Hamalainen <ccr@tnsp.org>
parents: 286
diff changeset
152 playtime limit effective only when song length information
ae5795ba5c77 Remove "only when song-length unknown" option from minimum playtime, it
Matti Hamalainen <ccr@tnsp.org>
parents: 286
diff changeset
153 is not found from song-length database.
146
d9d776c6f4cd Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 134
diff changeset
154
256
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
155 - Use XSIDPLAY-compatible database: If enabled, you can specify
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
156 song-length database file and it is used. If disabled, the
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
157 database is not used.
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
158
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
159 - DB-file: Specify path and filename, usually Songlengths.txt,
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
160 that contains lengths for most songs in High Voltage SID
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
161 Collection (HVSC) in XSIDPLAY compatible format, for example:
902
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
162 /media/C64Music/DOCUMENTS/Songlengths.txt
256
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
163
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
164 Click the "Browse" button to get a file selector dialog.
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
165
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
166 I highly recommend that you download the database and configure
683
3cc9b8e23d88 SLDB is now distributed with HVSC.
Matti Hamalainen <ccr@tnsp.org>
parents: 670
diff changeset
167 XMMS-SID to use it. The SLDB is included with latest versions of
902
451e248f4f65 Document the ROM configuration option.
Matti Hamalainen <ccr@tnsp.org>
parents: 830
diff changeset
168 HVSC, under DOCUMENTS/Songlengths.txt
256
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
169
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
170
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
171 Title-tab
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
172 ---------
266
cb218e92d1d4 Several kyrpe-paske fixed.
Matti Hamalainen <ccr@tnsp.org>
parents: 263
diff changeset
173 SID Tune Information List (STIL) database:
256
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
174
266
cb218e92d1d4 Several kyrpe-paske fixed.
Matti Hamalainen <ccr@tnsp.org>
parents: 263
diff changeset
175 - Use STIL database: If enabled, the settings below take effect
cb218e92d1d4 Several kyrpe-paske fixed.
Matti Hamalainen <ccr@tnsp.org>
parents: 263
diff changeset
176 and XMMS-SID can utilize additional information from High
cb218e92d1d4 Several kyrpe-paske fixed.
Matti Hamalainen <ccr@tnsp.org>
parents: 263
diff changeset
177 Voltage SID Collection (HVSC) STIL-database. STIL contains
cb218e92d1d4 Several kyrpe-paske fixed.
Matti Hamalainen <ccr@tnsp.org>
parents: 263
diff changeset
178 general information about the tune, plus trivia, history and
cb218e92d1d4 Several kyrpe-paske fixed.
Matti Hamalainen <ccr@tnsp.org>
parents: 263
diff changeset
179 comments from the composers.
256
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
180
266
cb218e92d1d4 Several kyrpe-paske fixed.
Matti Hamalainen <ccr@tnsp.org>
parents: 263
diff changeset
181 - STIL file: Path and filename of STIL database (STIL.txt).
cb218e92d1d4 Several kyrpe-paske fixed.
Matti Hamalainen <ccr@tnsp.org>
parents: 263
diff changeset
182 Usually the STIL database file is under DOCUMENTS/ sub-
cb218e92d1d4 Several kyrpe-paske fixed.
Matti Hamalainen <ccr@tnsp.org>
parents: 263
diff changeset
183 directory of HVSC, for example:
256
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
184 /media/C64Music/DOCUMENTS/STIL.txt
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
185
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
186 - HVSC path: Path to your High Voltage SID Collection directory,
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
187 for example: /media/C64Music
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
188
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
189 Click the "Browse" button to get a file selector dialog.
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
190
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
191 Song name/title format:
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
192
256
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
193 - Override generic XMMS titles: Enable to override generic XMMS
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
194 titlestring setting and use XMMS-SID specific titlestring
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
195 format.
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
196
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
197
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
198 Misc-tab
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
199 --------
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
200 Sub-tune control:
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
201
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
202 - Disabled: No separate sub-tune control. The sub-tune selector
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
203 in XMMS-SID's fileinfo dialog will still be enabled.
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
204
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
205 - Seek back/forward changes sub-song: This method is similar to
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
206 the one used in "XMMS-SidPlay"
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
207
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
208 - Pop-up via seekbar (UADE-style): Similar to selector used in
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
209 Unix Amiga Delitracker Emulator (UADE). Any interaction with
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
210 XMMS's seeking capabilities pops up a sub-tune control window.
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
211 Mouse and arrow keys can be used to select a tune. Escape key
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
212 (ESC) or moving mouse out of the window closes it.
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
213
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
214 - Song-position patch: If you have a patched version of XMMS
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
215 (patched with song-position patch, which comes with XMMS-SID),
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
216 you can select this method. Then you can use XMMS's seekbar
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
217 to select the sub-tune. (Back in XMMS-SID v0.7 this was the
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
218 only option.)
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
219
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
220 Automatic sub-tune changes:
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
221
286
2db7bcc43f2b Document automatic sub-tune changing.
Matti Hamalainen <ccr@tnsp.org>
parents: 275
diff changeset
222 - Go through all sub-tunes in file: When enabled, all sub-tunes
2db7bcc43f2b Document automatic sub-tune changing.
Matti Hamalainen <ccr@tnsp.org>
parents: 275
diff changeset
223 in files will be played. The default tune is played first, then
2db7bcc43f2b Document automatic sub-tune changing.
Matti Hamalainen <ccr@tnsp.org>
parents: 275
diff changeset
224 others that have not been played.
256
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
225
286
2db7bcc43f2b Document automatic sub-tune changing.
Matti Hamalainen <ccr@tnsp.org>
parents: 275
diff changeset
226 - Only tunes with specified minimum length: Only sub-tunes with
2db7bcc43f2b Document automatic sub-tune changing.
Matti Hamalainen <ccr@tnsp.org>
parents: 275
diff changeset
227 this given minimum length will be played by automatic sub-tune
2db7bcc43f2b Document automatic sub-tune changing.
Matti Hamalainen <ccr@tnsp.org>
parents: 275
diff changeset
228 changer.
2db7bcc43f2b Document automatic sub-tune changing.
Matti Hamalainen <ccr@tnsp.org>
parents: 275
diff changeset
229
2db7bcc43f2b Document automatic sub-tune changing.
Matti Hamalainen <ccr@tnsp.org>
parents: 275
diff changeset
230 NOTICE: You can always manually change to wished sub-tune.
256
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
231
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
232 Miscellaneous options:
42632e13d6b5 More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 254
diff changeset
233
263
d7b7d49b52fe Clarified detect file contents option description.
Matti Hamalainen <ccr@tnsp.org>
parents: 256
diff changeset
234 - Detect file by contents: Determine if file is a SID-tune
d7b7d49b52fe Clarified detect file contents option description.
Matti Hamalainen <ccr@tnsp.org>
parents: 256
diff changeset
235 by checking the file contents. If disabled, only filename
d7b7d49b52fe Clarified detect file contents option description.
Matti Hamalainen <ccr@tnsp.org>
parents: 256
diff changeset
236 extension (.sid, .dat, ...) is checked.
d7b7d49b52fe Clarified detect file contents option description.
Matti Hamalainen <ccr@tnsp.org>
parents: 256
diff changeset
237
d7b7d49b52fe Clarified detect file contents option description.
Matti Hamalainen <ccr@tnsp.org>
parents: 256
diff changeset
238 If XMMS-SID doesn't recognize your SID-tunes, try enabling
d7b7d49b52fe Clarified detect file contents option description.
Matti Hamalainen <ccr@tnsp.org>
parents: 256
diff changeset
239 this option. It is EXTREMELY slow if you have a 10000-tune
d7b7d49b52fe Clarified detect file contents option description.
Matti Hamalainen <ccr@tnsp.org>
parents: 256
diff changeset
240 playlist, though.
251
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
241
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
242
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
243 Miscellaneous tips
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
244 ==================
400
39824bf269f9 Add information about the automagic configuration adjusting when emulation
Matti Hamalainen <ccr@tnsp.org>
parents: 387
diff changeset
245 * The emulator engine backends will adjust the preferred configuration
39824bf269f9 Add information about the automagic configuration adjusting when emulation
Matti Hamalainen <ccr@tnsp.org>
parents: 387
diff changeset
246 settings if they do not support them as they are. To see the
39824bf269f9 Add information about the automagic configuration adjusting when emulation
Matti Hamalainen <ccr@tnsp.org>
parents: 387
diff changeset
247 adjusted settings, play a tune after configuring and then go back
39824bf269f9 Add information about the automagic configuration adjusting when emulation
Matti Hamalainen <ccr@tnsp.org>
parents: 387
diff changeset
248 to plugin configuration after that.
39824bf269f9 Add information about the automagic configuration adjusting when emulation
Matti Hamalainen <ccr@tnsp.org>
parents: 387
diff changeset
249
193
5cb9c9e9a020 Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 191
diff changeset
250 * SIDPlay2-emulation is heavier, but more accurate. So you need to
5cb9c9e9a020 Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 191
diff changeset
251 have more CPU-power for it.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
252
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
253 * 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
254 what you're doing.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
255
193
5cb9c9e9a020 Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 191
diff changeset
256 * 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
257 to the original SID chip, but are extra options implemented in
5cb9c9e9a020 Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 191
diff changeset
258 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
259 sounds on real C64, use the Mono setting.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
260
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
261 * 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
262 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
263 option).
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
264
251
e9ea4ce4c697 Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents: 205
diff changeset
265 Also see FAQ for more tips, gotchas and such.
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
266
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
267
158
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
268 Contact, support and new versions
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
269 =================================
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
270 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
271 homepages, see below for address. Bug-reports, suggestions,
158
2ae878523164 Minor fixes
Matti Hamalainen <ccr@tnsp.org>
parents: 146
diff changeset
272 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
273 the homepage for latest information.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
274
191
bdf3d81fb937 Cleanup too long line
Matti Hamalainen <ccr@tnsp.org>
parents: 173
diff changeset
275
112
fb16fc1fd506 Minor updates to docs, added reference to IRC-channel
Matti Hamalainen <ccr@tnsp.org>
parents: 93
diff changeset
276 E-mail : ccr@tnsp.org
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
277
112
fb16fc1fd506 Minor updates to docs, added reference to IRC-channel
Matti Hamalainen <ccr@tnsp.org>
parents: 93
diff changeset
278 Homepage : http://www.tnsp.org/xmms-sid.php
191
bdf3d81fb937 Cleanup too long line
Matti Hamalainen <ccr@tnsp.org>
parents: 173
diff changeset
279