HelpSource/Classes/PitchShift.schelp

   1 class:: PitchShift
   2 summary:: Time domain pitch shifter.
   3 categories::  UGens>Filters>Pitch
   4
   5
   6 Description::
   7
   8 A time domain granular pitch shifter. Grains have a triangular amplitude
   9 envelope and an overlap of 4:1.
  10
  11
  12 classmethods::
  13
  14 method::ar
  15
  16 argument::in
  17
  18 The input signal.
  19
  20
  21 argument::windowSize
  22
  23 The size of the grain window in seconds. This value cannot be
  24 modulated.
  25
  26
  27 argument::pitchRatio
  28
  29 The ratio of the pitch shift. Must be from 0 to 4.
  30
  31
  32 argument::pitchDispersion
  33
  34 The maximum random deviation of the pitch from the
  35
  36 code::pitchRatio:: .
  37
  38
  39 argument::timeDispersion
  40
  41 A random offset of from zero to
  42
  43 code::timeDispersion::  seconds is added to the
  44 delay of each grain. Use of some dispersion can alleviate a hard
  45 comb filter effect due to uniform grain placement. It can also be
  46 an effect in itself.
  47 code::timeDispersion::  can be
  48 no larger than
  49 code::windowSize:: .
  50
  51
  52 argument::mul
  53
  54 Output will be multiplied by this value.
  55
  56
  57 argument::add
  58
  59 This value will be added to the output.
  60
  61
  62 Examples::
  63
  64 code::
  65
  66 (
  67 play({
  68         z = Blip.ar(800, 6, 0.1);
  69         PitchShift.ar(z, 0.02, Line.kr(0.1,4,20), 0, 0.0001)
  70 }))
  71
  72 (
  73 // pitch shift input - USE HEADPHONES to prevent feedback.
  74 play({
  75         PitchShift.ar(
  76                 AudioIn.ar([1,2]),      // stereo audio input
  77                 0.1,                    // grain size
  78                 MouseX.kr(0,2), // mouse x controls pitch shift ratio
  79                 0,                              // pitch dispersion
  80                 0.004                   // time dispersion
  81         )
  82 }))
  83
  84 (
  85 // use PitchShift to granulate input - USE HEADPHONES to prevent feedback.
  86 // upper left corner is normal playback. x = pitch dispersion, y = time dispersion
  87 var grainSize;
  88 grainSize = 0.5;
  89 play({
  90         PitchShift.ar(
  91                 AudioIn.ar([1,2]),
  92                 grainSize,
  93                 1,                                              // nominal pitch rate = 1
  94                 MouseX.kr(0,1),                         // pitch dispersion
  95                 MouseY.kr(0, grainSize) // time dispersion
  96         )
  97 }))
  98
  99 ::