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

« back to all changes in this revision

Viewing changes to opcodes/pvstanal.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
<refentry id="pvstanal">
 
2
<indexterm id="IndexPvstanal"><primary>pvstanal</primary></indexterm>
 
3
  <refentryinfo><title>Spectral processing: pvstanal</title></refentryinfo>
 
4
  <refmeta>
 
5
    <refentrytitle>pvstanal</refentrytitle>
 
6
  </refmeta>
 
7
 
 
8
 
 
9
 
 
10
  <refnamediv>
 
11
    <refname>pvstanal</refname>
 
12
    <refpurpose>
 
13
Phase vocoder analysis processing with onset detection/processing.
 
14
          </refpurpose>
 
15
  </refnamediv>
 
16
  
 
17
  <refsect1>
 
18
    <title>Description</title>
 
19
    <para>
 
20
<emphasis>pvstanal</emphasis> implements phase vocoder analysis by reading function tables
 
21
containing sampled-sound sources, with <link linkend="GEN01"><citetitle>GEN01</citetitle></link>, and
 
22
<emphasis>pvstanal</emphasis> will accept deferred allocation tables.
 
23
  </para>
 
24
  <para>
 
25
This opcode allows for time and frequency-independent scaling. Time is advanced internally, but controlled by a tempo scaling parameter; when an onset is detected, timescaling is momentarily stopped to avoid smearing of attacks. The quality of the effect is generally improved with phase locking switched on. 
 
26
  </para>
 
27
  <para>
 
28
<emphasis>pvstanal</emphasis> will also scale pitch, independently of frequency, using a transposition factor (k-rate).
 
29
  </para>
 
30
  </refsect1>
 
31
 
 
32
  <refsect1>
 
33
    <title>Syntax</title>
 
34
    <synopsis>asig <command>pvstanal</command> ktimescal,kamp,kpitch,ktab,[kdetect, kwrap, ioffset,ifftsize, ihop, ithresh]
 
35
      </synopsis>
 
36
  </refsect1>
 
37
 
 
38
  <refsect1>
 
39
    <title>Initialization</title>
 
40
      <para>
 
41
      <emphasis>ifftsize</emphasis> -- FFT size (power-of-two), defaults to 2048.
 
42
    </para>
 
43
              <para>
 
44
      <emphasis>ihop</emphasis> -- hopsize, defaults to 512
 
45
    </para>
 
46
<para>
 
47
      <emphasis>ioffset</emphasis> -- startup read offset into table, in secs.
 
48
    </para>
 
49
 
 
50
                      <para>
 
51
      <emphasis>idbthresh</emphasis> -- threshold based on dB power spectrum ratio between two successive windows. A detected ratio above it will cancel timescaling momentarily, to avoid smearing (defaults to 1)
 
52
    </para>
 
53
        
 
54
  </refsect1>
 
55
  
 
56
  <refsect1>
 
57
    <title>Performance</title>
 
58
  <para>
 
59
      <emphasis>ktimescal</emphasis> -- timescaling ratio, &lt; 1 stretch, > 1 contract.
 
60
    </para>
 
61
    <para>
 
62
      <emphasis>kamp</emphasis> -- amplitude scaling
 
63
    </para>
 
64
    <para>
 
65
      <emphasis>kpitch</emphasis> -- grain pitch scaling (1=normal pitch, &lt; 1 lower, > 1 higher; negative, backwards)
 
66
    </para>
 
67
 
 
68
    <para>
 
69
      <emphasis>kdetect</emphasis> -- 0 or 1, to switch onset detection/processing
 
70
    </para>
 
71
    <para>
 
72
      <emphasis>ktab</emphasis> -- source signal function table. Deferred-allocation tables (see
 
73
      <link linkend="GEN01"><citetitle>GEN01</citetitle></link>) are accepted, but the opcode
 
74
      expects a mono source. Tables can be switched at k-rate.
 
75
    </para>
 
76
 <para>
 
77
      <emphasis>kwrap</emphasis> -- 0 or 1, to switch on/off table wrap-around read (default to 1)
 
78
    </para>
 
79
 
 
80
  </refsect1>
 
81
  <refsect1>
 
82
    <title>Examples</title>
 
83
    <para>
 
84
      <example>
 
85
        <title>Example</title>
 
86
        <programlisting>
 
87
                
 
88
idur = p3
 
89
ilock = p4
 
90
itab = 1
 
91
ipitch = 1
 
92
iamp = 0.8
 
93
ktime linseg 0.3, p3/2, 0.8, p3/2, 0.3
 
94
 
 
95
fs1 pvstanal ktime,iamp,ipitch,itab
 
96
a1 pvsynth fs1
 
97
   out a1
 
98
    
 
99
 
 
100
   </programlisting>
 
101
      </example>
 
102
 
 
103
    </para>
 
104
    
 
105
 
 
106
  </refsect1>
 
107
 
 
108
 
 
109
 
 
110
  <refsect1>
 
111
    <title>Credits</title>
 
112
    <para>
 
113
      <simplelist>
 
114
        <member>Author: &namevictor;</member>
 
115
        <member>February 2010</member>
 
116
      </simplelist>
 
117
    </para>
 
118
 
 
119
    <para>New plugin in version 5.13</para>
 
120
    <para>February 2005.</para>
 
121
  </refsect1>
 
122
</refentry>