ramekin 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8ecaeee8d7551d229bd4d659e37db4fb7ce51b8c8b02db5951afe2889c5766d
-  data.tar.gz: 306dd97179707ab87cbf615c0740495f230a5be78476c89855c5e65c3cbc8d54
+  metadata.gz: 1454704618e8123c1ade7251f1a30cc66b2f2febacd10e1e8f438e4b3fe3023c
+  data.tar.gz: 82453a74e36685f30e7637092fc47d242a63b609c7e4b1f586b17fafae05289f
 SHA512:
-  metadata.gz: f6496a57a0d10da8cb22d3c0da7593fc8db6949f36fa78b6bf124b39bb727f9b05176fff29961111f510029c7ec93e7d4b8edad2ee0704e312bff82b2d5b02e0
-  data.tar.gz: 494634f3636b32f99fd77c3337b7981021f39850aee811cbe15e6b8154fe5d1474ca51659bce91fe46e09ec4e64e7d5344488ba171523b5036ca7e53713cfcf5
+  metadata.gz: f33e028002e58ad86ae808bcc4a0a77b9c8b324e3a47f652bf20dcf1bc4a83381f13e23e3ec980f5350cad8686f13097f1996e08c3de798614e4092ca55a8cbf
+  data.tar.gz: 4df89465d887a660c7353a6e4b16e3817603efd861c60315c39ca531026af27b5a72bf0a7b32aa73328f9b0160f3f7f5aa868a2de9fbe6bf493bb4f1cc345aff

data/README.md

@@ -2,6 +2,8 @@
 
 Ramekin is a pre-processor for AddMusicK syntax that is in very early development.
 
+Please keep in mind that as alpha software, **I may make breaking changes at any time.** After initial testing is done, I will release 1.0.0, at which point I will make a reasonable commitment to back-compatibility. That time is not yet.
+
 # Installation
 
 First, [Install Ruby](https://ruby-lang.org). Windows users can use [RubyInstaller](https://rubyinstaller.org/).
@@ -210,6 +212,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/amk_runner.rb

@@ -3,6 +3,8 @@ require_relative 'amk_runner/sample_groups'
 
 module Ramekin
   class AMKRunner
+    include Util
+
     def initialize(filename, meta, txt)
       @filename = File.expand_path(filename)
       @amk_path = Ramekin.config.amk_dir
@@ -40,6 +42,8 @@ module Ramekin
 
       ln("#@amk_path/asm", "#@workdir/asm")
 
+      FileUtils.mkdir_p("#@workdir/Visualizations")
+
       FileUtils.mkdir_p("#@workdir/samples")
       ln("#@amk_path/samples/default", "#@workdir/samples/default")
       ln("#@amk_path/samples/optimized", "#@workdir/samples/optimized")
@@ -62,7 +66,7 @@ module Ramekin
       File.write("#@workdir/Addmusic_sound effects.txt", '')
 
       Dir.chdir(@workdir) do
-        system "./AddmusicK -norom ramekin/#{basename}.txt"
+        sys './AddmusicK', '-norom', '-visualize', "ramekin/#{basename}.txt"
         res = $?
         binding.pry unless res.success?
       end
@@ -73,6 +77,7 @@ module Ramekin
         FileUtils.cp(@filename, "./#{basename}.rmk")
         FileUtils.cp(spc_file, "./#{basename}.spc")
         FileUtils.cp(stats_file, "./#{basename}.stats.txt")
+        FileUtils.cp("#@workdir/Visualizations/#{basename}.png", "./#{basename}.png")
         File.write("./#{basename}.txt", @txt)
 
         FileUtils.mkdir_p("samples/#{basename}")

data/lib/ramekin/cli.rb

@@ -111,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'
@@ -134,7 +139,7 @@ module Ramekin
       # have a path to render the SPC file to.
       if @play || @wav_file
         if @output_package
-          @play_spc = "#@output_package/#{File.basename(@infile)}.spc"
+          @play_spc = "#@output_package/#{File.basename(@infile, '.rmk')}.spc"
         elsif @output_spc
           @play_spc = @output_spc
         else
@@ -232,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

@@ -22,7 +22,7 @@ module Ramekin
     end
 
     def echo_channel_bits
-      (@echo_channels ||= Set.new).map { |x| 1 << x }.inject(&:|)
+      (@echo_channels ||= Set.new).map { |x| 1 << x }.inject(0, &:|)
     end
 
     def echo_volumes
@@ -63,8 +63,6 @@ module Ramekin
           error! 'invalid token in header'
         end
       end
-
-      @sample_groups << 'default' if @sample_groups.empty?
     end
 
     SURROUND_R = (-0x7f..0x80)
@@ -84,21 +82,25 @@ 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]
-        if channels == 'all'
+        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/
@@ -250,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
@@ -284,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
@@ -293,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))
 
@@ -300,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|
@@ -109,7 +113,7 @@ module Ramekin
     def tempo_of(el)
       case el.type
       when :t then el.value
-      when :bpm then (el.value.to_i * 256 / 625.0).round
+      when :bpm then (el.value.to_i * 8192 / 20025.0).round
       end
     end
 
@@ -170,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}"
@@ -189,11 +187,14 @@ 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 :q
+        yield "q#{token.value}"
       when :adsr
         vals = token.value.split(',').map { |x| x.to_i(16) }
         error! 'invalid #adsr, expected 4 arguments' unless vals.size == 4
@@ -254,6 +255,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'

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 /~/
@@ -227,6 +228,7 @@ module Ramekin
       return [:instrument, m(1)] if match /@(\w+)/
       return [:hex, m(1)] if match /[$](\h\h)/
       return [:t, m(1)] if match /t(\d+)/
+      return [:q, m(1)] if match /q(\d\h?)/
 
       return note(:note, m) if match /[abcdefg][+-]?/
       return note(:r) if match /r/
@@ -259,7 +261,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.7
+  version: 0.0.9
 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