fast_osc 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d28e104c919d500f56f8cc1ff18eaedfc3324c07127f72c5af5d4d662a453f55
-  data.tar.gz: fd255b333c9d2e482f08eab6dac3b7bab74fae4732e454b9d22b1f658a3f7dff
+  metadata.gz: b38399e4e904a64b2d068eaf3dc944ef458db7b6baed7af35217c791908150ce
+  data.tar.gz: ccf35824f5b5bb7d405710a1ae7101dd975365a7f0abc60a43471954ac46211e
 SHA512:
-  metadata.gz: bb5faf369b9b7859d9adda5f11811290c64f1014ffcb9cd2a9a81a5f9141d31b0c94e1055137bf3a730dc80499396624f06515e0c76f750e0fb68dc1fd08110b
-  data.tar.gz: 15333641c23c7095fe8453e4c78301f72e2e71a307304b8a756d760fcdc151a2f88d6c77322eb9bda9157bde31bd83a1899786963d1632b6642a314db0077ad1
+  metadata.gz: a3c596094fa578c98447d2dccec83a3d796cc19444343c704d2d837d76643c41bb344a8700014a95a1bea2b06e21d0caac6a3f87091baac8e7ec2aac4461825d
+  data.tar.gz: 2751ee485a1486d990250cfc93733cdfdbe8284486b1a651f6d174ab0731b501245e8027e61cec9dcdd8696c0c988fd62dd414538fa549b2b6498ce8905d38db

data/README.md

@@ -52,6 +52,13 @@ end
 
  A timestamp of `nil` is a special case meaning "immediately".
 
+### A note on types
+
+To represent the `blob` type tag from the OSC spec, FastOsc uses strings with
+the `ASCII-8BIT` encoding. UTF-8 strings remain as normal string tags.
+
+For examples of this, see the test suite.
+
 ## Is it fast?
 
 Let's see...
@@ -67,13 +74,14 @@ Key:
 ```
 $ WITH_BENCHMARKS=1 rake test
 Warming up --------------------------------------
-            fast_osc    64.995k i/100ms
-             samsosc    23.371k i/100ms
-            osc-ruby     7.691k i/100ms
+            fast_osc    94.043k i/100ms
+             samsosc    41.231k i/100ms
+            osc-ruby    17.476k i/100ms
 Calculating -------------------------------------
-            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
+            fast_osc      1.186M (± 3.7%) i/s -      5.925M in   5.004014s
+             samsosc    458.561k (± 4.1%) i/s -      2.309M in   5.043860s
+            osc-ruby    182.051k (± 4.6%) i/s -    908.752k in   5.003313s
+DECODING TEST
 ```
 
 ### Decoding Bencmark
@@ -81,27 +89,20 @@ Calculating -------------------------------------
 ```
 $ WITH_BENCHMARKS=1 rake test
 Warming up --------------------------------------
-            fast_osc   102.344k i/100ms
-             samsosc    20.770k i/100ms
-            osc-ruby     3.145k i/100ms
+            fast_osc   208.209k i/100ms
+             samsosc    38.760k i/100ms
+            osc-ruby     6.844k i/100ms
 Calculating -------------------------------------
-            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
+            fast_osc      3.679M (± 3.8%) i/s -     18.531M in   5.044888s
+             samsosc    430.488k (± 3.0%) i/s -      2.171M in   5.046837s
+            osc-ruby     70.998k (± 3.1%) i/s -    355.888k in   5.017493s
 ```
 
 Benchmarks are now part of this repo - run `WITH_BENCHMARKS=1 rake test` to see the results for yourself.
 
-## Running the test suite
-
-```
-$ gem install minitest # or bundle install
-$ rake clean && rake clobber && rake compile && rake test
-```
-
 ## Still todo
 
-- [ ] Make a pure ruby fallback available
+- [x] Make a pure ruby fallback available
 - [x] Implement more types
 - [x] Bring benchmarks into the repo
 - [ ] Work out cross compilation story for easier packaging
@@ -114,6 +115,13 @@ $ rake clean && rake clobber && rake compile && rake test
     bundle install
     rake compile
 
+### Running the test suite
+
+```
+$ gem install minitest # or bundle install
+$ rake clean && rake clobber && rake compile && rake test && FAST_OSC_USE_FALLBACK=true rake test
+```
+
 https://gist.github.com/xavriley/507eff0a75d4552fa56e
 
 ## Contributing

data/ext/fast_osc/fast_osc_wrapper.c

@@ -1,3 +1,4 @@
+#include <stdbool.h>
 #include <ruby.h>
 #include <ruby/encoding.h>
 #include <rtosc.h>
@@ -181,7 +182,11 @@ VALUE method_fast_osc_decode_single_message(VALUE self, VALUE msg) {
         rb_ary_push(args_output, string_arg);
         break;
       case 'b' :
-        rb_ary_push(args_output, rb_str_new((const char*)next_val.val.b.data, next_val.val.b.len));
+        string_arg = rb_str_new((const char*)next_val.val.b.data, next_val.val.b.len);
+        enc = rb_enc_find_index("ASCII-8BIT");
+        rb_enc_associate_index(string_arg, enc);
+
+        rb_ary_push(args_output, string_arg);
         break;
       case 'h' :
         // INT2NUM() for arbitrary sized integers
@@ -271,8 +276,21 @@ VALUE method_fast_osc_encode_single_message(int argc, VALUE* argv, VALUE self) {
         output_args[i].f = NUM2DBL(current_arg);
         break;
       case T_STRING:
-        rb_str_concat(tagstring, rb_str_new2("s"));
-        output_args[i].s = StringValueCStr(current_arg);
+        {
+        VALUE rb_string_encoding;
+        rb_string_encoding = rb_funcall(current_arg, rb_intern("encoding"), 0); // #=> Encoding:UTF-8 
+
+        // check for ASCII-8BIT after converting to symbol
+        // if present, set as blob arg, else string
+        // if(rb_string_encoding._dump.to_sym == :"ASCII-8BIT") { ... }
+        if(rb_funcall(rb_funcall(rb_string_encoding, rb_intern("_dump"), 0), rb_intern("=="), 1, rb_str_new2("ASCII-8BIT"))) {
+            rb_str_concat(tagstring, rb_str_new2("b"));
+            output_args[i].b = (rtosc_blob_t){RSTRING_LEN(current_arg), StringValuePtr(current_arg)};
+        } else {
+            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
@@ -285,11 +303,11 @@ VALUE method_fast_osc_encode_single_message(int argc, VALUE* argv, VALUE self) {
         break;
       case T_DATA:
         if (CLASS_OF(current_arg) == rb_cTime) {
-          // at present I only care about the Time as an object arg
+          // check for Time as an object arg
           rb_str_concat(tagstring, rb_str_new2("t"));
           output_args[i].t = ruby_time_to_osc_timetag(current_arg);
         }
-        break;
+	break;
     }
   }
 

data/lib/fast_osc/pure_ruby_fallback_decode.rb

@@ -23,6 +23,7 @@ module SonicPi
         @num_cached_integers = 0
         @num_cached_floats = 0
         @string_terminator = "\x00".freeze
+        @bundle_header = "#bundle\x00".freeze
         @args = []
         @i_tag = "i".freeze
         @f_tag = "f".freeze
@@ -36,6 +37,9 @@ module SonicPi
         @low_g = 'g'.freeze
         @q_lt = 'q>'.freeze
         @binary_encoding = "BINARY".freeze
+
+        @literal_magic_time_offset = 2208988800
+        @literal_cap_n = 'N'.freeze
       end
 
       def decode_single_message(m)
@@ -96,6 +100,7 @@ module SonicPi
               orig_idx = idx
               idx = m.index(@string_terminator, orig_idx)
               arg, idx =  m[orig_idx...idx], idx + 1 + ((4 - ((idx + 1) % 4)) % 4)
+              arg.force_encoding("UTF-8")
             when @d_tag
               # double64
               arg, idx = m[idx, 8].unpack(@cap_g)[0], idx + 8
@@ -120,15 +125,62 @@ module SonicPi
         return address, args
       end
 
-    end
-  end
-end
+      def decode(m, output=[])
+        tt = parse_timetag(m)
+        raw_msgs, raw_bundles = parse_bundles(m)
+
+        output << [tt, raw_msgs.map {|m| self.decode_single_message(m) }]
+
+        if raw_bundles.any?
+          output << raw_bundles[1..-1]
+          self.decode(raw_bundles.first, output)
+        else
+          # for compatibility with the C Extension API
+          return output.reject {|msg| msg.empty? }.reverse
+        end
+      end
+
+      private
+
+      def parse_timetag(m)
+        return nil unless is_bundle?(m)
+
+        t1 = m[8..11].unpack(@literal_cap_n).first
+        t1 = (t1 - @literal_magic_time_offset)
+
+        t2 = m[12..15].unpack(@literal_cap_n).first
+        Time.at(t1 + t2)
+      end
+
+      def parse_bundles(m)
+        raw_msgs = []
+        raw_bundles = []
 
-# Allow for loading above method in benmarks without clobbering c-ext
-if ENV['FAST_OSC_USE_FALLBACK'] == "true"
-module FastOsc
-  def decode_no_bundles(m)
-    SonicPi::OSC::OscEncode.new.decode_single_message(m)
+        if is_bundle?(m)
+          rest_of_message = m[16..-1]
+
+          while rest_of_message && rest_of_message.bytesize > 0
+            first_element_length = rest_of_message[0..3].unpack(@literal_cap_n).first
+            first_element = rest_of_message[4..(4 + first_element_length - 1)]
+
+            if is_bundle?(first_element)
+              raw_bundles << first_element
+            else
+              raw_msgs << first_element
+            end
+
+            rest_of_message = rest_of_message[(4 + first_element_length)..-1]
+          end
+        else
+          raw_msgs << m
+        end
+
+        [raw_msgs, raw_bundles]
+      end
+
+      def is_bundle?(m)
+        m[0..7] == @bundle_header
+      end
+    end
   end
 end
-end

data/lib/fast_osc/pure_ruby_fallback_encode.rb

@@ -26,11 +26,13 @@ module SonicPi
         @literal_low_i = 'i'.freeze
         @literal_low_g = 'g'.freeze
         @literal_low_s = 's'.freeze
+        @literal_low_b = 'b'.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
+        @ascii_encoding = Encoding.find("ASCII-8BIT")
 
         @use_cache = use_cache
         @integer_cache = {}
@@ -92,9 +94,14 @@ module SonicPi
             end
           when String, Symbol
             arg = arg.to_s
-            tags << @literal_low_s
-
-            args_encoded << get_from_or_add_to_string_cache(arg)
+            if(arg.encoding == @ascii_encoding)
+              tags <<  @literal_low_b
+              args_encoded << [arg.bytesize].pack(@literal_cap_n)
+              args_encoded << [arg].pack("Z#{arg.bytesize + 4 - (arg.bytesize % 4)}")
+            else
+              tags << @literal_low_s
+              args_encoded << get_from_or_add_to_string_cache(arg)
+            end
           else
             raise "Unknown arg type to encode: #{arg.inspect}"
           end
@@ -102,7 +109,7 @@ module SonicPi
 
         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}"
+        "#{address}#{tags_encoded}#{args_encoded}".force_encoding("ASCII-8BIT")
       end
 
       def encode_single_bundle(ts, address, args=[])
@@ -132,6 +139,8 @@ module SonicPi
       end
 
       def time_encoded(time)
+        return "\x00\x00\x00\x00\x00\x00\x00\x01" if time.nil?
+
         t1, fr = (time.to_f + @literal_magic_time_offset).divmod(1)
 
         t2 = (fr * @literal_two_to_pow_2).to_i
@@ -152,12 +161,3 @@ module SonicPi
     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 = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/fast_osc.rb

@@ -1,19 +1,70 @@
 require "fast_osc/version"
 
-begin
-  require "fast_osc/fast_osc"
+if ENV['FAST_OSC_USE_FALLBACK'] == "true"
+  # optionally force pure Ruby version
+  warn "FastOsc: choosing to use pure Ruby version"
+  require "fast_osc/pure_ruby_fallback_encode.rb"
+  require "fast_osc/pure_ruby_fallback_decode.rb"
 
   module FastOsc
-    # Your code goes here...
+    def self.encode_single_message(address, args=[])
+      SonicPi::OSC::OscEncode.new.encode_single_message(address, args)
+    end
+
+    def self.encode_single_bundle(ts, address, args=[])
+      SonicPi::OSC::OscEncode.new.encode_single_bundle(ts, address, args)
+    end
+
+    def self.encode_no_bundles(address, args=[])
+      SonicPi::OSC::OscEncode.new.encode_single_message(address, args)
+    end
+    def self.decode_single_message(m)
+      SonicPi::OSC::OscDecode.new.decode_single_message(m)
+    end
+
+    def self.decode_no_bundles(m)
+      SonicPi::OSC::OscDecode.new.decode_single_message(m)
+    end
+
+    def self.decode(m)
+      SonicPi::OSC::OscDecode.new.decode(m)
+    end
   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
+else
+  begin
+    require "fast_osc/fast_osc"
+  
+    module FastOsc
+      # Your code goes here...
+    end
+  rescue LoadError
+    warn "FastOsc: 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"
 
-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"
+    module FastOsc
+      def self.encode_single_message(address, args=[])
+        SonicPi::OSC::OscEncode.new.encode_single_message(address, args)
+      end
+
+      def self.encode_single_bundle(ts, address, args=[])
+        SonicPi::OSC::OscEncode.new.encode_single_bundle(ts, address, args)
+      end
+
+      def self.encode_no_bundles(address, args=[])
+        SonicPi::OSC::OscEncode.new.encode_single_message(address, args)
+      end
+      def self.decode_single_message(m)
+        SonicPi::OSC::OscDecode.new.decode_single_message(m)
+      end
+
+      def self.decode_no_bundles(m)
+        SonicPi::OSC::OscDecode.new.decode_single_message(m)
+      end
+
+      def self.decode(m)
+        SonicPi::OSC::OscDecode.new.decode(m)
+      end
+    end
+  end
 end

data/test/fast_osc_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 require 'osc-ruby'
 require 'date'
 
-class FastOscTest < Minitest::Test
+module FastOscTesting
   def setup
     @path = "/thisisatest"
     @args = ["", 1, 2.0, "baz", "▁▃▅▇"]
@@ -13,6 +13,11 @@ class FastOscTest < Minitest::Test
     @timestamp2 = Date.parse("21st Mar 2000").to_time
     @timestamp3 = Date.parse("22nd Jun 2010").to_time
 
+    # SuperCollider (the main client for this lib)
+    # treats arrays of int8s as a blob
+    # https://doc.sccode.org/Guides/OSC_communication.html
+    @nested_array_args = [1, 2, [-127, 0, 4, 5, 6, 127].join.force_encoding("ASCII-8BIT")]
+    @nested_array_args_blob_encoding = [1, 2, OSC::OSCBlob.new([-127, 0, 4, 5, 6, 127].join)]
 
     @msg0 = OSC::Message.new(@path).encode
     @encoded_msg0 = @msg0.encode
@@ -24,6 +29,8 @@ class FastOscTest < Minitest::Test
     @encoded_msg3 = @msg3.encode
     @msg4 = OSC::Message.new(@path, *@args4).encode
     @encoded_msg4 = @msg4.encode
+    @msg5 = OSC::Message.new(@path, *@nested_array_args_blob_encoding).encode
+    @encoded_msg5 = @msg5.encode
 
     @bundle = OSC::Bundle.new(@timestamp, @msg1, @msg2)
     @encoded_bundle = @bundle.encode
@@ -73,6 +80,23 @@ class FastOscTest < Minitest::Test
     end
   end
 
+  def test_that_it_encodes_a_single_message_with_nested_array_args
+    msg = FastOsc.encode_single_message(@path, @nested_array_args)
+
+    assert_equal msg, @encoded_msg5
+  end
+
+  def test_that_it_decodes_a_single_message_with_nested_array_args
+    FastOsc.decode(@encoded_msg5).each do |msg|
+      _timestamp, osc_msgs = msg
+      path, args = osc_msgs[0]
+
+      assert_equal path, @path
+      assert_equal args, @nested_array_args
+      assert_equal osc_msgs.length, 1
+    end
+  end
+
   def test_that_it_decodes_a_single_message_with_args_knowing_there_are_no_bundles_using_the_decode_no_bundles_function
     path, args =  FastOsc.decode_no_bundles(@encoded_msg1)
 
@@ -210,10 +234,10 @@ class FastOscTest < Minitest::Test
     multiple_decoded = FastOsc.decode(@encoded_bundle)
     single_decoded = FastOsc.decode(@msg1)
 
-    timestamp1, msgs1 = multiple_decoded.first
+    _, msgs1 = multiple_decoded.first
     assert_equal msgs1.first.class, Array
 
-    timestamp2, msgs2 = single_decoded.first
+    _, msgs2 = single_decoded.first
     assert_equal msgs2.first.class, Array
   end
 
@@ -242,3 +266,15 @@ class FastOscTest < Minitest::Test
     assert_in_delta 2.75, Time.at(OSC::OSCPacket.messages_from_network(FastOsc.encode_single_bundle(1463234579.188746, "/foo", []), []).first.time - 2208988800) - start
   end
 end
+
+class FastOscExtTest < Minitest::Test
+  include FastOscTesting
+end
+
+# this doesn't work yet - for now run `rake test` with and without the env var
+# class FastOscPureTest < Minitest::Test
+#   ENV["FAST_OSC_USE_FALLBACK"] = "true"
+#   $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+#   load 'fast_osc.rb'
+#   include FastOscTesting
+# end

metadata

@@ -1,24 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: fast_osc
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Xavier Riley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-30 00:00:00.000000000 Z
+date: 2020-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -26,13 +26,13 @@ dependencies:
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -40,13 +40,13 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,13 +54,13 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -68,13 +68,13 @@ dependencies:
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: osc-ruby
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.1
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -82,13 +82,13 @@ dependencies:
         version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
-  prerelease: false
   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:
     - - "~>"