launchpad 0.1.1 → 0.2.0

data/README.rdoc

@@ -66,12 +66,17 @@ For more details, see the examples. examples/color_picker.rb is the most complex
 == Near future plans
 
 * interaction responses for presses on single grid buttons/button areas
-* double buffering
 * bitmap rendering
 
 
 == Changelog
 
+=== v.0.2.0
+
+* double buffering (see Launchpad::Device#buffering_mode)
+* don't update grid button 0,0 before change_all (in order to reset rapid update pointer), use MIDI message without visual effect
+* (at least) doubled the speed of change_all by not sending each message individually but sending them in one go (as an array)
+
 === v0.1.1
 
 * ability to close device/interaction to free portmidi resources

data/examples/double_buffering.rb

@@ -0,0 +1,104 @@
+require File.join(File.dirname(__FILE__), 'setup')
+
+interaction = Launchpad::Interaction.new
+
+# store and change button states, ugly but well...
+@button_states = [
+  [false, false, false, false, false, false, false, false],
+  [false, false, false, false, false, false, false, false],
+  [[false, false], [false, false], [false, false], [false, false], [false, false], [false, false], [false, false], [false, false]],
+  [[false, false], [false, false], [false, false], [false, false], [false, false], [false, false], [false, false], [false, false]],
+  [[false, false], [false, false], [false, false], [false, false], [false, false], [false, false], [false, false], [false, false]],
+  [[false, false], [false, false], [false, false], [false, false], [false, false], [false, false], [false, false], [false, false]],
+  [[false, false], [false, false], [false, false], [false, false], [false, false], [false, false], [false, false], [false, false]],
+  [[false, false], [false, false], [false, false], [false, false], [false, false], [false, false], [false, false], [false, false]]
+]
+def change_button_state(action)
+  if action[:y] > 1
+    which = @active_buffer_button == :user2 ? 1 : 0
+    @button_states[action[:y]][action[:x]][which] = !@button_states[action[:y]][action[:x]][which]
+  else
+    @button_states[action[:y]][action[:x]] = !@button_states[action[:y]][action[:x]]
+  end
+end
+
+# setup grid buttons to:
+# * set LEDs in normal mode on the first row
+# * set LEDs in flashing mode on the second row
+# * set LEDs in buffering mode on all other rows
+interaction.response_to(:grid, :down) do |interaction, action|
+  color = change_button_state(action) ? @color : {}
+  case action[:y]
+  when 0
+    interaction.device.change(:grid, action.merge(color))
+  when 1
+    interaction.device.buffering_mode(:flashing => false, :display_buffer => 1, :update_buffer => 0)
+    interaction.device.change(:grid, action.merge(color).merge(:mode => :flashing))
+    interaction.respond_to(@active_buffer_button, :down)
+  else
+    interaction.device.change(:grid, action.merge(color).merge(:mode => :buffering))
+  end
+end
+
+# green feedback for buffer buttons
+interaction.response_to([:session, :user1, :user2], :down) do |interaction, action|
+  case @active_buffer_button = action[:type]
+  when :session
+    interaction.device.buffering_mode(:flashing => true)
+  when :user1
+    interaction.device.buffering_mode(:display_buffer => 0, :update_buffer => 0)
+  when :user2
+    interaction.device.buffering_mode(:display_buffer => 1, :update_buffer => 1)
+  end
+  interaction.device.change(:session, :red => @active_buffer_button == :session ? :hi : :lo, :green => @active_buffer_button == :session ? :hi : :lo)
+  interaction.device.change(:user1, :red => @active_buffer_button == :user1 ? :hi : :lo, :green => @active_buffer_button == :user1 ? :hi : :lo)
+  interaction.device.change(:user2, :red => @active_buffer_button == :user2 ? :hi : :lo, :green => @active_buffer_button == :user2 ? :hi : :lo)
+end
+
+# setup color picker
+def display_color(opts)
+  lambda do |interaction, action|
+    @red = opts[:red] if opts[:red]
+    @green = opts[:green] if opts[:green]
+    if @red == 0 && @green == 0
+      @red = 1 if opts[:red]
+      @green = 1 if opts[:green]
+    end
+    @color = {:red => @red, :green => @green}
+    on = {:red => 3, :green => 3}
+    interaction.device.change(:scene1, @red == 3 ? on : {:red => 3})
+    interaction.device.change(:scene2, @red == 2 ? on : {:red => 2})
+    interaction.device.change(:scene3, @red == 1 ? on : {:red => 1})
+    interaction.device.change(:scene4, @red == 0 ? on : {:red => 0})
+    interaction.device.change(:scene5, @green == 3 ? on : {:green => 3})
+    interaction.device.change(:scene6, @green == 2 ? on : {:green => 2})
+    interaction.device.change(:scene7, @green == 1 ? on : {:green => 1})
+    interaction.device.change(:scene8, @green == 0 ? on : {:green => 0})
+  end
+end
+# register color picker interactors on scene buttons
+interaction.response_to(:scene1, :down, :exclusive => true, &display_color(:red => 3))
+interaction.response_to(:scene2, :down, :exclusive => true, &display_color(:red => 2))
+interaction.response_to(:scene3, :down, :exclusive => true, &display_color(:red => 1))
+interaction.response_to(:scene4, :down, :exclusive => true, &display_color(:red => 0))
+interaction.response_to(:scene5, :down, :exclusive => true, &display_color(:green => 3))
+interaction.response_to(:scene6, :down, :exclusive => true, &display_color(:green => 2))
+interaction.response_to(:scene7, :down, :exclusive => true, &display_color(:green => 1))
+interaction.response_to(:scene8, :down, :exclusive => true, &display_color(:green => 0))
+# pick green
+interaction.respond_to(:scene5, :down)
+
+# mixer button terminates interaction on button up
+interaction.response_to(:mixer) do |interaction, action|
+  interaction.device.change(:mixer, :red => action[:state] == :down ? :hi : :off)
+  interaction.stop if action[:state] == :up
+end
+
+# start in auto flashing mode
+interaction.respond_to(:session, :down)
+
+# start interacting
+interaction.start
+
+# sleep so that the messages can be sent before the program terminates
+sleep 0.1

data/launchpad.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{launchpad}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Thomas Jachmann"]
-  s.date = %q{2009-11-18}
+  s.date = %q{2009-11-24}
   s.description = %q{This gem provides an interface to access novation's launchpad programmatically. LEDs can be lighted and button presses can be evaluated using launchpad's MIDI input/output.}
   s.email = %q{tom.j@gmx.net}
   s.extra_rdoc_files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
      "examples/color_picker.rb",
      "examples/colors.rb",
      "examples/doodle.rb",
+     "examples/double_buffering.rb",
      "examples/drawing_board.rb",
      "examples/feedback.rb",
      "examples/reset.rb",
@@ -53,6 +54,7 @@ Gem::Specification.new do |s|
      "examples/color_picker.rb",
      "examples/colors.rb",
      "examples/doodle.rb",
+     "examples/double_buffering.rb",
      "examples/drawing_board.rb",
      "examples/feedback.rb",
      "examples/reset.rb",

data/lib/launchpad/device.rb

@@ -119,7 +119,10 @@ module Launchpad
     # [<tt>:y</tt>]     y coordinate
     # [<tt>:red</tt>]   brightness of red LED
     # [<tt>:green</tt>] brightness of green LED
-    # [<tt>:mode</tt>]  button mode
+    # [<tt>:mode</tt>]  button mode, defaults to <tt>:normal</tt>, one of:
+    #                   [<tt>:normal/tt>]     updates the LED for all circumstances (the new value will be written to both buffers)
+    #                   [<tt>:flashing/tt>]   updates the LED for flashing (the new value will be written to buffer 0 while the LED will be off in buffer 1, see buffering_mode)
+    #                   [<tt>:buffering/tt>]  updates the LED for the current update_buffer only
     # 
     # Errors raised:
     # 
@@ -157,12 +160,15 @@ module Launchpad
       # ensure that colors is at least and most 80 elements long
       colors = colors.flatten[0..79]
       colors += [0] * (80 - colors.size) if colors.size < 80
-      # HACK switch off first grid LED to reset rapid LED change pointer
-      output(Status::ON, 0, 0)
+      # send normal MIDI message to reset rapid LED change pointer
+      # in this case, set mapping mode to x-y layout (the default)
+      output(Status::CC, Status::NIL, GridLayout::XY)
       # send colors in slices of 2
+      messages = []
       colors.each_slice(2) do |c1, c2|
-        output(Status::MULTI, velocity(c1), velocity(c2))
+        messages << message(Status::MULTI, velocity(c1), velocity(c2))
       end
+      output_messages(messages)
     end
     
     # Switches LEDs marked as flashing on when using custom timer for flashing.
@@ -171,7 +177,7 @@ module Launchpad
     # 
     # [Launchpad::NoOutputAllowedError] when output is not enabled
     def flashing_on
-      output(Status::CC, Status::NIL, Velocity::FLASHING_ON)
+      buffering_mode(:display_buffer => 0)
     end
     
     # Switches LEDs marked as flashing off when using custom timer for flashing.
@@ -180,7 +186,7 @@ module Launchpad
     # 
     # [Launchpad::NoOutputAllowedError] when output is not enabled
     def flashing_off
-      output(Status::CC, Status::NIL, Velocity::FLASHING_OFF)
+      buffering_mode(:display_buffer => 1)
     end
     
     # Starts flashing LEDs marked as flashing automatically.
@@ -190,21 +196,33 @@ module Launchpad
     # 
     # [Launchpad::NoOutputAllowedError] when output is not enabled
     def flashing_auto
-      output(Status::CC, Status::NIL, Velocity::FLASHING_AUTO)
+      buffering_mode(:flashing => true)
     end
     
-    #   def start_buffering
-    #     output(CC, 0x00, 0x31)
-    #     @buffering = true
-    #   end
-    #   
-    #   def flush_buffer(end_buffering = true)
-    #     output(CC, 0x00, 0x34)
-    #     if end_buffering
-    #       output(CC, 0x00, 0x30)
-    #       @buffering = false
-    #     end
-    #   end
+    # Controls the two buffers.
+    # 
+    # Optional options hash:
+    # 
+    # [<tt>:display_buffer</tt>]  which buffer to use for display, defaults to +0+
+    # [<tt>:update_buffer</tt>]   which buffer to use for updates when <tt>:mode</tt> is set to <tt>:buffering</tt>, defaults to +0+ (see change)
+    # [<tt>:copy</tt>]            whether to copy the LEDs states from the new display_buffer over to the new update_buffer, <tt>true/false</tt>, defaults to <tt>false</tt>
+    # [<tt>:flashing</tt>]        whether to start flashing by automatically switching between the two buffers for display, <tt>true/false</tt>, defaults to <tt>false</tt>
+    # 
+    # Errors raised:
+    # 
+    # [Launchpad::NoOutputAllowedError] when output is not enabled
+    def buffering_mode(opts = nil)
+      opts = {
+        :display_buffer => 0,
+        :update_buffer => 0,
+        :copy => false,
+        :flashing => false
+      }.merge(opts || {})
+      data = opts[:display_buffer] + 4 * opts[:update_buffer] + 32
+      data += 16 if opts[:copy]
+      data += 8 if opts[:flashing]
+      output(Status::CC, Status::NIL, data)
+    end
     
     # Reads user actions (button presses/releases) that haven't been handled yet.
     # 
@@ -330,8 +348,22 @@ module Launchpad
     # 
     # [Launchpad::NoOutputAllowedError] when output is not enabled
     def output(status, data1, data2)
+      output_messages([message(status, data1, data2)])
+    end
+    
+    # Writes several messages to the MIDI device.
+    # 
+    # Parameters:
+    # 
+    # [+messages+]  an array of hashes (usually created with message) with:
+    #               [<tt>:message</tt>]   an array of
+    #                                     MIDI status code,
+    #                                     MIDI data 1 (note),
+    #                                     MIDI data 2 (velocity)
+    #               [<tt>:timestamp</tt>] integer indicating the time when the MIDI message was created
+    def output_messages(messages)
       raise NoOutputAllowedError if @output.nil?
-      @output.write([{:message => [status, data1, data2], :timestamp => 0}])
+      @output.write(messages)
       nil
     end
     
@@ -385,7 +417,10 @@ module Launchpad
     # 
     # [<tt>:red</tt>]   brightness of red LED
     # [<tt>:green</tt>] brightness of green LED
-    # [<tt>:mode</tt>]  button mode
+    # [<tt>:mode</tt>]  button mode, defaults to <tt>:normal</tt>, one of:
+    #                   [<tt>:normal/tt>]     updates the LED for all circumstances (the new value will be written to both buffers)
+    #                   [<tt>:flashing/tt>]   updates the LED for flashing (the new value will be written to buffer 0 while in buffer 1, the value will be :off, see )
+    #                   [<tt>:buffering/tt>]  updates the LED for the current update_buffer only
     # 
     # Returns:
     # 
@@ -430,6 +465,27 @@ module Launchpad
       end
     end
     
+    # Creates a MIDI message.
+    # 
+    # Parameters:
+    # 
+    # [+status+]  MIDI status code
+    # [+data1+]   MIDI data 1 (note)
+    # [+data2+]   MIDI data 2 (velocity)
+    # 
+    # Returns:
+    # 
+    # an array with:
+    # 
+    # [<tt>:message</tt>]   an array of
+    #                       MIDI status code,
+    #                       MIDI data 1 (note),
+    #                       MIDI data 2 (velocity)
+    # [<tt>:timestamp</tt>] integer indicating the time when the MIDI message was created, in this case 0
+    def message(status, data1, data2)
+      {:message => [status, data1, data2], :timestamp => 0}
+    end
+    
   end
   
 end

data/lib/launchpad/midi_codes.rb

@@ -38,12 +38,15 @@ module Launchpad
     
     # Module defining MIDI data 2 (velocity) codes.
     module Velocity
-      FLASHING_ON   = 0x20
-      FLASHING_OFF  = 0x21
-      FLASHING_AUTO = 0x28
       TEST_LEDS     = 0x7C
     end
     
+    # Module defining MIDI data 2 codes for selecting the grid layout.
+    module GridLayout
+      XY            = 0x01
+      DRUM_RACK     = 0x02
+    end
+    
   end
   
 end

data/lib/launchpad/version.rb

@@ -1,3 +1,3 @@
 module Launchpad
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/test/test_device.rb

@@ -34,7 +34,9 @@ class TestDevice < Test::Unit::TestCase
   }
   
   def expects_output(device, *args)
-    device.instance_variable_get('@output').expects(:write).with([{:message => args, :timestamp => 0}])
+    args = [args] unless args.first.is_a?(Array)
+    messages = args.collect {|data| {:message => data, :timestamp => 0}}
+    device.instance_variable_get('@output').expects(:write).with(messages)
   end
   
   def stub_input(device, *args)
@@ -414,16 +416,15 @@ class TestDevice < Test::Unit::TestCase
         assert_nil @device.change_all([0])
       end
       
-      should 'fill colors with 0, set grid 0,0 to 0 and flush colors' do
-        expects_output(@device, 0x90, 0, 0)
-        20.times {|i| expects_output(@device, 0x92, 17, 17)}
-        20.times {|i| expects_output(@device, 0x92, 12, 12)}
+      should 'fill colors with 0, set grid layout to XY and flush colors' do
+        expects_output(@device, 0xB0, 0, 0x01)
+        expects_output(@device, *([[0x92, 17, 17]] * 20 + [[0x92, 12, 12]] * 20))
         @device.change_all([5] * 40)
       end
       
-      should 'cut off exceeding colors, set grid 0,0 to 0 and flush colors' do
-        expects_output(@device, 0x90, 0, 0)
-        40.times {|i| expects_output(@device, 0x92, 17, 17)}
+      should 'cut off exceeding colors, set grid layout to XY and flush colors' do
+        expects_output(@device, 0xB0, 0, 0x01)
+        expects_output(@device, *([[0x92, 17, 17]] * 40))
         @device.change_all([5] * 100)
       end
       
@@ -431,6 +432,37 @@ class TestDevice < Test::Unit::TestCase
     
   end
   
+  context 'buffering_mode' do
+    
+    should 'raise NoOutputAllowedError when not initialized with output' do
+      assert_raise Launchpad::NoOutputAllowedError do
+        Launchpad::Device.new(:output => false).buffering_mode
+      end
+    end
+    
+    {
+      nil                     => [0xB0, 0x00, 0x20],
+      {}                      => [0xB0, 0x00, 0x20],
+      {:display_buffer => 1}  => [0xB0, 0x00, 0x21],
+      {:update_buffer => 1}   => [0xB0, 0x00, 0x24],
+      {:copy => true}         => [0xB0, 0x00, 0x30],
+      {:flashing => true}     => [0xB0, 0x00, 0x28],
+      {
+        :display_buffer => 1,
+        :update_buffer  => 1,
+        :copy           => true,
+        :flashing       => true
+      }                       => [0xB0, 0x00, 0x3D]
+    }.each do |opts, codes|
+      should "send #{codes.inspect} when called with #{opts.inspect}" do
+        d = Launchpad::Device.new
+        expects_output(d, *codes)
+        d.buffering_mode(opts)
+      end
+    end
+    
+  end
+  
   context 'read_pending_actions' do
     
     should 'raise NoInputAllowedError when not initialized with input' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: launchpad
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Thomas Jachmann
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-18 00:00:00 +01:00
+date: 2009-11-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,6 +60,7 @@ files:
 - examples/color_picker.rb
 - examples/colors.rb
 - examples/doodle.rb
+- examples/double_buffering.rb
 - examples/drawing_board.rb
 - examples/feedback.rb
 - examples/reset.rb
@@ -110,6 +111,7 @@ test_files:
 - examples/color_picker.rb
 - examples/colors.rb
 - examples/doodle.rb
+- examples/double_buffering.rb
 - examples/drawing_board.rb
 - examples/feedback.rb
 - examples/reset.rb