/
ftom.xml
91 lines (77 loc) · 2.7 KB
/
ftom.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
<!--Change refentry id and indexterm id-->
<refentry id="ftom">
<indexterm id="IndexFtom"><primary>ftom</primary></indexterm>
<!--Make sure the category below is a valid one! See categories.py-->
<refentryinfo><title>Pitch Converters:Functions</title></refentryinfo>
<refmeta>
<refentrytitle>ftom</refentrytitle>
</refmeta>
<refnamediv>
<refname>ftom</refname>
<refpurpose>
Convert frequency to midi
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
Convert frequency to midi note number, taking global value
of A4 into account.
</para>
</refsect1>
<refsect1>
<title>Syntax</title>
<!-- Please keep this below ~70 characters by using backslashes
to avoid overflow in the pdf version-->
<synopsis>imidi <command>ftom</command> ifreq</synopsis>
<synopsis>kmidi <command>ftom</command> kfreq</synopsis>
</refsect1>
<refsect1>
<title>Performance</title>
<!-- First list all input and output performance parameters-->
<para>
<emphasis>kfreq</emphasis> / <emphasis>ifreq</emphasis> -- Frequency
</para>
<para>
<emphasis>kfmidi</emphasis> / <emphasis>imidi</emphasis> --
Corresponding midi note number
</para>
<note>
<para>
Set the global <link linkend="A4"><citetitle>A4</citetitle></link>
value at the header to modify the tuning
</para>
</note>
</refsect1>
<refsect1>
<!--To add examples, create the csd file in the examples directory, then run:-->
<!--python csd2docbook.py -f newopcodename.csd-->
<!--to generate the xml highlighted version used below-->
<title>Examples</title>
<para>
Here is an example of the ftom opcode. It uses the file <ulink url="examples/mtof-ftom.csd"><citetitle>mtof-ftom.csd</citetitle></ulink>.
<example>
<title>Example of the ftom opcode.</title>
<xi:include href="examples-xml/mtof-ftom.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</example>
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<!-- it's always good to include a good See Also list -->
<para>
<link linkend="cpsmidinn"><citetitle>cpsmidinn</citetitle></link>,
<link linkend="mtof"><citetitle>mtof</citetitle></link>
</para>
</refsect1>
<refsect1>
<!-- And put your name and other relevant information here-->
<title>Credits</title>
<para>By: &nameeduardo; 2017</para>
<para>New in version 6.09</para>
</refsect1>
<!--Now remember to add a link from the appropriate category in the Opcode Overview.-->
<!--Add the entity to manual.xml-->
<!--Add the entity reference in the appropriate place in opcodes/top.xml-->
<!--And you're set! Maybe delete the comments as well...-->
</refentry>