summaryrefslogtreecommitdiff
path: root/opcodes/butterbr.xml
blob: 992015e3cdd97d4ce47256eaba392ef72f551c1c (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
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
92
93
94
<refentry id="butterbr">
<indexterm id="IndexButterbr"><primary>butterbr</primary></indexterm>
  <refentryinfo><title>Signal Modifiers:Standard Filters</title></refentryinfo>
  <refmeta>
    <refentrytitle>butterbr</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>butterbr</refname>
    <refpurpose>
      A band-reject Butterworth filter.
          </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Implementation of a second-order band-reject Butterworth filter. This opcode can also be written as <link linkend="butbr"><citetitle>butbr</citetitle></link>.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>ares <command>butterbr</command> asig, xfreq, xband [, iskip]</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>iskip</emphasis> (optional, default=0) -- Skip initialization if present and non-zero.
    </para>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      These filters are Butterworth second-order IIR filters. They are slightly slower than the original filters in Csound, but they offer an almost flat passband and very good precision and stopband attenuation.
    </para>

    <para>
      <emphasis>asig</emphasis> -- Input signal to be filtered.
    </para>

    <para>
      <emphasis>xfreq</emphasis> -- Cutoff or center frequency for each of the filters.
    </para>

    <para>
      <emphasis>xband</emphasis> -- Bandwidth of the bandpass and bandreject filters.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the butterbr opcode. It uses the file <ulink url="examples/butterbr.csd"><citetitle>butterbr.csd</citetitle></ulink>.

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

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="butterbp"><citetitle>butterbp</citetitle></link>,
      <link linkend="butterhp"><citetitle>butterhp</citetitle></link>,
      <link linkend="butterlp"><citetitle>butterlp</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &nameparis;</member>
        <member>MIT, Cambridge</member>
        <member>1995</member>
      </simplelist>
    </para>
    <para>Existed in 3.30</para>
    <para>Audio rate parameters introduced in version 6.02</para>
    <para>October 2013.</para>
  </refsect1>
</refentry>