portmidi 0.0.1 → 0.0.5

data/.gitignore

@@ -1,2 +1,3 @@
 pkg/
-*.gemspec
+*.gemspec
+rdoc/

data/README.rdoc

@@ -0,0 +1,63 @@
+= Portmidi-Mapper
+
+This is a small, incomplete wrapper around the portmidi library.
+
+It is the successor of my portmidi-ruby project which used ordinary ruby extensions which are a pain to write.
+
+Author: Jan 'half/byte' Krutisch <jan@krutisch.de>
+
+Uses Portmidi, written by Roger B. Dannenberg.
+
+== Requirements
+
+
+* portmidi (who woulda thought) built as a dynamic library.
+* ffi (which in turn needs a sane build env)
+
+== What's missing?
+
+The most important: Tests. I'm still pondering on how to test a library that
+has hardware requirements and dependencies (= MIDI hardware). So I guess it
+means I will mock away the portmidi layer to test my abstractions and add some optional integration test that will require a MIDI loopback configuration.
+
+Implementation wise, there's a few things missing:
+
+* Setting Channel- and Message filters
+* Porttime support(not sure I can support that, I guess it needs multithreading, plus: I did not need it until now)
+examples/read_test.rb on how to decipher sysex atm.
+* More different exceptions, plus support for Host Errors
+* A lot of safety nets like testing for open devices before reading and writing and such.
+
+== What's coming
+
+* I'd love to see some explicit support for correctly parsing SysEx, see 
+
+
+== Installing Portmidi on OS X Snow leopard
+
+This is a major pita, because currently portmidi doesn't officially build for 64 bit, which 
+makes it impossible to use with the default Snow Leopard Ruby.
+
+You can try to enable 64 bit support, but I don't have a frekkin clue what this means. It works 
+for me and my application, but YMMV and I am not responsible for any damage this does
+to you or your system.
+
+To enable 64 bit compilation (you will see quite a few warnings while compiling), open
+CMakeLists.txt in the trunk folder and find the following line (around line 39 in my version)
+
+  set(CMAKE_OSX_ARCHITECTURES i386 ppc CACHE STRING "do not build for 64-bit" FORCE)
+
+and change it to: (yes, the comment is a bit silly)
+
+  set(CMAKE_OSX_ARCHITECTURES i386 ppc x86_64 CACHE STRING "do build for 64-bit" FORCE)
+
+Now you can call
+
+  make -f pm_mac/Makefile.osx
+
+if it builds, you can try to install the library. Currently the process seems to be a bit broken, 
+so you actually need to type:
+
+  sudo env PF=/usr make -f pm_mac/Makefile.osx install
+
+yes, this sucks - I'm currently trying to find out with the portmidi authors what it would take to fix all this.

data/Rakefile

@@ -1,4 +1,7 @@
+require 'rubygems'
+require 'rake'
 require File.join(File.dirname(__FILE__), "lib/portmidi/version")
+
 begin
   require 'jeweler'
   
@@ -16,4 +19,14 @@ begin
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = Portmidi::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Portmidi #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/examples/helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'portmidi'
+
+Portmidi.start

data/examples/read_test.rb

@@ -0,0 +1,47 @@
+require 'helper'
+Portmidi.input_devices.each do |dev|
+  puts "%d > %s" % [dev.device_id, dev.name]
+end
+puts "choose device id"
+device_id = gets()
+
+input =  Portmidi::Input.new(device_id.to_i)
+cnt = 0
+data = []
+running_sysex = []
+sysex_is_on = false
+loop do
+  begin
+    events = input.read(16)
+    if events
+      events.each do |event|
+        
+        
+        if event[:message][0] == 0xF0
+          running_sysex = event[:message]
+          sysex_is_on = true
+        elsif sysex_is_on
+          if event[:message][0] < 0x80
+            running_sysex += event[:message]
+            if event[:message].include?(0xF7)
+              data << running_sysex.flatten
+              puts running_sysex.inspect
+              sysex_is_on = false
+            end
+          else
+            puts event[:message].inspect
+            sysex_is_on = false
+            puts "cancelled sysex"
+          end
+        end
+      end
+      # data << events
+    else
+      # puts "poll" if cnt % 10000 == 0
+    end
+  rescue Portmidi::DeviceError => e
+    puts e.portmidi_error
+  end
+  cnt += 1
+  #sleep 0.002
+end

data/examples/write_sysex_test.rb

@@ -0,0 +1,11 @@
+require 'helper'
+sysex = [0xF0, 00, 12, 0x12, 0xF7]
+
+Portmidi.output_devices.each do |dev|
+  puts "%d > %s" % [dev.device_id, dev.name]
+end
+puts "choose device id"
+device_id = gets()
+
+output =  Portmidi::Output.new(device_id.to_i)
+output.write_sysex(sysex)

data/examples/write_test.rb

@@ -0,0 +1,14 @@
+require 'helper'
+messages = [
+  {:message => [0x90, 0x33, 0x7F], :timestamp => 0},
+  {:message => [0x90, 0x33, 0x00], :timestamp => 0}
+]
+
+Portmidi.output_devices.each do |dev|
+  puts "%d > %s" % [dev.device_id, dev.name]
+end
+puts "choose device id"
+device_id = gets()
+
+output =  Portmidi::Output.new(device_id.to_i)
+output.write(messages)

data/lib/portmidi.rb

@@ -7,13 +7,20 @@ require 'portmidi/exceptions'
 
 module Portmidi
   
-  def self.devices
-    devices = []
+  def self.devices(rescan = false)
+    @@devices = []
     PM_Map.Pm_CountDevices.times do |i|
       di = PM_Map::DeviceInfo.new(PM_Map.Pm_GetDeviceInfo(i))
-      devices << Device.new(i, di[:input], di[:output], di[:name])
+      @@devices << Device.new(i, di[:input], di[:output], di[:name])
     end
-    devices
+    @@devices
+  end
+  
+  def self.input_devices
+    self.devices.select{|device| device.type == :input }
+  end
+  def self.output_devices
+    self.devices.select{|device| device.type == :output }
   end
   
   # this is not a very good name, but Portmidi::initialize woulda been a worse idea

data/lib/portmidi/device.rb

@@ -8,7 +8,7 @@ module Portmidi
       @name = name
     end
     
-    def open(buffer_size = 4, latency = 0)
+    def open(buffer_size = nil, latency = nil)
       case(@type)
       when :input
         Input.new(@device_id, buffer_size)

data/lib/portmidi/exceptions.rb

@@ -1,7 +1,9 @@
 module Portmidi
   class DeviceError < StandardError
+    attr_reader :portmidi_error
     def initialize(errnum)
-      @full_message
+      @portmidi_error = PM_Map.Pm_GetErrorText(errnum)
     end
   end
+  
 end

data/lib/portmidi/input.rb

@@ -1,6 +1,7 @@
 module Portmidi
   class Input
-    def initialize(device_id = 0, buffer_size = 4)
+    def initialize(device_id, buffer_size = 512)
+      puts buffer_size
       in_stream_ptr = FFI::MemoryPointer.new(:pointer)
       if (errnum = PM_Map.Pm_OpenInput(in_stream_ptr, device_id, nil, buffer_size, nil, nil)) == 0
         @in_stream = in_stream_ptr.read_pointer
@@ -10,10 +11,38 @@ module Portmidi
     end
     
     def poll
-      
+      PM_Map.Pm_Poll(@in_stream) != 0
+    end
+    
+    def read(buffer_size = 1)
+      event_pointer = FFI::MemoryPointer.new(PM_Map::Event, buffer_size)
+      read = PM_Map::Pm_Read(@in_stream, event_pointer, buffer_size);
+      if read > 0
+        events = []
+        read.times do |i|
+          events << parseEvent(PM_Map::Event.new(event_pointer[i]))
+        end
+        return events
+      elsif read < 0
+        raise DeviceError, read, "read failed"
+      else
+        return nil
+      end
     end
     
     # TODO: poll methods etc.
+  private
+    def parseEvent(event)
+      {
+        :message => [
+          ((event[:message]) & 0xFF),
+          (((event[:message]) >> 8) & 0xFF),
+          (((event[:message]) >> 16) & 0xFF),
+          (((event[:message]) >> 24) & 0xFF)
+        ],
+        :timestamp => event[:timestamp]
+      }
+    end
     
   end
 end

data/lib/portmidi/output.rb

@@ -1,6 +1,10 @@
 module Portmidi
   class Output
-    def initialize(device_id = 0, buffer_size = 4, latency = 0)
+    
+    #
+    # open a device with the given ID
+    #
+    def initialize(device_id = 0, buffer_size = 0, latency = 0)
       out_stream_ptr = FFI::MemoryPointer.new(:pointer)
       if (errnum = PM_Map.Pm_OpenOutput(out_stream_ptr, device_id, nil, buffer_size, nil, nil, latency)) == 0
         @out_stream = out_stream_ptr.read_pointer
@@ -9,9 +13,42 @@ module Portmidi
       end
     end
     
+    #
+    # write a single three byte message
+    #
+    
     def write_short(status, data1, data2)
       PM_Map.Pm_WriteShort(@out_stream, 0, PM_Map.encode_message(status, data1, data2))
     end
     
+    def write(messages)
+      buffer = FFI::MemoryPointer.new(PM_Map::Event, messages.length)
+      messages.length.times do |i|
+        event = PM_Map::Event.new(buffer[i])
+        event[:timestamp] = messages[i][:timestamp]
+        event[:message] = packEvent(messages[i][:message])
+      end
+      PM_Map.Pm_Write(@out_stream, buffer, messages.length)
+    end
+    
+    
+
+    # 
+    # sends the sysex, the message should be an array of byte values
+    # 
+    def write_sysex(sysex)
+      raise "Invalid Sysex Format" if (sysex.first != 0xF0 || sysex.last != 0xF7)
+      msg = FFI::Buffer.alloc_in(:uchar, sysex.length)
+      sysex.each_with_index do |sysx, i|
+        msg.put_uchar(i, sysx & 0xFF)
+      end
+      PM_Map.Pm_WriteSysEx(@out_stream, 0, msg)
+    end
+    
+  private
+    def packEvent(message)
+      ((((message[3] || 0) << 24) & 0xFF000000) | (((message[2] || 0) << 16) & 0xFF0000) | (((message[1] || 0) << 8) & 0xFF00) | ((message[0]) & 0xFF))
+    end
+    
   end
 end

data/lib/portmidi/pm_map.rb

@@ -13,7 +13,10 @@ module Portmidi
     attach_function :Pm_Poll, [:pointer], :int
     attach_function :Pm_Read, [:pointer, :pointer, :int], :int
     attach_function :Pm_WriteShort, [:pointer, :int32, :int32], :int
-    attach_function :Pm_GetErrorText, [:int], :pointer
+    attach_function :Pm_Write, [:pointer, :pointer, :int32], :int
+    attach_function :Pm_WriteSysEx, [:pointer, :int32, :buffer_in], :int
+
+    attach_function :Pm_GetErrorText, [:int], :string
   
     #attach_function :Pt_Start, [:int, :pointer, :pointer], :int
   
@@ -28,7 +31,7 @@ module Portmidi
   
     class Event < FFI::Struct
       layout :message, :int32,
-             :timestamp, :int32           
+             :timestamp, :int32
     end
   
     def self.encode_message(status, data1, data2)

data/lib/portmidi/version.rb

@@ -1,3 +1,3 @@
 module Portmidi
-  VERSION = "0.0.1"
+  VERSION = "0.0.5"
 end

data/license.txt

@@ -0,0 +1,40 @@
+/*
+ * PortMidi Portable Real-Time MIDI Library
+ *
+ * license.txt -- a copy of the PortMidi copyright notice and license information
+ *
+ * Latest version available at: http://sourceforge.net/projects/portmedia
+ *
+ * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
+ * Copyright (c) 2001-2009 Roger B. Dannenberg
+ *
+ * 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.
+ */
+
+/*
+ * The text above constitutes the entire PortMidi license; however, 
+ * the PortMusic community also makes the following non-binding requests:
+ *
+ * Any person wishing to distribute modifications to the Software is
+ * requested to send the modifications to the original developer so that
+ * they can be incorporated into the canonical version. It is also
+ * requested that these non-binding requests be included along with the 
+ * license above.
+ */

data/test/helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'portmidi'
+
+class Test::Unit::TestCase
+  def stub_portmidi
+    Portmidi::PM_Map.stubs(:CountDevices).returns(2)
+    Portmidi::PM_Map.stubs(:Pm_Initialize).returns(false);
+    Portmidi::PM_map.stubs(:Pm_GetDeviceInfo).returns({:input => 1, :output => 0, :name => 'TestDevice'})
+    Portmidi::PM_map.stubs(:Pm_OpenInput).returns(1)
+    Portmidi::PM_map.stubs(:Pm_OpenOutput).returns(2)
+    Portmidi::PM_map.stubs(:Pm_Poll).returns(1)
+    Portmidi::PM_map.stubs(:Pm_Poll).returns(1)
+    Portmidi::PM_map.stubs(:Pm_Read).returns(1)
+    Portmidi::PM_Map.stubs(:Pm_WriteShort).returns(1)
+    Portmidi::PM_Map.stubs(:Pm_GetErrorText).returns(1)
+  end
+end

data/test/test_portmidi.rb

@@ -0,0 +1,8 @@
+require 'helper'
+class TestPortmidi < Test::Unit::TestCase
+  
+  
+  def test_buffering
+    flunk
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: portmidi
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.5
 platform: ruby
 authors: 
 - Jan Krutisch
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-07 00:00:00 +01:00
+date: 2009-11-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -29,11 +29,15 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.markdown
+- README.rdoc
 files: 
 - .gitignore
-- README.markdown
+- README.rdoc
 - Rakefile
+- examples/helper.rb
+- examples/read_test.rb
+- examples/write_sysex_test.rb
+- examples/write_test.rb
 - lib/portmidi.rb
 - lib/portmidi/device.rb
 - lib/portmidi/exceptions.rb
@@ -41,6 +45,9 @@ files:
 - lib/portmidi/output.rb
 - lib/portmidi/pm_map.rb
 - lib/portmidi/version.rb
+- license.txt
+- test/helper.rb
+- test/test_portmidi.rb
 has_rdoc: true
 homepage: http://github.com/halfbyte/portmidi
 licenses: []
@@ -69,5 +76,10 @@ rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: An ffi wrapper around the cross platform midi library portmidi
-test_files: []
-
+test_files: 
+- test/helper.rb
+- test/test_portmidi.rb
+- examples/helper.rb
+- examples/read_test.rb
+- examples/write_sysex_test.rb
+- examples/write_test.rb

data/README.markdown

@@ -1,41 +0,0 @@
-Portmidi-Mapper
-===============
-
-This is a small, incomplete wrapper around the portmidi library.
-
-Requirements
-============
-
-portmidi (who woulda thought) built as a dynamic library.
-ffi gem.
-
-
-Installing Portmidi on OS X Snow leopard
-========================================
-
-This is a major pita, because currently portmidi doesn't officially build for 64 bit, which 
-makes it impossible to use with the default Snow Leopard Ruby.
-
-You can try to enable 64 bit support, but I don't have a frekkin clue what this means. It works 
-for me and my application, but YMMV and I am not responsible for any damage this does
-to you or your system.
-
-To enable 64 bit compilation (you will see quite a few warnings while compiling), open
-CMakeLists.txt in the trunk folder and find the following line (around line 39 in my version)
-
-set(CMAKE_OSX_ARCHITECTURES i386 ppc CACHE STRING "do not build for 64-bit" FORCE)
-
-and change it to: (yes, the comment is a bit silly)
-
-set(CMAKE_OSX_ARCHITECTURES i386 ppc x86_64 CACHE STRING "do build for 64-bit" FORCE)
-
-Now you can call
-
-make -f pm_mac/Makefile.osx
-
-if it builds, you can try to install the library. Currently the process seems to be a bit broken, 
-so you actually need to type:
-
-sudo env PF=/usr make -f pm_mac/Makefile.osx install
-
-yes, this sucks - I'm currently trying to find out with the portmidi authors what it would take to fix all this.