midi-message 0.4.4 → 0.4.5

data/lib/midi-message/message.rb

@@ -1,212 +1,53 @@
 module MIDIMessage
 
-  #
-  # MIDI Channel Aftertouch message
-  #
-  class ChannelAftertouch
-
-    include ChannelMessage
-
-    DATA = [:channel, :value]
-    DISPLAY_NAME = "Channel Aftertouch"
-    
-  end
-  ChannelPressure = ChannelAftertouch
-
-  #
-  # MIDI Control Change message
-  #
-  class ControlChange
-
-    include ChannelMessage
-
-    DATA = [:channel, :index, :value]
-    DISPLAY_NAME = "Control Change"
-    CONSTANT = { "Control Change" => :index }
-   
-  end  
-  Controller = ControlChange #shortcut
-
-  #
-  # MIDI Pitch Bend message
-  #
-  class PitchBend
-
-    include ChannelMessage
-
-    DATA = [:channel, :low, :high]
-    DISPLAY_NAME = "Pitch Bend"
-
-  end
-
-  #
-  # MIDI Polyphonic (note specific) Aftertouch message
-  #
-  class PolyphonicAftertouch
-
-    include ChannelMessage
-
-    DATA = [:channel, :note, :value]
-    DISPLAY_NAME = "Polyphonic Aftertouch"
-    CONSTANT = { "Note" => :note }
-
-  end
-  PolyAftertouch = PolyphonicAftertouch
-  PolyPressure = PolyphonicAftertouch
-  PolyphonicPressure = PolyphonicAftertouch
-
-  #
-  # MIDI Program Change message
-  #
-  class ProgramChange
-
-    include ChannelMessage
-
-    DATA = [:channel, :program]
-    DISPLAY_NAME = "Program Change"
-
-  end
-
-  #
-  # MIDI Note-Off message
-  #
-  class NoteOff
-
-    include NoteMessage
-
-    DATA = [:channel, :note, :velocity]
-    DISPLAY_NAME = "Note Off"
-    CONSTANT = { "Note" => :note }
-
-  end
-
-  #
-  # MIDI Note-On message
-  #
-  class NoteOn
-    
-    include NoteMessage   
-
-    DATA = [:channel, :note, :velocity]
-    DISPLAY_NAME = "Note On"
-    CONSTANT = { "Note" => :note }
-    
-    # returns the NoteOff equivalent of this object
-    def to_note_off
-      NoteOff.new(channel, note, velocity)
+  # Common behavior amongst all Message types
+  module Message
+
+    # Initialize the message status
+    # @param [Fixnum] status_nibble_1 The first nibble of the status
+    # @param [Fixnum] status_nibble_2 The second nibble of the status
+    def initialize_message(status_nibble_1, status_nibble_2)
+      @status = [status_nibble_1, status_nibble_2]
+      populate_using_const
     end
 
-  end
-
-  #
-  # MIDI System-Common message
-  #
-  class SystemCommon
-
-    include SystemMessage
-
-    DISPLAY_NAME = "System Common"
-    
-    attr_reader :data
-    
-    def initialize(*args)
-      options = args.last.kind_of?(Hash) ? args.pop : {}
-      @const = options[:const]
-      id = @const.nil? ? args.shift : @const.value
-      id = strip_redundant_nibble(id)
-      initialize_short_message(0xF, id)
-      @data = args.slice(0..1)
+    # Byte array representation of the message eg [0x90, 0x40, 0x40] for NoteOn(0x40, 0x40)
+    # @return [Array<Fixnum>] The array of bytes in the MIDI message
+    def to_a
+      data = @data.nil? ? [] : [@data[0], @data[1]]
+      [(@status[0] << 4) + @status[1], *data].compact
     end
-    
-  end  
-  
-  #
-  # MIDI System-Realtime message
-  #
-  class SystemRealtime
-
-    include SystemMessage
-
-    DISPLAY_NAME = "System Realtime"
-    
-    def initialize(*args)
-      options = args.last.kind_of?(Hash) ? args.pop : {} 
-      @const = options[:const]
-      id = @const.nil? ? args.first : @const.value
-      id = strip_redundant_nibble(id)
-      initialize_short_message(0xF, id)
+    alias_method :to_byte_a, :to_a
+    alias_method :to_byte_array, :to_a
+    alias_method :to_bytes, :to_a
+
+    # String representation of the message's bytes eg "904040" for NoteOn(0x40, 0x40)
+    # @return [String] The bytes of the message as a string of hex bytes
+    def to_hex_s
+      TypeConversion.numeric_byte_array_to_hex_string(to_a)
     end
+    alias_method :to_bytestr, :to_hex_s
 
-    def id
-      @status[1]
+    def update
+      populate_using_const
     end
 
-  end
-
-  module SystemExclusive
-
-    # A SysEx command message
-    # A command message is identified by having a status byte equal to 0x12
-    class Command
-
-      include SystemExclusive
-
-      attr_accessor :data
-      alias_method :value, :data
+    protected
 
-      TypeByte = 0x12
-      
-      def initialize(address, data, options = {})
-        # store as a byte if it's a single byte
-        @data = if data.kind_of?(Array) && data.length == 1
-          data.first
-        else
-          data
-        end
-        initialize_sysex(address, options)
+    def populate_using_const
+      unless (info = Constant::Loader.get_info(self)).nil?
+        @const = info[:const]
+        @name = info[:name]
+        @verbose_name = info[:verbose_name]
       end
-      
     end
-    
-    # A SysEx request message
-    # A request message is identified by having a status byte equal to 0x11
-    class Request
 
-      include SystemExclusive
-      
-      attr_reader :size
-      alias_method :value, :size
-
-      TypeByte = 0x11
-      
-      def initialize(address, size, options = {})
-        self.size = if size.kind_of?(Array) && size.count == 1
-          size.first
-        else
-          size
-        end
-        initialize_sysex(address, options)
-      end
-      
-      def size=(value)
-        # accepts a Numeric or Array but
-        # must always store value as an array of three bytes
-        size = []
-        if value.kind_of?(Array) && value.size <= 3
-          size = value
-        elsif value.kind_of?(Numeric) && (value + 1) / 247 <= 2
-          size = []
-          div, mod = *value.divmod(247)
-          size << mod unless mod.zero?
-          div.times { size << 247 }
-        end
-        (3 - size.size).times { size.unshift 0 }
-        @size = size
-      end
-      
+    def self.included(base)
+      base.send(:extend, Constant::Loader::DSL)
+      base.send(:include, MIDIMessage) # this enables ..kind_of?(MIDIMessage)
+      base.send(:attr_reader, :name, :status, :verbose_name)
     end
 
   end
-  
-end
 
+end

data/lib/midi-message/messages.rb

@@ -0,0 +1,211 @@
+module MIDIMessage
+
+  #
+  # MIDI Channel Aftertouch message
+  #
+  class ChannelAftertouch
+
+    include ChannelMessage
+
+    DATA = [:channel, :value]
+    DISPLAY_NAME = "Channel Aftertouch"
+
+  end
+  ChannelPressure = ChannelAftertouch
+
+  #
+  # MIDI Control Change message
+  #
+  class ControlChange
+
+    include ChannelMessage
+
+    DATA = [:channel, :index, :value]
+    DISPLAY_NAME = "Control Change"
+    CONSTANT = { "Control Change" => :index }
+
+  end
+  Controller = ControlChange #shortcut
+
+  #
+  # MIDI Pitch Bend message
+  #
+  class PitchBend
+
+    include ChannelMessage
+
+    DATA = [:channel, :low, :high]
+    DISPLAY_NAME = "Pitch Bend"
+
+  end
+
+  #
+  # MIDI Polyphonic (note specific) Aftertouch message
+  #
+  class PolyphonicAftertouch
+
+    include ChannelMessage
+
+    DATA = [:channel, :note, :value]
+    DISPLAY_NAME = "Polyphonic Aftertouch"
+    CONSTANT = { "Note" => :note }
+
+  end
+  PolyAftertouch = PolyphonicAftertouch
+  PolyPressure = PolyphonicAftertouch
+  PolyphonicPressure = PolyphonicAftertouch
+
+  #
+  # MIDI Program Change message
+  #
+  class ProgramChange
+
+    include ChannelMessage
+
+    DATA = [:channel, :program]
+    DISPLAY_NAME = "Program Change"
+
+  end
+
+  #
+  # MIDI Note-Off message
+  #
+  class NoteOff
+
+    include NoteMessage
+
+    DATA = [:channel, :note, :velocity]
+    DISPLAY_NAME = "Note Off"
+    CONSTANT = { "Note" => :note }
+
+  end
+
+  #
+  # MIDI Note-On message
+  #
+  class NoteOn
+
+    include NoteMessage
+
+    DATA = [:channel, :note, :velocity]
+    DISPLAY_NAME = "Note On"
+    CONSTANT = { "Note" => :note }
+
+    # returns the NoteOff equivalent of this object
+    def to_note_off
+      NoteOff.new(channel, note, velocity)
+    end
+
+  end
+
+  #
+  # MIDI System-Common message
+  #
+  class SystemCommon
+
+    include SystemMessage
+
+    DISPLAY_NAME = "System Common"
+
+    attr_reader :data
+
+    def initialize(*args)
+      options = args.last.kind_of?(Hash) ? args.pop : {}
+      @const = options[:const]
+      id = @const.nil? ? args.shift : @const.value
+      id = strip_redundant_nibble(id)
+      initialize_message(0xF, id)
+      @data = args.slice(0..1)
+    end
+
+  end
+
+  #
+  # MIDI System-Realtime message
+  #
+  class SystemRealtime
+
+    include SystemMessage
+
+    DISPLAY_NAME = "System Realtime"
+
+    def initialize(*args)
+      options = args.last.kind_of?(Hash) ? args.pop : {}
+      @const = options[:const]
+      id = @const.nil? ? args.first : @const.value
+      id = strip_redundant_nibble(id)
+      initialize_message(0xF, id)
+    end
+
+    def id
+      @status[1]
+    end
+
+  end
+
+  module SystemExclusive
+
+    # A SysEx command message
+    # A command message is identified by having a status byte equal to 0x12
+    class Command
+
+      include SystemExclusive
+
+      attr_accessor :data
+      alias_method :value, :data
+
+      TypeByte = 0x12
+
+      def initialize(address, data, options = {})
+        # store as a byte if it's a single byte
+        @data = if data.kind_of?(Array) && data.length == 1
+          data.first
+        else
+          data
+        end
+        initialize_sysex(address, options)
+      end
+
+    end
+
+    # A SysEx request message
+    # A request message is identified by having a status byte equal to 0x11
+    class Request
+
+      include SystemExclusive
+
+      attr_reader :size
+      alias_method :value, :size
+
+      TypeByte = 0x11
+
+      def initialize(address, size, options = {})
+        self.size = if size.kind_of?(Array) && size.count == 1
+          size.first
+        else
+          size
+        end
+        initialize_sysex(address, options)
+      end
+
+      def size=(value)
+        # accepts a Numeric or Array but
+        # must always store value as an array of three bytes
+        size = []
+        if value.kind_of?(Array) && value.size <= 3
+          size = value
+        elsif value.kind_of?(Numeric) && (value + 1) / 247 <= 2
+          size = []
+          div, mod = *value.divmod(247)
+          size << mod unless mod.zero?
+          div.times { size << 247 }
+        end
+        (3 - size.size).times { size.unshift 0 }
+        @size = size
+      end
+
+    end
+
+  end
+
+end