ramekin 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f859d4c5dc75cc34a8053dcf5d9958aa48a80aea10d58bb44ac130e1b37c9af0
-  data.tar.gz: b1f2678cb27b008646ad250346c5345c7bf173749ba119d1b42ca5b8dbd3f1f4
+  metadata.gz: a249d3680d6f96fe57c566445a3add42d0287de30bd86a556131963b58b239b8
+  data.tar.gz: df8ab404da547bd42b68fee9ef45d3eeed5c1c46201c997dea2a04cb65a8e0aa
 SHA512:
-  metadata.gz: 5ac7a907935cdb923dd3007b739b257c89262cbd862fd7b987189487330c3b39c6ae762741c5cd91ffa0b8e5f07455ab40ad90fef6178e773db8db32fb9ecf23
-  data.tar.gz: 3ab59a78f14c06923c2f93011567b8fa6a41aa9c5d56ef8121088157b43f7775da6c8c43ebfe497039498348f3583d3c70523e121904922614215c094f410431
+  metadata.gz: 3001f9832d107a892137de8e811c842d972ad226de761e2cd033b79845d455988de28e328c55d14c78215c61a6adb5d11b3819ca35682e66a3c3b9bb0593961c
+  data.tar.gz: b52c6b301948c3400d7c0c7db3cdc4f3da93e1827a352cd927d5fa8c7bf06d06aee67e70b21392002262fee92ede83cef2cbdd69dbf4c11d84ecb55af5e890f1

data/README.md

@@ -42,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
@@ -399,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/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)

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
@@ -115,22 +115,22 @@ module Ramekin
         note = @notes[i]
         to_note = @notes[i+1]
 
+        next unless check_duration!(note, divisor)
+
         if i == 0
           out << note.octave_amk(octave)
+          octave = note.octave_num
           out << note.note_name
         else
           out << '^'
         end
 
-        next unless check_duration!(note, divisor)
-
-        ticks = note.ticks
-        ticks /= divisor
+        ticks = note.ticks / divisor
 
         # 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 << dd(ticks, to_note, octave)
         out << '$f4$01' if @end_legato && i == 0
       end
 
@@ -138,15 +138,9 @@ module Ramekin
       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

@@ -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 || [4, 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/note_aggregator.rb

@@ -107,6 +107,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

@@ -58,7 +58,7 @@ module Ramekin
       yield "; https://codeberg.org/jneen/ramekin\n\n"
 
       # TODO
-      yield "#amk #{@track.meta.amk&.value || 2}\n\n"
+      yield "#amk #{@track.meta.amk&.value || 4}\n\n"
 
       if m.instruments.any?
         yield "#path #{(m.sample_path || @filename.chomp('.rmk')).inspect}\n"
@@ -130,7 +130,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

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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ramekin
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - jneen