<?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>dumpk</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="dssilist.html" title="dssilist" />
<link rel="next" href="dumpk2.html" title="dumpk2" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">dumpk</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dssilist.html">Prev</a> </td>
<th width="60%" align="center">Orchestra Opcodes and Operators</th>
<td width="20%" align="right"> <a accesskey="n" href="dumpk2.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="refentry">
<a id="dumpk"></a>
<div class="titlepage"></div>
<a id="IndexDumpk" class="indexterm"></a>
<div class="refnamediv">
<h2>
<span class="refentrytitle">dumpk</span>
</h2>
<p>dumpk —
Periodically writes an orchestra control-signal value to an external file.
</p>
</div>
<div class="refsect1">
<a id="idm281472940524504"></a>
<h2>Description</h2>
<p>
Periodically writes an orchestra control-signal value to a named external file in a specific format.
</p>
</div>
<div class="refsect1">
<a id="idm281472940523192"></a>
<h2>Syntax</h2>
<pre class="synopsis"><span class="command"><strong>dumpk</strong></span> ksig, ifilname, iformat, iprd</pre>
</div>
<div class="refsect1">
<a id="idm281472940459544"></a>
<h2>Initialization</h2>
<p>
<span class="emphasis"><em>ifilname</em></span> -- character string (in double quotes, spaces permitted) denoting the external file name. May either be a full path name with target directory specified or a simple filename to be created within the current directory
</p>
<p>
<span class="emphasis"><em>iformat</em></span> -- specifies the output data format:
</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<p>1 = 8-bit signed char(high order 8 bits of a 16-bit integer</p>
</li>
<li class="listitem">
<p>4 = 16-bit short integers</p>
</li>
<li class="listitem">
<p>5 = 32-bit long integers</p>
</li>
<li class="listitem">
<p>6 = 32-bit floats</p>
</li>
<li class="listitem">
<p>7 = ASCII long integers</p>
</li>
<li class="listitem">
<p>8 = ASCII floats (2 decimal places)</p>
</li>
</ul>
</div>
<p>
</p>
<p>
Note that A-law and U-law output are not available, and that all formats except the last two are binary. The output file contains no header information.
</p>
<p>
<span class="emphasis"><em>iprd</em></span> -- the period of <span class="emphasis"><em>ksig</em></span> output in seconds, rounded to the nearest orchestra control period. A value of 0 implies one control period (the enforced minimum), which will create an output file sampled at the orchestra control rate.
</p>
</div>
<div class="refsect1">
<a id="idm281472940449608"></a>
<h2>Performance</h2>
<p>
<span class="emphasis"><em>ksig</em></span> -- a control-rate signal
</p>
<p>
This opcode allows a generated control signal value to be saved in a named external file. The file contains no self-defining header information. But it contains a regularly sampled time series, suitable for later input or analysis. There may be any number of <span class="emphasis"><em>dumpk</em></span> opcodes in an instrument or orchestra but each must write to a different file.
</p>
</div>
<div class="refsect1">
<a id="idm281472940446776"></a>
<h2>Examples</h2>
<p>
Here is an example of the dumpk opcode. It uses the file <a class="ulink" href="examples/dumpk.csd" target="_top"><em class="citetitle">dumpk.csd</em></a>.
Note that the example must be run from a directory for which the
user has write access.
</p>
<div class="example">
<a id="idm281472940444824"></a>
<p class="title">
<strong>Example 229. Example of the dumpk 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="idm281472773016600"></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 dumpk.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">20</span>
<span class="vg">nchnls</span> <span class="o">=</span> <span class="mi">1</span>
<span class="c1">; By Andres Cabrera 2008</span>
<span class="kd">instr</span> <span class="nf">1</span>
<span class="c1">; Write fibonacci numbers to file "fibonacci.txt"</span>
<span class="c1">; as ascii long integers (mode 7), using the orchestra's</span>
<span class="c1">; control rate (iprd = 0)</span>
k<span class="n">number</span> <span class="nb">init</span> <span class="mi">0</span>
k<span class="n">oldnumber</span> <span class="nb">init</span> <span class="mi">1</span>
k<span class="n">trans</span> <span class="nb">init</span> <span class="mi">1</span>
k<span class="n">trans</span> <span class="o">=</span> k<span class="n">number</span>
k<span class="n">number</span> <span class="o">=</span> k<span class="n">number</span> <span class="o">+</span> k<span class="n">oldnumber</span>
k<span class="n">oldnumber</span> <span class="o">=</span> k<span class="n">trans</span>
<span class="nb">dumpk</span> k<span class="n">number</span><span class="p">,</span> <span class="s">"fibonacci.txt"</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">0</span>
<span class="nb">printk2</span> k<span class="n">number</span>
<span class="kd">endin</span>
<span class="nt"></CsInstruments></span>
<span class="nt"><CsScore></span>
<span class="c1">;Write to the file for 1 second. Since control rate is 20, 20 values will be written</span>
<span class="nb">i</span> <span class="mi">1</span> <span class="mi">0</span> <span class="mi">1</span>
<span class="nt"></CsScore></span>
<span class="nt"></CsoundSynthesizer></span>
</pre>
</div>
</div>
</div>
<p><br class="example-break" />
</p>
<p>
Here is another example of the dumpk opcode. It uses the file <a class="ulink" href="examples/dumpk-2.csd" target="_top"><em class="citetitle">dumpk-2.csd</em></a>.
</p>
<div class="example">
<a id="idm281472940439544"></a>
<p class="title">
<strong>Example 230. Example 2 of the dumpk opcode.</strong>
</p>
<div class="example-contents">
<div class="refsect1">
<a id="idm281472772922408"></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>
-odac <span class="c1">;;;realtime audio out</span>
<span class="c1">;-iadc ;;;uncomment -iadc if realtime audio input is needed too</span>
<span class="c1">; For Non-realtime ouput leave only the line below:</span>
<span class="c1">; -o dumpk-2.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">32</span>
<span class="vg">nchnls</span> <span class="o">=</span> <span class="mi">2</span>
<span class="vg">0dbfs</span> <span class="o">=</span> <span class="mi">1</span>
gi<span class="n">Sine</span> <span class="nb">ftgen</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="o">^</span><span class="mi">10</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">1</span>
<span class="kd">instr</span> <span class="nf">1</span> <span class="c1">;writes a control signal to a file</span>
k<span class="n">freq</span> <span class="nb">randh</span> <span class="mi">100</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">500</span> <span class="c1">;generates one random number between 400 and 600 per second</span>
<span class="nb">dumpk</span> k<span class="n">freq</span><span class="p">,</span> <span class="s">"dumpk.txt"</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">1</span> <span class="c1">;writes the control signal</span>
<span class="nb">printk</span> <span class="mi">1</span><span class="p">,</span> k<span class="n">freq</span> <span class="c1">;prints it</span>
<span class="kd">endin</span>
<span class="kd">instr</span> <span class="nf">2</span> <span class="c1">;reads the file written by instr 1</span>
k<span class="n">freq</span> <span class="nb">readk</span> <span class="s">"dumpk.txt"</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">1</span>
<span class="nb">printk</span> <span class="mi">1</span><span class="p">,</span> k<span class="n">freq</span> <span class="c1">;prints it</span>
a<span class="n">out</span> <span class="nb">poscil</span> <span class="mf">.2</span><span class="p">,</span> k<span class="n">freq</span><span class="p">,</span> gi<span class="n">Sine</span>
<span class="nb">outs</span> a<span class="n">out</span><span class="p">,</span> a<span class="n">out</span>
<span class="kd">endin</span>
<span class="nt"></CsInstruments></span>
<span class="nt"><CsScore></span>
<span class="nb">i</span> <span class="mi">1</span> <span class="mi">0</span> <span class="mi">5</span>
<span class="nb">i</span> <span class="mi">2</span> <span class="mi">5</span> <span class="mi">5</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">
WARNING: Seeding from current time 683384022
i 1 time 1.00033: 463.64510
i 1 time 2.00000: 463.64510
i 1 time 3.00000: 483.14200
i 1 time 4.00000: 567.55973
i 1 time 5.00000: 576.37060
i 1 time 6.00000: 460.66550
i 2 time 6.00033: 463.64510
i 2 time 7.00000: 463.64510
i 2 time 8.00000: 483.14200
i 2 time 9.00000: 567.55970
i 2 time 10.00000: 576.37060
i 2 time 11.00000: 460.66550</pre>
<p>
</p>
</div>
<div class="refsect1">
<a id="idm281472940435112"></a>
<h2>See Also</h2>
<p>
<a class="link" href="dumpk2.html" title="dumpk2"><em class="citetitle">dumpk2</em></a>,
<a class="link" href="dumpk3.html" title="dumpk3"><em class="citetitle">dumpk3</em></a>,
<a class="link" href="dumpk4.html" title="dumpk4"><em class="citetitle">dumpk4</em></a>,
<a class="link" href="readk.html" title="readk"><em class="citetitle">readk</em></a>,
<a class="link" href="readk2.html" title="readk2"><em class="citetitle">readk2</em></a>,
<a class="link" href="readk3.html" title="readk3"><em class="citetitle">readk3</em></a>,
<a class="link" href="readk4.html" title="readk4"><em class="citetitle">readk4</em></a>
</p>
</div>
<div class="refsect1">
<a id="idm281472940427240"></a>
<h2>Credits</h2>
<p>By: John ffitch and Barry L. Vercoe</p>
<p>1999 or earlier</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="dssilist.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="dumpk2.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">dssilist </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> dumpk2</td>
</tr>
</table>
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
5fcfcb7517038d1f44ab4e478e6e61fa
>
files
>
586
