ramekin 0.0.5b

data/lib/ramekin/cli.rb

@@ -0,0 +1,367 @@
+module Ramekin
+  class CLI
+    include Util
+
+    def self.main(*argv)
+      new.main(*argv)
+    end
+
+    def tempfiles
+      @tempfiles ||= []
+    end
+
+    def tempfile(fname)
+      dir = Dir.mktmpdir
+      tempfiles << dir
+      "#{dir}/#{fname}"
+    end
+
+    def usage
+      $stderr.puts "Ramekin version #{RAMEKIN_VERSION}"
+      $stderr.puts ""
+      $stderr.puts "usage: ramekin [command] [flags]"
+      $stderr.puts "    (default command: compile)"
+      $stderr.puts ""
+      $stderr.puts "ramekin compile -i filename.rmk [flags]"
+      $stderr.puts "    flags:"
+      $stderr.puts "        -h --help"
+      $stderr.puts "            display this message"
+      $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 "        --spc filename.spc"
+      $stderr.puts "            attempt to invoke AddmusicK to output an SPC"
+      $stderr.puts "            requires ADDMUSICK_DIR and ASAR_COMMAND"
+      $stderr.puts "            to be set."
+      $stderr.puts "        --play"
+      $stderr.puts "            play the generated SPC file. will automatically"
+      $stderr.puts "            set up an SPC player if none is detected."
+      default_text = if Ramekin.config.windows?
+        '(installs spcplay.exe, which can render WAVs)'
+      else
+        '(compiles and installs spct - requires git,cmake,make)'
+      end
+      $stderr.puts "            #{default_text}"
+      unless Ramekin.config.windows?
+        $stderr.puts "        --wav filename.wav"
+        $stderr.puts "        --wav filename.wav:N"
+        $stderr.puts "            render N seconds of the file to WAV. Requires spct."
+      end
+      $stderr.puts ""
+      $stderr.puts "ramekin package [flags]"
+      $stderr.puts "    flags:"
+      $stderr.puts "        --update"
+      $stderr.puts "            download BRR packages from SMW Central."
+      $stderr.puts "        --search [text]"
+      $stderr.puts "            search for BRR filenames."
+      $stderr.puts "        --list [text]"
+      $stderr.puts "            list all samples in packages matching [text]."
+      $stderr.puts ""
+      $stderr.puts "ramekin setup [flags]"
+      $stderr.puts "    flags:"
+      $stderr.puts "        --amk"
+      $stderr.puts "            downloads and sets up AddMusicK and asar."
+      unless Ramekin.config.windows?
+        $stderr.puts "            (requires cmake and make to be available)"
+      end
+      $stderr.puts "        --packages"
+      $stderr.puts "            downloads packages from SMW Central."
+      $stderr.puts "            (equivalent to package --update)"
+      $stderr.puts "        --spc"
+      $stderr.puts "            downloads and sets up a default SPC player."
+      $stderr.puts "        --all (default)"
+      $stderr.puts "            runs all of the above setup steps"
+      $stderr.puts "        --force"
+      $stderr.puts "            deletes and redownloads files instead of skipping."
+    end
+
+    def usage!(message)
+      $stderr.puts(message)
+      $stderr.puts
+      usage
+
+      exit 1
+    end
+
+    def fail!(message)
+      $stderr.puts(message)
+      $stderr.puts
+
+      exit 1
+    end
+
+    def compile(*argv)
+      @force = false
+      @play = false
+
+      while (h = argv.shift)
+        case h
+        when '--version', '-V'
+          puts RAMEKIN_VERSION
+          return 0
+        when '--help', '-help', '-h', '-?'
+          usage
+          return 0
+        when '--txt'
+          @output_txt = argv.shift or usage! 'missing filename after --txt'
+        when '--spc'
+          @output_spc = argv.shift or usage! 'missing filename after --spc'
+        when '--package'
+          @output_package = argv.shift or usage! 'missing dirname after --package'
+        when '--play'
+          @play = true
+        when '--wav'
+          arg = argv.shift or usage! 'missing wav file after --render'
+          @wav_file, @wav_seconds = arg.split(':')
+          @wav_seconds ||= ENV['SECONDS'] || 60
+          @wav_seconds = @wav_seconds.to_i or usage! 'invalid number of seconds'
+        when '--force', '-f'
+          @force = true
+        when '-i'
+          @infile = argv.shift or usage! 'missing filename after -i'
+        when '-v', '--verbose'
+          @verbose = true
+        when /\A-/
+          usage! "unknown argument #{h}"
+        else
+          @infile = h
+        end
+      end
+
+      # if we want to play or render wav, we have to make sure we
+      # have a path to render the SPC file to.
+      if @play || @wav_file
+        if @output_package
+          @play_spc = "#@output_package/#{File.basename(@infile)}.spc"
+        elsif @output_spc
+          @play_spc = @output_spc
+        else
+          @output_spc = @play_spc = tempfile("#{File.basename(@infile)}.spc")
+        end
+      end
+
+      usage! 'missing infile (use -i)' if @infile.nil?
+      @infile = File.expand_path(@infile)
+      fail! "can't find a file at #{@infile}" unless File.exist?(@infile)
+
+      source = begin
+        File.read(@infile)
+      rescue
+        fail! "couldn't read the file at #{@infile}"
+      end
+
+      tokens = Tokenizer.tokenize(source).to_a
+
+      outer_chain = Processor.compose(
+        MacroExpander,
+        ScanForL,
+      )
+
+      expanded = outer_chain.call(tokens)
+
+      channels = ChannelSeparator.parse(expanded)
+
+      inner_chain = Processor.compose(
+        NoteAggregator,
+        RestAggregator,
+        Legato,
+        Inspector,
+      )
+
+      channels.channels.map! do |c|
+        next if c.nil?
+
+        inner_chain.call(c)
+      end
+
+
+      txt = Renderer.render(@infile, channels)
+
+      if Error.any?
+        puts "errors:"
+        puts
+        Error.all.each do |error|
+          puts error.present(source)
+        end
+
+        exit 1
+      end
+
+      unless @output_txt || @output_package || @output_spc
+        warn <<~WARN
+          no output specified. use either:
+            --txt my_cool_file.txt
+            --spc my_cool_file.spc
+            --package my_cool_output_dir
+            --play
+            --wav my_cool_file.wav
+        WARN
+      end
+
+      if @output_txt
+        File.write(@output_txt, txt)
+      end
+
+      if @output_spc || @output_package
+        runner = AMKRunner.new(@infile, channels.meta, txt)
+        runner.compile
+      end
+
+      FileUtils.cp(runner.spc_file, @output_spc) if @output_spc
+      if @output_package
+        clear_dir(@output_package, force: @force) or exit 1
+        runner.export(@output_package)
+
+        $stderr.puts <<~MSG
+          Package directory generated at #{@output_package}
+        MSG
+
+        $stderr.puts <<~MSG unless channels.meta.readme
+          Please remember to edit README.txt!
+        MSG
+      end
+
+      if @wav_file
+        SPCPlayer.instance.setup!
+        SPCPlayer.instance.render(@play_spc, @wav_file, @wav_seconds)
+      end
+
+      if @play
+        SPCPlayer.instance.setup!
+        SPCPlayer.instance.play(@play_spc)
+      end
+
+      if @verbose
+        aggregated.each do |a|
+          puts a.inspect
+        end
+      end
+
+      tempfiles.each { |path| FileUtils.rm_r(path) if path && !path.empty? }
+    end
+
+    def package(*argv)
+      @mode = nil
+      @update = false
+      @search = nil
+      while (h = argv.shift)
+        case h
+        when '--update'
+          @update = true
+        when '--search'
+          @mode = :search
+          @term = argv.shift || ''
+        when '--list'
+          @mode = :list
+          @term = argv.shift || ''
+        end
+      end
+
+      if @update
+        $stderr.puts "=== updating packages... ==="
+        SamplePack.download_all!
+      end
+
+      case @mode
+      when :search
+        search(@term, list_matched: false, search_brr: true)
+      when :list
+        search(@term, list_matched: true, search_brr: false)
+      end
+    end
+
+    def setup(*argv)
+      @force = false
+      @setup_packages = false
+      @setup_amk = false
+      @default_action = true
+      while (h = argv.shift)
+        case h
+        when '--all'
+          @setup_packages = true
+          @setup_amk = true
+          @setup_spc = true
+          @default_action = false
+        when '--amk'
+          @setup_amk = true
+          @default_action = false
+        when '--packages'
+          @setup_packages = true
+          @default_action = false
+        when '--spc'
+          @setup_spc = true
+          @default_action = false
+        when '--force'
+          @force = true
+        end
+      end
+
+      if @default_action
+        @setup_packages = true
+        @setup_amk = true
+      end
+
+      if @setup_amk
+        AMKSetup.setup!(force: @force)
+      end
+
+      if @setup_spc
+        SPCPlayer.instance.setup!
+      end
+
+      if @setup_packages
+        SamplePack.download_all!
+      end
+    end
+
+    def search(term, list_matched: false, search_brr: false)
+      term = term.downcase
+
+      SamplePack.each do |package|
+        matched_pack = package.name.downcase.include?(term)
+
+        matched_brr = package.unprefixed_brrs.select do |brr|
+          brr.downcase.include?(term)
+        end if search_brr
+
+        if search_brr && matched_brr.any?
+          puts "#pack #{package.name.inspect}"
+          dump_brrs(package, matched_brr)
+        elsif matched_pack
+          puts "#pack #{package.name.inspect}"
+          if list_matched
+            dump_brrs(package, package.unprefixed_brrs)
+          end
+        end
+      end
+    end
+
+    def dump_brrs(pack, brrs)
+      brrs.each do |brr|
+        tunings = pack.tunings_for(brr)
+        out = "  #{brr.inspect}"
+        out << " (#{tunings.size} tunings)" if tunings.size != 1
+        puts out
+      end
+    end
+
+    def main(*argv)
+      if argv.empty?
+        usage
+        return 0
+      end
+
+      case argv[0]
+      when 'compile'
+        compile(*argv[1..])
+      when 'package'
+        package(*argv[1..])
+      when 'setup'
+        setup(*argv[1..])
+      else
+        compile(*argv)
+      end
+    end
+  end
+end

data/lib/ramekin/config.rb

@@ -0,0 +1,126 @@
+require 'yaml'
+
+module Ramekin
+  HOME = File.expand_path(ENV['RAMEKIN_HOME'] || RAMEKIN_HOME)
+
+  FileUtils.mkdir_p(HOME)
+
+  Dir.chdir(HOME) do
+    if RbConfig::CONFIG['SOEXT'] == 'dll'
+      default_player_action = 'automatically download and run spcplay.exe from SMW Central'
+    else
+      default_player_action = 'automatically download, compile and run spct from jneen\'s codeberg'
+    end
+
+    File.write('config.yml', <<~YML) unless File.exist?('config.yml')
+      # This file configures various options for Ramekin.
+      # Lines beginning with # are comments.
+      # For each option, the default value is shown.
+
+      # File paths are relative to the directory this file is in,
+      # or the environment variable RAMEKIN_HOME.
+
+      # Override where Ramekin should find / install AddmusicK
+      # also overrideable with env var RAMEKIN_AMK_DIR
+      # amk_dir: ./addmusick
+
+      # Override where Ramekin should find / install asar
+      # also overrideable with env var RAMEKIN_ASAR_DIR
+      # asar_dir: ./asar
+
+      # Override where Ramekin stores packages from SMW Central
+      # also overrideable with env var RAMEKIN_PACKAGES_DIR
+      # packages_dir: ./packages
+
+      # Use a custom command for playing SPC files.
+      # Either a command line string, or the special setting __auto__,
+      # which will #{default_player_action}.
+      #
+      # also overrideable with env var RAMEKIN_SPC_PLAYER
+      #
+      # spc_player: __auto__
+      # spc_player: C:\\Users\\jneen\\Desktop\\spcplay\\spcplay.exe
+      # spc_player: /path/to/bin/spct
+
+    YML
+  end
+
+  class Config
+    def initialize(file)
+      @raw = YAML.load_file(file) || {}
+    end
+
+    def lib_ext
+      RbConfig::CONFIG['SOEXT']
+    end
+
+    def windows?
+      lib_ext == 'dll'
+    end
+
+    def macos?
+      lib_ext == 'dylib'
+    end
+
+    def linux?
+      lib_ext == 'so'
+    end
+
+    def raw_option(upname, downname, default)
+      ENV[upname] || @raw[downname] || Object.const_get(upname)
+    end
+
+    def option(upname, downname, default)
+      expand(raw_option(upname, downname, default))
+    end
+
+    def amk_dir
+      option('RAMEKIN_AMK_DIR', 'amk_dir', 'addmusick')
+    end
+
+    def asar_dir
+      option('RAMEKIN_ASAR_DIR', 'asar_dir', 'asar')
+    end
+
+    def spc_player
+      raw_option('RAMEKIN_SPC_PLAYER', 'spc_player', '__auto__')
+    end
+
+    def asar_lib
+      try_asar_lib or begin
+        $stderr.puts "can't find asar lib. did you compile it?"
+        exit 1
+      end
+    end
+
+    def try_asar_lib
+      return nil unless Dir.exist?(asar_dir)
+
+      path = Dir.chdir(asar_dir) do
+        Dir.glob('asar/lib/*').find do |f|
+          next unless File.file?(f)
+          next if File.symlink?(f)
+          f.end_with?(lib_ext)
+        end
+      end
+
+      path && File.expand_path(path, asar_dir)
+    end
+
+    def packages_dir
+      expand(ENV['RAMEKIN_PACKAGES_DIR'] || @raw['packages_dir'] || 'packages')
+    end
+
+    def expand(path)
+      File.expand_path(path, HOME)
+    end
+  end
+
+  def self.config
+    @config ||= Config.new("#{HOME}/config.yml")
+  end
+
+  FileUtils.mkdir_p(config.packages_dir)
+  FileUtils.mkdir_p(config.asar_dir) unless config.windows?
+  FileUtils.mkdir_p(config.amk_dir)
+end

data/lib/ramekin/element.rb

@@ -0,0 +1,24 @@
+module Ramekin
+  class Element
+    def self.make(components, *a)
+      new(*a).tap { |e| e.components = components }
+    end
+
+    attr_accessor :components
+    attr_accessor :start_tick
+    attr_accessor :channel
+
+    attr_writer :macro_stack
+    def macro_stack
+      @macro_stack ||= []
+    end
+
+    def start
+      @components.first.start
+    end
+
+    def fin
+      @components.last.fin
+    end
+  end
+end

data/lib/ramekin/errors.rb

@@ -0,0 +1,57 @@
+module Ramekin
+  class Error
+    def self.all
+      @all ||= []
+    end
+
+    def self.any?
+      all.size > 0
+    end
+
+    def self.last
+      all.last
+    end
+
+    def self.error!(e, nesting: 0)
+      all << e
+
+      if ENV['RAMEKIN_DEBUG']
+        if nesting >= 0
+          Pry.config.hooks.add_hook(:before_session, :ramekin) do |output, binding, pry|
+            Pry.config.hooks.delete_hook(:before_session, :ramekin)
+            pry.run_command("up #{nesting + 1}")
+          end
+        end
+
+        binding.pry
+      end
+    end
+
+    def initialize(start, fin, message)
+      @start = start
+      @range = LocRange.between(start, fin)
+      @message = message
+    end
+
+    def present(orig)
+      out = []
+      out << "line #{@range.start.line}, col #{@range.start.col}:"
+      out << "  ---"
+      out << "  #{orig[@range.pos_range]}"
+      out << "  ---"
+      out << "  #{@message}"
+    end
+
+    module Helpers
+    private
+      def error!(message, el: nil, nesting: 0)
+        el ||= @current
+        Error.error!(Error.new(el, el, message), nesting: nesting + 1)
+      end
+
+      def default_error_location
+        @current
+      end
+    end
+  end
+end

data/lib/ramekin/legato.rb

@@ -0,0 +1,142 @@
+module Ramekin
+  class LegatoStart < Element
+    def to_amk
+      '$f4$01'
+    end
+
+    def inspect
+      'legato-start'
+    end
+  end
+
+  class NoteWrapper < NoteEvent
+    def initialize(note)
+      @note = note
+    end
+
+    def rest?
+      @note.rest?
+    end
+
+    def octave_amk(*a)
+      @note.octave_amk(*a)
+    end
+
+    def note_name
+      @note.note_name
+    end
+  end
+
+  class LegatoLastNote < NoteWrapper
+    def ticks
+      @note.ticks / 2
+    end
+
+    def to_amk(current_octave=nil)
+      post_ticks = @note.ticks - ticks
+      post_len = KNOWN_LENGTHS.fetch(post_ticks) { "=#{post_ticks}" }
+      "#{octave_amk(current_octave)}#{note_name}#{length_amk}$f4$01^#{post_len}"
+    end
+
+    def inspect
+      "legato-end(#{@note.inspect})"
+    end
+  end
+
+  class Legato < Processor
+    def initialize
+      @in_legato = false
+      @seen_legato = false
+    end
+
+    def flush_legato!(&b)
+      non_notes = []
+      non_notes << buffer.pop while buffer.any? && !buffer.last.is_a?(NoteEvent)
+
+      return if buffer.empty?
+      return flush!(&b) if buffer.size == 1
+
+      yield LegatoStart.new
+      last = buffer.pop
+      error! "legato marks must follow a note", el: last unless NoteEvent === last
+      buffer.each(&b)
+      yield LegatoLastNote.new(last)
+      buffer.clear
+    ensure
+      non_notes.reverse_each(&b)
+    end
+
+    TIEABLE_EVENTS = %i(
+      amp
+      y
+      rely
+      v
+      relv
+      o
+      p
+      hex
+      octave
+      transpose
+      adsr
+      bpm
+    )
+    def call(&b)
+      return enum_for(:process) unless block_given?
+
+      each do |el|
+        if @in_legato
+          if NoteEvent === el
+            if @seen_legato
+              @seen_legato = false
+              buffer << el
+            else
+              @in_legato = false
+              @seen_legato = false
+              flush_legato!(&b)
+              buffer!(el, &b)
+            end
+          elsif Token === el && el.type == :amp
+            @seen_legato = true
+            buffer << el
+          elsif Token === el && el.type == :legato_tie
+            @seen_legato = true
+          elsif Token === el && TIEABLE_EVENTS.include?(el.type)
+            buffer << el
+          else
+            @in_legato = false
+            @seen_legato = false
+            flush_legato!(&b)
+            yield el
+          end
+        else
+          if NoteEvent === el
+            flush!(&b)
+            buffer!(el, &b)
+          elsif Token === el && TIEABLE_EVENTS.include?(el.type)
+            buffer << el
+          elsif Token === el && el.type == :legato_tie
+            @seen_legato = true
+            @in_legato = true
+          else
+            flush!(&b)
+            yield el
+          end
+        end
+      end
+
+      if @in_legato
+        flush_legato!(&b)
+      else
+        flush!(&b)
+      end
+    end
+
+    def buffer!(note, &b)
+      if note.rest?
+        yield note
+      else
+        buffer << note
+      end
+    end
+  end
+end