puredata 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5019cc763303059953a987b3987e9841bf6e3ad
+  data.tar.gz: 12158322048cc28ae8b83425b9a75c40915b01b8
+SHA512:
+  metadata.gz: 2909322b6f9c15dac7f1f49c09680bbc96166ae78931ae4a6a271a3a00c7a3ce42aff1ebdcba5c3f9a3cbc8402fbf766bd4ae3d5f329d165edd10845120600e4
+  data.tar.gz: 61935a92985785f15c9c5ee1afb6da5460eb2db389082a261489bebc02f6b8c1e401faf1c6d4d06d9a1eae3d92cbd270d357933f185ab1e0130366fac1fbab2b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puredata.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Tomoyuki Chikanaga
+
+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.rdoc

@@ -0,0 +1,33 @@
+= Ruby/PureData
+Ruby library to manipulate PureData (Pd-extended) via socket.
+
+== Requirements
+  Mac OS X
+  Pd-extended
+
+== Synopsis
+
+  require "puredata"
+
+  Pd.start do |pd|
+    canvas = pd.canvas("sample")
+
+    osc = canvas.obj("osc~", 440)
+    mul = canvas.obj("*~", 0.1)
+    dac = canvas.obj("dac~")
+    osc >> mul
+    dac.left << mul
+    dac.right << mul
+
+    pd.dsp = true
+    sleep 5
+    pd.dsp = false
+  end
+
+== Description
+
+== Installation
+
+== License
+
+This software is released under the MIT License, see LICENSE.txt.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/example/abstraction.rb

@@ -0,0 +1,23 @@
+require "puredata"
+
+Pd.start do |pd|
+  # create abstraction "osc440.pd"
+  sample = pd.abstraction("osc440") do |abst|
+    abst.add_outlet(true)
+    osc = abst.obj("osc~", 440)
+    mul = abst.obj("*~", 0.3)
+    osc >> mul
+    abst.outlet(0) << mul
+  end
+
+  canvas = pd.canvas("sample")
+  osc440 = canvas.obj("osc440")
+  dac = canvas.obj("dac~")
+  osc440 >> dac.left
+  osc440 >> dac.right
+  canvas.save
+
+  pd.dsp = true
+  sleep 3
+  pd.dsp = false
+end

data/example/example.pd

@@ -0,0 +1,2 @@
+#N canvas 0 22 450 300 10;
+#X obj 40 40 netreceive 10002 0 old;

data/example/example.rb

@@ -0,0 +1,39 @@
+require "puredata"
+
+PureData.start(:port => 10002) do |pd|
+  # create canvas "sample.pd"
+  canvas = pd.canvas("sample")
+
+  # osc~ => *~ 0.1 => dac~
+  osc = canvas.obj("osc~", 440)
+  mul = canvas.obj("*~", 0.3)
+  dac = canvas.obj("dac~")
+  canvas.connect(osc.outlet, mul.inlet(0))
+  canvas.connect(mul.outlet, dac.left)
+  canvas.connect(mul.outlet, dac.right)
+
+  pd.dsp = true
+  sleep 3
+  pd.dsp = false
+
+  # add receive object for modify frequency of osc~
+  freq = canvas.obj("r", "freq")
+  line = canvas.obj("line")
+  canvas.connect(freq.outlet, line.inlet)
+  canvas.connect(line.outlet, osc.freq)
+
+  pd.dsp = true
+  pd.msg(:freq, 500, 4000)
+  puts "freq 500 4000"
+  sleep 3
+  pd.msg(:freq, 220, 5000)
+  puts "freq 220 5000"
+  sleep 5
+  pd.msg(:freq, 1000, 1000)
+  puts "freq 1000 1000"
+  sleep 1
+  pd.msg(:freq, 100, 50)
+  puts "freq 100 50"
+  sleep 1
+  pd.dsp = false
+end

data/example/save.rb

@@ -0,0 +1,21 @@
+require "puredata"
+
+Pd.start do |pd|
+  # create canvas "sample.pd"
+  canvas = pd.canvas("sample")
+
+  # osc~ => *~ 0.1 => dac~
+  osc = canvas.obj("osc~", 440)
+  mul = canvas.obj("*~", 0.3)
+  dac = canvas.obj("dac~")
+  canvas.connect(osc.outlet, mul.inlet(0))
+  canvas.connect(mul.outlet, dac.left)
+  canvas.connect(mul.outlet, dac.right)
+
+  # save canvas
+  canvas.save
+
+  # Canvas#save only messaging to Pd and there's no reply.
+  # So we can't confirm Pd save patch to file.
+  sleep 1
+end

data/lib/puredata.rb

@@ -0,0 +1,8 @@
+# vim:encoding=utf-8
+#
+# Ruby/PureData early scrach version.
+
+require "puredata/pd"
+require "puredata/canvas"
+require "puredata/connection"
+require "puredata/pdobject"

data/lib/puredata/canvas.rb

@@ -0,0 +1,98 @@
+# vim:encoding=utf-8
+#
+# Ruby/PureData Canvas, Abstraction class
+
+class PureData
+  class Canvas
+    def initialize(pd, name, opt={})
+      @pd = pd
+      @name = name.dup
+      unless /\.pd\Z/ =~ @name
+        @name += ".pd"
+      end
+      @dir = File.expand_path(opt[:dir] || Dir.pwd)
+      @pdobjid = 0
+      pos = opt[:position] || [100, 100]
+      size = opt[:size] || [300, 300]
+      font = opt[:font] || 10
+      pd.msg("pd", "filename", @name, @dir)
+      pd.msg("#N", "canvas #{pos.join(" ")} #{size.join(" ")} #{font}")
+      pd.msg("#X", "pop", "1")
+    end
+
+    def msg(*args)
+      @pd.msg("pd-#{@name}", *args)
+    end
+
+    def obj(klass, *args)
+      self.msg("obj", 10, 10, klass, *args)
+      id = @pdobjid
+      @pdobjid += 1
+      cls = PureData.dispatch_object_class(klass, *args)
+      cls.new(@pd, self, id, klass, *args)
+    end
+
+    def connect(outlet, inlet)
+      obj1, outletid = outlet.outlet_tuple
+      obj2, inletid = inlet.inlet_tuple
+      oid1 = obj1.pdobjid
+      oid2 = obj2.pdobjid
+      self.msg("connect", oid1, outletid, oid2, inletid)
+    end
+
+    def save(path=nil)
+      if path
+        name = File.basename(path)
+        unless /\.pd\Z/ =~ name
+          name += ".pd"
+        end
+        dir = File.expand_path(File.dirname(path))
+      else
+        name = @name
+        dir = @dir
+      end
+      self.msg("savetofile", name, dir)
+      @name = name
+      @dir = dir
+      nil
+    end
+  end
+
+  class Abstraction < Canvas
+    def initialize(pd, name, opt={})
+      super(pd, name, opt)
+      @inlets = []
+      @outlets = []
+    end
+
+    def inlet(idx=0)
+      @inlets[idx].outlet(0)
+    end
+
+    def outlet(idx=0)
+      @outlets[idx].inlet(0)
+    end
+
+    def add_inlet(audio=false)
+      if audio
+        @inlets << self.obj("inlet~")
+      else
+        @inlets << self.obj("inlet")
+      end
+    end
+
+    def add_outlet(audio=false)
+      if audio
+        @outlets << self.obj("outlet~")
+      else
+        @outlets << self.obj("outlet")
+      end
+    end
+
+    def self.create(pd, name, opt={})
+      abstract = self.new(pd, name, opt)
+      yield(abstract)
+      abstract.save
+    end
+  end
+end

data/lib/puredata/connection.rb

@@ -0,0 +1,67 @@
+# vim:encoding=utf-8
+#
+# PureData connection (inlet/outlet) control
+
+class PureData
+  class IOlet
+    def initialize(obj, idx=0)
+      @obj = obj
+      @idx = idx
+    end
+
+    attr_reader :idx
+
+    def canvas
+      @obj.canvas
+    end
+
+    def pdobjid
+      @obj.pdobjid
+    end
+
+    def name
+      @obj.name
+    end
+
+    def check_canvas(other)
+      unless @obj.canvas == other.canvas
+        raise "#{@obj.name} and #{other.name} must be in same canvas"
+      end
+    end
+
+    def pair
+      [@obj, @idx]
+    end
+  end
+
+  class Inlet < IOlet
+    def inlet_tuple
+      [@obj, @idx]
+    end
+
+    def <<(other)
+      if other.is_a?(PdObject)
+        other = other.outlet
+      end
+      check_canvas(other)
+      @obj.canvas.connect(other, self)
+      other
+    end
+  end
+
+  class Outlet < IOlet
+    def outlet_tuple
+      [@obj, @idx]
+    end
+
+    def >>(other)
+      if other.is_a?(PdObject)
+        other = other.inlet
+      end
+      check_canvas(other)
+      @obj.canvas.connect(self, other)
+      other
+    end
+  end
+
+end

data/lib/puredata/pd.rb

@@ -0,0 +1,132 @@
+# vim:encoding=utf-8
+#
+# Ruby/PureData early scrach version.
+
+require "socket"
+
+require "puredata/canvas"
+
+class PureData
+  case RUBY_PLATFORM
+  when /darwin/
+    @@pd_app_path = "/Applications/Pd-extended.app/Contents/Resources/bin/pd"
+  else
+    @@pd_app_path = nil
+  end
+
+  def self.start(opt={}, &blk)
+    pd = self.new(opt)
+    pd.fork_pd(opt)
+    pd.start(opt, &blk)
+  end
+
+  def self.attach(opt={}, &blk)
+    pd = self.new(opt)
+    pd.start(opt, &blk)
+  end
+
+  def initialize(opt={})
+    @portno = (opt[:port] || 10002).to_i
+  end
+
+  def fork_pd(opt={})
+    path = opt[:pd_app_path] || @@pd_app_path
+    pd_params = opt[:pd_params] || [] 
+    if path.nil? or not File.executable?(path)
+      raise "option :pd_app_path (Pd-extended executable) must be specified."
+    end
+    cmd = [
+      path,
+      pd_params,
+      "-nogui",
+      "-send", "pd filename ruby-pd.pd ./;",
+      "-send", "#N canvas 10 10 200 200 10;",
+      "-send", "#X pop 1;",
+      "-send", "pd-ruby-pd.pd obj 50 50 netreceive #{@portno} 0 old;",
+    ].flatten
+    @pid = fork do
+      Process.setsid
+      exec(*cmd)
+    end
+  end
+
+  def bind(opt={})
+    err = nil
+    200.times do
+      sleep 0.1
+      begin
+        @sock = TCPSocket.new("localhost", @portno)
+        break
+      rescue
+        err = $!
+      end
+    end
+    unless @sock
+      $stderr.puts("connect to localhost:#{@portno} failed")
+      raise err
+    end
+  end
+
+  def start(opt={}, &blk)
+    begin
+      bind(opt)
+      if blk
+        blk.call(self)
+      end
+    ensure
+      if blk
+        stop
+      end
+    end
+  end
+
+  def stop
+    if @sock
+      @sock.close unless @sock.closed?
+      @sock = nil
+    end
+
+    return if @pid.nil?
+
+    begin
+      Process.kill(:TERM, -@pid)
+    rescue Errno::ESRCH
+    rescue Errno::EPERM
+      raise "fail to kill process(#{@pid}): #{$!}"
+    end
+    Process.waitpid(@pid)
+  ensure
+    @sock = nil
+    @pid = nil
+  end
+
+  def msg(*args)
+    @sock.puts(args.map{|l| l.to_s}.join(" ") + ";")
+  end
+
+  def canvas(name, opt={})
+    Canvas.new(self, name, opt)
+  end
+
+  def abstraction(name, opt={}, &blk)
+    if blk
+      Abstraction.create(self, name, opt, &blk)
+    else
+      Abstraction.new(self, name, opt)
+    end
+  end
+
+  def dsp=(flag)
+    if flag
+      self.msg("pd", "dsp", 1)
+    else
+      self.msg("pd", "dsp", 0)
+    end
+  end
+
+  def quit
+    self.msg("pd", "quit")
+  end
+end
+
+Pd = PureData

data/lib/puredata/pdobject.rb

@@ -0,0 +1,9 @@
+# vim:encoding=utf-8
+#
+# Ruby/PureData Pd object wrapper classes
+
+require "puredata/pdobject/pdobject"
+require "puredata/pdobject/osc"
+require "puredata/pdobject/dac"
+require "puredata/pdobject/receive"
+

data/lib/puredata/pdobject/dac.rb

@@ -0,0 +1,16 @@
+# vim:encoding=utf-8
+#
+# dac~ object class
+
+class PureData
+  class Dac < PdObject
+    def left
+      inlet(0)
+    end
+    def right
+      inlet(1)
+    end
+  end
+end
+
+PureData.register_pdobject(PureData::Dac, "dac~")

data/lib/puredata/pdobject/osc.rb

@@ -0,0 +1,12 @@
+# vim:encoding=utf-8
+#
+# osc~ object class
+
+class PureData
+  class Osc < PdObject
+    def freq
+      inlet(0)
+    end
+  end
+end
+PureData.register_pdobject(PureData::Osc, "osc~")

data/lib/puredata/pdobject/pdobject.rb

@@ -0,0 +1,55 @@
+# vim:encoding=utf-8
+#
+# Ruby/PureData ojbect wrapper base class
+
+class PureData
+
+  @@pdclass = {}
+
+  def self.register_pdobject(klass, *names)
+    names.each do |n|
+      @@pdclass[n] = klass
+    end
+  end
+
+  def self.dispatch_object_class(klass, *args)
+    cls = @@pdclass[klass.to_s]
+    cls ||= PdObject
+    cls
+  end
+
+  class PdObject
+    def initialize(pd, canvas, pdobjid, name, *args)
+      @pd = pd
+      @canvas = canvas
+      @pdobjid = pdobjid
+      @name = name
+      @args = args
+    end
+    attr_reader :canvas, :pdobjid, :name
+
+    def inlet(idx=0)
+      Inlet.new(self, idx)
+    end
+
+    def inlet_pair
+      [self, 0]
+    end
+
+    def outlet(idx=0)
+      Outlet.new(self, idx)
+    end
+
+    def outlet_pair
+      [self, 0]
+    end
+
+    def <<(other)
+      self.inlet << other
+    end
+
+    def >>(other)
+      self.outlet >> other
+    end
+  end
+end

data/lib/puredata/pdobject/receive.rb

@@ -0,0 +1,13 @@
+# vim:encoding=utf-8
+#
+# receive object class
+
+class PureData
+  class Receive < PdObject
+    def msg(*args)
+      @pd.msg(@args[0], *args)
+    end
+  end
+end
+
+PureData.register_pdobject(PureData::Receive, "receive", "r")

data/lib/puredata/version.rb

@@ -0,0 +1,3 @@
+module Puredata
+  VERSION = "0.1.0"
+end

data/puredata.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puredata/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "puredata"
+  spec.version       = Puredata::VERSION
+  spec.authors       = ["CHIKANAGA Tomoyuki"]
+  spec.email         = ["nagachika00@gmail.com"]
+
+  spec.summary       = "Ruby library to manipulate PureData (Pd-extended) via socket."
+  spec.description   = "Ruby library to manipulate PureData (Pd-extended) via socket."
+  spec.homepage      = "https://github.com/nagachika/ruby-puredata"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: puredata
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- CHIKANAGA Tomoyuki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Ruby library to manipulate PureData (Pd-extended) via socket.
+email:
+- nagachika00@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- example/abstraction.rb
+- example/example.pd
+- example/example.rb
+- example/save.rb
+- lib/puredata.rb
+- lib/puredata/canvas.rb
+- lib/puredata/connection.rb
+- lib/puredata/pd.rb
+- lib/puredata/pdobject.rb
+- lib/puredata/pdobject/dac.rb
+- lib/puredata/pdobject/osc.rb
+- lib/puredata/pdobject/pdobject.rb
+- lib/puredata/pdobject/receive.rb
+- lib/puredata/version.rb
+- puredata.gemspec
+homepage: https://github.com/nagachika/ruby-puredata
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby library to manipulate PureData (Pd-extended) via socket.
+test_files: []