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