<?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>active</title> <link rel="stylesheet" type="text/css" href="csound.css" /> <link rel="stylesheet" type="text/css" href="syntax-highlighting.css" /> <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /> <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="abs.html" title="abs" /> <link rel="next" href="adsr.html" title="adsr" /> </head> <body> <div class="navheader"> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center">active</th> </tr> <tr> <td width="20%" align="left"><a accesskey="p" href="abs.html">Prev</a> </td> <th width="60%" align="center">Orchestra Opcodes and Operators</th> <td width="20%" align="right"> <a accesskey="n" href="adsr.html">Next</a></td> </tr> </table> <hr /> </div> <div class="refentry"> <a id="active"></a> <div class="titlepage"></div> <a id="IndexActive" class="indexterm"></a> <div class="refnamediv"> <h2> <span class="refentrytitle">active</span> </h2> <p>active — Returns the number of active instances of an instrument. </p> </div> <div class="refsect1"> <a id="idm281472952169272"></a> <h2>Description</h2> <p> Returns the number of active instances of an instrument with options to ignore releasing instances. </p> </div> <div class="refsect1"> <a id="idm281472952167816"></a> <h2>Syntax</h2> <pre class="synopsis">ir <span class="command"><strong>active</strong></span> insnum [,iopt [,inorel]]</pre> <pre class="synopsis">ir <span class="command"><strong>active</strong></span> Sinsname [,iopt [,inorel]]</pre> <pre class="synopsis">kres <span class="command"><strong>active</strong></span> kinsnum [,iopt [,inorel]]</pre> </div> <div class="refsect1"> <a id="idm281472952104344"></a> <h2>Initialization</h2> <p> <span class="emphasis"><em>insnum</em></span> -- number or string name of the instrument to be reported </p> <p> <span class="emphasis"><em>Sinsname</em></span> -- instrument name </p> <p> <span class="emphasis"><em>iopt</em></span> -- select currently active (zero, default), or all every active (non zero) </p> <p> <span class="emphasis"><em>inorel</em></span> -- if non-zero ignore instruments in release phase (zero, default), only valid if iopts is zero. </p> </div> <div class="refsect1"> <a id="idm281472952099704"></a> <h2>Performance</h2> <p> <span class="emphasis"><em>kinsnum</em></span> -- number or string name of the instrument to be reported </p> <p> <span class="emphasis"><em>active</em></span> returns the number of active instances of instrument number <span class="emphasis"><em>insnum/kinsnum</em></span> (or named instrument <span class="emphasis"><em>Sinsname</em></span>). As of Csound 4.17 the output is updated at k-rate (if input arg is k-rate), to allow running count of instr instances. </p> <p> As of Csound 5.17 if the instrument number is given as zero then all instruments are counted. </p> </div> <div class="refsect1"> <a id="idm281472952095208"></a> <h2>Examples</h2> <p> Here is a simple example of the active opcode. It uses the file <a class="ulink" href="examples/active.csd" target="_top"><em class="citetitle">active.csd</em></a>. </p> <div class="example"> <a id="idm281472952093224"></a> <p class="title"> <strong>Example 42. Simple example of the active opcode.</strong> </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> <div class="refsect1"> <a id="idm281472787755880"></a> <pre class="programlisting"> <span class="nt"><CsoundSynthesizer></span> <span class="nt"><CsOptions></span> <span class="c1">; Select audio/midi flags here according to platform</span> <span class="c1">; Audio out Audio in</span> -odac -iadc <span class="c1">;;;RT audio I/O</span> <span class="c1">; For Non-realtime ouput leave only the line below:</span> <span class="c1">; -o active.wav -W ;;; for file output any platform</span> <span class="nt"></CsOptions></span> <span class="nt"><CsInstruments></span> <span class="c1">; Initialize the global variables.</span> <span class="vg">sr</span> <span class="o">=</span> <span class="mi">44100</span> <span class="vg">kr</span> <span class="o">=</span> <span class="mi">4410</span> <span class="vg">ksmps</span> <span class="o">=</span> <span class="mi">10</span> <span class="vg">nchnls</span> <span class="o">=</span> <span class="mi">1</span> <span class="c1">; Instrument #1 - a noisy waveform.</span> <span class="kd">instr</span> <span class="nf">1</span> <span class="c1">; Generate a really noisy waveform.</span> a<span class="n">noisy</span> <span class="nb">rand</span> <span class="mi">44100</span> <span class="c1">; Turn down its amplitude.</span> a<span class="n">output</span> <span class="nb">gain</span> a<span class="n">noisy</span><span class="p">,</span> <span class="mi">2500</span> <span class="c1">; Send it to the output.</span> <span class="nb">out</span> a<span class="n">output</span> <span class="kd">endin</span> <span class="c1">; Instrument #2 - counts active instruments.</span> <span class="kd">instr</span> <span class="nf">2</span> <span class="c1">; Count the active instances of Instrument #1.</span> i<span class="n">count</span> <span class="nb">active</span> <span class="mi">1</span> <span class="c1">; Print the number of active instances.</span> <span class="nb">print</span> i<span class="n">count</span> <span class="kd">endin</span> <span class="nt"></CsInstruments></span> <span class="nt"><CsScore></span> <span class="c1">; Start the first instance of Instrument #1 at 0:00 seconds.</span> <span class="nb">i</span> <span class="mi">1</span> <span class="mf">0.0</span> <span class="mf">3.0</span> <span class="c1">; Start the second instance of Instrument #1 at 0:015 seconds.</span> <span class="nb">i</span> <span class="mi">1</span> <span class="mf">1.5</span> <span class="mf">1.5</span> <span class="c1">; Play Instrument #2 at 0:01 seconds, when we have only </span> <span class="c1">; one active instance of Instrument #1.</span> <span class="nb">i</span> <span class="mi">2</span> <span class="mf">1.0</span> <span class="mf">0.1</span> <span class="c1">; Play Instrument #2 at 0:02 seconds, when we have </span> <span class="c1">; two active instances of Instrument #1.</span> <span class="nb">i</span> <span class="mi">2</span> <span class="mf">2.0</span> <span class="mf">0.1</span> <span class="nb">e</span> <span class="nt"></CsScore></span> <span class="nt"></CsoundSynthesizer></span> </pre> </div> </div> </div> <p><br class="example-break" /> Its output should include lines like this: </p> <pre class="screen"> instr 2: icount = 1.000 instr 2: icount = 2.000 </pre> <p> </p> <p> Here is a more advanced example of the active opcode. It displays the results of the active opcode at k-rate instead of i-rate. It uses the file <a class="ulink" href="examples/active_k.csd" target="_top"><em class="citetitle">active_k.csd</em></a>. </p> <div class="example"> <a id="idm281472952086904"></a> <p class="title"> <strong>Example 43. Example of the active opcode at k-rate.</strong> </p> <div class="example-contents"> <div class="refsect1"> <a id="idm281472787715896"></a> <pre class="programlisting"> <span class="nt"><CsoundSynthesizer></span> <span class="nt"><CsOptions></span> <span class="c1">; Select audio/midi flags here according to platform</span> <span class="c1">; Audio out Audio in</span> -odac -iadc <span class="c1">;;;RT audio I/O</span> <span class="c1">; For Non-realtime ouput leave only the line below:</span> <span class="c1">; -o active_k.wav -W ;;; for file output any platform</span> <span class="nt"></CsOptions></span> <span class="nt"><CsInstruments></span> <span class="c1">; Initialize the global variables.</span> <span class="vg">sr</span> <span class="o">=</span> <span class="mi">44100</span> <span class="vg">kr</span> <span class="o">=</span> <span class="mi">4410</span> <span class="vg">ksmps</span> <span class="o">=</span> <span class="mi">10</span> <span class="vg">nchnls</span> <span class="o">=</span> <span class="mi">1</span> <span class="c1">; Instrument #1 - a noisy waveform.</span> <span class="kd">instr</span> <span class="nf">1</span> <span class="c1">; Generate a really noisy waveform.</span> a<span class="n">noisy</span> <span class="nb">rand</span> <span class="mi">44100</span> <span class="c1">; Turn down its amplitude.</span> a<span class="n">output</span> <span class="nb">gain</span> a<span class="n">noisy</span><span class="p">,</span> <span class="mi">2500</span> <span class="c1">; Send it to the output.</span> <span class="nb">out</span> a<span class="n">output</span> <span class="kd">endin</span> <span class="c1">; Instrument #2 - counts active instruments at k-rate.</span> <span class="kd">instr</span> <span class="nf">2</span> <span class="c1">; Count the active instances of Instrument #1.</span> k<span class="n">count</span> <span class="nb">active</span> <span class="mi">1</span> <span class="c1">; Print the number of active instances.</span> <span class="nb">printk2</span> k<span class="n">count</span> <span class="kd">endin</span> <span class="nt"></CsInstruments></span> <span class="nt"><CsScore></span> <span class="c1">; Start the first instance of Instrument #1 at 0:00 seconds.</span> <span class="nb">i</span> <span class="mi">1</span> <span class="mf">0.0</span> <span class="mf">3.0</span> <span class="c1">; Start the second instance of Instrument #1 at 0:015 seconds.</span> <span class="nb">i</span> <span class="mi">1</span> <span class="mf">1.5</span> <span class="mf">1.5</span> <span class="c1">; Play Instrument #2 at 0:01 seconds, when we have only </span> <span class="c1">; one active instance of Instrument #1.</span> <span class="nb">i</span> <span class="mi">2</span> <span class="mf">1.0</span> <span class="mf">0.1</span> <span class="c1">; Play Instrument #2 at 0:02 seconds, when we have </span> <span class="c1">; two active instances of Instrument #1.</span> <span class="nb">i</span> <span class="mi">2</span> <span class="mf">2.0</span> <span class="mf">0.1</span> <span class="nb">e</span> <span class="nt"></CsScore></span> <span class="nt"></CsoundSynthesizer></span> </pre> </div> </div> </div> <p><br class="example-break" /> Its output should include lines like: </p> <pre class="screen"> i2 1.00000 i2 2.00000 </pre> <p> </p> <p> Here is another example of the active opcode, using the number of instances to calculate gain. It uses the file <a class="ulink" href="examples/active_scale.csd" target="_top"><em class="citetitle">active_scale.csd</em></a>. </p> <div class="example"> <a id="idm281472952083096"></a> <p class="title"> <strong>Example 44. Example of the active opcode at k-rate.</strong> </p> <div class="example-contents"> <div class="refsect1"> <a id="idm281472787651128"></a> <pre class="programlisting"> <span class="nt"><CsoundSynthesizer></span> <span class="nt"><CsOptions></span> <span class="c1">; Select audio/midi flags here according to platform</span> <span class="c1">; Audio out Audio in No messages</span> -odac -d <span class="c1">;;;RT audio I/O</span> <span class="c1">; For Non-realtime ouput leave only the line below:</span> <span class="c1">; -o atone.wav -W ;;; for file output any platform</span> <span class="nt"></CsOptions></span> <span class="nt"><CsInstruments></span> <span class="vg">sr</span><span class="o">=</span> <span class="mi">44100</span> <span class="vg">ksmps</span> <span class="o">=</span> <span class="mi">64</span> <span class="vg">nchnls</span> <span class="o">=</span> <span class="mi">1</span> <span class="vg">0dbfs</span> <span class="o">=</span> <span class="mi">1</span> <span class="c1">;by Victor Lazzarini 2008</span> <span class="kd">instr</span> <span class="nf">1</span> k<span class="n">scal</span> <span class="nb">active</span> <span class="mi">1</span> k<span class="n">amp</span> <span class="nb">port</span> <span class="mi">1</span><span class="o">/</span>k<span class="n">scal</span><span class="p">,</span> <span class="mf">0.01</span> a<span class="n">sig</span> <span class="nb">oscili</span> k<span class="n">amp</span><span class="p">,</span> <span class="nb">p4</span><span class="p">,</span> <span class="mi">1</span> k<span class="n">env</span> <span class="nb">linseg</span> <span class="mi">0</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="nb">p3</span><span class="o">-</span><span class="mf">0.2</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mf">0.1</span><span class="p">,</span> <span class="mi">0</span> <span class="nb">out</span> a<span class="n">sig</span><span class="o">*</span>k<span class="n">env</span> <span class="kd">endin</span> <span class="nt"></CsInstruments></span> <span class="nt"><CsScore></span> <span class="nb">f</span><span class="mi">1</span> <span class="mi">0</span> <span class="mi">16384</span> <span class="mi">10</span> <span class="mi">1</span> <span class="nb">i</span><span class="mi">1</span> <span class="mi">0</span> <span class="mi">10</span> <span class="mi">440</span> <span class="nb">i</span><span class="mi">1</span> <span class="mi">1</span> <span class="mi">3</span> <span class="mi">220</span> <span class="nb">i</span><span class="mi">1</span> <span class="mi">2</span> <span class="mi">5</span> <span class="mi">350</span> <span class="nb">i</span><span class="mi">1</span> <span class="mi">4</span> <span class="mi">3</span> <span class="mi">700</span> <span class="nb">e</span> <span class="nt"></CsScore></span> <span class="nt"></CsoundSynthesizer></span> </pre> </div> </div> </div> <p><br class="example-break" /> </p> </div> <div class="refsect1"> <a id="idm281472952081272"></a> <h2>Credits</h2> <p> </p> <table border="0" summary="Simple list" class="simplelist"> <tr> <td>Author: John ffitch</td> </tr> <tr> <td>University of Bath/Codemist Ltd.</td> </tr> <tr> <td>Bath, UK</td> </tr> <tr> <td>July, 1999</td> </tr> </table> <p> </p> <p>Examples written by Kevin Conder.</p> <p>New in Csound version 3.57; named instruments added version 5.13</p> <p>Option for all ever active new in 5.13</p> <p>Count of all instruments new in 5.17</p> <p>No release option new in 5.19</p> </div> </div> <div class="navfooter"> <hr /> <table width="100%" summary="Navigation footer"> <tr> <td width="40%" align="left"><a accesskey="p" href="abs.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="adsr.html">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top">abs </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> adsr</td> </tr> </table> </div> </body> </html>