mirror of
https://github.com/thestk/stk
synced 2026-01-16 06:21:51 +00:00
Release 4.1.3 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
503ed3cc9f
commit
e11bff2fe8
@@ -8,7 +8,7 @@
|
||||
<img src="princeton.gif"> <img src="ccrma.gif"> <img src="mcgill.gif"><P>
|
||||
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="links.html">Links</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
||||
<HR>
|
||||
<!-- Generated by Doxygen 1.3.6 -->
|
||||
<!-- Generated by Doxygen 1.3.4 -->
|
||||
<h1><a class="anchor" name="usage">Usage Documentation</a></h1><ul>
|
||||
<li><a class="el" href="usage.html#directory">Directory Structure:</a></li><li><a class="el" href="usage.html#compiling">Compiling:</a></li><li><a class="el" href="usage.html#control">Control Data:</a></li><li><a class="el" href="usage.html#voices">Demo: STK Instruments</a></li><li><a class="el" href="usage.html#nort">Demo: Non-Realtime Use</a></li><li><a class="el" href="usage.html#rt">Demo: Realtime Use</a></li><li><a class="el" href="usage.html#tcl">Realtime Control Input using Tcl/Tk Graphical User Interfaces:</a></li><li><a class="el" href="usage.html#midi">Realtime MIDI Control Input:</a></li><li><a class="el" href="usage.html#polyphony">Polyphony:</a></li></ul>
|
||||
<p>
|
||||
@@ -77,9 +77,9 @@ Several options can be supplied to the <code>configure</code> script to customiz
|
||||
<code>--with-alsa</code> to choose native ALSA API support (linux only) </li>
|
||||
</ul>
|
||||
<p>
|
||||
In addition, it is possible to specify the location of the STK rawwaves and the STK include path as follows: <pre class="fragment"><div>./configure RAWWAVE_PATH=<span class="stringliteral">"/home/gary/rawwaves/"</span>
|
||||
In addition, it is possible to specify the location of the STK rawwaves and the STK include path as follows: <div class="fragment"><pre>./configure RAWWAVE_PATH=<span class="stringliteral">"/home/gary/rawwaves/"</span>
|
||||
./configure INCLUDE_PATH=<span class="stringliteral">"/home/gary/include/"</span>
|
||||
</div></pre><p>
|
||||
</pre></div><p>
|
||||
For novice STK users, the default configuration should be adequate. </li>
|
||||
</ul>
|
||||
<p>
|
||||
@@ -98,7 +98,7 @@ For those who wish to create their own system-specific <code>Makefiles</code>: <
|
||||
</ul>
|
||||
<h2><a class="anchor" name="control">
|
||||
Control Data:</a></h2>
|
||||
All STK programs in this distribution take input control data in the form of <a href="skini.html">SKINI</a> or MIDI messages only. The <a class="el" href="classMessager.html">Messager</a> class unifies the various means of acquiring control data under a single, easy to use set of functions. The way that <a class="el" href="classSKINI.html">SKINI</a> messages can be sent to the programs is dependent upon the operating system in use, as well as whether the program is running in realtime or not. In general, it is possible to:<p>
|
||||
All STK programs in this distribution take input control data in the form of <a href="skini.html"><a class="el" href="classSKINI.html">SKINI</a></a> or MIDI messages only. The <a class="el" href="classMessager.html">Messager</a> class unifies the various means of acquiring control data under a single, easy to use set of functions. The way that <a class="el" href="classSKINI.html">SKINI</a> messages can be sent to the programs is dependent upon the operating system in use, as well as whether the program is running in realtime or not. In general, it is possible to:<p>
|
||||
<ol>
|
||||
<li>
|
||||
Redirect or pipe <a class="el" href="classSKINI.html">SKINI</a> scorefiles to an executable. </li>
|
||||
@@ -172,17 +172,17 @@ The <em><b>demo</b></em> project demonstrates the behavior of all the distribute
|
||||
Demo: Non-Realtime Use</a></h2>
|
||||
See the information above with respect to compiling STK for non-realtime use.<p>
|
||||
In non-realtime mode, it is assumed that input control messages are provided from a <a class="el" href="classSKINI.html">SKINI</a> scorefile and that audio output is written to a soundfile (.snd, .wav, .aif, .mat, .raw). A number of <a class="el" href="classSKINI.html">SKINI</a> scorefiles are provided in the <em>scores</em> directory of the <em><b>demo</b></em> project. Assuming a successful compilation of the <em><b>demo</b></em> program, typing:<p>
|
||||
<pre class="fragment"><div>cat scores/bookert.ski | demo <a class="code" href="classBeeThree.html">BeeThree</a> -ow myfile.wav
|
||||
</div></pre><p>
|
||||
<div class="fragment"><pre>cat scores/bookert.ski | demo <a class="code" href="classBeeThree.html">BeeThree</a> -ow myfile.wav
|
||||
</pre></div><p>
|
||||
or (on WindowsXX and/or Unix)<p>
|
||||
<pre class="fragment"><div>demo <a class="code" href="classBeeThree.html">BeeThree</a> -ow myfile.wav < scores\bookert.ski
|
||||
</div></pre><p>
|
||||
<div class="fragment"><pre>demo <a class="code" href="classBeeThree.html">BeeThree</a> -ow myfile.wav < scores\bookert.ski
|
||||
</pre></div><p>
|
||||
from the <em><b>demo</b></em> directory will play the scorefile <em>bookert.ski</em> using the STK <a class="el" href="classBeeThree.html">BeeThree</a> instrument and write the resulting audio data to a WAV formatted soundfile called "myfile.wav". Typing <code>demo</code> without any arguments will provide a full program usage description.<h2><a class="anchor" name="rt">
|
||||
Demo: Realtime Use</a></h2>
|
||||
STK realtime audio and MIDI input/output and realtime <a class="el" href="classSKINI.html">SKINI</a> control input via socketing support is provided for Linux, SGI, Mac OS X, and Windows95/98/2000/XP operating systems. STK realtime <a class="el" href="classSKINI.html">SKINI</a> control input via piping is possible under Linux, SGI, Mac OS X, and Windows2000/XP only. <p>
|
||||
Control input and audio output options are typically specified as command-line arguments to STK programs. For example, the <em><b>demo</b></em> program is invoked as:<p>
|
||||
<pre class="fragment"><div>demo instrument flags
|
||||
</div></pre><p>
|
||||
<div class="fragment"><pre>demo instrument flags
|
||||
</pre></div><p>
|
||||
where instruments include those described above and flags can be any or all of: <ul>
|
||||
<li>
|
||||
<em>-or</em> for realtime audio output, </li>
|
||||
@@ -205,16 +205,16 @@ where instruments include those described above and flags can be any or all of:
|
||||
</ul>
|
||||
The <-ip> and <-is> flags must be used when piping or socketing realtime <a class="el" href="classSKINI.html">SKINI</a> control data to an STK program. The <-im> flag must be used to read MIDI control input from your MIDI port. Note that you can use all three input types simultaneously.<p>
|
||||
Assuming a successful compilation of the <em><b>demo</b></em> program, typing:<p>
|
||||
<pre class="fragment"><div>cat scores/bookert.ski | demo <a class="code" href="classBeeThree.html">BeeThree</a> -or
|
||||
</div></pre><p>
|
||||
<div class="fragment"><pre>cat scores/bookert.ski | demo <a class="code" href="classBeeThree.html">BeeThree</a> -or
|
||||
</pre></div><p>
|
||||
or (on WindowsXX and/or Unix)<p>
|
||||
<pre class="fragment"><div>demo <a class="code" href="classBeeThree.html">BeeThree</a> -or < scores\bookert.ski
|
||||
</div></pre><p>
|
||||
<div class="fragment"><pre>demo <a class="code" href="classBeeThree.html">BeeThree</a> -or < scores\bookert.ski
|
||||
</pre></div><p>
|
||||
from the <em><b>demo</b></em> directory will play the scorefile <em>bookert.ski</em> using the STK <a class="el" href="classBeeThree.html">BeeThree</a> instrument and stream the resulting audio data in realtime to the audio output channel of your computer. Typing <code>demo</code> without any arguments will provide a full program usage description.<h2><a class="anchor" name="tcl">
|
||||
Realtime Control Input using Tcl/Tk Graphical User Interfaces:</a></h2>
|
||||
There are a number of <a href="http://dev.scriptics.com">Tcl/Tk</a> GUIs supplied with the STK projects. These scripts require Tcl/Tk version 8.0 or later, which can be downloaded for free over the WWW. On Unix and Windows2000/XP platforms, you can run the various executable scripts (e.g. StkDemo.bat) provided with each project to start everything up (you may need to symbolically link the wishXX executable to the name <em>wish</em>). The Physical.bat script just implements the following command-line sequence:<p>
|
||||
<pre class="fragment"><div>wish < tcl/Physical.tcl | demo <a class="code" href="classClarinet.html">Clarinet</a> -or -ip
|
||||
</div></pre><p>
|
||||
<div class="fragment"><pre>wish < tcl/Physical.tcl | demo <a class="code" href="classClarinet.html">Clarinet</a> -or -ip
|
||||
</pre></div><p>
|
||||
On WindowsXX and Unix platforms, the following operations are necessary to establish a socket connection between the Tcl/Tk GUI and the STK program: <ol>
|
||||
<li>
|
||||
Open a DOS shell and start the STK program with the <em>-is</em> flag (ex. <em><b>demo <a class="el" href="classClarinet.html">Clarinet</a> -or -is</b></em>). </li>
|
||||
@@ -227,12 +227,12 @@ Establish the socket connection by selecting <em><a class="el" href="classSocket
|
||||
Note that it is possible to specify a hostname when establishing the socket connection from the socket client. Thus, the STK socket server program and the Tcl/Tk GUI need not necessarily reside on the same computer.<h2><a class="anchor" name="midi">
|
||||
Realtime MIDI Control Input:</a></h2>
|
||||
On all supported realtime platforms, you can direct realtime MIDI input to the STK <a class="el" href="classClarinet.html">Clarinet</a> by typing:<p>
|
||||
<pre class="fragment"><div>demo <a class="code" href="classClarinet.html">Clarinet</a> -or -im
|
||||
</div></pre><h2><a class="anchor" name="polyphony">
|
||||
<div class="fragment"><pre>demo <a class="code" href="classClarinet.html">Clarinet</a> -or -im
|
||||
</pre></div><h2><a class="anchor" name="polyphony">
|
||||
Polyphony:</a></h2>
|
||||
The <em><b>demo</b></em> program supports an arbitrary number of voices via the <code>-n NUMBER</code> command-line flag and argument. For example, you can play eight <a class="el" href="classBeeThree.html">BeeThree</a> instruments with realtime output and control them from a MIDI device by typing:<p>
|
||||
<pre class="fragment"><div>demo <a class="code" href="classBeeThree.html">BeeThree</a> -n 8 -or -im
|
||||
</div></pre><HR>
|
||||
<div class="fragment"><pre>demo <a class="code" href="classBeeThree.html">BeeThree</a> -n 8 -or -im
|
||||
</pre></div><HR>
|
||||
|
||||
<table>
|
||||
<tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
||||
|
||||
Reference in New Issue
Block a user