summaryrefslogtreecommitdiff
path: root/opcodes/trsplit.xml
diff options
context:
space:
mode:
Diffstat (limited to 'opcodes/trsplit.xml')
-rw-r--r--opcodes/trsplit.xml65
1 files changed, 25 insertions, 40 deletions
diff --git a/opcodes/trsplit.xml b/opcodes/trsplit.xml
index a7d0dd8..679deb9 100644
--- a/opcodes/trsplit.xml
+++ b/opcodes/trsplit.xml
@@ -7,26 +7,23 @@
<refentrytitle>trsplit</refentrytitle>
</refmeta>
-
-
<refnamediv>
<refname>trsplit</refname>
<refpurpose>
- Streaming partial track frequency splitting.
-
+ Streaming partial track frequency splitting.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
- The trsplit opcode takes an input containg a TRACKS pv streaming signal (as generated,
- for instance by partials) and splits it into two signals according to a k-rate frequency 'split point'.
- The first output will contain all tracks up from 0Hz to the split frequency and the second will
- contain the tracks from the split frequency up to the Nyquist.
- It can also, optionally, scale the gain of the output signals by a k-rate amount (default 1).
- The result is two output signals containing only part of the original spectrum.
- </para>
+ The <emphasis>trsplit</emphasis> opcode takes an input containg a TRACKS pv streaming signal (as generated,
+ for instance by <emphasis>partials</emphasis>) and splits it into two signals according to a k-rate frequency 'split point'.
+ The first output will contain all tracks up from 0Hz to the split frequency and the second will
+ contain the tracks from the split frequency up to the Nyquist.
+ It can also, optionally, scale the gain of the output signals by a k-rate amount (default 1).
+ The result is two output signals containing only part of the original spectrum.
+ </para>
</refsect1>
<refsect1>
@@ -36,55 +33,44 @@
<refsect1>
<title>Performance</title>
- <para>
+ <para>
<emphasis>fsiglow</emphasis> -- output pv stream in TRACKS format containing the tracks below
- the split point.
+ the split point.
</para>
+
<para>
- <emphasis>fsighi</emphasis> -- output pv stream in TRACKS format containing the tracks above and
- including the split point.
+ <emphasis>fsighi</emphasis> -- output pv stream in TRACKS format containing the tracks above and
+ including the split point.
</para>
-
+
<para>
<emphasis>fin</emphasis> -- input pv stream in TRACKS format
</para>
+
<para>
<emphasis>ksplit</emphasis> -- frequency split point in Hz
</para>
+
<para>
<emphasis>kgainlow, kgainhig</emphasis> -- amplitude scaling of each one of the
- outputs (default 1).
+ outputs (default 1).
</para>
- <para>
-
- </para>
-
</refsect1>
<refsect1>
<title>Examples</title>
<para>
+ Here is an example of the trsplit opcode. It uses the file <ulink url="examples/trsplit.csd"><citetitle>trsplit.csd</citetitle></ulink>.
<example>
- <title>Example</title>
- <programlisting>
-ain inch 1 ; input signal
-fs1,fsi2 pvsifd ain,2048,512,1 ; ifd analysis
-fst partials fs1,fsi2,.003,1,3,500 ; partial tracking
-fslo,fshi trsplit fst, 1500 ; split partial tracks at 1500 Hz
- aout tradsyn fshi, 1, 1, 500, 1 ; resynthesis of tracks above 1500Hz
-out aout
- </programlisting>
+ <title>Example of the trsplit opcode.</title>
+ <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
+ <xi:include href="examples-xml/trsplit.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</example>
-
-
- </para>
-
+ </para>
<para>
-The example above shows partial tracking of an ifd-analysis signal and
-linear additive resynthesis of the upper part of the spectrum (from 1500Hz).
-
+ The example above shows partial tracking of an ifd-analysis signal and
+ linear additive resynthesis of the upper part of the spectrum (from 1500Hz).
</para>
-
</refsect1>
<refsect1>
@@ -95,7 +81,6 @@ linear additive resynthesis of the upper part of the spectrum (from 1500Hz).
<member>February 2006 </member>
</simplelist>
</para>
- <para>New in Csound5.01</para>
-
+ <para>New in Csound 5.01</para>
</refsect1>
</refentry>