1SIDPLAYFP(1)                     User Programs                    SIDPLAYFP(1)
2
3
4

NAME

6       sidplayfp - a C64 and SID chip emulator for playing Commodore 64 music.
7

SYNOPSIS

9       sidplayfp [OPTIONS] datafile
10

DESCRIPTION

12       Sidplayfp is a music player that emulates various components from a
13       Commodore 64 (C64) computer.  The result is a program which can load
14       and execute C64 machine code programs which produce music and sound.
15       Sidplayfp has been designed for accuracy which results in a quite high
16       cpu usage.  Additional playback modes have however been provided to
17       allow playback on low specification machines at the cost of accuracy.
18

OPTIONS

20       -h, --help
21           Display help.
22
23       -h, --help-debug
24           Display additional options helpful for debugging.
25
26       -f<num>
27           Set audio output frequency in Hz (default: 44100).
28
29       -nf No filter emulation.  This will reduce CPU overhead at the cost of
30           reduced emulation quality.
31
32       -o<num>
33           Select track number (default: preset).
34
35       -s  Stereo playback.  If the tune is identified as stereo then sid 1
36           and 2 become the left and right channels respectively.  For three
37           sid tunes the chips are mixed as left, center and right.
38
39       -m  Mono playback.
40
41       -v|q[level]
42           Verbose or quiet (no time display) console output while playing.
43           Can include an optional level, defaults to 1.
44
45       -b<num>
46           Set start time in [mins:]secs[.milli] format (compatible with
47           sid2wav).
48
49       -ds<addr>
50           Force dual sid environment by adding a second chip at specified
51           address.  This forces emulation of 2 sid-chips for stereo playback
52           even if datafile is identified as only being mono.  This occurs in
53           the case of the stereo prg format as currently there is no way to
54           identify them.  Stereo MUS and SID files are however automatically
55           detected.  The second sid may be installed in the 0xD420-0xD7FF or
56           0xDE00-0xDFFF address range.  Address may  be specified in
57           exadecimal (e.g -ds0xd420) or decimal (e.g.  -ds54304) format.
58
59       -ts<addr>
60           Add a third chip at specified address.  The sid may be installed in
61           the 0xD420-0xD7FF or 0xDE00-0xDFFF address range.  Address may  be
62           specified in exadecimal (e.g -ts0xd440) or decimal (e.g.  -ts54336)
63           format.
64
65       -u<num>
66           Mute a channel.  May be used more than one time.  Channel 1 to 3
67           are for the first SID chip while channels from 4 to 6 are for the
68           second one and 7 to 9 for the third.
69
70       -p<num>
71           Set bit precision for file saving. The default is 16 to create 16
72           bit signed samples, but can be set to 32 (32 bit float). Other
73           values will cause invalid output.
74
75       -o<l|s>
76           Option 'l' will select continuous track looping while 's' will
77           select the current track instead of all.  This option can be
78           combined with the track selection to form -ols<num>.
79
80       -t<num>
81           Set play length in [mins:]secs[.milli] format (0 is endless).
82
83       -v<n|p>[f]
84           Set VIC clock speed.  'n' is NTSC (America, 60Hz) and 'p' is PAL
85           (Europe, 50Hz).  Providing an 'f' will prevent speed fixing that
86           tries to compensate automatically for the speed difference.
87           Removing speed fixing simulates what happens on a real C64.
88           Options can be written as: -vnf or -vn -vf.
89
90       -m<o|n>[f]
91           Set SID chip model.  'o' is the old 6581 and 'n' is the new 8580.
92           Providing an 'f' will force the selected model overriding the one
93           specified by the tune.
94
95       --digiboost
96           Enable digiboost hack for 8580 model so the digi samples become
97           audible.
98
99       -r<i|r>[f]
100           Set resampling mode.  'i' is interpolation (less expensive) and 'r'
101           resampling (accurate).  Providing an 'f' will provide faster
102           resampling sacrificing quality.  Fast resampling is available only
103           for reSID emulation.  Options can be written as: -rif or -ri -rf.
104
105       -w, --wav[name]
106           Create WAV-file.  The default output filename is <datafile>[n].wav
107           where [n] is the tune number should there be more than one in the
108           sid.  This allows batch conversion of sid tunes without them
109           overwriting each other.  By providing a name it is possible to
110           override this default behavior.  The output file will be <name>
111           with no tune number added and <name> IS NOT checked for or appended
112           with a legal wav file extension.
113
114       --au[name]
115           Create AU-file.  The default output filename is <datafile>[n].au.
116
117       --resid
118           Use VICE's original reSID emulation engine.
119
120       --residfp
121           Use reSIDfp emulation engine.
122
123       --hardsid
124           Use HardSID device.
125
126       --exsid
127           Use exSID device.
128
129       --cpu-debug
130           Display cpu register and assembly dumps, available only for debug
131           builds.
132
133       --delay=[num]
134           Simulate c64 power on delay as number of cpu cycles.  If greater
135           than 8191 the delay will be random.  This is the default.
136
137       --noaudio
138           Run without an audio output device.
139
140       --nosid
141           Run without sid emulation.
142
143       --none
144           Run with no audio output device and no sid emulation.
145

Key bindings

147       1-9 Mute/unmute voice.
148
149       f   Toggle filter.
150
151       p   Pause/unpause playback.
152
153       Esc Quit player.
154
155       Up/Down Arrows
156           Increase/reset playback speed.
157
158       Left/Right Arrows
159           Move to previous/next subtune.
160
161       Home/End Arrows
162           Go to first/last subtune.
163

ENVIRONMENT VARIABLES

165       HVSC_BASE
166           The path to the HVSC base directory. If specified the songlength DB
167           will be loaded from here and relative SID tune paths are accepted.
168

FILES

170       sidplayfp.ini
171           The configuration file. See sidplayfp.ini(5) for further details.
172
173       kernal
174           The c64 kernal rom dump file.
175
176       basic
177           The c64 basic rom dump file.
178
179       chargen
180           The c64 character generator rom dump file.
181

BUGS

183       The upstream bug tracker can be found at
184       <https://github.com/libsidplayfp/sidplayfp/issues/>.
185

SEE ALSO

187       sidplayfp.ini(5)
188

NOTES

190       ROM dumps are not embedded due to copyright issues and must be supplied
191       by the user.  Check the sidplayfp.ini(5) documentation for
192       configuration details and default search paths.
193

AUTHORS

195       Leandro Nini
196           Current maintainer.
197
198       Simon White
199           Wrote the original Sidplay2.
200
201       Dag Lem
202           Wrote the reSID emulation engine.
203
204       Antti S. Lankila
205           Wrote the reSIDfp emulation engine as a fork of reSID 0.16.
206
207       The Vice team
208           Large part of the emulation is based on the VICE's code.
209
210       Andre Fachat
211           Wrote the original reloc65 utility.
212
213       Michael Schwendt
214           Wrote the original SidTune library and MD5 class (based on work by
215           L. Peter Deutsch).
216
217       Mikko Kilponen
218           Wrote the original man page.
219

RESOURCES

221       Home page: <https://github.com/libsidplayfp/>
222       Sidplay2 homepage: <http://sidplay2.sourceforge.net/>
223       High Voltage Sid Collection (HVSC): <http://hvsc.c64.org/>
224

COPYING

226       Copyright (C) 2000-2004 Simon White
227       Copyright (C) 2007-2010 Antti Lankila
228       Copyright (C) 2009-2015 VICE Project
229       Copyright (C) 2010-2021 Leandro Nini
230
231       This program is free software; you can redistribute it and/or modify it
232       under the terms of the GNU General Public License as published by the
233       Free Software Foundation; either version 2 of the License, or (at your
234       option) any later version.
235
236       This program is distributed in the hope that it will be useful, but
237       WITHOUT ANY WARRANTY; without even the implied warranty of
238       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
239       General Public License for more details.
240
241       You should have received a copy of the GNU General Public License along
242       with this program; if not, write to the Free Software Foundation, Inc.,
243       51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
244
245
246
247perl v5.30.0                      2021-09-16                      SIDPLAYFP(1)
Impressum