.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "SIDPLAYFP 1" .TH SIDPLAYFP 1 2024-04-07 "perl v5.38.2" "User Programs" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME sidplayfp \- a C64 and SID chip emulator for playing Commodore 64 music. .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBsidplayfp\fR [\fIOPTIONS\fR] \fIdatafile\fR .SH DESCRIPTION .IX Header "DESCRIPTION" \&\fBSidplayfp\fR is a music player that emulates various components from a Commodore 64 (C64) computer. The result is a program which can load and execute C64 machine code programs which produce music and sound. Sidplayfp has been designed for accuracy which results in a quite high cpu usage. Additional playback modes have however been provided to allow playback on low specification machines at the cost of accuracy. .SH OPTIONS .IX Header "OPTIONS" .IP "\fB\-h, \-\-help\fR" 4 .IX Item "-h, --help" Display help. .IP "\fB\-h, \-\-help\-debug\fR" 4 .IX Item "-h, --help-debug" Display additional options helpful for debugging. .IP \fB\-f\fR\fI\fR 4 .IX Item "-f" Set audio output frequency in Hz (default: 48000). .IP \fB\-nf\fR 4 .IX Item "-nf" No filter emulation. This will reduce CPU overhead at the cost of reduced emulation quality. .IP \fB\-o\fR\fI\fR 4 .IX Item "-o" Select track number (default: preset). .IP \fB\-s\fR 4 .IX Item "-s" Stereo playback. If the tune is identified as stereo then sid 1 and 2 become the left and right channels respectively. For three sid tunes the chips are mixed as left, center and right. .IP \fB\-m\fR 4 .IX Item "-m" Mono playback. .IP \fB\-v|q\fR[level] 4 .IX Item "-v|q[level]" Verbose or quiet (no time display) console output while playing. Can include an optional level, defaults to 1. .IP \fB\-b\fR\fI\fR 4 .IX Item "-b" Set start time in [mins:]secs[.milli] format (compatible with sid2wav). .IP \fB\-ds\fR\fI\fR 4 .IX Item "-ds" Force dual sid environment by adding a second chip at specified address. This forces emulation of 2 sid-chips for stereo playback even if datafile is identified as only being mono. This occurs in the case of the stereo prg format as currently there is no way to identify them. Stereo MUS and SID files are however automatically detected. The second sid may be installed in the 0xD420\-0xD7FF or 0xDE00\-0xDFFF address range. Address may be specified in exadecimal (e.g \-ds0xd420) or decimal (e.g. \&\-ds54304) format. .IP \fB\-ts\fR\fI\fR 4 .IX Item "-ts" Add a third chip at specified address. The sid may be installed in the 0xD420\-0xD7FF or 0xDE00\-0xDFFF address range. Address may be specified in exadecimal (e.g \-ts0xd440) or decimal (e.g. \&\-ts54336) format. .IP \fB\-u\fR\fI\fR 4 .IX Item "-u" Mute a channel. May be used more than one time. Channel 1 to 3 are for the first SID chip while channels from 4 to 6 are for the second one and 7 to 9 for the third. .IP \fB\-p\fR\fI\fR 4 .IX Item "-p" Set bit precision for file saving. The default is 16 to create 16 bit signed samples, but can be set to 32 (32 bit float). Other values will cause invalid output. .IP \fB\-o\fR\fI\fR 4 .IX Item "-o" Option 'l' will select continuous track looping while 's' will select the current track instead of all. This option can be combined with the track selection to form \-ols. .IP \fB\-t\fR\fI\fR 4 .IX Item "-t" Set play length in [mins:]secs[.milli] format (0 is endless). .IP \fB\-v\fR\fI[f]\fR 4 .IX Item "-v[f]" Set VIC clock speed. 'n' is NTSC (America, 60Hz) and 'p' is PAL (Europe, 50Hz). Providing an 'f' will prevent speed fixing that tries to compensate automatically for the speed difference. Removing speed fixing simulates what happens on a real C64. Options can be written as: \-vnf or \-vn \-vf. .IP \fB\-m\fR\fI[f]\fR 4 .IX Item "-m[f]" Set SID chip model. 'o' is the old 6581 and 'n' is the new 8580. Providing an 'f' will force the selected model overriding the one specified by the tune. .IP \fB\-\-digiboost\fR 4 .IX Item "--digiboost" Enable digiboost hack for 8580 model so the digi samples become audible. .IP \fB\-r\fR\fI[f]\fR 4 .IX Item "-r[f]" Set resampling mode. 'i' is interpolation (less expensive) and \&'r' resampling (accurate). Providing an 'f' will provide faster resampling sacrificing quality. Fast resampling is available only for reSID emulation. Options can be written as: \-rif or \&\-ri \-rf. .IP "\fB\-w, \-\-wav\fR\fI[name]\fR" 4 .IX Item "-w, --wav[name]" Create WAV-file. The default output filename is [n].wav where [n] is the tune number should there be more than one in the sid. This allows batch conversion of sid tunes without them overwriting each other. By providing a name it is possible to override this default behavior. The output file will be with no tune number added and the extension \&.wav appended if no extension is given. .IP \fB\-\-au\fR\fI[name]\fR 4 .IX Item "--au[name]" Create AU-file. The default output filename is [n].au. Same notes as the wav file applies. .IP \fB\-\-resid\fR 4 .IX Item "--resid" Use VICE's original reSID emulation engine. .IP \fB\-\-residfp\fR 4 .IX Item "--residfp" Use reSIDfp emulation engine. .IP \fB\-\-hardsid\fR 4 .IX Item "--hardsid" Use HardSID device. .IP \fB\-\-exsid\fR 4 .IX Item "--exsid" Use exSID device. .IP \fB\-\-cpu\-debug\fR 4 .IX Item "--cpu-debug" Display cpu register and assembly dumps, available only for debug builds. .IP \fB\-\-delay=\fR\fI[num]\fR 4 .IX Item "--delay=[num]" Simulate c64 power on delay as number of cpu cycles. If greater than 8191 the delay will be random. This is the default. .IP \fB\-\-fcurve=\fR\fI|auto\fR 4 .IX Item "--fcurve=|auto" Controls the filter curve in the ReSIDfp mulation. Ranges from 0.0 (light) to 1.0 (dark), the default value is 0.5. If set to auto it will choose a predefined value for 6581 depending on the tune author. .IP \fB\-\-noaudio\fR 4 .IX Item "--noaudio" Run without an audio output device. .IP \fB\-\-nosid\fR 4 .IX Item "--nosid" Run without sid emulation. .IP \fB\-\-none\fR 4 .IX Item "--none" Run with no audio output device and no sid emulation. .SH "Key bindings" .IX Header "Key bindings" .IP 1\-9 4 .IX Item "1-9" Mute/unmute voice. .IP f 4 .IX Item "f" Toggle filter. .IP p 4 .IX Item "p" Pause/unpause playback. .IP Esc 4 .IX Item "Esc" Quit player. .IP "Up/Down Arrows" 4 .IX Item "Up/Down Arrows" Increase/reset playback speed. .IP "Left/Right Arrows" 4 .IX Item "Left/Right Arrows" Move to previous/next subtune. .IP "Home/End Arrows" 4 .IX Item "Home/End Arrows" Go to first/last subtune. .SH "ENVIRONMENT VARIABLES" .IX Header "ENVIRONMENT VARIABLES" .IP \fBHVSC_BASE\fR 4 .IX Item "HVSC_BASE" The path to the HVSC base directory. If specified the songlength DB will be loaded from here and relative SID tune paths are accepted. .SH FILES .IX Header "FILES" .IP \fIsidplayfp.ini\fR 4 .IX Item "sidplayfp.ini" The configuration file. See \fBsidplayfp.ini\fR\|(5) for further details. .IP \fIkernal\fR 4 .IX Item "kernal" The c64 kernal rom dump file. .IP \fIbasic\fR 4 .IX Item "basic" The c64 basic rom dump file. .IP \fIchargen\fR 4 .IX Item "chargen" The c64 character generator rom dump file. .SH BUGS .IX Header "BUGS" The upstream bug tracker can be found at . .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBsidplayfp.ini\fR\|(5) .SH NOTES .IX Header "NOTES" ROM dumps are not embedded due to copyright issues and must be supplied by the user. Check the \fBsidplayfp.ini\fR\|(5) documentation for configuration details and default search paths. .SH AUTHORS .IX Header "AUTHORS" .IP "Leandro Nini" 4 .IX Item "Leandro Nini" Current maintainer. .IP "Simon White" 4 .IX Item "Simon White" Wrote the original Sidplay2. .IP "Dag Lem" 4 .IX Item "Dag Lem" Wrote the reSID emulation engine. .IP "Antti S. Lankila" 4 .IX Item "Antti S. Lankila" Wrote the reSIDfp emulation engine as a fork of reSID 0.16. .IP "The Vice team" 4 .IX Item "The Vice team" Large part of the emulation is based on the VICE's code. .IP "André Fachat" 4 .IX Item "André Fachat" Wrote the original reloc65 utility. .IP "Michael Schwendt" 4 .IX Item "Michael Schwendt" Wrote the original SidTune library and MD5 class (based on work by L. Peter Deutsch). .IP "Mikko Kilponen" 4 .IX Item "Mikko Kilponen" Wrote the original man page. .SH RESOURCES .IX Header "RESOURCES" .IP "Home page: " 4 .IX Item "Home page: " .PD 0 .IP "Sidplay2 homepage: " 4 .IX Item "Sidplay2 homepage: " .IP "High Voltage Sid Collection (HVSC): " 4 .IX Item "High Voltage Sid Collection (HVSC): " .PD .SH COPYING .IX Header "COPYING" .IP "Copyright (C) 2000\-2004 Simon White" 4 .IX Item "Copyright (C) 2000-2004 Simon White" .PD 0 .IP "Copyright (C) 2007\-2010 Antti Lankila" 4 .IX Item "Copyright (C) 2007-2010 Antti Lankila" .IP "Copyright (C) 2009\-2015 VICE Project" 4 .IX Item "Copyright (C) 2009-2015 VICE Project" .IP "Copyright (C) 2010\-2024 Leandro Nini" 4 .IX Item "Copyright (C) 2010-2024 Leandro Nini" .PD .PP This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. .PP This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. .PP You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301, USA.