summaryrefslogtreecommitdiff
path: root/opcodes/plltrack.xml
blob: e88c5596b532ddcb22566ab99f4c48c8ca077823 (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
95
<refentry id="plltrack">
  <indexterm id="Indexplltrack"><primary>plltrack</primary></indexterm>
  <refentryinfo><title>Instrument Control:Sensing and Control</title></refentryinfo>
  <refmeta>
    <refentrytitle>plltrack</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>plltrack</refname>
    <refpurpose>
      Tracks the pitch of a signal.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      <emphasis>plltrack</emphasis>, a pitch tracker based on a phase-locked loop algorithm, described in Zolzer, U, Sankarababu, S.V. and Moller, S, "PLL-based Pitch Detection and Tracking for Audio Signals. Proc. of IIH-MSP 2012".
      </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis>acps, alock <command>plltrack</command> asig, kd [, kloopf, kloopq, klf, khf, kthresh]</synopsis>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>acps</emphasis> -- estimated pitch in Hz.
    </para>

    <para>
      <emphasis>alock</emphasis> -- phase lock indicator, a phase error indicating the quality of the tracking, with values between 0 and 1. Higher values
indicate good tracking
    </para>

<para>
      <emphasis>kd</emphasis> -- PLL feedback gain, controls frequency range of PLL (between 0 and 1). Higher values increase the range of the tracking.
    </para>

<para>
      <emphasis>kloopf</emphasis> -- PLL LP filter cf, controls frequency range of PLL (opt, defaults to 20Hz).
    </para>

<para>
      <emphasis>kloopq</emphasis> -- PLL LP filter Q, controls rise time of FO step (opt, defaults to 1/3)
    </para>

<para>
      <emphasis>klf</emphasis> -- lowest tracking freq (opt, defaults to 20Hz)
    </para>

<para>
      <emphasis>khf</emphasis> -- highest tracking freq (opt, defaults to 1500Hz)
    </para>

<para>
      <emphasis>kthresh</emphasis> --  tracking signal level threshold (optional, defaults to 0.001, equiv to -60dBfs)
    </para>

    <para>
      <emphasis>plltrack</emphasis> analyzes the input signal, <emphasis>asig</emphasis>, 
      estimating the fundamental of a monophonic signal. Its output is updated every sample.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the plltrack operator. It uses the file <ulink url="examples/plltrack.csd"><citetitle>plltrack.csd</citetitle></ulink>.
      <example>
        <title>Example of the plltrack operator.</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/plltrack.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>


  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namevictor;</member>
        <member>NUI, Maynooth.</member>
        <member>Maynooth, Ireland</member>
        <member>September, 2012</member>
      </simplelist>
    </para>

    <para>New in Csound version 5.18.031</para>
  </refsect1>
</refentry>