~ubuntu-branches/ubuntu/trusty/csound-manual/trusty-proposed

« back to all changes in this revision

Viewing changes to opcodes/pvslock.xml

  • Committer: Bazaar Package Importer
  • Author(s): Felipe Sateler
  • Date: 2011-08-01 22:21:58 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20110801222158-90kslkp5ujci2f5d
Tags: 1:5.13~dfsg-1
* New upstream release
 - Add Menno Knevel to the copyright file
 - Refresh patch 2000-stripped-opcodes.diff
 - Update copyright hints file
* Update Vcs-* headers
* Bump Standards-Version

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
<refentry id="pvslock">
 
3
<indexterm id="IndexPvslock"><primary>pvslock</primary></indexterm>
 
4
  <refentryinfo><title>Spectral Processing:Streaming</title></refentryinfo>
 
5
  <refmeta>
 
6
    <refentrytitle>pvslock</refentrytitle>
 
7
  </refmeta>
 
8
 
 
9
 
 
10
 
 
11
  <refnamediv>
 
12
    <refname>pvslock</refname>
 
13
    <refpurpose>
 
14
      Frequency lock an input fsig
 
15
          </refpurpose>
 
16
  </refnamediv>
 
17
  
 
18
  <refsect1>
 
19
    <title>Description</title>
 
20
    <para>
 
21
      This opcode searches for spectral peaks and then locks the frequencies around those peaks. This is similar to
 
22
phase-locking in non-streaming PV processing. It can be used to improve timestretching and pitch-shifting quality in
 
23
PV processing.
 
24
    </para>
 
25
  </refsect1>
 
26
 
 
27
  <refsect1>
 
28
    <title>Syntax</title>
 
29
    <synopsis>fsig <command>pvslock</command> fsigin, klock</synopsis>
 
30
  </refsect1>
 
31
 
 
32
  <refsect1>
 
33
    <title>Performance</title>
 
34
    <para>
 
35
      <emphasis>fsig</emphasis> -- output pv stream
 
36
    </para>
 
37
 
 
38
    <para>
 
39
      <emphasis>fsigin</emphasis> -- input pv stream.
 
40
    </para>
 
41
 
 
42
    <para>
 
43
      <emphasis>klock</emphasis> -- frequency lock, 1 -> lock, 0 -> unlock (bypass).
 
44
    </para>
 
45
    <warning>
 
46
      <para>
 
47
        It is unsafe to use the same f-variable for both input and output of pvs opcodes. Using the same one might lead to undefined behavior on some opcodes. Use a different one on the left and right sides of the opcode.
 
48
      </para>
 
49
    </warning>
 
50
 
 
51
  </refsect1>
 
52
 
 
53
  <refsect1>
 
54
    <title>Examples</title>
 
55
    <para>
 
56
      <example>
 
57
        <title>Example</title>
 
58
        <programlisting>
 
59
fsig1   pvstanal  kspeed,1,1,1  ; pvoc analysis from table 1 (kspeed is timescale factor) 
 
60
fsigout pvslock  fsig1, 1         ; frequency lock
 
61
aout    pvsynth fsigout              ; pvoc synthesis
 
62
        </programlisting>
 
63
      </example>
 
64
 
 
65
 
 
66
    </para>
 
67
    
 
68
    <para>Depending on the input, this will transform a pitched sound into an inharmonic,
 
69
bell-like sound.</para>
 
70
    
 
71
  </refsect1>
 
72
 
 
73
  <refsect1>
 
74
    <title>Credits</title>
 
75
    <para>
 
76
      <simplelist>
 
77
        <member>Author: &namevictor;</member>
 
78
        <member>November 2004 </member>
 
79
      </simplelist>
 
80
    </para>
 
81
 
 
82
    <para>New plugin in version 5</para>
 
83
    <para>Nivember 2004.</para>
 
84
  </refsect1>
 
85
</refentry>