<?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>OSClisten</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="OSCinit.html" title="OSCinit" />
<link rel="next" href="OSCraw.html" title="OSCraw" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">OSClisten</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="OSCinit.html">Prev</a> </td>
<th width="60%" align="center">Orchestra Opcodes and Operators</th>
<td width="20%" align="right"> <a accesskey="n" href="OSCraw.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="refentry">
<a id="OSClisten"></a>
<div class="titlepage"></div>
<a id="IndexOSClisten" class="indexterm"></a>
<div class="refnamediv">
<h2>
<span class="refentrytitle">OSClisten</span>
</h2>
<p>OSClisten —
Listen for OSC messages to a particular path.
</p>
</div>
<div class="refsect1">
<a id="idm281472908496456"></a>
<h2>Description</h2>
<p>
On each k-cycle looks to see if an OSC message has been send to
a given path of a given type.
</p>
</div>
<div class="refsect1">
<a id="idm281472908455096"></a>
<h2>Syntax</h2>
<pre class="synopsis">kans <span class="command"><strong>OSClisten</strong></span> ihandle, idest, itype [, xdata1, xdata2, ...]</pre>
</div>
<div class="refsect1">
<a id="idm281472908452920"></a>
<h2>Initialization</h2>
<p>
<span class="emphasis"><em>ihandle</em></span>
-- a handle returned by an earlier call to OSCinit, to associate
OSClisten with a particular port number.
</p>
<p>
<span class="emphasis"><em>idest</em></span>
-- a string that is the destination address. This takes the
form of a file name with directories. Csound uses this address
to decide if messages are meant for csound.
</p>
<p>
<span class="emphasis"><em>itype</em></span>
-- a string that indicates the types of the optional arguments
that are to be read. The string can contain the characters
"acdfhisAG" which stand for audio, character, double, float, 64-bit integer,
32-bit integer, string, scalar array and f-table. All types other than 'asA' require a
k-rate variable; 's' requires a string variable, 'a' an audio
variable and 'A' an i- or k- rate array. Fot type 'G' a variable
or constant can be used.
</p>
<p> A handler is inserted into the listener (see OSCinit) to
intercept messages of this pattern.
</p>
</div>
<div class="refsect1">
<a id="idm281472908448360"></a>
<h2>Performance</h2>
<p>
<span class="emphasis"><em>kans</em></span> -- set to 1 if a new message was
received, or zero if not. If multiple messages are received in
a single control period, the messages are buffered, and OSClisten
can be called again until zero is returned.
</p>
<p>
If there was a message the <span class="emphasis"><em>xdata</em></span> variables
are set to the incoming values, as interpretted by the
<span class="emphasis"><em>itype</em></span> parameter.
Note that although the <span class="emphasis"><em>xdata</em></span> variables are on
the right of an operation they are actually outputs, and so must be
variables of type a, ga, k, gk, S, gS, k[] and gk[] and may need to be declared with
init, or = in the case of string variables, before calling OSClisten.
</p>
</div>
<div class="refsect1">
<a id="idm281472908444504"></a>
<h2>Example</h2>
<p>
The example shows a pair of floating point numbers being received
on port 7770.
</p>
<div class="informalexample">
<pre class="programlisting">
<span class="ohdr">sr</span> <span class="op">=</span> 44100
<span class="ohdr">ksmps</span> <span class="op">=</span> 100
<span class="ohdr">nchnls</span> <span class="op">=</span> 2
gihandle <span class="opc">OSCinit</span> 7770
<span class="oblock">instr</span> 1
kf1 <span class="opc">init</span> 0
kf2 <span class="opc">init</span> 0
nxtmsg:
kk <span class="opc">OSClisten</span> gihandle, "/foo/bar", "ff", kf1, kf2
if (kk <span class="opc">==</span> 0) goto ex
<span class="opc">printk</span> 0,kf1
<span class="opc">printk</span> 0,kf2
<span class="opc">kgoto</span> nxtmsg
ex:
<span class="oblock">endin</span>
</pre>
</div>
<p>
Below are two .csd files which demonstrate the usage of the OSC opcodes. They use the files <a class="ulink" href="examples/OSCmidisend.csd" target="_top"><em class="citetitle">OSCmidisend.csd</em></a> and <a class="ulink" href="examples/OSCmidircv.csd" target="_top"><em class="citetitle">OSCmidircv.csd</em></a>.
</p>
<div class="example">
<a id="idm281472908429304"></a>
<p class="title">
<strong>Example 630. Example of the OSC opcodes.</strong>
</p>
<div class="example-contents">
<p>The following two .csd files demonstrate the usage of the OSC opcodes in csound. The first file, <a class="ulink" href="examples/OSCmidisend.csd" target="_top"><em class="citetitle">OSCmidisend.csd</em></a>, transforms received real-time MIDI messages into OSC data. The second file, <a class="ulink" href="examples/OSCmidircv.csd" target="_top"><em class="citetitle">OSCmidircv.csd</em></a>, can take these OSC messages, and intrepret them to generate sound from note messages, and store controller values. It will use controller number 7 to control volume. Note that these files are designed to be on the same machine, but if a different host address (in the IPADDRESS macro) is used, they can be separate machines on a network, or connected through the internet.</p>
<p>CSD file to send OSC messages:</p>
<div class="refsect1">
<a id="idm281472731581704"></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="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">128</span>
<span class="vg">nchnls</span> <span class="o">=</span> <span class="mi">1</span>
<span class="c1">; Example by David Akbari 2007</span>
<span class="c1">; Modified by Jonathan Murphy</span>
<span class="c1">; Use this file to generate OSC events for OSCmidircv.csd</span>
<span class="cp">#define</span> <span class="cp">IPADDRESS</span> <span class="p">#</span><span class="cp"> "localhost" </span><span class="p">#</span>
<span class="cp">#define</span> <span class="cp">PORT</span> <span class="p">#</span><span class="cp"> 47120 </span><span class="p">#</span>
<span class="nb">turnon</span> <span class="mi">1000</span>
<span class="kd">instr</span> <span class="nf">1000</span>
k<span class="n">st</span><span class="p">,</span> k<span class="n">ch</span><span class="p">,</span> k<span class="n">d1</span><span class="p">,</span> k<span class="n">d2</span> <span class="nb">midiin</span>
<span class="nb">OSCsend</span> k<span class="n">st</span><span class="o">+</span>k<span class="n">ch</span><span class="o">+</span>k<span class="n">d1</span><span class="o">+</span>k<span class="n">d2</span><span class="p">,</span> <span class="cp">$IPADDRESS</span><span class="p">,</span> <span class="cp">$PORT</span><span class="p">,</span> <span class="s">"/midi"</span><span class="p">,</span> <span class="s">"iiii"</span><span class="p">,</span> k<span class="n">st</span><span class="p">,</span> k<span class="n">ch</span><span class="p">,</span> k<span class="n">d1</span><span class="p">,</span> k<span class="n">d2</span>
<span class="kd">endin</span>
<span class="nt"></CsInstruments></span>
<span class="nt"><CsScore></span>
<span class="nb">f</span> <span class="mi">0</span> <span class="mi">3600</span> <span class="c1">;Dummy f-table</span>
<span class="nb">e</span>
<span class="nt"></CsScore></span>
<span class="nt"></CsoundSynthesizer></span>
</pre>
</div>
<p>CSD file to receive OSC messages:</p>
<div class="refsect1">
<a id="idm281472731429672"></a>
<pre class="programlisting">
<span class="nt"><CsoundSynthesizer></span>
<span class="c1">; network_recv.csd</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="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">128</span>
<span class="vg">nchnls</span> <span class="o">=</span> <span class="mi">1</span>
<span class="c1">; Example by Jonathan Murphy and Andres Cabrera 2007</span>
<span class="c1">; Use file OSCmidisend.csd to generate OSC events for this file</span>
<span class="vg">0dbfs</span> <span class="o">=</span> <span class="mi">1</span>
gi<span class="n">listen</span> <span class="nb">OSCinit</span> <span class="mi">47120</span>
gi<span class="n">sin</span> <span class="nb">ftgen</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">16384</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">1</span>
gi<span class="n">vel</span> <span class="nb">ftgen</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">128</span><span class="p">,</span> <span class="o">-</span><span class="mi">2</span><span class="p">,</span> <span class="mi">0</span>
gi<span class="n">cc</span> <span class="nb">ftgen</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">128</span><span class="p">,</span> <span class="o">-</span><span class="mi">7</span><span class="p">,</span> <span class="mi">100</span><span class="p">,</span> <span class="mi">128</span><span class="p">,</span> <span class="mi">100</span> <span class="c1">;Default all controllers to 100</span>
<span class="c1">;Define scale tuning</span>
gi<span class="n">ji_12</span> <span class="nb">ftgen</span> <span class="mi">202</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">32</span><span class="p">,</span> <span class="o">-</span><span class="mi">2</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">256</span><span class="p">,</span> <span class="mi">60</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">16</span><span class="o">/</span><span class="mi">15</span><span class="p">,</span> <span class="mi">9</span><span class="o">/</span><span class="mi">8</span><span class="p">,</span> <span class="mi">6</span><span class="o">/</span><span class="mi">5</span><span class="p">,</span> <span class="mi">5</span><span class="o">/</span><span class="mi">4</span><span class="p">,</span> <span class="mi">4</span><span class="o">/</span><span class="mi">3</span><span class="p">,</span> <span class="mi">7</span><span class="o">/</span><span class="mi">5</span><span class="p">,</span> \
<span class="mi">3</span><span class="o">/</span><span class="mi">2</span><span class="p">,</span> <span class="mi">8</span><span class="o">/</span><span class="mi">5</span><span class="p">,</span> <span class="mi">5</span><span class="o">/</span><span class="mi">3</span><span class="p">,</span> <span class="mi">9</span><span class="o">/</span><span class="mi">5</span><span class="p">,</span> <span class="mi">15</span><span class="o">/</span><span class="mi">8</span><span class="p">,</span> <span class="mi">2</span>
<span class="cp">#define</span> <span class="cp">DEST</span> <span class="p">#</span><span class="cp">"/midi"</span><span class="p">#</span>
<span class="c1">; Use controller number 7 for volume</span>
<span class="cp">#define</span> <span class="cp">VOL</span> <span class="p">#</span><span class="cp">7</span><span class="p">#</span>
<span class="nb">turnon</span> <span class="mi">1000</span>
<span class="kd">instr</span> <span class="nf">1000</span>
k<span class="n">st</span> <span class="nb">init</span> <span class="mi">0</span>
k<span class="n">ch</span> <span class="nb">init</span> <span class="mi">0</span>
k<span class="n">d1</span> <span class="nb">init</span> <span class="mi">0</span>
k<span class="n">d2</span> <span class="nb">init</span> <span class="mi">0</span>
<span class="nl">next</span><span class="p">:</span>
k<span class="n">k</span> <span class="nb">OSClisten</span> gi<span class="n">listen</span><span class="p">,</span> <span class="cp">$DEST</span><span class="p">,</span> <span class="s">"iiii"</span><span class="p">,</span> k<span class="n">st</span><span class="p">,</span> k<span class="n">ch</span><span class="p">,</span> k<span class="n">d1</span><span class="p">,</span> k<span class="n">d2</span>
<span class="k">if</span> <span class="p">(</span>k<span class="n">k</span> <span class="o">==</span> <span class="mi">0</span><span class="p">)</span> <span class="k">goto</span> <span class="nl">done</span>
<span class="nb">printks</span> <span class="s">"kst = </span><span class="si">%i</span><span class="s">, kch = </span><span class="si">%i</span><span class="s">, kd1 = </span><span class="si">%i</span><span class="s">, kd2 = </span><span class="si">%i</span><span class="se">\\</span><span class="s">n"</span><span class="p">,</span> \
<span class="mi">0</span><span class="p">,</span> k<span class="n">st</span><span class="p">,</span> k<span class="n">ch</span><span class="p">,</span> k<span class="n">d1</span><span class="p">,</span> k<span class="n">d2</span>
<span class="k">if</span> <span class="p">(</span>k<span class="n">st</span> <span class="o">==</span> <span class="mi">176</span><span class="p">)</span> <span class="k">then</span>
<span class="c1">;Store controller information in a table</span>
<span class="nb">tablew</span> k<span class="n">d2</span><span class="p">,</span> k<span class="n">d1</span><span class="p">,</span> gi<span class="n">cc</span>
<span class="k">endif</span>
<span class="k">if</span> <span class="p">(</span>k<span class="n">st</span> <span class="o">==</span> <span class="mi">144</span><span class="p">)</span> <span class="k">then</span>
<span class="c1">;Process noteon and noteoff messages.</span>
k<span class="n">key</span> <span class="o">=</span> k<span class="n">d1</span>
k<span class="n">vel</span> <span class="o">=</span> k<span class="n">d2</span>
k<span class="n">cps</span> <span class="nb">cpstun</span> k<span class="n">vel</span><span class="p">,</span> k<span class="n">key</span><span class="p">,</span> gi<span class="n">ji_12</span>
k<span class="n">amp</span> <span class="o">=</span> k<span class="n">vel</span><span class="o">/</span><span class="mi">127</span>
<span class="k">if</span> <span class="p">(</span>k<span class="n">vel</span> <span class="o">==</span> <span class="mi">0</span><span class="p">)</span> <span class="k">then</span>
<span class="nb">turnoff2</span> <span class="mi">1001</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">1</span>
<span class="k">elseif</span> <span class="p">(</span>k<span class="n">vel</span> <span class="o">></span> <span class="mi">0</span><span class="p">)</span> <span class="k">then</span>
<span class="nb">event</span> <span class="s">"i"</span><span class="p">,</span> <span class="mi">1001</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> k<span class="n">cps</span><span class="p">,</span> k<span class="n">amp</span>
<span class="k">endif</span>
<span class="k">endif</span>
<span class="k">kgoto</span> <span class="nl">next</span> <span class="c1">;Process all events in queue</span>
<span class="nl">done</span><span class="p">:</span>
<span class="kd">endin</span>
<span class="kd">instr</span> <span class="nf">1001</span> <span class="c1">;Simple instrument</span>
i<span class="n">cps</span> <span class="nb">init</span> <span class="nb">p4</span>
k<span class="n">vol</span> <span class="nb">table</span> <span class="cp">$VOL</span><span class="p">,</span> gi<span class="n">cc</span> <span class="c1">;Read MIDI volume from controller table</span>
k<span class="n">vol</span> <span class="o">=</span> k<span class="n">vol</span><span class="o">/</span><span class="mi">127</span>
a<span class="n">env</span> <span class="nb">linsegr</span> <span class="mi">0</span><span class="p">,</span> <span class="mf">.003</span><span class="p">,</span> <span class="nb">p5</span><span class="p">,</span> <span class="mf">0.03</span><span class="p">,</span> <span class="nb">p5</span> <span class="o">*</span> <span class="mf">0.5</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">,</span> <span class="mi">0</span>
a<span class="n">osc</span> <span class="nb">oscil</span> a<span class="n">env</span><span class="p">,</span> i<span class="n">cps</span><span class="p">,</span> gi<span class="n">sin</span>
<span class="nb">out</span> a<span class="n">osc</span> <span class="o">*</span> k<span class="n">vol</span>
<span class="kd">endin</span>
<span class="nt"></CsInstruments></span>
<span class="nt"><CsScore></span>
<span class="nb">f</span> <span class="mi">0</span> <span class="mi">3600</span> <span class="c1">;Dummy f-table</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="idm281472908423112"></a>
<h2>See Also</h2>
<p>
<a class="link" href="OSCsend.html" title="OSCsend"><em class="citetitle">OSCsend</em></a>,
<a class="link" href="OSCinit.html" title="OSCinit"><em class="citetitle">OSCinit</em></a>
</p>
<p> More information on this opcode: <a class="ulink" href="http://www.youtube.com/watch?v=JX1C3TqP_9Y" target="_top"><em class="citetitle">http://www.youtube.com/watch?v=JX1C3TqP_9Y</em></a> , made by Andrés Cabrera </p>
</div>
<div class="refsect1">
<a id="idm281472908418712"></a>
<h2>Credits</h2>
<p>
</p>
<table border="0" summary="Simple list" class="simplelist">
<tr>
<td>Author: John ffitch</td>
</tr>
<tr>
<td>2005</td>
</tr>
<tr>
<td>Examples by: David Akbari, Andrés Cabrera and Jonathan Murphy 2007</td>
</tr>
</table>
<p>
</p>
<p>types aAG are new in Csound 6.07</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="OSCinit.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="OSCraw.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">OSCinit </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> OSCraw</td>
</tr>
</table>
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
5fcfcb7517038d1f44ab4e478e6e61fa
>
files
>
225
