rtmidi 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7296f8034f41a26f21bbe45d3dfcc31c66a4b62
-  data.tar.gz: 53af0cdf65ae9250f0aa2da07d379b61d1f154f6
+  metadata.gz: 951dc43b29adbc7d76f79f191f1e4a9ad6c034fd
+  data.tar.gz: 4733255fee9f6e321cc690594afafa8fa9e520af
 SHA512:
-  metadata.gz: 63f9593bc6a9f405d923607fd2fa82405f8fdaf217ed808386b46f864b1442083874632bc048a8ec36bcbe75906be14dc9e1c30856cc412458abdff40ae7ba6d
-  data.tar.gz: 5c64d24a84430a1296bdb28a88510cfdf302bc20f639c014200f2b417500e007f3259b9cb51b162f39d0c8ef2dcdb6a12f41b31268ab3361774fb3effe9f82ef
+  metadata.gz: 9777c38f05c57c90f63c731279cb0c3d4ca3064049758d4c28c21bcd8a458900a0d51c33fff557d449bd4d7fdbfadcd6d1ecd7b4aa324f98ece78af57dc3849b
+  data.tar.gz: 897d148e298d4b9d76ebf953234bfe35bc5e3c76457f4395e8728cf519dacc77400a8d56375b68afbb30499b07e3c0b5587ddb45a525e1c699d74e4a9059e17d

data/README.md

@@ -4,7 +4,6 @@ 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.
 
-<br>
 Features:
 
 * List MIDI I/O ports
@@ -15,32 +14,39 @@ In other words, it can handle [channel messages](http://www.cs.cf.ac.uk/Dave/Mul
 (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.
 
-<br>
 Supported Platforms:
 
 * OS X
-* Windows with [MinGW](http://www.mingw.org/)
-* Linux? It compiles on Linux with [JACK](http://jackaudio.org/) but is otherwise untested.
+* Windows
+* Linux with [JACK](http://jackaudio.org/) or [ALSA](http://www.alsa-project.org)
 
-<br>
 
 Requirements
 ============
 
-To install, you need `gcc` and `g++` on your PATH. Here's the recommended approach for your system:
+To install, you need `gcc` and `g++` on your PATH.
+
+On Windows, you can use Visual Studio's `cl.exe` compiler instead.
+
+Here's the recommended approach for your system:
 
 OS X Setup
 ----------
 
 * Install XCode via the Apple AppStore.
-* Open Preferences and install the "Command Line Tools" from the Downloads tab.
+* Open XCode's Preferences and install "Command Line Tools" in the Downloads tab.
 
 See [this stackoverflow discussion](http://stackoverflow.com/questions/9329243/xcode-4-4-command-line-tools) for help.
 
 Windows Setup
 -------------
 
-* [Install MinGW](http://sourceforge.net/projects/mingw/files/)  (see "Looking for the latest version?" link)
+### with [Visual Studio](http://www.microsoft.com/visualstudio) (cl.exe)
+* Install [Visual Studio](http://www.microsoft.com/visualstudio) (Tested with Visual C++ 2010 Express. Any recent version with a C++ compiler should work.)
+* Use the "Visual Studio Command Prompt" to install
+
+### with [MinGW](http://www.mingw.org/) (gcc/g++)
+* [Install MinGW](http://sourceforge.net/projects/mingw/files/latest/download)
 * During installation, on the "Select Components" screen, install the following:
   * C Compiler
   * C++ Compiler
@@ -55,7 +61,6 @@ Linux Setup (Ubuntu)
     sudo apt-get install jackd
     sudo apt-get install libjack-dev
 
-<br>
 
 Installation
 ============
@@ -64,7 +69,6 @@ Assuming you have Ruby installed, and are ready to compile C++ code with `gcc`,
 
     gem install rtmidi
 
-<br>
 
 Usage
 =====
@@ -75,8 +79,15 @@ See the following examples:
 * [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)
 
-<br>
 
 Documentation
 =============
-[http://rdoc.info/github/adamjmurray/ruby-rtmidi/frames](http://rdoc.info/github/adamjmurray/ruby-rtmidi/frames)
+[http://rdoc.info/github/adamjmurray/ruby-rtmidi/frames](http://rdoc.info/github/adamjmurray/ruby-rtmidi/frames)
+
+
+Changelog
+=========
+
+* 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/ext/Rakefile

@@ -25,15 +25,26 @@ def run(cmd)
 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 ["-D__MACOSX_CORE__", "-framework CoreMIDI -framework CoreAudio -framework CoreFoundation"]
-  when WINDOWS then ["-D__WINDOWS_MM__", "-lwinmm"]
+  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 << "-D#{macro} "
+      defines << "#{macro} "
       libs << `pkg-config --libs #{pkg}`.chomp
     end
     if defines.empty?
@@ -43,22 +54,44 @@ PREDEFINE, SYSTEM_LIBS = *case
   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'
 task :default => :make
 
-desc 'build the RtMidi C++ code'
+desc 'build the RtMidi C++ library with Ruby FFI wrapper'
 task :make do
-  require "mkmf"
-  abort "missing gcc" unless find_executable "gcc"
-  abort "missing g++" unless find_executable "g++"
-
-  cd RTMIDI_DIR
-  run "g++ -O3 -Wall -Iinclude -fPIC #{PREDEFINE} -c RtMidi.cpp -o RtMidi.o"
+  compile_rtmidi
   puts
-
-  cd EXT_DIR
-  run "g++ -g -Wall -I#{RTMIDI_DIR} -fPIC -c ruby-rtmidi.cpp"
+  compile_ruby_rtmidi_wrapper
   puts
-  run "g++ -g -Wall -I#{RTMIDI_DIR} -I#{RTMIDI_DIR}/include #{PREDEFINE} -fPIC -shared -o ruby-rtmidi.so " +
-        "ruby-rtmidi.o #{RTMIDI_DIR}/RtMidi.o #{SYSTEM_LIBS}"
+  create_shared_library
 end

data/ext/ruby-rtmidi.cpp

@@ -1,6 +1,7 @@
 #include "RtMidi.h"
 #include "RtError.h"
 #include <vector>
+#include <cstring>
 #include <iostream> // TODO: can probably stop including this later when done debugging
 
 #include "ruby-rtmidi.h"
@@ -23,8 +24,13 @@ int midiin_port_count(rtmidi_ptr p) {
 }
 
 const char* midiin_port_name(rtmidi_ptr p, int port_index) {
-  RtMidiIn *midiin = static_cast<RtMidiIn *>(p);  
-  return midiin->getPortName(port_index).c_str(); // getPortName returns a std::string, use c_str() to be convert to char*
+  RtMidiIn *midiin = static_cast<RtMidiIn *>(p);
+  std::string name = midiin->getPortName(port_index);
+  // std::string will be freed from memory at end of scope, so copy into a c string before returning.
+  // returning name directly caused noticeable problems when compiled with cl.exe
+  char* cstr = new char [name.length()+1];
+  std::strcpy(cstr, name.c_str());
+  return cstr;
 }
 
 void midiin_open_port(rtmidi_ptr p, int port_index) {
@@ -84,8 +90,13 @@ int midiout_port_count(rtmidi_ptr p) {
 }
 
 const char* midiout_port_name(rtmidi_ptr p, int port_index) {
-  RtMidiOut *midiout = static_cast<RtMidiOut *>(p);  
-  return midiout->getPortName(port_index).c_str(); // getPortName returns a std::string, use c_str() to be convert to char*
+  RtMidiOut *midiout = static_cast<RtMidiOut *>(p);
+  std::string name = midiout->getPortName(port_index);
+  // std::string will be freed from memory at end of scope, so copy into a c string before returning.
+  // returning name directly caused noticeable problems when compiled with cl.exe
+  char* cstr = new char [name.length()+1];
+  std::strcpy(cstr, name.c_str());
+  return cstr;
 }
 
 void midiout_open_port(rtmidi_ptr p, int port_index) {

data/ext/ruby-rtmidi.h

@@ -1,3 +1,9 @@
+#ifdef __RUBY_RTMIDI_DLL__
+  #define DLL_EXPORT __declspec( dllexport ) // export function definitions for Windows DLL compiled via cl.exe
+#else
+  #define DLL_EXPORT
+#endif
+
 extern "C"
 {
   typedef void* rtmidi_ptr;
@@ -6,39 +12,39 @@ extern "C"
   //================================================
   // INPUT
 
-  rtmidi_ptr midiin_new();
+  DLL_EXPORT rtmidi_ptr midiin_new();
 
-  void midiin_delete(rtmidi_ptr midiin);
+  DLL_EXPORT void midiin_delete(rtmidi_ptr midiin);
 
-  int midiin_port_count(rtmidi_ptr midiin);
+  DLL_EXPORT int midiin_port_count(rtmidi_ptr midiin);
 
-  const char* midiin_port_name(rtmidi_ptr midiin, int port_index);
+  DLL_EXPORT const char* midiin_port_name(rtmidi_ptr midiin, int port_index);
 
-  void midiin_open_port(rtmidi_ptr p, int port_index);
+  DLL_EXPORT void midiin_open_port(rtmidi_ptr p, int port_index);
 
-  void midiin_close_port(rtmidi_ptr p);
+  DLL_EXPORT void midiin_close_port(rtmidi_ptr p);
 
-  void midiin_ignore_types(rtmidi_ptr p, bool sysex, bool timing, bool active_sensing);
+  DLL_EXPORT void midiin_ignore_types(rtmidi_ptr p, bool sysex, bool timing, bool active_sensing);
 
-  void midiin_set_callback(rtmidi_ptr p, rtmidi_callback callback);
+  DLL_EXPORT void midiin_set_callback(rtmidi_ptr p, rtmidi_callback callback);
 
-  void midiin_cancel_callback(rtmidi_ptr p);
+  DLL_EXPORT void midiin_cancel_callback(rtmidi_ptr p);
   
 
   //================================================
   // OUTPUT
 
-  rtmidi_ptr midiout_new();
+  DLL_EXPORT rtmidi_ptr midiout_new();
 
-  void midiout_delete(rtmidi_ptr midiout);
+  DLL_EXPORT void midiout_delete(rtmidi_ptr midiout);
 
-  int midiout_port_count(rtmidi_ptr midiout);
+  DLL_EXPORT int midiout_port_count(rtmidi_ptr midiout);
 
-  const char* midiout_port_name(rtmidi_ptr midiout, int port_index);
+  DLL_EXPORT const char* midiout_port_name(rtmidi_ptr midiout, int port_index);
 
-  void midiout_open_port(rtmidi_ptr p, int port_index);
+  DLL_EXPORT void midiout_open_port(rtmidi_ptr p, int port_index);
 
-  void midiout_close_port(rtmidi_ptr p);
+  DLL_EXPORT void midiout_close_port(rtmidi_ptr p);
 
-  void midiout_send_message(rtmidi_ptr p, int byte1, int byte2, int byte3);
+  DLL_EXPORT void midiout_send_message(rtmidi_ptr p, int byte1, int byte2, int byte3);
 };

data/lib/rtmidi/in.rb

@@ -28,7 +28,7 @@ module RtMidi
     # @see #port_name
     # @see #open_port
     def port_names
-      @port_namess ||= (
+      @port_names ||= (
         names = []
         port_count.times{|i| names << Interface::midiin_port_name(@midiin, i) }
         names

data/lib/rtmidi/interface.rb

@@ -5,7 +5,10 @@ module RtMidi
   # @see RtMidi::Out
   module Interface
     extend FFI::Library
-    ffi_lib File.expand_path("../../ext/ruby-rtmidi.so", File.dirname(__FILE__))
+    ffi_lib [
+      File.expand_path("../../ext/ruby-rtmidi.so", File.dirname(__FILE__)),
+      File.expand_path("../../ext/ruby-rtmidi.dll", File.dirname(__FILE__))
+    ]
   
     #####################################
     # INPUT

data/lib/rtmidi/out.rb

@@ -28,7 +28,7 @@ module RtMidi
     # @see #port_name
     # @see #open_port
     def port_names
-      @port_namess ||= (
+      @port_names ||= (
         names = []
         port_count.times{|i| names << Interface::midiout_port_name(@midiout, i) }
         names

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rtmidi
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Adam Murray