<html lang="en">
<head>
<title>starting - 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="install.html#install" title="install">
<link rel="next" href="fileselector.html#fileselector" title="fileselector">
<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="starting"></a>
<p>
Next: <a rel="next" accesskey="n" href="fileselector.html#fileselector">fileselector</a>,
Previous: <a rel="previous" accesskey="p" href="install.html#install">install</a>,
Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">2 Starting Open Cubic Player</h2>
<p>When starting OCP, it first tries to setup a directory in your home-directory
where cache and configuration will be stored, aswell at locating where OCP
has installed its main files.
<p>OCP then tries to detect the sound cards defined in the <samp><span class="file">ocp.ini</span></samp> file.
If the card is not found you cannot use it. If more than one sound card is
installed and found by OCP the first one listed in the <samp><span class="file">ocp.ini</span></samp> is
used as the default device.<a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a>
<p>By entering a filename as parameter onto the command line you can load a module.
If a filename is given the file will be loaded and OCP starts with the
player.<a rel="footnote" href="#fn-2" name="fnd-2"><sup>2</sup></a> When the parameter is
the name of a directory the fileselector starts with the given directory.
If the parameter equals a certain archive all files found inside the archive
will be played (by adding them to the playlist).
<p>If more than one parameter is given a playlist will be set up, containing all
found files. You can mix filenames of archives, files in archives and normal
files on the hard disk.
<p>You normally don't have to supply the right file extensions, as they are
guessed by the fileselector. If the filename is not complete the file will
not be processed (unlike the quickfind function).
<p>OCP can be configured using the command line, although the configuration
through the <samp><span class="file">ocp.ini</span></samp> file is more comfortable. The options split up
into three main sections each starting with “-” followed by a letter. For
each section different options are given, which will configure the player
accordingly. You can precede each option with the section prefix every time
or supply multiple options seperated with “,”. Some special options do not
require the use of a sections prefix, like the <em>help</em> switch.
<p>The command line looks like:
<pre class="example"> ocp [prefix option[,option]] [specialOption] [filename]<a rel="footnote" href="#fn-3" name="fnd-3"><sup>3</sup></a>
</pre>
<p>Special options include:
<ul>
<li>-h show a help screen
<li>-c<name> use a configuration defined in <samp><span class="file">ocp.ini</span></samp>
</ul>
<p>Fileselector options are envoked with <em>-f</em>. The values in square brackets define
a choice that must be made when using one of these options.
<ul>
<li>-r[0|1] remove played files from playlist
<li>-o[0|1] don't scramble playlist order
<li>-l[0|1] loop modules
</ul>
<p>Playback options are preceded by <em>-v</em>. Values in sharp brackets define a range
in which the value must be taken.
<ul>
<li>-a<0..800> set amplification
<li>-v<0..100> set volume
<li>-b<-100..100> set balance
<li>-p<-100..100> set panning
<li>-r<-100..100> set reverb
<li>-c<-100..100> set chorus
<li>-s[0|1] set surround
<li>-f[0|1|2] set filter (0=off, 1=AOI, 2=FOI)
</ul>
<p>Device setting are accomplished with the suffix <em>-s</em>.
<ul>
<li>-p<name> use specific player device
<li>-s<name> use specific sampler device
<li>-w<name> use specific wavetable device
<li>-r<0..64000> sample at specific rate
<li>-8 play/sample/mix as 8bit
<li>-m play/sample/mix mono
</ul>
<p>Finally an example to illustrate the above features:
<pre class="example"> ocp -fl0,r1 -va80,p50,f2 -spdevpdisk -sr44100 ftstar.xm
</pre>
<p>This will start OCP and load the file <samp><span class="file">ftstar.xm</span></samp><a rel="footnote" href="#fn-4" name="fnd-4"><sup>4</sup></a>. The music will be played once
and will not loop <em>(-fl0, r1)</em>. Further the player is advised to amplify
this file with 80%, set the panning to 50% and interpolate every sample
(<em>-va80, p50, f2</em>). The mixed output will be saved into <samp><span class="file">.wav</span></samp>
format through the See <a href="player.html#player">Using the diskwriter</a>, device (<em>-spdevpdisk</em>) with a
sample rate of 44.1KHz (<em>-sr44100</em>).
<p>You can burn this WAV file directly onto a CD-Audio and play it with every
normal CD player. A much simpler and more convinient way to make such a
<em>sample image</em> of a module is by using predefined configurations with
the <em>-c</em> switch. Have a look at See <a href="player.html#player">Using the diskwriter</a>.
<div class="footnote">
<hr>
<h4>Footnotes</h4><p class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small> You can change this in the player by using
the <samp><span class="file">setup:</span></samp> device. See page See <a href="specialdrive.html#specialdrive">specialdrive</a>, for detail.</p>
<p class="footnote"><small>[<a name="fn-2" href="#fnd-2">2</a>]</small> This will work if the file is inside an archive located in the
current directory. If no (unpacked) file is found all archives in the current
directory are searched for an appropriate filename.</p>
<p class="footnote"><small>[<a name="fn-3" href="#fnd-3">3</a>]</small> Square
brackets [] indicate an optional item that can be repeated.</p>
<p class="footnote"><small>[<a name="fn-4" href="#fnd-4">4</a>]</small> A marvelous piece of
music composed by KB which won The Party 1997.</p>
<hr></div>
</body></html>
