_Mappings.pde

   1 /**
   2  *     DOUBLE BLACK DIAMOND        DOUBLE BLACK DIAMOND
   3  *
   4  *         //\\   //\\                 //\\   //\\
   5  *        ///\\\ ///\\\               ///\\\ ///\\\
   6  *        \\\/// \\\///               \\\/// \\\///
   7  *         \\//   \\//                 \\//   \\//
   8  *
   9  *        EXPERTS ONLY!!              EXPERTS ONLY!!
  10  *
  11  * This file implements the mapping functions needed to lay out the physical
  12  * cubes and the output ports on the panda board. It should only be modified
  13  * when physical changes or tuning is being done to the structure.
  14  */
  15
  16 public Model buildModel() {
  17
  18   // Shorthand helpers for specifying wiring more quickly
  19   final Cube.Wiring WFL = Cube.Wiring.FRONT_LEFT;
  20   final Cube.Wiring WFR = Cube.Wiring.FRONT_RIGHT;
  21   final Cube.Wiring WRL = Cube.Wiring.REAR_LEFT;
  22   final Cube.Wiring WRR = Cube.Wiring.REAR_RIGHT;
  23
  24   // Utility value if you need the height of a cube shorthand
  25   final float CH = Cube.EDGE_HEIGHT;
  26   final float CW = Cube.EDGE_WIDTH ;
  27
  28
  29
  30   // Positions for the bass box
  31   final float BBY = BassBox.EDGE_HEIGHT + BoothFloor.PLEXI_WIDTH;
  32   final float BBX = 56;
  33   final float BBZ = 2;
  34
  35   // The model is represented as an array of towers. The cubes in the tower
  36   // are represenented relatively. Each tower has an x, y, z reference position,
  37   // which is typically the base cube's bottom left corner.
  38   //
  39   // Following that is an array of floats. A 2-d array contains an x-offset
  40   // and a z-offset from the previous reference position. Typically the first cube
  41   // will just be {0, 0}. Each successive cube uses the position of the previous
  42   // cube as its reference.
  43   //
  44   // A 3-d array contains an x-offset, a z-offset, and a rotation about the
  45   // y-axis.
  46   //
  47   // The cubes automatically increment their y-position by Cube.EDGE_HEIGHT.
  48
  49   // To-Do:  (Mark Slee, Alex Green, or Ben Morrow):   The Cube # is determined by the order in this list.
  50   // "raw object index" is serialized by running through towermapping and then individual cube mapping below.
  51   //  We can do better than this.  The raw object index should be obvious from the code-- looking through the
  52   //  rendered simulation and counting through cubes in mapping mode is grossly inefficient.
  53
  54
  55   ////////////////////////////////////////////////////////////////////////
  56   // dan's proposed lattice
  57   ArrayList<StaggeredTower> scubes = new ArrayList<StaggeredTower>();
  58   if (NumBackTowers != 9) exit();
  59   for (int i=0; i<NumBackTowers; i++) scubes.add(new StaggeredTower(
  60       (i+1)*CW,               // x
  61       (i % 2 == 0) ? 0 : CH * 2./3.   ,   // y
  62      - ((i % 2 == 0) ? 0 : 11) + 97   ,   // z
  63      -135, (i % 2 == 0) ? MaxCubeHeight : MaxCubeHeight-1) );  // num cubes
  64
  65   ArrayList<Cube> dcubes = new ArrayList<Cube>();
  66   for (int i=1; i<6; i++) {
  67     if (i>1) dcubes.add(new Cube(-6+CW*4/3*i             , 0, 0, 0, 0, 0, WRR));
  68          dcubes.add(new Cube(-6+CW*4/3*i+CW*2/3., CH*.5, 0, 0, 0, 0, WRR));
  69   }
  70
  71
  72   TowerMapping[] towerCubes = new TowerMapping[] {};
  73
  74   // Single cubes can be constructed directly here if you need them
  75   Cube[] singleCubes = new Cube[] {
  76      //new Cube(15, int( Cube.EDGE_HEIGHT), 39, 0, 10, 0,  WRL),     // Back left channel behind speaker
  77      //new Cube(x, y, z, rx, ry, rz, wiring),
  78      //new Cube(0,0,0,0,-135,0, WRR),
  79   };
  80
  81   // The bass box!
  82   // BassBox bassBox = BassBox.unlitBassBox(BBX, 0, BBZ); // frame exists, no lights
  83      BassBox bassBox = BassBox.noBassBox(); // no bass box at all
  84   // BassBox bassBox = new BassBox(BBX, 0, BBZ); // bass box with lights
  85
  86   // The speakers!
  87   List<Speaker> speakers = Arrays.asList(new Speaker[] {
  88      // Each speaker parameter is x, y, z, rotation, the left speaker comes first
  89      // new Speaker(TRAILER_WIDTH - Speaker.EDGE_WIDTH + 8, 6, 3, -15)
  90   });
  91
  92   //////////////////////////////////////////////////////////////////////
  93   //      BENEATH HERE SHOULD NOT REQUIRE ANY MODIFICATION!!!!        //
  94   //////////////////////////////////////////////////////////////////////
  95
  96   // These guts just convert the shorthand mappings into usable objects
  97   ArrayList<Tower> towerList = new ArrayList<Tower>();
  98   ArrayList<Cube> tower;
  99   Cube[] cubes = new Cube[100];
 100   int cubeIndex = 1;
 101   float px, pz, ny;
 102   for (TowerMapping tm : towerCubes) {
 103     px = tm.x;
 104     ny = tm.y;
 105     pz = tm.z;
 106     tower = new ArrayList<Cube>();
 107     for (CubeMapping cm : tm.cubeMappings) {
 108       tower.add(cubes[cubeIndex++] = new Cube(px = px + cm.dx, ny, pz = pz + cm.dz, 0, cm.ry, 0, cm.wiring));
 109       ny += Cube.EDGE_HEIGHT;
 110     }
 111     towerList.add(new Tower(tower));
 112   }
 113
 114
 115   for (Cube cube : singleCubes) cubes[cubeIndex++] = cube;
 116   for (Cube cube : dcubes)              cubes[cubeIndex++] = cube;
 117 for (StaggeredTower st : scubes) {
 118     tower = new ArrayList<Cube>();
 119     for (int i=0; i < st.n; i++)
 120       tower.add(cubes[cubeIndex++] = new Cube(st.x, st.y + CH* 4/3.*i, st.z, 0, st.r, 0, WRR));
 121     towerList.add(new Tower(tower));
 122   }
 123
 124   return new Model(towerList, cubes, bassBox, speakers);
 125 }
 126
 127 /**
 128  * This function maps the panda boards. We have an array of them, each has
 129  * an IP address and a list of channels.
 130  */
 131 public PandaMapping[] buildPandaList() {
 132   final int LEFT_SPEAKER = 0;
 133   final int RIGHT_SPEAKER = 1;
 134
 135   // 8 channels map to:  3, 4, 7, 8, 13, 14, 15, 16.
 136   return new PandaMapping[] {
 137     // new PandaMapping(
 138     //   "10.200.1.30", new ChannelMapping[] {
 139     //     new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 39, 40, 41, 42 }), // 30 J3 *
 140     //     new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 37, 38, 36, 35}),  // 30 J4 //ORIG *
 141     //     new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { }),                // 30 J7 *
 142     //     new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 16, 17, 18, 19}),  // 30 J8 *
 143     //     new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { }),                // 30 J13 (not working)
 144     //     new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { }),                // 30 J14 (unplugged)
 145     //     new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { }),                // 30 J15 (unplugged)
 146     //     new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 53, 54, 55, 72 }), // 30 J16
 147     // }),
 148     new PandaMapping(
 149       "10.200.1.29", new ChannelMapping[] {
 150         new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 1,2,3,4}),                // 29 J3  (not connected)
 151         new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 1,2,3,4 }),                // 29 J4  (not connected)
 152         new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 1,2,3,4}),  // 29 J7
 153         new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 1,2,3,4}),  // 29 J8  //XXX
 154         new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 8,9,10}),                // 29 J13 //XX //bassbox  (not working)
 155         new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 8,9,10 }),                // 29 J14 (not working)
 156         new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 14,15,16,17 }), // 29 J15
 157         new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] {  14,15,16,17 }), // 29 J16
 158     }),
 159     new PandaMapping(
 160       "10.200.1.28", new ChannelMapping[] {
 161 /*        new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 60, 61, 62, 63 }), // 28 J3
 162         new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 33, 34, 32, 31}),                // 28 J4
 163         new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 45, 46, 47, 48 }), // 28 J7
 164         new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 24, 25, 26, 27}),                // 28 J8
 165         new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] {  4,  5,  6,  7}),  // 28 J13
 166         new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 64, 65, 66, 67 }), // 28 J14
 167         new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 68, 69, 70, 71 }), // 28 J15
 168         new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 49, 50, 51, 52}),  // 28 J16
 169 */
 170    }),
 171     // new PandaMapping(
 172     //   "10.200.1.31", new ChannelMapping[] {
 173     //     new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { }),                // 31 J3
 174     //     new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { }),                // 31 J4
 175     //     new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 73}),                // 31 J7
 176     //     new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 24, 25, 26, 27}),  // 31 J8
 177     //     new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { }),                // 31 J13
 178     //     new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 56, 57, 58, 59}),  // 31 J14
 179     //     new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 20, 21, 22, 23}),  // 31 J15
 180     //     new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { }),                // 31 J16
 181     // }),
 182   };
 183 }
 184
 185 class TowerMapping {
 186   public final float x, y, z;
 187   public final CubeMapping[] cubeMappings;
 188
 189   TowerMapping(float x, float y, float z, CubeMapping[] cubeMappings) {
 190     this.x = x;
 191     this.y = y;
 192     this.z = z;
 193     this.cubeMappings = cubeMappings;
 194   }
 195 }
 196
 197 class CubeMapping {
 198   public final float dx, dz, ry;
 199   public final Cube.Wiring wiring;
 200
 201   CubeMapping(float dx, float dz, Cube.Wiring wiring) {
 202     this(dx, dz, 0., wiring);
 203   }
 204   CubeMapping(float dx, float dz, float ry) {
 205     this(dz, dz, ry, Cube.Wiring.FRONT_LEFT);
 206   }
 207
 208   CubeMapping(float dx, float dz, float ry, Cube.Wiring wiring) {
 209     this.dx = dx;
 210     this.dz = dz;
 211     this.ry = ry;
 212     this.wiring = wiring;
 213   }
 214 }
 215
 216 class StaggeredTower {
 217   public final float x, y, z, r;
 218   public final int n;
 219   StaggeredTower(float _x, float _y, float _z, float _r, int _n) { x=_x; y=_y; z=_z; r=_r; n=_n;}
 220 }
 221
 222 /**
 223  * Each panda board has an IP address and a fixed number of channels. The channels
 224  * each have a fixed number of pixels on them. Whether or not that many physical
 225  * pixels are connected to the channel, we still send it that much data.
 226  */
 227 class PandaMapping {
 228
 229   // How many channels are on the panda board
 230   public final static int CHANNELS_PER_BOARD = 8;
 231
 232   // How many total pixels on the whole board
 233   public final static int PIXELS_PER_BOARD = ChannelMapping.PIXELS_PER_CHANNEL * CHANNELS_PER_BOARD;
 234
 235   final String ip;
 236   final ChannelMapping[] channelList = new ChannelMapping[CHANNELS_PER_BOARD];
 237
 238   PandaMapping(String ip, ChannelMapping[] rawChannelList) {
 239     this.ip = ip;
 240
 241     // Ensure our array is the right length and has all valid items in it
 242     for (int i = 0; i < channelList.length; ++i) {
 243       channelList[i] = (i < rawChannelList.length) ? rawChannelList[i] : new ChannelMapping();
 244       if (channelList[i] == null) {
 245         channelList[i] = new ChannelMapping();
 246       }
 247     }
 248   }
 249 }
 250
 251 /**
 252  * Each channel on a pandaboard can be mapped in a number of modes. The typical is
 253  * to a series of connected cubes, but we also have special mappings for the bass box,
 254  * the speaker enclosures, and the DJ booth floor.
 255  *
 256  * This class is just the mapping meta-data. It sanitizes the input to make sure
 257  * that the cubes and objects being referenced actually exist in the model.
 258  *
 259  * The logic for how to encode the pixels is contained in the PandaDriver.
 260  */
 261 class ChannelMapping {
 262
 263   // How many cubes per channel xc_PB is configured for
 264   public final static int CUBES_PER_CHANNEL = 4;
 265
 266   // How many total pixels on each channel
 267   public final static int PIXELS_PER_CHANNEL = Cube.POINTS_PER_CUBE * CUBES_PER_CHANNEL;
 268
 269   public static final int MODE_NULL = 0;
 270   public static final int MODE_CUBES = 1;
 271   public static final int MODE_BASS = 2;
 272   public static final int MODE_SPEAKER = 3;
 273   public static final int MODE_STRUTS_AND_FLOOR = 4;
 274   public static final int MODE_INVALID = 5;
 275
 276   public static final int NO_OBJECT = -1;
 277
 278   final int mode;
 279   final int[] objectIndices = new int[CUBES_PER_CHANNEL];
 280
 281   ChannelMapping() {
 282     this(MODE_NULL);
 283   }
 284
 285   ChannelMapping(int mode) {
 286     this(mode, new int[]{});
 287   }
 288
 289   ChannelMapping(int mode, int rawObjectIndex) {
 290     this(mode, new int[]{ rawObjectIndex });
 291   }
 292
 293   ChannelMapping(int mode, int[] rawObjectIndices) {
 294     if (mode < 0 || mode >= MODE_INVALID) {
 295       throw new RuntimeException("Invalid channel mapping mode: " + mode);
 296     }
 297     if (mode == MODE_SPEAKER) {
 298       if (rawObjectIndices.length != 1) {
 299         throw new RuntimeException("Speaker channel mapping mode must specify one speaker index");
 300       }
 301       int speakerIndex = rawObjectIndices[0];
 302       if (speakerIndex < 0 || speakerIndex >= glucose.model.speakers.size()) {
 303         throw new RuntimeException("Invalid speaker channel mapping: " + speakerIndex);
 304       }
 305     } else if ((mode == MODE_STRUTS_AND_FLOOR) || (mode == MODE_BASS) || (mode == MODE_NULL)) {
 306       if (rawObjectIndices.length > 0) {
 307         throw new RuntimeException("Bass/floor/null mappings cannot specify object indices");
 308       }
 309     } else if (mode == MODE_CUBES) {
 310       for (int rawCubeIndex : rawObjectIndices) {
 311         if (glucose.model.getCubeByRawIndex(rawCubeIndex) == null) {
 312           throw new RuntimeException("Non-existing cube specified in cube mapping: " + rawCubeIndex);
 313         }
 314       }
 315     }
 316
 317     this.mode = mode;
 318     for (int i = 0; i < objectIndices.length; ++i) {
 319       objectIndices[i] = (i < rawObjectIndices.length) ? rawObjectIndices[i] : NO_OBJECT;
 320     }
 321   }
 322 }