ramekin 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7b36dbfb523fcdcfc98705488675f16c06ce0aed6ad2a93abe69d3ff5818eff
-  data.tar.gz: 81c0bdc600590ed5f1a552ecd8eed52901d52b558820c9c53e69bac0cdc13053
+  metadata.gz: 463b021dd0273151c13a7590db845acf584a2df021596dd715721964e777f6d9
+  data.tar.gz: 432c1eccc9c5443cc63ec828f87a319141caeb3080c847948634b7935553ec86
 SHA512:
-  metadata.gz: fcdf3d5540e3cbcaf92f37235a7d778c4d4389fe4d791777e849db2d40076d839a618ba7333af29878390375130963be0e98b0d232f7c6557a90b2787bec0c19
-  data.tar.gz: 8bd4df95943b9e05ec1a849dedefdfd5c277ce53b7019098562881ec7f892532bc2fa623e0e368b5a3f817970f94e1c671f79a3a5bfa750f240e93a1cdc41e37
+  metadata.gz: fbe078d3e43b620748e3bcd91360d06e1bf2b9b804821d21a6479479fe519abb7d48643a8a95f45abfcfe512b2654b1a1f6424773282d294503799e2ee31175b
+  data.tar.gz: bd829fcd1272ac8279757c73963e407b90ef9257d104475aa07a5c52cf3ed16ce691d25ade84a3333fa2c243854948b92a7fcbfa90b47ee2fedad9c845b54c33

data/README.md

@@ -42,7 +42,8 @@ ramekin compile -i filename.rmk [flags]
         -i filename.rmk
             set the input file
         --txt filename.txt
-            output amk txt to this file
+            output amk txt to this file.
+            use a single dash (-) to print txt to stdout.
         --spc filename.spc
             attempt to invoke AddmusicK to output an SPC
             requires ADDMUSICK_DIR and ASAR_COMMAND
@@ -209,6 +210,24 @@ After the instrument declaration, you can use several commands to change the def
 
 It is generally advised to stick with the default tuning. The `o5` declaration sets the *default octave* for the instrument to octave 5 (the default is 4). Whenever this instrument is selected, Ramekin will insert a switch to the specified octave.
 
+### Echo settings
+
+Echo settings can be set up with the `#echo/...` family of directives:
+
+```elisp
+#echo/channels:0,1,2,3
+; or
+#echo/channels:all
+; or
+#echo/channels:none
+
+#echo/volume:20    ; range from -7f to 80, use negatives for surround
+#echo/volume:20,30 ; set different values for left vs right echo
+#echo/feedback:48  ; range from -7f to 80, use negatives for surround
+#echo/fir:1        ; 1 or 0 to enable/disable the FIR filter
+```
+
+
 ## Channel Commands
 
 With your metadata all set up, it's time to add some notes!

data/lib/ramekin/cli.rb

@@ -29,7 +29,8 @@ module Ramekin
       $stderr.puts "        -i filename.rmk"
       $stderr.puts "            set the input file"
       $stderr.puts "        --txt filename.txt"
-      $stderr.puts "            output amk txt to this file"
+      $stderr.puts "            output amk txt to this file."
+      $stderr.puts "            use a single dash (-) to print txt to stdout."
       $stderr.puts "        --spc filename.spc"
       $stderr.puts "            attempt to invoke AddmusicK to output an SPC"
       $stderr.puts "            requires ADDMUSICK_DIR and ASAR_COMMAND"
@@ -110,6 +111,11 @@ module Ramekin
         when '--package'
           @output_package = argv.shift or usage! 'missing dirname after --package'
         when '--play'
+          if argv.any? && argv[0] =~ /\A\d+\z/
+            @play_offset = argv.shift
+          else
+            @play_offset = 0
+          end
           @play = true
         when '--wav'
           arg = argv.shift or usage! 'missing wav file after --render'
@@ -199,7 +205,9 @@ module Ramekin
         WARN
       end
 
-      if @output_txt
+      if @output_txt == '-'
+        $stdout.puts(txt)
+      elsif @output_txt
         File.write(@output_txt, txt)
       end
 
@@ -229,7 +237,7 @@ module Ramekin
 
       if @play
         SPCPlayer.instance.setup!
-        SPCPlayer.instance.play(@play_spc)
+        SPCPlayer.instance.play(@play_spc, @play_offset)
       end
 
       if @verbose

data/lib/ramekin/errors.rb

@@ -15,7 +15,7 @@ module Ramekin
     def self.error!(e, nesting: 0)
       all << e
 
-      if ENV['RAMEKIN_DEBUG']
+      if ENV['RAMEKIN_DEBUG'] == '1'
         if nesting >= 0
           Pry.config.hooks.add_hook(:before_session, :ramekin) do |output, binding, pry|
             Pry.config.hooks.delete_hook(:before_session, :ramekin)
@@ -35,7 +35,7 @@ module Ramekin
 
     def present(orig)
       out = []
-      out << "line #{@range.start.line}, col #{@range.start.col}:"
+      out << "line #{@range.start.line+1}, col #{@range.start.col+1}:"
       out << "  ---"
       out << "  #{orig[@range.pos_range]}"
       out << "  ---"

data/lib/ramekin/meta.rb

@@ -21,6 +21,33 @@ module Ramekin
       @options = {}
     end
 
+    def echo_channel_bits
+      (@echo_channels ||= Set.new).map { |x| 1 << x }.inject(0, &:|)
+    end
+
+    def echo_volumes
+      [(@echo_volume_l || 0) & 0xFF, (@echo_volume_r || 0) & 0xFF]
+    end
+
+    def echo_delay
+      @echo_delay || 0
+    end
+
+    def echo_feedback
+      (@echo_feedback || 0) & 0xFF
+    end
+
+    def echo_fir
+      @echo_fir || 0
+    end
+
+    def echo_hex
+      sprintf("$ef$%02x$%02x$%02x $f1$%02x$%02x$%02x",
+        echo_channel_bits, *echo_volumes,
+        echo_delay, echo_feedback, echo_fir
+      )
+    end
+
     def parse
       loop do
         break if @elements.empty?
@@ -36,10 +63,10 @@ module Ramekin
           error! 'invalid token in header'
         end
       end
-
-      @sample_groups << 'default' if @sample_groups.empty?
     end
 
+    SURROUND_R = (-0x7f..0x80)
+
     def parse_directive
       @current_directive = @current
       case @current.value
@@ -55,16 +82,78 @@ module Ramekin
       when 'instrument'
         name, path = expect_args(:instrument, :string)
         extensions = []
-        while (el = check_arg(:adsr, :tuning, :o))
+        while (el = check_arg(:adsr, :tuning, :gain, :o))
           extensions << el
         end
 
         return unless @current_pack
-        @instruments << Instrument.new(@current_pack, @current, name, path, extensions)
+        @instruments << Instrument.new(@current_pack, @current_directive, name, path, extensions)
       when 'default', 'optimized' then @sample_groups << @current
 
       # TODO: real echo syntax
       when 'echo' then @echo = expect_args(*([:hex] * 8))
+      when 'echo/channels'
+        channels = @current_directive.values[1]
+        case channels
+        when 'all'
+          @echo_channels = Set.new(0..7)
+          return
+        when 'none'
+          @echo_channels = Set.new
+          return
+        end
+
+        unless channels && channels =~ /\A\d(,\d)+\z/
+          error! 'invalid echo channels (list of single digit numbers separated by comma)'
+        end
+
+        @echo_channels = Set.new(channels.split(',').map(&:to_i))
+        unless @echo_channels.all? { |c| (0..7).include?(c) }
+          error! 'invalid echo channels (must be 0-7)'
+        end
+      when 'echo/volume'
+        vols = @current_directive.values[1]
+
+        unless vols && vols =~ /\A-?\h\h?(,\h\h?)?/
+          error! 'invalid echo volume (one or two hex numbers)'
+        end
+
+        vols = vols.split(',').map { |v| v.to_i(16) }
+        if vols.size == 1
+          @echo_volume_l = @echo_volume_r = vols[0]
+        else
+          @echo_volume_l, @echo_volume_r = vols
+        end
+
+        unless SURROUND_R.include?(@echo_volume_l) && SURROUND_R.include?(@echo_volume_r)
+          error! 'invalid echo volume (-7f to 80, use negative for surround)'
+        end
+
+      when 'echo/delay'
+        delay = @current_directive.values[1]
+        unless delay && delay =~ /\A[0-7]\z/
+          error! 'invalid echo delay (single digit 0-7)'
+        end
+
+        @echo_delay = delay.to_i
+      when 'echo/feedback'
+        feedback = @current_directive.values[1]
+        unless feedback && feedback =~ /\A-?\h\h?\z/
+          error! 'invalid echo feedback (one or two hex digits)'
+        end
+
+        @echo_feedback = feedback.to_i(16)
+
+        unless SURROUND_R.include?(@echo_feedback)
+          error! 'invalid echo feedback (-7F to 80, use negative for surround)'
+        end
+      when 'echo/fir'
+        fir = @current_directive.values[1]
+        unless fir && fir =~ /\A\h\h?\z/
+          error! 'invalid echo FIR setting (one or two hex digits)'
+        end
+
+        @echo_fir = fir.to_i(16)
       else
         error! 'invalid directive in header'
       end
@@ -163,12 +252,12 @@ module Ramekin
 
     def adsr
       @adsr ||= ext_adsr || pack_adsr \
-        or error! "no adsr configured for #{name}"
+        or error! "no adsr configured for #{name.value}", el: name
     end
 
     def tuning
       @tuning ||= ext_tuning || pack_tuning \
-        or error! "no tuning configured for #{name}"
+        or error! "no tuning configured for #{name.value}", el: name
     end
 
     def pack_tuning
@@ -197,8 +286,7 @@ module Ramekin
     end
 
     def gain
-      @gain ||= ext_gain || pack_gain \
-        or error! "no gain configured for #{name}"
+      @gain ||= ext_gain || pack_gain || 0xFF
     end
 
     def hexes
@@ -206,6 +294,8 @@ module Ramekin
       t1, t2 = self.tuning
       g = self.gain
 
+      return [] unless a && d && s && r && t1 && t2 && g
+
       adsr1 = ((7 - d)*16 | 0x80) + (15 - a)
       adsr2 = (s*32 + (31-r))
 
@@ -213,6 +303,11 @@ module Ramekin
     end
 
     def to_amk
+      unless @pack.has?(@path.value)
+        error! "no sample named #{path.value.inspect} in pack #{pack.name.inspect}", el: @path
+        return ''
+      end
+
       "#{File.basename(sample_name).inspect} #{hexes.map { |h| "$#{h}" }.join(' ')}"
     end
 

data/lib/ramekin/renderer.rb

@@ -74,13 +74,17 @@ module Ramekin
       yield "; https://codeberg.org/jneen/ramekin\n\n"
 
       # TODO
-      yield "#amk 2\n\n"
+      yield "#amk #{@track.meta.amk&.value || 2}\n\n"
 
       if m.instruments.any?
         yield "#path #{@filename.chomp('.rmk').inspect}\n"
         yield "#samples {\n"
-        m.sample_groups.each do |group|
-          yield "  ##{group.value}\n"
+        if m.sample_groups.empty?
+          yield "  #default"
+        else
+          m.sample_groups.each do |group|
+            yield "  ##{group.value}\n"
+          end
         end
 
         m.instruments.map(&:sample_name).sort.uniq.each do |sample|
@@ -99,7 +103,10 @@ module Ramekin
 
       yield "t#{tempo_of(m.tempo)} ; main tempo (0-60)\n" if m.tempo
       yield "w#{m.volume.value} ; main volume (0-255)\n" if m.volume
-      yield "l16"
+      yield "l16\n\n"
+
+      yield "; echo settings\n"
+      yield m.echo_hex
       # binding.pry
     end
 
@@ -167,13 +174,7 @@ module Ramekin
         # reset tick counter for newlines
         @tick = 0
       when :transpose
-        interval = token.value.to_i
-
-        if interval < 0
-          interval = 0x80 - interval
-        end
-
-        yield sprintf("$fa$02$%02x", token.value.to_i)
+        yield sprintf("$fa$02$%02x", token.value.to_i & 0x7f)
       when :instrument
         case token.value
         when /\A\d+\z/ then yield "@#{token.value}"
@@ -186,11 +187,12 @@ module Ramekin
           yield "@#{@instrument_index[token.value]}"
         end
       when :v
-        yield "v#{token.values.compact.join(',')}"
-        @volume = token.values[0].to_i
+        vol, time = token.values.compact.map(&:to_i)
+        yield velocity_command(vol, time)
+        @volume = vol
       when :relv
         relvol, duration = token.values
-        yield "v#{[@volume + relvol.to_i, duration].compact.join(',')}"
+        yield velocity_command(@volume + relvol.to_i, duration)
       when :adsr
         vals = token.value.split(',').map { |x| x.to_i(16) }
         error! 'invalid #adsr, expected 4 arguments' unless vals.size == 4
@@ -251,6 +253,20 @@ module Ramekin
       end
     end
 
+    def velocity_command(vol, time=nil)
+      vol = 255 if vol > 255
+      vol = 0 if vol < 0
+
+      if time.nil?
+        "v#{vol}"
+      else
+        time = time.to_i
+        time = 255 if time > 255
+        time = 0 if time < 0
+        sprintf("$E8$%02x$%02x", time, vol)
+      end
+    end
+
     def render_directive(token)
       case token.value
       when 'SPC'
@@ -274,6 +290,8 @@ module Ramekin
         @octave = note.octave
       when 'legato'
         yield '$f4$01'
+      when 'echo/toggle'
+        yield '$f4$03'
       else
         error! "unexpected directive ##{token.value}"
       end

data/lib/ramekin/sample_pack.rb

@@ -105,6 +105,10 @@ module Ramekin
       File.join(prefix_dir, "#{path}.brr")
     end
 
+    def has?(path)
+      File.exist?(find(path))
+    end
+
     def tunings_for(path)
       rel = Pathname.new(find(path)).relative_path_from(dir).to_s
       (tunings[rel] || []).map(&:last)

data/lib/ramekin/spc_player.rb

@@ -37,7 +37,7 @@ module Ramekin
         File.exist?("#@spcplay_dir/spcplay.exe")
       end
 
-      def play(fname)
+      def play(fname, offset_=0)
         fname = File.expand_path(fname)
         Dir.chdir(@spcplay_dir) do
           sys "spcplay.exe", fname
@@ -61,8 +61,8 @@ module Ramekin
     end
 
     class NormalSPCPlayer < SPCPlayer
-      def play(fname)
-        sys "#@spct_dir/spct", 'play', fname
+      def play(fname, offset=0)
+        sys "#@spct_dir/spct", 'play', fname, '--seek', offset
       end
 
       def render(fname, outfile, seconds=nil)
@@ -110,9 +110,9 @@ module Ramekin
         sys(*args)
       end
 
-      def play(fname)
+      def play(fname, offset=0)
         if File.basename(@path, '.exe') == 'spct'
-          sys @path, 'play', fname
+          sys @path, 'play', fname, '--seek', offset
         else
           sys @path, fname
         end

data/lib/ramekin/tokenizer.rb

@@ -135,9 +135,9 @@ module Ramekin
       newlines = matched.count("\n")
       @line += newlines
       if newlines > 0
-        @col = find_colno(matched[0])
+        @col = find_colno(matched)
       else
-        @col += find_colno(matched[0])
+        @col += find_colno(matched)
       end
     end
 
@@ -208,6 +208,7 @@ module Ramekin
       return [:endif, m(1)] if match /#endif/
 
       return [:adsr, m(1)] if match /#adsr:(\h+(?:,\h+)*)/
+      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+)/
       return [:legato_tie] if match /~/
@@ -217,7 +218,8 @@ module Ramekin
       return [:amk, m(1)] if match /#amk\s*(\d+)/
       return [:option, m(1)] if match /#option (\w+)/
       return [:channel, m(1)] if match /#(\d+)/
-      return [:directive, m(1)] if match /#([\w-]+)/
+      return [:directive, m(1), m(2)] if match /#([\w\/-]+):(\S+)/
+      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+))?/
@@ -258,7 +260,7 @@ module Ramekin
       return [:q, m(1)] if match /q(\h\h)/
       return [:n, m(1)] if match /n(\h\h?)/
 
-      error! "unknown token near: #{@scanner.peek(10)}"
+      error! "unknown token near: #{@scanner.peek(10)}", el: @last_token
 
       return [:unknown, m] if match /./
     end

data/lib/ramekin/util.rb

@@ -44,7 +44,7 @@ module Ramekin
       env = {}
       kw.each { |k, v| env[k.to_s] = v }
 
-      system(env, *a)
+      system(env, *a.map(&:to_s))
     rescue Interrupt
       # allow interrupt out of the subprocess but capture it for ramekin itself
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ramekin
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - jneen
 autorequire:
 bindir: gembin
 cert_chain: []
-date: 2025-02-17 00:00:00.000000000 Z
+date: 2025-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: strscan