.\" -*- 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.INI 5"
.TH SIDPLAYFP.INI 5 2024-04-07 "perl v5.38.2" "File formats"
.\" 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.ini \- Configuration file for sidplayfp(1).
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This page describes the options available for the configuration file of
Sidplayfp.  It is composed by a number of sections, each one composed
by a section  name, enclosed by square brackets, followed by a list of
<parameter>=<value> lines.
.PP
\&\fBsidplayfp.ini\fR supports the following sections:
.PP
\&\fB[SIDPlayfp]\fR \- Generic configuration
.PP
\&\fB[Console]\fR \- Console appearance configuration
.PP
\&\fB[Audio]\fR \- Audio output configuration
.PP
\&\fB[Emulation]\fR \- Emulation engine parameters
.PP
All options and values are described in detail below.
.PP
For any of the following parameter, if it's specified more than one
time the last entry encountered will be used.
.PP
\&\fBNOTE\fR: if any of these options is specified outside its section, it will
be \fIignored\fR.
.SS SIDPlayfp
.IX Subsection "SIDPlayfp"
.IP \fBVersion\fR=\fI<number>\fR 4
.IX Item "Version=<number>"
Configuration version
.IP "\fBSonglength Database\fR=\fI<path>\fR" 4
.IX Item "Songlength Database=<path>"
Full path for the Songlength DB.
By default the program will look for a file named \fIDOCUMENTS/Songlengths.txt\fR under the HVSC collection path, if the HVSC_BASE environment variable is defined.
On *NIX systems, if this value is not set, \fBsidplayfp\fR\|(1) will try \fR\f(CI$PREFIX\fR\fI/share/sidplayfp/Songlengths.txt\fR.
.IP "\fBDefault Play Length\fR=\fIMM:SS.mmm\fR" 4
.IX Item "Default Play Length=MM:SS.mmm"
Default play time if Songlength Database is not found.
.IP "\fBDefault Record Length\fR=\fIMM:SS.mmm\fR" 4
.IX Item "Default Record Length=MM:SS.mmm"
Default recording time when writing wave files if Songlength Database is not found.
.IP "\fBKernal Rom\fR=\fI<path>\fR" 4
.IX Item "Kernal Rom=<path>"
Full path for the Kernal Rom file. This is the most important rom and should always be provided, although many tunes will still work without.
By default the program will look for a file named \fIkernal\fR under the following locations:
.RS 4
.IP \(bu 4
\&\f(CW$XDG_DATA_HOME\fR/sidplayfp/
.Sp
on *NIX systems where XDG_DATA_HOME is defined.
.IP \(bu 4
\&\f(CW$HOME\fR/.local/share/sidplayfp/
.Sp
on *NIX systems where XDG_DATA_HOME is not defined.
.IP \(bu 4
\&\f(CW$PREFIX\fR/share/sidplayfp
.Sp
on *NIX systems when not found in the above directories.
.IP \(bu 4
\&\f(CW%CSIDL_APPDATA\fR%\e\esidplayfp\e\e
.Sp
on Windows systems where CSIDL_APPDATA is defined.
.IP \(bu 4
\&\f(CW%USERPROFILE\fR%\e\eApplication Data\e\esidplayfp\e\e
.Sp
on Windows systems where CSIDL_APPDATA is not defined.
.RE
.RS 4
.RE
.IP "\fBBasic Rom\fR=\fI<path>\fR" 4
.IX Item "Basic Rom=<path>"
Full path for the Basic Rom file. This is mostly useful for playing BASIC tunes.
By default the program will look for a file named \fIbasic\fR under the same locations as above.
.IP "\fBChargen Rom\fR=\fI<path>\fR" 4
.IX Item "Chargen Rom=<path>"
Full path for the Character generator Rom file. Almost useless for playback of tunes, but included for completeness.
By default the program will look for a file named \fIchargen\fR under the same locations as above.
.IP \fBVerboseLevel\fR=\fI<number>\fR 4
.IX Item "VerboseLevel=<number>"
Verbosity level, 0 = low, 1 = normal, >1 = high.
Default is 0
.SS Console
.IX Subsection "Console"
.IP \fBAnsi\fR=\fItrue|false\fR 4
.IX Item "Ansi=true|false"
Use ANSI escape sequences to provide colored output.
.IP "\fBChar Top Left\fR=\fI<char>\fR" 4
.IX Item "Char Top Left=<char>"
Character for the top left corner.
.IP "\fBChar Top Right\fR=\fI<char>\fR" 4
.IX Item "Char Top Right=<char>"
Character for the top right corner.
.IP "\fBChar Bottom Left\fR=\fI<char>\fR" 4
.IX Item "Char Bottom Left=<char>"
Character for the bottom left corner.
.IP "\fBChar Bottom Right\fR=\fI<char>\fR" 4
.IX Item "Char Bottom Right=<char>"
Character for the bottom right corner.
.IP "\fBChar Vertical\fR=\fI<char>\fR" 4
.IX Item "Char Vertical=<char>"
Character for vertical lines.
.IP "\fBChar Horizontal\fR=\fI<char>\fR" 4
.IX Item "Char Horizontal=<char>"
Character for horizontal lines.
.IP "\fBChar Junction Left\fR=\fI<char>\fR" 4
.IX Item "Char Junction Left=<char>"
Character for left junctions.
.IP "\fBChar Junction Right\fR=\fI<char>\fR" 4
.IX Item "Char Junction Right=<char>"
Character for right junctions.
.SS Audio
.IX Subsection "Audio"
.IP \fBFrequency\fR=\fI<number>\fR 4
.IX Item "Frequency=<number>"
Playback frequency expressed in Hertz. Default is 48000.
.IP \fBChannels\fR=\fI<number>\fR 4
.IX Item "Channels=<number>"
Number of channels, 1 for mono and 2 for stereo playback.
Default is 1 for standard tunes and 2 for multi SID tunes.
.IP \fBBitsPerSample\fR=\fI<16|32>\fR 4
.IX Item "BitsPerSample=<16|32>"
Number of bits ber sample, used only for wav output. Using
values other than the ones specified will produce invalid
output.
.SS Emulation
.IX Subsection "Emulation"
.IP \fBEngine\fR=\fI<RESIDFP|RESID|HARDSID|EXSID|NONE>\fR 4
.IX Item "Engine=<RESIDFP|RESID|HARDSID|EXSID|NONE>"
Set the SID emulation engine. Default is RESIDFP.
.IP \fBC64Model\fR=\fI<PAL|NTSC|OLD_NTSC|DREAN>\fR 4
.IX Item "C64Model=<PAL|NTSC|OLD_NTSC|DREAN>"
Default c64 model to use if not specified by tune, PAL for
european PAL-B model, NTSC for american/japanese NTSC-M models,
OLD_NTSC for NTSC-M models with old video chip and DREAN
for argentinian PAL-N model. Default is PAL.
.IP \fBForceC64Model\fR=\fItrue|false\fR 4
.IX Item "ForceC64Model=true|false"
Force the configured c64 model even if the tune specifies one.
.IP \fBCiaModel\fR=\fI<MOS6526|MOS8521>\fR 4
.IX Item "CiaModel=<MOS6526|MOS8521>"
Select CIA chip model, old MOS 6526 or newer MOS 8521.
.IP \fBSidModel\fR=\fI<MOS6581|MOS8580>\fR 4
.IX Item "SidModel=<MOS6581|MOS8580>"
Default SID chip model, old MOS 6581 or newer MOS 8580.
.IP \fBForceSidModel\fR=\fItrue|false\fR 4
.IX Item "ForceSidModel=true|false"
Force the configured SID chip model even if the tune specifies one.
.IP \fBDigiBoost\fR=\fItrue|false\fR 4
.IX Item "DigiBoost=true|false"
Enable digiboost for 8580 model.
.IP \fBUseFilter\fR=\fItrue|false\fR 4
.IX Item "UseFilter=true|false"
Enable/disable the emulation of the SID filter.
.IP \fBFilterBias\fR=\fI<number>\fR 4
.IX Item "FilterBias=<number>"
Controls the filter bias in the ReSID emulation.
Ranges from 0.0 (dark) to 1.0 (light), the default
value is 0.5.
.IP \fBFilterCurve6581\fR=\fI<number>\fR 4
.IX Item "FilterCurve6581=<number>"
Controls the filter curve for the 6581 model in the ReSIDfp
emulation.  Ranges from 0.0 (light) to 1.0 (dark), the default
value is 0.5.
.IP \fBFilterRange6581\fR=\fI<number>\fR 4
.IX Item "FilterRange6581=<number>"
Controls the filter uCox parameter for the 6581 model in the ReSIDfp
emulation.  Ranges from 0.0 (dark) to 1.0 (bright), the default
value is 0.5.
.IP \fBFilterCurve8580\fR=\fI<number>\fR 4
.IX Item "FilterCurve8580=<number>"
Controls the filter curve for the 8580 model in the ReSIDfp
emulation.  Ranges from 0.0 (light) to 1.0 (dark), the default
value is 0.5.
.IP \fBCombinedWaveforms\fR=\fI<AVERAGE|WEAK|STRONG>\fR 4
.IX Item "CombinedWaveforms=<AVERAGE|WEAK|STRONG>"
Controls the combined waveforms strength in the ReSIDfp
emulation.  The default value is AVERAGE.
.IP \fBPowerOnDelay\fR=\fI<number>\fR 4
.IX Item "PowerOnDelay=<number>"
The c64 power on delay as number of cpu cycles.
If greater than 8191 the delay will be random.
.IP \fBSampling\fR=\fI<INTERPOLATE|RESAMPLE>\fR 4
.IX Item "Sampling=<INTERPOLATE|RESAMPLE>"
Set resampling mode.  'Interpolation (less expensive) or
resampling (accurate).
.IP \fBFastSampling\fR=\fI<true|false>\fR 4
.IX Item "FastSampling=<true|false>"
Fast resampling, available only for reSID emulation.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBsidplayfp\fR\|(1)
.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: <https://github.com/libsidplayfp/>" 4
.IX Item "Home page: <https://github.com/libsidplayfp/>"
.PD 0
.IP "Sidplay2 homepage: <http://sidplay2.sourceforge.net/>" 4
.IX Item "Sidplay2 homepage: <http://sidplay2.sourceforge.net/>"
.IP "High Voltage Sid Collection (HVSC): <http://hvsc.c64.org/>" 4
.IX Item "High Voltage Sid Collection (HVSC): <http://hvsc.c64.org/>"
.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.