summaryrefslogtreecommitdiff
path: root/opcodes/dbfsamp.xml
blob: d09eba6791afdb3ce31d7faa3cb61c2a2021b63f (plain)
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
<refentry id="dbfsamp">
<indexterm id="IndexDbfsamp"><primary>dbfsamp</primary></indexterm>
  <refentryinfo><title>Mathematical Operations:Amplitude Functions</title></refentryinfo>
  <refmeta>
    <refentrytitle>dbfsamp</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>dbfsamp</refname>

    <refpurpose>
      Returns the decibel equivalent of the raw amplitude <emphasis>x</emphasis>, relative to full scale amplitude.
          </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Returns the decibel equivalent of the raw amplitude <emphasis>x</emphasis>, relative to full scale amplitude. Full scale is assumed to be 16 bit. New is Csound version 4.10.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis><command>dbfsamp</command>(x)  (init-rate or control-rate args only)</synopsis>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the dbfsamp opcode. It uses the file <ulink url="examples/dbfsamp.csd"><citetitle>dbfsamp.csd</citetitle></ulink>.

      <example>
        <title>Example of the dbfsamp 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/dbfsamp.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>

      Its output should include lines like this:
      <screen>instr 1:  idb = -0.767</screen>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="ampdb"><citetitle>ampdb</citetitle></link>,
      <link linkend="ampdbfs"><citetitle>ampdbfs</citetitle></link>,
      <link linkend="dbamp"><citetitle>dbamp</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>Example written by &namekevin;.</para>
  </refsect1>
</refentry>