synthdef 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 606df2662e08ada182088202a35eac3d4371288f
-  data.tar.gz: 7e0639b1b86fe4f9555081db52fb7d691f78097c
+  metadata.gz: 665422f13978b9e8381467e67573a50fb522f768
+  data.tar.gz: c2110f4a9fbfa0a0791ed3ce7b559e3f39263bf3
 SHA512:
-  metadata.gz: 178481c0bde1bda955b256fb5d57f0b8d87517d909c13009fb36f941c84ec0438eb6f35c0c4396db5217971fcf90986fef51f8e2f12770eb3b0f584d083c91fa
-  data.tar.gz: 0867d1e926b801e40c21fe2bb03814955ab724e0e69d30c7fe226b1da0e1ea0daf5eaa337cface9942017ef46263eb43738e9e35b0393f30d77a72795daf195c
+  metadata.gz: 539a3e6d7691f19a939c1cb311d250c7fdfffc0187c59874f1e523861da3cbf978271b1a84f08f3aa82def73e5d8e8260faa940c68f259d20082c0d65e9a25a5
+  data.tar.gz: 61d36bda458ead263f7b5c7c309c20d1e9ea483092c97d9e74c5acf8d581b133e998d6580ba15d704c158e33ea1a7c5d432e0b223d6d5e93b5e2bdde2e3ae7dc

data/README.md

@@ -2,9 +2,15 @@
 
 ## pre-Alpha
 
-A gem to work with SuperCollider's binary synthdef format. This uses the excellent [`bindata`](https://github.com/dmendel/bindata) gem to define the spec in a very readable way. The implementation is less than 60 lines of code.
+A gem to work with SuperCollider's binary synthdef format. This uses the excellent [`bindata`](https://github.com/dmendel/bindata) gem to define the spec in a very readable way. The implementation is around than 60 lines of code.
 
-Inspiration for the spec was taken from the following links:
+It works with both SynthDef and SynthDef2 formats.
+
+I found the actual spec here:
+
+[http://doc.sccode.org/Reference/Synth-Definition-File-Format.html](http://doc.sccode.org/Reference/Synth-Definition-File-Format.html)
+
+Before I found the spec(!), inspiration was taken from the following links:
 
 - [Clojure - Overtone - synthdef.clj](https://github.com/overtone/overtone/blob/master/src/overtone/sc/machinery/synthdef.clj)
 
@@ -39,11 +45,116 @@ Take a binary scsyndef file (you can find an example in `spec/data/recorder.scsy
 ```
 $ bundle exec irb
 
+# pp is just to pretty print the output, not essential
+>> require 'pp'
+=> true
 >> require 'synthdef'
 => true
 >> raw = open("spec/data/recorder.scsyndef").read
->> Synthdef.read(raw)
-=> {:file_type_id=>"SCgf", :file_version=>1, :no_of_synthdefs=>1, :synthdefs=>[{:name=>"sonic-pi-recorder", :no_of_constants=>0, :constants=>[], :no_of_params=>2, :params=>[0.0, 0.0], :no_of_param_names=>2, :param_names=>[{:param_name=>"out-buf", :param_index=>0}, {:param_name=>"in_bus", :param_index=>1}], :no_of_ugens=>3, :ugens=>[{:ugen_name=>"Control", :rate=>1, :no_of_inputs=>0, :no_of_outputs=>2, :special=>0, :inputs=>[], :outputs=>[1, 1]}, {:ugen_name=>"InFeedback", :rate=>2, :no_of_inputs=>1, :no_of_outputs=>2, :special=>0, :inputs=>[{:src=>0, :input_index=>1}], :outputs=>[2, 2]}, {:ugen_name=>"DiskOut", :rate=>2, :no_of_inputs=>3, :no_of_outputs=>1, :special=>0, :inputs=>[{:src=>0, :input_index=>0}, {:src=>1, :input_index=>0}, {:src=>1, :input_index=>1}], :outputs=>[2]}], :no_of_variants=>0, :variants=>[]}]}
+>> pp Synthdef.read(raw)
+=> {:file_type_id=>"SCgf",
+ :file_version=>1,
+ :no_of_synthdefs=>1,
+ :synthdefs=>
+  [{:name=>"sonic-pi-recorder",
+    :no_of_constants=>0,
+    :constants=>[],
+    :no_of_params=>2,
+    :params=>[0.0, 0.0],
+    :no_of_param_names=>2,
+    :param_names=>
+     [{:param_name=>"out-buf", :param_index=>0},
+      {:param_name=>"in_bus", :param_index=>1}],
+    :no_of_ugens=>3,
+    :ugens=>
+     [{:ugen_name=>"Control",
+       :rate=>1,
+       :no_of_inputs=>0,
+       :no_of_outputs=>2,
+       :special=>0,
+       :inputs=>[],
+       :outputs=>[1, 1]},
+      {:ugen_name=>"In",
+       :rate=>2,
+       :no_of_inputs=>1,
+       :no_of_outputs=>2,
+       :special=>0,
+       :inputs=>[{:src=>0, :input_constant_index=>1}],
+       :outputs=>[2, 2]},
+      {:ugen_name=>"DiskOut",
+       :rate=>2,
+       :no_of_inputs=>3,
+       :no_of_outputs=>1,
+       :special=>0,
+       :inputs=>
+        [{:src=>0, :input_constant_index=>0},
+         {:src=>1, :input_constant_index=>0},
+         {:src=>1, :input_constant_index=>1}],
+       :outputs=>[2]}],
+    :no_of_variants=>0,
+    :variants=>[]}]}
+```
+
+## Differences between SynthDef versions 1 and 2
+
+```
+# Taken from spec
+# synth-definition-file for version 2
+
+int32 - four byte file type id containing the ASCII characters: "SCgf"
+int32 - file version, currently 2.
+int16 - number of synth definitions in this file (D).
+[ synth-definition ] * D
+pstring - the name of the synth definition
+int32 - number of constants (K)
+[float32] * K - constant values
+int32 - number of parameters (P)
+[float32] * P - initial parameter values
+int32 - number of parameter names (N)
+[ param-name ] * N
+pstring - the name of the parameter
+int32 - its index in the parameter array
+int32 - number of unit generators (U)
+[ ugen-spec ] * U
+pstring - the name of the SC unit generator class
+int8 - calculation rate
+int32 - number of inputs (I)
+int32 - number of outputs (O)
+int16 - special index
+[ input-spec ] * I
+int32 - index of unit generator or -1 for a constant
+if (unit generator index == -1)
+int32 - index of constant
+else
+int32 - index of unit generator output
+[ output-spec ] * O
+int8 - calculation rate
+int16 - number of variants (V)
+[ variant-spec ] * V
+pstring - the name of the variant
+[float32] * P - variant initial parameter values
+```
+
+Again, taken from the spec
+
+```
+The original SynthDef format differs in that the following items are int16 instead of int32.
+NOTE: The following list describes what has changed between SynthDef and SynthDef2. It is not a complete description of the the original SynthDef file format.
+int32 - file version, currently 1. (This is 2 for the new format.)
+a synth-definition is :
+int16 - number of constants (K)
+int16 - number of parameters (P)
+int16 - number of parameter names (N)
+int16 - number of unit generators (U)
+a param-name is :
+int16 - its index in the parameter array
+a ugen-spec is :
+int16 - number of inputs (I)
+int16 - number of outputs (O)
+an input-spec is :
+int16 - index of unit generator or -1 for a constant
+int16 - index of constant
+int16 - index of unit generator output
 ```
 
 ## Contributing

data/lib/synthdef.rb

@@ -10,41 +10,50 @@ class PascalString < BinData::Primitive
 end
 
 class Synthdef < BinData::Record
+  def check_version
+    # Returns zero based index for choices
+    file_version == 1 ? 0 : 1
+  end
+
   endian :big
 
   string :file_type_id, read_length: 4
-  uint32 :file_version
-  uint16 :no_of_synthdefs
+  int32 :file_version
+  int16 :no_of_synthdefs
 
   array :synthdefs, initial_length: lambda { no_of_synthdefs } do
     pascal_string :name
 
-    int16        :no_of_constants
-    array        :constants, initial_length: lambda { no_of_constants } do
+    choice        :no_of_constants, :selection => :check_version, :choices => {0 => :int16, 1 => :int32}
+    array         :constants, initial_length: lambda { no_of_constants } do
       float :constant
     end
 
-    int16        :no_of_params
+    choice        :no_of_params, :selection => :check_version, :choices => {0 => :int16, 1 => :int32}
     array        :params, initial_length: lambda { no_of_params } do
       float :initial_parameter_value
     end
 
-    int16        :no_of_param_names
+    choice        :no_of_param_names, :selection => :check_version, :choices => {0 => :int16, 1 => :int32}
     array        :param_names, initial_length: lambda { no_of_param_names } do
       pascal_string :param_name
-      int16         :param_index
+      choice        :param_index, :selection => :check_version, :choices => {0 => :int16, 1 => :int32}
     end
 
-    int16        :no_of_ugens
+    choice        :no_of_ugens, :selection => :check_version, :choices => {0 => :int16, 1 => :int32}
     array        :ugens, initial_length: lambda { no_of_ugens } do
       pascal_string :ugen_name
       int8          :rate
-      int16         :no_of_inputs
-      int16         :no_of_outputs
+      choice        :no_of_inputs, :selection => :check_version, :choices => {0 => :int16, 1 => :int32}
+      choice        :no_of_outputs, :selection => :check_version, :choices => {0 => :int16, 1 => :int32}
       int16         :special, initial_value: 0
       array         :inputs, initial_length: lambda { no_of_inputs } do
-        int16 :src
-        int16 :input_index
+        choice :src, :selection => :check_version, :choices => {0 => :int16, 1 => :int32}
+        if lambda { src == -1 }
+          choice :input_constant_index, :selection => :check_version, :choices => {0 => :int16, 1 => :int32}
+        else
+          choice :input_ugen_index, :selection => :check_version, :choices => {0 => :int16, 1 => :int32}
+        end
       end
       array         :outputs, initial_length: lambda { no_of_outputs } do
         int8 :calculation_rate

data/lib/synthdef/version.rb

@@ -1,5 +1,5 @@
 require 'bindata'
 
 class Synthdef < BinData::Record
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/spec/synthdef_spec.rb

@@ -2,11 +2,29 @@ require 'spec_helper'
 
 describe Synthdef do
   let(:synthdef_binary) { IO.read(File.expand_path("../data/recorder.scsyndef", __FILE__)) }
+  let(:complex_synthdef_binary) { IO.read(File.expand_path("../data/hoover.scsyndef", __FILE__)) }
 
-  it 'reads a basic synthdef' do
+  it 'reads a basic version 1 synthdef' do
     parsed_synthdef = Synthdef.read(synthdef_binary).snapshot
 
     expect(parsed_synthdef).to be_a(Hash)
     expect(parsed_synthdef).not_to be_empty
+    expect(parsed_synthdef[:synthdefs].first[:no_of_constants]).to eq(0)
+    expect(parsed_synthdef[:synthdefs].first[:no_of_params]).to eq(2)
+  end
+
+  it 'reads a complex version 2 synthdef' do
+    parsed_synthdef = Synthdef.read(complex_synthdef_binary).snapshot
+
+    expect(parsed_synthdef).to be_a(Hash)
+    expect(parsed_synthdef[:file_version]).to eq(2)
+    expect(parsed_synthdef[:no_of_synthdefs]).to eq(1)
+    expect(parsed_synthdef[:synthdefs].first[:no_of_constants]).to eq(32)
+    expect(parsed_synthdef[:synthdefs].first[:constants].last).to eq(-4.0)
+    expect(parsed_synthdef[:synthdefs].first[:no_of_params]).to eq(5)
+    expect(parsed_synthdef[:synthdefs].first[:param_names].last).to eq({param_name: "gate", param_index: 4})
+    expect(parsed_synthdef[:synthdefs].first[:no_of_ugens]).to eq(104)
+    expect(parsed_synthdef[:synthdefs].first[:ugens].last[:ugen_name]).to eq("Out")
+    expect(parsed_synthdef[:synthdefs].first[:no_of_variants]).to eq(0)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synthdef
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Xavier Riley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-24 00:00:00.000000000 Z
+date: 2015-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -151,7 +151,9 @@ files:
 - Rakefile
 - lib/synthdef.rb
 - lib/synthdef/version.rb
+- spec/data/hoover.scsyndef
 - spec/data/recorder.scsyndef
+- spec/data/stereo_player.scsyndef
 - spec/spec_helper.rb
 - spec/synthdef_spec.rb
 - synthdef.gemspec
@@ -180,7 +182,9 @@ signing_key:
 specification_version: 4
 summary: Work with SuperCollider's binary synthdef format
 test_files:
+- spec/data/hoover.scsyndef
 - spec/data/recorder.scsyndef
+- spec/data/stereo_player.scsyndef
 - spec/spec_helper.rb
 - spec/synthdef_spec.rb
 has_rdoc: