fast_osc 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3615d5a4fa5494a0ad2cfafe7c7bb143d5a277a4
-  data.tar.gz: 38ebafa5000ef23eacf2dfefd99808958483f3ba
+  metadata.gz: e4e7bff342d4a5632e0cf9f70c6d4370469a2a28
+  data.tar.gz: 471466562ba2ac1a9b7b98ccb3812e543dd97b77
 SHA512:
-  metadata.gz: 83a69f85ba11e17f26731b7eec9e439686a44ec757ab631841916de3044fbadea7ca03299588ff4d7f59b4f8f0eb7afe499e55d1b5f5164365b2da7385c76cf7
-  data.tar.gz: 2a00b2f5615da6bdd7c7e5eb69fb06a3e3b44014a78e29c539969789a29a143a040b9f19f2b39976306fd8b6171b81b0f2019faa9311a7b0cde978a5e67a3231
+  metadata.gz: 609e4d29594e0c230a0d8223e49612a292f0eac2e12f36a282af24fe5c149aaef2f0feafb8f40f931296cb9b419ea6e4ccbc30c6e6834355f5b8e4454daca408
+  data.tar.gz: 8e2508cb94292d344eab85becedff76948ce879240210eb0ddae5462fb2d18a0bc71e8e71ac8af7c5567429cd2172a1f9eba7578430ba843bdb6019c67c5c69e

data/README.md

@@ -4,6 +4,8 @@
 
 A Ruby wrapper around [rtosc](https://github.com/fundamental/rtosc/) to encode and decode OSC messages.
 
+This also includes a fallback implementation in pure Ruby in the case that the compiled version doesn't load properly. This can be forced by setting an environment variable of `FAST_OSC_USE_FALLBACK=1` where needed.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -31,34 +33,30 @@ Key:
 ### Encoding Benchmark
 
 ```
-["/feeooblah", ["beans", 1, 2.0]]
+Warming up --------------------------------------
+            fast_osc    64.995k i/100ms
+             samsosc    23.371k i/100ms
+            osc-ruby     7.691k i/100ms
 Calculating -------------------------------------
-            fast_osc    54.101k i/100ms
-                 osc     7.688k i/100ms
-             samsosc    21.406k i/100ms
--------------------------------------------------
-            fast_osc    909.680k (±21.4%) i/s -      4.328M
-                 osc     94.678k (±14.5%) i/s -    468.968k
-             samsosc    271.908k (±19.3%) i/s -      1.327M
+            fast_osc    797.673k (±15.0%) i/s -      3.900M in   5.043770s
+             samsosc    258.331k (±12.8%) i/s -      1.285M in   5.063755s
+            osc-ruby     83.203k (±12.6%) i/s -    415.314k in   5.073578s
 ```
 
 ## Decoding Bencmark
 
 ```
-["/feeooblah", ["beans", 1, 2.0]]
+Warming up --------------------------------------
+            fast_osc   102.344k i/100ms
+             samsosc    20.770k i/100ms
+            osc-ruby     3.145k i/100ms
 Calculating -------------------------------------
-            fast_osc    91.434k i/100ms
-             samsosc    22.095k i/100ms
-             oscruby     3.522k i/100ms
--------------------------------------------------
-            fast_osc      2.635M (±22.2%) i/s -     12.435M
-             samsosc    264.614k (±16.1%) i/s -      1.304M
-             oscruby     36.362k (±16.3%) i/s -    179.622k
+            fast_osc      1.650M (±14.5%) i/s -      8.085M in   5.017162s
+             samsosc    234.951k (±14.0%) i/s -      1.163M in   5.049167s
+            osc-ruby     34.266k (±13.3%) i/s -    169.830k in   5.048509s
 ```
 
-Benchmark adapted from https://github.com/samaaron/sonic-pi/blob/master/app/server/sonicpi/test/performance/test_osc_perf.rb
-
-I'll include a better test in the repo in time.
+Benchmarks are now part of this repo - run `rake test` to see the results for yourself.
 
 ## Usage
 
@@ -83,11 +81,12 @@ $ rake clean && rake clobber && rake compile && rake test
 
 ## Still todo
 
-* Implement more types
-* Bring benchmarks into the repo
-* Implement multi message/nested bundles
-* Documentation
-* Travis
+-[x] Implement more types
+-[x] Bring benchmarks into the repo
+-[ ] Work out cross compilation story for easier packaging
+-[ ] Implement multi message/nested bundles
+-[ ] Documentation
+-[ ] Travis
 
 ## Development notes
 

data/Rakefile

@@ -12,5 +12,7 @@ task :default => :spec
 require 'rake/extensiontask'
 spec = Gem::Specification.load('fast_osc.gemspec')
 Rake::ExtensionTask.new('fast_osc') do |ext|
+  # ext.platform or ext.cross_config_options
+  # might work to enable universal builds on darwin for older processors
   ext.lib_dir = "lib/fast_osc"
 end

data/ext/fast_osc/fast_osc_wrapper.c

@@ -171,7 +171,6 @@ VALUE method_fast_osc_encode_single_message(int argc, VALUE* argv, VALUE self) {
 
   int no_of_args = NUM2INT(LONG2NUM(RARRAY_LEN(args)));
   int i;
-  int max_buffer_size = 0;
   VALUE current_arg, strval;
 
   //output tags and args list
@@ -183,9 +182,6 @@ VALUE method_fast_osc_encode_single_message(int argc, VALUE* argv, VALUE self) {
 
     switch(TYPE(current_arg)) {
       case T_FIXNUM:
-        // max bytes for a single numeric representation
-        max_buffer_size += 8;
-
         if(FIX2LONG(current_arg) < ~(1 << 31)) {
           rb_str_concat(tagstring, rb_str_new2("i"));
           output_args[i].i = FIX2INT(current_arg);
@@ -195,23 +191,16 @@ VALUE method_fast_osc_encode_single_message(int argc, VALUE* argv, VALUE self) {
         }
         break;
       case T_FLOAT:
-        // now align to 4 byte boundary for sizing output buffer
-        max_buffer_size += 8;
-
         rb_str_concat(tagstring, rb_str_new2("f"));
         output_args[i].f = NUM2DBL(current_arg);
         break;
       case T_STRING:
-        // now align to 4 byte boundary for sizing output buffer
-        max_buffer_size += buffer_size_for_ruby_string(current_arg);
-
         rb_str_concat(tagstring, rb_str_new2("s"));
         output_args[i].s = StringValueCStr(current_arg);
         break;
       case T_SYMBOL:
         // now align to 4 byte boundary for sizing output buffer
         strval = rb_sym_to_s(current_arg);
-        max_buffer_size += buffer_size_for_ruby_string(strval);
 
         // encode as a string because not all implementation understand S as
         // alternative string tag
@@ -221,8 +210,6 @@ VALUE method_fast_osc_encode_single_message(int argc, VALUE* argv, VALUE self) {
       case T_DATA:
         if (CLASS_OF(current_arg) == rb_cTime) {
           // at present I only care about the Time as an object arg
-          max_buffer_size += 8;
-
           rb_str_concat(tagstring, rb_str_new2("t"));
           output_args[i].t = ruby_time_to_osc_timetag(current_arg);
         }
@@ -230,26 +217,20 @@ VALUE method_fast_osc_encode_single_message(int argc, VALUE* argv, VALUE self) {
     }
   }
 
-  //add space for the address and tag strings to the buffer
-  max_buffer_size += buffer_size_for_ruby_string(address);
-  max_buffer_size += buffer_size_for_ruby_string(tagstring);
-
-  // Get next largest power of two for buffer
-  max_buffer_size--;
-  max_buffer_size |= max_buffer_size >> 1;
-  max_buffer_size |= max_buffer_size >> 2;
-  max_buffer_size |= max_buffer_size >> 4;
-  max_buffer_size |= max_buffer_size >> 8;
-  max_buffer_size |= max_buffer_size >> 16;
-  max_buffer_size++;
-
-  char buffer[max_buffer_size];
-
   unsigned long int len;
+  // When buffer is NULL, the function returns the size of the buffer required to store the message
+  if(RSTRING_LEN(tagstring)) {
+    len = rtosc_amessage(NULL, 0, c_address, StringValueCStr(tagstring), output_args);
+  } else {
+    len = rtosc_message(NULL, 0, c_address, "");
+  }
+
+  // duplicate if/else due to compiler errors
+  char buffer[len];
   if(RSTRING_LEN(tagstring)) {
-    len = rtosc_amessage(buffer, sizeof(buffer), c_address, StringValueCStr(tagstring), output_args);
+    rtosc_amessage(buffer, len, c_address, StringValueCStr(tagstring), output_args);
   } else {
-    len = rtosc_message(buffer, sizeof(buffer), c_address, "");
+    rtosc_message(buffer, len, c_address, "");
   }
 
   VALUE output = rb_str_new(buffer, len);

data/fast_osc.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake-compiler"
   spec.add_development_dependency "minitest", "~> 5.0"
 	spec.add_development_dependency "osc-ruby", "~> 1.1.1"
+	spec.add_development_dependency "benchmark-ips", "~> 2.7.2"
 end

data/lib/fast_osc.rb

@@ -1,6 +1,19 @@
 require "fast_osc/version"
-require "fast_osc/fast_osc"
 
-module FastOsc
-  # Your code goes here...
+begin
+  require "fast_osc/fast_osc"
+
+  module FastOsc
+    # Your code goes here...
+  end
+rescue LoadError
+  warn "Failed to load the fast_osc c-extension, falling back to pure Ruby version"
+  require "fast_osc/pure_ruby_fallback_encode.rb"
+	require "fast_osc/pure_ruby_fallback_decode.rb"
+end
+
+if ENV['FAST_OSC_USE_FALLBACK'] == "true"
+  warn "Using pure Ruby fallback"
+  require "fast_osc/pure_ruby_fallback_encode.rb"
+  require "fast_osc/pure_ruby_fallback_decode.rb"
 end

data/lib/fast_osc/pure_ruby_fallback_decode.rb

@@ -0,0 +1,134 @@
+#--
+# This file was part of Sonic Pi: http://sonic-pi.net
+# Full project source: https://github.com/samaaron/sonic-pi
+# License: https://github.com/samaaron/sonic-pi/blob/master/LICENSE.md
+#
+# Copyright 2013, 2014, 2015, 2016 by Sam Aaron (http://sam.aaron.name).
+# All rights reserved.
+#
+# Permission is granted for use, copying, modification, and
+# distribution of modified versions of this work as long as this
+# notice is included.
+#++
+
+module SonicPi
+  module OSC
+    class OscDecode
+
+      def initialize(use_cache = false, cache_size=1000)
+        @float_cache = {}
+        @integer_cache = {}
+        @cache_size = cache_size
+
+        @num_cached_integers = 0
+        @num_cached_floats = 0
+        @string_terminator = "\x00".freeze
+        @args = []
+        @i_tag = "i".freeze
+        @f_tag = "f".freeze
+        @s_tag = "s".freeze
+        @d_tag = "d".freeze
+        @h_tag = "h".freeze
+        @b_tag = "b".freeze
+
+        @cap_n = 'N'.freeze
+        @cap_g = 'G'.freeze
+        @low_g = 'g'.freeze
+        @q_lt = 'q>'.freeze
+        @binary_encoding = "BINARY".freeze
+      end
+
+      def decode_single_message(m)
+        ## Note everything is inlined here for effienciency to remove the
+        ## cost of method dispatch. Apologies if this makes it harder to
+        ## read & understand. See http://opensoundcontrol.org for spec.
+
+        m.force_encoding(@binary_encoding)
+
+        args, idx = [], 0
+
+        # Get OSC address e.g. /foo
+        orig_idx = idx
+        idx = m.index(@string_terminator, orig_idx)
+        address, idx =  m[orig_idx...idx], idx + 1 + ((4 - ((idx + 1) % 4)) % 4)
+
+        sep, idx = m[idx], idx + 1
+
+        # Let's see if we have some args..
+        if sep == ?,
+
+          # Get type tags
+          orig_idx = idx
+          idx = m.index(@string_terminator, orig_idx)
+          tags, idx = m[orig_idx...idx], idx + 1 + ((4 - ((idx + 1) % 4)) % 4)
+
+          tags.each_char do |t|
+            case t
+            when @i_tag
+              # int32
+              raw = m[idx, 4]
+              arg, idx = @integer_cache[raw], idx + 4
+
+              unless arg
+                arg = raw.unpack(@cap_n)[0]
+                # Values placed inline for efficiency:
+                # 2**32 == 4294967296
+                # 2**31 - 1 == 2147483647
+                arg -= 4294967296 if arg > 2147483647
+                if @num_cached_integers < @cache_size
+                  @integer_cache[raw] = arg
+                  @num_cached_integers += 1
+                end
+              end
+            when @f_tag
+              # float32
+              raw = m[idx, 4]
+              arg, idx = @float_cache[raw], idx + 4
+              unless arg
+                arg = raw.unpack(@low_g)[0]
+                if @num_cached_floats < @cache_size
+                  @float_cache[raw] = arg
+                  @num_cached_floats += 1
+                end
+              end
+            when @s_tag
+              # string
+              orig_idx = idx
+              idx = m.index(@string_terminator, orig_idx)
+              arg, idx =  m[orig_idx...idx], idx + 1 + ((4 - ((idx + 1) % 4)) % 4)
+            when @d_tag
+              # double64
+              arg, idx = m[idx, 8].unpack(@cap_g)[0], idx + 8
+            when @h_tag
+              # int64
+              arg, idx = m[idx, 8].unpack(@q_lt)[0], idx + 8
+            when @b_tag
+              # binary blob
+              l = m[idx, 4].unpack(@cap_n)[0]
+              idx += 4
+              arg = m[idx, l]
+              idx += l
+              #Skip Padding
+              idx += ((4 - (idx % 4)) % 4)
+            else
+              raise "Unknown OSC type #{t}"
+            end
+
+            args << arg
+          end
+        end
+        return address, args
+      end
+
+    end
+  end
+end
+
+# Allow for loading above method in benmarks without clobbering c-ext
+if ENV['FAST_OSC_USE_FALLBACK'] == "true"
+module FastOsc
+  def decode_single_message(m)
+    SonicPi::OSC::OscEncode.new.decode_single_message(m)
+  end
+end
+end

data/lib/fast_osc/pure_ruby_fallback_encode.rb

@@ -0,0 +1,163 @@
+#--
+# This file was part of Sonic Pi: http://sonic-pi.net
+# Full project source: https://github.com/samaaron/sonic-pi
+# License: https://github.com/samaaron/sonic-pi/blob/master/LICENSE.md
+#
+# Copyright 2013, 2014, 2015, 2016 by Sam Aaron (http://sam.aaron.name).
+# All rights reserved.
+#
+# Permission is granted for use, copying, modification, and
+# distribution of modified versions of this work as long as this
+# notice is included.
+#++
+
+module SonicPi
+  module OSC
+    class OscEncode
+      # Apologies for the density of this code - I've inlined a lot of the
+      # code to reduce method dispatch overhead and to increase efficiency.
+      # See http://opensoundcontrol.org for spec.
+
+      def initialize(use_cache = false, cache_size=1000)
+        @literal_binary_str = "BINARY".freeze
+        @literal_cap_n = 'N'.freeze
+        @literal_cap_n2 = 'N2'.freeze
+        @literal_low_f = 'f'.freeze
+        @literal_low_i = 'i'.freeze
+        @literal_low_g = 'g'.freeze
+        @literal_low_s = 's'.freeze
+        @literal_empty_str = ''.freeze
+        @literal_str_encode_regexp = /\000.*\z/
+        @literal_str_pad = "\000".freeze
+        @literal_two_to_pow_2 = 2 ** 32
+        @literal_magic_time_offset = 2208988800
+
+        @use_cache = use_cache
+        @integer_cache = {}
+        @string_cache = {}
+        @float_cache = {}
+        @cache_size = cache_size
+
+        @num_cached_integers = 0
+        @num_cached_floats = 0
+        @num_cached_strings = 0
+
+        @bundle_header = get_from_or_add_to_string_cache("#bundle")
+      end
+
+      def encode_single_message(address, args=[])
+        args_encoded, tags = "", ","
+
+        # inlining this method was not faster surprisingly
+        address = get_from_or_add_to_string_cache(address)
+
+        args.each do |arg|
+          case arg
+          when Integer
+            tags << @literal_low_i
+
+            if @use_cache
+              if cached = @integer_cache[arg]
+                args_encoded << cached
+              else
+                res = [arg].pack(@literal_cap_n)
+                if @num_cached_integers < @cache_size
+                  @integer_cache[arg] = res
+                  @num_cached_integers += 1
+                  # log "caching integer #{arg}"
+                end
+                args_encoded << res
+              end
+            else
+              args_encoded << [arg].pack(@literal_cap_n)
+            end
+          when Float, Rational
+            arg = arg.to_f
+            tags << @literal_low_f
+
+            if @use_cache
+              if cached = @float_cache[arg]
+                args_encoded << cached
+              else
+                res = [arg].pack(@literal_low_g)
+                if @num_cached_floats < @cache_size
+                  @float_cache[arg] = res
+                  @num_cached_floats += 1
+                  # log "caching float #{arg}"
+                end
+                args_encoded << res
+              end
+            else
+              args_encoded << [arg].pack(@literal_low_g)
+            end
+          when String, Symbol
+            arg = arg.to_s
+            tags << @literal_low_s
+
+            args_encoded << get_from_or_add_to_string_cache(arg)
+          else
+            raise "Unknown arg type to encode: #{arg.inspect}"
+          end
+        end
+
+        tags_encoded = get_from_or_add_to_string_cache(tags)
+        # Address here needs to be a new string, not sure why
+        "#{address}#{tags_encoded}#{args_encoded}"
+      end
+
+      def encode_single_bundle(ts, address, args=[])
+        message = encode_single_message(address, args)
+        message_encoded = [message.size].pack(@literal_cap_n) << message
+        "#{@bundle_header}#{time_encoded(ts)}#{message_encoded}"
+      end
+
+      private
+      def get_from_or_add_to_string_cache(s)
+        if cached = @string_cache[s]
+          return cached
+        else
+          # This makes a null padded string rounded up to the nearest
+          # multiple of four
+          size = s.bytesize
+          res = [s].pack("Z#{size + 4 - (size % 4)}")
+          if @num_cached_strings < @cache_size
+            # only cache the first @cache_size strings to avoid a memory
+            # memory leak.
+            @string_cache[s] = res
+            @num_cached_strings += 1
+            # log "caching string #{s}"
+          end
+          return  res
+        end
+      end
+
+      def time_encoded(time)
+        t1, fr = (time.to_f + @literal_magic_time_offset).divmod(1)
+
+        t2 = (fr * @literal_two_to_pow_2).to_i
+        [t1, t2].pack(@literal_cap_n2)
+      end
+    end
+
+    class StreamOscEncode < OscEncode
+      def encode_single_message(address, args=[])
+        message = super
+        ([message.length].pack(@literal_cap_n) << message).force_encoding(@literal_binary_str)
+      end
+
+      def encode_single_bundle(ts, address, args=[])
+        message = super
+        message.count.pack(@literal_cap_n) << message
+      end
+    end
+  end
+end
+
+# Allow for loading above method in benmarks without clobbering c-ext
+if ENV['FAST_OSC_USE_FALLBACK'] == "true"
+module FastOsc
+  def encode_single_message(address, args=[])
+    SonicPi::OSC::OscEncode.new.encode_single_message(address, args)
+  end
+end
+end

data/lib/fast_osc/version.rb

@@ -1,3 +1,3 @@
 module FastOsc
-  VERSION = "0.0.11"
+  VERSION = "0.0.12"
 end

data/test/benchmark_test.rb

@@ -0,0 +1,51 @@
+#--
+# This file was part of Sonic Pi: http://sonic-pi.net
+# Full project source: https://github.com/samaaron/sonic-pi
+# License: https://github.com/samaaron/sonic-pi/blob/master/LICENSE.md
+#
+# Copyright 2013, 2014, 2015, 2016 by Sam Aaron (http://sam.aaron.name).
+# All rights reserved.
+#
+# Permission is granted for use, copying, modification, and
+# distribution of modified versions of this work as long as this
+# notice is included.
+#++
+
+
+# requires benchmark/ips gem to be installed
+
+require 'test_helper'
+require 'benchmark/ips'
+require 'osc-ruby'
+require 'fast_osc/pure_ruby_fallback_encode'
+require 'fast_osc/pure_ruby_fallback_decode'
+
+samosc = SonicPi::OSC::OscDecode.new(true)
+samoscenc = SonicPi::OSC::OscEncode.new(false)
+oscruby = OSC::OSCPacket
+
+address = "/feeooblah"
+args = ["beans", 1, 2.0]
+msg = OSC::Message.new(address, *args)
+test_message = msg.encode
+# puts test_message.inspect
+
+# puts [address, args].inspect
+puts "ENCODING TEST"
+Benchmark.ips do |bencher|
+  bencher.report("fast_osc") { FastOsc.encode_single_message(address, args) }
+  bencher.report("samsosc") { samoscenc.encode_single_message(address, args) }
+  bencher.report("osc-ruby") { msg.encode }
+
+  bencher.compare
+end
+
+# puts samosc.decode_single_message(test_message).inspect
+puts "DECODING TEST"
+Benchmark.ips do |bencher|
+  bencher.report("fast_osc") { FastOsc.decode_single_message(test_message) }
+  bencher.report("samsosc") { samosc.decode_single_message(test_message) }
+  bencher.report("osc-ruby") { oscruby.messages_from_network(test_message) }
+
+  bencher.compare
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_osc
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Xavier Riley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-24 00:00:00.000000000 Z
+date: 2017-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.2
 description: Serialize and deserialize Open Sound Control messages using rtosc
 email:
 - xavriley@hotmail.com
@@ -99,7 +113,10 @@ files:
 - ext/fast_osc/rtosc.h
 - fast_osc.gemspec
 - lib/fast_osc.rb
+- lib/fast_osc/pure_ruby_fallback_decode.rb
+- lib/fast_osc/pure_ruby_fallback_encode.rb
 - lib/fast_osc/version.rb
+- test/benchmark_test.rb
 - test/fast_osc_test.rb
 - test/test_helper.rb
 homepage: https://github.com/xavriley/fast_osc
@@ -123,10 +140,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: Serialize and deserialize Open Sound Control messages
 test_files:
+- test/benchmark_test.rb
 - test/fast_osc_test.rb
 - test/test_helper.rb