ffi-coremidi 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 24583f1bb64dea16e2988a4ed7f4c51411000413
-  data.tar.gz: 3d7804e408e78313e46095ca9fa879c1c427d9e0
+SHA256:
+  metadata.gz: d05cb8f763c856b651e7fa5f94499350bc7576cd210e7402ce26bc9bbd714739
+  data.tar.gz: 77a98c6abc53d0287bc4e57d7f3cce217da9e32d73fd6a3205602f0c6bd69fbe
 SHA512:
-  metadata.gz: c8d2c2fc9c502f21710213e46ecd03937a61f58f0f6bdbc74652ab3995c5615eb1ef23ebdf79a1fe0afaa8fecdd39898ae1ad29b257de5314b2a038f2ff6f688
-  data.tar.gz: adbb7aa16fe70b8306cd0dd8f9740a15b1b23fd3c4b04ec61616120b3fcc3ad0e1e132c4a526d0cc682d0eb94067940c86f023654e457e01cc7e414033df57aa
+  metadata.gz: fc172a0d02c6fc6efd3d1337623e92fdf9bb4b01e08debe2105ed78bb306d49db44308d72cc0041cd04ee04ecb50f4ebda935610bcf18dab67afb2b90e1a5d9b
+  data.tar.gz: bbdcf6d8e87f2896db09859e79b6d8c39f33ea2046a10704d917439d7974e50224ed842414ece048e99d671943da7939e47cef74ae3e4683ee4ccdf54646687b

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2011-2017 Ari Russo
+Copyright 2011-2022 Ari Russo
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -48,4 +48,4 @@ Also thank you to [Jeremy Voorhis](http://github.com/jvoorhis) for some useful d
 
 Apache 2.0, See the file LICENSE
 
-Copyright (c) 2011-2017 [Ari Russo](http://github.com/arirusso)
+Copyright (c) 2011-2022 [Ari Russo](http://github.com/arirusso)

data/lib/coremidi/api.rb

@@ -1,8 +1,8 @@
-module CoreMIDI
+# frozen_string_literal: true
 
+module CoreMIDI
   # Coremidi C binding
   module API
-
     extend FFI::Library
     ffi_lib '/System/Library/Frameworks/CoreMIDI.framework/Versions/Current/CoreMIDI'
 
@@ -17,12 +17,11 @@ module CoreMIDI
     typedef :pointer, :MIDIEntityRef
     typedef :pointer, :MIDIObjectRef
     typedef :pointer, :MIDIPortRef
-    #typedef :pointer, :MIDIReadProc
+    # typedef :pointer, :MIDIReadProc
     typedef :uint32, :MIDITimeStamp
     typedef :int32, :OSStatus
 
     class MIDISysexSendRequest < FFI::Struct
-
       layout :destination,         :MIDIEndpointRef,
              :data,                :pointer,
              :bytes_to_send,       :uint32,
@@ -33,18 +32,15 @@ module CoreMIDI
     end
 
     class MIDIPacket < FFI::Struct
-
       layout :timestamp, :MIDITimeStamp,
              :nothing, :uint32, # no idea...
              :length, :uint16,
              :data, [:uint8, 256]
-
     end
 
     class MIDIPacketList < FFI::Struct
       layout :numPackets, :uint32,
              :packet, [MIDIPacket.by_value, 1]
-
     end
 
     def self.get_callback(*args, &block)
@@ -53,7 +49,7 @@ module CoreMIDI
 
     # Pack the given data into a coremidi MIDI packet (used by Destination)
     def self.get_midi_packet(data)
-      format = "C" * data.size
+      format = 'C' * data.size
       packed_data = data.pack(format)
       char_size = FFI.type_size(:char) * data.size
       bytes = FFI::MemoryPointer.new(char_size)
@@ -67,8 +63,8 @@ module CoreMIDI
       error = API.MIDIClientCreate(client_name, nil, nil, client_pointer)
       client = client_pointer.read_pointer
       {
-        :error => error,
-        :resource => client
+        error: error,
+        resource: client
       }
     end
 
@@ -78,8 +74,8 @@ module CoreMIDI
       error = API.MIDIInputPortCreate(client, port_name, callback, nil, handle_ptr)
       handle = handle_ptr.read_pointer
       {
-        :error => error,
-        :handle => handle
+        error: error,
+        handle: handle
       }
     end
 
@@ -89,8 +85,8 @@ module CoreMIDI
       error = API.MIDIOutputPortCreate(client, port_name, port_pointer)
       handle = port_pointer.read_pointer
       {
-        :error => error,
-        :handle => handle
+        error: error,
+        handle: handle
       }
     end
 
@@ -100,11 +96,12 @@ module CoreMIDI
       packet_ptr = API.MIDIPacketListInit(packet_list)
       time = HostTime.AudioGetCurrentHostTime
       packet_ptr = if X86_64
-        API.MIDIPacketListAdd(packet_list, 256, packet_ptr, time, size, bytes)
-      else
-        # Pass in two 32-bit 0s for the 64 bit time
-        time1 = API.MIDIPacketListAdd(packet_list, 256, packet_ptr, time >> 32, time & 0xFFFFFFFF, size, bytes)
-      end
+                     API.MIDIPacketListAdd(packet_list, 256, packet_ptr, time, size, bytes)
+                   else
+                     # Pass in two 32-bit 0s for the 64 bit time
+                     time1 = API.MIDIPacketListAdd(packet_list, 256, packet_ptr, time >> 32, time & 0xFFFFFFFF, size,
+                                                   bytes)
+                   end
       packet_list
     end
 
@@ -132,7 +129,7 @@ module CoreMIDI
         bytes = FFI::MemoryPointer.new(length + 1)
 
         if CF.CFStringGetCString(string, bytes, length + 1, :kCFStringEncodingUTF8)
-          bytes.read_string.force_encoding("utf-8")
+          bytes.read_string.force_encoding('utf-8')
         end
       ensure
         CF.CFRelease(string) unless string.nil? || string.null?
@@ -145,13 +142,13 @@ module CoreMIDI
     callback :MIDIReadProc, [MIDIPacketList.by_ref, :pointer, :pointer], :pointer
 
     # OSStatus MIDIClientCreate(CFStringRef name, MIDINotifyProc notifyProc, void *notifyRefCon, MIDIClientRef *outClient);
-    attach_function :MIDIClientCreate, [:pointer, :pointer, :pointer, :pointer], :int
+    attach_function :MIDIClientCreate, %i[pointer pointer pointer pointer], :int
 
     # OSStatus MIDIClientDispose(MIDIClientRef client);
     attach_function :MIDIClientDispose, [:pointer], :int
 
     # MIDIEntityRef MIDIDeviceGetEntity(MIDIDeviceRef  device, ItemCount entityIndex0);
-    attach_function :MIDIDeviceGetEntity, [:MIDIDeviceRef, :ItemCount], :MIDIEntityRef
+    attach_function :MIDIDeviceGetEntity, %i[MIDIDeviceRef ItemCount], :MIDIEntityRef
 
     # MIDIEndpointRef MIDIGetDestination(ItemCount destIndex0);
     attach_function :MIDIGetNumberOfDestinations, [], :ItemCount
@@ -162,11 +159,11 @@ module CoreMIDI
     # MIDIEndpointRef MIDIEntityGetDestination(MIDIEntityRef entity, ItemCount destIndex0);
     attach_function :MIDIGetDestination, [:int], :pointer
 
-    #extern OSStatus MIDIEndpointDispose( MIDIEndpointRef endpt );
+    # extern OSStatus MIDIEndpointDispose( MIDIEndpointRef endpt );
     attach_function :MIDIEndpointDispose, [:MIDIEndpointRef], :OSStatus
 
     # MIDIEndpointRef MIDIEntityGetDestination( MIDIEntityRef entity, ItemCount destIndex0 );
-    attach_function :MIDIEntityGetDestination, [:MIDIEntityRef, :int], :MIDIEndpointRef
+    attach_function :MIDIEntityGetDestination, %i[MIDIEntityRef int], :MIDIEndpointRef
 
     # ItemCount MIDIEntityGetNumberOfDestinations (MIDIEntityRef  entity);
     attach_function :MIDIEntityGetNumberOfDestinations, [:MIDIEntityRef], :ItemCount
@@ -175,77 +172,76 @@ module CoreMIDI
     attach_function :MIDIEntityGetNumberOfSources, [:MIDIEntityRef], :ItemCount
 
     # MIDIEndpointRef MIDIEntityGetSource (MIDIEntityRef  entity, ItemCount sourceIndex0);
-    attach_function :MIDIEntityGetSource, [:MIDIEntityRef, :ItemCount], :MIDIEndpointRef
+    attach_function :MIDIEntityGetSource, %i[MIDIEntityRef ItemCount], :MIDIEndpointRef
 
     # MIDIDeviceRef MIDIGetDevice(ItemCount deviceIndex0);
     attach_function :MIDIGetDevice, [:ItemCount], :MIDIDeviceRef
 
     # extern OSStatus MIDIInputPortCreate( MIDIClientRef client, CFStringRef portName,
     #                                      MIDIReadProc readProc, void * refCon, MIDIPortRef * outPort );
-    attach_function :MIDIInputPortCreate, [:MIDIClientRef, :CFStringRef, :MIDIReadProc, :pointer, :MIDIPortRef], :OSStatus
+    attach_function :MIDIInputPortCreate, %i[MIDIClientRef CFStringRef MIDIReadProc pointer MIDIPortRef],
+                    :OSStatus
 
     # extern OSStatus MIDIObjectGetIntegerProperty( MIDIObjectRef obj, CFStringRef propertyID, SInt32 * outValue );
-    attach_function :MIDIObjectGetIntegerProperty, [:MIDIObjectRef, :CFStringRef, :pointer], :OSStatus
+    attach_function :MIDIObjectGetIntegerProperty, %i[MIDIObjectRef CFStringRef pointer], :OSStatus
 
     # OSStatus MIDIObjectGetStringProperty (MIDIObjectRef  obj, CFStringRef propertyID, CFStringRef *str);
-    attach_function :MIDIObjectGetStringProperty, [:MIDIObjectRef, :CFStringRef, :pointer], :OSStatus
+    attach_function :MIDIObjectGetStringProperty, %i[MIDIObjectRef CFStringRef pointer], :OSStatus
 
     # extern OSStatus MIDIOutputPortCreate( MIDIClientRef client, CFStringRef portName, MIDIPortRef * outPort );
-    attach_function :MIDIOutputPortCreate, [:MIDIClientRef, :CFStringRef, :pointer], :int
+    attach_function :MIDIOutputPortCreate, %i[MIDIClientRef CFStringRef pointer], :int
 
     # (MIDIPacket*) MIDIPacketListInit(MIDIPacketList *pktlist);
     attach_function :MIDIPacketListInit, [:pointer], :pointer
 
-    #extern OSStatus MIDIPortConnectSource( MIDIPortRef port, MIDIEndpointRef source, void * connRefCon )
-    attach_function :MIDIPortConnectSource, [:MIDIPortRef, :MIDIEndpointRef, :pointer], :OSStatus
+    # extern OSStatus MIDIPortConnectSource( MIDIPortRef port, MIDIEndpointRef source, void * connRefCon )
+    attach_function :MIDIPortConnectSource, %i[MIDIPortRef MIDIEndpointRef pointer], :OSStatus
 
-    #extern OSStatus MIDIPortDisconnectSource( MIDIPortRef port, MIDIEndpointRef source );
-    attach_function :MIDIPortDisconnectSource, [:MIDIPortRef, :MIDIEndpointRef], :OSStatus
+    # extern OSStatus MIDIPortDisconnectSource( MIDIPortRef port, MIDIEndpointRef source );
+    attach_function :MIDIPortDisconnectSource, %i[MIDIPortRef MIDIEndpointRef], :OSStatus
 
-    #extern OSStatus MIDIPortDispose(MIDIPortRef port );
+    # extern OSStatus MIDIPortDispose(MIDIPortRef port );
     attach_function :MIDIPortDispose, [:MIDIPortRef], :OSStatus
 
-    #extern OSStatus MIDISend(MIDIPortRef port,MIDIEndpointRef dest,const MIDIPacketList *pktlist);
-    attach_function :MIDISend, [:MIDIPortRef, :MIDIEndpointRef, :pointer], :int
+    # extern OSStatus MIDISend(MIDIPortRef port,MIDIEndpointRef dest,const MIDIPacketList *pktlist);
+    attach_function :MIDISend, %i[MIDIPortRef MIDIEndpointRef pointer], :int
 
-    #OSStatus MIDISendSysex(MIDISysexSendRequest *request);
+    # OSStatus MIDISendSysex(MIDISysexSendRequest *request);
     attach_function :MIDISendSysex, [:pointer], :int
 
     # extern MIDIPacket * MIDIPacketListAdd( MIDIPacketList * pktlist, ByteCount listSize,
     #                                        MIDIPacket * curPacket, MIDITimeStamp time,
     #                                        ByteCount nData, const Byte * data)
     if X86_64
-      attach_function :MIDIPacketListAdd, [:pointer, :int, :pointer, :uint64, :int, :pointer], :pointer
+      attach_function :MIDIPacketListAdd, %i[pointer int pointer uint64 int pointer], :pointer
     else
-      attach_function :MIDIPacketListAdd, [:pointer, :int, :pointer, :int, :int, :int, :pointer], :pointer
+      attach_function :MIDIPacketListAdd, %i[pointer int pointer int int int pointer], :pointer
     end
 
     module CF
-
       extend FFI::Library
       ffi_lib '/System/Library/Frameworks/CoreFoundation.framework/Versions/Current/CoreFoundation'
 
       typedef :pointer, :CFStringRef
       typedef :long, :CFIndex
-      enum :CFStringEncoding, [ :kCFStringEncodingUTF8, 0x08000100 ]
+      enum :CFStringEncoding, [:kCFStringEncodingUTF8, 0x08000100]
 
       # CFString* CFStringCreateWithCString( ?, CString, encoding)
-      attach_function :CFStringCreateWithCString, [:pointer, :string, :int], :pointer
+      attach_function :CFStringCreateWithCString, %i[pointer string int], :pointer
       # CString* CFStringGetCStringPtr(CFString*, encoding)
-      attach_function :CFStringGetCStringPtr, [:pointer, :int], :pointer
+      attach_function :CFStringGetCStringPtr, %i[pointer int], :pointer
 
       # CFIndex CFStringGetLength(CFStringRef theString);
-      attach_function :CFStringGetLength, [ :CFStringRef ], :CFIndex
+      attach_function :CFStringGetLength, [:CFStringRef], :CFIndex
 
       # CFIndex CFStringGetMaximumSizeForEncoding(CFIndex length, CFStringEncoding encoding);
-      attach_function :CFStringGetMaximumSizeForEncoding, [ :CFIndex, :CFStringEncoding ], :long
+      attach_function :CFStringGetMaximumSizeForEncoding, %i[CFIndex CFStringEncoding], :long
 
       # Boolean CFStringGetCString(CFStringRef theString, char *buffer, CFIndex bufferSize, CFStringEncoding encoding);
-      attach_function :CFStringGetCString, [ :CFStringRef, :pointer, :CFIndex, :CFStringEncoding ], :bool
+      attach_function :CFStringGetCString, %i[CFStringRef pointer CFIndex CFStringEncoding], :bool
 
       # void CFRelease (CFTypeRef cf);
-      attach_function :CFRelease, [ :pointer ], :void
-
+      attach_function :CFRelease, [:pointer], :void
     end
 
     module HostTime
@@ -257,7 +253,5 @@ module CoreMIDI
       # UInt64 AudioGetCurrentHostTime()
       attach_function :AudioGetCurrentHostTime, [], :uint64
     end
-
   end
-
 end

data/lib/coremidi/destination.rb

@@ -1,8 +1,8 @@
-module CoreMIDI
+# frozen_string_literal: true
 
+module CoreMIDI
   # Type of endpoint used for output
   class Destination
-
     include Endpoint
 
     attr_reader :entity
@@ -24,14 +24,14 @@ module CoreMIDI
     def puts_s(data)
       data = data.dup
       bytes = []
-      until (str = data.slice!(0,2)).eql?("")
+      until (str = data.slice!(0, 2)).eql?('')
         bytes << str.hex
       end
       puts_bytes(*bytes)
       true
     end
-    alias_method :puts_bytestr, :puts_s
-    alias_method :puts_hex, :puts_s
+    alias puts_bytestr puts_s
+    alias puts_hex puts_s
 
     # Send a MIDI message comprised of numeric bytes
     # @param [*Integer] data Numeric bytes eg 0x90, 0x40, 0x40
@@ -39,7 +39,7 @@ module CoreMIDI
     def puts_bytes(*data)
       type = sysex?(data) ? :sysex : :small
       bytes = API.get_midi_packet(data)
-      send("puts_#{type.to_s}", bytes, data.size)
+      send("puts_#{type}", bytes, data.size)
       true
     end
 
@@ -53,12 +53,12 @@ module CoreMIDI
       when String then puts_bytestr(*args)
       end
     end
-    alias_method :write, :puts
+    alias write puts
 
     # Enable this device
     # @return [Destination]
-    def enable(options = {}, &block)
-      @enabled = true unless @enabled
+    def enable(_options = {})
+      @enabled ||= true
       if block_given?
         begin
           yield(self)
@@ -68,8 +68,8 @@ module CoreMIDI
       end
       self
     end
-    alias_method :open, :enable
-    alias_method :start, :enable
+    alias open enable
+    alias start enable
 
     # Shortcut to the first output endpoint available
     # @return [Destination]
@@ -97,10 +97,10 @@ module CoreMIDI
     def connect
       client_error = enable_client
       port_error = initialize_port
-      @resource = API.MIDIEntityGetDestination( @entity.resource, @resource_id )
+      @resource = API.MIDIEntityGetDestination(@entity.resource, @resource_id)
       !@resource.address.zero? && client_error.zero? && port_error.zero?
     end
-    alias_method :connect?, :connect
+    alias connect? connect
 
     private
 
@@ -126,7 +126,7 @@ module CoreMIDI
 
     SysexCompletionCallback =
       API.get_callback([:pointer]) do |sysex_request_ptr|
-      # this isn't working for some reason. as of now, it's not needed though
+        # this isn't working for some reason. as of now, it's not needed though
       end
 
     # Initialize a coremidi port for this endpoint
@@ -140,7 +140,5 @@ module CoreMIDI
     def sysex?(data)
       data.first.eql?(0xF0) && data.last.eql?(0xF7)
     end
-
   end
-
 end

data/lib/coremidi/device.rb

@@ -1,12 +1,12 @@
-module CoreMIDI
+# frozen_string_literal: true
 
+module CoreMIDI
   # A MIDI device may have multiple logically distinct sub-components. For example, one device may
   # encompass a MIDI synthesizer and a pair of MIDI ports, both addressable via a USB port. Each
   # such element of a device is called a MIDI entity.
   #
   # https://developer.apple.com/library/ios/documentation/CoreMidi/Reference/MIDIServices_Reference/Reference/reference.html
   class Device
-
     attr_reader :entities,
                 :id, # Unique Numeric id
                 :name # Device name from coremidi
@@ -25,8 +25,8 @@ module CoreMIDI
     # Endpoints for this device
     # @return [Array<Endpoint>]
     def endpoints
-      endpoints = { :source => [], :destination => [] }
-      endpoints.keys.each do |key|
+      endpoints = { source: [], destination: [] }
+      endpoints.each_key do |key|
         endpoint_group = entities.map { |entity| entity.endpoints[key] }.flatten
         endpoints[key] += endpoint_group
       end
@@ -53,8 +53,8 @@ module CoreMIDI
       if !populated? || !use_cache
         @devices = []
         counter = 0
-        while !(device_pointer = API.MIDIGetDevice(counter)).null?
-          device = new(counter, device_pointer, :include_offline => include_offline)
+        until (device_pointer = API.MIDIGetDevice(counter)).null?
+          device = new(counter, device_pointer, include_offline: include_offline)
           @devices << device
           counter += 1
         end
@@ -79,8 +79,8 @@ module CoreMIDI
 
     # Populate the device name
     def populate_name
-      @name = API.get_string(@resource, "name")
-      raise RuntimeError.new("Can't get device name") unless @name
+      @name = API.get_string(@resource, 'name')
+      raise "Can't get device name" unless @name
     end
 
     # All of the endpoints for all devices a consecutive local id
@@ -97,8 +97,8 @@ module CoreMIDI
     def populate_entities(options = {})
       include_if_offline = options[:include_offline] || false
       i = 0
-      while !(entity_pointer = API.MIDIDeviceGetEntity(@resource, i)).null?
-        @entities << Entity.new(entity_pointer, :include_offline => include_if_offline)
+      until (entity_pointer = API.MIDIDeviceGetEntity(@resource, i)).null?
+        @entities << Entity.new(entity_pointer, include_offline: include_if_offline)
         i += 1
       end
       i
@@ -107,9 +107,7 @@ module CoreMIDI
     # Populate the instance
     def populate(options = {})
       populate_name
-      populate_entities(:include_offline => options[:include_offline])
+      populate_entities(include_offline: options[:include_offline])
     end
-
   end
-
 end

data/lib/coremidi/endpoint.rb

@@ -1,10 +1,10 @@
-module CoreMIDI
+# frozen_string_literal: true
 
+module CoreMIDI
   # A source or destination of a 16-channel MIDI stream
   #
   # https://developer.apple.com/library/ios/documentation/CoreMidi/Reference/MIDIServices_Reference/Reference/reference.html
   module Endpoint
-
     extend Forwardable
 
     attr_reader :enabled, # has the endpoint been initialized?
@@ -15,7 +15,7 @@ module CoreMIDI
 
     def_delegators :entity, :manufacturer, :model, :name
 
-    alias_method :enabled?, :enabled
+    alias enabled? enabled
 
     # @param [Integer] resource_id
     # @param [Entity] entity
@@ -24,6 +24,9 @@ module CoreMIDI
       @resource_id = resource_id
       @type = get_type
       @enabled = false
+
+      @threads_sync_semaphore = Mutex.new
+      @threads_waiting = []
     end
 
     # Is this endpoint online?
@@ -102,7 +105,5 @@ module CoreMIDI
       @client = client[:resource]
       client[:error]
     end
-
   end
-
 end

data/lib/coremidi/entity.rb

@@ -1,5 +1,6 @@
-module CoreMIDI
+# frozen_string_literal: true
 
+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
@@ -8,7 +9,6 @@ module CoreMIDI
   #
   # https://developer.apple.com/library/ios/documentation/CoreMidi/Reference/MIDIServices_Reference/Reference/reference.html
   class Entity
-
     attr_reader :endpoints,
                 :manufacturer,
                 :model,
@@ -31,18 +31,13 @@ module CoreMIDI
     # @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
@@ -63,9 +58,8 @@ module CoreMIDI
       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
+        should_include_message = endpoint.online? || options[:include_offline]
+        @endpoints[type] << endpoint if should_include_message
       end
       @endpoints[type].size
     end
@@ -82,8 +76,8 @@ module CoreMIDI
     # @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
 
@@ -110,7 +104,5 @@ module CoreMIDI
       @name = get_name
       populate_endpoints(options)
     end
-
   end
-
 end

data/lib/coremidi/source.rb

@@ -1,8 +1,8 @@
-module CoreMIDI
+# frozen_string_literal: true
 
+module CoreMIDI
   # Type of endpoint used for input
   class Source
-
     include Endpoint
 
     # The buffer of received messages since instantiation
@@ -25,9 +25,9 @@ module CoreMIDI
     #
     # @return [Array<Hash>]
     def gets
-      fill_buffer
+      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:
@@ -45,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)
@@ -60,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
@@ -102,14 +102,27 @@ 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
+    def fill_buffer(locking: nil)
+      locking ||= false
+
       messages = []
-      until @queue.empty?
-        messages << @queue.pop
+
+      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
@@ -120,14 +133,14 @@ module CoreMIDI
       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 = []
 
       error.zero?
     end
-    alias_method :connect?, :connect
+    alias connect? connect
 
     private
 
@@ -145,33 +158,27 @@ module CoreMIDI
       end
       message = get_message_formatted(bytes, timestamp)
       @queue << message
-      message
-    end
 
-    # New MIDI messages from the queue
-    def queued_messages
-      @queue.pop
-    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?
-      !@queue.empty?
+      message
     end
 
     # The callback fired by coremidi when new MIDI messages are received
     def get_event_callback
       Thread.abort_on_exception = true
-      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 do |message|
-            enqueue_message(message, timestamp)
-          end
-        rescue Exception => exception
-          Thread.main.raise(exception)
+      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
 
@@ -184,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
@@ -234,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
 
@@ -248,7 +256,5 @@ module CoreMIDI
       end
       true
     end
-
   end
-
 end

data/lib/coremidi/type_conversion.rb

@@ -1,9 +1,9 @@
-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<Integer>] bytes
@@ -11,11 +11,10 @@ module CoreMIDI
     def numeric_bytes_to_hex_string(bytes)
       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,26 +1,28 @@
+# frozen_string_literal: true
+
 #
 # ffi-coremidi
 # Realtime MIDI IO with Ruby for OSX
 #
-# (c)2011-2017 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.4.1"
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-coremidi
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Ari Russo
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-07-06 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
 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.6.12
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Realtime MIDI IO with Ruby for OSX
 test_files: []

data/test/helper.rb

@@ -1,66 +0,0 @@
-dir = File.dirname(File.expand_path(__FILE__))
-$LOAD_PATH.unshift dir + "/../lib"
-
-require "minitest/autorun"
-require "mocha/test_unit"
-require "shoulda-context"
-
-require "coremidi"
-
-module TestHelper
-
-  extend self
-
-  def device
-    @device ||= select_devices
-  end
-
-  def select_devices
-    @device ||= {}
-    { :input => CoreMIDI::Source.all, :output => CoreMIDI::Destination.all }.each do |type, devs|
-      puts ""
-      puts "select an #{type.to_s}..."
-      while @device[type].nil?
-        devs.each do |device|
-          puts "#{device.id}: #{device.name}"
-        end
-        selection = $stdin.gets.chomp
-        if selection != ""
-          selection = selection.to_i
-          @device[type] = devs.find { |d| d.id == selection }
-          puts "selected #{selection} for #{type.to_s}" unless @device[type]
-        end
-      end
-    end
-    @device
-  end
-
-  def bytestrs_to_ints(arr)
-    data = arr.map { |m| m[:data] }.join
-      output = []
-      until (bytestr = data.slice!(0,2)).eql?("")
-        output << bytestr.hex
-      end
-    output
-  end
-
-  # some MIDI messages
-  VariousMIDIMessages = [
-    [0xF0, 0x41, 0x10, 0x42, 0x12, 0x40, 0x00, 0x7F, 0x00, 0x41, 0xF7], # SysEx
-    [0x90, 100, 100], # note on
-    [0x90, 43, 100], # note on
-    [0x90, 76, 100], # note on
-    [0x90, 60, 100], # note on
-    [0x80, 100, 100] # note off
-  ]
-
-  # some MIDI messages
-  VariousMIDIByteStrMessages = [
-    "F04110421240007F0041F7", # SysEx
-    "906440", # note on
-    "804340" # note off
-  ]
-
-end
-
-TestHelper.select_devices

data/test/input_buffer_test.rb

@@ -1,42 +0,0 @@
-require "helper"
-
-class InputBufferTest < Minitest::Test
-
-  context "CoreMIDI" do
-
-    setup do
-      sleep(1)
-    end
-
-    context "Source#buffer" do
-
-      setup do
-        @messages = TestHelper::VariousMIDIMessages
-        @messages_arr = @messages.inject { |a,b| a+b }.flatten
-        @received_arr = []
-        @pointer = 0
-
-        @output = TestHelper.device[:output].open
-        @input = TestHelper.device[:input].open
-        @input.buffer.clear
-      end
-
-      should "have the correct messages in the buffer" do
-        bytes = []
-        @messages.each do |message|
-          puts "sending: #{message.inspect}"
-          @output.puts(message)
-          bytes += message
-
-          sleep(0.5)
-
-          buffer = @input.buffer.map { |m| m[:data] }.flatten
-          puts "received: #{buffer.to_s}"
-          assert_equal(bytes, buffer)
-        end
-        assert_equal(bytes.length, @input.buffer.map { |m| m[:data] }.flatten.length)
-      end
-    end
-
-  end
-end

data/test/io_test.rb

@@ -1,90 +0,0 @@
-require "helper"
-
-class CoreMIDI::IOTest < Minitest::Test
-
-  # ** these tests assume that TestOutput is connected to TestInput
-  context "CoreMIDI" do
-
-    setup do
-      sleep(1)
-    end
-
-    context "full IO" do
-
-      context "using Arrays" do
-
-        setup do
-          @messages = TestHelper::VariousMIDIMessages
-          @messages_arr = @messages.inject { |a,b| a+b }.flatten
-          @received_arr = []
-          @pointer = 0
-        end
-
-        should "do IO" do
-          TestHelper.device[:output].open do |output|
-            TestHelper.device[:input].open do |input|
-
-              input.buffer.clear
-
-              @messages.each do |msg|
-
-                $>.puts "sending: " + msg.inspect
-
-                output.puts(msg)
-                sleep(1)
-                received = input.gets.map { |m| m[:data] }.flatten
-
-                $>.puts "received: " + received.inspect
-
-                assert_equal(@messages_arr.slice(@pointer, received.length), received)
-                @pointer += received.length
-                @received_arr += received
-              end
-              assert_equal(@messages_arr.length, @received_arr.length)
-            end
-          end
-
-        end
-      end
-
-      context "using byte Strings" do
-
-        setup do
-          @messages = TestHelper::VariousMIDIByteStrMessages
-          @messages_str = @messages.join
-          @received_str = ""
-          @pointer = 0
-        end
-
-        should "do IO" do
-          TestHelper.device[:output].open do |output|
-            TestHelper.device[:input].open do |input|
-
-              @messages.each do |msg|
-
-                $>.puts "sending: " + msg.inspect
-
-                output.puts(msg)
-                sleep(1)
-                received = input.gets_bytestr.map { |m| m[:data] }.flatten.join
-                $>.puts "received: " + received.inspect
-
-                assert_equal(@messages_str.slice(@pointer, received.length), received)
-                @pointer += received.length
-                @received_str += received
-              end
-              assert_equal(@messages_str, @received_str)
-
-            end
-          end
-
-
-        end
-
-      end
-
-    end
-
-  end
-
-end