ffi-coremidi 0.3.8 → 0.5.0

data/lib/coremidi/entity.rb

@@ -1,48 +1,43 @@
-module CoreMIDI
+# frozen_string_literal: true
 
-  # A MIDI entity can have any number of MIDI endpoints, each of which is a source or destination 
-  # of a 16-channel MIDI stream. By grouping a device's endpoints into entities, the system has 
-  # enough information for an application to make reasonable default assumptions about how to 
-  # communicate in a bi-directional manner with each entity, as is necessary in MIDI librarian 
+module CoreMIDI
+  # A MIDI entity can have any number of MIDI endpoints, each of which is a source or destination
+  # of a 16-channel MIDI stream. By grouping a device's endpoints into entities, the system has
+  # enough information for an application to make reasonable default assumptions about how to
+  # communicate in a bi-directional manner with each entity, as is necessary in MIDI librarian
   # applications.
   #
   # https://developer.apple.com/library/ios/documentation/CoreMidi/Reference/MIDIServices_Reference/Reference/reference.html
   class Entity
-
-    attr_reader :endpoints, 
+    attr_reader :endpoints,
                 :manufacturer,
                 :model,
                 :name,
                 :resource
-                
+
     # @param [FFI::Pointer] resource A pointer to the underlying entity
     # @param [Hash] options
     # @option options [Boolean] :include_offline Include offline endpoints in the list
     def initialize(resource, options = {})
-      @endpoints = { 
-        :source => [], 
-        :destination => [] 
+      @endpoints = {
+        source: [],
+        destination: []
       }
       @resource = resource
       populate(options)
     end
-    
+
     # Assign all of this Entity's endpoints an consecutive local id
-    # @param [Fixnum] starting_id
-    # @return [Fixnum]
+    # @param [Integer] starting_id
+    # @return [Integer]
     def populate_endpoint_ids(starting_id)
-      counter = 0
-      @endpoints.values.flatten.each do |endpoint|
-        endpoint.id = counter + starting_id
-        counter += 1
-      end
-      counter
+      @endpoints.values.flatten.map.with_index { |endpoint, index| endpoint.id = index + starting_id }.length
     end
-    
+
     # Is the entity online?
     # @return [Boolean]
     def online?
-      get_int(:offline) == 0
+      get_int(:offline).zero?
     end
 
     private
@@ -52,54 +47,53 @@ module CoreMIDI
     def get_name
       "#{@manufacturer} #{@model}"
     end
-    
+
     # Populate endpoints of a specified type for this entity
     # @param [Symbol] type The endpoint type eg :source, :destination
     # @param [Hash] options
     # @option options [Boolean] :include_offline Include offline endpoints in the list
-    # @return [Fixnum]
+    # @return [Integer]
     def populate_endpoints_by_type(type, options = {})
       endpoint_class = Endpoint.get_class(type)
       num_endpoints = number_of_endpoints(type)
       (0..num_endpoints).each do |i|
         endpoint = endpoint_class.new(i, self)
-        if endpoint.online? || options[:include_offline]
-          @endpoints[type] << endpoint
-        end
-      end  
-      @endpoints[type].size   
+        should_include_message = endpoint.online? || options[:include_offline]
+        @endpoints[type] << endpoint if should_include_message
+      end
+      @endpoints[type].size
     end
 
     # Populate the endpoints for this entity
     # @param [Hash] options
     # @option options [Boolean] :include_offline Include offline endpoints in the list
-    # @return [Fixnum]
+    # @return [Integer]
     def populate_endpoints(options = {})
       @endpoints.keys.map { |type| populate_endpoints_by_type(type, options) }.reduce(&:+)
     end
-    
+
     # The number of endpoints for this entity
     # @param [Symbol] type The endpoint type eg :source, :destination
     def number_of_endpoints(type)
       case type
-        when :source then API.MIDIEntityGetNumberOfSources(@resource)
-        when :destination then API.MIDIEntityGetNumberOfDestinations(@resource)
+      when :source then API.MIDIEntityGetNumberOfSources(@resource)
+      when :destination then API.MIDIEntityGetNumberOfDestinations(@resource)
       end
     end
-    
+
     # A CFString property from the underlying entity
     # @param [Symbol, String] name The property name
     # @return [String, nil]
     def get_string(name)
       API.get_string(@resource, name)
     end
-    
+
     # An Integer property from the underlying entity
     # @param [Symbol, String] name The property name
-    # @return [Fixnum, nil]
+    # @return [Integer, nil]
     def get_int(name)
       API.get_int(@resource, name)
-    end        
+    end
 
     # Populate the entity properties from the underlying resource
     # @param [Hash] options
@@ -110,7 +104,5 @@ module CoreMIDI
       @name = get_name
       populate_endpoints(options)
     end
-
   end
-
 end

data/lib/coremidi/source.rb

@@ -1,11 +1,16 @@
-module CoreMIDI
+# frozen_string_literal: true
 
+module CoreMIDI
   # Type of endpoint used for input
   class Source
-
     include Endpoint
 
-    attr_reader :buffer
+    # The buffer of received messages since instantiation
+    # @return [Array<Hash>]
+    def buffer
+      fill_buffer
+      @buffer
+    end
 
     #
     # An array of MIDI event hashes as such:
@@ -20,15 +25,9 @@ module CoreMIDI
     #
     # @return [Array<Hash>]
     def gets
-      until queued_messages?
-        # per https://github.com/arirusso/unimidi/issues/20#issuecomment-44761318
-        sleep(0.0001) # patch to prevent 100% CPU issue with some midi controllers
-      end
-      messages = queued_messages
-      @pointer = @buffer.length
-      messages
+      fill_buffer(locking: true)
     end
-    alias_method :read, :gets
+    alias read gets
 
     # Same as Source#gets except that it returns message data as string of hex
     # digits as such:
@@ -46,12 +45,12 @@ module CoreMIDI
       end
       messages
     end
-    alias_method :gets_bytestr, :gets_s
+    alias gets_bytestr gets_s
 
     # Enable this the input for use; can be passed a block
     # @return [Source]
-    def enable(options = {}, &block)
-      @enabled = true unless @enabled
+    def enable(_options = {})
+      @enabled ||= true
       if block_given?
         begin
           yield(self)
@@ -61,20 +60,20 @@ module CoreMIDI
       end
       self
     end
-    alias_method :open, :enable
-    alias_method :start, :enable
+    alias open enable
+    alias start enable
 
     # Close this input
     # @return [Boolean]
     def close
-      #error = API.MIDIPortDisconnectSource( @handle, @resource )
-      #raise "MIDIPortDisconnectSource returned error code #{error}" unless error.zero?
-      #error = API.MIDIClientDispose(@handle)
-      #raise "MIDIClientDispose returned error code #{error}" unless error.zero?
-      #error = API.MIDIPortDispose(@handle)
-      #raise "MIDIPortDispose returned error code #{error}" unless error.zero?
-      #error = API.MIDIEndpointDispose(@resource)
-      #raise "MIDIEndpointDispose returned error code #{error}" unless error.zero?
+      # error = API.MIDIPortDisconnectSource( @handle, @resource )
+      # raise "MIDIPortDisconnectSource returned error code #{error}" unless error.zero?
+      # error = API.MIDIClientDispose(@handle)
+      # raise "MIDIClientDispose returned error code #{error}" unless error.zero?
+      # error = API.MIDIPortDispose(@handle)
+      # raise "MIDIPortDispose returned error code #{error}" unless error.zero?
+      # error = API.MIDIEndpointDispose(@resource)
+      # raise "MIDIEndpointDispose returned error code #{error}" unless error.zero?
       if @enabled
         @enabled = false
         true
@@ -103,24 +102,49 @@ module CoreMIDI
 
     protected
 
+    def truncate_buffer
+      @buffer.slice!(-1024, 1024)
+    end
+
+    # Migrate new received messages from the callback queue to
+    # the buffer
+    def fill_buffer(locking: nil)
+      locking ||= false
+
+      messages = []
+
+      if locking && @queue.empty?
+        @threads_sync_semaphore.synchronize do
+          @threads_waiting << Thread.current
+        end
+        sleep
+      end
+
+      messages << @queue.pop until @queue.empty?
+      @buffer += messages
+      truncate_buffer
+      @pointer = @buffer.length
+      messages
+    end
+
     # Base initialization for this endpoint -- done whether or not the endpoint is enabled to check whether
     # it is truly available for use
     def connect
       enable_client
       initialize_port
       @resource = API.MIDIEntityGetSource(@entity.resource, @resource_id)
-      error = API.MIDIPortConnectSource(@handle, @resource, nil )
+      error = API.MIDIPortConnectSource(@handle, @resource, nil)
       initialize_buffer
+      @queue = Queue.new
       @sysex_buffer = []
-      @start_time = Time.now.to_f
 
       error.zero?
     end
-    alias_method :connect?, :connect
+    alias connect? connect
 
     private
 
-    # Add a single message to the buffer
+    # Add a single message to the callback queue
     # @param [Array<Fixnum>] bytes Message data
     # @param [Float] timestamp The system float timestamp
     # @return [Array<Hash>] The resulting buffer
@@ -132,31 +156,29 @@ module CoreMIDI
           @sysex_buffer.clear
         end
       end
-      @buffer << get_message_formatted(bytes, timestamp) if @sysex_buffer.empty?
-      @buffer
-    end
+      message = get_message_formatted(bytes, timestamp)
+      @queue << message
 
-    # New MIDI messages from the queue
-    def queued_messages
-      @buffer.slice(@pointer, @buffer.length - @pointer)
-    end
+      @threads_sync_semaphore.synchronize do
+        @threads_waiting.each(&:run)
+        @threads_waiting.clear
+      end
 
-    # Are there new MIDI messages in the queue?
-    def queued_messages?
-      @pointer < @buffer.length
+      message
     end
 
-    # The callback fired by coremidi when new MIDI messages are in the buffer
+    # The callback fired by coremidi when new MIDI messages are received
     def get_event_callback
-      Proc.new do |new_packets, refCon_ptr, connRefCon_ptr|
-        begin
-          # p "packets received: #{new_packets[:numPackets]}"
-          timestamp = Time.now.to_f
-          messages = get_messages(new_packets)
-          messages.each { |message| enqueue_message(message, timestamp) }
-        rescue Exception => exception
-          Thread.main.raise(exception)
+      Thread.abort_on_exception = true
+      proc do |new_packets, _refCon_ptr, _connRefCon_ptr|
+        # p "packets received: #{new_packets[:numPackets]}"
+        timestamp = Time.now.to_f
+        messages = get_messages(new_packets)
+        messages.each do |message|
+          enqueue_message(message, timestamp)
         end
+      rescue Exception => e
+        Thread.main.raise(e)
       end
     end
 
@@ -169,18 +191,18 @@ module CoreMIDI
       data = first[:data].to_a
       messages = []
       messages << data.slice!(0, first[:length])
-      (count - 1).times do |i|
+      (count - 1).times do |_i|
         length_index = find_next_length_index(data)
         message_length = data[length_index]
-        unless message_length.nil?
-          packet_start_index = length_index + 2
-          packet_end_index = packet_start_index + message_length
-          if data.length >= packet_end_index + 1
-            packet = data.slice!(0..packet_end_index)
-            message = packet.slice(packet_start_index, message_length)
-            messages << message
-          end
-        end
+        next if message_length.nil?
+
+        packet_start_index = length_index + 2
+        packet_end_index = packet_start_index + message_length
+        next unless data.length >= packet_end_index + 1
+
+        packet = data.slice!(0..packet_end_index)
+        message = packet.slice(packet_start_index, message_length)
+        messages << message
       end
       messages
     end
@@ -203,18 +225,12 @@ module CoreMIDI
       end
     end
 
-    # Timestamp for a received MIDI message
-    # @return [Fixnum]
-    def timestamp(now)
-      (now - @start_time) * 1000
-    end
-
     # Give a message its timestamp and package it in a Hash
     # @return [Hash]
     def get_message_formatted(raw, time)
       {
-        :data => raw,
-        :timestamp => timestamp(time)
+        data: raw,
+        timestamp: time
       }
     end
 
@@ -225,6 +241,7 @@ module CoreMIDI
       port = API.create_midi_input_port(@client, @resource_id, @name, @callback)
       @handle = port[:handle]
       raise "MIDIInputPortCreate returned error code #{port[:error]}" unless port[:error].zero?
+
       true
     end
 
@@ -239,7 +256,5 @@ module CoreMIDI
       end
       true
     end
-
   end
-
 end

data/lib/coremidi/type_conversion.rb

@@ -1,21 +1,20 @@
-module CoreMIDI
+# frozen_string_literal: true
 
-  # Helper for convertig MIDI data
+module CoreMIDI
+  # Helper for converting MIDI data
   module TypeConversion
-
-    extend self
+    module_function
 
     # Convert an array of numeric byes to a hex string (e.g. [0x90, 0x40, 0x40] becomes "904040")
-    # @param [Array<Fixnum>] bytes
+    # @param [Array<Integer>] bytes
     # @return [String]
     def numeric_bytes_to_hex_string(bytes)
-      string_bytes = bytes.map do |byte| 
+      string_bytes = bytes.map do |byte|
         str = byte.to_s(16).upcase
-        str = "0" + str if byte < 16
+        str = "0#{str}" if byte < 16
         str
       end
       string_bytes.join
-    end 
-
+    end
   end
 end

data/lib/coremidi.rb

@@ -1,23 +1,28 @@
-# ffi-coremidi
+# frozen_string_literal: true
+
 #
+# ffi-coremidi
 # Realtime MIDI IO with Ruby for OSX
-# (c)2011-2015 Ari Russo
+#
+# (c)2011-2022 Ari Russo
+# https://github.com/arirusso/ffi-coremidi
+#
 
 # Libs
-require "ffi"
-require "forwardable"
+require 'ffi'
+require 'forwardable'
 
 # Modules
-require "coremidi/api"
-require "coremidi/endpoint"
-require "coremidi/type_conversion"
+require 'coremidi/api'
+require 'coremidi/endpoint'
+require 'coremidi/type_conversion'
 
 # Classes
-require "coremidi/entity"
-require "coremidi/device"
-require "coremidi/source"
-require "coremidi/destination"
+require 'coremidi/entity'
+require 'coremidi/device'
+require 'coremidi/source'
+require 'coremidi/destination'
 
 module CoreMIDI
-  VERSION = "0.3.8"
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-coremidi
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.5.0
 platform: ruby
 authors:
 - Ari Russo
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-05-31 00:00:00.000000000 Z
+date: 2022-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -16,100 +16,100 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.15'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.5.0
+        version: 5.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.15'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.5.0
+        version: 5.15.0
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '3.11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '3.11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
-  name: shoulda-context
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.25'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.25'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.15'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.6
+        version: 1.15.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.15'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.6
+        version: 1.15.5
 description: Perform realtime MIDI IO with Ruby for OSX
 email:
 - ari.russo@gmail.com
@@ -127,14 +127,11 @@ files:
 - lib/coremidi/entity.rb
 - lib/coremidi/source.rb
 - lib/coremidi/type_conversion.rb
-- test/helper.rb
-- test/input_buffer_test.rb
-- test/io_test.rb
 homepage: http://github.com/arirusso/ffi-coremidi
 licenses:
-- Apache 2.0
+- Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,9 +146,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: ffi-coremidi
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Realtime MIDI IO with Ruby for OSX
 test_files: []