-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added undersample page and corrected oversample text
- Loading branch information
vlazzarini
committed
Mar 20, 2024
1 parent
5762ff5
commit a1bf7ca
Showing
4 changed files
with
82 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
|
||
<refentry id="undersample"> | ||
<indexterm id="IndexUndersample"><primary>undersample</primary></indexterm> | ||
<refentryinfo><title>Signal I/O:Software Bus</title></refentryinfo> | ||
<refmeta> | ||
<refentrytitle>undersample</refentrytitle> | ||
</refmeta> | ||
|
||
<refnamediv> | ||
<refname>undersample</refname> | ||
<refpurpose> | ||
Sets a lower local sampling rate based on an undersampling factor. | ||
</refpurpose> | ||
</refnamediv> | ||
|
||
<refsect1> | ||
<title>Description</title> | ||
<para> | ||
Sets the local sampling rate value in a user-defined opcode block. | ||
</para> | ||
</refsect1> | ||
|
||
<refsect1> | ||
<title>Syntax</title> | ||
<synopsis><command>undersample</command> ifactor[,imode] </synopsis> | ||
</refsect1> | ||
|
||
<refsect1> | ||
<title>Initialization</title> | ||
<para> | ||
<emphasis>ifactor</emphasis> -- sets the undersampling factor. It | ||
needs to be a positive integer > 1. A factor of 1 is a non-op, | ||
zero or negative factors are illegal. The local sampling rate is | ||
set as (1/ifactor) * sr. The value of the sr variable is then | ||
changed locally. Local ksmps is also changed accordingly. | ||
</para> | ||
<para> | ||
<emphasis>imode</emphasis> -- resampling mode: if Secret | ||
Rabbit Code is used, then 0 - best quality sync (default); 1 - medium | ||
quality sync; 2 - fast sync; 3 - zero-order hold; and 4 - linear. | ||
</para> | ||
|
||
<note> | ||
<title>Note</title> | ||
<para> | ||
Calling this opcode in the same UDO as setksmps is not | ||
allowed. | ||
The opcode can only be used in UDOs. Audio or control rate array arguments | ||
are not allowed. Global variables or bus channels should not be used. | ||
</para> | ||
</note> | ||
</refsect1> | ||
|
||
<refsect1> | ||
<title>See Also</title> | ||
<para> | ||
<link linkend="endop"><citetitle>endop</citetitle></link>, | ||
<link linkend="opcode"><citetitle>opcode</citetitle></link>, | ||
<link linkend="xin"><citetitle>xin</citetitle></link>, | ||
<link linkend="xout"><citetitle>xout</citetitle></link> | ||
</para> | ||
</refsect1> | ||
|
||
<refsect1> | ||
<title>Credits</title> | ||
<para>Author: Victor Lazzarini</para> | ||
<para>New in version 7.0</para> | ||
</refsect1> | ||
</refentry> |