unimidi 0.3.5 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed90b779061c05a4d9de9aaf94175fc0f616df1a
-  data.tar.gz: 0dc1da5d5695baed5abbc980c7e322309409b54b
+  metadata.gz: a75ecec80f113f9831ddabe50fbb3a00e183faae
+  data.tar.gz: 174c3ec107b0d696f8780708c83a9abf8a1e33ca
 SHA512:
-  metadata.gz: bf13056a209f9b9dd456f2d2fcfa8a7859f290ec2957d334e91a163911f74c892d292d1c12ea947cd8f86c26a089e6862c6fd38ee5db54b80f43d75b346cff1e
-  data.tar.gz: 2d6cf96e42bbe5384bf41212c2db0abc1aea88bdeca82b66ba744069aaf0f54470e7e27de3ec23c040d403131108e6712ccb251cf8bfc98ab59d411564f7d10e
+  metadata.gz: f1b430c23cb93b0373834bab0c66a25286dc5ca6bcee99e963b3d40892781f7b076b00a13ada2828bc871d035706d63d2fa774e101a4c965df1b28ea05bcc5e3
+  data.tar.gz: cae4027fefcbb3b0a06cebbe1eefba944b7ca55419fc025cf752f1604915ce19845a70290aeae3cd941491c30b8dc5b53b4ffb7681235221356be95d0d7fa195

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2010-2013 Ari Russo
+Copyright 2010-2014 Ari Russo
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -9,14 +9,14 @@ Also see [MicroMIDI](http://github.com/arirusso/micromidi) which builds a full M
 * 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
+* Generalized handling of different MIDI and SysEx Message types
 * (OSX Only) Use IAC to internally route MIDI to other programs
 
 ### Requirements
 
 Using Ruby 1.9.2 or JRuby 1.6.1 (or newer) is strongly recommended.  JRuby should be run in 1.9 mode where applicable
 
-UniMIDI uses one of the following libraries, depending on which platform you're using it on.  The necessary library should install automatically with the unimidi gem.  In some uncommon cases, they will all install
+UniMIDI uses one of the following libraries, depending on which platform you're using it on.  The necessary library should install automatically with the unimidi gem. 
 
 Platform
 
@@ -84,4 +84,4 @@ See below for additional notes on testing with JRuby
 
 Apache 2.0, See the file LICENSE
 
-Copyright (c) 2010-2013 Ari Russo  
+Copyright (c) 2010-2014 Ari Russo  

data/lib/unimidi.rb

@@ -1,34 +1,24 @@
-# A realtime MIDI interface for Ruby
-# (c)2010-2013 Ari Russo and licensed under the Apache 2.0 License
-module UniMIDI
-  
-  VERSION = "0.3.5"
- 
-end
-
-# libs
-require "forwardable"
-require "singleton"
+#
+# Realtime MIDI IO for Ruby
+#
+# (c)2010-2014 Ari Russo and licensed under the Apache 2.0 License
+#
 
 # modules
-require "unimidi/congruous_api_adapter"
+require "unimidi/command"
+require "unimidi/device"
+require "unimidi/loader"
+require "unimidi/platform"
 require "unimidi/type_conversion"
 
 # classes
-require "unimidi/platform"
+require "unimidi/input"
+require "unimidi/output"
 
 module UniMIDI
-  extend(Platform.instance.interface)
-  include(Platform.instance.interface)
-  
-  def self.command(command, options = {})
-    if [:l, :list, :list_devices].include?(command)
-      puts "input:"
-      Input.list
-      puts "output:"
-      Output.list
-    else
-      raise "Command #{command.to_s} not found"
-    end      
-  end
+
+  VERSION = "0.4.4"
+
+  Platform.bootstrap
+
 end

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

@@ -1,25 +1,30 @@
-require 'alsa-rawmidi'
+require "alsa-rawmidi"
 
 module UniMIDI
 
-  module AlsaRawMIDIAdapter
-    
-    class Input < CongruousApiInput
-      defer_to AlsaRawMIDI::Input
-      device_class AlsaRawMIDI::Device
-    end
+  module Adapter
+
+    # Load underlying devices using the alsa-rawmidi gem
+    module AlsaRawMIDI
+
+      module Loader
+
+        extend self
+
+        # @return [Array<AlsaRawMIDI::Input>]
+        def inputs
+          ::AlsaRawMIDI::Device.all_by_type[:input]
+        end
+
+        # @return [Array<AlsaRawMIDI::Output>]
+        def outputs
+          ::AlsaRawMIDI::Device.all_by_type[:output]
+        end
+
+      end
 
-    class Output < CongruousApiOutput
-      defer_to AlsaRawMIDI::Output
-      device_class AlsaRawMIDI::Device
-    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,34 +1,30 @@
-require 'coremidi'
+require "coremidi"
 
 module UniMIDI
 
-  module CoreMIDIAdapter
-    
-    class Input < CongruousApiInput
-      defer_to CoreMIDI::Source
-      device_class CoreMIDI::Endpoint
-    end
+  module Adapter
+
+    # Load underlying devices using the coremidi gem
+    module CoreMIDI
+
+      module Loader
+
+        extend self
+
+        # @return [Array<CoreMIDI::Source>]
+        def inputs
+          ::CoreMIDI::Endpoint.all_by_type[:source]
+        end
+
+        # @return [Array<CoreMIDI::Destination>]
+        def outputs
+          ::CoreMIDI::Endpoint.all_by_type[:destination]
+        end
 
-    class Output < CongruousApiOutput
-      defer_to CoreMIDI::Destination
-      device_class CoreMIDI::Endpoint
-    end
-    
-    class Device < CongruousApiDevice
-      defer_to CoreMIDI::Endpoint
-      input_class Input
-      output_class Output
-        
-      def self.populate
-        klass = @deference[self].respond_to?(:all_by_type) ? @deference[self] : @device_class
-        @devices = {
-            :input => klass.all_by_type[:source].map { |d| @input_class.new(d) },
-            :output => klass.all_by_type[:destination].map { |d| @output_class.new(d) }
-          }          
       end
-      
+
     end
-    
+
   end
 
 end

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

@@ -1,23 +1,28 @@
-require 'midi-jruby'
+require "midi-jruby"
 
 module UniMIDI
 
-  module MIDIJRubyAdapter
-    
-    class Input < CongruousApiInput
-      defer_to MIDIJRuby::Input
-      device_class MIDIJRuby::Device
-    end
+  module Adapter
+
+    # Load underlying devices using the midi-jruby gem
+    module MIDIJRuby
+
+      module Loader
+
+        extend self
+
+        # @return [Array<MIDIJRuby::Input>]
+        def inputs
+          ::MIDIJRuby::Device.all_by_type[:input]
+        end
+
+        # @return [Array<MIDIJRuby::Output>]
+        def outputs
+          ::MIDIJRuby::Device.all_by_type[:output]
+        end
+
+      end
 
-    class Output < CongruousApiOutput
-      defer_to MIDIJRuby::Output
-      device_class MIDIJRuby::Device
-    end
-    
-    class Device < CongruousApiDevice
-      defer_to MIDIJRuby::Device
-      input_class Input
-      output_class Output
     end
 
   end

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

@@ -1,23 +1,28 @@
-require 'midi-winmm'
+require "midi-winmm"
 
 module UniMIDI
 
-  module MIDIWinMMAdapter
-    
-    class Input < CongruousApiInput
-      defer_to MIDIWinMM::Input
-      device_class MIDIWinMM::Device
-    end
+  module Adapter
+
+    # Load underlying devices using the midi-winmm gem
+    module MIDIWinMM
+
+      module Loader
+
+        extend self
+
+        # @return [Array<MIDIWinMM::Input>]
+        def inputs
+          ::MIDIWinMM::Device.all_by_type[:input]
+        end
+
+        # @return [Array<MIDIWinMM::Output>]
+        def outputs
+          ::MIDIWinMM::Device.all_by_type[:output]
+        end
+
+      end
 
-    class Output < CongruousApiOutput
-      defer_to MIDIWinMM::Output
-      device_class MIDIWinMM::Device
-    end
-    
-    class Device < CongruousApiDevice
-      defer_to MIDIWinMM::Device
-      input_class Input
-      output_class Output
     end
 
   end

data/lib/unimidi/command.rb

@@ -0,0 +1,26 @@
+module UniMIDI
+
+  # Module for command-line use of UniMIDI.  Used by the bin/unimidi script
+  module Command
+
+    extend self
+
+    # Execute a command
+    # @param [Symbol] command
+    # @param [Hash] options
+    # @return [Boolean]
+    def exec(command, options = {})
+      if [:l, :list, :list_devices].include?(command)
+        puts "input:"
+        Input.list
+        puts "output:"
+        Output.list
+        true
+      else
+        raise "Command #{command.to_s} not found"
+      end   
+    end
+
+  end
+
+end

data/lib/unimidi/device.rb

@@ -0,0 +1,182 @@
+module UniMIDI
+
+  # Common logic that is shared by both Input and Output devices
+  module Device
+
+    # Methods that are shared by both Input and Output classes
+    module ClassMethods
+
+      include Enumerable
+
+      # Iterate over all devices of this direction (eg Input, Output)
+      def each(&block)
+        all.each { |device| yield(device) }
+      end
+
+      # Prints ids and names of each device to the console
+      # @return [Array<String>]
+      def list
+        all.map do |device| 
+          name = device.pretty_name
+          puts(name)
+          name
+        end
+      end
+
+      # Shortcut to select a device by its name
+      # @param [String, Symbol] name
+      # @return [Input, Output]
+      def find_by_name(name)
+        all.find { |device| name.to_s == device.name }
+      end
+
+      # Streamlined console prompt that asks the user to select a device
+      # When their input is received, the device is selected and enabled
+      def gets(&block)
+        device = nil
+        class_name = self.name.split("::").last.downcase
+        puts ""
+        puts "Select a MIDI #{class_name}..."
+        while device.nil?
+          list
+          print "> "
+          selection = $stdin.gets.chomp
+          if selection != ""
+            selection = Integer(selection) rescue nil
+            device = all.find { |d| d.id == selection }
+          end
+        end
+        device.open(&block) unless device.enabled?
+        device
+      end
+
+      # Select the first device and enable it
+      # @return [Input, Output]
+      def first(&block)
+        use_device(all.first, &block)
+      end
+
+      # Select the last device and enable it
+      # @return [Input, Output]
+      def last(&block)
+        use_device(all.last, &block)
+      end
+
+      # Select the device at the given index and enable it
+      # @param [Fixnum] index
+      # @return [Input, Output]
+      def use(index, &block)
+        index = case index
+                when :first then 0
+                when :last then all.size - 1
+                else index
+                end
+        use_device(all[index], &block) 
+      end
+      alias_method :open, :use
+
+      # Select the device at the given index
+      # @param [Fixnum] index
+      # @return [Input, Output]
+      def [](index)
+        all[index]
+      end
+
+      private
+
+      # Enable the given device
+      # @param [Input, Output] device
+      # @return [Input, Output]
+      def use_device(device, &block)
+        device.open(&block) unless device.enabled?
+        device         
+      end
+
+    end
+
+    # Methods that are shared by both Input and Output instances
+    module InstanceMethods
+
+      # @param [AlsaRawMIDI::Input, AlsaRawMIDI::Output, CoreMIDI::Destination, CoreMIDI::Source, MIDIJRuby::Input, MIDIJRuby::Output, MIDIWinMM::Input, MIDIWinMM::Output] device
+      def initialize(device)        
+        @device = device
+        @enabled = false
+
+        populate_from_device
+      end
+
+      # Is this device ready for io?
+      # @return [Boolean]
+      def enabled?
+        @enabled = true if @device.enabled # keep the adapter in sync
+        @enabled
+      end
+
+      # Enable the device for use
+      # Params are passed to the underlying device object
+      # Can be passed a block to which the device will be passed in as the yieldparam
+      # @param [*Object] args
+      # @return [Input, Output] self
+      def open(*args, &block)
+        @device.open(*args) unless enabled?
+        @enabled = true
+        if block_given?
+          begin
+            yield(self)
+          ensure
+            close
+          end
+        else
+          at_exit do
+            close
+          end
+          self
+        end
+      end
+
+      # A human readable display name for this device
+      # @return [String]
+      def pretty_name
+        "#{id}) #{name}"
+      end
+
+      # Close the device
+      # Params are passed to the underlying device object
+      # @param [*Object] args
+      # @return [Boolean]
+      def close(*args)
+        @device.close(*args)
+        true
+      end
+
+      # Add attributes for the device instance
+      # :direction, :id, :name
+      def self.included(base)
+        base.send(:attr_reader, :direction)
+        base.send(:attr_reader, :id)
+        base.send(:attr_reader, :name)
+        base.send(:alias_method, :type, :direction)
+      end
+
+      private
+
+      # Populate the direction attribute
+      def populate_direction
+        @direction = case @device.type
+                when :source, :input then :input
+                when :destination, :output then :output
+                end
+      end
+
+      # Populate attributes from the underlying device object
+      def populate_from_device
+        @id = @device.id
+        @name = @device.name
+        populate_direction
+      end
+
+    end
+
+  end
+
+end