rsgt 0.0.1

data/lib/rsgt/unpacked_psarc.rb

@@ -0,0 +1,72 @@
+module RSGuitarTech
+  class UnpackedPSARC
+
+    def self.from_psarc(psarc, opts)
+      raise ArgumentError, "A block is required" unless block_given?
+      raise ArgumentError, "#{psarc} not found!" unless File.exist?(psarc)
+
+      puts "Unpacking psarc to temporary location..."
+      # Use pyrocksmith to unpack the file, and check that it worked..
+      CommandRunner.run! ["pyrocksmith", "--unpack", psarc, "--no-crypto"]
+      expected_extraction = File.basename psarc, ".*"
+      raise ArgumentError unless File.exist?(expected_extraction + "/appid.appid")
+
+      # Move it to a tmpdir, and yield
+      Dir.mktmpdir do |dir|
+        FileUtils.mv expected_extraction, dir
+        yield self.new(psarc, dir, opts)
+      end
+    end
+
+    attr_accessor :psarc, :tmpdir, :opts
+
+    def initialize(psarc, tmpdir, opts)
+      @psarc  = psarc
+      @tmpdir = tmpdir
+      @opts   = opts
+    end
+
+    def repack!
+      puts "Repacking altered psarc..."
+      CommandRunner.run! ["pyrocksmith", "--no-crypto", "--pack", "#{tmpdir}/#{expected_extraction}"]
+      puts "Done! ✅"
+    end
+
+    def expected_extraction
+      File.basename psarc, ".*"
+    end
+
+    def manifest(type)
+      Dir.glob("#{tmpdir}/#{expected_extraction}/manifests/*/*.json").detect { |filename| filename.include? type.to_s }
+    end
+
+    def sng_bin(type)
+      Dir.glob("#{tmpdir}/#{expected_extraction}/songs/bin/macos/*.sng").detect { |filename| filename.include? type.to_s }
+    end
+
+    def sng_xml
+      Dir.glob("#{tmpdir}/#{expected_extraction}/songs/bin/macos/*.xml").first
+    end
+
+    def audio_track(track: :main)
+      audio_tracks[track]
+    end
+
+    def ogg_track
+      audio_tracks[:main].gsub ".wem", ".ogg"
+    end
+
+  private
+
+    def audio_tracks
+      @audio_tracks ||= begin
+        both_wems = Dir.glob("#{tmpdir}/#{expected_extraction}/audio/mac/*.wem").sort_by { |wem| File.stat(wem).size }
+
+        {
+          main:    both_wems.last,
+          preview: both_wems.first
+        }
+      end
+    end
+  end
+end

data/lib/rsgt/version.rb

@@ -0,0 +1,3 @@
+module RSGuitarTech
+  VERSION = "0.0.1"
+end

data/lib/rsgt/vocals_extractor.rb

@@ -0,0 +1,24 @@
+module RSGuitarTech
+  class VocalsExtractor
+
+    attr_accessor :psarc, :opts, :unpacked
+
+    def initialize(opts)
+      @psarc = File.expand_path(opts.delete :psarc)
+      @opts  = opts
+    end
+
+    def extract!
+      puts ".. Extracting vocals from sng to xml..."
+      UnpackedPSARC.from_psarc(psarc, opts) do |unpacked|
+        CommandRunner.run! RSCustomSongToolkit.sng2xml(
+          manifest: unpacked.manifest(:vocals),
+          input:    unpacked.sng_bin(:vocals)
+        )
+        raise StandardError, "Failed to extract vocals" unless File.exist? unpacked.sng_xml
+
+        FileUtils.cp unpacked.sng_xml, "."
+      end
+    end
+  end
+end

data/lib/rsgt/wav_shifter.rb

@@ -0,0 +1,54 @@
+module RSGuitarTech
+  class WavShifter
+
+    attr_accessor :wav, :dir, :amount
+
+    def initialize(opts)
+      @wav    = File.expand_path(opts.delete :wav)
+      @dir    = opts[:dir]
+      @amount = opts[:amount].to_i
+    end
+
+    def shift!
+      case dir
+      when "forward" then forward!
+      when /back/    then backward!
+      end
+    end
+
+  private
+
+    def forward!
+      raise NotImplementedError
+    end
+
+    def backward!
+      Dir.mktmpdir do |tmpdir|
+        puts "Trimming #{amount}ms from beginning..."
+        status = CommandRunner.run! [
+          "ffmpeg", "-i", wav,
+          "-ss", start_trim_timestamp,
+          "-acodec", "copy",
+          "#{tmpdir}/shifted.wav"
+        ]
+        if status.success?
+          puts "Success!"
+          FileUtils.cp "#{tmpdir}/shifted.wav", wav
+        else
+          puts "Failed!"
+        end
+      end
+    end
+
+    TS_CONV = [1, 1000, 60000, 3600000]
+
+    def start_trim_timestamp
+      h  = (amount / TS_CONV[3])
+      m  = (amount % TS_CONV[3] / TS_CONV[2])
+      s  = (amount % TS_CONV[2] / TS_CONV[1])
+      ms = (amount % TS_CONV[1])
+
+      "%02d:%02d:%02d.%03d" % [h, m, s, ms]
+    end
+  end
+end

data/lib/rsgt/wwise_converter.rb

@@ -0,0 +1,99 @@
+module RSGuitarTech
+  class WWiseConverter
+
+    TEMPLATE_TAR_BZ  = "/Applications/RocksmithCustomSongToolkit.app/Contents/Resources/WwiseYEAR.tar.bz2"
+
+    attr_accessor :source_file, :wwise_version, :quality, :chorus, :dir
+
+    def initialize(source_file, opts = {})
+      @source_file   = source_file
+      @wwise_version = opts[:wwise_ver]
+      @quality       = opts[:quality]
+      @chorus        = opts[:chorus]
+    end
+
+    def convert!
+      Dir.mktmpdir do |dir|
+        @dir = dir
+
+        extract_base_template
+        prepare_template
+        copy_source
+        ffmpeg_preview
+        run_wwise
+        if wwise_version[0..3].to_i >= 2016
+          downgrade_headers "#{template_dir}/GeneratedSoundBanks/Windows/144151451.wem"
+          downgrade_headers "#{template_dir}/GeneratedSoundBanks/Windows/309608343.wem"
+        end
+        yield self
+      end
+    end
+
+    def extract_base_template
+      just_tar = template_tar_bz.gsub(".bz2", "")
+      CommandRunner.run! ["bunzip2", "-k", template_tar_bz]     # Unzip Wwise2016.tar.bz2 to Wwise2016.tar
+      CommandRunner.run! ["tar", "-xzvf", just_tar, "-C", dir]  # Untar Wwise2016.tar to the workdir
+    end
+
+    def prepare_template
+      CommandRunner.run! ["mkdir", "-p", "#{template_dir}/.cache/Windows/SFX"]
+      CommandRunner.run! ["sed", "-i.bak", "'s/%QF1%/#{quality}/'", default_work_unit.shellescape], skip_escaping: true
+      CommandRunner.run! ["sed", "-i.bak", "'s/%QF2%/#{quality}/'", default_work_unit.shellescape], skip_escaping: true
+    end
+
+    def copy_source
+      FileUtils.cp source_file, "#{template_dir}/Originals/SFX/Audio.wav"
+    end
+
+    def ffmpeg_preview
+      CommandRunner.run! ["ffmpeg", "-i", source_file, "-ss", chorus, "-t", "30", "#{template_dir}/Originals/SFX/Audio_preview.wav"]
+    end
+
+    def run_wwise
+      wwise_cmd = [
+        wwise_cli,
+        "#{template_dir}/Template.wproj",
+        "-GenerateSoundBanks",
+        "-Platform",
+        "Windows",
+        "-NoWwiseDat",
+        "-ClearAudioFileCache",
+        "-Save"
+      ]
+      wwise_cmd << "-Verbose" if RSGuitarTech.verbose
+      CommandRunner.run! wwise_cmd
+    end
+
+    def downgrade_headers(file)
+      CommandRunner.run! %Q{printf "$(printf '\\x%02X' 03)" | dd of=#{file} bs=1 seek=40 count=1 conv=notrunc}, skip_escaping: true
+      CommandRunner.run! %Q{printf "$(printf '\\x%02X' 00)" | dd of=#{file} bs=1 seek=41 count=1 conv=notrunc}, skip_escaping: true
+      CommandRunner.run! %Q{printf "$(printf '\\x%02X' 00)" | dd of=#{file} bs=1 seek=42 count=1 conv=notrunc}, skip_escaping: true
+      CommandRunner.run! %Q{printf "$(printf '\\x%02X' 00)" | dd of=#{file} bs=1 seek=43 count=1 conv=notrunc}, skip_escaping: true
+    end
+
+    def results
+      {
+        main:    "#{template_dir}/GeneratedSoundBanks/Windows/144151451.wem",
+        preview: "#{template_dir}/GeneratedSoundBanks/Windows/309608343.wem"
+      }
+    end
+
+  private
+
+    def template_dir
+      "#{dir}/Template"
+    end
+
+    def template_tar_bz
+      TEMPLATE_TAR_BZ.dup.gsub "YEAR", wwise_version[0..3]
+    end
+
+    def wwise_cli
+      "/Applications/Audiokinetic/Wwise #{wwise_version}/Wwise.app/Contents/Tools/WwiseCLI.sh"
+    end
+
+    def default_work_unit
+      "#{template_dir}/Interactive Music Hierarchy/Default Work Unit.wwu"
+    end
+  end
+end

data/rsgt.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rsgt/version"
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = "rsgt"
+  s.version     = RSGuitarTech::VERSION
+  s.authors     = ["Justin Aiken"]
+  s.email       = ["60tonangel@gmail.com"]
+  s.license     = "MIT"
+  s.homepage    = "https://github.com/JustinAiken/rsgt"
+  s.summary     = %q{Rocksmith}
+  s.description = %q{Rocksmith}
+
+  s.rubyforge_project = "rsgt"
+
+  s.files           = `git ls-files`.split("\n")
+  s.test_files      = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths   = ["lib"]
+  s.bindir          = "bin"
+  s.executables     = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+
+  s.add_dependency "bindata"
+  s.add_dependency "trollop",       "~> 2.1"
+  s.add_dependency "rainbow",       "~> 2.2"
+  s.add_dependency "activesupport", ">= 3.0"
+
+  s.add_development_dependency "rspec", "~> 3.5"
+  s.add_development_dependency "pry"
+end

data/spec/lib/rsgt/audio_extractor_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe RSGuitarTech::AudioExtractor do
+  let(:extractor) { described_class.new psarc: psarc }
+  let(:psarc)     { "foo_m.psarc" }
+
+  describe "#extract!" do
+    it "extracts" do
+      allow(extractor).to receive :puts
+      expect(RSGuitarTech::UnpackedPSARC).to receive :from_psarc
+      extractor.extract!
+    end
+  end
+end

data/spec/lib/rsgt/command_runner_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+describe RSGuitarTech::CommandRunner do
+  let(:runner)        { described_class  }
+  let(:args)          { "ls" }
+  let(:skip_escaping) { false }
+  subject(:run!)      { runner.run! args, skip_escaping: skip_escaping }
+
+  it { should be_success }
+
+  context "with spaces" do
+    let(:args) { "ls -al" }
+
+    after { run! }
+
+    it "escapes the command" do
+      expect(Open3).to receive(:capture3).with "ls\\ -al"
+    end
+
+    context "but skip_escaping: true" do
+      let(:skip_escaping) { true }
+
+      it "runs the command as-is" do
+        expect(Open3).to receive(:capture3).with "ls -al"
+      end
+    end
+  end
+
+  context "verbosely" do
+    before { allow(RSGuitarTech).to receive(:verbose).and_return true }
+
+    it "does some puts" do
+      expect_any_instance_of(described_class).to receive(:puts).at_least :once
+      run!
+    end
+  end
+end

data/spec/lib/rsgt/repacker_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe RSGuitarTech::Repacker do
+  let(:repacker)   { described_class.new psarc: "foo_m.psarc", vocals_xml: vocals_xml, audio: audio }
+  let(:vocals_xml) { "foo_vocals.xml" }
+  let(:audio)      { "audio.wav" }
+
+  let(:unpacked)  { double RSGuitarTech::UnpackedPSARC, manifest: "manifest.json", audio_track: "track.wem" }
+  let(:converter) { double RSGuitarTech::WWiseConverter, results: {main: "main.wav"} }
+
+  describe "#repack!" do
+    before { allow(repacker).to receive :puts }
+
+    it "repacks" do
+      expect(RSGuitarTech::UnpackedPSARC).to receive(:from_psarc).and_yield unpacked
+      expect_any_instance_of(RSGuitarTech::WWiseConverter).to receive(:convert!).and_yield converter
+      expect(FileUtils).to receive(:cp).with "main.wav", "track.wem"
+      expect(RSGuitarTech::CommandRunner).to receive :run!
+      expect(unpacked).to receive :repack!
+
+      repacker.repack!
+    end
+  end
+end

data/spec/lib/rsgt/rs_custom_song_toolkit_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe RSGuitarTech::RSCustomSongToolkit do
+  let(:rs_custom) { described_class  }
+
+  it ".ww2ogg" do
+    expect(rs_custom.ww2ogg "foo.wem").to eq [
+      "wine",
+      "/Applications/RocksmithCustomSongToolkit.app/Contents/Resources/ww2ogg.exe",
+      "foo.wem",
+      "--pcb",
+      described_class::PCB_PATH
+    ]
+  end
+
+  it ".revorb" do
+    expect(rs_custom.revorb "foo.ogg").to eq [
+      "wine",
+      "/Applications/RocksmithCustomSongToolkit.app/Contents/Resources/revorb.exe",
+      "foo.ogg"
+    ]
+  end
+
+  it ".sng2xml" do
+    expect(rs_custom.sng2xml manifest: "manifest.json", input: "foo.sng").to eq [
+      "wine",
+      "/Applications/RocksmithCustomSongToolkit.app/Contents/Resources/sng2014.exe",
+      "--sng2xml",
+      "--manifest=manifest.json",
+      "--input=foo.sng",
+      "--arrangement=Vocal",
+      "--platform=Mac"
+    ]
+  end
+
+  it ".xml2sng" do
+    expect(rs_custom.xml2sng manifest: "manifest.json", input: "foo.xml").to eq [
+      "wine",
+      "/Applications/RocksmithCustomSongToolkit.app/Contents/Resources/sng2014.exe",
+      "--xml2sng",
+      "--manifest=manifest.json",
+      "--input=foo.xml",
+      "--arrangement=Vocal",
+      "--platform=Mac"
+    ]
+  end
+end

data/spec/lib/rsgt/saved_game/learn_a_song/song_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe RSGuitarTech::SavedGame::LearnASong::Song do
+  pending ".from"
+
+  describe "#==" do
+    subject      { described_class.new id: "123", timestamp: nil, dynamic_difficulty: nil, play_next_stats: nil }
+    let(:song_b) { described_class.new id: "123", timestamp: nil, dynamic_difficulty: nil, play_next_stats: nil }
+    let(:song_c) { described_class.new id: "456", timestamp: nil, dynamic_difficulty: nil, play_next_stats: nil }
+
+    it { should eq     song_b }
+    it { should_not eq song_c }
+    it { should_not eq nil }
+  end
+end

data/spec/lib/rsgt/saved_game_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe RSGuitarTech::SavedGame do
+  let(:saved_game) { described_class.new json, :filename }
+
+  pending ".from"
+
+  describe "#options" do
+    subject    { saved_game.options }
+    let(:json) { {"Options" => {"foo" => "bar"}} }
+    it         { should eq "foo" => "bar" }
+  end
+
+  describe "#statistics" do
+    subject    { saved_game.statistics }
+    let(:json) { {"Stats" => {"foo" => "bar"}} }
+    it         { should be_a RSGuitarTech::SavedGame::Statistics }
+  end
+
+  describe "#song_statistics" do
+    subject(:song_statistics) { saved_game.song_statistics }
+    let(:json)                { {"Stats" => {"Songs" => {"abc" => "songdata"}}} }
+    it                        { should be_a RSGuitarTech::SavedGame::SongCollection }
+
+    it "is a keyed collection of Statistics::Song's" do
+      expect(song_statistics["abc"]).to be_a RSGuitarTech::SavedGame::Statistics::Song
+    end
+  end
+
+  describe "#score_attack" do
+    subject(:score_attack) { saved_game.score_attack }
+    let(:json)                { {"SongsSA" => {"abc" => "songdata"}} }
+    it                        { should be_a RSGuitarTech::SavedGame::SongCollection }
+
+    it "is a keyed collection of Statistics::Song's" do
+      expect(score_attack["abc"]).to be_a RSGuitarTech::SavedGame::ScoreAttack::Song
+    end
+  end
+
+  describe "#learn_a_song" do
+    subject(:learn_a_song) { saved_game.learn_a_song }
+    let(:json)                { {"Songs" => {"abc" => "songdata"}} }
+    it                        { should be_a RSGuitarTech::SavedGame::SongCollection }
+
+    it "is a keyed collection of Statistics::Song's" do
+      expect(learn_a_song["abc"]).to be_a RSGuitarTech::SavedGame::LearnASong::Song
+    end
+  end
+end