synthdef 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 606df2662e08ada182088202a35eac3d4371288f
+  data.tar.gz: 7e0639b1b86fe4f9555081db52fb7d691f78097c
+SHA512:
+  metadata.gz: 178481c0bde1bda955b256fb5d57f0b8d87517d909c13009fb36f941c84ec0438eb6f35c0c4396db5217971fcf90986fef51f8e2f12770eb3b0f584d083c91fa
+  data.tar.gz: 0867d1e926b801e40c21fe2bb03814955ab724e0e69d30c7fe226b1da0e1ea0daf5eaa337cface9942017ef46263eb43738e9e35b0393f30d77a72795daf195c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec', cmd: 'bundle exec rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Xavier Riley
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Synthdef
+
+## 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.
+
+Inspiration for the spec was taken from the following links:
+
+- [Clojure - Overtone - synthdef.clj](https://github.com/overtone/overtone/blob/master/src/overtone/sc/machinery/synthdef.clj)
+
+This handles the synthdef format in Overtone, using Jeff Rose's [byte-spec](https://github.com/overtone/byte-spec) library.
+
+- [Haskell - synthdef.ipynb](https://gist.github.com/miguel-negrao/8d71807afb513412d780)
+
+Code by @miguel-negrao to parse synthdefs in Haskell.
+
+Other libraries and langs I haven't checked out yet:
+
+- [Go - scgolang](https://github.com/scgolang/sc/blob/master/synthdef.go)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'synthdef'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install synthdef
+
+## Usage
+
+Take a binary scsyndef file (you can find an example in `spec/data/recorder.scsyndef`)
+
+```
+$ bundle exec irb
+
+>> 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=>[]}]}
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/xavriley/synthdef/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/lib/synthdef.rb

@@ -0,0 +1,61 @@
+require "synthdef/version"
+require 'bindata'
+
+class PascalString < BinData::Primitive
+  uint8  :len,  :value => lambda { data.length }
+  string :data, :read_length => :len
+
+  def get;   self.data; end
+  def set(v) self.data = v; end
+end
+
+class Synthdef < BinData::Record
+  endian :big
+
+  string :file_type_id, read_length: 4
+  uint32 :file_version
+  uint16 :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
+      float :constant
+    end
+
+    int16        :no_of_params
+    array        :params, initial_length: lambda { no_of_params } do
+      float :initial_parameter_value
+    end
+
+    int16        :no_of_param_names
+    array        :param_names, initial_length: lambda { no_of_param_names } do
+      pascal_string :param_name
+      int16         :param_index
+    end
+
+    int16        :no_of_ugens
+    array        :ugens, initial_length: lambda { no_of_ugens } do
+      pascal_string :ugen_name
+      int8          :rate
+      int16         :no_of_inputs
+      int16         :no_of_outputs
+      int16         :special, initial_value: 0
+      array         :inputs, initial_length: lambda { no_of_inputs } do
+        int16 :src
+        int16 :input_index
+      end
+      array         :outputs, initial_length: lambda { no_of_outputs } do
+        int8 :calculation_rate
+      end
+    end
+
+    int16 :no_of_variants, initial_value: 0
+    array :variants, initial_length: lambda { no_of_variants } do
+      pascal_string :variant_name
+      float         :variant_param
+    end
+  end
+
+end

data/lib/synthdef/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'pry'
+require 'synthdef'

data/spec/synthdef_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Synthdef do
+  let(:synthdef_binary) { IO.read(File.expand_path("../data/recorder.scsyndef", __FILE__)) }
+
+  it 'reads a basic synthdef' do
+    parsed_synthdef = Synthdef.read(synthdef_binary).snapshot
+
+    expect(parsed_synthdef).to be_a(Hash)
+    expect(parsed_synthdef).not_to be_empty
+  end
+end

data/synthdef.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'synthdef/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "synthdef"
+  spec.version       = Synthdef::VERSION
+  spec.authors       = ["Xavier Riley"]
+  spec.email         = ["xavriley@hotmail.com"]
+  spec.summary       = %q{Work with SuperCollider's binary synthdef format}
+  spec.description   = %q{Use the power of Ruby to convert, edit and save synthdefs for SuperCollider}
+  spec.homepage      = "https://github.com/xavriley/synthdef"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bindata"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "pry-nav"
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: synthdef
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Xavier Riley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use the power of Ruby to convert, edit and save synthdefs for SuperCollider
+email:
+- xavriley@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/synthdef.rb
+- lib/synthdef/version.rb
+- spec/data/recorder.scsyndef
+- spec/spec_helper.rb
+- spec/synthdef_spec.rb
+- synthdef.gemspec
+homepage: https://github.com/xavriley/synthdef
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Work with SuperCollider's binary synthdef format
+test_files:
+- spec/data/recorder.scsyndef
+- spec/spec_helper.rb
+- spec/synthdef_spec.rb
+has_rdoc: