File: README

package info (click to toggle)
xsidplay 2.0.3-2
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 5,448 kB
  • ctags: 4,296
  • sloc: cpp: 14,967; sh: 9,859; makefile: 373
file content (228 lines) | stat: -rw-r--r-- 9,357 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
XSIDPLAY2
http://xsidplay2.sf.net

-----------------------------------------------------------------------------
GENERAL NOTES:
-----------------------------------------------------------------------------

  This version strictly requires libsidplay >= 1.36.52 due to
  PSID v2NG support as well as easier package configuration and
  compilation.
  
  When building for libsidplay v2, it must not be a release older
  than 2.1.0. See README.sidplay2 for more.

  Get libsidplay and headers and install it from either source or
  binary package. If the configure script can't find the library or
  header files in standard or common places, you need to specify the
  paths to where you've installed libsidplay (see INSTALL or
  configure --help).

-----------------------------------------------------------------------------
REQUIREMENTS:
-----------------------------------------------------------------------------

Qt (multi-threaded)

  Consult the file README.QT on where to get Qt. Apart from the Qt
  library and header files you also need a working meta object
  compiler (moc) which is part of the Qt distribution. The user
  interface compiler (uic) is not required.

  This version is made for multi-threaded Qt 3.0 and above. It
  will not compile with the older Qt 2.x and Qt 1.x series.

  The configure script does search for Qt in only a few common
  places, taking into account the environment variables $QTDIR (Qt
  installation root path) or $QTINC (Qt include path) and $QTLIB (Qt
  library path) as well as several command-line arguments (see
  configure --help).

libstdc++

  To remove a bit of burden from the programmer ;-), parts of the
  code use features provided by the Standard Template Library which
  is part of the C++ Standard. Other parts use Standard C++ features.
  If you have trouble upon compilation it may be that you need a
  newer version of your C++ compiler or Standard C++ library.

Enlightenment Sound Daemon

  If "esd-config" can be found in standard program search path, an
  audio driver for ESD will be compiled in.

KDE Sound Server (aRts)

  If "artsc-config" can be found in standard program search path, an
  audio driver for the KDE Sound Server will be compiled in.

-----------------------------------------------------------------------------
OPTIONAL STUFF:
-----------------------------------------------------------------------------

  Also see separate README files.

HVSC & STIL

  When listening to sidtunes, it is recommended that you get the
  most accurate and most complete sid music collection currently
  available, the High Voltage SID Collection (HVSC). See the FAQ
  files hv_sids.faq and STIL.faq which are included within this
  package.

  If you keep your custom collection of favourite sids in a
  directory structure which equals the HVSC, you can continue to use
  HVSC-specific support files like the STIL database and the Bugged
  Tunes List. Just make sure you place a copy of the DOCUMENTS
  directory from the HVSC in the root of your private collection.

SONGLENGTH DATABASE

  Each time you add a sidtune to a playlist, a prebuilt songlengths
  database can be queried to provide a default playtime for the
  current or default subtune respectively.

  Songlengths database in released inside the HVSC document 
  directory

  All times in the database have been created with an emulator
  system running at PAL clock speed and using the song speed
  specified in the sidtune file itself. If you have your SID player
  set to override the default song speed of sidtunes (e.g. NTSC
  clock speed + force song speed), any sids that are affected will
  not match the given playtime by 20% (for VBI speed) or 3.8% (CIA
  timer speed). Future SID players will be able to preset the
  correct clock speed setting, too.

  A newer implementation of the experimental songlength database
  uses MD5 fingerprints to lookup the playtimes for sidtunes. This
  separates sidtune files from the fixed structure of the HVSC. You
  no longer need to store your favourite sids in a HVSC-like
  directory tree, and you don't need to keep the file names either.

  In other words, you can install the songlength database file in
  either
  
    $HOME/.sidplay/Songlengths.txt
    
  or
  
    $HVSC_ROOT/DOCUMENTS/Songlengths.txt

  and use it together with files previously fetched from the HVSC
  but now stored at arbitrary locations on your filesystem.

  If you add sids files to a playlist and have the songlength
  database enabled, the sidtune and its playtime will be identified
  by an MD5 fingerprint of relevant parts of the sidtune.

  If your particular sidtune file doesn't match any fingerprint in
  the database, you are left with playlist defaults and need to
  determine the playtime of the song yourself (for now).

  If you fetch your sids from the HVSC usually, it is recommended
  that you update your private collection of sidtunes with possibly
  newer versions from the HVSC. Also check out for possibly newer
  and improved releases of prebuilt songlength database files.

SIDID

  Cadaver's SidId player detector is integrated into the program.
  You need only to select the sidid.cfg file at runtime to enable it.
  Always check: http://cadaver.homeftp.net/tools/sidid.zip
  for updated signature to use.

-----------------------------------------------------------------------------
USAGE:
-----------------------------------------------------------------------------

PLAYLIST & HOTLIST

  The playlist implementation can read format 1 and 2 playlists from
  SIDPLAY/Windows and writes playlists in format 2.

  Stopping the current song disables the playlist, so if you start
  it via the player control buttons, it is not affected by the
  playlist's playtime which might be too short. You can enable the
  playlist again via the checkbox or the playlist dialog.

  The hotlist is meant to provide the cheap capability to "bookmark"
  sidtunes while listening to sids from directories or playlists,
  respectively. The contents of the hotlist can be added to a
  playlist anytime either by saving the hotlist as a playlist file,
  or by moving the hotlist contents into the current playlist. The
  latter operation will clear the hotlist after it has been added to
  the current playlist.

PLAYLIST UPDATE

  This function is useful if you want to keep playlists in sync with
  a sidtune collection like the HVSC which moves and updates files in
  the collection.

HISTORY

  The purpose of the history logfile is just to provide the user
  with a way to go through the last X sids that have been played.
  Often, after having listened to a new sidtune collection update,
  it can happen one or more days later that one remembers the melody
  of a good sidtune, but -- without having saved it in a playlist or
  separate directory -- is unable to find it among the 14000+ sids
  in the complete collection or the several hundred sids in an
  update.

  Because sids can appear in the history as often as they have been
  played, the history is not a playlist, but a simple text file
  which keeps the title and filename of a sidtune. Upon application
  exit it is saved automatically in: $HOME/.sidplay/xsidplay-history.txt

CONFIGURATION
  
  Most configuration settings can be changed via the graphical user
  interface. Upon application exit all settings get saved to:
  $HOME/.sidplay/xsidplay.ini

  You can use this applications as a command line player as well or
  start it from the SIDPlug wrapper plug-in (ln -sf xsidplay
  sidplug).

  Syntax:
    
    xsidplay [-|<sidtuneFile>] [<options>]

  Options:

    -bufsize<number>    the sample buffer size in bytes (0 = use default)
    -o<number>          the starting song number (default: preset)
    --nosnd             start with "No Sound" driver

  If really necessary you can tune the Open Sound System (OSS) audio
  driver of the Linux Kernel with additional command line arguments.
  These get saved upon application exit, too. Be sure to check the
  kernel driver defaults at least once.

	-maxfrags<number>   maximum number of fragments (0 = use default)
	-fragsize<number>   size of each fragment in bytes (0 = use default)

  The waveform viewer (Oscilloscope) has been disabled by default
  until fully-working synchronization of video and audio output can
  be assured. Hence the code is not completely implemented. With
  command line argument "--expert" you can try the very basic
  viewer. Note, however, that you likely need to adjust the OSS
  driver settings to get rid of delays in the audio output. Those
  special "--expert" settings will not be saved.

  Depending on the version of Qt you have used to compile XSIDPLAY,
  the following interesting command line options are available. For
  more options consult the Qt documentation:

    -style=<style>, sets the application GUI style. Possible values for
     <style> are "motif" and "windows". 
    -display display, sets the X display (default is $DISPLAY). 
    -fn or -font font, defines the application font. 
    -bg or -background color, sets the default background color and an
     application palette (light and dark shades are calculated). 
    -fg or -foreground color, sets the default foreground color. 
    -visual TrueColor, forces the application to use a TrueColor visual
     on an 8-bit display.