HelpSource/Classes/DecodeB2.schelp

   1 class:: DecodeB2
   2 summary:: 2D Ambisonic B-format decoder.
   3 related:: Classes/BiPanB2, Classes/PanB, Classes/PanB2, Classes/Rotate2
   4 categories::  UGens>Multichannel>Ambisonics
   5
   6
   7 Description::
   8
   9 Decode a two dimensional ambisonic B-format signal to a set of speakers
  10 in a regular polygon. The outputs will be in clockwise order. The
  11 position of the first speaker is either center or left of center.
  12
  13
  14 classmethods::
  15
  16 method::ar, kr
  17
  18 argument::numChans
  19
  20 Number of output speakers. Typically 4 to 8.
  21
  22
  23 argument::w
  24
  25 The B-format signal.
  26
  27
  28 argument::x
  29
  30 The B-format signal.
  31
  32
  33 argument::y
  34
  35 The B-format signal.
  36
  37
  38 argument::orientation
  39
  40 Should be zero if the front is a vertex of the polygon. The first
  41 speaker will be directly in front. Should be 0.5 if the front
  42 bisects a side of the polygon. Then the first speaker will be the
  43 one left of center.
  44
  45 returns::
  46 An array of channels, one for each speaker.
  47
  48 Examples::
  49
  50 code::
  51
  52 (
  53 {
  54         var w, x, y, p, a, b, c, d;
  55
  56         p = PinkNoise.ar; // source
  57
  58         // B-format encode
  59         #w, x, y = PanB2.ar(p, MouseX.kr(-1,1), 0.1);
  60
  61         // B-format decode to quad
  62         #a, b, c, d = DecodeB2.ar(4, w, x, y);
  63
  64         [a, b, d, c] // reorder to my speaker arrangement: Lf Rf Lr Rr
  65 }.play;
  66 )
  67
  68 ::
  69