midi-mmc 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d1f6f968a7a654593b58147b5347d2af79dbac47d35af39d7f7a0c7e1e96395
+  data.tar.gz: 3620e420346df8b561ed93091b350b1fb688887814d3a777d1e74d13b19212d2
+SHA512:
+  metadata.gz: '09b2811ad251e3f939eb649cdd578ca8d99032cab1f56a70b823d9f601c564c2c08da980df5bb8063919b3436fe46863b245005b6b5815a7730e7b7176158b85'
+  data.tar.gz: d79f2cae94aaaade3d1f65b0330b0d7cf0e1cf2c87355d481240e664cae77468099042f08a6017dde21577cd8bd20975e6d09226ed61cf479bb5f50afaecb162

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,49 @@
+# MIDI::MMC
+
+This is a Ruby gem to facilitate controlling MIDI devices using the [MIDI Machine Control](https://en.wikipedia.org/wiki/MIDI_Machine_Control) protocol.
+
+
+## Features
+
+- Implements the common MMC commands, including transport (stop, play, record, etc.) and track arming.
+
+
+## Limitations
+
+- Does not handle any command responses, whether status (like timecode) or errors.
+- Does not implement full MMC specification.
+
+
+## Usage
+
+```ruby
+require 'midi-mmc'
+require 'unimidi'
+
+# set up
+midi_output = UniMIDI::Output.gets
+mmc = MIDI::MMC.new(output: midi_output)
+mmc.reset
+
+# record
+mmc.goto_zero
+mmc.arm_tracks(1)
+# record something here
+mmc.stop
+mmc.arm_tracks(nil)
+
+# play back
+mmc.goto_zero
+mmc.play
+```
+
+
+## Requirements
+
+MIDI::MMC is designed to work with the [unimidi](http://github.com/arirusso/unimidi) gem, although any object passed in the `output` parameter to `MIDI::MMC.new` that responds to the `#puts` method can be used.
+
+
+## References
+
+- [Complete MIDI 1.0 Detailed Specification (1996, from archive.org)](https://archive.org/details/Complete_MIDI_1.0_Detailed_Specification_96-1-3)
+- [MIDI Machine Control (Wikipedia)](https://en.wikipedia.org/wiki/MIDI_Machine_Control)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+Bundler.require
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*test.rb']
+end
+
+task :default => :test

data/TODO.md

@@ -0,0 +1,4 @@
+# TODO
+
+- Implement other MMC commands.
+- Implement monitoring/reading, to get responses.

data/lib/midi-mmc.rb

@@ -0,0 +1,190 @@
+module MIDI
+
+  class MMC
+
+    attr_accessor :output
+    attr_accessor :device_id
+
+    DEVICE_ID_ALL = 0x7F
+
+    TYPES = {
+      command:        0x06,
+      response:       0x07,
+    }
+
+    COMMANDS = {
+      stop:           0x01,
+      play:           0x02,
+      deferred_play:  0x03,
+      fast_forward:   0x04,
+      rewind:         0x05,
+      record_strobe:  0x06,
+      record_exit:    0x07,
+      record_pause:   0x08,
+      pause:          0x09,
+      eject:          0x0A,
+      chase:          0x0B,
+      reset:          0x0D,
+      write:          0x40,
+      locate:         0x44,
+      shuttle:        0x47,
+    }
+
+    WRITE_MODES = {
+      record_ready:   0x4F,
+      sync_monitor:   0x52,
+      input_monitor:  0x53,
+      mute:           0x62,
+    }
+
+    def initialize(output: nil, device_id: nil, debug: nil)
+      @output = output
+      @device_id = device_id || DEVICE_ID_ALL
+      @debug = debug
+    end
+
+    def stop
+      send_command_message(:stop)
+    end
+
+    def play
+      send_command_message(:play)
+    end
+
+    def deferred_play
+      send_command_message(:deferred_play)
+    end
+
+    def fast_forward
+      send_command_message(:fast_forward)
+    end
+
+    def rewind
+      send_command_message(:rewind)
+    end
+
+    def record_strobe
+      send_command_message(:record_strobe)
+    end
+    alias_method :punch_in, :record_strobe
+
+    def record_exit
+      send_command_message(:record_exit)
+    end
+    alias_method :punch_out, :record_exit
+
+    def record_pause
+      send_command_message(:record_pause)
+    end
+
+    def pause
+      send_command_message(:pause)
+    end
+
+    def eject
+      send_command_message(:eject)
+    end
+
+    def chase
+      send_command_message(:chase)
+    end
+
+    def reset
+      send_command_message(:reset)
+    end
+
+    def arm_tracks(tracks)
+      tracks = case tracks
+      when nil
+        []
+      when Numeric
+        [tracks]
+      when Range
+        tracks.to_a
+      when Array
+        tracks
+      else
+        raise
+      end
+      bytes = track_bitmap_bytes(tracks)
+      track_bitmap = [bytes.length, *bytes]
+      mode_id = WRITE_MODES[:record_ready] or raise
+      send_command_message(:write, track_bitmap.length, mode_id, *track_bitmap)
+    end
+    alias_method :record_ready, :arm_tracks
+
+    def locate(location)
+      send_command_message(:locate, 0x06, 0x01, *location, wait: 1)
+    end
+    alias_method :goto, :locate
+
+    def locate_zero
+      locate([0, 0, 0, 0, 0])
+    end
+    alias_method :goto_zero, :locate_zero
+
+    def shuffle
+      send_command_message(:shuffle)
+    end
+
+    def message_to_str(msg)
+      msg.map { |b| '%02X' % b }.join(' ')
+    end
+
+    private
+
+    def send_command_message(command, *elements, wait: nil)
+      id = COMMANDS[command] or raise
+      msg = [0xF0, 0x7F, @device_id, TYPES[:command], id, *elements, 0xF7]
+      if @debug
+        warn "%-15s >>> %s" % [command, message_to_str(msg)]
+      end
+      @output.puts(msg) if @output
+      sleep(wait) if wait
+      msg
+    end
+
+    TRACK_BITMAP = {
+       1 => [0, 0x20],
+       2 => [0, 0x40],
+
+       3 => [1, 0x01],
+       4 => [1, 0x02],
+       5 => [1, 0x04],
+       6 => [1, 0x08],
+       7 => [1, 0x10],
+       8 => [1, 0x20],
+       9 => [1, 0x40],
+
+      10 => [2, 0x01],
+      11 => [2, 0x02],
+      12 => [2, 0x04],
+      13 => [2, 0x08],
+      14 => [2, 0x10],
+      15 => [2, 0x20],
+      16 => [2, 0x40],
+
+      17 => [3, 0x01],
+      18 => [3, 0x02],
+      19 => [3, 0x04],
+      20 => [3, 0x08],
+      21 => [3, 0x10],
+      22 => [3, 0x20],
+      23 => [3, 0x40],
+
+      24 => [4, 0x01],
+    }
+
+    def track_bitmap_bytes(tracks)
+      bytes = [0, 0, 0, 0, 0]
+      tracks.each do |track|
+        spec = TRACK_BITMAP[track] or raise "Track out of range: #{track.inspect}"
+        byte_idx, bits = *spec
+        bytes[byte_idx] += bits
+      end
+      bytes
+    end
+
+  end
+
+end

data/midi-mmc.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |gem|
+  gem.name          = 'midi-mmc'
+  gem.version       = '0.1'
+  gem.authors       = 'John Labovitz'
+  gem.email         = 'johnl@johnlabovitz.com'
+  gem.summary       = %q{Perform MIDI Machine Control (MMC)}
+  gem.description   = %q{Perform MIDI Machine Control (MMC).}
+  gem.homepage      = 'https://github.com/jslabovitz/midi-mmc.git'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'bundler', '~> 2.5'
+  gem.add_development_dependency 'minitest', '~> 5.23'
+  gem.add_development_dependency 'minitest-power_assert', '~> 0.3'
+  gem.add_development_dependency 'rake', '~> 13.2'
+  gem.add_development_dependency 'unimidi', '~> 0.5'
+end

data/test/test.rb

@@ -0,0 +1,28 @@
+$VERBOSE = false
+
+require 'minitest/autorun'
+require 'minitest/power_assert'
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'midi-mmc'
+
+class MIDI::MMC::Test < Minitest::Test
+
+  def test_simple
+    mmc = MIDI::MMC.new
+    steps = [
+      [ proc { mmc.reset            }, 'F0 7F 7F 06 0D F7'                          ],
+      [ proc { mmc.goto_zero        }, 'F0 7F 7F 06 44 06 01 00 00 00 00 00 F7'     ],
+      [ proc { mmc.arm_tracks(1)    }, 'F0 7F 7F 06 40 06 4F 05 20 00 00 00 00 F7'  ],
+      [ proc { mmc.stop             }, 'F0 7F 7F 06 01 F7'                          ],
+      [ proc { mmc.arm_tracks(nil)  }, 'F0 7F 7F 06 40 06 4F 05 00 00 00 00 00 F7'  ],
+      [ proc { mmc.goto_zero        }, 'F0 7F 7F 06 44 06 01 00 00 00 00 00 F7'     ],
+      [ proc { mmc.play             }, 'F0 7F 7F 06 02 F7'                          ],
+    ]
+    steps.each do |step, expected_output|
+      output = mmc.message_to_str(step.call)
+      assert { output == expected_output }
+    end
+  end
+
+end

data/tools/example

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'midi-mmc'
+require 'unimidi'
+
+# set up
+midi_output = UniMIDI::Output.gets
+mmc = MIDI::MMC.new(output: midi_output)
+mmc.reset
+
+# record
+mmc.goto_zero
+mmc.arm_tracks(1)
+# record something here
+mmc.stop
+mmc.arm_tracks(nil)
+
+# play back
+mmc.goto_zero
+mmc.play

data/tools/test-track-arming

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+#
+# This script exercises the 'arm tracks' MMC command, in order to determine
+# the proper track bitmap.
+#
+
+require 'unimidi'
+
+require_relative '../lib/midi-mmc'
+
+midi_output = UniMIDI::Output.gets
+mmc = MIDI::MMC.new(output: midi_output, debug: true)
+
+mmc.reset
+
+begin
+  1.upto(24).each do |track|
+    mmc.write(nil)
+    msg = mmc.arm_tracks(track)
+    pp(track => msg)
+    gets
+  end
+ensure
+  mmc.arm_tracks(nil)
+  mmc.reset
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: midi-mmc
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- John Labovitz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.23'
+- !ruby/object:Gem::Dependency
+  name: minitest-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: unimidi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Perform MIDI Machine Control (MMC).
+email: johnl@johnlabovitz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- TODO.md
+- lib/midi-mmc.rb
+- midi-mmc.gemspec
+- test/test.rb
+- tools/example
+- tools/test-track-arming
+homepage: https://github.com/jslabovitz/midi-mmc.git
+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: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Perform MIDI Machine Control (MMC)
+test_files:
+- test/test.rb