Mercurial > hg > xmms-sid
annotate README @ 740:aa8f054e27a3
Updated the documentation a bit.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Mon, 05 Nov 2012 15:08:44 +0200 |
parents | f2037b4d2c23 |
children | 22d0c5631fd2 |
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 |
740
aa8f054e27a3
Updated the documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
701
diff
changeset
|
4 (C) Copyright 1999-2012 Tecnic Software productions (TNSP) |
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 | 8 |
254
d3a4d35f2a8f
Themetune, at least temporarily. Haven't asked Agemixer yet for permission.
Matti Hamalainen <ccr@tnsp.org>
parents:
251
diff
changeset
|
9 "Kummatti City", theme of XMMS-SID 0.8 |
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 | 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 | 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 | 21 to the memory of |
22 | |
601 | 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 --------------------------------------------------------------------- |
1 | 37 |
275 | 38 Short introduction |
146
d9d776c6f4cd
Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents:
134
diff
changeset
|
39 ================== |
7 | 40 XMMS-SID is a plugin for XMMS (X MultiMedia System) which provides |
601 | 41 support for playing "SID tunes", which are music from old Commodore |
42 64/128 computer series software, including games, demos, etc. | |
1 | 43 |
146
d9d776c6f4cd
Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents:
134
diff
changeset
|
44 |
200
ec8b735f5418
Support for libNanoSID dropped.
Matti Hamalainen <ccr@tnsp.org>
parents:
199
diff
changeset
|
45 Configuration |
ec8b735f5418
Support for libNanoSID dropped.
Matti Hamalainen <ccr@tnsp.org>
parents:
199
diff
changeset
|
46 ============= |
ec8b735f5418
Support for libNanoSID dropped.
Matti Hamalainen <ccr@tnsp.org>
parents:
199
diff
changeset
|
47 |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
48 Audio-tab |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
49 --------- |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
50 - 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
|
51 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
|
52 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
|
53 is much worse than 16-bit. |
171 | 54 |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
55 - 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
|
56 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
|
57 artificial additions. |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
58 |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
59 - Samplerate: High samplerate means better quality sound. Usually |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
60 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
|
61 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
|
62 |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
63 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
|
64 thus requires more CPU power. |
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 - Oversampling: Some emulator backends (currently only SIDPlay 2) |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
67 support technique called "oversampling", which further enhances |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
68 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
|
69 higher rate (factor * samplerate) and then downsampling with |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
70 rate-conversion filter. |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
71 |
601 | 72 This results in smoother waveforms, but it consumes very much |
73 CPU power! | |
336 | 74 |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
75 |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
76 Emu#1-tab |
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 - 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
|
79 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
|
80 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
|
81 emulator libraries and their aspects. |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
82 |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
83 - Memory mode: libSIDPlay supports several different memory modes |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
84 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
|
85 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
|
86 For SIDPlay 1 emulation, select "Bank switching". |
1 | 87 |
256
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
88 |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
89 Emu#2-tab |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
90 --------- |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
91 - 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
|
92 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
|
93 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
|
94 know what you're doing. |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
95 |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
96 - 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
|
97 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
|
98 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
|
99 not known. |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
100 |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
101 - SIDPlay 2 options: |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
102 - 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
|
103 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
|
104 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
|
105 inaccurate emulation. |
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 - reSID-emulation / HardSID: Select SIDPlay 2 backend. reSID |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
108 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
|
109 option available. HardSID is backend for HardSID card, |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
110 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
|
111 |
256
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
112 |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
113 Filters-tab |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
114 ----------- |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
115 - 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
|
116 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
|
117 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
|
118 |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
119 - 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
|
120 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
|
121 to touch filter settings. |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
122 |
256
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
123 |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
124 Songlength-tab |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
125 -------------- |
308
ae5795ba5c77
Remove "only when song-length unknown" option from minimum playtime, it
Matti Hamalainen <ccr@tnsp.org>
parents:
286
diff
changeset
|
126 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
|
127 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
|
128 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
|
129 is not found from song-length database. |
146
d9d776c6f4cd
Added information about SLDB, cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents:
134
diff
changeset
|
130 |
256
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
131 - Use XSIDPLAY-compatible database: If enabled, you can specify |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
132 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
|
133 database is not used. |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
134 |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
135 - DB-file: Specify path and filename, usually Songlengths.txt, |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
136 that contains lengths for most songs in High Voltage SID |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
137 Collection (HVSC) in XSIDPLAY compatible format, for example: |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
138 /media/Songlengths.txt |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
139 |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
140 Click the "Browse" button to get a file selector dialog. |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
141 |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
142 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
|
143 XMMS-SID to use it. The SLDB is included with latest versions of |
3cc9b8e23d88
SLDB is now distributed with HVSC.
Matti Hamalainen <ccr@tnsp.org>
parents:
670
diff
changeset
|
144 HVSC. |
256
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
145 |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
146 |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
147 Title-tab |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
148 --------- |
266 | 149 SID Tune Information List (STIL) database: |
256
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
150 |
266 | 151 - Use STIL database: If enabled, the settings below take effect |
152 and XMMS-SID can utilize additional information from High | |
153 Voltage SID Collection (HVSC) STIL-database. STIL contains | |
154 general information about the tune, plus trivia, history and | |
155 comments from the composers. | |
256
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
156 |
266 | 157 - STIL file: Path and filename of STIL database (STIL.txt). |
158 Usually the STIL database file is under DOCUMENTS/ sub- | |
159 directory of HVSC, for example: | |
256
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
160 /media/C64Music/DOCUMENTS/STIL.txt |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
161 |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
162 - HVSC path: Path to your High Voltage SID Collection directory, |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
163 for example: /media/C64Music |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
164 |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
165 Click the "Browse" button to get a file selector dialog. |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
166 |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
167 Song name/title format: |
7 | 168 |
256
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
169 - Override generic XMMS titles: Enable to override generic XMMS |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
170 titlestring setting and use XMMS-SID specific titlestring |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
171 format. |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
172 |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
173 |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
174 Misc-tab |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
175 -------- |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
176 Sub-tune control: |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
177 |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
178 - Disabled: No separate sub-tune control. The sub-tune selector |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
179 in XMMS-SID's fileinfo dialog will still be enabled. |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
180 |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
181 - 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
|
182 the one used in "XMMS-SidPlay" |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
183 |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
184 - 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
|
185 Unix Amiga Delitracker Emulator (UADE). Any interaction with |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
186 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
|
187 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
|
188 (ESC) or moving mouse out of the window closes it. |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
189 |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
190 - 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
|
191 (patched with song-position patch, which comes with XMMS-SID), |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
192 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
|
193 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
|
194 only option.) |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
195 |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
196 Automatic sub-tune changes: |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
197 |
286
2db7bcc43f2b
Document automatic sub-tune changing.
Matti Hamalainen <ccr@tnsp.org>
parents:
275
diff
changeset
|
198 - 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
|
199 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
|
200 others that have not been played. |
256
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
201 |
286
2db7bcc43f2b
Document automatic sub-tune changing.
Matti Hamalainen <ccr@tnsp.org>
parents:
275
diff
changeset
|
202 - 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
|
203 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
|
204 changer. |
2db7bcc43f2b
Document automatic sub-tune changing.
Matti Hamalainen <ccr@tnsp.org>
parents:
275
diff
changeset
|
205 |
2db7bcc43f2b
Document automatic sub-tune changing.
Matti Hamalainen <ccr@tnsp.org>
parents:
275
diff
changeset
|
206 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
|
207 |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
208 Miscellaneous options: |
42632e13d6b5
More documentation about configuration.
Matti Hamalainen <ccr@tnsp.org>
parents:
254
diff
changeset
|
209 |
263
d7b7d49b52fe
Clarified detect file contents option description.
Matti Hamalainen <ccr@tnsp.org>
parents:
256
diff
changeset
|
210 - 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
|
211 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
|
212 extension (.sid, .dat, ...) is checked. |
d7b7d49b52fe
Clarified detect file contents option description.
Matti Hamalainen <ccr@tnsp.org>
parents:
256
diff
changeset
|
213 |
d7b7d49b52fe
Clarified detect file contents option description.
Matti Hamalainen <ccr@tnsp.org>
parents:
256
diff
changeset
|
214 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
|
215 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
|
216 playlist, though. |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
217 |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
218 |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
219 Miscellaneous tips |
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
220 ================== |
400
39824bf269f9
Add information about the automagic configuration adjusting when emulation
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
221 * 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
|
222 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
|
223 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
|
224 to plugin configuration after that. |
39824bf269f9
Add information about the automagic configuration adjusting when emulation
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
225 |
193 | 226 * SIDPlay2-emulation is heavier, but more accurate. So you need to |
227 have more CPU-power for it. | |
1 | 228 |
7 | 229 * Oversampling is available with SIDPlay2-emulation, it can further |
55 | 230 enchange the audio quality, but you need some really powerful |
231 hardware to run it smoothly. | |
1 | 232 |
7 | 233 * Filter-settings can be usually left as they are, unless you know |
234 what you're doing. | |
1 | 235 |
193 | 236 * For those who don't know it: Autopanning and stereo are not native |
237 to the original SID chip, but are extra options implemented in | |
238 libSIDPlay. So if you think that the tune does not sound as it | |
239 sounds on real C64, use the Mono setting. | |
1 | 240 |
241 * The "kb/s rate" box is actually the play rate in Hz, so you can | |
242 see if it's an NTSC or PAL song (if you haven't set the Force Speed | |
243 option). | |
244 | |
251
e9ea4ce4c697
Muchly improved documentation and installation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
205
diff
changeset
|
245 Also see FAQ for more tips, gotchas and such. |
7 | 246 |
1 | 247 |
158 | 248 Contact, support and new versions |
249 ================================= | |
7 | 250 New releases of this plugin should be available at TNSP's WWW- |
251 homepages, see below for address. Bug-reports, suggestions, | |
158 | 252 patches, etc. should be sent to ccr at least for now, please see |
253 the homepage for latest information. | |
1 | 254 |
191 | 255 |
112
fb16fc1fd506
Minor updates to docs, added reference to IRC-channel
Matti Hamalainen <ccr@tnsp.org>
parents:
93
diff
changeset
|
256 E-mail : ccr@tnsp.org |
1 | 257 |
112
fb16fc1fd506
Minor updates to docs, added reference to IRC-channel
Matti Hamalainen <ccr@tnsp.org>
parents:
93
diff
changeset
|
258 Homepage : http://www.tnsp.org/xmms-sid.php |
191 | 259 |