mrjoy-launchpad 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8c2eaea477fc7c3dd5587186a3ee2846705f14e
+  data.tar.gz: a5e36f0a19dd060bb7a48fd2414d4c05796981b8
+SHA512:
+  metadata.gz: 4435b65556c71612909b4cd6ff980f506085d8a3fff825619d4e7ce72e9627b346bfae8f9865c86c9cb1c36580a37485991cc74331051aaf5ce8437d0b0062b5
+  data.tar.gz: c93a479be6b78023c09c9deedc2eb5818577a6cd7facb50cca3dd3fb77a6c5d8a5156ba312dc5dd30285a80d27354566318b027b3490cd32aea48ff1d9c99166

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+before_install:
+  - sudo apt-get update
+  - sudo apt-get install libportmidi-dev

data/Gemfile

@@ -0,0 +1,6 @@
+#ruby-gemset=launchpad
+ruby "2.2.2"
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in launchpad.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Thomas Jachmann
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,136 @@
+= launchpad
+
+{<img src="https://travis-ci.org/thomasjachmann/launchpad.png?branch=master" alt="Build Status" />}[https://travis-ci.org/thomasjachmann/launchpad]
+
+This gem provides a ruby interface to access novation's launchpad programmatically. LEDs can be lighted and button presses can be responded to. Internally, launchpad's MIDI input/output is used to accomplish this.
+
+The interfaces should be rather stable now (sorry, I changed quite a bit since the last release), so experiment with them and comment on their usability. This still is work in progress. If you need anything or think the interfaces could be improved in any way, please contact me.
+
+Sometimes, the launchpad won't react to anything or react to/light up the wrong LEDs. Don't despair, just dis- and reconnect the thing. It seems that some (unexpected) MIDI signals make it hickup.
+
+== This Fork
+
+* Added ability to handle inputs without spawning a thread per input.
+* Modify to support for LaunchPad Mk 2.  Note that this breaks Mk 1 support!
+    * Recognize identity string from this model.
+    * Fix X/Y coordinates for buttons.
+    * Add support for RGB colors.
+
+
+== More Info
+
+If you don't know what launchpad is, visit:
+
+* Novation's site at http://de.novationmusic.com/products/midi_controller/launchpad
+* my demo videos for this library at http://www.youtube.com/thomasjachmann
+* other demos on youtube http://www.youtube.com/results?search_query=novation+launchpad
+
+If you're into other languages or want to know what goes on behind the scenes MIDI wise, have a look at:
+
+* Novation's MIDI programmer's reference at {www.novationmusic.com/support/launchpad}[http://www.novationmusic.com/support/launchpad/] (bottom of the page)
+* Tobi Tobes' port of my gem to processing at http://github.com/rngtng/launchpad
+
+
+== Requirements
+
+* Roger B. Dannenberg's {portmidi library}[http://sourceforge.net/projects/portmedia/]
+* Jan Krutisch's {portmidi gem}[http://github.com/halfbyte/portmidi]
+
+
+== Compatibility
+
+The gem is known to be compatible with the following ruby versions:
+
+* MRI 1.8.7
+* MRI 1.9.3
+* MRI 2.0.0
+* MRI 2.2.2
+
+
+== Installation
+
+The gem is hosted on RubyGems[https://rubygems.org/], so in order to use it, you're gonna gem install it:
+
+  gem install launchpad
+
+
+== Usage
+
+There are two main entry points:
+
+* require 'launchpad/device', providing Launchpad::Device, which handles all the basic input/output stuff
+* require 'launchpad/interaction' or just 'launchpad', additionally providing Launchpad::Interaction, which lets you respond to actions (button presses/releases)
+
+This is a simple example (only requiring the device for output) that switches on all LEDs (for testing), resets the launchpad again and then lights the grid button at position 4/4 (from top left).
+
+  require 'launchpad/device'
+
+  device = Launchpad::Device.new
+  device.test_leds
+  sleep 1
+  device.reset
+  sleep 1
+  device.change :grid, :x => 4, :y => 4, :red => :high, :green => :low
+
+This is an interaction example lighting all grid buttons in red when pressed and keeping them lit.
+
+  require 'launchpad'
+
+  interaction = Launchpad::Interaction.new
+  interaction.response_to(:grid, :down) do |interaction, action|
+    interaction.device.change(:grid, action.merge(:red => :high))
+  end
+  interaction.response_to(:mixer, :down) do |interaction, action|
+    interaction.stop
+  end
+
+  interaction.start
+
+
+For more details, see the examples. examples/color_picker.rb is the most complex example with interaction.
+
+
+== Future plans
+
+* bitmap rendering
+* internal tracking of LED states for both buffers
+
+
+== Changelog
+
+=== v.0.3.0
+
+* logging
+* reworked multi threading for action handling
+* compatibility with ruby 1.8.7 and 2.0.0
+* interaction responses for presses on single grid buttons/button areas/columns/rows
+
+=== v.0.2.2
+
+* single threading fix: prevent ThreadError when Launchpad::Interaction#stop is called within an action response
+
+=== v.0.2.1
+
+* Launchpad::Interaction#close now properly stops interaction first
+* multi threading: Launchpad::Interaction#start method can be called with :detached => true to allow calling thread to continue
+
+=== 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
+* ability to initialize devices using device ids as well as device names
+* complete documentation for http://rdoc.info/projects/thomasjachmann/launchpad
+
+=== v0.1.0
+
+* first feature complete version with kinda stable API
+
+
+== Copyright
+
+Copyright (c) 2009 Thomas Jachmann. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/examples/binary_clock.rb

@@ -0,0 +1,29 @@
+require 'launchpad'
+
+device = Launchpad::Device.new
+
+on = { :red => :high, :green => :off }
+off = { :red => :off, :green => :lo }
+
+digit_map = [
+  [off, off, off, off],
+  [on , off, off, off],
+  [off, on , off, off],
+  [on , on , off, off],
+  [off, off, on , off],
+  [on , off, on , off],
+  [off, on , on , off],
+  [on , on , on , off],
+  [off, off, off, on ],
+  [on , off, off, on ]
+]
+
+while true do
+  Time.now.strftime('%H%M%S').split('').each_with_index do |digit, x|
+    digit_map[digit.to_i].each_with_index do |color, y|
+      device.change :grid, color.merge(:x => x, :y => (7 - y))
+    end
+  end
+
+  sleep 0.25
+end

data/examples/color_picker.rb

@@ -0,0 +1,96 @@
+require 'launchpad'
+
+interaction = Launchpad::Interaction.new
+
+# build color arrays for color display views
+colors_single = [
+  [ 0,  1,  2,  3,  0,  0,  0,  0],
+  [16, 17, 18, 19,  0,  0,  0,  0],
+  [32, 33, 34, 35,  0,  0,  0,  0],
+  [48, 49, 50, 51,  0,  0,  0,  0],
+  [0] * 8,
+  [0] * 8,
+  [0] * 8,
+  [0] * 8,
+  [0] * 8
+]
+colors_double = [
+  [ 0,  0,  1,  1,  2,  2,  3,  3],
+  [ 0,  0,  1,  1,  2,  2,  3,  3],
+  [16, 16, 17, 17, 18, 18, 19, 19],
+  [16, 16, 17, 17, 18, 18, 19, 19],
+  [32, 32, 33, 33, 34, 34, 35, 35],
+  [32, 32, 33, 33, 34, 34, 35, 35],
+  [48, 48, 49, 49, 50, 50, 51, 51],
+  [48, 48, 49, 49, 50, 50, 51, 51],
+  [0] * 8
+]
+colors_mirrored = [
+  [ 0,  1,  2,  3,  3,  2,  1,  0],
+  [16, 17, 18, 19, 19, 18, 17, 16],
+  [32, 33, 34, 35, 35, 34, 33, 32],
+  [48, 49, 50, 51, 51, 50, 49, 48],
+  [48, 49, 50, 51, 51, 50, 49, 48],
+  [32, 33, 34, 35, 35, 34, 33, 32],
+  [16, 17, 18, 19, 19, 18, 17, 16],
+  [ 0,  1,  2,  3,  3,  2,  1,  0],
+  [0] * 8
+]
+
+# setup color display views
+def display_color_view(colors)
+  lambda do |interaction, action|
+    # set color
+    interaction.device.change_all(colors)
+    # register mute interactor on scene buttons
+    interaction.response_to(%w(scene1 scene2 scene3 scene4 scene5 scene6 scene7 scene8), :down, :exclusive => true, &@mute)
+  end
+end
+interaction.response_to(:up, :down, &display_color_view(colors_single + [48, 16, 16, 16]))
+interaction.response_to(:down, :down, &display_color_view(colors_double + [16, 48, 16, 16]))
+interaction.response_to(:left, :down, &display_color_view(colors_mirrored + [16, 16, 48, 16]))
+
+# setup color picker view
+def display_color(opts)
+  lambda do |interaction, action|
+    @red = opts[:red] if opts[:red]
+    @green = opts[:green] if opts[:green]
+    colors = [(@green * 16 + @red)] * 64
+    scenes = [@red == 3 ? 51 : 3, @red == 2 ? 51 : 2, @red == 1 ? 51 : 1, @red == 0 ? 51 : 0, @green == 3 ? 51 : 48, @green == 2 ? 51 : 32, @green == 1 ? 51 : 16, @green == 0 ? 51 : 0]
+    interaction.device.change_all(colors + scenes + [16, 16, 16, 48])
+  end
+end
+interaction.response_to(:right, :down) do |interaction, action|
+  @red = 0
+  @green = 0
+  # 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))
+  # display color
+  interaction.respond_to(:scene8, :down)
+end
+
+# 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
+
+# setup mute display interactors on all unused buttons
+@mute = display_color_view([0] * 72 + [16, 16, 16, 16])
+interaction.response_to(%w(session user1 user2 grid), :down, &@mute)
+
+# display mute view
+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/examples/colors.rb

@@ -0,0 +1,21 @@
+require 'launchpad'
+
+device = Launchpad::Device.new(:input => false, :output => true)
+
+pos_x = pos_y = 0
+4.times do |red|
+  4.times do |green|
+    device.change :grid, :x => pos_x, :y => pos_y, :red => red, :green => green
+    device.change :grid, :x => 7 - pos_x, :y => pos_y, :red => red, :green => green
+    device.change :grid, :x => pos_x, :y => 7 - pos_y, :red => red, :green => green
+    device.change :grid, :x => 7 - pos_x, :y => 7 - pos_y, :red => red, :green => green
+    pos_y += 1
+    # sleep, otherwise the connection drops some messages - WTF?
+    sleep 0.01
+  end
+  pos_x += 1
+  pos_y = 0
+end
+
+# sleep so that the messages can be sent before the program terminates
+sleep 0.1

data/examples/doodle.rb

@@ -0,0 +1,68 @@
+require 'launchpad'
+
+interaction = Launchpad::Interaction.new
+
+current_color = {
+  :red    => :hi,
+  :green  => :hi,
+  :mode   => :normal
+}
+
+def update_scene_buttons(d, color)
+  on = {:red => :hi, :green => :hi}
+  d.change(:scene1, color[:red] == :hi ? on : {:red => :hi})
+  d.change(:scene2, color[:red] == :med ? on : {:red => :med})
+  d.change(:scene3, color[:red] == :lo ? on : {:red => :lo})
+  d.change(:scene4, color[:red] == :off ? on : {:red => :off})
+  d.change(:scene5, color[:green] == :hi ? on : {:green => :hi})
+  d.change(:scene6, color[:green] == :med ? on : {:green => :med})
+  d.change(:scene7, color[:green] == :lo ? on : {:green => :lo})
+  d.change(:scene8, color[:green] == :off ? on : {:green => :off})
+  d.change(:user1, :green => color[:mode] == :normal ? :lo : :hi, :mode => :flashing)
+  d.change(:user2, :green => color[:mode] == :normal ? :hi : :lo)
+end
+
+def choose_color(color, opts)
+  lambda do |interaction, action|
+    color.update(opts)
+    update_scene_buttons(interaction.device, color)
+  end
+end
+
+# register color picker interactors on scene buttons
+interaction.response_to(:scene1, :down, &choose_color(current_color, :red => :hi))
+interaction.response_to(:scene2, :down, &choose_color(current_color, :red => :med))
+interaction.response_to(:scene3, :down, &choose_color(current_color, :red => :lo))
+interaction.response_to(:scene4, :down, &choose_color(current_color, :red => :off))
+interaction.response_to(:scene5, :down, &choose_color(current_color, :green => :hi))
+interaction.response_to(:scene6, :down, &choose_color(current_color, :green => :med))
+interaction.response_to(:scene7, :down, &choose_color(current_color, :green => :lo))
+interaction.response_to(:scene8, :down, &choose_color(current_color, :green => :off))
+
+# register mode picker interactors on user buttons
+interaction.response_to(:user1, :down, &choose_color(current_color, :mode => :flashing))
+interaction.response_to(:user2, :down, &choose_color(current_color, :mode => :normal))
+
+# update scene buttons and start flashing
+update_scene_buttons(interaction.device, current_color)
+interaction.device.flashing_auto
+
+# feedback for grid buttons
+interaction.response_to(:grid, :down) do |interaction, action|
+  #coord = 16 * action[:y] + action[:x]
+  #brightness = flags[coord] ? :off : :hi
+  #flags[coord] = !flags[coord]
+  interaction.device.change(:grid, action.merge(current_color))
+end
+
+# 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 interacting
+interaction.start
+
+# sleep so that the messages can be sent before the program terminates
+sleep 0.1

data/examples/double_buffering.rb

@@ -0,0 +1,104 @@
+require 'launchpad'
+
+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