rtmidi 0.2.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 951dc43b29adbc7d76f79f191f1e4a9ad6c034fd
-  data.tar.gz: 4733255fee9f6e321cc690594afafa8fa9e520af
+  metadata.gz: 3c430949e32e04bb62083aae6879c0b20dad223e
+  data.tar.gz: 81ab70ee2a3fe78349ed6de2542fea7e42ca3bfc
 SHA512:
-  metadata.gz: 9777c38f05c57c90f63c731279cb0c3d4ca3064049758d4c28c21bcd8a458900a0d51c33fff557d449bd4d7fdbfadcd6d1ecd7b4aa324f98ece78af57dc3849b
-  data.tar.gz: 897d148e298d4b9d76ebf953234bfe35bc5e3c76457f4395e8728cf519dacc77400a8d56375b68afbb30499b07e3c0b5587ddb45a525e1c699d74e4a9059e17d
+  metadata.gz: 55647eec74cde698b047ad3abea4b3b2c88d8b3f42ca318e05106bd4ceaab9191da0194873b8c16675bc78e6bc0a4f77dd6a19207204261d39f1259e1bb9b690
+  data.tar.gz: 7953645285988a046841e8bf4a75e403d1919b3c95640bbdfaa59db64b7934fc21cacba08bff03e24380569a54e367c5daab7ce346df0d870462c406574f6c4f

data/README.md

@@ -1,24 +1,25 @@
 Ruby-RtMidi
 ===========
 
+[![Build Status](https://travis-ci.org/adamjmurray/ruby-rtmidi.png)](http://travis-ci.org/adamjmurray/ruby-rtmidi)
+
 [Ruby](http://www.ruby-lang.org/) wrapper for [RtMidi](http://www.music.mcgill.ca/~gary/rtmidi/index.html),
 a cross-platform C++ library for realtime MIDI input and output.
 
 Features:
 
 * List MIDI I/O ports
-* Send 3-byte MIDI messages to output ports
-* Listen for 3-byte messages on input ports
+* Send MIDI messages to output ports
+* Receive messages on input ports
 
-In other words, it can handle [channel messages](http://www.cs.cf.ac.uk/Dave/Multimedia/node158.html)
-(notes, control change, pitch bend, pressure, program),
-but there is no support for [SySex](https://en.wikipedia.org/wiki/SysEx#System_Exclusive_messages) messages yet.
+In other words, everything you'd want from a low-level MIDI library.
+It's still your responsibility to interpret the MIDI message byte streams!
 
 Supported Platforms:
 
 * OS X
 * Windows
-* Linux with [JACK](http://jackaudio.org/) or [ALSA](http://www.alsa-project.org)
+* Linux
 
 
 Requirements
@@ -54,8 +55,14 @@ Windows Setup
   * MinGW Developer ToolKit
 * Use the the MinGW Shell (MSYS) to install
 
-Linux Setup (Ubuntu)
---------------------
+Note: when installing under MinGW, this library may not work outside of MinGW. If that is a problem for you, use Visual Studio to install.
+
+Linux Setup
+-----------
+
+Install [JACK](http://jackaudio.org/) or [ALSA](http://www.alsa-project.org).
+
+This should work on Ubuntu:
 
     sudo apt-get install g++
     sudo apt-get install jackd
@@ -75,19 +82,39 @@ Usage
 
 See the following examples:
 
-* [List MIDI devices](http://rdoc.info/github/adamjmurray/ruby-rtmidi/file/examples/list_ports.rb)
-* [MIDI output](http://rdoc.info/github/adamjmurray/ruby-rtmidi/file/examples/play_notes.rb)
-* [MIDI input](http://rdoc.info/github/adamjmurray/ruby-rtmidi/file/examples/monitor_input.rb)
+* [list MIDI devices](http://rdoc.info/github/adamjmurray/ruby-rtmidi/file/examples/list_ports.rb)
+* [MIDI channel output](http://rdoc.info/github/adamjmurray/ruby-rtmidi/file/examples/send_channel_message.rb)
+* [MIDI channel input](http://rdoc.info/github/adamjmurray/ruby-rtmidi/file/examples/receive_channel_input.rb)
+* [arbitrary MIDI output](http://rdoc.info/github/adamjmurray/ruby-rtmidi/file/examples/send_any_message.rb)
+* [arbitrary MIDI input](http://rdoc.info/github/adamjmurray/ruby-rtmidi/file/examples/receive_any_input.rb)
+
+Use the arbitrary MIDI IO to handle channel messages, SysEx, timing, and/or active sensing messages.
+If you only need channel messages (notes, modulation/CC, pitch bend, aftertouch), it's recommended you
+follow the channel IO examples.
 
 
 Documentation
 =============
+
 [http://rdoc.info/github/adamjmurray/ruby-rtmidi/frames](http://rdoc.info/github/adamjmurray/ruby-rtmidi/frames)
 
 
+Contributing
+============
+
+Pull requests are welcome. The following must work:
+
+* `rake test` shows all unit tests are passing
+* Build and test the gem manually:
+    * `gem build rtmidi.gemspec`
+    * `gem install rtmidi-#{version}.gem`
+    * the examples can be run successfully against this version of the gem (`ruby examples/**`)
+
+
 Changelog
 =========
 
+* 0.3 - Support for arbitrary MIDI messages including SysEx
 * 0.2.2 - Compilable with Visual Studio on Windows
 * 0.2.1 - Linux support (thanks to [@quark-zju](https://github.com/quark-zju))
 * 0.2 - First stable release

data/Rakefile

@@ -1,10 +1,27 @@
-load File.expand_path('ext/Rakefile', File.dirname(__FILE__))
+require 'rake/clean'
+
+CLEAN.include %w[ **/*.o  **/*.lib  **/*.obj  **/*.log ]
+CLOBBER.include %w[ **/*.so  **/*.dll ]
+
 
-desc 'remove artifacts produced by make task'
-task :clean do
-  for file in Dir["#{RTMIDI_DIR}/*.o", "#{EXT_DIR}/*.o","#{EXT_DIR}/*.so"]
-    puts "Deleting #{file}"
-    File.unlink(file)
+require 'rspec/core/rake_task'
+
+desc "Run tests"
+RSpec::Core::RakeTask.new('test') do |spec|
+  spec.rspec_opts = ["--color", "--format", "nested"]
+  if ARGV[1]
+    # only run specs with filenames starting with the command line argument
+    spec.pattern = "spec/**/#{ARGV[1]}*"
   end
-  puts
 end
+
+task :spec => :test  # alias test task as spec task
+
+
+load File.expand_path('ext/Rakefile', File.dirname(__FILE__))
+
+
+desc 'Build the gem'
+task :gem do
+  system 'gem build rtmidi.gemspec'
+end

data/examples/list_ports.rb

@@ -4,12 +4,12 @@ puts
 
 midiin = RtMidi::In.new
 puts "Available MIDI input ports"
-midiin.port_names.each_with_index{|name,index| puts "  ##{index+1}: #{name}" }
+midiin.port_names.each_with_index{|name,index| puts "  #{index+1}: #{name}" }
 
 puts
 
 midiout = RtMidi::Out.new
 puts "Available MIDI output ports"
-midiout.port_names.each_with_index{|name,index| puts "  ##{index+1}: #{name}" }
+midiout.port_names.each_with_index{|name,index| puts "  #{index+1}: #{name}" }
 
 puts

data/examples/receive_any_message.rb

@@ -0,0 +1,35 @@
+require "rtmidi"
+
+midiin = RtMidi::In.new
+
+
+##############################################################################
+# Boilerplate code for selecting a MIDI port
+
+puts "Available MIDI input ports"
+midiin.port_names.each_with_index{|name,index| printf "%3i: %s\n", index, name }
+
+def select_port(midiio)
+  print "Select a port number: "
+  if (port = gets) =~ /^\d+$/
+    return port.to_i if (0...midiio.port_count).include? port.to_i
+  end
+  puts "Invalid port number"
+end
+
+port_index = select_port(midiin) until port_index
+
+##############################################################################
+# Use this approach when you need to receive any message including:
+# System Exclusive (SysEx), timing, active sensing
+
+midiin.receive_message do |*bytes|
+  puts bytes.inspect
+end
+
+puts "Receiving MIDI messages including SysEx..."
+puts "Ctrl+C to exit"
+
+midiin.open_port(port_index)
+
+sleep # prevent Ruby from exiting immediately

data/examples/receive_channel_message.rb

@@ -0,0 +1,35 @@
+require "rtmidi"
+
+midiin = RtMidi::In.new
+
+
+##############################################################################
+# Boilerplate code for selecting a MIDI port
+
+puts "Available MIDI input ports"
+midiin.port_names.each_with_index{|name,index| printf "%3i: %s\n", index, name }
+
+def select_port(midiio)
+  print "Select a port number: "
+  if (port = gets) =~ /^\d+$/
+    return port.to_i if (0...midiio.port_count).include? port.to_i
+  end
+  puts "Invalid port number"
+end
+
+port_index = select_port(midiin) until port_index
+
+##############################################################################
+# Use this approach when you only need to receive channel message like:
+# MIDI notes, modulation/CC, pitch bend, aftertouch
+
+midiin.receive_channel_message do |byte1, byte2, byte3|
+  puts "#{byte1} #{byte2} #{byte3}"
+end
+
+puts "Receiving MIDI channel messages..."
+puts "Ctrl+C to exit"
+
+midiin.open_port(port_index)
+
+sleep # prevent Ruby from exiting immediately

data/examples/send_any_message.rb

@@ -0,0 +1,31 @@
+require "rtmidi"
+
+midiout = RtMidi::Out.new
+
+
+##############################################################################
+# Boilerplate code for selecting a MIDI port
+
+puts "Available MIDI output ports"
+midiout.port_names.each_with_index{|name,index| printf "%3i: %s\n", index, name }
+
+def select_port(midiio)
+  print "Select a port number: "
+  if (port = gets) =~ /^\d+$/
+    return port.to_i if (0...midiio.port_count).include? port.to_i
+  end
+  puts "Invalid port number"
+end
+
+port_index = select_port(midiout) until port_index
+
+##############################################################################
+# Use this approach when you need to send any message including:
+# System Exclusive (SysEx), timing, active sensing
+
+midiout.open_port(port_index)
+
+# Now send some SysEx messages
+midiout.send_message(240, 67, 16, 0, 16, 34, 247)
+# or if you prefer a single array argument:
+midiout.send_message( [240, 67, 16, 0, 16, 35, 247] )

data/examples/send_channel_message.rb

@@ -0,0 +1,34 @@
+require "rtmidi"
+
+midiout = RtMidi::Out.new
+
+
+##############################################################################
+# Boilerplate code for selecting a MIDI port
+
+puts "Available MIDI output ports"
+midiout.port_names.each_with_index{|name,index| printf "%3i: %s\n", index, name }
+
+def select_port(midiio)
+  print "Select a port number: "
+  if (port = gets) =~ /^\d+$/
+    return port.to_i if (0...midiio.port_count).include? port.to_i
+  end
+  puts "Invalid port number"
+end
+
+port_index = select_port(midiout) until port_index
+
+##############################################################################
+# Use this approach when you only need to send channel message like:
+# MIDI notes, modulation/CC, pitch bend, aftertouch
+
+midiout.open_port(port_index)
+
+for pitch in [60, 62, 64, 65, 67]
+  midiout.send_channel_message(0x90, pitch, 127) # note on
+  sleep 0.5
+  midiout.send_channel_message(0x90, pitch, 0) # note off
+end
+
+sleep 0.5 # give the final note off time to release

data/ext/Rakefile

@@ -1,97 +1,11 @@
-require 'rake/clean'
-
-EXT_DIR = File.expand_path(File.dirname __FILE__)
-RTMIDI_DIR = "#{EXT_DIR}/rtmidi-2.0.1"
-
-HOST_OS = RbConfig::CONFIG['host_os'].downcase
-OS_X = (HOST_OS =~ /darwin/)
-WINDOWS = ((HOST_OS =~ /win/ and HOST_OS !~ /darwin/) or HOST_OS =~ /mingw/)
-LINUX = (HOST_OS =~ /linux/)
-
-CLEAN.include('**/*.o', '*.log')
-CLOBBER.include('*.so')
-
-def cd(dir)
-  puts "cd #{dir}"
-  Dir.chdir(dir)
-end
-
-def run(cmd)
-  puts cmd
-  unless system(cmd)
-    puts "Error: command exited with return value #{$?.exitstatus}"
-    exit $?.exitstatus
-  end
-end
-
-
-require "mkmf"
-COMPILER = if WINDOWS and find_executable "cl.exe"
-  :cl
-else
-  if find_executable "gcc" and find_executable "g++"
-    :gcc
-  else
-    abort "Cannot find gcc/g++ #{'or cl.exe ' if WINDOWS}compiler"
-  end
-end
-
-PREDEFINE, SYSTEM_LIBS = *case
-  when OS_X then ["__MACOSX_CORE__", "-framework CoreMIDI -framework CoreAudio -framework CoreFoundation"]
-  when WINDOWS then ["__WINDOWS_MM__", "-lwinmm"]
-  when LINUX then
-    defines, libs = '', ''
-    {:alsa => '__LINUX_ALSA__', :jack => '__UNIX_JACK__'}.select do |pkg, _|
-      system "pkg-config --exists #{pkg}"
-    end.each do |pkg, macro|
-      defines << "#{macro} "
-      libs << `pkg-config --libs #{pkg}`.chomp
-    end
-    if defines.empty?
-      raise 'Neither JACK or ALSA detected using pkg-config. Please install one of them first.'
-    end
-    [defines, libs]
-  else
-end
-
-
-def compile_rtmidi
-  cd RTMIDI_DIR
-  if COMPILER == :gcc
-    run "g++ -O3 -Wall -Iinclude -fPIC -D#{PREDEFINE} -o RtMidi.o -c RtMidi.cpp"
-  else
-    run "cl /O2 /Iinclude /D#{PREDEFINE} /EHsc /FoRtMidi.obj /c RtMidi.cpp"
-  end
-end
-
-def compile_ruby_rtmidi_wrapper
-  cd EXT_DIR
-  if COMPILER == :gcc
-    run "g++ -g -Wall -I#{RTMIDI_DIR} -fPIC -o ruby-rtmidi.o -c ruby-rtmidi.cpp"
-  else
-    run "cl /I#{RTMIDI_DIR} /D__RUBY_RTMIDI_DLL__ /EHsc /Foruby-rtmidi.obj /c ruby-rtmidi.cpp"
-  end
-end
-
-def create_shared_library
-  cd EXT_DIR
-  if COMPILER == :gcc
-    run "g++ -g -Wall -I#{RTMIDI_DIR} -I#{RTMIDI_DIR}/include -D#{PREDEFINE} -fPIC -shared -o ruby-rtmidi.so " +
-        "ruby-rtmidi.o #{RTMIDI_DIR}/RtMidi.o #{SYSTEM_LIBS}"
-  else
-    run "cl /I#{RTMIDI_DIR} /I#{RTMIDI_DIR}/include /D#{PREDEFINE} /LD ruby-rtmidi.obj #{RTMIDI_DIR}/RtMidi.obj winmm.lib"
-  end
-end
-
-
-desc 'run the make task'
+desc 'Run the make task'
 task :default => :make
 
-desc 'build the RtMidi C++ library with Ruby FFI wrapper'
+desc 'Compile the RtMidi C++ library with Ruby FFI wrapper'
 task :make do
-  compile_rtmidi
-  puts
-  compile_ruby_rtmidi_wrapper
-  puts
-  create_shared_library
+  require_relative '../lib/rtmidi/build/compiler'
+  ext_dir = File.expand_path(File.dirname __FILE__)
+  rtmidi_dir = "#{ext_dir}/rtmidi-2.0.1"
+  compiler = RtMidi::Build::Compiler.new(ext_dir, rtmidi_dir, verbose: true)
+  compiler.compile
 end

data/ext/ruby-rtmidi.cpp

@@ -67,6 +67,21 @@ void midiin_set_callback(rtmidi_ptr p, rtmidi_callback callback) {
   midiin->setCallback(midiin_callback_proxy, (void *)callback);
 }
 
+void midiin_varargs_callback_proxy( double deltatime, std::vector< unsigned char > *message, void *userData )
+{
+  unsigned int byte_count = message->size();
+  // for ( unsigned int i=0; i<byte_count; i++ )
+  //   std::cout << "Byte " << i << " = " << (int)message->at(i) << ", ";
+  // if ( byte_count > 0 )
+  //   std::cout << "stamp = " << deltatime << std::endl; # TODO: do we care about the deltatime?
+  ((rtmidi_varargs_callback)userData)(&(*message)[0], byte_count);
+}
+
+void midiin_set_varargs_callback(rtmidi_ptr p, rtmidi_varargs_callback callback) {
+  RtMidiIn *midiin = static_cast<RtMidiIn *>(p);
+  midiin->setCallback(midiin_varargs_callback_proxy, (void *)callback);
+}
+
 void midiin_cancel_callback(rtmidi_ptr p) {
   RtMidiIn *midiin = static_cast<RtMidiIn *>(p);
   midiin->cancelCallback();
@@ -117,3 +132,12 @@ void midiout_send_message(rtmidi_ptr p, int byte1, int byte2, int byte3) {
   message[2] = byte3;
   midiout->sendMessage(&message);
 }
+
+void midiout_send_bytes(rtmidi_ptr p, int* bytes, int byte_count) {
+  RtMidiOut *midiout = static_cast<RtMidiOut *>(p);
+  std::vector<unsigned char> message;
+  for(int i=0; i<byte_count; i++) {
+    message.push_back(bytes[i]);
+  }
+  midiout->sendMessage(&message);
+}

data/ext/ruby-rtmidi.h

@@ -8,6 +8,7 @@ extern "C"
 {
   typedef void* rtmidi_ptr;
   typedef void (*rtmidi_callback)(int byte1, int byte2, int byte3);
+  typedef void (*rtmidi_varargs_callback)(unsigned char* bytes, int byte_count);
 
   //================================================
   // INPUT
@@ -28,6 +29,8 @@ extern "C"
 
   DLL_EXPORT void midiin_set_callback(rtmidi_ptr p, rtmidi_callback callback);
 
+  DLL_EXPORT void midiin_set_varargs_callback(rtmidi_ptr p, rtmidi_varargs_callback callback);
+
   DLL_EXPORT void midiin_cancel_callback(rtmidi_ptr p);
   
 
@@ -47,4 +50,6 @@ extern "C"
   DLL_EXPORT void midiout_close_port(rtmidi_ptr p);
 
   DLL_EXPORT void midiout_send_message(rtmidi_ptr p, int byte1, int byte2, int byte3);
+
+  DLL_EXPORT void midiout_send_bytes(rtmidi_ptr p, int* bytes, int byte_count);
 };