<?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>ftlen</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="ftgentmp.html" title="ftgentmp" />
<link rel="next" href="ftload.html" title="ftload" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">ftlen</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="ftgentmp.html">Prev</a> </td>
<th width="60%" align="center">Orchestra Opcodes and Operators</th>
<td width="20%" align="right"> <a accesskey="n" href="ftload.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="refentry" title="ftlen">
<a id="ftlen"></a>
<div class="titlepage"></div>
<a id="IndexFtlen" class="indexterm"></a>
<div class="refnamediv">
<h2>
<span class="refentrytitle">ftlen</span>
</h2>
<p>ftlen —
Returns the size of a stored function table.
</p>
</div>
<div class="refsect1" title="Description">
<a id="id2924268"></a>
<h2>Description</h2>
<p>
Returns the size of a stored function table.
</p>
</div>
<div class="refsect1" title="Syntax">
<a id="id2924439"></a>
<h2>Syntax</h2>
<pre class="synopsis"><span class="command"><strong>ftlen</strong></span>(x) (init-rate args only)</pre>
</div>
<div class="refsect1" title="Performance">
<a id="id2924456"></a>
<h2>Performance</h2>
<p>
Returns the size (number of points, excluding guard point) of stored function table, number <span class="emphasis"><em>x</em></span>. While most units referencing a stored table will automatically take its size into account (so tables can be of arbitrary length), this function reports the actual size if that is needed. Note that <span class="emphasis"><em>ftlen</em></span> will always return a power-of-2 value, i.e. the function table guard point (see <a class="link" href="f.html" title="f Statement (or Function Table Statement)"><em class="citetitle">f Statement</em></a>) is not included.As of Csound version 3.53, <span class="emphasis"><em>ftlen</em></span> works with deferred function tables (see <a class="link" href="GEN01.html" title="GEN01"><em class="citetitle">GEN01</em></a>).
</p>
<p>
<span class="emphasis"><em>ftlen</em></span> differs from <span class="emphasis"><em>nsamp</em></span> in that <span class="emphasis"><em>nsamp</em></span> gives the number of sample frames loaded, while <span class="emphasis"><em>ftlen</em></span> gives the total number of samples without the guard point. For example, with a stereo sound file of 10000 samples, ftlen() would return 19999 (i.e. a total of 20000 mono samples, not including a guard point), but nsamp() returns 10000.
</p>
</div>
<div class="refsect1" title="Examples">
<a id="id2924526"></a>
<h2>Examples</h2>
<p>
Here is an example of the ftlen opcode. It uses the file <a class="ulink" href="examples/ftlen.csd" target="_top"><em class="citetitle">ftlen.csd</em></a>, and <a class="ulink" href="examples/mary.wav" target="_top"><em class="citetitle">mary.wav</em></a>.
</p>
<div class="example">
<a id="id2925133"></a>
<p class="title">
<b>Example 278. Example of the ftlen opcode.</b>
</p>
<div class="example-contents">
<p>See the sections <a class="link" href="UsingRealTime.html" title="Real-Time Audio"><em class="citetitle">Real-time Audio</em></a> and <a class="link" href="CommandFlags.html" title="Csound command line"><em class="citetitle">Command Line Flags</em></a> for more information on using command line flags.</p>
<pre class="programlisting">
<span class="csdtag"><CsoundSynthesizer></span>
<span class="csdtag"><CsOptions></span>
<span class="comment">; Select audio/midi flags here according to platform</span>
<span class="comment">; Audio out Audio in</span>
-odac -iadc <span class="comment">;;;RT audio I/O</span>
<span class="comment">; For Non-realtime ouput leave only the line below:</span>
<span class="comment">; -o ftlen.wav -W ;;; for file output any platform</span>
<span class="csdtag"></CsOptions></span>
<span class="csdtag"><CsInstruments></span>
<span class="comment">; Initialize the global variables.</span>
<span class="ohdr">sr</span> <span class="op">=</span> 44100
<span class="ohdr">kr</span> <span class="op">=</span> 4410
<span class="ohdr">ksmps</span> <span class="op">=</span> 10
<span class="ohdr">nchnls</span> <span class="op">=</span> 1
<span class="comment">; Instrument #1.</span>
<span class="oblock">instr</span> 1
<span class="comment">; Print out the size of Table #1.</span>
<span class="comment">; The size will be the number of points excluding the guard point.</span>
ilen <span class="op">=</span> <span class="opc">ftlen</span>(1)
<span class="opc">print</span> ilen
<span class="oblock">endin</span>
<span class="csdtag"></CsInstruments></span>
<span class="csdtag"><CsScore></span>
<span class="comment">; Table #1: Use an audio file, Csound will determine its size.</span>
<span class="stamnt">f</span> 1 0 0 1 "mary.wav" 0 0 0
<span class="comment">; Play Instrument #1 for 1 second.</span>
<span class="stamnt">i</span> 1 0 1
<span class="stamnt">e</span>
<span class="csdtag"></CsScore></span>
<span class="csdtag"></CsoundSynthesizer></span>
</pre>
</div>
</div>
<p><br class="example-break" />
The audio file <span class="quote">“<span class="quote">mary.wav</span>”</span> is 154390 samples long. The ftlen opcode reports it as 154389 samples long because it reserves 1 point for the guard point. Its output should include a line like this:
</p>
<pre class="screen">
instr 1: ilen = 154389.000
</pre>
<p>
</p>
</div>
<div class="refsect1" title="See Also">
<a id="id2925188"></a>
<h2>See Also</h2>
<p>
<a class="link" href="ftchnls.html" title="ftchnls"><em class="citetitle">ftchnls</em></a>,
<a class="link" href="ftlptim.html" title="ftlptim"><em class="citetitle">ftlptim</em></a>,
<a class="link" href="ftsr.html" title="ftsr"><em class="citetitle">ftsr</em></a>,
<a class="link" href="nsamp.html" title="nsamp"><em class="citetitle">nsamp</em></a>
</p>
</div>
<div class="refsect1" title="Credits">
<a id="id2925230"></a>
<h2>Credits</h2>
<p>
</p>
<table border="0" summary="Simple list" class="simplelist">
<tr>
<td>Author: Barry L. Vercoe</td>
</tr>
<tr>
<td>MIT</td>
</tr>
<tr>
<td>Cambridge, Massachussetts</td>
</tr>
<tr>
<td>1997</td>
</tr>
</table>
<p>
</p>
<p>Example written by Kevin Conder.</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="ftgentmp.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="ftload.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">ftgentmp </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> ftload</td>
</tr>
</table>
</div>
</body>
</html>
