fast_osc 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 949bcdc8e52905bef3bb5b53468844ab80232dd84e41b4d3d6c583c4317a6ff6
-  data.tar.gz: 229101f3ae65814846abb268e3780d4ac2c41d8c0d80f1e4c6da914cd07f2066
+  metadata.gz: d28e104c919d500f56f8cc1ff18eaedfc3324c07127f72c5af5d4d662a453f55
+  data.tar.gz: fd255b333c9d2e482f08eab6dac3b7bab74fae4732e454b9d22b1f658a3f7dff
 SHA512:
-  metadata.gz: 0d8e2777889e23339b1aebfbf15dd0bf26c98377c17721a876261767df06de0eaff80cb1418bc979dcadfcd61f5fced74e8857c52dbd601e8029c25d9b9fac6a
-  data.tar.gz: 2c61360c8a58ff7994c4158e31060938f98352941aedb7941359980730cbd9bd9a8ca0f43c7ec88c09d4d0e56b5736ad24cbc8a7ad15106b525d73378b29522b
+  metadata.gz: bb5faf369b9b7859d9adda5f11811290c64f1014ffcb9cd2a9a81a5f9141d31b0c94e1055137bf3a730dc80499396624f06515e0c76f750e0fb68dc1fd08110b
+  data.tar.gz: 15333641c23c7095fe8453e4c78301f72e2e71a307304b8a756d760fcdc151a2f88d6c77322eb9bda9157bde31bd83a1899786963d1632b6642a314db0077ad1

data/README.md

@@ -18,6 +18,40 @@ Or install it yourself as:
 
     $ gem install fast_osc
 
+## Usage
+
+Everything (single messages and bundles) can be parsed with a single method -
+`FastOsc.decode`. This outputs an array of bundles, with each bundle containing
+a timestamp and an array of messages. Each message contains a path and,
+optionally, some arguments.
+
+```ruby
+# encode an OSC message with the established Ruby OSC libary
+@msg = OSC::Message.new("/testpath", ["some", "args", 1, 2.0]).encode
+@encoded_msg = @msg1.encode
+
+FastOsc.decode(@encoded_msg0).each do |bundle|
+  _timestamp, osc_msgs = bundle
+
+  osc_msgs.each do |(path, args)|
+    puts @path # "/testpath"
+    puts args # ["some", "args", 1, 2.0]
+  end
+end
+```
+
+```
+>> FastOsc.encode_single_message("/foo", ["baz", 1, 2.0])
+=> "/foo\x00\x00\x00\x00,sif\x00\x00\x00\x00baz\x00\x00\x00\x00\x01@\x00\x00\x00"
+>> res = _
+>> FastOsc.decode_no_bundles(res)
+=> ["/foo", ["baz", 1, 2.0]]
+>> FastOsc.encode_single_bundle(Time.now.to_i, "/foo", ["baz", 1, 2.0])
+=> "#bundle\x00\x00\x00\x00\x00W*1\x7F\x00\x00\x00\x1C/foo\x00\x00\x00\x00,sif\x00\x00\x00\x00baz\x00\x00\x00\x00\x01@\x00\x00\x00"
+```
+
+ A timestamp of `nil` is a special case meaning "immediately".
+
 ## Is it fast?
 
 Let's see...
@@ -31,6 +65,7 @@ Key:
 ### Encoding Benchmark
 
 ```
+$ WITH_BENCHMARKS=1 rake test
 Warming up --------------------------------------
             fast_osc    64.995k i/100ms
              samsosc    23.371k i/100ms
@@ -44,6 +79,7 @@ Calculating -------------------------------------
 ### Decoding Bencmark
 
 ```
+$ WITH_BENCHMARKS=1 rake test
 Warming up --------------------------------------
             fast_osc   102.344k i/100ms
              samsosc    20.770k i/100ms
@@ -54,102 +90,7 @@ Calculating -------------------------------------
             osc-ruby     34.266k (±13.3%) i/s -    169.830k in   5.048509s
 ```
 
-Benchmarks are now part of this repo - run `rake test` to see the results for yourself.
-
-## What about Truffle Ruby?
-
-> A high performance implementation of the Ruby programming language. Built on GraalVM by Oracle Labs.
-
-Just for fun, I re-ran the benchmarks using TruffleRuby. First some install steps:
-
-```
-git clone this repo
-bundle install
-export PATH="/usr/local/opt/llvm@4/bin:$PATH"
-rake clean && rake compile
-```
-
-then the test:
-
-```
-$ rake test
-ENCODING TEST
-Warming up --------------------------------------
-            fast_osc     3.000  i/100ms
-             samsosc    28.219k i/100ms
-            osc-ruby   234.000  i/100ms
-Calculating -------------------------------------
-            fast_osc     33.294  (±45.1%) i/s -    129.000  in   5.295649s
-             samsosc      1.369M (±33.5%) i/s -      3.556M in   5.010343s
-            osc-ruby    274.170k (±20.2%) i/s -      1.064M in   4.971832s
-DECODING TEST
-Warming up --------------------------------------
-            fast_osc     9.000  i/100ms
-             samsosc     6.087k i/100ms
-            osc-ruby   418.000  i/100ms
-Calculating -------------------------------------
-            fast_osc     71.034  (±45.0%) i/s -    261.000  in   5.015393s
-             samsosc    114.443k (±70.2%) i/s -    261.741k in   5.283892s
-            osc-ruby     84.236k (±34.7%) i/s -    237.424k in   5.317738s
-
-# update - retested using rc5
-ENCODING TEST
-Warming up --------------------------------------
-            fast_osc   106.000  i/100ms
-             samsosc   999.000  i/100ms
-            osc-ruby   159.000  i/100ms
-Calculating -------------------------------------
-            fast_osc     24.507k (±28.6%) i/s -     83.316k in   4.984544s
-             samsosc      1.494M (±22.4%) i/s -      2.785M in   4.988822s
-            osc-ruby    265.322k (±26.5%) i/s -    597.522k in   5.014127s
-DECODING TEST
-Warming up --------------------------------------
-            fast_osc   173.000  i/100ms
-             samsosc   454.000  i/100ms
-            osc-ruby   208.000  i/100ms
-Calculating -------------------------------------
-            fast_osc     73.712k (±66.4%) i/s -    163.831k in   5.049410s
-             samsosc    325.920k (±33.7%) i/s -    875.766k in   4.989279s
-            osc-ruby     63.624k (±52.3%) i/s -    129.792k in   5.005088s
-Run options: --seed 56032
-```
-
-### The Good
-
-The encoding benchmark - the optimised pure Ruby version is nearly as fast as
-the C extension!
-
-```
-# C ext in MRI
-fast_osc    797.673k (±15.0%) i/s -      3.900M in   5.043770s
-# Pure Ruby in Truffle rc3
-samsosc      1.369M (±33.5%) i/s -      3.556M in   5.010343s
-# Pure Ruby in Truffle rc5
-samsosc      1.494M (±22.4%) i/s -      2.785M in   4.988822s
-```
-
-### The Bad
-
-Decoding was generally slower, although the (non optimised) osc gem seemed to
-prefer TruffleRuby, running around 40% faster.
-
-~Also the performance of the C extension in TruffleRuby was very, very poor but
-this may be due to not warming up enough.~ update - this appears to be better
-in rc5.
-
-## Usage
-
-```
->> FastOsc.encode_single_message("/foo", ["baz", 1, 2.0])
-=> "/foo\x00\x00\x00\x00,sif\x00\x00\x00\x00baz\x00\x00\x00\x00\x01@\x00\x00\x00"
->> res = _
->> FastOsc.decode_single_message(res)
-=> ["/foo", ["baz", 1, 2.0]]
->> FastOsc.encode_single_bundle(Time.now.to_i, "/foo", ["baz", 1, 2.0])
-=> "#bundle\x00\x00\x00\x00\x00W*1\x7F\x00\x00\x00\x1C/foo\x00\x00\x00\x00,sif\x00\x00\x00\x00baz\x00\x00\x00\x00\x01@\x00\x00\x00"
-```
-
-See the test suite for additional methods regarding bundles with timestamps. Bundles are only supported with a single message at present. A timestamp of `nil` is a special case meaning "immediately".
+Benchmarks are now part of this repo - run `WITH_BENCHMARKS=1 rake test` to see the results for yourself.
 
 ## Running the test suite
 
@@ -160,6 +101,7 @@ $ rake clean && rake clobber && rake compile && rake test
 
 ## Still todo
 
+- [ ] Make a pure ruby fallback available
 - [x] Implement more types
 - [x] Bring benchmarks into the repo
 - [ ] Work out cross compilation story for easier packaging

data/docs/what-about-truffle-ruby.md

@@ -0,0 +1,102 @@
+# What about Truffle Ruby?
+
+> A high performance implementation of the Ruby programming language. Built on GraalVM by Oracle Labs.
+
+Just for fun, I re-ran the benchmarks using TruffleRuby. First some install steps:
+
+```
+git clone this repo
+bundle install
+export PATH="/usr/local/opt/llvm@4/bin:$PATH"
+rake clean && rake compile
+export WITH_BENCHMARKS=1
+```
+
+then the test:
+
+```
+$ rake test
+ENCODING TEST
+Warming up --------------------------------------
+            fast_osc     3.000  i/100ms
+             samsosc    28.219k i/100ms
+            osc-ruby   234.000  i/100ms
+Calculating -------------------------------------
+            fast_osc     33.294  (±45.1%) i/s -    129.000  in   5.295649s
+             samsosc      1.369M (±33.5%) i/s -      3.556M in   5.010343s
+            osc-ruby    274.170k (±20.2%) i/s -      1.064M in   4.971832s
+DECODING TEST
+Warming up --------------------------------------
+            fast_osc     9.000  i/100ms
+             samsosc     6.087k i/100ms
+            osc-ruby   418.000  i/100ms
+Calculating -------------------------------------
+            fast_osc     71.034  (±45.0%) i/s -    261.000  in   5.015393s
+             samsosc    114.443k (±70.2%) i/s -    261.741k in   5.283892s
+            osc-ruby     84.236k (±34.7%) i/s -    237.424k in   5.317738s
+
+# update - retested using rc5
+ENCODING TEST
+Warming up --------------------------------------
+            fast_osc   106.000  i/100ms
+             samsosc   999.000  i/100ms
+            osc-ruby   159.000  i/100ms
+Calculating -------------------------------------
+            fast_osc     24.507k (±28.6%) i/s -     83.316k in   4.984544s
+             samsosc      1.494M (±22.4%) i/s -      2.785M in   4.988822s
+            osc-ruby    265.322k (±26.5%) i/s -    597.522k in   5.014127s
+DECODING TEST
+Warming up --------------------------------------
+            fast_osc   173.000  i/100ms
+             samsosc   454.000  i/100ms
+            osc-ruby   208.000  i/100ms
+Calculating -------------------------------------
+            fast_osc     73.712k (±66.4%) i/s -    163.831k in   5.049410s
+             samsosc    325.920k (±33.7%) i/s -    875.766k in   4.989279s
+            osc-ruby     63.624k (±52.3%) i/s -    129.792k in   5.005088s
+Run options: --seed 56032
+
+# update - retested using 19.0.1
+ENCODING TEST
+Warming up --------------------------------------
+            fast_osc   210.000  i/100ms
+             samsosc    12.833k i/100ms
+            osc-ruby   262.000  i/100ms
+Calculating -------------------------------------
+            fast_osc    150.306k (±38.0%) i/s -    411.600k in   4.904832s
+             samsosc      1.393M (±22.7%) i/s -      5.300M in   4.995566s
+            osc-ruby    273.289k (±19.4%) i/s -    714.474k in   4.988380s
+DECODING TEST
+Warming up --------------------------------------
+            fast_osc   507.000  i/100ms
+             samsosc   871.000  i/100ms
+            osc-ruby   329.000  i/100ms
+Calculating -------------------------------------
+            fast_osc    577.429k (±34.2%) i/s -    539.448k in   5.028383s
+             samsosc    779.126k (±14.0%) i/s -      2.360M in   4.989644s
+            osc-ruby    173.848k (±39.8%) i/s -    334.593k in   4.994280s
+Run options: --seed 47839
+```
+
+### The Good
+
+The encoding benchmark - the optimised pure Ruby version is nearly as fast as
+the C extension!
+
+```
+# C ext in MRI
+fast_osc    797.673k (±15.0%) i/s -      3.900M in   5.043770s
+# Pure Ruby in Truffle rc3
+samsosc      1.369M (±33.5%) i/s -      3.556M in   5.010343s
+# Pure Ruby in Truffle rc5
+samsosc      1.494M (±22.4%) i/s -      2.785M in   4.988822s
+```
+
+### The Bad
+
+Decoding was generally slower, although the (non optimised) osc gem seemed to
+prefer TruffleRuby, running around 40% faster.
+
+~Also the performance of the C extension in TruffleRuby was very, very poor but
+this may be due to not warming up enough.~ update - this appears to be better
+in rc5.

data/ext/fast_osc/fast_osc_wrapper.c

@@ -96,9 +96,14 @@ VALUE method_fast_osc_decode(VALUE self, VALUE msg) {
   // If we get != Qnil, then there were no bundles, and we need to add the element
   VALUE element = method_fast_osc_decode_do(self, msg, output_ary);
   if (element != Qnil){
+    // format [[timestamp, [[ ... msg ...]]]]
+    // enclosing arrays match output shape of decode_do
+    VALUE msgs_ary = rb_ary_new();
     VALUE element_ary = rb_ary_new();
-    rb_ary_push(element_ary, osc_timetag_to_ruby_time(1));
-    rb_ary_push(element_ary, element);
+    // A timestamp of `nil` is a special case meaning "immediately".
+    rb_ary_push(element_ary, Qnil);
+    rb_ary_push(msgs_ary, element);
+    rb_ary_push(element_ary, msgs_ary);
     rb_ary_push(output_ary, element_ary);
   }
   return output_ary;

data/lib/fast_osc/pure_ruby_fallback_decode.rb

@@ -127,7 +127,7 @@ 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)
+  def decode_no_bundles(m)
     SonicPi::OSC::OscEncode.new.decode_single_message(m)
   end
 end

data/lib/fast_osc/version.rb

@@ -1,3 +1,3 @@
 module FastOsc
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/test/benchmark_test.rb

@@ -13,6 +13,7 @@
 
 
 # requires benchmark/ips gem to be installed
+return unless ENV['WITH_BENCHMARKS']
 
 require 'test_helper'
 require 'benchmark/ips'

data/test/fast_osc_test.rb

@@ -33,7 +33,6 @@ class FastOscTest < Minitest::Test
 
     @bundle3 = OSC::Bundle.new(@timestamp3, @msg4, @bundle2, @msg3, @msg2)
     @encoded_bundle3 = @bundle3.encode
-
   end
 
   def test_that_it_has_a_version_number
@@ -46,16 +45,15 @@ class FastOscTest < Minitest::Test
     assert_equal msg, @encoded_msg0
   end
 
-
   def test_that_it_decodes_a_single_message
-    msgs = FastOsc.decode(@encoded_msg0)
-
-    _timestamp, osc_msgs = msgs[0]
-    path, args = osc_msgs
-
-    assert path == @path
-    assert args == []
-    assert_nil msgs[1]
+    FastOsc.decode(@encoded_msg0).each do |msg|
+      _timestamp, osc_msgs = msg
+
+      osc_msgs.each do |(path, args)|
+        assert_equal @path, path
+        assert_equal args, []
+      end
+    end
   end
 
   def test_that_it_encodes_a_single_message_with_args
@@ -65,21 +63,14 @@ class FastOscTest < Minitest::Test
   end
 
   def test_that_it_decodes_a_single_message_with_args
-    msgs = FastOsc.decode(@encoded_msg1)
-
-    _timestamp, osc_msgs = msgs[0]
-    path, args = osc_msgs
-
-    assert_equal path, @path
-    assert_equal args, @args
-    assert_nil msgs[1]
-  end
-
-  def test_that_it_decodes_a_single_message_with_args_knowing_there_are_no_bundles_using_the_decode_function
-    _timestamp, (path, args) =  FastOsc.decode(@encoded_msg1)[0]
-
-    assert_equal path, @path
-    assert_equal args, @args
+    FastOsc.decode(@encoded_msg1).each do |msg|
+      _timestamp, osc_msgs = msg
+      path, args = osc_msgs[0]
+
+      assert_equal path, @path
+      assert_equal args, @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
@@ -119,11 +110,11 @@ class FastOscTest < Minitest::Test
     msgs = FastOsc.decode(@encoded_bundle2)
 
     # Example of how to process the message:
-    #msgs.each do |timestamp, osc_messages|
-      # These are the messages within this bundle
+    # msgs.each do |timestamp, osc_messages|
+    #  # These are the messages within this bundle
     #  puts "T: #{timestamp}, M: #{osc_messages}"
     #  osc_messages.each do |path, args|
-        # And this is each message
+    #   # And this is each message
     #    puts "P: #{path}, A: #{args}"
     #  end
     #end
@@ -215,6 +206,17 @@ class FastOscTest < Minitest::Test
     assert_equal bundle1, bundle2
   end
 
+  def test_that_single_messages_and_bundles_can_still_be_iterated_over
+    multiple_decoded = FastOsc.decode(@encoded_bundle)
+    single_decoded = FastOsc.decode(@msg1)
+
+    timestamp1, msgs1 = multiple_decoded.first
+    assert_equal msgs1.first.class, Array
+
+    timestamp2, msgs2 = single_decoded.first
+    assert_equal msgs2.first.class, Array
+  end
+
   def test_that_it_encodes_a_single_bundle_with_special_immediate_time
     bundle1 = OSC::Bundle.new(nil, @msg1).encode
     bundle2 = FastOsc.encode_single_bundle(nil, @path, @args)

metadata

@@ -1,24 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: fast_osc
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Xavier Riley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-21 00:00:00.000000000 Z
+date: 2019-07-30 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:
     - - "~>"
@@ -108,6 +108,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- docs/what-about-truffle-ruby.md
 - ext/fast_osc/extconf.rb
 - ext/fast_osc/fast_osc_wrapper.c
 - ext/fast_osc/rtosc.c
@@ -140,8 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Serialize and deserialize Open Sound Control messages