Mapping for Asana hackathon
[SugarCubes.git] / _PandaDriver.pde
index 6a4a3da021c760c15873fda6583fc155fa16b9b8..5d8ad249bbe3171446033c720c1d15f60cfda226 100644 (file)
@@ -14,119 +14,346 @@ import oscP5.*;
  * This class implements the output function to the Panda Boards. It
  * will be moved into GLucose once stabilized.
  */
-public class PandaDriver {
-
+public static class PandaDriver {
+  
+  interface Listener {
+    public void onToggle(boolean enabled);
+  }
+  
+  private Listener listener = null;
+  
+  // IP address
+  public final String ip;
+  
   // Address to send to
   private final NetAddress address;
   
+  // Whether board output is enabled
+  private boolean enabled = false;
+  
   // OSC message
   private final OscMessage message;
 
-  // List of point indices on the board
+  // List of point indices that get sent to this board
   private final int[] points;
+    
+  // Packet data
+  private final byte[] packet = new byte[4*352]; // magic number, our UDP packet size
 
-  // Bit for flipped status of each point index
-  private final boolean[] flipped;
+  private static final int NO_POINT = -1;
+
+  ////////////////////////////////////////////////////////////////
+  //
+  // READ THIS RIGHT NOW BEFORE YOU MODIFY THE BELOW!!!!!!!!!!!!!
+  // READ THIS RIGHT NOW BEFORE YOU MODIFY THE BELOW!!!!!!!!!!!!!
+  // READ THIS RIGHT NOW BEFORE YOU MODIFY THE BELOW!!!!!!!!!!!!!
+  //
+  // The mappings below indicate the physical order of strips
+  // connected to a pandaboard channel. The strip numbers are a
+  // reflection of how the model is built.
+  //
+  // For ANYTHING in the model which is a rectangular prism,
+  // which means Cubes, the BassBox, and each Speaker, the
+  // strips are numbered incrementally by face. The first
+  // face is always the FRONT, which you are looking at.
+  // The next face is the RIGHT, then the BACK, then the LEFT.
+  //
+  // For every face, the strips are ordered numerically moving
+  // clockwise from the the TOP LEFT.
+  //
+  // So, for a cube:
+  //
+  //  Strip 0: front face, top strip, left to right
+  //  Strip 1: front face, right strip, top to bottom
+  //  Strip 2: front face, bottom strip, right to left
+  //  Strip 3: front face, left strip, bottom to top
+  //
+  //  Strip 4: right face, top strip, left to right
+  //  ... and so on
+  //  Strip 14: left face, bottom strip, right to left
+  //  Strip 15: left face, left strip, bottom to top
+  //
+  ////////////////////////////////////////////////////////////////
+  
+  private final static int FORWARD = -1;
+  private final static int BACKWARD = -2;
+
+  /**
+   * These constant arrays indicate the order in which the strips of a cube
+   * are wired. There are four different options, depending on which bottom
+   * corner of the cube the data wire comes in.
+   */
+  private final static int[][] CUBE_STRIP_ORDERINGS = new int[][] {
+//    {  2,  1,  0,  3, 13, 12, 15, 14,  4,  7,  6,  5, 11, 10,  9,  8 }, // FRONT_LEFT
+//    {  6,  5,  4,  7,  1,  0,  3,  2,  8, 11, 10,  9, 15, 14, 13, 12 }, // FRONT_RIGHT
+//    { 14, 13, 12, 15,  9,  8, 11, 10,  0,  3,  2,  1,  7,  6,  5,  4 }, // REAR_LEFT
+//    { 10,  9,  8, 11,  5,  4,  7,  6, 12, 15, 14, 13,  3,  2,  1,  0 }, // REAR_RIGHT
 
-  // Packet data
-  private final byte[] packet = new byte[4*352]; // TODO: de-magic-number
 
-  public PandaDriver(NetAddress address, Model model, int[][] channelList, int[][] flippedList) {
-    this.address = address;
+    {  2,  1,  0,  3, 13, 12, 15, 14,  4,  7,  6,  5, 11, 10,  9,  8 }, // FRONT_LEFT
+    {  6,  5,  4,  7,  1,  0,  3,  2,  8, 11, 10,  9, 15, 14, 13, 12 }, // FRONT_RIGHT
+    { 14, 13, 12, 15,  9,  8, 11, 10,  0,  3,  2,  1,  7,  6,  5,  4 }, // REAR_LEFT
+    {  9,  8, 11,  5,  4,  7,  6, 10, 14,  2,  1,  0,  3, 13, 12, 15 }, // REAR_RIGHT
+
+  };
+  
+  private final static int[][] BASS_STRIP_ORDERING = {
+    // front face, counterclockwise from bottom front left
+    {2, BACKWARD /* if this strip has extra pixels, you can add them here */ /*, 4 */ }, 
+    {1, BACKWARD /* if this strip is short some pixels, substract them here */ /*, -3 */ },
+    {0, BACKWARD },
+    {3, BACKWARD },
+    
+    // left face, counterclockwise from bottom front left
+    {13, BACKWARD },
+    {12, BACKWARD },
+    {15, BACKWARD },
+    {14, BACKWARD },
+
+    // back face, counterclockwise from bottom rear left
+    {9, BACKWARD },
+    {8, BACKWARD },
+    {11, BACKWARD },
+    {10, BACKWARD },
+
+    // right face, counterclockwise from bottom rear right
+    {5, BACKWARD },
+    {4, BACKWARD },
+    {7, BACKWARD },
+    {6, BACKWARD },
+  };
+
+  private final static int[][] STRUT_STRIP_ORDERING = {
+    {6, BACKWARD},
+    {5, FORWARD},
+    {4, BACKWARD},
+    {3, FORWARD},
+    {2, BACKWARD},
+    {1, FORWARD},
+    {0, BACKWARD},
+    {7, FORWARD},    
+  };
+  
+  private final static int[][] FLOOR_STRIP_ORDERING = {
+    {0, FORWARD},
+    {1, FORWARD},
+    {2, FORWARD},
+    {3, BACKWARD},
+  };
+  
+  // The speakers are currently configured to be wired the same
+  // as cubes with Wiring.FRONT_LEFT. If this needs to be changed,
+  // remove this null assignment and change the below to have mappings
+  // for the LEFT and RIGHT speaker
+  private final static int[][][] SPEAKER_STRIP_ORDERING = {
+    // Left speaker
+    { 
+      // Front face, counter-clockwise from bottom left
+      {2, BACKWARD },
+      {1, BACKWARD },
+      {0, BACKWARD },
+      {3, BACKWARD },
+    },
+    // Right speaker
+    {
+      // Front face, counter-clockwise from bottom left
+      {2, BACKWARD },
+      {1, BACKWARD },
+      {0, BACKWARD },
+      {3, BACKWARD },
+    }
+  };
+
+  public PandaDriver(String ip) {
+    this.ip = ip;
+    
+    // Initialize our OSC output stuff
+    address = new NetAddress(ip, 9001);
     message = new OscMessage("/shady/pointbuffer");
-    List<Integer> pointList = buildMappedList(model, channelList);
-    points = new int[pointList.size()];
-    int i = 0;
-    for (int value : pointList) {
-      points[i++] = value;
+    
+    // Build the array of points, initialize all to nothing
+    points = new int[PandaMapping.PIXELS_PER_BOARD];
+    for (int i = 0; i < points.length; ++i) {
+      points[i] = NO_POINT;
     }
-    flipped = buildFlippedList(model, flippedList);
   }
+    
+  public PandaDriver(String ip, Model model, PandaMapping pm) {
+    this(ip);
+    
+    // Ok, we are initialized, time to build the array if points in order to
+    // send out. We start at the head of our point buffer, and work our way
+    // down. This is the order in which points will be sent down the wire.
+    int ci = -1;
+    
+    // Iterate through all our channels
+    for (ChannelMapping channel : pm.channelList) {
+      ++ci;
+      int pi = ci * ChannelMapping.PIXELS_PER_CHANNEL;
+      
+      switch (channel.mode) {
 
-  private ArrayList<Integer> buildMappedList(Model model, int[][] channelList) {
-    ArrayList<Integer> points = new ArrayList<Integer>();
-    for (int[] channel : channelList) {
-      for (int cubeNumber : channel) {
-        if (cubeNumber == 0) {
-          for (int i = 0; i < (Cube.CLIPS_PER_CUBE*Clip.STRIPS_PER_CLIP*Strip.POINTS_PER_STRIP); ++i) {
-            points.add(0);
+        case ChannelMapping.MODE_CUBES:
+          // We have a list of cubes per channel
+          for (int rawCubeIndex : channel.objectIndices) {
+            if (rawCubeIndex < 0) {
+              // No cube here, skip ahead in the buffer
+              pi += Cube.POINTS_PER_CUBE;
+            } else {
+              // The cube exists, check which way it is wired to
+              // figure out the order of strips.
+              Cube cube = model.getCubeByRawIndex(rawCubeIndex);
+              int stripOrderIndex = 0;
+              switch (cube.wiring) {
+                case FRONT_LEFT: stripOrderIndex = 0; break;
+                case FRONT_RIGHT: stripOrderIndex = 1; break;
+                case REAR_LEFT: stripOrderIndex = 2; break;
+                case REAR_RIGHT: stripOrderIndex = 3; break;
+              }
+              
+              // Iterate through all the strips on the cube and add the points
+              for (int stripIndex : CUBE_STRIP_ORDERINGS[stripOrderIndex]) {
+                // We go backwards here... in the model strips go clockwise, but
+                // the physical wires are run counter-clockwise
+                pi = mapStrip(cube.strips.get(stripIndex), BACKWARD, points, pi);
+              }
+            }
+          }
+          break;
+          
+        case ChannelMapping.MODE_BASS:
+          for (int[] config : BASS_STRIP_ORDERING) {
+            pi = mapStrip(model.bassBox.strips.get(config[0]), config[1], points, pi);
+            if (config.length >= 3) pi += config[2];            
+          }
+          break;
+          
+        case ChannelMapping.MODE_STRUTS_AND_FLOOR:
+          for (int[] config : STRUT_STRIP_ORDERING) {
+            pi = mapStrip(model.bassBox.struts.get(config[0]), config[1], points, pi);
+            if (config.length >= 3) pi += config[2];
+          }     
+          for (int[] config : FLOOR_STRIP_ORDERING) {
+            pi = mapStrip(model.boothFloor.strips.get(config[0]), config[1], points, pi);
+            if (config.length >= 3) pi += config[2];
           }
-        } else {
-          Cube cube = model.getCubeByRawIndex(cubeNumber);
-          if (cube == null) {
-            throw new RuntimeException("Non-zero, non-existing cube specified in channel mapping (" + cubeNumber + ")");
+          break;
+          
+        case ChannelMapping.MODE_SPEAKER:
+          int [][] speakerStripOrdering;
+          if (SPEAKER_STRIP_ORDERING == null) {
+            // Copy the cube strip ordering
+            int[] frontLeftCubeWiring = CUBE_STRIP_ORDERINGS[0];
+            speakerStripOrdering = new int[frontLeftCubeWiring.length][];
+            for (int i = 0; i < frontLeftCubeWiring.length; ++i) {
+              speakerStripOrdering[i] = new int[] { frontLeftCubeWiring[0], BACKWARD }; 
+            }
+          } else {
+            speakerStripOrdering = SPEAKER_STRIP_ORDERING[channel.objectIndices[0]];
           }
-          for (Point p : cube.points) {
-            points.add(p.index);
+          for (int[] config : speakerStripOrdering) {
+            Speaker speaker = model.speakers.get(channel.objectIndices[0]);
+            pi = mapStrip(speaker.strips.get(config[0]), config[1], points, pi);
+            if (config.length >= 3) pi += config[2];            
           }
-        }
+          break;
+          
+        case ChannelMapping.MODE_NULL:
+          // No problem, nothing on this channel!
+          break;
+          
+        default:
+          throw new RuntimeException("Invalid/unhandled channel mapping mode: " + channel.mode);
       }
-    }
-    return points;
-  }
 
-  private boolean[] buildFlippedList(Model model, int[][] flippedRGBList) {
-    boolean[] flipped = new boolean[model.points.size()];
-    for (int i = 0; i < flipped.length; ++i) {
-      flipped[i] = false;
     }
-    for (int[] cubeInfo : flippedRGBList) {
-      int cubeNumber = cubeInfo[0];
-      Cube cube = model.getCubeByRawIndex(cubeNumber);
-      if (cube == null) {
-        throw new RuntimeException("Non-existing cube specified in flipped RGB mapping (" + cubeNumber + ")");
+  }
+  
+  private int mapStrip(Strip s, int direction, int[] points, int pi) {
+    if (direction == FORWARD) {
+      for (LXPoint p : s.points) {
+        points[pi++] = p.index;
       }
-      for (int i = 1; i < cubeInfo.length; ++i) {
-        int stripIndex = cubeInfo[i];
-        for (Point p : cube.strips.get(stripIndex-1).points) {
-          flipped[p.index] = true;
-        }
+    } else if (direction == BACKWARD) {
+      for (int i = s.points.size()-1; i >= 0; --i) {
+        points[pi++] = s.points.get(i).index;
       }
+    } else {
+      throw new RuntimeException("Unidentified strip mapping direction: " + direction);
     }
-    return flipped;
-  } 
+    return pi;
+  }
+
+  public PandaDriver setListener(Listener listener) {
+    this.listener = listener;
+    return this;
+  }
+
+  public void setEnabled(boolean enabled) {
+    if (this.enabled != enabled) {
+      this.enabled = enabled;
+      println("PandaBoard/" + ip + ": " + (enabled ? "ON" : "OFF"));
+      if (listener != null) {
+        listener.onToggle(enabled);
+      }
+    }
+  }
+  
+  public boolean isEnabled() {
+    return this.enabled;
+  }
+
+  public void disable() {
+    setEnabled(false);
+  }
+  
+  public void enable() {
+    setEnabled(true);
+  }
+
+  public void toggle() {
+    setEnabled(!enabled);
+  }
 
   public final void send(int[] colors) {
+    if (!enabled) {
+      return;
+    }
     int len = 0;
     int packetNum = 0;
     for (int index : points) {
-      int c = colors[index];
+      int c = (index < 0) ? 0 : colors[index];
       byte r = (byte) ((c >> 16) & 0xFF);
       byte g = (byte) ((c >> 8) & 0xFF);
       byte b = (byte) ((c) & 0xFF);
-      if (flipped[index]) {
-        byte tmp = r;
-        r = g;
-        g = tmp;
-      }
-      packet[len++] = 0;
+      packet[len++] = 0; // alpha channel, unused but makes for 4-byte alignment
       packet[len++] = r;
       packet[len++] = g;
       packet[len++] = b;
 
       // Flush once packet is full buffer size
       if (len >= packet.length) {
-        sendPacket(packetNum++, len);
+        sendPacket(packetNum++);
         len = 0;
       }
     }
 
     // Flush any remaining data
     if (len > 0) {
-      sendPacket(packetNum++, len);
+      sendPacket(packetNum++);
     }
   }
   
-  private void sendPacket(int packetNum, int len) {
+
+  private void sendPacket(int packetNum) {
     message.clearArguments();
     message.add(packetNum);
-    message.add(len);
+    message.add(packet.length);
     message.add(packet);
     try {
-      OscP5.flush(message, address);     
+      OscP5.flush(message, address);
     } catch (Exception x) {
       x.printStackTrace();
     }
   }
 }
-