unimidi 0.1.14 → 0.2.0

data/LICENSE

@@ -1,13 +1,13 @@
-Copyright 2010-2011 Ari Russo
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
+Copyright 2010-2011 Ari Russo
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
 limitations under the License.

data/README.rdoc

@@ -1,63 +1,82 @@
-= UniMIDI
-
-== Summary
-
-Platform independent realtime MIDI input and output for Ruby.
-
-== Features
-
-* Supports Linux, JRuby, OSX, Windows and Cygwin
-* Both input and output to and from multiple devices concurrently
-* Agnostically handle different MIDI and SysEx Message types
-
-== Requirements
-
-Ruby 1.9.2 or JRuby 1.6.1 are strongly recommended
-
-One of the following libraries is required based on what platform is being used.  It should install automatically when you install the unimidi gem
-
-Platform
-
-* JRuby: {midi-jruby}[http://github.com/arirusso/midi-jruby]
-* Linux: {alsa-rawmidi}[http://github.com/arirusso/alsa-rawmidi]
-* OSX: {ffi-coremidi}[http://github.com/arirusso/ffi-coremidi]
-* Windows/Cygwin: {midi-winmm}[http://github.com/arirusso/midi-winmm]
-	
-== Install
-
-  gem install unimidi
-  
-No compilation required
-	
-== Examples
-
-* {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]
-
-== Tests
-
-* please see {test/config.rb}[http://github.com/arirusso/unimidi/blob/master/test/config.rb] before running tests
-
-== Documentation
-
-* {rdoc}[http://rdoc.info/gems/unimidi]
-
-== If you are using JRuby
-
-A couple of notes
-
-* 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.
-	
-== Author 
-
-{Ari Russo}[http://github.com/arirusso] <ari.russo at gmail.com>
-		
-== License
-
-Apache 2.0, See the file LICENSE
-
-Copyright (c) 2010-2011 Ari Russo  
+= UniMIDI
+
+== Summary
+
+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.  It should install automatically with the unimidi gem.  In some uncommon cases, they will all install
+
+Platform
+
+* JRuby: {midi-jruby}[http://github.com/arirusso/midi-jruby]
+* Linux: {alsa-rawmidi}[http://github.com/arirusso/alsa-rawmidi]
+* OSX: {ffi-coremidi}[http://github.com/arirusso/ffi-coremidi]
+* Windows/Cygwin: {midi-winmm}[http://github.com/arirusso/midi-winmm]
+	
+== Install
+
+  gem install unimidi
+	
+== 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 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
+
+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]
+
+== Platform Specific 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 
+
+{Ari Russo}[http://github.com/arirusso] <ari.russo at gmail.com>
+		
+== License
+
+Apache 2.0, See the file LICENSE
+
+Copyright (c) 2010-2011 Ari Russo  

data/bin/unimidi

@@ -1,10 +1,10 @@
-#!/usr/bin/env ruby
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-
-require 'unimidi'
-
-opts = ARGV.length > 1 ? ARGV.slice(1, ARGV.length-1) : {} 
-  
-raise "No command specified" if ARGV.first.nil? 
- 
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'unimidi'
+
+opts = ARGV.length > 1 ? ARGV.slice(1, ARGV.length-1) : {} 
+  
+raise "No command specified" if ARGV.first.nil? 
+ 
 UniMIDI.command(ARGV.first.to_sym, opts)

data/lib/unimidi.rb

@@ -1,31 +1,31 @@
-#!/usr/bin/env ruby
-#
-# A realtime MIDI interface for Ruby
-# (c)2010-2011 Ari Russo and licensed under the Apache 2.0 License
-#
-
-module UniMIDI
-  
-  VERSION = "0.1.14"
- 
-end
-
-require 'forwardable'
-
-require 'unimidi/congruous_api_adapter'
-require 'unimidi/platform'
-require 'unimidi/type_conversion'
-
-module UniMIDI
-  extend(Platform.instance.interface)
-  include(Platform.instance.interface)
-  
-  def self.command(command, options = {})
-    if [:l, :list, :list_devices].include?(command)
-      require 'pp'
-      pp Device::all
-    else
-      raise "Command #{command.to_s} not found"
-    end      
-  end
-end
+#!/usr/bin/env ruby
+#
+# A realtime MIDI interface for Ruby
+# (c)2010-2011 Ari Russo and licensed under the Apache 2.0 License
+#
+
+module UniMIDI
+  
+  VERSION = "0.2.0"
+ 
+end
+
+require 'forwardable'
+
+require 'unimidi/congruous_api_adapter'
+require 'unimidi/platform'
+require 'unimidi/type_conversion'
+
+module UniMIDI
+  extend(Platform.instance.interface)
+  include(Platform.instance.interface)
+  
+  def self.command(command, options = {})
+    if [:l, :list, :list_devices].include?(command)
+      require 'pp'
+      pp Device::all
+    else
+      raise "Command #{command.to_s} not found"
+    end      
+  end
+end

data/lib/unimidi/adapter/alsa-rawmidi.rb

@@ -1,26 +1,26 @@
-#!/usr/bin/env ruby
-#
-
-require 'alsa-rawmidi'
-
-module UniMIDI
-
-  module AlsaRawMIDIAdapter
-    
-    class Input < CongruousApiInput
-      defer_to AlsaRawMIDI::Input
-    end
-
-    class Output < CongruousApiOutput
-      defer_to AlsaRawMIDI::Output
-    end
-    
-    class Device < CongruousApiDevice
-      defer_to AlsaRawMIDI::Device
-      input_class Input
-      output_class Output
-    end
-    
-  end
-
+#!/usr/bin/env ruby
+#
+
+require 'alsa-rawmidi'
+
+module UniMIDI
+
+  module AlsaRawMIDIAdapter
+    
+    class Input < CongruousApiInput
+      defer_to AlsaRawMIDI::Input
+    end
+
+    class Output < CongruousApiOutput
+      defer_to AlsaRawMIDI::Output
+    end
+    
+    class Device < CongruousApiDevice
+      defer_to AlsaRawMIDI::Device
+      input_class Input
+      output_class Output
+    end
+    
+  end
+
 end

data/lib/unimidi/adapter/ffi-coremidi.rb

@@ -1,26 +1,26 @@
-#!/usr/bin/env ruby
-#
-
-require 'coremidi'
-
-module UniMIDI
-
-  module CoreMIDIAdapter
-    
-    class Input < CongruousApiInput
-      defer_to CoreMIDI::Input
-    end
-
-    class Output < CongruousApiOutput
-      defer_to CoreMIDI::Output
-    end
-    
-    class Device < CongruousApiDevice
-      defer_to CoreMIDI::Entity
-      input_class Input
-      output_class Output
-    end
-    
-  end
-
+#!/usr/bin/env ruby
+#
+
+require 'coremidi'
+
+module UniMIDI
+
+  module CoreMIDIAdapter
+    
+    class Input < CongruousApiInput
+      defer_to CoreMIDI::Input
+    end
+
+    class Output < CongruousApiOutput
+      defer_to CoreMIDI::Output
+    end
+    
+    class Device < CongruousApiDevice
+      defer_to CoreMIDI::Entity
+      input_class Input
+      output_class Output
+    end
+    
+  end
+
 end

data/lib/unimidi/adapter/midi-jruby.rb

@@ -1,26 +1,26 @@
-#!/usr/bin/env ruby
-#
-
-require 'midi-jruby'
-
-module UniMIDI
-
-  module MIDIJRubyAdapter
-    
-    class Input < CongruousApiInput
-      defer_to MIDIJRuby::Input
-    end
-
-    class Output < CongruousApiOutput
-      defer_to MIDIJRuby::Output
-    end
-    
-    class Device < CongruousApiDevice
-      defer_to MIDIJRuby::Device
-      input_class Input
-      output_class Output
-    end
-
-  end
-
+#!/usr/bin/env ruby
+#
+
+require 'midi-jruby'
+
+module UniMIDI
+
+  module MIDIJRubyAdapter
+    
+    class Input < CongruousApiInput
+      defer_to MIDIJRuby::Input
+    end
+
+    class Output < CongruousApiOutput
+      defer_to MIDIJRuby::Output
+    end
+    
+    class Device < CongruousApiDevice
+      defer_to MIDIJRuby::Device
+      input_class Input
+      output_class Output
+    end
+
+  end
+
 end

data/lib/unimidi/adapter/midi-winmm.rb

@@ -1,26 +1,26 @@
-#!/usr/bin/env ruby
-#
-
-require 'midi-winmm'
-
-module UniMIDI
-
-  module MIDIWinMMAdapter
-    
-    class Input < CongruousApiInput
-      defer_to MIDIWinMM::Input
-    end
-
-    class Output < CongruousApiOutput
-      defer_to MIDIWinMM::Output
-    end
-    
-    class Device < CongruousApiDevice
-      defer_to MIDIWinMM::Device
-      input_class Input
-      output_class Output
-    end
-
-  end
-
+#!/usr/bin/env ruby
+#
+
+require 'midi-winmm'
+
+module UniMIDI
+
+  module MIDIWinMMAdapter
+    
+    class Input < CongruousApiInput
+      defer_to MIDIWinMM::Input
+    end
+
+    class Output < CongruousApiOutput
+      defer_to MIDIWinMM::Output
+    end
+    
+    class Device < CongruousApiDevice
+      defer_to MIDIWinMM::Device
+      input_class Input
+      output_class Output
+    end
+
+  end
+
 end