midi-instrument 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4dc9ef33817d2595aa97bec2239f28f1b1779bb4
-  data.tar.gz: 05d6227e8b18d1a7a36b439661ea0d7204ec2770
+  metadata.gz: 978dc80ea49edc2731e8f13901b836b097f0d2c8
+  data.tar.gz: b994a8bc8087ed8e7137bbd4104eb1cbb2a9b6b5
 SHA512:
-  metadata.gz: b377e4696a2ab9f80d0c76a10287891883a1ab04162d78b0b0d5c88ba6981f384577ee0b82a1a8fab8da1c8780797699b9cb3f3e3896eb57369354da1cade4cf
-  data.tar.gz: c3c7bf02d6ab64895a10b0319bd7ecf387d40885b0c0c184fd79922149eda6edc776d26715f573d83afa6006448b87d86ec7e24453715d44155d1c5eea6c38be
+  metadata.gz: fb094c3701f256fbebfbca1f8123757c67a16bcbcba813848ab13e1258dd30c8d73af8ce4fb76a0a463d36ebe9d265996dce9654caf9526e39fa30a455d157df
+  data.tar.gz: 7d9f7a393fb61e3001f340f5a0d99ea428792a50f9c990c6cdf0e57d2f6417fef25fc97f6ac9c86520f15516cc8d448907b0aaaa26fd48b3f88cc83127ea40c2

data/lib/midi-instrument.rb

@@ -27,6 +27,6 @@ require "midi-instrument/output"
 
 module MIDIInstrument
   
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
   
 end

data/lib/midi-instrument/api.rb

@@ -1,11 +1,66 @@
 module MIDIInstrument
 
+  # Adds convenience methods when included by Node
   module API
 
-    def self.included(base)
-      base.send(:extend, Forwardable)
-      base.send(:def_delegators, :@input, :omni_on)
-      base.send(:def_delegators, :@output, :mute, :toggle_mute, :mute=, :muted?, :mute?)
+    # Input convenience methods
+    module Input
+
+      def self.included(base)
+        base.send(:extend, Forwardable)
+        base.send(:def_delegators, :@input, :omni_on)
+      end
+
+      # MIDI input devices
+      # @return [Array<UniMIDI::Input>]
+      def inputs
+        @input.devices
+      end
+
+      # MIDI channel messages will only be acknowledged if they have this optional specified channel
+      # @return [Fixnum, nil]
+      def receive_channel
+        @input.channel
+      end
+      alias_method :rx_channel, :receive_channel
+
+      # Set the receive channel
+      # @return [Fixnum, nil]
+      def receive_channel=(channel)
+        @input.channel = channel
+      end
+      alias_method :rx_channel=, :receive_channel=
+
+    end
+
+    # Output convenience methods
+    module Output
+
+      def self.included(base)
+        base.send(:extend, Forwardable)
+        base.send(:def_delegators, :@output, :mute, :toggle_mute, :mute=, :muted?, :mute?)
+      end
+
+      # MIDI output devices
+      # @return [Array<UniMIDI::Output>]
+      def outputs
+        @output.devices
+      end
+
+      # MIDI channel messages will be optionally forced to have this channel when outputted
+      # @return [Fixnum, nil]
+      def transmit_channel
+        @output.channel
+      end
+      alias_method :tx_channel, :transmit_channel
+
+      # Set an optional MIDI channel to force channel notes into when outputted
+      # @return [Fixnum, nil]
+      def transmit_channel=(channel)
+        @output.channel = channel
+      end
+      alias_method :tx_channel=, :transmit_channel=
+
     end
 
   end

data/lib/midi-instrument/input.rb

@@ -32,6 +32,9 @@ module MIDIInstrument
       self
     end
 
+    # Manually add messages to the input
+    # @param [Array<MIDIMessage>, MIDIMessage, *MIDIMessage] messages
+    # @return [Array<MIDIMessage>]
     def add(*messages)
       messages = Message.to_messages([messages].flatten)
       messages = messages.map { |message| filter_message(message) }.compact
@@ -68,6 +71,9 @@ module MIDIInstrument
 
     private
 
+    # Filter an event based on the message contained in it
+    # @param [Hash] event
+    # @return [Hash, nil]
     def filter_event(event)
       if !@channel_filter.nil?
         if !(message = filter_message(event[:message])).nil?
@@ -79,6 +85,9 @@ module MIDIInstrument
       end
     end
 
+    # If there's a channel filter, use it to filter the given message.
+    # @param [MIDIMessage] message
+    # @return [MIDIMessage]
     def filter_message(message)
       message = @channel_filter.process(message) unless @channel_filter.nil?
       message

data/lib/midi-instrument/message.rb

@@ -29,6 +29,24 @@ module MIDIInstrument
       end
     end
 
+    # Convert the input to MIDI note off messages
+    # @param [*MIDIMessage::NoteOff, *MIDIMessage::NoteOn, *String] args
+    # @param [Hash] options
+    # @option options [Fixnum] :default_channel
+    # @option options [Fixnum] :default_velocity
+    # @return [Array<MIDIMessage::NoteOn, nil>]
+    def to_note_offs(*args)
+      notes = [args.dup].flatten
+      options = notes.last.kind_of?(Hash) ? notes.pop : {}
+      notes.map do |note|
+        case note
+        when String then string_to_note_off(note, options) if note?(note)
+        when MIDIMessage::NoteOff then note
+        when MIDIMessage::NoteOn then note.to_note_off
+        end
+      end
+    end
+
     # Convert the input to MIDI note on messages
     # @param [*MIDIMessage::NoteOn, *String] args
     # @param [Hash] options
@@ -76,9 +94,30 @@ module MIDIInstrument
     # @option options [Fixnum] :default_velocity
     # @return [MIDIMessage::NoteOn]
     def string_to_note_on(string, options = {})
+      string_to_note(string, MIDIMessage::NoteOn, options)
+    end
+
+    # Convert the given string (eg "A4") to a note off message object
+    # @param [String] string
+    # @param [Hash] options
+    # @option options [Fixnum] :default_channel
+    # @option options [Fixnum] :default_velocity
+    # @return [MIDIMessage::NoteOn]
+    def string_to_note_off(string, options = {})
+      string_to_note(string, MIDIMessage::NoteOff, options)
+    end
+
+    # Convert the given string (eg "A4") to the given note message class
+    # @param [String] string
+    # @param [MIDIMessage::NoteOn, MIDIMessage::NoteOff] klass
+    # @param [Hash] options
+    # @option options [Fixnum] :default_channel
+    # @option options [Fixnum] :default_velocity
+    # @return [MIDIMessage::NoteOn]
+    def string_to_note(string, klass, options = {})
       channel = options.fetch(:default_channel, 0)
       velocity = options.fetch(:default_velocity, 100)
-      MIDIMessage::NoteOn[string].new(channel, velocity)
+      klass[string].new(channel, velocity)
     end
 
   end

data/lib/midi-instrument/node.rb

@@ -3,7 +3,8 @@ module MIDIInstrument
   # Can listen for and send MIDI messages
   class Node
 
-    include API
+    include API::Input
+    include API::Output
 
     attr_reader :input, :output
 
@@ -14,34 +15,6 @@ module MIDIInstrument
       @output = Output.new
     end
 
-    def inputs
-      @input.devices
-    end
-
-    def outputs
-      @output.devices
-    end
-
-    def receive_channel
-      @input.channel
-    end
-    alias_method :rx_channel, :receive_channel
-
-    def receive_channel=(channel)
-      @input.channel = channel
-    end
-    alias_method :rx_channel=, :receive_channel=
-
-    def transmit_channel
-      @output.channel
-    end
-    alias_method :tx_channel, :transmit_channel
-
-    def transmit_channel=(channel)
-      @output.channel = channel
-    end
-    alias_method :tx_channel=, :transmit_channel=
-
   end
 
 end

data/test/message_test.rb

@@ -22,6 +22,7 @@ class MIDIInstrument::MessageTest < Test::Unit::TestCase
         result = MIDIInstrument::Message.to_messages(*messages)
         assert_not_nil result
         assert_not_empty result
+        assert result.all? { |message| message.is_a?(MIDIMessage::NoteOn) }
         messages.each_with_index { |message,i| assert_equal message.note, result[i].note }
       end
 
@@ -68,6 +69,37 @@ class MIDIInstrument::MessageTest < Test::Unit::TestCase
 
     end
 
+    context ".to_note_offs" do
+
+      should "convert strings to note off" do
+        names = ["A-1", "C#4", "F#5", "D6"]
+        result = MIDIInstrument::Message.to_note_offs(*names)
+        assert_not_nil result
+        assert_not_empty result
+        assert_equal names.size, result.size
+        assert result.all? { |item| item.is_a?(MIDIMessage::NoteOff) }
+        names.each_with_index { |name, i| assert_equal name, result[i].name }
+      end
+
+      should "convert on to off" do
+        names = ["A-1", "C#4", "F#5", "D6"]
+        messages  = MIDIInstrument::Message.to_messages(*names)
+        result = MIDIInstrument::Message.to_note_offs(*messages)
+        assert_not_nil result
+        assert_not_empty result
+        assert result.all? { |message| message.is_a?(MIDIMessage::NoteOff) }
+        messages.each_with_index { |message,i| assert_equal message.note, result[i].note }
+      end
+
+      should "return nil for unknowns" do
+        result = MIDIInstrument::Message.to_note_offs("blah", "blah", 56904)
+        assert_not_nil result
+        assert_equal 3, result.size
+        assert_empty result.compact
+      end
+
+    end
+
     context ".to_note_ons" do
 
       should "convert strings to note ons" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: midi-instrument
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Ari Russo