futurocube 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0db85c1e614f4be0889f66a3d31a57bcdcac83a7
+  data.tar.gz: 848407ce6ed8c34a287692de074ac4177ab4a38d
+SHA512:
+  metadata.gz: 770c7d4393e7462ae84d745f25a3f01d002251256c34f6d8ab33838eaa7094eb74892848d7ae923e90fd817f4d0a5e0adca37cc6222b91968482163d6f7f543b
+  data.tar.gz: 56228bdd075aadb06a92a344d491efab75e40dd660a3355455f617fe57bb37a952343e08f282d04d8074e4d52388261a36e2bfc795c4c8ff15362d0bd5c98242

data/COPYING.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Trejkaz
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    futurocube (0.1.0)
+      bindata
+      progressbar
+      wavefile
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bindata (1.6.0)
+    diff-lcs (1.2.4)
+    multi_json (1.8.1)
+    progressbar (0.21.0)
+    rake (0.9.6)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    wavefile (0.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  futurocube!
+  rake
+  rspec
+  simplecov

data/README.md

@@ -0,0 +1,26 @@
+# FuturoCube
+
+[Rubik's Futuro Cube][1] is a neat toy made by Princip Interactive which basically embeds a
+microprocessor in a cube covered with LEDs.
+
+I started this project to mess with files which the SDK doesn't yet let you customise.
+
+[1]: http://www.futurocube.com/
+
+## Installation
+
+Install the gem:
+
+    $ gem install futurocube
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/bin/fcrestool

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'futurocube'
+
+FuturoCube::ResourceTool.new.main(ARGV)

data/futurocube.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'futurocube/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'futurocube'
+  spec.version       = FuturoCube::VERSION
+  spec.authors       = ['Trejkaz']
+  spec.email         = ['trejkaz@trypticon.org']
+  spec.description   = %q{Tools for messing with FuturoCube data}
+  spec.summary       = %q{Contains tools and parsers for messing with data for the Rubik's FuturoCube.}
+  spec.homepage      = 'https://github.com/trejkaz/futurocube'
+  spec.license       = 'MIT'
+
+  spec.files         = [ "COPYING.txt", "Gemfile", "Gemfile.lock", "README.md",
+                         "Rakefile", "#{spec.name}.gemspec" ] +
+                       Dir.glob("bin/*") +
+                       Dir.glob("lib/**/*.rb") +
+                       Dir.glob("spec/**/*.rb")
+
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_runtime_dependency 'bindata'
+  spec.add_runtime_dependency 'wavefile'
+  spec.add_runtime_dependency 'progressbar'
+end

data/lib/futurocube.rb

@@ -0,0 +1,2 @@
+require 'futurocube/version'
+require 'futurocube/resource_tool'

data/lib/futurocube/command_helper.rb

@@ -0,0 +1,14 @@
+require 'progressbar'
+
+module FuturoCube
+  module CommandHelper
+    def with_progress(title, total, &block)
+      progress = ProgressBar.new(title, total)
+      begin
+        block.call(progress)
+      ensure
+        progress.finish
+      end
+    end
+  end
+end

data/lib/futurocube/crc.rb

@@ -0,0 +1,50 @@
+class CRC
+  def initialize
+    @table = make_table(0x04C11DB7)
+    reset
+  end
+
+  def reset
+    @crc = 0xFFFFFFFF
+  end
+
+  def update(input)
+    crc = @crc
+    table = @table
+
+    # Original algorithm does it little-endian then iterates from the high byte.
+    # I read it big-endian and then iterate from the low byte, saving some bit maths.
+    input.unpack('N*').each do |data|
+      4.times do
+        table_index = (data & 0xFF) ^ (crc >> 24)
+        crc = (crc << 8) & 0xFFFFFFFF
+        crc = crc ^ table[table_index]
+        data >>= 8
+      end
+    end
+
+    @crc = crc
+  end
+
+  def crc
+    @crc
+  end
+
+private
+
+  def make_table(poly)
+    (0..255).map do |n|
+      crc = n << 24
+      8.times do
+        if crc & 0x80000000 != 0
+          crc = ((crc << 1) ^ poly) & 0xFFFFFFFF
+        else
+          crc <<= 1
+        end
+      end
+      (crc & 0xFFFFFFFF)
+    end
+  end
+
+end
+

data/lib/futurocube/dump_command.rb

@@ -0,0 +1,39 @@
+require 'wavefile'
+
+require_relative 'resource_file'
+require_relative 'command_helper'
+
+module FuturoCube
+  class DumpCommand
+    include CommandHelper
+
+    def exec(file, dir)
+      ResourceFile.open(file) do |rf|
+        with_progress('Dumping', rf.records.size) do |progress|
+          rf.records.each do |rec|
+            data = rf.data(rec)
+
+            f = File.join(dir, "#{rec.name}.wav")
+            format = WaveFile::Format.new(:mono, :pcm_16, 22050)
+            WaveFile::Writer.new(f, format) do |writer|
+              #TODO: is there a way to write a buffer directly?
+              samples = data.unpack("S<*")
+              buffer = WaveFile::Buffer.new(samples, format)
+              writer.write(buffer)
+            end
+
+            progress.inc
+          end
+        end
+      end
+    end
+
+    def args_valid?(args)
+      args.length == 2
+    end
+
+    def usage
+      "filename directory"
+    end
+  end
+end

data/lib/futurocube/list_command.rb

@@ -0,0 +1,21 @@
+require_relative 'resource_file'
+
+module FuturoCube
+  class ListCommand
+    def exec(file)
+      ResourceFile.open(file) do |rf|
+        rf.records.each do |rec|
+          puts "#{rec.name.ljust(20)}   #{rec.data_length.to_s.rjust(10)}"
+        end
+      end
+    end
+
+    def args_valid?(args)
+      args.length == 1
+    end
+
+    def usage
+      "filename"
+    end
+  end
+end

data/lib/futurocube/resource_file.rb

@@ -0,0 +1,103 @@
+require 'bindata'
+
+require_relative 'crc'
+
+module FuturoCube
+  class ResourceFile
+    class FileHeader < BinData::Record
+      endian :little
+      uint32 :magic
+      uint32 :checksum
+      uint32 :version
+      uint32 :created
+      string :name, :length => 20, :trim_padding => true
+      uint32 :record_count
+      uint32 :file_size
+    end
+
+    class ResourceRecord < BinData::Record
+      endian :little
+      string :name, :length => 20, :trim_padding => true
+      uint32 :format
+      uint32 :data_offset
+      uint32 :data_length
+    end
+
+    attr_reader :header, :records
+
+    def initialize(io)
+      @io = io
+    end
+
+    # Reads the header from the resource file.
+    def header
+      if !@header
+        @io.seek(0, IO::SEEK_SET)
+        @header = FileHeader.read(@io)
+      end
+      @header
+    end
+
+    # Reads the list of records from the resource file.
+    def records
+      if !@records
+        @io.seek(44, IO::SEEK_SET)
+        records = []
+        header.record_count.times do
+          records << ResourceRecord.read(@io)
+        end
+        @records = records
+      end
+      @records
+    end
+
+    # Reads the data for a given record.
+    #
+    # @param rec [ResourceRecord] the record to read the data for.
+    def data(rec)
+      @io.seek(rec.data_offset, IO::SEEK_SET)
+      @io.read(rec.data_length)
+    end
+
+    # Computes the checksum for the resource file.
+    #
+    # @yield [done] Provides feedback about the progress of the operation.
+    def compute_checksum(&block)
+      crc = CRC.new
+      # Have to read this first because it might change the seek position.
+      file_size = header.file_size
+      @io.seek(8, IO::SEEK_SET)
+      pos = 8
+      length = 4096-8
+      buf = nil
+      while true
+        buf = @io.read(length, buf)
+        break if !buf
+        crc.update(buf)
+        pos += buf.size
+        block.call(pos) if block
+        length = 4096
+      end
+      crc.crc
+    end
+
+    def self.open(file, &block)
+      if block
+        File.open(file, File::RDONLY) do |io|
+          rf = ResourceFile.new(io)
+          begin
+            block.call(rf)
+          ensure
+            rf.close
+          end
+        end
+      else
+        ResourceFile.new(File.open(file, File::RDONLY))
+      end
+    end
+
+    def close
+      @io.close
+    end
+  end
+end

data/lib/futurocube/resource_tool.rb

@@ -0,0 +1,38 @@
+
+require_relative 'list_command'
+require_relative 'verify_command'
+require_relative 'dump_command'
+
+module FuturoCube
+  class ResourceTool
+    COMMANDS = {
+      'list' => ListCommand.new,
+      'verify' => VerifyCommand.new,
+      'dump' => DumpCommand.new
+    }
+
+    def usage(exit_code = 1)
+      $stderr.puts("Usage:")
+      COMMANDS.each_pair do |name, command|
+        $stderr.puts("  #{$0} #{name} #{command.usage}")
+      end
+      exit exit_code
+    end
+
+    def main(args)
+      usage if args.length < 1
+      usage(0) if args[0] == '--help'
+
+      command = COMMANDS[args[0]]
+      usage if !command
+
+      command_args = args.slice(1..-1)
+      usage if !command.args_valid?(command_args)
+      begin
+        command.exec(*command_args)
+      rescue Interrupt => e
+        $stderr.puts("Interrupted")
+      end
+    end
+  end
+end

data/lib/futurocube/verify_command.rb

@@ -0,0 +1,33 @@
+require_relative 'resource_file'
+require_relative 'command_helper'
+
+module FuturoCube
+  class VerifyCommand
+    include CommandHelper
+
+    def exec(file)
+      ResourceFile.open(file) do |rf|
+        expected = rf.header.checksum
+        actual = with_progress('Checking', rf.header.file_size) do |progress|
+          rf.compute_checksum do |done|
+            progress.set(done)
+          end
+        end
+
+        if actual == expected
+          puts "  Checksum %08X OK" % [actual]
+        else
+          puts "  Checksum %08X NG (expected %08X)" % [actual, expected]
+        end
+      end
+    end
+
+    def args_valid?(args)
+      args.length == 1
+    end
+
+    def usage
+      "filename"
+    end
+  end
+end

data/lib/futurocube/version.rb

@@ -0,0 +1,3 @@
+module FuturoCube
+  VERSION = "0.1.0"
+end

data/spec/futurocube/resource_file_spec.rb

@@ -0,0 +1,107 @@
+require_relative '../spec_helper'
+require 'futurocube/resource_file'
+
+describe FuturoCube::ResourceFile do
+  before do
+    @rf = FuturoCube::ResourceFile.open('FutRes031212.bin')
+  end
+
+  after do
+    @rf.close
+  end
+
+  describe '::open' do
+    it 'yields the ResourceFile to the block' do
+      FuturoCube::ResourceFile.open('FutRes031212.bin') do |rf|
+        rf.should be_a FuturoCube::ResourceFile
+      end
+    end
+  end
+
+  describe '#header' do
+    describe '#magic' do
+      it 'returns the magic number' do
+        @rf.header.magic.should == 0xAA987745
+      end
+    end
+    
+    describe '#checksum' do
+      it 'returns the file checksum' do
+        @rf.header.checksum.should == 0x35D806F6
+      end
+    end
+    
+    describe '#version' do
+      it 'returns the file format version' do
+        @rf.header.version.should == 2
+      end
+    end
+
+    describe '#created' do
+      it 'returns the file creation date' do
+        @rf.header.created.should == 1354536121
+      end
+    end
+
+    describe '#name' do
+      it 'returns the resource bundle name' do
+        @rf.header.name.should == 'FutRes031212'
+      end
+    end
+
+    describe '#record_count' do
+      it 'returns the record count' do
+        @rf.header.record_count.should == 274
+      end
+    end
+    
+    describe '#file_size' do
+      it 'returns the file size' do
+        @rf.header.file_size.should == 98828288
+      end
+    end
+  end
+
+  describe '#records' do
+    it 'returns one element for each record in the file' do
+      @rf.records.size.should == 274
+    end
+
+    describe '#name' do
+      it 'returns the name of the record' do
+        @rf.records[0].name.should == '1'
+      end
+    end
+
+    describe '#format' do
+      it 'returns a format version number' do
+        @rf.records[0].format.should == 1
+      end
+    end
+    
+    describe '#data_offset' do
+      it 'returns the data offset' do
+        @rf.records[0].data_offset.should == 10240
+      end
+    end
+    
+    describe '#data_length' do
+      it 'returns the data length' do
+        @rf.records[0].data_length.should == 29184
+      end
+    end
+  end
+
+  describe '#data' do
+    it 'returns the data for the record' do
+      @rf.data(@rf.records[0]).size.should == 29184
+    end
+  end
+
+  describe '#compute_checksum' do
+    it 'computes the checksum for the file' do
+      @rf.compute_checksum.should == @rf.header.checksum
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler.setup
+
+require 'simplecov'
+SimpleCov.start

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: futurocube
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Trejkaz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wavefile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tools for messing with FuturoCube data
+email:
+- trejkaz@trypticon.org
+executables:
+- fcrestool
+extensions: []
+extra_rdoc_files: []
+files:
+- COPYING.txt
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- futurocube.gemspec
+- bin/fcrestool
+- lib/futurocube/command_helper.rb
+- lib/futurocube/crc.rb
+- lib/futurocube/dump_command.rb
+- lib/futurocube/list_command.rb
+- lib/futurocube/resource_file.rb
+- lib/futurocube/resource_tool.rb
+- lib/futurocube/verify_command.rb
+- lib/futurocube/version.rb
+- lib/futurocube.rb
+- spec/futurocube/resource_file_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/trejkaz/futurocube
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Contains tools and parsers for messing with data for the Rubik's FuturoCube.
+test_files:
+- spec/futurocube/resource_file_spec.rb
+- spec/spec_helper.rb