unimidi 0.1.14-i686-linux → 0.2.0-i686-linux

data/README.rdoc

@@ -7,14 +7,16 @@ Platform independent realtime MIDI input and output for Ruby.
 == Features
 
 * Supports Linux, JRuby, OSX, Windows and Cygwin
+* No compilation required
 * Both input and output to and from multiple devices concurrently
 * Agnostically handle different MIDI and SysEx Message types
+* (OSX Only) Internally patch to other programs using IAC and {MIDI Patch Bay}[http://www.apple.com/downloads/macosx/audio/midipatchbay.html]
 
 == Requirements
 
 Ruby 1.9.2 or JRuby 1.6.1 are strongly recommended
 
-One of the following libraries is required based on what platform you're using.  They should all install automatically when you install the unimidi gem.  You can freely remove the ones that do not apply to your platform
+One of the following libraries is required based on what platform you're using.  It should install automatically with the unimidi gem.  In some uncommon cases, they will all install
 
 Platform
 
@@ -26,31 +28,48 @@ Platform
 == Install
 
   gem install unimidi
-  
-No compilation required
 	
-== Examples
+== Usage
 
+Here's a {blog post}[http://tx81z.blogspot.com/2011/06/unimidi-platform-independent-realtime.html] with a quick tutorial to {get started}[http://tx81z.blogspot.com/2011/06/unimidi-platform-independent-realtime.html].
+
+Here's another {blog post}[http://tx81z.blogspot.com/2011/06/high-level-midi-io-with-ruby.html] that {explains how to do high-level messaging}[http://tx81z.blogspot.com/2011/06/high-level-midi-io-with-ruby.html]
+
+In addition, some examples are included with the library
+
+* {selecting a device}[http://github.com/arirusso/unimidi/blob/master/examples/select_a_device.rb]
 * {input}[http://github.com/arirusso/unimidi/blob/master/examples/input.rb]
 * {output}[http://github.com/arirusso/unimidi/blob/master/examples/output.rb]
 
-{more}[http://github.com/arirusso/unimidi/blob/master/examples]
+{more examples}[http://github.com/arirusso/unimidi/blob/master/examples]
+
+Here's another {blog post}[http://tx81z.blogspot.com/2011/06/osx-unimidi-and-midi-patch-bay.html] about {using unimidi with MIDI Patch Bay on OSX}[http://tx81z.blogspot.com/2011/06/osx-unimidi-and-midi-patch-bay.html]
 
 == Tests
 
-* please see {test/config.rb}[http://github.com/arirusso/unimidi/blob/master/test/config.rb] before running tests
+There are a set of generic tests which assume that an output is connected to an input.  If you wish to run these tests, first edit {test/config.rb}[http://github.com/arirusso/unimidi/blob/master/test/config.rb] to configure it to your setup. 
+
+The tests can be run using
+
+  rake test
+
+See below for additional notes on testing with JRuby
 
 == Documentation
 
 * {rdoc}[http://rdoc.info/gems/unimidi]
 
-== If you are using JRuby
+== Platform Specific Notes
 
-A couple of notes
+==== JRuby
 
 * You must be in 1.9 mode.  This is normally accomplished by passing --1.9 to JRuby at the command line.  For testing in 1.9 mode, use 
     jruby --1.9 -S rake test
 * javax.sound has some documented issues with SysEx messages in some versions OSX Snow Leopard which do affect this library.
+
+==== Linux
+
+* libasound and libasound-dev packages are required
 	
 == Author 
 

data/lib/unimidi.rb

@@ -6,7 +6,7 @@
 
 module UniMIDI
   
-  VERSION = "0.1.14"
+  VERSION = "0.2.0"
  
 end
 

data/lib/unimidi/congruous_api_adapter.rb

@@ -182,9 +182,21 @@ module UniMIDI
     # bytes eg output.puts(0x90, 0x40, 0x40)
     # an array of bytes eg output.puts([0x90, 0x40, 0x40])
     # or a string eg output.puts("904040")
+    # if none of those types are found, unimidi will attempt 
+    # to call to_bytes and then to_a on the object
     #
     def puts(*a)
-      @device.puts(*a)
+      case a.first
+        when Array then puts_bytes(*a.first)
+        when Numeric then puts_bytes(*a)
+        when String then puts_s(*a)
+        else
+          if a.first.respond_to?(:to_bytes)
+            puts_bytes(*a.first.to_bytes.flatten)
+          elsif a.first.respond_to?(:to_a) 
+            puts_bytes(*a.first.to_a.flatten)
+          end
+      end
     end
 
     # sends a message to the output in a form of a string eg "904040".  this method does not do

data/test/config.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+module TestHelper::Config
+
+  # adjust these constants to suit your hardware configuration
+  # before running tests
+
+  TestInput = UniMIDI::Input.first # this is the device you wish to use to test input
+  TestOutput = UniMIDI::Output.first # likewise for output
+
+  puts "connect #{TestInput.name} (#{TestInput.id}) to #{TestOutput.name} (#{TestOutput.id}) and press enter"
+  $stdin.gets.chomp
+
+end
+

data/test/helper.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+
+require 'test/unit'
+require 'unimidi'
+
+module TestHelper
+  
+  TestSysex = !RUBY_PLATFORM.include?("java") 
+  
+  def platform_test(adapter, mod)
+    assert_equal(adapter, UniMIDI::Platform.instance.interface)
+    assert_not_same(mod::Input, UniMIDI::Input)
+    assert_not_same(mod::Output, UniMIDI::Output)
+    assert_not_same(mod::Device, UniMIDI::Device)
+    assert_equal(mod::Input.first.name, UniMIDI::Input.first.name)
+    assert_equal(mod::Input.first.id, UniMIDI::Input.first.id)
+    assert_not_same(mod::Output.first, UniMIDI::Output.first)
+    assert_equal(mod::Output.first.name, UniMIDI::Output.first.name)
+    assert_equal(mod::Output.first.id, UniMIDI::Output.first.id)
+  end
+	    
+  def bytestrs_to_ints(arr)
+    data = arr.map { |m| m[:data] }.join
+      output = []
+      until (bytestr = data.slice!(0,2)).eql?("")
+        output << bytestr.hex
+      end
+    output    	
+  end
+  
+  class MIDIObj
+    def initialize(*bytes)
+      @bytes = bytes
+    end
+    def to_bytes
+      @bytes
+    end
+  end 
+  
+  # some MIDI messages
+  VariousMIDIObjects = [
+    TestSysex ? MIDIObj.new(0xF0, 0x41, 0x10, 0x42, 0x12, 0x40, 0x00, 0x7F, 0x00, 0x41, 0xF7) : nil, # SysEx
+    MIDIObj.new(0x90, 100, 100), # note on
+    MIDIObj.new(0x90, 43, 100), # note on
+    MIDIObj.new(0x90, 76, 100), # note on
+    MIDIObj.new(0x90, 60, 100), # note on
+    MIDIObj.new(0x80, 100, 100) # note off
+  ].compact
+    
+  # some MIDI messages
+  VariousMIDIMessages = [
+    TestSysex ? [0xF0, 0x41, 0x10, 0x42, 0x12, 0x40, 0x00, 0x7F, 0x00, 0x41, 0xF7] : nil, # SysEx
+    [0x90, 100, 100], # note on
+    [0x90, 43, 100], # note on
+    [0x90, 76, 100], # note on
+    [0x90, 60, 100], # note on
+    [0x80, 100, 100] # note off
+  ].compact
+    
+  # some MIDI messages
+  VariousMIDIByteStrMessages = [
+    TestSysex ? "F04110421240007F0041F7" : nil, # SysEx
+    "906440", # note on
+    "804340" # note off
+  ].compact
+    
+end
+
+require File.dirname(__FILE__) + '/config'

data/test/test_input_buffer.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'helper'
+
+class InputBufferTest < Test::Unit::TestCase
+
+  include UniMIDI
+  include TestHelper
+  include TestHelper::Config # before running these tests, adjust the constants in config.rb to suit your hardware setup
+  
+ def test_input_buffer
+    sleep(1)
+
+    messages = VariousMIDIMessages
+    bytes = []
+
+    TestOutput.open do |output|
+      TestInput.open do |input|
+
+        messages.each do |msg|
+
+          $>.puts "sending: " + msg.inspect
+
+          output.puts(msg)
+          
+          bytes += msg 
+          
+          sleep(0.5)
+          
+          buffer = input.buffer.map { |m| m[:data] }.flatten
+
+          $>.puts "received: " + buffer.to_s
+          
+          assert_equal(bytes, buffer)
+
+        end
+        
+        assert_equal(bytes.length, input.buffer.map { |m| m[:data] }.flatten.length)
+
+      end
+    end
+  end
+
+end

data/test/test_io.rb

@@ -0,0 +1,117 @@
+#!/usr/bin/env ruby
+
+require 'helper'
+
+class IoTest < Test::Unit::TestCase
+
+  include UniMIDI
+  include TestHelper
+  include TestHelper::Config # before running these tests, adjust the constants in config.rb to suit your hardware setup
+
+  # ** this test assumes that TestOutput is connected to TestInput
+  def test_full_io
+    sleep(1)
+    messages = VariousMIDIMessages
+    messages_arr = messages.inject { |a,b| a+b }.flatten
+    received_arr = []
+    pointer = 0
+    TestOutput.open do |output|
+      TestInput.open do |input|
+
+        messages.each do |msg|
+
+          $>.puts "sending: " + msg.inspect
+
+          output.puts(msg)
+          sleep(1)
+          received = input.gets.map { |m| m[:data] }.flatten
+          
+
+          $>.puts "received: " + received.inspect
+
+          assert_equal(messages_arr.slice(pointer, received.length), received)
+          
+          pointer += received.length
+          
+          received_arr += received
+          
+        end
+        
+        assert_equal(messages_arr.length, received_arr.length)
+
+      end
+    end
+  end
+
+  # ** this test assumes that TestOutput is connected to TestInput
+  def test_full_io_bytestr
+    sleep(1) # pause between tests
+
+    messages = VariousMIDIByteStrMessages
+    messages_str = messages.join
+    received_str = ""
+    pointer = 0
+
+    TestOutput.open do |output|
+      TestInput.open do |input|
+
+        messages.each do |msg|
+
+          $>.puts "sending: " + msg.inspect
+
+          output.puts(msg)
+          sleep(1)
+          received = input.gets_bytestr.map { |m| m[:data] }.flatten.join
+          $>.puts "received: " + received.inspect
+
+          assert_equal(messages_str.slice(pointer, received.length), received)
+          
+          pointer += received.length
+          
+          received_str += received
+          
+        end
+   
+        assert_equal(messages_str, received_str)
+        
+      end
+    end
+
+  end
+  
+  # ** this test assumes that TestOutput is connected to TestInput
+  def test_full_io_objects
+    sleep(1)
+    messages = VariousMIDIObjects
+    messages_arr = messages.map { |m| m.to_bytes }.flatten
+    received_arr = []
+    pointer = 0
+    TestOutput.open do |output|
+      TestInput.open do |input|
+
+        messages.each do |msg|
+
+          $>.puts "sending: " + msg.inspect
+
+          output.puts(msg)
+          sleep(1)
+          received = input.gets.map { |m| m[:data] }.flatten
+          
+
+          $>.puts "received: " + received.inspect
+
+          assert_equal(messages_arr.slice(pointer, received.length), received)
+          
+          pointer += received.length
+          
+          received_arr += received
+          
+        end
+        
+        assert_equal(messages_arr.length, received_arr.length)
+
+      end
+    end
+  end
+
+end

data/test/test_platform.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require 'helper'
+
+class PlatformTest < Test::Unit::TestCase
+
+  include UniMIDI
+  include TestHelper
+  include TestHelper::Config
+    
+  def test_jruby
+    if RUBY_PLATFORM.include?("java")
+      platform_test(MIDIJRubyAdapter, MIDIJRuby)
+    end
+  end
+    
+  def test_linux
+    if RUBY_PLATFORM.include?("linux")
+      platform_test(AlsaRawMIDIAdapter, AlsaRawMIDI)
+    end  
+  end
+  
+  def test_osx
+    if RUBY_PLATFORM.include?("darwin")
+      platform_test(CoreMIDIAdapter, CoreMIDI)
+    end  
+  end
+  
+  def test_windows
+    if RUBY_PLATFORM.include?("mingw")
+      platform_test(MIDIWinMMAdapter, MIDIWinMM)
+    end
+  end  
+  
+end

metadata

@@ -2,7 +2,7 @@
 name: unimidi
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.14
+  version: 0.2.0
 platform: i686-linux
 authors: 
 - Ari Russo
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-23 00:00:00 -04:00
+date: 2011-07-07 00:00:00 -04:00
 default_executable: unimidi
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,7 +24,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-description: Platform Independent, realtime MIDI input and output for Ruby.
+description: Platform Independent, realtime MIDI input and output for Ruby
 email: 
 - ari.russo@gmail.com
 executables: 
@@ -35,14 +35,19 @@ extra_rdoc_files: []
 
 files: 
 - bin/unimidi
-- lib/unimidi/type_conversion.rb
-- lib/unimidi/platform.rb
-- lib/unimidi/adapter/alsa-rawmidi.rb
+- lib/unimidi.rb
 - lib/unimidi/adapter/ffi-coremidi.rb
 - lib/unimidi/adapter/midi-winmm.rb
+- lib/unimidi/adapter/alsa-rawmidi.rb
 - lib/unimidi/adapter/midi-jruby.rb
 - lib/unimidi/congruous_api_adapter.rb
-- lib/unimidi.rb
+- lib/unimidi/platform.rb
+- lib/unimidi/type_conversion.rb
+- test/helper.rb
+- test/config.rb
+- test/test_io.rb
+- test/test_input_buffer.rb
+- test/test_platform.rb
 - LICENSE
 - README.rdoc
 has_rdoc: true
@@ -72,6 +77,6 @@ rubyforge_project: unimidi
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Realtime MIDI input and output for Ruby.
+summary: Realtime MIDI input and output for Ruby
 test_files: []