vissen-input 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf9e2d7e4ab570645627dab31c509d35c94c1dd0fab403113505fcd807acf4ec
+  data.tar.gz: 12845d0b04e56faf957a4780d0a04e671d304197a9d0b2040f7c5665ab1aa0fc
+SHA512:
+  metadata.gz: 560ac7d4f5e7670e2ebf5d79fd8e4ce5ada839b61ab8ec30815bf44be5b6e5b5e683aac9f992f1e003bdc2c22947cb2db5a8a97e4209b87636391e88de46d30d
+  data.tar.gz: ed3da5a2f4f479dcc9ef4fac688945ebdda4ec2b1a3c7e045ffb991babe330201f53e076c39e5783ead938e1cf1b2309bab84c6b70d59637fe5f5b6c3624330e

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,48 @@
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+  TargetRubyVersion: 2.5
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+      - module_inclusion
+      - constants
+      - public_class_methods
+      - initializer
+      - instance_methods
+      - protected_methods
+      - private_methods
+
+Layout/IndentHeredoc:
+  EnforcedStyle: squiggly
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'test/**/*.rb'
+
+Lint/InterpolationCheck:
+  Exclude:
+    - 'test/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'test/**/*.rb'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'test/**/*.rb'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.2] - 2018-04-18
+### Changed
+- Message subscribers can now prevent a message from reaching lower priority subscribers.
+
+## [0.2.1] - 2018-04-11
+### Added
+- Yard compatible documentation.
+### Changed
+- Broker#run_once now returns true if a message was handled.
+- PitchBendChange.create now accepts a float value instead of the raw bytes.
+
+### Fixed
+- Bug in Message::Base.create that ment the status was always set to zero.
+
+## [0.2.0] - 2018-04-11
+### Added
+- Subscription object to handle objects subscribing to incoming messages.
+- Message broker implementation.

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in vissen-input.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    vissen-input (0.2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    docile (1.3.0)
+    json (2.1.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rubocop (~> 0.52)
+  simplecov (~> 0.16)
+  vissen-input!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sebastian Lindberg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Vissen::Input
+
+[![Build Status](https://travis-ci.org/midi-visualizer/vissen-input.svg?branch=master)](https://travis-ci.org/midi-visualizer/vissen-input)
+[![Inline docs](http://inch-ci.org/github/midi-visualizer/vissen-input.svg?branch=master)](http://inch-ci.org/github/midi-visualizer/vissen-input)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vissen-input'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vissen-input
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/midi-visualizer/vissen-input.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'vissen/input'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/vissen/input/broker.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Input
+    # Message broker that consumes a stream of messages and exposes a simple
+    # subscription interface.
+    #
+    # == Usage
+    # This example subscribes to note messages on channel 1 and calls the
+    # fictitious method play when a matching message is published and processed.
+    #
+    #   broker = Broker.new
+    #   broker.subscribe Message::Note[1], priority: 1 do |message|
+    #     play message.note
+    #   end
+    #
+    #   message = Message::Note.create 42, channel: 1
+    #   broker.publish message
+    #   broker.run_once
+    #
+    # The next example sets up two different priority listeners, one of which
+    # blocks the other for some messages.
+    #
+    #   broker = Broker.new
+    #   broker.subscribe Message::Note[1], priority: 1 do |message|
+    #     play message.note
+    #   end
+    #
+    #   broker.subscribe Message::Note[1], priority: 2 do |message, ctrl|
+    #     ctrl.stop! if message.note % 2 == 0
+    #   end
+    #
+    class Broker
+      def initialize
+        @subscriptions = []
+        @message_queue = Queue.new
+      end
+
+      # Register a callback for the broker to run when a message matched by the
+      # given matcher is published.
+      #
+      # By specifying a priority a subscriber added after another can still be
+      # handled at an earlier time. The handler can either be specified as an
+      # object responding to `#call` or as a block.
+      #
+      # @param  matcher [#match?] the matcher that will be used to filter
+      #   messeges.
+      # @param  handler [#call] the handler that will be called when a matching
+      #   message is published. Mandatory unless a block is given.
+      # @param  priority [Integer] the priority determines when the subscription
+      #   will be matched against a published message in relation to other
+      #   subscriptions.
+      # @return [Subscription] the new subscription object.
+      def subscribe(matcher, handler = nil, priority: 0, &block)
+        if block_given?
+          raise ArgumentError if handler
+          handler = block
+        else
+          raise ArgumentError unless handler
+        end
+
+        insert_subscription Subscription.new(matcher, handler, priority)
+      end
+
+      # Removes the given subscription.
+      #
+      # @param  subscription [Subscription] the subscription to cancel.
+      # @return [Subscription, nil] the subscription that was cancelled, or nil
+      #   if the subscription was not found.
+      def unsubscribe(subscription)
+        @subscriptions.delete subscription
+      end
+
+      # Insert a new message into the message queue. The message is handled at a
+      # later time in `#run_once`.
+      #
+      # @param  message [Message] the message(s) to handle.
+      def publish(*message)
+        message.each { |m| @message_queue.push m }
+      end
+
+      # Takes one message from the message queue and handles it.
+      #
+      # @return [true, false] true if the message_queue contained a message,
+      #   otherwise false.
+      def run_once
+        return false if @message_queue.empty?
+        ctrl = PropagationControl.new
+        call @message_queue.shift, ctrl
+        true
+      end
+
+      # Processes one message. By design, implementing this method allows for
+      # multiple brokers being chained.
+      #
+      # @param  message [Message] the message to match against the
+      #   subscriptions.
+      # @return [nil]
+      def call(message, ctrl)
+        # TODO: Remap the message if needed.
+        @subscriptions.each do |subscription|
+          break if ctrl.stop?(subscription.priority)
+          next unless subscription.match? message
+
+          subscription.handle message, ctrl
+        end
+        nil
+      end
+
+      private
+
+      # Insert of append a new subscription to the list. The subscription will
+      # be placed before the first subscription that is found to have a lower
+      # priority, or last.
+      #
+      # @param  subscription [Subscription] the subscription to add.
+      # @return [Subscription] the subscription that was added.
+      def insert_subscription(subscription)
+        @subscriptions.each_with_index do |other, index|
+          if other.priority < subscription.priority
+            @subscriptions.insert index, subscription
+            return subscription
+          end
+        end
+
+        @subscriptions.push subscription
+        subscription
+      end
+
+      # Internal class used by the `Broker` to control the propagation of a
+      # message and provide a control surface for subscription handlers,
+      # allowing them to stop the propagation at priorites lower than (not equal
+      # to) their own.
+      #
+      # == Usage
+      # The following example uses a propagation control object to stop
+      # propagation at priority 1. Note that `#stop?` must be called for each
+      # message before `#stop!` to ensure that the correct priority is set.
+      #
+      #   ctrl = PropagationControl.new
+      #   ctrl.stop? 2 # => false
+      #   ctrl.stop? 1 # => false
+      #
+      #   ctrl.stop!
+      #
+      #   ctrl.stop? 1 # => false
+      #   ctrl.stop? 0 # => true
+      #
+      class PropagationControl
+        def initialize
+          @stop_at_priority = -1
+          @current_priority = 0
+        end
+
+        # @param  [Integer] the priority to test if
+        # @return [true, false] whether to stop or not.
+        def stop?(priority)
+          return true if priority < @stop_at_priority
+
+          @current_priority = priority
+          false
+        end
+
+        # Sets the priority stopping threshold.
+        #
+        # @return [nil]
+        def stop!
+          @stop_at_priority = @current_priority
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/vissen/input/matcher.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Input
+    # The job of an input matcher is to match a raw message with a message
+    # class.
+    #
+    # == Usage
+    # In the following example a matcher is setup to match aftertouch messages
+    # (on channel 0). Only data arrays of the correct length and content causes
+    # `#match?` to return true
+    #
+    #   matcher = Matcher.new(Message::Aftertouch) { |d| d[0] == 0xA0 }
+    #
+    #   matcher.match? [0xB0, 0, 0] # => false
+    #   matcher.match? [0xA0, 0]    # => false
+    #   matcher.match? [0xA0, 0, 0] # => true
+    #
+    class Matcher
+      attr_reader :klass
+
+      # @param message_klass [Message] the message class that should be used to
+      #   parse the data that this matcher matches. The class constant
+      #   `DATA_LENGTH` will be used to verify that the data has the correct
+      #   length.
+      # @param proc [#call] the block that will be called to match messages.
+      def initialize(message_klass, &proc)
+        raise TypeError unless message_klass <= Message
+
+        @klass = message_klass
+        @rule  = proc
+
+        freeze
+      end
+
+      # Match either a byte array or a `Message` against the rule stored in the
+      # matcher.
+      #
+      # @param  obj [#to_a] the message data to match.
+      # @return [true, false] true if the data matches.
+      def match?(obj)
+        data = obj.to_a
+
+        return false unless data.length >= @klass::DATA_LENGTH
+        @rule.call data
+      end
+    end
+  end
+end

data/lib/vissen/input/message/aftertouch.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Input
+    module Message
+      # From the MIDI Association:
+      #   Polyphonic Key Pressure (Aftertouch). This message is most often sent
+      #   by pressing down on the key after it "bottoms out".
+      class Aftertouch < Base
+        STATUS = 0xA0
+
+        # @return [Integer] the note value.
+        def note
+          data[1]
+        end
+
+        # @return [Integer] the preassure value.
+        def preassure
+          data[2]
+        end
+      end
+    end
+  end
+end

data/lib/vissen/input/message/base.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Input
+    module Message
+      # This is the base message implementaion. This class should never be used
+      # directly, but rather be subclassed to create the various messages that
+      # the system understands.
+      #
+      # The Base class keeps track of subclasses and can produce a message
+      # factory for all the implementations that it knows about (see
+      # `.factory`).
+      class Base
+        include Message
+
+        DATA_LENGTH = 3
+        STATUS      = 0
+
+        # Checks message data consistency with the class default matcher.
+        #
+        # @return [true, false] true if the message data matches the class
+        #   matcher.
+        def valid?
+          self.class.matcher.match? data
+        end
+
+        class << self
+          # Returns a new instance of a Matcher, configured to match this
+          # particular Message class. Subclasses of Base can utilize the same
+          # functionality by simply redefining STATUS and, if necessary,
+          # STATUS_MASK.
+          #
+          # By supplying the optional named arguments channel and number
+          #
+          # Raises a RangeError if the channel is given and is outside its valid
+          # range of (0..15).
+          # Raises a RangeError if number is given and is outside its valid
+          # range of (0..127).
+          #
+          # @param  channel [nil, Integer] the channel to match, or nil to match
+          #   all channels.
+          # @param  number [nil, Integer] the second byte value to match, or nil
+          #   to match all values.
+          # @return [Matcher] the matcher that fulfills the requirements.
+          def matcher(channel: nil, number: nil)
+            return klass_matcher unless channel || number
+            val, mask = status_value_and_mask channel
+
+            if number
+              raise RangeError unless (0...128).cover? number
+              Matcher.new(self) { |d| (d[0] & mask) == val && d[1] == number }
+            else
+              Matcher.new(self) { |d| (d[0] & mask) == val }
+            end
+          end
+
+          # Accessor for the class default matcher.
+          #
+          # @param  message [#to_a] the message or data to match.
+          # @return [true, false] see `Matcher#match?`.
+          def match?(message)
+            matcher.match? message
+          end
+
+          # Creates a new factory with all the subclasses of base added to it as
+          # matchers.
+          #
+          # @return [MessageFactory] a factory configured to build all
+          #   subclasses of Base.
+          def factory
+            raise RuntimeError unless defined? @subclasses
+            MessageFactory.new @subclasses.map(&:matcher)
+          end
+
+          # Alias to `#matcher` that swaps named arguments for positional ones.
+          #
+          # @param  (see #matcher)
+          # @return (see #matcher)
+          def [](channel, number = nil)
+            matcher channel: channel, number: number
+          end
+
+          # Build a new instance of `Message::Base`, or a subclass, using more
+          # intuitive arguments. Subclasses of Base can utilize the same
+          # functionality by simply redefining `DATA_LENGTH` to correspond to
+          # their message length.
+          #
+          # Note that status and channel are masked using the default masks, and
+          # not the constants that may have been defined by a subclass.
+          #
+          # @param  bytes [Array<Integer>] the message data byte values.
+          #   Unspecified values default to 0.
+          # @param  status [Integer] the status to use for the new message.
+          # @param  channel [Integer] the channel to use for the new message.
+          # @param  timestamp [Float] the timestamp to use for the new message.
+          # @return [Base] a new instance of this class.
+          def create(*bytes, status: self::STATUS,
+                     channel: 0,
+                     timestamp: Time.now.to_f)
+            raise ArgumentError if bytes.length >= self::DATA_LENGTH
+
+            validate_status status
+            validate_channel channel
+
+            data = Array.new self::DATA_LENGTH, 0
+
+            # Note: this line line must reference
+            #       STATUS_MASK and not self::STATUS_MASK
+            data[0] = (status & STATUS_MASK) + (channel & CHANNEL_MASK)
+
+            # Copy the bytes
+            bytes.each_with_index { |value, index| data[index + 1] = value }
+
+            new data, timestamp
+          end
+
+          protected
+
+          def inherited(subclass)
+            (@subclasses ||= []) << subclass
+          end
+
+          def validate_status(status)
+            raise RangeError unless (status & ~STATUS_MASK).zero?
+          end
+
+          def validate_channel(channel)
+            raise RangeError unless (channel & ~CHANNEL_MASK).zero?
+          end
+
+          def status_value_and_mask(channel = nil)
+            if channel
+              validate_channel channel
+              [(self::STATUS & self::STATUS_MASK) + (channel & CHANNEL_MASK),
+               self::STATUS_MASK + CHANNEL_MASK]
+            else
+              [self::STATUS, self::STATUS_MASK]
+            end
+          end
+
+          def klass_matcher(&block)
+            return @klass_matcher if defined?(@klass_matcher)
+
+            unless block_given?
+              val, mask = status_value_and_mask
+              block = proc { |d| (d[0] & mask) == val }
+            end
+
+            @klass_matcher = Matcher.new(self, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vissen/input/message/channel_mode.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Input
+    module Message
+      # From the MIDI Association:
+      #   This the same code as the Control Change (above), but implements Mode
+      #   control and special message by using reserved controller numbers
+      #   120-127. The commands are:
+      #
+      #   - All Sound Off (120)
+      #       When All Sound Off is received all oscillators will turn off, and
+      #       their volume envelopes are set to zero as soon as possible.
+      #   - Reset All Controllers (121)
+      #       When Reset All Controllers is received, all controller values are
+      #       reset to their default values.
+      #   - Local Control (122)
+      #       When Local Control is Off, all devices on a given channel will
+      #       respond only to data received over MIDI. Played data, etc. will be
+      #       ignored. Local Control On restores the functions of the normal
+      #       controllers.
+      #   - All Notes Off (123..127)
+      #       When an All Notes Off is received, all oscillators will turn off.
+      #
+      class ChannelMode < Base
+        DATA_LENGTH = 2
+        STATUS      = 0xB0
+
+        # @return [Integer] the control number.
+        def number
+          data[1]
+        end
+
+        class << self
+          protected
+
+          # The channel mode message is special in that it is only valid when
+          # the second byte takes values equal to or greather than 120. We
+          # therefore need to override `Base.klass_matcher`.
+          #
+          # FIXME: other matchers created may not be correct.
+          def klass_matcher
+            super do |d|
+              (d[0] & STATUS_MASK) == STATUS && d[1] >= 120
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vissen/input/message/channel_pressure.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Input
+    module Message
+      # From the MIDI Association:
+      #   Channel Pressure (After-touch). This message is most often sent by
+      #   pressing down on the key after it "bottoms out". This message is
+      #   different from polyphonic after-touch. Use this message to send the
+      #   single greatest pressure value (of all the current depressed keys)
+      class ChannelPressure < Base
+        STATUS      = 0xD0
+        DATA_LENGTH = 2
+
+        # @return [Integer] the pressure value.
+        def pressure
+          data[1]
+        end
+      end
+    end
+  end
+end

data/lib/vissen/input/message/control_change.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Input
+    module Message
+      # From the MIDI Association:
+      #   This message is sent when a controller value changes. Controllers
+      #   include devices such as pedals and levers. Controller numbers 120-127
+      #   are reserved as "Channel Mode Messages".
+      class ControlChange < Base
+        STATUS = 0xB0
+
+        # @return [Integer] the control number.
+        def number
+          data[1]
+        end
+
+        # @return [Integer] the control value.
+        def value
+          data[2]
+        end
+
+        class << self
+          protected
+
+          # The control change message is special in that it is only valid when
+          # the second byte takes values lower than 120. We therefore need to
+          # override `Base.klass_matcher`.
+          #
+          # FIXME: other matchers created may not be correct.
+          def klass_matcher
+            super do |d|
+              (d[0] & STATUS_MASK) == STATUS && d[1] < 120
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vissen/input/message/note.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Input
+    module Message
+      # From the MIDI Association:
+      #   Note On event.
+      #   This message is sent when a note is depressed (start).
+      #
+      #   Note Off event.
+      #   This message is sent when a note is released (ended).
+      class Note < Base
+        STATUS_MASK = 0xE0
+        STATUS      = 0x80
+        NOTE_ON     = 0x10
+        NOTE_OFF    = 0x00
+
+        # @return [Integer] the note value.
+        def note
+          data[1]
+        end
+
+        # @return [Integer] the velocity value.
+        def velocity
+          data[2]
+        end
+
+        # @return [true, false] true if the note was released.
+        def off?
+          (data[0] & NOTE_ON).zero?
+        end
+
+        # @return [true, false] true if the note was depressed.
+        def on?
+          !off?
+        end
+
+        class << self
+          # @param  bytes (see Base.create)
+          # @param  on [true, false] true if the note should be depressed,
+          #   otherwise false.
+          # @param  args (see Base.create)
+          # @return [Note]
+          def create(*bytes, on: true, **args)
+            super(*bytes, status: STATUS + (on ? NOTE_ON : NOTE_OFF), **args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vissen/input/message/pitch_bend_change.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Input
+    module Message
+      # From the MIDI Association:
+      #   This message is sent to indicate a change in the pitch bender (wheel
+      #   or lever, typically). The pitch bender is measured by a fourteen bit
+      #   value. Center (no pitch change) is 2000H. Sensitivity is a function of
+      #   the receiver, but may be set using RPN 0.
+      class PitchBendChange < Base
+        STATUS       = 0xE0
+        CENTER_VALUE = 0x2000
+
+        # @return [Integer] the integer pitch bend value.
+        def raw
+          (data[2] << 7) + data[1] - CENTER_VALUE
+        end
+
+        # @return [Float] the pitch bend value normalized to the range (-1..1).
+        def value
+          raw.to_f / CENTER_VALUE
+        end
+
+        class << self
+          # TODO: Check the range on value.
+          #
+          # @param  value [Float] the pitch bend value in the range (-1..1).
+          # @param  args (see Base.create)
+          # @return [PitchBendChange]
+          def create(value = 0.0, **args)
+            bin_value = (value.to_f * CENTER_VALUE).round + CENTER_VALUE
+
+            super(bin_value & 0xFF, bin_value >> 7, **args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vissen/input/message/program_change.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Input
+    module Message
+      # From the MIDI Association:
+      #   This message sent when the patch number changes.
+      class ProgramChange < Base
+        DATA_LENGTH = 2
+        STATUS      = 0xC0
+
+        # @return [Integer] the program number.
+        def number
+          data[1]
+        end
+      end
+    end
+  end
+end

data/lib/vissen/input/message/unknown.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Input
+    module Message
+      # The unknown message type is not a subclass of Base since it is never
+      # meant to be used directly. It is instead expected to be created by the
+      # MessageFactory whenever the incomming data does not match any known
+      # matcher.
+      class Unknown
+        include Message
+      end
+    end
+  end
+end

data/lib/vissen/input/message.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Vissen
+  module Input
+    # This module implements the minimal interface for an input message. All
+    # message classes must _include_ this module to be compatible with the input
+    # matching engine.
+    #
+    # All Vissen Input Messages must be representable by one to three bytes.
+    # This stems from the tight connection with the MIDI protocol. Each message
+    # must also store a timestamp from when the input arrived to the system.
+    #
+    # The individual message implementations are based off the information given
+    # on the [midi association website](https://www.midi.org/specifications/item/table-1-summary-of-midi-message).
+    #
+    # Terminology
+    # -----------
+    # The first (and mandatory) byte of the data byte array is referred to as
+    # the message status. Since this byte also include channel information the
+    # term _status_ is, howerver, sometimes also used to name only the upper
+    # nibble of the status field.
+    module Message
+      STATUS_MASK  = 0xF0
+      CHANNEL_MASK = 0x0F
+      DATA_LENGTH  = 1
+
+      # @return [Array<Integer>]
+      attr_reader :data
+
+      # @return [Float]
+      attr_reader :timestamp
+
+      # Allow a message to pass for the raw byte array
+      alias to_a data
+
+      # @param  data [Array<Integer>] the raw message data.
+      # @param  timestamp [Float] the time that the message was received.
+      def initialize(data, timestamp)
+        raise TypeError unless data.length >= self.class::DATA_LENGTH
+
+        @data      = data.freeze
+        @timestamp = timestamp.freeze
+      end
+
+      # The default for messages is to always be valid. Message implementations
+      # can override this behaviour.
+      #
+      # @return [true]
+      def valid?
+        true
+      end
+
+      # @return [Integer] the message status.
+      def status
+        @data[0] & self.class::STATUS_MASK
+      end
+
+      # @return [Integer] the message channel.
+      def channel
+        @data[0] & self.class::CHANNEL_MASK
+      end
+    end
+  end
+end

data/lib/vissen/input/message_factory.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Input
+    # The facatory takes raw input messages and builds matching objects around
+    # them. It stores a list of input matchers that it knows about.
+    #
+    # If an array of matchers is passed to the constructor the MessageFactory
+    # will freeze itself to create an immutable factory.
+    #
+    # TODO: Sort the matchers on input frequency for performance?
+    #
+    # == Usage
+    # The following example sets up a factory to build ControlChange messages.
+    #
+    #   matcher = Message::ControlChange.matcher
+    #   factory = MessageFactory.new [matcher]
+    #
+    #   factory.build [0xC0, 3, 42], 0.0 # => Message::ControlChange
+    #   factory.build [0xB0, 0, 0], 0.0  # => Message::Unknown
+    #
+    class MessageFactory
+      # @param  matchers [nil, Array<Matcher>] the matchers to use when building
+      #   messages. If provided the factory will be frozen after creation.
+      def initialize(matchers = nil)
+        @lookup_table = Array.new(16)
+        @matchers     = []
+
+        return unless matchers
+
+        matchers.each { |m| add_matcher m }
+        freeze
+      end
+
+      # Prevents any more matchers from being added.
+      #
+      # @return [self]
+      def freeze
+        @matchers.freeze
+        super
+      end
+
+      # Inserts another matcher to the list of known input data matchers.
+      #
+      # @param  matcher [Matcher] the matcher to add.
+      # @return [self]
+      def add_matcher(matcher)
+        raise TypeError unless matcher.is_a? Matcher
+        @matchers << matcher
+        self
+      end
+
+      # Creates a new Message object by matching the data against the stored
+      # message classes.
+      #
+      # @param  obj [#to_a] the data object to build the new message arround.
+      # @param  timestamp [Float] the time that the message was first received.
+      # @return [Message]
+      def build(obj, timestamp)
+        data  = obj.to_a
+        klass =
+          if obj.is_a?(Message) && obj.valid?
+            return obj if obj.timestamp == timestamp
+            obj.class
+          else
+            matcher = lookup data
+            matcher ? matcher.klass : Message::Unknown
+          end
+
+        klass.new data, timestamp
+      end
+
+      private
+
+      def lookup(data)
+        status  = data[0] >> 4
+        entry   = @lookup_table[status]
+        matcher = entry&.find { |m| m.match? data }
+
+        unless matcher
+          matcher = @matchers.find { |m| m.match? data }
+          add_to_lookup matcher, data if matcher
+        end
+
+        matcher
+      end
+
+      def add_to_lookup(matcher, data)
+        status = data[0] >> 4
+        entry  = @lookup_table[status]
+
+        if entry
+          entry << matcher
+        else
+          @lookup_table[status] = [matcher]
+        end
+      end
+    end
+  end
+end

data/lib/vissen/input/subscription.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Vissen
+  module Input
+    # Whenever a callable object wants to receive messages from a broker it is
+    # wrapped inside of a subscription. A subscription is a basic immutable
+    # value object with a minimal api that keeps track of three things: a
+    # Matcher, a callable handler and a numeric priority.
+    class Subscription
+      extend Forwardable
+
+      # @return [Integer] the subscription priority.
+      attr_reader :priority
+
+      # @!method match?(message)
+      # This method is forwarded to `Message#match?`.
+      #
+      # @return [true, false] (see Matcher#match?).
+      def_delegator :@matcher, :match?, :match?
+
+      # @!method handle(message)
+      # Calls the registered handler with the given message.
+      #
+      # @return (see Matcher#match?)
+      def_delegator :@handler, :call, :handle
+
+      # @param  matcher [#match?] the matcher to use when filtering messages.
+      # @param  handler [#call] the target of the subscription.
+      # @param  priority [Integer] the priority of the subscription relative
+      #   other subscriptions.
+      def initialize(matcher, handler, priority)
+        @matcher  = matcher
+        @handler  = handler
+        @priority = priority
+
+        freeze
+      end
+    end
+  end
+end

data/lib/vissen/input/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Vissen
+  module Input
+    # The Vissen Input library version number.
+    VERSION = '0.2.2'
+  end
+end

data/lib/vissen/input.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'vissen/input/version'
+
+require 'vissen/input/matcher'
+require 'vissen/input/message_factory'
+require 'vissen/input/subscription'
+require 'vissen/input/broker'
+
+require 'vissen/input/message'
+require 'vissen/input/message/base'
+require 'vissen/input/message/aftertouch'
+require 'vissen/input/message/channel_pressure'
+require 'vissen/input/message/channel_mode'
+require 'vissen/input/message/control_change'
+require 'vissen/input/message/note'
+require 'vissen/input/message/pitch_bend_change'
+require 'vissen/input/message/program_change'
+require 'vissen/input/message/unknown'
+
+module Vissen
+  # Input
+  #
+  # This module includes all the input messages that can be sent to the vissen
+  # engine, as well as some facilities for converting them to and from their
+  # binary form.
+  module Input
+  end
+end

data/vissen-input.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vissen/input/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vissen-input'
+  spec.version       = Vissen::Input::VERSION
+  spec.authors       = ['Sebastian Lindberg']
+  spec.email         = ['seb.lindberg@gmail.com']
+
+  spec.summary       = 'The input side of the vissen system.'
+  spec.description   = 'This gem implements the input messages and message ' \
+                       'matching engine used in the vissen project.'
+  spec.homepage      = 'https://github.com/midi-visualizer/vissen-input'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: vissen-input
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Sebastian Lindberg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: This gem implements the input messages and message matching engine used
+  in the vissen project.
+email:
+- seb.lindberg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vissen/input.rb
+- lib/vissen/input/broker.rb
+- lib/vissen/input/matcher.rb
+- lib/vissen/input/message.rb
+- lib/vissen/input/message/aftertouch.rb
+- lib/vissen/input/message/base.rb
+- lib/vissen/input/message/channel_mode.rb
+- lib/vissen/input/message/channel_pressure.rb
+- lib/vissen/input/message/control_change.rb
+- lib/vissen/input/message/note.rb
+- lib/vissen/input/message/pitch_bend_change.rb
+- lib/vissen/input/message/program_change.rb
+- lib/vissen/input/message/unknown.rb
+- lib/vissen/input/message_factory.rb
+- lib/vissen/input/subscription.rb
+- lib/vissen/input/version.rb
+- vissen-input.gemspec
+homepage: https://github.com/midi-visualizer/vissen-input
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: The input side of the vissen system.
+test_files: []