Merge pull request #506 from andrewcsmith/patch-2
[supercollider.git] / HelpSource / Classes / BiPanB2.schelp
blob98e28b4838b71237506fd34c3d549b88fb2b5a48
1 class:: BiPanB2
2 summary:: 2D Ambisonic B-format panner.
3 related:: Classes/DecodeB2, Classes/PanB, Classes/PanB2, Classes/Rotate2
4 categories::  UGens>Multichannel>Ambisonics
7 Description::
9 Encode a two channel signal to two dimensional ambisonic B-format. This
10 puts two channels at opposite poles of a 2D ambisonic field. This is one
11 way to map a stereo sound onto a soundfield. It is equivalent to:
13 code::
14 PanB2(inA, azimuth, gain) + PanB2(inB, azimuth + 1, gain)
17 classmethods::
19 method::ar, kr
21 argument::inA
22 Input signal A
24 argument::inB
25 Input signal B.
27 argument::azimuth
28 Position around the circle from -1 to +1.
30 -1 is behind, -0.5 is left, 0 is forward, +0.5 is right, +1 is behind.
32 argument::gain
33 Amplitude control.
36 Examples::
38 code::
42         var w, x, y, p, q, a, b, c, d;
44         p = LFSaw.ar(200);
45         q = LFSaw.ar(301);
47         // B-format encode
48         #w, x, y = BiPanB2.ar(p, q, MouseX.kr(-1,1), 0.1);
50         // B-format decode to quad
51         #a, b, c, d = DecodeB2.ar(4, w, x, y);
53         [a, b, d, c] // reorder to my speaker arrangement: Lf Rf Lr Rr
54 }.play;