patchmaster 0.0.0

data/lib/patchmaster/consts.rb

@@ -0,0 +1,439 @@
+# MIDI and PatchMaster constants.
+module PM
+
+  # Define MIDI note names C0 - B10
+  (0..10).each { |oct|
+    {:C => 0, :D => 2, :E => 4, :F => 5, :G => 7, :A => 9, :B => 11}.each { |note,val|
+      base = (oct+1) * 12 + val
+      eval <<EOS
+#{note}f#{oct} = #{base - 1}
+#{note}b#{oct} = #{base - 1}
+#{note}#{oct} = #{base}
+#{note}s#{oct} = #{base + 1}
+EOS
+    }
+  }
+
+  # Number of MIDI channels
+  MIDI_CHANNELS = 16
+  # Number of note per MIDI channel
+  NOTES_PER_CHANNEL = 128
+
+  #--
+  # Standard MIDI File meta event defs.
+  #++
+  META_EVENT = 0xff
+  META_SEQ_NUM = 0x00
+  META_TEXT = 0x01
+  META_COPYRIGHT = 0x02
+  META_SEQ_NAME = 0x03
+  META_INSTRUMENT = 0x04
+  META_LYRIC = 0x05
+  META_MARKER = 0x06
+  META_CUE = 0x07
+  META_MIDI_CHAN_PREFIX = 0x20
+  META_TRACK_END = 0x2f
+  META_SET_TEMPO = 0x51
+  META_SMPTE = 0x54
+  META_TIME_SIG = 0x58
+  META_PATCH_SIG = 0x59
+  META_SEQ_SPECIF = 0x7f
+
+  #--
+  # Channel messages
+  #++
+  # Note, val
+  NOTE_OFF = 0x80
+  # Note, val
+  NOTE_ON = 0x90
+  # Note, val
+  POLY_PRESSURE = 0xA0
+  # Controller #, val
+  CONTROLLER = 0xB0
+  # Program number
+  PROGRAM_CHANGE = 0xC0
+  # Channel pressure
+  CHANNEL_PRESSURE = 0xD0
+  # LSB, MSB
+  PITCH_BEND = 0xE0
+
+  #--
+  # System common messages
+  #++
+  # System exclusive start
+  SYSEX = 0xF0
+  # Beats from top: LSB/MSB 6 ticks = 1 beat
+  SONG_POINTER = 0xF2
+  # Val = number of song
+  SONG_SELECT = 0xF3
+  # Tune request
+  TUNE_REQUEST = 0xF6
+  # End of system exclusive
+  EOX = 0xF7
+
+  #--
+  # System realtime messages
+  #++
+  # MIDI clock (24 per quarter note)
+  CLOCK = 0xF8
+  # Sequence start
+  START = 0xFA
+  # Sequence continue
+  CONTINUE = 0xFB
+  # Sequence stop
+  STOP = 0xFC
+  # Active sensing (sent every 300 ms when nothing else being sent)
+  ACTIVE_SENSE = 0xFE
+  # System reset
+  SYSTEM_RESET = 0xFF
+
+  # Controller numbers
+  # = 0 - 31 = continuous, LSB
+  # = 32 - 63 = continuous, MSB
+  # = 64 - 97 = switches
+  CC_MOD_WHEEL = 1
+  CC_BREATH_CONTROLLER = 2
+  CC_FOOT_CONTROLLER = 4
+  CC_PORTAMENTO_TIME = 5
+  CC_DATA_ENTRY_MSB = 6
+  CC_VOLUME = 7
+  CC_BALANCE = 8
+  CC_PAN = 10
+  CC_EXPRESSION_CONTROLLER = 11
+  CC_GEN_PURPOSE_1 = 16
+  CC_GEN_PURPOSE_2 = 17
+  CC_GEN_PURPOSE_3 = 18
+  CC_GEN_PURPOSE_4 = 19
+
+  # [32 - 63] are LSB for [0 - 31]
+  CC_DATA_ENTRY_LSB = 38
+
+  #--
+  # Momentaries:
+  #++
+  CC_SUSTAIN = 64
+  CC_PORTAMENTO = 65
+  CC_SUSTENUTO = 66
+  CC_SOFT_PEDAL = 67
+  CC_HOLD_2 = 69
+  CC_GEN_PURPOSE_5 = 50
+  CC_GEN_PURPOSE_6 = 51
+  CC_GEN_PURPOSE_7 = 52
+  CC_GEN_PURPOSE_8 = 53
+  CC_TREMELO_DEPTH = 92
+  CC_CHORUS_DEPTH = 93
+  CC_DETUNE_DEPTH = 94
+  CC_PHASER_DEPTH = 95
+  CC_DATA_INCREMENT = 96
+  CC_DATA_DECREMENT = 97
+  CC_NREG_PARAM_LSB = 98
+  CC_NREG_PARAM_MSB = 99
+  CC_REG_PARAM_LSB = 100
+  CC_REG_PARAM_MSB = 101
+
+  #--
+  # Channel mode message values
+  #++
+  # Val 0 == off, 0x7f == on
+  CM_LOCAL_CONTROL = 0x7A
+  CM_ALL_NOTES_OFF = 0x7B       # Val must be 0
+  CM_OMNI_MODE_OFF = 0x7C       # Val must be 0
+  CM_OMNI_MODE_ON = 0x7D        # Val must be 0
+  CM_MONO_MODE_ON = 0x7E        # Val = # chans
+  CM_POLY_MODE_ON = 0x7F        # Val must be 0
+
+  # Controller names
+  CONTROLLER_NAMES = [
+    "0",
+    "Modulation",
+    "Breath Control",
+    "3",
+    "Foot Controller",
+    "Portamento Time",
+    "Data Entry",
+    "Volume",
+    "Balance",
+    "9",
+    "Pan",
+    "Expression Control",
+    "12", "13", "14", "15",
+    "General Controller 1",
+    "General Controller 2",
+    "General Controller 3",
+    "General Controller 4",
+    "20", "21", "22", "23", "24", "25", "26", "27", "28", "29",
+    "30", "31",
+    "32", "33", "34", "35", "36", "37", "38", "39", "40", "41",
+    "42", "43", "44", "45", "46", "47", "48", "49", "50", "51",
+    "52", "53", "54", "55", "56", "57", "58", "59", "60", "61",
+    "62", "63",
+    "Sustain Pedal",
+    "Portamento",
+    "Sostenuto",
+    "Soft Pedal",
+    "68",
+    "Hold 2",
+    "70", "71", "72", "73", "74", "75", "76", "77", "78", "79",
+    "General Controller 5",
+    "Tempo Change",
+    "General Controller 7",
+    "General Controller 8",
+    "84", "85", "86", "87", "88", "89", "90",
+    "External Effects Depth",
+    "Tremolo Depth",
+    "Chorus Depth",
+    "Detune (Celeste) Depth",
+    "Phaser Depth",
+    "Data Increment",
+    "Data Decrement",
+    "Non-Registered Param LSB",
+    "Non-Registered Param MSB",
+    "Registered Param LSB",
+    "Registered Param MSB",
+    "102", "103", "104", "105", "106", "107", "108", "109",
+    "110", "111", "112", "113", "114", "115", "116", "117",
+    "118", "119", "120",
+    "Reset All Controllers",
+    "Local Control",
+    "All Notes Off",
+    "Omni Mode Off",
+    "Omni Mode On",
+    "Mono Mode On",
+    "Poly Mode On"
+  ]
+
+  # General MIDI patch names
+  GM_PATCH_NAMES = [
+    #--
+    # Pianos
+    #++
+    "Acoustic Grand Piano",
+    "Bright Acoustic Piano",
+    "Electric Grand Piano",
+    "Honky-tonk Piano",
+    "Electric Piano 1",
+    "Electric Piano 2",
+    "Harpsichord",
+    "Clavichord",
+    #--
+    # Tuned Idiophones
+    #++
+    "Celesta",
+    "Glockenspiel",
+    "Music Box",
+    "Vibraphone",
+    "Marimba",
+    "Xylophone",
+    "Tubular Bells",
+    "Dulcimer",
+    #--
+    # Organs
+    #++
+    "Drawbar Organ",
+    "Percussive Organ",
+    "Rock Organ",
+    "Church Organ",
+    "Reed Organ",
+    "Accordion",
+    "Harmonica",
+    "Tango Accordion",
+    #--
+    # Guitars
+    #++
+    "Acoustic Guitar (nylon)",
+    "Acoustic Guitar (steel)",
+    "Electric Guitar (jazz)",
+    "Electric Guitar (clean)",
+    "Electric Guitar (muted)",
+    "Overdriven Guitar",
+    "Distortion Guitar",
+    "Guitar harmonics",
+    #--
+    # Basses
+    #++
+    "Acoustic Bass",
+    "Electric Bass (finger)",
+    "Electric Bass (pick)",
+    "Fretless Bass",
+    "Slap Bass 1",
+    "Slap Bass 2",
+    "Synth Bass 1",
+    "Synth Bass 2",
+    #--
+    # Strings
+    #++
+    "Violin",
+    "Viola",
+    "Cello",
+    "Contrabass",
+    "Tremolo Strings",
+    "Pizzicato Strings",
+    "Orchestral Harp",
+    "Timpani",
+    #--
+    # Ensemble strings and voices
+    #++
+    "String Ensemble 1",
+    "String Ensemble 2",
+    "SynthStrings 1",
+    "SynthStrings 2",
+    "Choir Aahs",
+    "Voice Oohs",
+    "Synth Voice",
+    "Orchestra Hit",
+    #--
+    # Brass
+    #++
+    "Trumpet",
+    "Trombone",
+    "Tuba",
+    "Muted Trumpet",
+    "French Horn",
+    "Brass Section",
+    "SynthBrass 1",
+    "SynthBrass 2",
+    #--
+    # Reeds
+    #++
+    "Soprano Sax",              # 64
+    "Alto Sax",
+    "Tenor Sax",
+    "Baritone Sax",
+    "Oboe",
+    "English Horn",
+    "Bassoon",
+    "Clarinet",
+    #--
+    # Pipes
+    #++
+    "Piccolo",
+    "Flute",
+    "Recorder",
+    "Pan Flute",
+    "Blown Bottle",
+    "Shakuhachi",
+    "Whistle",
+    "Ocarina",
+    #--
+    # Synth Leads
+    #++
+    "Lead 1 (square)",
+    "Lead 2 (sawtooth)",
+    "Lead 3 (calliope)",
+    "Lead 4 (chiff)",
+    "Lead 5 (charang)",
+    "Lead 6 (voice)",
+    "Lead 7 (fifths)",
+    "Lead 8 (bass + lead)",
+    #--
+    # Synth Pads
+    #++
+    "Pad 1 (new age)",
+    "Pad 2 (warm)",
+    "Pad 3 (polysynth)",
+    "Pad 4 (choir)",
+    "Pad 5 (bowed)",
+    "Pad 6 (metallic)",
+    "Pad 7 (halo)",
+    "Pad 8 (sweep)",
+    #--
+    # Effects
+    #++
+    "FX 1 (rain)",
+    "FX 2 (soundtrack)",
+    "FX 3 (crystal)",
+    "FX 4 (atmosphere)",
+    "FX 5 (brightness)",
+    "FX 6 (goblins)",
+    "FX 7 (echoes)",
+    "FX 8 (sci-fi)",
+    #--
+    # Ethnic
+    #++
+    "Sitar",
+    "Banjo",
+    "Shamisen",
+    "Koto",
+    "Kalimba",
+    "Bag pipe",
+    "Fiddle",
+    "Shanai",
+    #--
+    # Percussion
+    #++
+    "Tinkle Bell",
+    "Agogo",
+    "Steel Drums",
+    "Woodblock",
+    "Taiko Drum",
+    "Melodic Tom",
+    "Synth Drum",
+    "Reverse Cymbal",
+    #--
+    # Sound Effects
+    #++
+    "Guitar Fret Noise",
+    "Breath Noise",
+    "Seashore",
+    "Bird Tweet",
+    "Telephone Ring",
+    "Helicopter",
+    "Applause",
+    "Gunshot"
+  ]
+
+  # GM drum notes start at 35 (C), so subtrack GM_DRUM_NOTE_LOWEST from your
+  # note number before using this array.
+  GM_DRUM_NOTE_LOWEST = 35
+  # General MIDI drum channel note names.
+  GM_DRUM_NOTE_NAMES = [
+    "Acoustic Bass Drum",       # 35, C
+    "Bass Drum 1",              # 36, C#
+    "Side Stick",               # 37, D
+    "Acoustic Snare",           # 38, D#
+    "Hand Clap",                # 39, E
+    "Electric Snare",           # 40, F
+    "Low Floor Tom",            # 41, F#
+    "Closed Hi Hat",            # 42, G
+    "High Floor Tom",           # 43, G#
+    "Pedal Hi-Hat",             # 44, A
+    "Low Tom",                  # 45, A#
+    "Open Hi-Hat",              # 46, B
+    "Low-Mid Tom",              # 47, C
+    "Hi Mid Tom",               # 48, C#
+    "Crash Cymbal 1",           # 49, D
+    "High Tom",                 # 50, D#
+    "Ride Cymbal 1",            # 51, E
+    "Chinese Cymbal",           # 52, F
+    "Ride Bell",                # 53, F#
+    "Tambourine",               # 54, G
+    "Splash Cymbal",            # 55, G#
+    "Cowbell",                  # 56, A
+    "Crash Cymbal 2",           # 57, A#
+    "Vibraslap",                # 58, B
+    "Ride Cymbal 2",            # 59, C
+    "Hi Bongo",                 # 60, C#
+    "Low Bongo",                # 61, D
+    "Mute Hi Conga",            # 62, D#
+    "Open Hi Conga",            # 63, E
+    "Low Conga",                # 64, F
+    "High Timbale",             # 65, F#
+    "Low Timbale",              # 66, G
+    "High Agogo",               # 67, G#
+    "Low Agogo",                # 68, A
+    "Cabasa",                   # 69, A#
+    "Maracas",                  # 70, B
+    "Short Whistle",            # 71, C
+    "Long Whistle",             # 72, C#
+    "Short Guiro",              # 73, D
+    "Long Guiro",               # 74, D#
+    "Claves",                   # 75, E
+    "Hi Wood Block",            # 76, F
+    "Low Wood Block",           # 77, F#
+    "Mute Cuica",               # 78, G
+    "Open Cuica",               # 79, G#
+    "Mute Triangle",            # 80, A
+    "Open Triangle"             # 81, A#
+  ]
+
+end # PM

data/lib/patchmaster/dsl.rb

@@ -0,0 +1,227 @@
+require 'unimidi'
+
+module PM
+
+# Implements a DSL for describing a PatchMaster setup.
+class DSL
+
+  include PM
+
+  def initialize(no_midi=false)
+    @no_midi = no_midi
+    @pm = PatchMaster.instance
+  end
+
+  def load(file)
+    contents = IO.read(file)
+    @filters = []
+    instance_eval(contents)
+    read_filters(contents)
+  end
+
+  def input(port_num, sym, name=nil)
+    @pm.inputs[sym] = InputDevice.new(name || sym.to_s, port_num, @no_midi)
+  rescue => ex
+    raise "error creating input device \"#{name}\" on input port #{port_num}: #{ex}"
+  end
+  alias_method :in, :input
+
+  def output(port_num, sym, name=nil)
+    @pm.outputs[sym] = OutputDevice.new(name || sym.to_s, port_num, @no_midi)
+  rescue => ex
+    raise "error creating output device \"#{name}\" on output port #{port_num}: #{ex}"
+  end
+  alias_method :out, :output
+
+  def song(name)
+    @song = Song.new(name)      # ctor saves into @pm.all_songs
+    yield @song if block_given?
+  end
+
+  def patch(name)
+    @patch = Patch.new(name)
+    @song << @patch
+    yield @patch if block_given?
+  end
+
+  def start_bytes(bytes)
+    @patch.start_bytes = bytes
+  end
+
+  def connection(in_sym, in_chan, out_sym, out_chan)
+    input = @pm.inputs[in_sym]
+    raise "can't find input instrument #{in_sym}" unless input
+    output = @pm.outputs[out_sym]
+    raise "can't find outputput instrument #{out_sym}" unless output
+
+    @conn = Connection.new(input, in_chan, output, out_chan)
+    @patch << @conn
+    yield @conn if block_given?
+  end
+  alias_method :conn, :connection
+  alias_method :c, :connection
+
+  def prog_chg(prog)
+    @conn.pc_prog = prog
+  end
+  alias_method :pc, :prog_chg
+
+  # If +start_or_range+ is a Range, use that. Else either or both params may
+  # be nil.
+  def zone(start_or_range=nil, stop=nil)
+    @conn.zone = if start_or_range.kind_of? Range
+                         start_or_range
+                       elsif start_or_range == nil && stop == nil
+                         nil
+                       else
+                         ((start_or_range || 0) .. (stop || 127))
+                       end
+  end
+  alias_method :z, :zone
+
+  def transpose(xpose)
+    @conn.xpose = xpose
+  end
+  alias_method :xpose, :transpose
+  alias_method :x, :transpose
+
+  def filter(&block)
+    @conn.filter = Filter.new(block)
+    @filters << @conn.filter
+  end
+  alias_method :f, :filter
+
+  def song_list(name, song_names)
+    sl = SongList.new(name)
+    @pm.song_lists << sl
+    song_names.each do |sn|
+      song = @pm.all_songs.find(sn)
+      raise "song \"#{sn}\" not found (song list \"#{name}\")" unless song
+      sl << song
+    end
+  end
+
+  # ****************************************************************
+
+  def save(file)
+    File.open(file, 'w') { |f|
+      save_instruments(f)
+      save_songs(f)
+      save_song_lists(f)
+    }
+  end
+
+  def save_instruments(f)
+    @pm.inputs.each { |sym, instr|
+      f.puts "input #{instr.port_num}, :#{sym}, #{quoted(instr.name)}"
+    }
+    @pm.outputs.each { |sym, instr|
+      f.puts "output #{instr.port_num}, :#{sym}, #{quoted(instr.name)}"
+    }
+    f.puts
+  end
+
+  def save_songs(f)
+    @pm.all_songs.songs.each do |song|
+      f.puts "song #{quoted(song.name)} do"
+      song.patches.each { |patch| save_patch(f, patch) }
+      f.puts "end"
+      f.puts
+    end
+  end
+
+  def save_patch(f, patch)
+    f.puts "  patch #{quoted(patch.name)} do"
+    f.puts "    start_bytes #{patch.start_bytes.inspect}" if patch.start_bytes
+    patch.connections.each { |conn| save_connection(f, conn) }
+    f.puts "  end"
+  end
+
+  def save_connection(f, conn)
+    in_sym = @pm.inputs.patch(conn.input)
+    in_chan = conn.input_chan ? conn.input_chan + 1 : 'nil'
+    out_sym = @pm.outputs.patch(conn.output)
+    out_chan = conn.output_chan + 1
+    f.puts "    conn :#{in_sym}, #{in_chan}, #{out_sym}, #{out_chan} do"
+    f.puts "      prog_chg #{conn.pc_prog}" if conn.pc?
+    f.puts "      zone #{conn.note_num_to_name(conn.zone.begin)}, #{conn.note_num_to_name(conn.zone.end)}" if conn.zone
+    f.puts "      xpose #{conn.xpose}" if conn.xpose
+    f.puts "      filter #{conn.filter.text}" if conn.filter
+    f.puts "    end"
+  end
+
+  def save_song_lists(f)
+    @pm.song_lists.each do |sl|
+      next if sl == @pm.all_songs
+      f.puts "song_list #{quoted(sl.name)}, ["
+      @pm.all_songs.songs.each do |song|
+        f.puts "  #{quoted(song.name)},"
+      end
+      f.puts "]"
+    end
+  end
+
+  def quoted(str)
+    "\"#{str.gsub('"', "\\\"")}\"" # ' <= un-confuse Emacs font-lock
+  end
+
+  # ****************************************************************
+
+  private
+
+  def input_port(port)
+    if @no_midi
+      MockInputPort.new
+    else
+      UniMIDI::Input.all[port].open
+    end
+  end
+
+  def output_port(port)
+    if @no_midi
+      MockOutputPort.new
+    else
+      UniMIDI::Output.all[port].open
+    end
+  end
+
+  # Extremely simple filter text reader. Relies on indentation to detect end
+  # of filter block.
+  def read_filters(contents)
+    i = 0
+    in_filter = false
+    filter_indentation = nil
+    filter_end_token = nil
+    contents.each_line do |line|
+      if line =~ /^(\s*)filter\s*(.*)/
+        filter_indentation, text = $1, $2
+        @filters[i].text = text + "\n"
+        in_filter = true
+        filter_end_token = case text
+                             when /^{/
+                               "}"
+                             when /^do\b/
+                               "end"
+                             when /^lambda\s*({|do)/
+                               $1 == "{" ? "}" : "end"
+                             else
+                               "}|end" # regex
+                             end
+      elsif in_filter
+        line =~ /^(\s*)(.*)/
+        indentation, text = $1, $2
+        if indentation.length <= filter_indentation.length
+          if text =~ /^#{filter_end_token}/
+            @filters[i].text << line
+          end
+          i += 1
+          in_filter = false
+        else
+          @filters[i].text << line
+        end
+      end
+    end
+  end
+
+end
+end