ramekin 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d868f9a713e079e67a612eb195411f981e08762404d04d864e3c49ebb436264
-  data.tar.gz: 1147c0e541694973b8c5e50c953822cce616abdcffba5a00e9a379e21bc65920
+  metadata.gz: 95057d0af759892ede884da43667ad0fc05366451bb8416a696bec369e6fb2a0
+  data.tar.gz: 66263b7127f80e3103c23b836a5587b02a390c682a194552a5fe5350b79b72af
 SHA512:
-  metadata.gz: b5f887113d039e9f9e496062b96c2905a1b877dd9199daf2db87a8e5b2072b3db74736ab496fbc92680f40bb8567ba875a6b0fb4e8934d9e674bc3734dc35f10
-  data.tar.gz: 76a5c121c7e2755fa09ef578fe8d9a002b3357c0fcdb3af5cf7241fbad7d59b153b6a111201caa4467c4a18e83d87c3c273d1a41467d219eec7a030ce0dc370b
+  metadata.gz: 5472514c2ae5edf9a979e7b251f188518b4095a1cea88052e44c7e11fe42912ef6349c4e797b07e09b608772f4d73d91aa8d767807e55da5efb2450c0a40f1f7
+  data.tar.gz: 9d2f76c65d0091998970069dc49b8632d3b73c5256334a888cef06a003e5d6a39eb88d5b54bebbc0fe2e0a7a4acd9cceafdc7d76d5f2aaf56e0604073a45c921

data/README.md

@@ -143,7 +143,7 @@ b8 #bend >>c16^16 ^^4
 
 * Tempo can alternately be declared with `#bpm:128`. This will be converted to the nearest `tXX` command. If the tempo is over `t60` (`#bpm:146`), the tempo and all note and event lengths will be halved automatically. This is similar to `#halvetempo` except that it is done automatically.
 * `p0,0` compiles to `$df`.
-* "Legato tie" represented by `~`, which will use `$f4$01` at appropriate times to cause the note transition to be played legato.
+* "Legato tie" represented by `~`, which will use `$f4$01` at appropriate times to cause the note transition to be played legato. `#legato/toggle` can be used for a raw `$f4$01`, and `#sustain/global-toggle` for `$f4$02`.
 * If you ever want to see what exactly Ramekin is generating, just use `--txt` and you can inspect the generated AddmusicK syntax manually!
 
 # Syntax
@@ -376,6 +376,20 @@ yL2  ; tasteful pan left
 yl10 ; maximum pan left
 ```
 
+#### Legato and quantization
+
+To play notes in sequence without re-starting the note from the beginning, you can use a "legato tie", represented by `~`:
+
+```elisp
+a4~b4~>c4
+```
+
+This works by inserting AddmusicK's "legato toggle" command at appropriate times. To insert this toggle manually, use `#legato/toggle` - but be careful of using this command inside loops, as it can sometimes be ignored by AddmusicK, leaving you with settings that leave the toggle in an inconsistent state. Legato ties should always be safe inside loops.
+
+To activate "sustain" mode, where notes are rekeyed but there is far less space between notes, use `#sustain/global-toggle`. AddmusicK will apply this setting to *all* channels at once. Again, this is a toggle, so be careful of activating this more than once unintentionally.
+
+To activate staccato for a channel, you can change the "quantization" (i.e. how long notes hold compared to their length) with `qX`, where X is a number 0-7. `q7` results in the longest held notes, and q0 in the shortest. If you've used `qXY` in AddmusicK to modify GAIN before, note that Ramekin's syntax requires a comma for parsing consistency: `qX,Y`.
+
 ## Hex
 
 For those who want to use AddmusicK features that are not currently supported by Ramekin, Ramekin still supports manual entry of hex values with `$XX`. While these can be made slightly easier to use with macros, I would very much appreciate it if you could open an issue here or contact me via SMWC or Discord if you find you are using these heavily.

data/lib/ramekin/amk_runner.rb

@@ -48,6 +48,10 @@ module Ramekin
       ln("#@amk_path/samples/default", "#@workdir/samples/default")
       ln("#@amk_path/samples/optimized", "#@workdir/samples/optimized")
       ln("#@amk_path/samples/EMPTY.brr", "#@workdir/samples/EMPTY.brr")
+      if File.exist?("#@amk_path/samples/SPECIALWAVE.brr")
+        ln("#@amk_path/samples/SPECIALWAVE.brr", "#@workdir/samples/SPECIALWAVE.brr")
+      end
+
       if @meta.instruments.any?
         sample_dir = "#@workdir/samples/#{@meta.sample_path || basename}"
         FileUtils.mkdir_p(sample_dir)
@@ -65,11 +69,16 @@ module Ramekin
       ___
       File.write("#@workdir/Addmusic_sound effects.txt", '')
 
-      Dir.chdir(@workdir) do
+      res = Dir.chdir(@workdir) do
         sys './AddmusicK', '-norom', '-visualize', "ramekin/#{basename}.txt"
-        res = $?
-        binding.pry unless res.success?
+        $?
       end
+
+      unless res && res.success?
+        binding.pry if ENV['RAMEKIN_DEBUG'] == '1'
+      end
+
+      return res
     end
 
     def export(outdir)

data/lib/ramekin/bends.rb

@@ -32,11 +32,11 @@ module Ramekin
     end
 
     def tie?
-      false
+      @notes.first.tie?
     end
 
     def ending_octave
-      @notes.first.octave
+      @notes.last.octave
     end
 
     # in the event of a tie-free bend exactly at a note out where we *also*
@@ -74,7 +74,7 @@ module Ramekin
       out << from.octave_amk(oct)
       out << from.note_name
       out << "=#{bend_duration}"
-      out << dd(bend_duration, to)
+      out << dd(bend_duration, to, from.octave_num)
       out << "$f4$01^=#{leftover}"
 
       out.string
@@ -111,6 +111,8 @@ module Ramekin
 
       out = StringIO.new
 
+      leftover = @notes.last.ticks / divisor
+
       (0...@notes.length-1).each do |i|
         note = @notes[i]
         to_note = @notes[i+1]
@@ -119,33 +121,40 @@ module Ramekin
 
         if i == 0
           out << note.octave_amk(octave)
+          octave = note.octave_num
           out << note.note_name
         else
           out << '^'
         end
 
-        ticks = note.ticks / divisor
+        bend_ticks = note.ticks / divisor
+        note_ticks = bend_ticks
+
+        # If we're at the last bend in the sequence, we can try to
+        # combine the bend with the length of the last note, if it's
+        # not too long, saving a tie and therefore a byte. This will
+        # only work if the combined length is < 0x60, since technically
+        # we are stretching the bend across the final two notes, but
+        # with a shorter tick time
+        if i == @notes.length-2 && ticks + leftover < 96
+          note_ticks += leftover
+          leftover = 0
+        end
 
         # always use tick count notation here because
         # amk can insert ties in some cases which will break $dd
-        out << "=#{ticks}"
-        out << dd(ticks, to_note)
+        out << "=#{note_ticks}"
+        out << dd(bend_ticks, to_note, octave)
         out << '$f4$01' if @end_legato && i == 0
       end
 
-      out << "^#{@notes.last.length_amk(divisor)}" if @notes.last.ticks > 0
+      out << "^#{Util.nice_length_amk(leftover)}" if leftover > 0
       out.string
     end
 
-    def dd(dur, note)
-      hex = note.note_hex
-
-      unless 0x80 <= hex && hex <= 0xC5
-        error! 'note out of range (o1c - o6a)', el: note
-        return ''
-      end
-
-      sprintf '$dd$00$%02x$%02x', dur, note.note_hex
+    def dd(dur, note, current_octave)
+      oct = note.octave_switching_amk(current_octave)
+      sprintf '$dd$00$%02x%s%s', dur, oct, note.note_name
     end
   end
 

data/lib/ramekin/cli.rb

@@ -238,7 +238,11 @@ module Ramekin
 
       if @output_spc || @output_package
         runner = AMKRunner.new(@infile, channels.meta, txt)
-        runner.compile
+        result = runner.compile
+        unless result && result.success?
+          $stderr.puts "AddmusicK did not exit successfully."
+          exit result&.to_i || 1
+        end
       end
 
       FileUtils.cp(runner.spc_file, @output_spc) if @output_spc

data/lib/ramekin/legato.rb

@@ -56,7 +56,7 @@ module Ramekin
 
       post_ticks /= divisor
 
-      post_len = KNOWN_LENGTHS.fetch(post_ticks) { "=#{post_ticks}" }
+      post_len = Util.nice_length_amk(post_ticks)
       "#{octave_amk(current_octave)}#{note_name}=1$f4$01^#{post_len}"
     end
 

data/lib/ramekin/meta.rb

@@ -288,7 +288,7 @@ module Ramekin
     end
 
     def tuning
-      @tuning ||= ext_tuning || pack_tuning || [0, 0]
+      @tuning ||= ext_tuning || pack_tuning || [4, 0]
     end
 
     def pack_tuning

data/lib/ramekin/note_aggregator.rb

@@ -46,21 +46,6 @@ module Ramekin
       @note.type == :native_tie
     end
 
-    KNOWN_LENGTHS = {}.tap do |out|
-      ticks = 192
-      length = 1
-
-      loop do
-        out[ticks] = length.to_s
-
-        break unless ticks % 2 == 0
-
-        out[ticks * 3 / 2] = "#{length}."
-        length *= 2
-        ticks /= 2
-      end
-    end
-
     def length_amk(div)
       return '=0' if ticks == 0
 
@@ -70,9 +55,8 @@ module Ramekin
       end
 
       t = ticks / div
-      # we use l16
-      return '' if t == 12
-      KNOWN_LENGTHS.fetch(t) { "=#{t}" }
+
+      tie? ? Util.nice_length_amk(t) : Util.extra_nice_length_amk(t)
     end
 
     NOTES = { 'c' => 0, 'd' => 2, 'e' => 4, 'f' => 5, 'g' => 7, 'a' => 9, 'b' => 11 }
@@ -107,6 +91,14 @@ module Ramekin
       end
     end
 
+    def octave_switching_amk(current_octave)
+      diff = octave_num - current_octave
+
+      return '' if diff == 0
+      return '<' * (-diff) if diff < 0
+      return '>' * diff if diff > 0
+    end
+
     def to_amk(current_octave=nil, divisor=1)
       return "#{octave_amk(current_octave)}#{note_name}#{length_amk(divisor)}"
     end

data/lib/ramekin/renderer.rb

@@ -57,8 +57,14 @@ module Ramekin
       yield "; generated from #{@filename} by Ramekin\n"
       yield "; https://codeberg.org/jneen/ramekin\n\n"
 
-      # TODO
-      yield "#amk #{@track.meta.amk&.value || 2}\n\n"
+      amk = @track.meta.amk&.value || 4
+      yield "#amk #{amk}\n"
+
+      if amk.to_i >= 4
+        yield "#option amk109hotpatch\n"
+      end
+
+      yield "\n"
 
       if m.instruments.any?
         yield "#path #{(m.sample_path || @filename.chomp('.rmk')).inspect}\n"
@@ -130,7 +136,7 @@ module Ramekin
 
           yield el.to_amk(@octave, @track.meta.divisor)
 
-          @octave = el.ending_octave
+          @octave = el.ending_octave unless el.tie?
         when NoteEvent
           old_tick = @tick
           @tick += el.ticks
@@ -286,8 +292,10 @@ module Ramekin
       case token.value
       when 'SPC'
         # pass
-      when 'legato'
+      when 'legato', 'legato/toggle'
         yield '$f4$01'
+      when 'sustain/global-toggle'
+        yield '$f4$02'
       when 'echo/toggle'
         yield '$f4$03'
       else

data/lib/ramekin/util.rb

@@ -4,6 +4,31 @@ module Ramekin
   module Util
     extend self
 
+    KNOWN_LENGTHS = {}.tap do |out|
+      ticks = 192
+      length = 1
+
+      loop do
+        out[ticks] = length.to_s
+
+        break unless ticks % 2 == 0
+
+        out[ticks * 3 / 2] = "#{length}."
+        length *= 2
+        ticks /= 2
+      end
+    end
+
+    def extra_nice_length_amk(ticks)
+      # output uses l16
+      return '' if ticks == 12
+      nice_length_amk(ticks)
+    end
+
+    def nice_length_amk(ticks)
+      KNOWN_LENGTHS.fetch(ticks) { "=#{ticks}" }
+    end
+
   private
     def clear_dir(dir, force: false, remake: true)
       if Dir.exist?(dir) && !Dir.empty?(dir)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ramekin
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.5
 platform: ruby
 authors:
 - jneen
 bindir: gembin
 cert_chain: []
-date: 2025-03-08 00:00:00.000000000 Z
+date: 2025-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: strscan