ramekin 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 399438b57abf19c6d68cbc4db7fbb96586985bf801f0f94cea4cd1365d2839e9
-  data.tar.gz: 5abb75a51346fa517c749f3dd78d469459d02bef30bb3478060f2ed9527a0792
+  metadata.gz: 4d868f9a713e079e67a612eb195411f981e08762404d04d864e3c49ebb436264
+  data.tar.gz: 1147c0e541694973b8c5e50c953822cce616abdcffba5a00e9a379e21bc65920
 SHA512:
-  metadata.gz: e9306550e91db609450792179302dce6752cb6fa9cb5fe97f95f1ac926bf28bc8548719c5e0d55e7909c0e4c8817149675f7caff6a86c0d4b37bbeaaf634840b
-  data.tar.gz: 38abeba0943b587b1559e9fe0a1fe5fe0875f349a1b7fa5883b1e7da57e1e52898a0bd0ef2b7fee02b418a8f739aae118baae74627cbfce6d773d6d4fba5a4a9
+  metadata.gz: b5f887113d039e9f9e496062b96c2905a1b877dd9199daf2db87a8e5b2072b3db74736ab496fbc92680f40bb8567ba875a6b0fb4e8934d9e674bc3734dc35f10
+  data.tar.gz: 76a5c121c7e2755fa09ef578fe8d9a002b3357c0fcdb3af5cf7241fbad7d59b153b6a111201caa4467c4a18e83d87c3c273d1a41467d219eec7a030ce0dc370b

data/README.md

@@ -10,6 +10,8 @@ Ramekin is a pre-processor for AddMusicK syntax that is in very early developmen
 
 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.
 
+For a preview of what full Ramekin tracks look like, feel free to check out [the examples repo](https://codeberg.org/jneen/ramekin-examples).
+
 # Installation
 
 First, [Install Ruby](https://ruby-lang.org). Windows users can use [RubyInstaller](https://rubyinstaller.org/).
@@ -40,10 +42,19 @@ ramekin setup
 # Usage
 
 ```
-usage: ramekin [command] [flags]
+usage: ramekin [--pack NAME=PATH] [command] [flags]
     (default command: compile)
 
+ramekin --pack my_cool_pack=/path/to/my_cool_pack [...]
+    Specifies an additional custom sample location.
+    Files compiled this way should use #pack "my_cool_pack",
+    and sample paths relative to the deepest common path that
+    contains .brr files. Use with `package --list my_cool_pack` to
+    see details.
+
 ramekin compile -i filename.rmk [flags]
+ramekin compile filename.rmk [flags]
+ramekin filename.rmk [flags]
     flags:
         -h --help
             display this message
@@ -397,6 +408,26 @@ Or drum instrument helpers:
 
 Or anything else you might find helpful.
 
+## Custom Samples
+
+If you have your own BRR-format samples that you'd like to use, Ramekin supports loading these through *custom packs*, specified on the CLI. First, organize your samples into a directory, with an optional `!patterns.txt` or `tunings.txt` file, much as may be found on [SMW Central's BRR repository](https://www.smwcentral.net/?p=section&s=brrsamples). In the simplest case, this is just a directory with .brr files in it.
+
+Then, when running ramekin, use:
+
+```console
+$ ramekin --pack 'my cool pack=/path/to/my_cool_pack' [the rest of the ramekin command]
+```
+
+where `/path/to/my_cool_pack` is replaced with a relative path to your BRR files directory. Your ramekin files can then freely use `#pack "my cool pack"`, and conjure up instruments from the pack. If no tuning file is specified, you may need to use `#tuning:XXXX` to specify a tuning, as the default tuning of `0000` is unlikely to be audible.
+
+If Ramekin is having trouble finding your BRR files, try:
+
+```console
+$ ramekin --pack 'my cool pack=/path/to/my_cool_pack' package --list 'my cool pack'
+```
+
+which will display the paths it expects you to use for each BRR sample it found.
+
 # Thank you for trying out Ramekin!
 
 If you find any bugs, please report them in the issue tracker here on Codeberg. If you have questions, design ideas, or complaints, or just want to chat, please feel free to ask anything in [my discord](https://jneen.ca/discord). Cheers!

data/lib/ramekin/bends.rb

@@ -56,6 +56,8 @@ module Ramekin
 
       leftover = total_duration - bend_duration
 
+      return '' unless check_duration!(from, div)
+
       # ensure there is some leftover so we can toggle legato
       # before the end
       if leftover < 2
@@ -67,8 +69,6 @@ module Ramekin
         end
       end
 
-      return '' unless check_duration!(from)
-
       out = StringIO.new
 
       out << from.octave_amk(oct)
@@ -94,8 +94,8 @@ module Ramekin
       true
     end
 
-    def check_duration!(note)
-      ticks = note.ticks
+    def check_duration!(note, divisor)
+      ticks = note.ticks / divisor
       return true if ticks > 0 && ticks <= 96
 
       error! 'bend length too short (must be at least one tick)', el: note if ticks <= 0
@@ -115,32 +115,25 @@ module Ramekin
         note = @notes[i]
         to_note = @notes[i+1]
 
+        next unless check_duration!(note, divisor)
+
         if i == 0
-          ticks = note.ticks + to_note.ticks
           out << note.octave_amk(octave)
           out << note.note_name
         else
-          ticks = to_note.ticks
           out << '^'
         end
 
-        ticks /= divisor
-        next unless check_duration!(note)
-
-        # $dd doesn't work properly if the note
-        # beforehand is more than a half note, so we have to
-        # split it up
-        clamped_ticks = [0x60, ticks].min
-        leftover_ticks = [0, ticks-0x60].max
+        ticks = note.ticks / divisor
 
         # always use tick count notation here because
         # amk can insert ties in some cases which will break $dd
-        out << "=#{clamped_ticks}"
-        out << dd(note.ticks, to_note)
+        out << "=#{ticks}"
+        out << dd(ticks, to_note)
         out << '$f4$01' if @end_legato && i == 0
-        out << "^=#{leftover_ticks}" if leftover_ticks > 0
       end
 
+      out << "^#{@notes.last.length_amk(divisor)}" if @notes.last.ticks > 0
       out.string
     end
 

data/lib/ramekin/cli.rb

@@ -19,10 +19,19 @@ module Ramekin
     def usage
       $stderr.puts "Ramekin version #{RAMEKIN_VERSION}"
       $stderr.puts ""
-      $stderr.puts "usage: ramekin [command] [flags]"
+      $stderr.puts "usage: ramekin [--pack NAME=PATH] [command] [flags]"
       $stderr.puts "    (default command: compile)"
       $stderr.puts ""
+      $stderr.puts "ramekin --pack my_cool_pack=/path/to/my_cool_pack [...]"
+      $stderr.puts "    Specifies an additional custom sample location."
+      $stderr.puts "    Files compiled this way should use #pack \"my_cool_pack\","
+      $stderr.puts "    and sample paths relative to the deepest common path that"
+      $stderr.puts "    contains .brr files. Use with `package --list my_cool_pack` to"
+      $stderr.puts "    see details."
+      $stderr.puts ""
       $stderr.puts "ramekin compile -i filename.rmk [flags]"
+      $stderr.puts "ramekin compile filename.rmk [flags]"
+      $stderr.puts "ramekin filename.rmk [flags]"
       $stderr.puts "    flags:"
       $stderr.puts "        -h --help"
       $stderr.puts "            display this message"
@@ -388,15 +397,21 @@ module Ramekin
         return 0
       end
 
-      case argv[0]
-      when 'compile'
-        compile(*argv[1..])
-      when 'package', 'pack'
-        package(*argv[1..])
-      when 'setup'
-        setup(*argv[1..])
-      else
-        compile(*argv)
+      while argv.any?
+        case (arg = argv.shift)
+        when '--pack'
+          pack = argv.shift or fail! '--pack missing a pack definition NAME=PATH'
+          pack =~ /\A(.*?)=(.*)\z/ or fail! 'invalid --pack, must be of the form NAME=PATH'
+          SamplePack.add_custom($1, File.expand_path($2))
+        when 'compile'
+          return compile(*argv)
+        when 'package', 'pack'
+          return package(*argv)
+        when 'setup'
+          return setup(*argv)
+        else
+          return compile(arg, *argv)
+        end
       end
     end
   end

data/lib/ramekin/meta.rb

@@ -284,17 +284,16 @@ module Ramekin
     end
 
     def adsr
-      @adsr ||= ext_adsr || pack_adsr \
-        or error! "no adsr configured for #{name.value}", el: name
+      @adsr ||= ext_adsr || pack_adsr || [0, 7, 7, 0x1f]
     end
 
     def tuning
-      @tuning ||= ext_tuning || pack_tuning \
-        or error! "no tuning configured for #{name.value}", el: name
+      @tuning ||= ext_tuning || pack_tuning || [0, 0]
     end
 
     def pack_tuning
       _, _, _, d, e = pack_hexes
+      return nil unless d && e
       [d, e]
     end
 
@@ -319,7 +318,7 @@ module Ramekin
     end
 
     def gain
-      @gain ||= ext_gain || pack_gain || 0xFF
+      @gain ||= ext_gain || pack_gain || 0x8F
     end
 
     def hexes
@@ -332,7 +331,7 @@ module Ramekin
       adsr1 = ((7 - d)*16 | 0x80) + (15 - a)
       adsr2 = (s*32 + (31-r))
 
-      [to_hex(adsr1), to_hex(adsr2), g, t1, t2]
+      [adsr1, adsr2, g, t1, t2].map(&method(:to_hex))
     end
 
     def to_hex(x)

data/lib/ramekin/sample_pack.rb

@@ -70,6 +70,12 @@ module Ramekin
     def self.each(&b)
       return enum_for(:each) unless block_given?
 
+      custom_packs.each do |name, path|
+        Dir.chdir(path) do
+          yield CustomSamplePack.new(name, path)
+        end
+      end
+
       Dir.chdir Ramekin.config.packages_dir do
         Dir.entries('.').sort.each do |subd|
           next unless /\A\d+\z/ =~ subd
@@ -80,6 +86,14 @@ module Ramekin
       end
     end
 
+    def self.custom_packs
+      @custom_packs ||= {}
+    end
+
+    def self.add_custom(name, path)
+      custom_packs[name] = path
+    end
+
     def initialize(data)
       @meta = data
     end
@@ -143,7 +157,7 @@ module Ramekin
 
     def find_tunings(name_re)
       raw = []
-      Dir.glob('**/*.txt').sort.each do |entry|
+      Dir.glob('**/*.txt', File::FNM_CASEFOLD).sort.each do |entry|
         next unless File.basename(entry).downcase =~ name_re
 
         contents = File.read(entry, encoding: 'binary')
@@ -169,7 +183,19 @@ module Ramekin
       out
     end
 
-    def index_packs
+    def index_and_save!
+      index!
+
+      File.write('.index.json', JSON.dump(
+        prefix: @prefix,
+        brrs: @brrs,
+        tunings: @tunings,
+      ))
+
+      @cached_index = nil
+    end
+
+    def index!
       paths = []
       raw_tunings = []
 
@@ -177,7 +203,7 @@ module Ramekin
       other_tunings = find_tunings(/\Atuning/)
       misc_tunings = find_tunings(//)
 
-      @brrs = Dir.glob('**/*.brr')
+      @brrs = Dir.glob('**/*.brr', File::FNM_CASEFOLD)
       @brrs.sort!
       @brrs.uniq!
       @prefix = shortest_prefix(@brrs.map(&File.method(:dirname)))
@@ -200,14 +226,6 @@ module Ramekin
 
         @tunings[brr] = candidates.map { |p, _, h| [p, h] }
       end
-
-      File.write('.index.json', JSON.dump(
-        prefix: @prefix,
-        brrs: @brrs,
-        tunings: @tunings,
-      ))
-
-      @cached_index = nil
     end
 
     def cached_index
@@ -235,12 +253,13 @@ module Ramekin
     end
 
     def prefix_dir
+      return dir if prefix == '.'
       File.join(dir, prefix)
     end
 
     def self.download_all!
       smwc_each(&:download)
-      each(&:index_packs)
+      each(&:index_and_save!)
     end
 
     def needs_download?
@@ -298,4 +317,32 @@ module Ramekin
       File.write(meta_file, JSON.dump(@meta))
     end
   end
+
+  class CustomSamplePack < SamplePack
+    attr_reader :dir, :name
+    def initialize(name, dir)
+      @name = name
+      @dir = dir
+    end
+
+    def cached_index
+      @cached_index ||= begin
+        Dir.chdir(dir) { index! }
+
+        {
+          'prefix' => @prefix,
+          'brrs' => @brrs,
+          'tunings' => @tunings,
+        }
+      end
+    end
+
+    def needs_download?
+      false
+    end
+
+    def download
+      # pass
+    end
+  end
 end

metadata

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