<html lang="en">
<head>
<title>configuration - Open Cubic Player</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Open Cubic Player">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="player.html#player" title="player">
<link rel="next" href="support.html#support" title="support">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This documentiation falls under the GPL license.
Copyright (C) 2005 Stian Skjelstad.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="configuration"></a>
<p>
Next: <a rel="next" accesskey="n" href="support.html#support">support</a>,
Previous: <a rel="previous" accesskey="p" href="player.html#player">player</a>,
Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">5 Configuration</h2>
<h3 class="section">5.1 ocp.ini</h3>
<p>OCP can be widely configured using the <samp><span class="file">ocp.ini</span></samp> file, which should
reside in the home directory of the player itself. This file is
processed at every startup and informs the player about various
modules / plugins and their respective configuration. For average
users the default configuration should be sufficient. However if you
want to change certain aspects of the player permanently you have to
modify this file. You can use every ascii editor to edit the ini file.
<p>The <samp><span class="file">ocp.ini</span></samp> consists of many sections. Each section starts
with a section identifier tag in square brackets [ ]. Examples of
sections are <a href="configuration.html#configuration">[general]</a> or
<a href="configuration.html#configuration">[sound]</a>. The sections id tag should be followed by
a newline. After a section has been declared with the id tag the options
describing the sections follow. Each options takes a single line and
consists of a keyword followed by a “=” and the parameters. Example:
<pre class="example"> mixrate=44100
</pre>
<p>All options following a section id are options for that section. If a
new section starts with a id tag all forthcoming options are assigned
to the new section. All options for a section have to be grouped
together. Multiple declarations of sections are not valid.
<pre class="example"> [general]
link=dos4gfix
[defaultconfig]
link=mchasm
[general]
dos4gfix=off
</pre>
<p>the above example has to be written as:
<pre class="example"> [general]
link=dos4gfix
dos4gfix=off
[defaultconfig]
link=mchasm
</pre>
<pre class="smallformat">Note that in the above example the option <em>link</em> has not
been overridden by the <em>defaultconfig</em> section. Both sections now
can access an options named <em>link</em>, but both options are totally
independant of each other.
</pre>
<p>Comments can be placed anywhere in the configuration file and are
marked by a <em>;</em>. The rest of the line starting from the
<em>;</em> is considered as a comment and not processed.
<p>Normally the definition for an option ends with the end of the
line. If many parameters are needed to specify an option they may
exceed the default line width of 80 characters. Although this is no
problem for OCP it is not nice looking. You can extend a line
logically by using the unix like <em>backquote</em> at the end of a line
to begin a newline without interupting the current option definition.
<pre class="example"> [example]
option1=parameter1 parameter2
option2=parameter1 \
parameter2
</pre>
<p>Both options contain exactly the same parameters.
<p>When modifying the configuration you should always start with the
default configuration file and configure it to your needs. Building a
bug free config file from scratch is difficult. <a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a>
<p>We will now have a look at the individual sections and their options.
<h3 class="section">5.2 [general]</h3>
<p>The <em>general</em> section describes which internal modules or plugins
to load at startup. Most of them are required for normal operation of
OCP so you should not remove any of the contents. All options listed
in this section are loaded every time OCP starts! The default
<em>general</em> section looks like:
<pre class="example"> [general]
link=cpiface cphlpif fstypes
prelink=framelock pfilesel
</pre>
<p><table summary=""><tr align="left"><td valign="top" width="30%">link </td><td valign="top" width="70%">
this options describes the modules to load when starting OCP.
There is no need to change this option, unless you have coded a basic
internal module.
<br></td></tr><tr align="left"><td valign="top" width="30%">datapath </td><td valign="top" width="70%">
OCP searches for background pictures and animations in its
home directory. If you want to store your artwork at a different place
use this option to set the right directory.
<br></td></tr><tr align="left"><td valign="top" width="30%">tempdir </td><td valign="top" width="70%">
this directory is used for extracting modules from archives.
If you have set a DOS environment variable called either <em>TEMP</em>
or <em>TMP</em> these will be used.
<br></td></tr></table>
<h3 class="section">5.3 [defaultconfig]</h3>
<p>The <em>defaultconfig</em> section is very similar to the <em>general</em>
section. But unlike the <em>general</em> section which is always
processed the settings in the <em>defaultconfig</em> section can be
ommited with an alternative section and the <em>-c</em> flag from the
command line. If the <em>-c</em> flag is not present the
<em>defaultconfig</em> section will be processed.<a rel="footnote" href="#fn-2" name="fnd-2"><sup>2</sup></a>
<pre class="example"> [defaultconfig] ; default configuration
link=devi plrbase mcpbase smpbase arctar mixclip medialib cdrom
prelink=poutput hardware cphelper sets mchasm compat
</pre>
<p><table summary=""><tr align="left"><td valign="top" width="20%">link </td><td valign="top" width="80%">
just like in the <em>general</em> section this option defines which
modules should be loaded at startup. You can delete some entries if
you will not need them – however this is not recommended as they do
not use much memory and do not require any processor power.
<br></td></tr><tr align="left"><td valign="top" width="20%">prelink </td><td valign="top" width="80%">
these files will be loaded before starting the main module. If
something goes wrong here OCP will continue to work.
<br></td></tr></table>
<h3 class="section">5.4 [sound]</h3>
<p>This section is the most important one for using OCP. If you want to
change the configuration permanently you have to modify the entries of
this section.
<pre class="example"> [sound]
playerdevices=devpOSS devpNone devpDisk
samplerdevices=devsOSS devsNone
wavetabledevices=devwMixF devwmixQ devwMix devwNone
mixrate=44100
mixprocrate=4096000
mix16bit=on
mixstereo=on
plrbufsize=200
mixbufsize=200
samprate=44100
samp16bit=on
sampstereo=on
smpbufsize=2000
defplayer=
defsampler=
defwavetable=
midichan=64
itchan=64
cdsamplelinein=off
bigmodules=devwMixF
wavetostereo=1
waveratetolerance=50
amplify=100
panning=100
volume=100
balance=0
reverb=0
chorus=0
surround=off
filter=2
</pre>
<p><table summary=""><tr align="left"><td valign="top" width="30%">playerdevices </td><td valign="top" width="70%">
OCP uses three different devices to communicate with the
hardware. The <em>playerdevices</em> are used to play a stream of
samples. As all sound cards support this feature you will find
<em>playerdevices</em> for every sound card supported by OCP. This
device is needed for playing <samp><span class="file">.ogg</span></samp>, <samp><span class="file">.wav</span></samp> and
<samp><span class="file">.mp3</span></samp> files and if you want/have to use the software
(quality) mixer. OCP searches for all devices listed in this option
at startup and only those found are actually loaded. You can delete
all devices you have not installed to speed up to startup
procedure. If you have multiple sound cards installed be sure to list
all devices if you want to use more than one sound card.<a rel="footnote" href="#fn-3" name="fnd-3"><sup>3</sup></a> If more
than one device is listed the first in the list will be used as default.
<br></td></tr><tr align="left"><td valign="top" width="30%">samplerdevices </td><td valign="top" width="70%">
these devices are the least important ones. They are
only needed if you want to use OCP when playing cd audio tracks or
start the player in sample mode. The sample data is not calculated
from files, but sampled from either the cd, line or microphone jack of
the sound card. You can then use the graphical screens to view the
sounds.
<br></td></tr><tr align="left"><td valign="top" width="30%">wavetabledevices </td><td valign="top" width="70%">
for mixing several channels you have to use
<em>wavetabledevices</em>. Most sound cards are only able to play to channels
simultaneously normally assigned to the left and right channel or your
home stereo. The <em>mixer</em> devices are used to mix the sample data
of module files to those two channels. However modern sound cards have
special hardware to mix channels “onboard”. But all hardware mixers
have a maximum amount of channels to mix<a rel="footnote" href="#fn-4" name="fnd-4"><sup>4</sup></a>. Especially <samp><span class="file">.it</span></samp> files often use more than 32
channels so an errorfree playback can not be guaranteed when using
hardware mixing. You should include one of the software mixers for
this case.
<br></td></tr><tr align="left"><td valign="top" width="30%">mixrate </td><td valign="top" width="70%">
the default mixrate. Unless you have a very old sound
card<a rel="footnote" href="#fn-5" name="fnd-5"><sup>5</sup></a> or
a very old processor<a rel="footnote" href="#fn-6" name="fnd-6"><sup>6</sup></a> there is no need
to change this option.
<br></td></tr><tr align="left"><td valign="top" width="30%">mixprocrate </td><td valign="top" width="70%">
if you have a slow cpu<a rel="footnote" href="#fn-7" name="fnd-7"><sup>7</sup></a> you might
not be able to play 32 channels at full mixrate. This value defines
the maximum “calculation power” to which OCP tries to use the full
mixrate.
<br></td></tr><tr align="left"><td valign="top" width="30%">mix16bit </td><td valign="top" width="70%">
Leave this option enabled unless you have a 8bit sound card.
<br></td></tr><tr align="left"><td valign="top" width="30%">mixstereo </td><td valign="top" width="70%">
dito for stereo cards
<br></td></tr><tr align="left"><td valign="top" width="30%">plrbufsize </td><td valign="top" width="70%">
When using a <em>playerdevice</em> to play sample streams a DMA
buffer is used to minimize cpu resources for handling the sample
stream. This option sets the DMA buffer length in miliseconds.
<br></td></tr><tr align="left"><td valign="top" width="30%">mixbufsize </td><td valign="top" width="70%">
When running in a multitasking environment there is no
guarantee for constant cpu resources. To avoid a break in the sample
stream OCP will calculate in advance. This option sets the buffer lenth in
miliseconds.
<br></td></tr><tr align="left"><td valign="top" width="30%">samprate </td><td valign="top" width="70%">
When using a <em>samplerdevice</em> this value will be used.
<br></td></tr><tr align="left"><td valign="top" width="30%">samp16bit </td><td valign="top" width="70%">
dito
<br></td></tr><tr align="left"><td valign="top" width="30%">sampstereo </td><td valign="top" width="70%">
dito
<br></td></tr><tr align="left"><td valign="top" width="30%">smpbufsize </td><td valign="top" width="70%">
this options sets the length of the sample DMA buffer in
miliseconds.
<br></td></tr><tr align="left"><td valign="top" width="30%">defplayer </td><td valign="top" width="70%">
with this option you can override the default
<em>playerdevice</em>. Normally you don't need to set this option, as the
default device can also be set by the order in the <em>playerdevice</em>
option. This option can also be specified by using the <em>-sp</em>
options from command line.
<br></td></tr><tr align="left"><td valign="top" width="30%">defwavetable </td><td valign="top" width="70%">
this option sets the default <em>wavetabledevice</em>. Can
also be set with <em>-sw</em> command.
<br></td></tr><tr align="left"><td valign="top" width="30%">defsampler </td><td valign="top" width="70%">
the same as the <em>-ss</em> command line option.
<br></td></tr><tr align="left"><td valign="top" width="30%">midichan </td><td valign="top" width="70%">
unlike the module file types the MIDI file format does not
specify the exact amount of channles to use. Complex <samp><span class="file">.mid</span></samp>
files can easily try to play several dozens of channels
simultaniously. This option sets the maximum amount of channels to mix
when playing <samp><span class="file">.mid</span></samp> files. Note that this value has no effect
when a hardware mixing device is used, as the maximum number is
limited by the hardware.
<br></td></tr><tr align="left"><td valign="top" width="30%">itchan </td><td valign="top" width="70%">
the <samp><span class="file">.it</span></samp> format can play more than one sample per channel
simultaniously. A maximum number of channels to mix is required for
this file type too. When playing <samp><span class="file">.it</span></samp> files using a hardware
mixer the maximum number of channels is again limited to the hardware.
<br></td></tr><tr align="left"><td valign="top" width="30%">cdsamplelinein </td><td valign="top" width="70%">
If you select a <samp><span class="file">.cda</span></samp> file the cd input of your
sound card is used to sample the current music. If you do not have a
cd input or if you have connected your cd-rom to the line-in jack
enable this option to change to sample input.
<br></td></tr><tr align="left"><td valign="top" width="30%">bigmodules </td><td valign="top" width="70%">
This option is of interest for users of hardware mixing
devices only. Sound cards capable of mixing channels are not only
limited by the amount of channels played simultaniously, but by the
amount of onboard memory to store the sample data too. If files are
marked as “big” in the fileselector this device listed in this
option will be used for mixing this module.<a rel="footnote" href="#fn-8" name="fnd-8"><sup>8</sup></a>
<br></td></tr><tr align="left"><td valign="top" width="30%">wavetostereo </td><td valign="top" width="70%">
When playing a mono wave the sound card can either be
switched to mono mode or the wave can be played as a stereo
file.<a rel="footnote" href="#fn-9" name="fnd-9"><sup>9</sup></a>
<br></td></tr><tr align="left"><td valign="top" width="30%">waveratetolerance </td><td valign="top" width="70%">
if the sample rate of the wave file is not equal to
a sample rate supported by your sound card, OCP will not resample
unless this value is exceeded. Divide the value by 1000 to get the
percentage.
<br></td></tr><tr align="left"><td valign="top" width="30%">amplify </td><td valign="top" width="70%">
the default amplification to use within the player. The
following options are described in section see <a href="player.html#player">General</a> in
detail. The command line option <em>-va</em> overrides this option.
<br></td></tr><tr align="left"><td valign="top" width="30%">panning </td><td valign="top" width="70%">
the default panning (command <em>-vp</em>)
<br></td></tr><tr align="left"><td valign="top" width="30%">volume </td><td valign="top" width="70%">
the default volume (command <em>-vv</em>)
<br></td></tr><tr align="left"><td valign="top" width="30%">balance </td><td valign="top" width="70%">
the default balance (command <em>-vb</em>)
<br></td></tr><tr align="left"><td valign="top" width="30%">reverb </td><td valign="top" width="70%">
some sound cards have an onboard effect processor <a rel="footnote" href="#fn-10" name="fnd-10"><sup>10</sup></a> which features a reverb
effect. This option controls the intensity of the onboard
effect. (command <em>-vr</em>)
<br></td></tr><tr align="left"><td valign="top" width="30%">chorus </td><td valign="top" width="70%">
dito as reverb (command <em>-vc</em>)
<br></td></tr><tr align="left"><td valign="top" width="30%">surround </td><td valign="top" width="70%">
this options controls the fake surround effect <a rel="footnote" href="#fn-11" name="fnd-11"><sup>11</sup></a> (command <em>-vs</em>)
<br></td></tr><tr align="left"><td valign="top" width="30%">filter </td><td valign="top" width="70%">
The software mixer can use a software filter to enhance the
playback quality. Different algorithms can be used. (command
<em>-vf</em>)
<ul>
<li>0 - no filter
<li>1 AOI - only filter samples when filtering is necessary
<li>2 FOI - filter every sample even if filtering has no effect
</ul>
<br></td></tr></table>
<h3 class="section">5.5 [screen]</h3>
<p>When the player starts it will use the options in this section as the
initial appearance.
<pre class="example"> [screen]
usepics=*.gif *.tga
compomode=off
startupmode=text
screentype=7
analyser=on
mvoltype=1
pattern=on
insttype=0
channeltype=1
palette=0 1 2 3 4 5 6 7 8 9 a b c d e f
fps=20
</pre>
<p><table summary=""><tr align="left"><td valign="top" width="30%">usepics
</td><td valign="top" width="70%">
When using graphics modes you can use a picture to show in the
background. OCP will load any TGA files with 640x384 dimensions and
256 colors. As the TGA format is poorly implemented in modern graphic
programs this might change in the future. As some colors out of the
256 are used by OCP you should leave either the first or the last 16
colors in the palette black. The pictures should be copied to the
home directory of ocp, unless you specify a different location in the
<em>defaultconfig</em> section.
<br></td></tr><tr align="left"><td valign="top" width="30%">compomode </td><td valign="top" width="70%">
this option will enable the compo mode. Section
see <a href="player.html#player">Using the Compo mode</a> describes the details.
<br></td></tr><tr align="left"><td valign="top" width="30%">startupmode </td><td valign="top" width="70%">
start the player in either text or graphic mode:
<ul>
<li>coolhelp - show help screen
<li>dots - show note nots
<li>graph - show graphical spectrum analyzer
<li>links - show currenty linked DLLs/shared libraries
<li>msg - show module message
<li>phase - show phase analyzer
<li>scope - show oscilloscopes
<li>text - show standard text screen
<li>wuerfel2 - show animation
</ul>
<br></td></tr><tr align="left"><td valign="top" width="30%">screentype </td><td valign="top" width="70%">
the default screentextmode:
<ul>
<li>0 - 80x25
<li>1 - 80x30
<li>2 - 80x50
<li>3 - 80x60
<li>4 - 132x25
<li>5 - 132x30
<li>6 - 132x50
<li>7 - 132x60
</ul>
<br></td></tr><tr align="left"><td valign="top" width="30%">analyzer </td><td valign="top" width="70%">
if the player starts in textmode show the analyzer (or not)
<br></td></tr><tr align="left"><td valign="top" width="30%">mvoltype </td><td valign="top" width="70%">
the appearance of the peak power levels:
<ul>
<li>1 - big
<li>2 - small
</ul>
<br></td></tr><tr align="left"><td valign="top" width="30%">pattern </td><td valign="top" width="70%">
show the tracklist when starting OCP in textmode
<br></td></tr><tr align="left"><td valign="top" width="30%">insttype </td><td valign="top" width="70%">
the appearance of the instrument function:
<ul>
<li>0 - short
<li>1 - long
<li>2 - side (only in 132 column modes)
</ul>
<br></td></tr><tr align="left"><td valign="top" width="30%">channeltype </td><td valign="top" width="70%">
the appearance of the channels in textmode:
<ul>
<li>0 - short
<li>1 - long
<li>2 - side (only in 132 column mode)
</ul>
<br></td></tr><tr align="left"><td valign="top" width="30%">palette </td><td valign="top" width="70%">
with this options you can redefine the default colors used in
textmode. The first entry defines which color to use for the original
color with number 0. Leave things as they are if you are satisfied
with the visual appearance of OCP. We will provide new color schemes
in the future.
<br></td></tr><tr align="left"><td valign="top" width="30%">fps </td><td valign="top" width="70%">
This tells how many frames per second OCP should try to use, since UNIX
isn't a real-time system, this is needed.
<br></td></tr></table>
<h3 class="section">5.6 [fileselector]</h3>
<p>Except the first two options all options can also be specified at
runtime by pressing <ALT>+<z> in the fileselector. However
to make changes permanent you have to modify the <em>fileselector</em>
section.
<pre class="example"> [fileselector] ; default fileselector section
modextensions=MOD S3M XM IT MDL DMF ULT AMS MTM 669 NST WOW \
OKT PTM MXM MID WAV RMI MP1 MP2 MP3 OGG SID DAT \
PLS M3U PLT OGG
movepath= ; default path to move files
screentype=2
typecolors=on
editwin=on
writeinfo=on
scanmdz=on
scaninarcs=on
scanmnodinfo=on
scanarchives=on
putarchives=on
playonce=on
randomplay=on
loop=on
path=.
</pre>
<p><table summary=""><tr align="left"><td valign="top" width="30%">modextensions
</td><td valign="top" width="70%">
files containing these extensions will be scanned by the
fileselector. Only those files will be shown. If you want to load
files with different extensions you have to specify them at the
command line.<a rel="footnote" href="#fn-12" name="fnd-12"><sup>12</sup></a>
<br></td></tr><tr align="left"><td valign="top" width="30%">movepath </td><td valign="top" width="70%">
the standard path to move files into. This is describend in
section See <a href="fileselector.html#fileselector">Advanced usage</a>.
<br></td></tr><tr align="left"><td valign="top" width="30%">screentype </td><td valign="top" width="70%">
the textmode to use within the fileselector. The options are
the same as in the <em>screen</em> section.
<br></td></tr><tr align="left"><td valign="top" width="30%">typecolors </td><td valign="top" width="70%">
show files in different colors depending on the file type
<br></td></tr><tr align="left"><td valign="top" width="30%">editwin </td><td valign="top" width="70%">
show the edit window at the bottom of the screen
<br></td></tr><tr align="left"><td valign="top" width="30%">writeinfo </td><td valign="top" width="70%">
write the info to the information database located in the
home directory of OCP. This speeds up the processing of directories,
as files have to be scanned only once.
<br></td></tr><tr align="left"><td valign="top" width="30%">scanmdz </td><td valign="top" width="70%">
if <samp><span class="file">.mdz</span></samp> files are found in the current directory, they
will be scanned and the included information used.
<br></td></tr><tr align="left"><td valign="top" width="30%">scanmodinfo </td><td valign="top" width="70%">
scan inside the music files for module information.
<br></td></tr><tr align="left"><td valign="top" width="30%">scanarchives </td><td valign="top" width="70%">
if archives (like <samp><span class="file">.zip</span></samp> or <samp><span class="file">.rar</span></samp>) are
found in the current directory the are scanned for modules.
<br></td></tr><tr align="left"><td valign="top" width="30%">putarchives </td><td valign="top" width="70%">
show archives in the fileselector, so they can be used just
like subdirectories.
<br></td></tr><tr align="left"><td valign="top" width="30%">playonce </td><td valign="top" width="70%">
play every file only once (thus not looping it) and then
procede with the next file in the playlist. If the file contains a
loop command the loop command is ignored.
<br></td></tr><tr align="left"><td valign="top" width="30%">randomplay </td><td valign="top" width="70%">
play files in the playlist in random order.
<br></td></tr><tr align="left"><td valign="top" width="30%">loop </td><td valign="top" width="70%">
loop files after the end.
<br></td></tr><tr align="left"><td valign="top" width="30%">path </td><td valign="top" width="70%">
the default path to use when starting the fileselector the first
time. The default is the current directory (.). If you keep all your
music files in one directory you can specfiy this directory here.
<br></td></tr></table>
<h3 class="section">5.7 device configuration</h3>
<p>The following sections define the various devices for the
player. Unless you really know what to do you should not change the
following options. As most entries are similar only some educational
examples are listed here. For a complete reference have a look at your
personal <samp><span class="file">ocp.ini</span></samp> file for details.
<p>The general form of a device looks like:
<pre class="example"> [handle]
link=...
subtype=...
port=...
port2=...
irq=...
irq2=...
dma=...
dma2=...
bypass=...
keep=...
</pre>
<p><table summary=""><tr align="left"><td valign="top" width="30%">handle </td><td valign="top" width="70%">
The internal name to use within the player. The <samp><span class="file">ocp.ini</span></samp>
file must contain all <em>handles</em> listed in the devices options of
the <em>devices</em> section.
<br></td></tr><tr align="left"><td valign="top" width="30%">link </td><td valign="top" width="70%">
the name of the dll function this device will be linked to.
<br></td></tr><tr align="left"><td valign="top" width="30%">port(2) </td><td valign="top" width="70%">
the primary/secondary port of the sound card. This value has to
be given in hexadecimal with preceeding <em>0x</em> or appending <em>h</em>!
<br></td></tr><tr align="left"><td valign="top" width="30%">irq(2) </td><td valign="top" width="70%">
the primary/secondary IRQ of the sound card
<br></td></tr><tr align="left"><td valign="top" width="30%">dma(2) </td><td valign="top" width="70%">
the primary/secondary DMA channel of the card
<br></td></tr><tr align="left"><td valign="top" width="30%">bypass </td><td valign="top" width="70%">
skip the autodetection if it may encounter problems
<br></td></tr><tr align="left"><td valign="top" width="30%">keep <br></td></tr><tr align="left"><td valign="top" width="30%">keep the driver resident in memory, even it is not currently
needed.
</td><td valign="top" width="70%">
<br></td></tr></table>
<p>Most device functions of the standard dll contain autodetection
routines for the supported sound cards, so there is normally no need
to specify any of the port, irq or dma options. However if OCP is not
able to detect your sound cards settings you can try to insert the
appropriate values in the configuration file.
<p>The next subsections will look at the special features the different
sound cards and drivers support. The original order of the
<samp><span class="file">ocp.ini</span></samp> has been slightly modified for the purpose of
documentation.
<h4 class="subsection">5.7.1 OSS</h4>
<p>Open Sound Sysstem is a generic portable UNIX sound interface for
playing/recording pcm data, and adjusting mixer settings.
<pre class="example"> [devpOSS]
link=devposs
revstereo=on
path=/dev/dsp
mixer=/dev/mixer
[devsOSS]
link=devsoss
revstereo=on
path=/dev/dsp
mixer=/dev/mixer
igain=1
</pre>
<p><table summary=""><tr align="left"><td valign="top" width="30%">path </td><td valign="top" width="70%">
where /dev/dsp is located. If you have more soundcards, this can be set to for
instance /dev/dsp3. You can override config with the DSP environment variable.
<br></td></tr><tr align="left"><td valign="top" width="30%">mixer </td><td valign="top" width="70%">
what mixerdevice to use. Override with the MIXER environment variable.
<br></td></tr><tr align="left"><td valign="top" width="30%">igain </td><td valign="top" width="70%">
if you don't input from cdrom, try to set igain. With this option, you can
automatically set igain to a given value (or -1 for not touching it)
<br></td></tr></table>
<h4 class="subsection">5.7.2 software mixers</h4>
<p>By default OCP will use its own routines for mixing several channels
to the two stereo output channels. You have the choice between to
mixers. The normal mixer is faster in calculating, thus can mix more
channels at the same time. The quality mixer however produces better
sound ouput. For average modules and a pentium processor the quality
mixer should be fast enough for sufficient playback. If many channels
are used you may have to change back to the normal mixer <a rel="footnote" href="#fn-13" name="fnd-13"><sup>13</sup></a>
<p>Both mixers take identical options. As the mixers will be rewritten in
the future the options are likely to change. Therefore they are not
documented here. Please have a look at future versions of this
document if you want to change to mixer settings. However these
devices never have caused any trouble/bugs and there should be no need
for change.
<h3 class="section">5.8 archivers</h3>
<p>When processing files inside archives OCP has to know how to call the
programs. The following sections define the usage of different
archivers supported by the OCP fileselector.
<p>When substituting the command line 4 special variables are processed
by the fileselector for accessing the archives:
<p><table summary=""><tr align="left"><td valign="top" width="10%">%% </td><td valign="top" width="90%">evaluates to “%”
<br></td></tr><tr align="left"><td valign="top" width="10%">%a </td><td valign="top" width="90%">evaluates to the archiv name preceeded by the path to process.
<br></td></tr><tr align="left"><td valign="top" width="10%">%n </td><td valign="top" width="90%">evaluates to the filename of the file to process inside the archive.
<br></td></tr><tr align="left"><td valign="top" width="10%">%d </td><td valign="top" width="90%">evaluates to the destination directory used to extract files out
of archive.
<br></td></tr></table>
<p>Three default command are defined for the arc modules:
<p><table summary=""><tr align="left"><td valign="top" width="30%">get </td><td valign="top" width="70%">
this command is used when a file should be extracted out of an
archive.
<br></td></tr><tr align="left"><td valign="top" width="30%">put </td><td valign="top" width="70%">
if a file should be added to the archive this command line is used.
<br></td></tr><tr align="left"><td valign="top" width="30%">delete </td><td valign="top" width="70%">
with <ALT>+<k> you can delete files out of archives.
<br></td></tr></table>
<p>The following two archivers contain special options described below:
<pre class="example"> [arcZIP]
get=pkunzip %a %d %n
put=pkzip %a %n
delete=pkzip -d %a %n
deleteempty=on
</pre>
<p><table summary=""><tr align="left"><td valign="top" width="30%">deleteempty </td><td valign="top" width="70%">
the program pkzip/pkunzip used by OCP to process
<samp><span class="file">.zip</span></samp> files have a bug when deleting the last file inside an archive.
An empty archive of 22 bytes is left on the hard disk. With this
option enabled the fileselector will delete those “zip zombies”.
<br></td></tr></table>
<pre class="example"> [arcACE]
get=ace32 e %a %n %d
scaninsolid=false
</pre>
<p><table summary=""><tr align="left"><td valign="top" width="30%">scaninsolid </td><td valign="top" width="70%">
scan in solid archives. As this takes more time you can
disable this feature.
<br></td></tr></table>
<h3 class="section">5.9 Filetypes</h3>
<p>The <samp><span class="file">ocp.ini</span></samp> file contains descriptions for all supported file
types. These features will be included in the file loader devices in
the next version of OCP, so these options will soon be obsolete. There
should be no need to modify any of the file types.
<h3 class="section">5.10 MIDI</h3>
<p>If you want to hear MIDI music you need samples for the
general midi instrument set.<a rel="footnote" href="#fn-14" name="fnd-14"><sup>14</sup></a> This
secion contains the paths to the midi patches. Section see <a href="player.html#player">MIDI files</a>
describes how to set up OCP for midi playback. For use of timidity,
<samp><span class="file">/etc/timidity.cfg</span></samp> must be configured.
<pre class="example"> [midi]
use=.... to force which option to use [ultradir fff freepats timidity]
fff=c:\iw\gsfull4m.fff
ultradir=/home/user/ultradir
freepats=/usr/local/share/freepats
</pre>
<p><table summary=""><tr align="left"><td valign="top" width="30%">use </td><td valign="top" width="70%">
if you want to force usage of a specific patch-system, set this variable to one of these values: ultradir fff freepats timidity
<br></td></tr><tr align="left"><td valign="top" width="30%">fff </td><td valign="top" width="70%">path where the fff font is located
<br></td></tr><tr align="left"><td valign="top" width="30%">ultradir </td><td valign="top" width="70%">
path where ULTRADIR.INI is stored. Please checkout <samp><span class="file">ultrafix.sh</span></samp> for
fixing cases in filenames.
<br></td></tr><tr align="left"><td valign="top" width="30%">freepats </td><td valign="top" width="70%">path to where freepats is located
<br></td></tr></table>
<div class="footnote">
<hr>
<h4>Footnotes</h4><p class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small> And remember
to make backups before changing vital parts of the <samp><span class="file">ocp.ini</span></samp></p>
<p class="footnote"><small>[<a name="fn-2" href="#fnd-2">2</a>]</small> Therefore it
was named <em>defaultconfig</em>...</p>
<p class="footnote"><small>[<a name="fn-3" href="#fnd-3">3</a>]</small> you
can change devices by using the special
<samp><span class="file">setup:</span></samp> drive described in section See <a href="fileselector.html#fileselector">fileselector</a>.</p>
<p class="footnote"><small>[<a name="fn-4" href="#fnd-4">4</a>]</small> mostly 32
channels</p>
<p class="footnote"><small>[<a name="fn-5" href="#fnd-5">5</a>]</small> SoundBlaster 1.x or SoundBlaster Pro and compatibles</p>
<p class="footnote"><small>[<a name="fn-6" href="#fnd-6">6</a>]</small> Something like 386SX</p>
<p class="footnote"><small>[<a name="fn-7" href="#fnd-7">7</a>]</small> <em><</em>486DX</p>
<p class="footnote"><small>[<a name="fn-8" href="#fnd-8">8</a>]</small> See section
see <a href="fileselector.html#fileselector">bigmodules</a> for details about this feature</p>
<p class="footnote"><small>[<a name="fn-9" href="#fnd-9">9</a>]</small> switching the soundcard may cause problems so enable
this option.</p>
<p class="footnote"><small>[<a name="fn-10" href="#fnd-10">10</a>]</small> currently
the SoundBlasterAWE and the TerraTecEWS</p>
<p class="footnote"><small>[<a name="fn-11" href="#fnd-11">11</a>]</small> this
has little to do with real Dolby Surround although there should be a
certain effect if you have such an amplifier</p>
<p class="footnote"><small>[<a name="fn-12" href="#fnd-12">12</a>]</small> however files with different extensions are
likely to be no valid module format, so they will be refused to load</p>
<p class="footnote"><small>[<a name="fn-13" href="#fnd-13">13</a>]</small> You
can toggle by using the <em>bigmodule</em> feature described in
See <a href="fileselector.html#fileselector">bigmodules</a>.</p>
<p class="footnote"><small>[<a name="fn-14" href="#fnd-14">14</a>]</small> a so called midi patch set</p>
<hr></div>
</body></html>
