<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>xscanu</title>
<link rel="stylesheet" href="csound.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2" />
<link rel="home" href="index.html" title="The Canonical Csound Reference Manual" />
<link rel="up" href="OpcodesTop.html" title="Orchestra Opcodes and Operators" />
<link rel="prev" href="xscans.html" title="xscans" />
<link rel="next" href="xtratim.html" title="xtratim" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">xscanu</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="xscans.html">Prev</a> </td>
<th width="60%" align="center">Orchestra Opcodes and Operators</th>
<td width="20%" align="right"> <a accesskey="n" href="xtratim.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="refentry" title="xscanu">
<a id="xscanu"></a>
<div class="titlepage"></div>
<a id="IndexXscanu" class="indexterm"></a>
<div class="refnamediv">
<h2>
<span class="refentrytitle">xscanu</span>
</h2>
<p>xscanu —
Compute the waveform and the wavetable for use in scanned synthesis.
</p>
</div>
<div class="refsect1" title="Description">
<a id="id3376528"></a>
<h2>Description</h2>
<p>
Experimental version of <a class="link" href="scanu.html" title="scanu"><em class="citetitle">scanu</em></a>. Allows much larger matrices and is faster and smaller but removes some (unused?) flexibility. If liked, it will replace the older opcode as it is syntax compatible but extended.
</p>
</div>
<div class="refsect1" title="Syntax">
<a id="id3376967"></a>
<h2>Syntax</h2>
<pre class="synopsis"><span class="command"><strong>xscanu</strong></span> init, irate, ifnvel, ifnmass, ifnstif, ifncentr, ifndamp, kmass, \
kstif, kcentr, kdamp, ileft, iright, kpos, kstrngth, ain, idisp, id</pre>
</div>
<div class="refsect1" title="Initialization">
<a id="id3376987"></a>
<h2>Initialization</h2>
<p>
<span class="emphasis"><em>init</em></span> -- the initial position of the masses. If this is a negative number, then the absolute of init signifies the table to use as a hammer shape. If init > 0, the length of it should be the same as the intended mass number, otherwise it can be anything.
</p>
<p>
<span class="emphasis"><em>irate</em></span> -- update rate.
</p>
<p>
<span class="emphasis"><em>ifnvel</em></span> -- the ftable that contains the initial velocity for each mass. It should have the same size as the intended mass number.
</p>
<p>
<span class="emphasis"><em>ifnmass</em></span> -- ftable that contains the mass of each mass. It should have the same size as the intended mass number.
</p>
<p>
<span class="emphasis"><em>ifnstif</em></span> --
</p>
<div class="itemizedlist">
<ul class="itemizedlist" type="disc">
<li class="listitem">
<p><span class="emphasis"><em>either</em></span> an ftable that contains the spring stiffness of each connection. It should have the same size as the square of the intended mass number. The data ordering is a row after row dump of the connection matrix of the system.</p>
</li>
<li class="listitem">
<p><span class="emphasis"><em>or</em></span> a string giving the name of a file in the MATRIX format</p>
</li>
</ul>
</div>
<p>
</p>
<p>
<span class="emphasis"><em>ifncentr</em></span> -- ftable that contains the centering force of each mass. It should have the same size as the intended mass number.
</p>
<p>
<span class="emphasis"><em>ifndamp</em></span> -- the ftable that contains the damping factor of each mass. It should have the same size as the intended mass number.
</p>
<p>
<span class="emphasis"><em>ileft</em></span> -- If init < 0, the position of the left hammer (ileft = 0 is hit at leftmost, ileft = 1 is hit at rightmost).
</p>
<p>
<span class="emphasis"><em>iright</em></span> -- If init < 0, the position of the right hammer (iright = 0 is hit at leftmost, iright = 1 is hit at rightmost).
</p>
<p>
<span class="emphasis"><em>idisp</em></span> -- If 0, no display of the masses is provided.
</p>
<p>
<span class="emphasis"><em>id</em></span> -- If positive, the ID of the opcode. This will be used to point the scanning opcode to the proper waveform maker. If this value is negative, the absolute of this value is the wavetable on which to write the waveshape. That wavetable can be used later from an other opcode to generate sound. The initial contents of this table will be destroyed.
</p>
</div>
<div class="refsect1" title="Performance">
<a id="id3377118"></a>
<h2>Performance</h2>
<p>
<span class="emphasis"><em>kmass</em></span> -- scales the masses
</p>
<p>
<span class="emphasis"><em>kstif</em></span> -- scales the spring stiffness
</p>
<p>
<span class="emphasis"><em>kcentr</em></span> -- scales the centering force
</p>
<p>
<span class="emphasis"><em>kdamp</em></span> -- scales the damping
</p>
<p>
<span class="emphasis"><em>kpos</em></span> -- position of an active hammer along the string (kpos = 0 is leftmost, kpos = 1 is rightmost). The shape of the hammer is determined by init and the power it pushes with is kstrngth.
</p>
<p>
<span class="emphasis"><em>kstrngth</em></span> -- power that the active hammer uses
</p>
<p>
<span class="emphasis"><em>ain</em></span> -- audio input that adds to the velocity of the masses. Amplitude should not be too great.
</p>
</div>
<div class="refsect1" title="Matrix Format">
<a id="id3377180"></a>
<h2>Matrix Format</h2>
<p>
The new matrix format is a list of connections, one per line linking point x to point y. There is no weight given to the link; it is assumed to be unity. The list is proceeded by the line <MATRIX> and ends with a </MATRIX> line
</p>
<p>
For example, a circular string of 8 would be coded as
</p>
<div class="informalexample">
<pre class="programlisting">
<MATRIX>
0 1
1 0
1 2
2 1
2 3
3 2
3 4
4 3
4 5
5 4
5 6
6 5
6 7
7 6
0 7
</MATRIX>
</pre>
</div>
<p>
</p>
</div>
<div class="refsect1" title="Credits">
<a id="id3377213"></a>
<h2>Credits</h2>
<p>Written by John ffitch.</p>
<p>New in version 4.20</p>
</div>
<div class="refsect1" title="Examples">
<a id="id3377228"></a>
<h2>Examples</h2>
<p>
For an example, see the documentation on <a class="link" href="scans.html" title="scans"><em class="citetitle">scans</em></a>.
</p>
</div>
<div class="refsect1" title="See Also">
<a id="id3377246"></a>
<h2>See Also</h2>
<p>
<a class="link" href="scanu.html" title="scanu"><em class="citetitle">scanu</em></a>,
<a class="link" href="xscans.html" title="xscans"><em class="citetitle">xscans</em></a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="xscans.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="OpcodesTop.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="xtratim.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">xscans </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> xtratim</td>
</tr>
</table>
</div>
</body>
</html>
