midi-communications 0.5.1

data/lib/midi-communications/input/stream_reader.rb

@@ -0,0 +1,79 @@
+module MIDICommunications
+  class Input
+    module StreamReader
+      # Returns any data in the input buffer that have been received since the last call to a
+      # StreamReader method. If a StreamReader method has not yet been called, all data received
+      # since the program was initialized will be returned
+      #
+      # The data is returned as array of MIDI event hashes as such:
+      #   [
+      #     { data: [144, 60, 100], timestamp: 1024 },
+      #     { data: [128, 60, 100], timestamp: 1100 },
+      #     { data: [144, 40, 120], timestamp: 1200 }
+      #   ]
+      #
+      # In this case, the data is an array of Numeric bytes
+      # The timestamp is the number of millis since this input was enabled
+      # Arguments are passed to the underlying device object
+      #
+      # @param [*Object] args
+      # @return [Array<Hash>]
+      def gets(*args)
+        @device.gets(*args)
+      rescue SystemExit, Interrupt
+        exit
+      end
+
+      # Returns any data in the input buffer that have been received since the last call to a
+      # StreamReader method. If a StreamReader method has not yet been called, all data received
+      # since the program was initialized will be returned
+      #
+      # Similar to Input#gets except that the returned message data as string of hex digits eg:
+      #   [
+      #     { data: "904060", timestamp: 904 },
+      #     { data: "804060", timestamp: 1150 },
+      #     { data: "90447F", timestamp: 1300 }
+      #   ]
+      #
+      # @param [*Object] args
+      # @return [Array<Hash>]
+      def gets_s(*args)
+        @device.gets_s(*args)
+      rescue SystemExit, Interrupt
+        exit
+      end
+      alias gets_bytestr gets_s
+      alias gets_hex gets_s
+
+      # Returns any data in the input buffer that have been received since the last call to a
+      # StreamReader method. If a StreamReader method has not yet been called, all data received
+      # since the program was initialized will be returned
+      #
+      # Similar to Input#gets except that the returned message data as an array of data bytes such as
+      #   [144, 60, 100, 128, 60, 100, 144, 40, 120]
+      #
+      # @param [*Object] args
+      # @return [Array<Integer>]
+      def gets_data(*args)
+        arr = gets(*args)
+        arr.map { |msg| msg[:data] }.inject(:+)
+      end
+
+      # Returns any data in the input buffer that have been received since the last call to a
+      # StreamReader method. If a StreamReader method has not yet been called, all data received
+      # since the program was initialized will be returned
+      #
+      # Similar to Input#gets except that the returned message data as a string of data such as
+      #   "90406080406090447F"
+      #
+      # @param [*Object] args
+      # @return [String]
+      def gets_data_s(*args)
+        arr = gets_bytestr(*args)
+        arr.map { |msg| msg[:data] }.join
+      end
+      alias gets_data_bytestr gets_data_s
+      alias gets_data_hex gets_data_s
+    end
+  end
+end

data/lib/midi-communications/input.rb

@@ -0,0 +1,16 @@
+require 'midi-communications/input/stream_reader'
+
+module MIDICommunications
+  # A MIDI input device
+  class Input
+    extend Device::ClassMethods
+    include Device::InstanceMethods
+    include StreamReader
+
+    # All MIDI input devices -- used to populate the class
+    # @return [Array<Input>]
+    def self.all
+      Loader.devices(direction: :input)
+    end
+  end
+end

data/lib/midi-communications/loader.rb

@@ -0,0 +1,29 @@
+module MIDICommunications
+
+  # Populate UniMIDI devices using the underlying device objects from the platform-specific gems
+  class Loader
+    class << self
+      # Use the given platform-specific adapter to load devices
+      # @param [MIDICommunications::Adapter::Loader] loader
+      def use(loader)
+        @loader = loader
+      end
+
+      # Get all MIDI devices
+      # @param [Hash] options
+      # @option options [Symbol] :direction Return only a particular direction of device eg :input, :output
+      # @return [Array<Input>, Array<Output>]
+      def devices(options = {})
+        if @devices.nil?
+          inputs = @loader.inputs.map { |device| ::MIDICommunications::Input.new(device) }
+          outputs = @loader.outputs.map { |device| ::MIDICommunications::Output.new(device) }
+          @devices = {
+            input: inputs,
+            output: outputs
+          }
+        end
+        options[:direction].nil? ? @devices.values.flatten : @devices[options[:direction]]
+      end
+    end
+  end
+end

data/lib/midi-communications/output.rb

@@ -0,0 +1,60 @@
+module MIDICommunications
+
+  # A MIDI output device
+  class Output
+    extend Device::ClassMethods
+    include Device::InstanceMethods
+
+    # All MIDI output devices -- used to populate the class
+    # @return [Array<Output>]
+    def self.all
+      Loader.devices(direction: :output)
+    end
+
+    # Sends a message to the output.
+    #
+    # The message format can be:
+    #
+    # 1. Numeric bytes eg output.puts(0x90, 0x40, 0x40)
+    # 2. An array of numeric bytes [0x90, 0x40, 0x40]
+    # 3. A string of bytes eg "904040"
+    # 4. An array of strings ["904040", "804040"]
+    #
+    # @param [*Array<Integer>, *Array<String>, *Integer, *String] messages
+    # @return [Array<Integer>, Array<String>]
+    def puts(*messages)
+      message = messages.first
+      case message
+      when Array then messages.each { |array| puts(*array.flatten) }
+      when Integer then puts_bytes(*messages)
+      when String then puts_s(*messages)
+      else
+        if message.respond_to?(:to_bytes)
+          puts_bytes(*message.to_bytes.flatten)
+        elsif message.respond_to?(:to_a)
+          puts_bytes(*message.to_a.flatten)
+        end
+      end
+    end
+
+    # Sends a message to the output in a form of a string eg "904040".  This method does not do
+    # type checking
+    # @param [*String] messages
+    # @return [Array<String>, Array<Array<String>>]
+    def puts_s(*messages)
+      @device.puts_s(*messages)
+      messages.count < 2 ? messages[0] : messages
+    end
+    alias puts_bytestr puts_s
+    alias puts_hex puts_s
+
+    # Sends a message to the output in a form of bytes eg output.puts_bytes(0x90, 0x40, 0x40).
+    # This method does not do type checking.
+    # @param [*Array<Integer>] messages
+    # @return [Array<Integer>, Array<Array<Integer>>]
+    def puts_bytes(*messages)
+      @device.puts_bytes(*messages)
+      messages.count < 2 ? messages[0] : messages
+    end
+  end
+end

data/lib/midi-communications/platform.rb

@@ -0,0 +1,33 @@
+module MIDICommunications
+
+  # Deal with different dependencies between different user environments
+  module Platform
+    extend self
+
+    # Loads the proper MIDI library and adapter for the user's environment
+    def bootstrap
+      require("midi-communications/adapter/#{platform_lib}")
+      Loader.use(platform_module::Loader)
+    end
+
+    private
+
+    def platform_lib
+      case RUBY_PLATFORM
+        when /darwin/ then 'macos'
+        when /java/ then 'jruby'
+        when /linux/ then 'linux'
+        when /mingw/ then 'windows'
+      end
+    end
+
+    def platform_module
+      case RUBY_PLATFORM
+        when /darwin/ then Adapter::MacOS
+        when /java/ then Adapter::JRuby
+        when /linux/ then Adapter::Linux
+        when /mingw/ then Adapter::Windows
+      end
+    end
+  end
+end

data/lib/midi-communications/type_conversion.rb

@@ -0,0 +1,14 @@
+module MIDICommunications
+
+  # Utility for converting between different data formats
+  module TypeConversion
+    extend self
+
+    # Convert an array of numeric bytes to string of hex bytes
+    # @param [Array<Integer>] bytes An array of numeric bytes eg [0x90, 0x40, 0x40]
+    # @return [String] A string of hex bytes eg "904040"
+    def numeric_byte_array_to_hex_string(bytes)
+      bytes.map { |b| b.to_s(16) }.join
+    end
+  end
+end

data/lib/midi-communications.rb

@@ -0,0 +1,22 @@
+#
+# MIDI Communications
+# Platform independent realtime MIDI IO for Ruby
+#
+# (c)2021 Javier Sánchez Yeste for the modifications, licensed under LGPL 3.0 License
+# (c)2011-2017 Ari Russo
+#
+
+# modules
+require 'midi-communications/device'
+require 'midi-communications/platform'
+require 'midi-communications/type_conversion'
+
+# classes
+require 'midi-communications/input'
+require 'midi-communications/loader'
+require 'midi-communications/output'
+
+module MIDICommunications
+  VERSION = '0.5.1'.freeze
+  Platform.bootstrap
+end

data/midi-communications.gemspec

@@ -0,0 +1,31 @@
+Gem::Specification.new do |s|
+  s.name        = 'midi-communications'
+  s.version     = '0.5.1'
+  s.date        = '2021-11-19'
+  s.summary     = 'Platform independent realtime MIDI input and output for Ruby'
+  s.description = 'Access MIDI devices for MacOS, Linux (wip), Windows (wip) and JRuby (wip).'
+  s.authors     = ['Javier Sánchez Yeste']
+  s.email       = ['javier.sy@gmail.com']
+  s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.homepage    = 'https://rubygems.org/gems/midi-communications'
+  s.license     = 'LGPL-3.0'
+
+  s.required_ruby_version = '~> 2.7'
+
+  # TODO
+  #s.metadata    = {
+  # "source_code_uri" => "https://",
+  # "homepage_uri" => "",
+  # "documentation_uri" => "",
+  # "changelog_uri" => ""
+  #}
+
+  s.add_runtime_dependency 'midi-communications-macos', '~> 0.5', '>= 0.5.0'
+  # s.add_runtime_dependency  'alsa-rawmidi', '~> 0.3', '>= 0.3.1'
+  # s.add_runtime_dependency  'midi-jruby', '~> 0.1', '>= 0.1.4'
+  # s.add_runtime_dependency  'midi-winmm', '~> 0.1', '>= 0.1.10'
+
+  s.add_development_dependency 'minitest', '~> 5.14', '>= 5.14.4'
+  s.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
+  s.add_development_dependency 'shoulda-context', '~> 2.0', '>= 2.0.0'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: midi-communications
+version: !ruby/object:Gem::Version
+  version: 0.5.1
+platform: ruby
+authors:
+- Javier Sánchez Yeste
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: midi-communications-macos
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Access MIDI devices for MacOS, Linux (wip), Windows (wip) and JRuby (wip).
+email:
+- javier.sy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.unimidi
+- README.md
+- Rakefile
+- examples/input.rb
+- examples/output.rb
+- examples/select_a_device.rb
+- examples/sysex_output.rb
+- lib/midi-communications.rb
+- lib/midi-communications/adapter/jruby.rb
+- lib/midi-communications/adapter/linux.rb
+- lib/midi-communications/adapter/macos.rb
+- lib/midi-communications/adapter/windows.rb
+- lib/midi-communications/device.rb
+- lib/midi-communications/input.rb
+- lib/midi-communications/input/stream_reader.rb
+- lib/midi-communications/loader.rb
+- lib/midi-communications/output.rb
+- lib/midi-communications/platform.rb
+- lib/midi-communications/type_conversion.rb
+- midi-communications.gemspec
+homepage: https://rubygems.org/gems/midi-communications
+licenses:
+- LGPL-3.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Platform independent realtime MIDI input and output for Ruby
+test_files: []