ramekin 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66ae01e06b69f6c295e9bd28d8fb79959f28818fd70770d608883e5b4baf5226
-  data.tar.gz: 05ece2318701ce0b3036d984ed4169e9dfcc11e19b98b86b54ff3aacdd9781b2
+  metadata.gz: 229317a8158d77d931e1cbb6b9a13e2755076137caa64ca70ff52b2ebc784d8a
+  data.tar.gz: 5b79ad0f53ec5b36c76abc993647e186561c1fdd8b69782915ea16a27d61add2
 SHA512:
-  metadata.gz: 1454727b090f2ee0db392c4822f3bb716c68ef5cdc23dd5156eeef9ab3f98a4fcde9eaa3964f21282f3caa7b152b9efa64067af57f8c35c6db365e153a665716
-  data.tar.gz: 06da5febfe538506f6dc98c08f0178c9311207b06380ce7601cb208925aec653c9a8ede8f9b04a33cd42d03b0150a2153bb038e7dceb105d9f9caad72cfd3e70
+  metadata.gz: 6b916559016efa4bc6f35dffff5d0f06d27789585ab50ffbaa4db7b5cfc6ce7d35ed7361cc6ca73676c79f182d3645bf69d899636f4cd72bb33d652694a7a73a
+  data.tar.gz: bad898187585898529a0ae108f8c170a2bc7076efecadb23cc050714435b4172a508b002fd3984c3a385e3d8d4f08b67a76a39321092daf3e9dd50218bb5a9b3

data/README.md

@@ -131,8 +131,10 @@ A list of some ramekin preprocessor features (see `spec/rmk` for some examples!)
 * `yLX` and `yRX` commands for panning left and right. `yC` to set back to center. Way easier for me to remember.
 * The implementation of `&` is more robust, and it compiles to a proper `$dd` command. It can also much more flexibly chain multiple bends together, using a non-breaking tie `^^X` to establish where the boundaries of the bend should be, and handles quite a few idiosyncracies of `$dd` automatically behind the scenes. You should be able to use `&` and `^^` for all pitch bending needs. See "Pitch Expression" below for details.
 ```elisp
-; bends to c two octaves up for two 16th notes, then continues for a quarter note
-b8 #bend >>c16^16 ^^4
+; bends to c two octaves up for two 16th notes, then continues for a quarter note.
+; note the ties don't affect the bend, and a special tie ^^ is used to mark the true
+; start of the bend.
+b8 ^^ b16^16 & >>c4
 ```
 * Instruments are named rather than numbered. See `doc/smw-instruments.rmk` for a list.
 * Switching instruments always sets that instrument's default octave, by default `o4`. It does *not* reset transposition (you can use `_0` for that).

data/lib/ramekin/cli.rb

@@ -198,6 +198,7 @@ module Ramekin
 
       inner_chain = Processor.compose(
         NoteAggregator,
+        Fades,
         Bends,
         RestAggregator,
         Legato,

data/lib/ramekin/fades.rb

@@ -0,0 +1,30 @@
+module Ramekin
+  class Fades < Processor
+    SUPPORTED = [
+      :y, :rely,
+      :v, :relv,
+      :p,
+      :w,
+      :t,
+    ]
+
+    def call(&b)
+      prev = nil
+      each do |el|
+        if NoteEvent === el && el.note.type == :fade
+          if prev.nil? || !(Token === prev) || !SUPPORTED.include?(prev.type)
+            error! 'invalid fade: must follow pan, volume, global volume, tempo, or #echo:vol commands'
+          end
+
+          prev.meta[:fade] = el
+
+          prev = nil
+        else
+          prev = el
+          yield el
+        end
+      end
+    end
+
+  end
+end

data/lib/ramekin/meta.rb

@@ -314,7 +314,7 @@ module Ramekin
 
     def ext_adsr
       adsr = @extensions.select { |e| e.type == :adsr }.last
-      adsr && adsr.value.split(',').map(&:to_i)
+      adsr && Util.adsr_value(adsr)
     end
 
     def adsr

data/lib/ramekin/note_aggregator.rb

@@ -230,7 +230,7 @@ module Ramekin
           buffer << el
         when :l
           current_l = el
-        when :note, :r, :native_tie
+        when :note, :r, :native_tie, :fade
           flush!(&b)
           @current_note = NoteEvent.new(el, current_octave, @triplets)
         when :o

data/lib/ramekin/renderer.rb

@@ -167,7 +167,14 @@ module Ramekin
     def render_token(token, &b)
       case token.type
       when :t, :bpm
-        yield "t#{tempo_of(token)}"
+        tempo = tempo_of(token)
+        fade = fade_duration(token)
+
+        if fade == 0
+          yield "t#{tempo_of(token)}"
+        else
+          yield hex(0xE3, fade, tempo)
+        end
       when :directive
         render_directive(token, &b)
       when :channel
@@ -179,7 +186,7 @@ module Ramekin
         # reset tick counter for newlines
         @tick = 0
       when :transpose
-        yield sprintf("$fa$02$%02x", token.value.to_i & 0x7f)
+        yield hex(0xFA, 0x02, token.value.to_i & 0x7f)
       when :instrument
         case token.value
         when /\A\d+\z/ then yield "@#{token.value}"
@@ -192,18 +199,16 @@ module Ramekin
           yield "@#{@instrument_index[token.value]}"
         end
       when :v
-        vol, time = token.values.compact.map(&:to_i)
+        vol = token.value.to_i
 
         unless Token === peek && [:v, :relv].include?(peek.type)
-          yield velocity_command(vol, time)
+          yield velocity_command(vol, fade_duration(token))
         end
 
         @volume = vol
       when :relv
-        relvol, duration = token.values
-
         unless Token === peek && [:v, :relv].include?(peek.type)
-          yield velocity_command(@volume + relvol.to_i, duration)
+          yield velocity_command(@volume + token.value.to_i, fade_duration(token))
         end
       when :q
         token.value =~ /(\d),?(\h)?/
@@ -211,40 +216,34 @@ module Ramekin
         gain = $2 || 'F'
         yield "q#{qval}#{gain}"
       when :w
-        yield "w#{token.value}"
-      when :adsr
-        vals = token.value.split(',').map { |x| x.to_i(16) }
-        error! 'invalid #adsr, expected 4 arguments' unless vals.size == 4
-
-        a, d, s, r = vals
-        error! 'invalid attack (must be 0-F)' unless (0..15).include?(a)
-        error! 'invalid decay (must be 0-7)' unless (0..7).include?(d)
-        error! 'invalid sustain (must be 0-7)' unless (0..7).include?(s)
-        error! 'invalid release (must be 0-1F)' unless (0..31).include?(r)
-
-        yield sprintf("$ed$%02x$%02x", (7-d) * 16 + (15-a), s * 32 + (31-r))
-      when :y
-        yield "y#{token.value}"
-      when :rely
-        token.value =~ /\A([LRC])(\d*)\z/
-        pan = case $1
-        when 'L' then 10 + $2.to_i
-        when 'R' then 10 - $2.to_i
-        when 'C' then 10
-        end
+        fade = fade_duration(token)
 
-        if pan > 20
-          return error! 'invalid pan (max yL10)'
-        elsif pan < 0
-          return error! 'invalid pan (max yR10)'
+        if fade.to_i == 0
+          yield "w#{token.value}"
+        else
+          yield hex(0xE1, fade, token.value.to_i)
+        end
+      when :adsr
+        a, d, s, r = Util.adsr_value(token)
+
+        yield hex(0xED, (7-d) * 16 + (15-a), s * 32 + (31-r))
+      when :y, :rely
+        pan_number = case token.type
+        when :y then token.value.to_i
+        when :rely
+          token.value =~ /\A([LRC])(\d*)\z/
+          pan = case $1
+          when 'L' then 10 + $2.to_i
+          when 'R' then 10 - $2.to_i
+          when 'C' then 10
+          end
         end
 
-        yield "y#{pan}"
-
+        yield pan_command(pan_number, fade_duration(token))
       when :p
         # it's free aram
         if token.value == '0,0'
-          yield '$df'
+          yield hex(0xDF)
         else
           yield "p#{token.value} "
         end
@@ -266,9 +265,6 @@ module Ramekin
         yield "*#{token.value}"
       when :superloop_end
         yield " ]]#{token.value} "
-      when :amp
-        yield '&'
-
       # triplets are handled in NoteAggregator
       when :lbrace, :rbrace
         # pass
@@ -277,18 +273,39 @@ module Ramekin
       end
     end
 
-    def velocity_command(vol, time=nil)
+    def pan_command(pan, time=0)
+      error! 'invalid pan: must be R10 to L10 (0 to 20)' unless (0..20).include?(pan)
+
+      if time.to_i == 0
+        "y#{pan}"
+      else
+        hex(0xDC, time, pan)
+      end
+    end
+
+    def velocity_command(vol, time=0)
       vol = 255 if vol > 255
       vol = 0 if vol < 0
 
-      if time.nil?
+      if time.to_i == 0
         "v#{vol}"
       else
-        time = time.to_i / @track.meta.divisor
+        time = time.to_i
         time = 255 if time > 255
         time = 0 if time < 0
-        sprintf("$e8$%02x$%02x", time, vol)
+        hex(0xE8, time, vol)
+      end
+    end
+
+    def fade_duration(tok)
+      return 0 unless tok.meta[:fade]
+      out = tok.meta[:fade].ticks / @track.meta.divisor
+
+      if out > 0xFF
+        error! "fade too long, cannot exceed 255 ticks (was #{out} ticks)"
       end
+
+      out
     end
 
     def render_directive(token)
@@ -296,16 +313,20 @@ module Ramekin
       when 'SPC'
         # pass
       when 'legato', 'legato/toggle'
-        yield '$f4$01'
+        yield hex(0xF4, 0x01)
       when 'sustain/global-toggle'
-        yield '$f4$02'
+        yield hex(0xF4, 0x02)
       when 'echo/toggle'
-        yield '$f4$03'
+        yield hex(0xF4, 0x03)
       else
         error! "unexpected directive ##{token.value}"
       end
     end
 
+    def hex(*args)
+      args.map { |a| sprintf("$%02x", a) }.join
+    end
+
     def render_string
       out = StringIO.new
       render { |chunk| out << chunk }

data/lib/ramekin/scanner.rb

@@ -0,0 +1,56 @@
+module Ramekin
+  class Scanner
+    attr_reader :match
+    attr_accessor :pos
+    def initialize(str)
+      @str = str
+      @cache = {}
+      @pos = 0
+      @match = nil
+    end
+
+    def inspect
+      prev = @str[@pos-5...@pos]
+      prev = "...#{prev}" if @pos > 5
+      prev = "#{prev} " unless prev.empty?
+
+      post = @str[@pos+1...@pos+5]
+      post = "#{post}..." unless @pos+5 >= @str.length
+      post = " #{post}" unless post.empty?
+
+      "Scanner([#{@pos}] #{prev}>#{@str[@pos]}<#{post})"
+    end
+
+    def scan(re)
+      anchored = anchored_re(re)
+
+      @match = anchored.match(@str, @pos)
+      @pos = @match.end(0) if @match
+      @match
+    end
+
+    def peek(n=1)
+      @str[@pos...@pos+n]
+    end
+
+    def eos?
+      @pos >= @str.size
+    end
+
+    def [](k)
+      @match && @match[k]
+    end
+
+    def captures
+      @match && @match.captures
+    end
+
+  private
+    def anchored_re(re)
+      @cache[re] ||= begin
+        raise 'bad regex, do not nest quantifiers' unless Regexp.linear_time?(re)
+        Regexp.new("\\G(?:#{re.source})", re.options)
+      end
+    end
+  end
+end

data/lib/ramekin/tokenizer.rb

@@ -13,6 +13,14 @@ module Ramekin
       "#{@line}:#{@col}"
     end
 
+    def repr
+      "#{linecol}@#{@pos}"
+    end
+
+    def inspect
+      "Location(#{repr})"
+    end
+
     def start
       self
     end
@@ -91,7 +99,7 @@ module Ramekin
     end
 
     def initialize(str)
-      @scanner = StringScanner.new(str)
+      @scanner = Scanner.new(str)
       @macros = []
       @last_match = nil
       @last_captures = []
@@ -118,7 +126,7 @@ module Ramekin
       matched = @scanner.scan(regexp)
       return false unless matched
 
-      update_linecol(matched)
+      update_linecol(matched.match(0))
       true
     end
 
@@ -207,7 +215,7 @@ module Ramekin
       return [:ifndef, m(1)] if match /#ifndef\s*(.*?)\n/
       return [:endif, m(1)] if match /#endif/
 
-      return [:adsr, m(1)] if match /#adsr:(\h+(?:,\h+)*)/
+      return [:adsr, m(1)] if match /#adsr:([\w,]+)/
       return [:gain, m(1)] if match /#gain:(\h+)/
       return [:tuning, m(1)] if match /#tuning:(\h\h\h\h)/
       return [:bpm, m(1)] if match /#bpm:(\d+)/
@@ -222,8 +230,8 @@ module Ramekin
       return [:directive, m(1)] if match /#([\w\/-]+)/
       return [:lbrace] if match /[{]/
       return [:rbrace] if match /[}]/
-      return [:v, m(1), m(2)] if match /v(\d+)(?:,(\d+))?/
-      return [:relv, m(1), m(2)] if match /v([+-]\d+)(?:,(\d+))?/
+      return [:v, m(1), m(2)] if match /v(\d+)/
+      return [:relv, m(1), m(2)] if match /v([+-]\d+)/
       return [:instrument, m(1)] if match /@(\d+)/
       return [:instrument, m(1)] if match /@(\w+)/
       return [:hex, m(1)] if match /[$](\h\h)/
@@ -233,6 +241,7 @@ module Ramekin
       return note(:r) if match /r/
       return note(:native_tie, m(1)) if match /\^\^/
       return note(:tie, m(1)) if match /\^/
+      return note(:fade) if match /\\/
       return [:slash] if match /\//
 
       return [:octave, m] if match /[<>]/
@@ -251,8 +260,8 @@ module Ramekin
       return remote(:remote_call, m(1)) if match /[(]!(\d*)/
 
       return [:star, m(1)] if match /\*(\d*)/
-      return [:y, m(1)] if match /y(\d+)/
-      return [:rely, m(1)] if match /y([LR]\d+)/
+      return [:y, m(1)] if match /y(\d+)(?:,(\d+))?/
+      return [:rely, m(1)] if match /y([LR]\d+)(?:,(\d+))?/
       return [:rely, 'C'] if match /yC/
       return [:w, m(1)] if match /w(\d+)/
       return [:l, m(1)] if match /l(\d+)/

data/lib/ramekin/util.rb

@@ -2,6 +2,24 @@ require 'zip'
 
 module Ramekin
   module Util
+    include Error::Helpers
+    def adsr_value(adsr)
+      case adsr.value
+      when 'flat'
+        [0, 7, 7, 31]
+      else
+        vals = adsr.value.split(',').map { |x| x.to_i(16) }
+        error! 'invalid #adsr, expected 4 arguments', el: adsr unless vals.size == 4
+
+        a, d, s, r = vals
+        error! 'invalid attack (must be 0-F)', el: adsr unless (0..15).include?(a)
+        error! 'invalid decay (must be 0-7)', el: adsr unless (0..7).include?(d)
+        error! 'invalid sustain (must be 0-7)', el: adsr unless (0..7).include?(s)
+        error! 'invalid release (must be 0-1F)', el: adsr unless (0..31).include?(r)
+        [a, d, s, r]
+      end
+    end
+
     extend self
 
     KNOWN_LENGTHS = {}.tap do |out|

data/lib/ramekin.rb

@@ -1,16 +1,18 @@
 #!/usr/bin/env ruby
 
+require_relative 'ramekin/errors'
+require_relative 'ramekin/scanner'
 require_relative 'ramekin/util'
 require_relative 'ramekin/smw'
 require_relative 'ramekin/config'
 require_relative 'ramekin/amk_setup'
 require_relative 'ramekin/spc_player'
-require_relative 'ramekin/errors'
 require_relative 'ramekin/element'
 require_relative 'ramekin/tokenizer'
 require_relative 'ramekin/processor'
 require_relative 'ramekin/macros'
 require_relative 'ramekin/note_aggregator'
+require_relative 'ramekin/fades'
 require_relative 'ramekin/bends'
 require_relative 'ramekin/legato'
 require_relative 'ramekin/loop_allocator'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ramekin
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - jneen
 bindir: gembin
 cert_chain: []
-date: 2025-04-11 00:00:00.000000000 Z
+date: 2025-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: strscan
@@ -83,6 +83,7 @@ files:
 - lib/ramekin/config.rb
 - lib/ramekin/element.rb
 - lib/ramekin/errors.rb
+- lib/ramekin/fades.rb
 - lib/ramekin/legato.rb
 - lib/ramekin/loop_allocator.rb
 - lib/ramekin/macros.rb
@@ -91,6 +92,7 @@ files:
 - lib/ramekin/processor.rb
 - lib/ramekin/renderer.rb
 - lib/ramekin/sample_pack.rb
+- lib/ramekin/scanner.rb
 - lib/ramekin/smw.rb
 - lib/ramekin/spc_player.rb
 - lib/ramekin/tokenizer.rb