circuit_patch_tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 51b6d91974fadb28cedb4b53697392bb2d89997853ba2066c014ba867dc1a33c
+  data.tar.gz: d6d8a203ccb8dd9e536a1b4b79e9226fc347c9d1cd061c52ba990330de4fb1aa
+SHA512:
+  metadata.gz: 1d1dfc98ec4fb9dd344c54bde3d7c82efd9e73c8963dedc2a4f42dbdf8e16dbdedfd7f0c1afd5993b0b26c8a066dc10deb1a81a1ba6ecdcde62dc69787a51ad8
+  data.tar.gz: be3fd12bcbcdbf51c3673b837d6050f0c429464472a2fde35423ad49493c5675d365a76ca4c5500b98bdf68bd7f752d42f6cd5f6656c19c578b4ded695c94faa

data/.gitignore

@@ -0,0 +1,4 @@
+*.syx
+*.sysx
+*.sysex
+*.gem

data/LICENSE

@@ -0,0 +1,15 @@
+ISC License (ISC)
+
+Copyright 2019 Paul Battley
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,12 @@
+# Circuit Patch Tools
+
+Tools for manipulating Novation Circuit patches:
+
+- `split` an set of patches into individual files
+- make them `portable` so that they can be auditioned as the current patch
+- print `info` about a single patch file
+- `join` individual files into a bank
+
+## Installation
+
+    gem install circuit_patch_tools

data/bin/circuit-patch

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require 'circuit_patch_tools/commands'
+require 'optparse'
+
+handlers = CircuitPatchTools::Commands.handlers
+handler = handlers.find { |h| h.name == ARGV.first }
+if handler
+  handler.run ARGV.drop(1)
+else
+  OptionParser.new do |opts|
+    opts.banner = <<~END
+      circuit-patch
+
+      Usage: circuit-patch command [command-options] ...
+
+      Commands:
+      #{handlers.map { |c| "  #{c.name}" }.join("\n")}
+
+      Options:
+    END
+    opts.on('-h', '--help', 'Print this help') do
+    end
+    puts opts
+  end.parse!
+end

data/circuit_patch_tools.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "circuit_patch_tools/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "circuit_patch_tools"
+  spec.version       = CircuitPatchTools::VERSION
+  spec.authors       = ["Paul Battley"]
+  spec.email         = ["pbattley@gmail.com"]
+  spec.license          = "ISC"
+
+  spec.summary       = %q{Tools for manipulating Novation Circuit patches}
+  spec.homepage      = "https://github.com/threedaymonk/circuit_patch_tools"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/circuit_patch_tools/any.rb

@@ -0,0 +1,7 @@
+module CircuitPatchTools
+  class Any
+    def self.===(*)
+      true
+    end
+  end
+end

data/lib/circuit_patch_tools/attr_lookup.rb

@@ -0,0 +1,13 @@
+module CircuitPatchTools
+  module AttrLookup
+    def attr_lookup(ext, int, table)
+      define_method ext do
+        table.fetch(send(int))
+      end
+
+      define_method "#{ext}=" do |v|
+        send "#{int}=", table.index(v)
+      end
+    end
+  end
+end

data/lib/circuit_patch_tools/commands.rb

@@ -0,0 +1,12 @@
+require 'circuit_patch_tools/commands/info'
+require 'circuit_patch_tools/commands/join'
+require 'circuit_patch_tools/commands/portable'
+require 'circuit_patch_tools/commands/split'
+
+module CircuitPatchTools
+  module Commands
+    def self.handlers
+      @handlers ||= [Info, Join, Portable, Split].map(&:new)
+    end
+  end
+end

data/lib/circuit_patch_tools/commands/info.rb

@@ -0,0 +1,71 @@
+require 'circuit_patch_tools/patch'
+require 'optparse'
+
+module CircuitPatchTools
+  module Commands
+    class Info
+      FIELDS = %i[ path name command location genre category polyphony ]
+
+      DEFAULT_OPTIONS = {
+        fields: %w[ name genre category command location polyphony ]
+      }
+
+      def name
+        'info'
+      end
+
+      def description
+        'show patch information'
+      end
+
+      def run(args)
+        options = DEFAULT_OPTIONS.dup
+
+        OptionParser.new do |opts|
+          opts.banner = <<~END
+            #{name}: #{description}
+
+            Usage: circuit-patch #{name} [options] patch1.sysex [patch2.sysex ...]
+
+            Options:
+          END
+          opts.on('-fFIELDS', '--fields=FIELDS',
+                  'Comma-separated list of fields to show',
+                  "Default: #{DEFAULT_OPTIONS.fetch(:fields).join(',')}",
+                  Array) do |v|
+            options[:fields] = v
+          end
+          opts.on('-l', '--list', 'List available fields') do
+            puts *FIELDS
+          end
+          opts.on('-h', '--help', 'Print this help') do
+            puts opts
+            return
+          end
+        end.parse!(args)
+
+        args.each do |path|
+          show_info options, path
+        end
+      end
+
+    private
+      def show_info(options, path)
+        patch = Patch.open(path)
+        metadata = FIELDS.map { |f| [f.to_s, patch.send(f)] }.to_h
+        options.fetch(:fields).each do |k|
+          puts "#{k}: #{metadata.fetch(k)}"
+        end
+      end
+
+      class Patch < CircuitPatchTools::Patch
+        attr_accessor :path
+
+        def self.open(path)
+          raw = File.open(path, 'rb', encoding: Encoding::ASCII_8BIT).read
+          unpack(raw).tap { |p| p.path = path }
+        end
+      end
+    end
+  end
+end

data/lib/circuit_patch_tools/commands/join.rb

@@ -0,0 +1,60 @@
+require 'circuit_patch_tools/patch'
+require 'optparse'
+
+module CircuitPatchTools
+  module Commands
+    class Join
+      DEFAULT_OPTIONS = {
+        output: 'patches.sysex'
+      }
+
+      def name
+        'join'
+      end
+
+      def description
+        'join up to 64 patches into a single sysex file'
+      end
+
+      def run(args)
+        options = DEFAULT_OPTIONS.dup
+
+        OptionParser.new do |opts|
+          opts.banner = <<~END
+            #{name}: #{description}
+
+            Usage: circuit-patch #{name} [options] patch1.sysex [patch2.sysex ...]
+
+            Options:
+          END
+          opts.on('-oFILENAME', '--output=FILENAME',
+                  'Output filename',
+                  "Default: #{DEFAULT_OPTIONS[:output]}",
+                  String) do |v|
+            options[:output] = v
+          end
+          opts.on('-h', '--help', 'Print this help') do
+            puts opts
+            return
+          end
+        end.parse!(args)
+
+        join options, args
+      end
+
+    private
+      def join(options, paths)
+        output = options.fetch(:output)
+        File.open(output, 'wb', encoding: Encoding::ASCII_8BIT) do |f|
+          paths.each.with_index do |path, index|
+            raw = File.open(path, 'rb', encoding: Encoding::ASCII_8BIT).read
+            patch = Patch.unpack(raw)
+            patch.command = :replace_patch
+            patch.location = index
+            f << patch.pack
+          end
+        end
+      end
+    end
+  end
+end

data/lib/circuit_patch_tools/commands/portable.rb

@@ -0,0 +1,59 @@
+require 'circuit_patch_tools/patch'
+require 'optparse'
+
+module CircuitPatchTools
+  module Commands
+    class Portable
+      DEFAULT_OPTIONS = {
+        synth: 1
+      }
+
+      def name
+        'portable'
+      end
+
+      def description
+        'make patches portable'
+      end
+
+      def run(args)
+        options = DEFAULT_OPTIONS.dup
+
+        OptionParser.new do |opts|
+          opts.banner = <<~END
+            #{name}: #{description}
+
+            Usage: circuit-patch #{name} [options] patch1.sysex [patch2.sysex ...]
+
+            Options:
+          END
+          opts.on('-sSYNTH', '--synth=SYNTH',
+                  'Synth for the patch',
+                  "Default: #{DEFAULT_OPTIONS[:synth]}",
+                  Integer) do |v|
+            options[:synth] = v
+          end
+          opts.on('-h', '--help', 'Print this help') do
+            puts opts
+            return
+          end
+        end.parse!(args)
+
+        args.each do |path|
+          make_portable options, path
+        end
+      end
+
+    private
+      def make_portable(options, path)
+        raw = File.open(path, 'rb', encoding: Encoding::ASCII_8BIT).read
+        patch = Patch.unpack(raw)
+        patch.command = :replace_current_patch
+        patch.location = options.fetch(:synth) - 1
+        File.open(path, 'wb', encoding: Encoding::ASCII_8BIT) do |f|
+          f << patch.pack
+        end
+      end
+    end
+  end
+end

data/lib/circuit_patch_tools/commands/split.rb

@@ -0,0 +1,73 @@
+require 'circuit_patch_tools/patch'
+require 'optparse'
+
+module CircuitPatchTools
+  module Commands
+    class Split
+      FIELDS = %i[ name command location genre category polyphony ]
+
+      DEFAULT_OPTIONS = {
+        filename: '%<location>02d - %<name>s.sysex'
+      }
+
+      PATCH_REGEXP = /\xF0\x00\x20\x29\x01\x60[\x00-\xFF]{343}\xF7/n
+
+      def name
+        'split'
+      end
+
+      def description
+        'extract patches from a single sysex file into one file per patch'
+      end
+
+      def run(args)
+        options = DEFAULT_OPTIONS.dup
+
+        OptionParser.new do |opts|
+          opts.banner = <<~END
+            #{name}: #{description}
+
+            Usage: circuit-patch #{name} [options] patch1.sysex [patch2.sysex ...]
+
+            Options:
+          END
+          opts.on('-fPATTERN', '--filename=PATTERN',
+                  'Pattern for filenames',
+                  "Default: #{DEFAULT_OPTIONS[:filename].inspect}",
+                  String) do |v|
+            options[:filename] = v
+          end
+          opts.on('-h', '--help', 'Print this help') do
+            puts opts
+            return
+          end
+        end.parse!(args)
+
+        extract_all options, args
+      end
+
+    private
+      def extract_all(options, paths)
+        paths.each do |path|
+          File.open(path, 'rb', encoding: Encoding::ASCII_8BIT)
+            .read
+            .scan(PATCH_REGEXP).each do |raw|
+              extract_one options, raw
+            end
+        end
+      end
+
+      def extract_one(options, raw)
+        patch = Patch.unpack(raw)
+
+        metadata = FIELDS.map { |f| [f, patch.send(f)] }.to_h
+        filename = format(options.fetch(:filename), metadata)
+
+        $stderr.puts filename
+        File.open(filename, 'wb', encoding: Encoding::ASCII_8BIT) do |f|
+          f << raw
+        end
+      end
+    end
+  end
+end

data/lib/circuit_patch_tools/patch.rb

@@ -0,0 +1,80 @@
+require 'circuit_patch_tools/attr_lookup'
+require 'circuit_patch_tools/any'
+
+module CircuitPatchTools
+  class Patch
+    extend AttrLookup
+
+    SYSEX = [
+      ['C',    :sysex,                0xF0],
+      ['C',    :manufacturer_1,       0x00],
+      ['C',    :manufacturer_2,       0x20],
+      ['C',    :manufacturer_3,       0x29],
+      ['C',    :product_type,         0x01],
+      ['C',    :product_number,       0x60],
+      ['C',    :command,              0..1],
+      ['C',    :location,             0..63],
+      ['C',    :reserved,             Any],
+      ['A16',  :patch_name,           Any],
+      ['C',    :patch_category,       0..14],
+      ['C',    :patch_genre,          0..9],
+      ['a14',  :patch_reserved,       Any],
+      ['C',    :voice_polyphony_mode, 0..2],
+      ['a307', :patch_settings,       Any],
+      ['C',    :eox,                  0xF7]
+    ]
+
+    PATTERN = SYSEX.map { |a, _, _| a }.join('')
+    FIELDS  = SYSEX.map { |_, a, _| a }
+
+    POLYPHONY = %i[ mono mono_ag poly ]
+    GENRES = %i[
+      none classic drumbass house industrial jazz randb rock techno dubstep
+    ]
+    CATEGORIES = %i[
+      none arp bass bell classic drum keyboard lead movement pad poly sfx
+      string user voc
+    ]
+    COMMANDS = %i[ replace_current_patch replace_patch ]
+
+    def self.unpack(raw)
+      values = raw.unpack(PATTERN)
+
+      values.zip(SYSEX).each do |v, (_, name, validator)|
+        unless validator === v
+          raise "#{name}: #{v.inspect} does not satisfy #{validator.inspect}"
+        end
+      end
+
+      new(FIELDS.zip(values).to_h)
+    end
+
+    def initialize(parameter_hash)
+      @parameters = parameter_hash
+    end
+
+    def pack
+      FIELDS.map { |f| @parameters[f] }.pack(PATTERN)
+    end
+
+    FIELDS.each do |f|
+      define_method "_#{f}" do
+        @parameters.fetch(f)
+      end
+
+      define_method "_#{f}=" do |v|
+        @parameters[f] = v
+      end
+    end
+
+    alias_method :name, :_patch_name
+    alias_method :name=, :_patch_name=
+    alias_method :location, :_location
+    alias_method :location=, :_location=
+
+    attr_lookup :polyphony, :_voice_polyphony_mode, POLYPHONY
+    attr_lookup :genre, :_patch_genre, GENRES
+    attr_lookup :category, :_patch_category, CATEGORIES
+    attr_lookup :command, :_command, COMMANDS
+  end
+end

data/lib/circuit_patch_tools/version.rb

@@ -0,0 +1,3 @@
+module CircuitPatchTools
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: circuit_patch_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Battley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-01 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- pbattley@gmail.com
+executables:
+- circuit-patch
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- bin/circuit-patch
+- circuit_patch_tools.gemspec
+- lib/circuit_patch_tools/any.rb
+- lib/circuit_patch_tools/attr_lookup.rb
+- lib/circuit_patch_tools/commands.rb
+- lib/circuit_patch_tools/commands/info.rb
+- lib/circuit_patch_tools/commands/join.rb
+- lib/circuit_patch_tools/commands/portable.rb
+- lib/circuit_patch_tools/commands/split.rb
+- lib/circuit_patch_tools/patch.rb
+- lib/circuit_patch_tools/version.rb
+homepage: https://github.com/threedaymonk/circuit_patch_tools
+licenses:
+- ISC
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Tools for manipulating Novation Circuit patches
+test_files: []