foxtracker 0.1.0.pre1337

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 146db4596b171e89640d7f55ceec69e16ef3e5075bbafc37429d9d9aed610528
+  data.tar.gz: 2a72fb658ec749043b0c1b3baf306f03c40fcb2f9aaa3a3f3a8c4cd7b49137ec
+SHA512:
+  metadata.gz: 2e7953b85f6b82728dc1ba2e45961b3f6512b1608ed7bccecb25a6969ad37bac478c8f0e39172eb94d63b8f867621988f984162524ab43946e26490887fc7fec
+  data.tar.gz: 9f47153f4a02d1a4a00303fae9083351a0819632ca48725ae0d8ba95529706ea5af185f86c6df64c94406250a714bffcc486d09a1426beb134d9dd0b252472f9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+---
+require:
+- rt_rubocop_defaults
+
+AllCops:
+  TargetRubyVersion: 2.5

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nilsding@nilsding.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in foxtracker.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    foxtracker (0.1.0.pre1337)
+      dry-struct (~> 0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    dry-configurable (0.7.0)
+      concurrent-ruby (~> 1.0)
+    dry-container (0.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.7)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.1)
+    dry-inflector (0.1.2)
+    dry-logic (0.4.2)
+      dry-container (~> 0.2, >= 0.2.6)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-struct (0.5.0)
+      dry-core (~> 0.4, >= 0.4.3)
+      dry-equalizer (~> 0.2)
+      dry-types (~> 0.13)
+      ice_nine (~> 0.11)
+    dry-types (0.13.2)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.2)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 0.4, >= 0.4.2)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.1)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rt_rubocop_defaults (1.0.0)
+      rubocop (~> 0.46)
+    rubocop (0.58.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  foxtracker!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rt_rubocop_defaults (~> 1.0)
+  rubocop (~> 0.58)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2018, Georg Gadinger <nilsding@nilsding.org>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,61 @@
+# Foxtracker
+
+[![Gem Version](https://badge.fury.io/rb/foxtracker.svg)](https://badge.fury.io/rb/foxtracker)
+
+Foxtracker is a parser for tracker music formats.  Right now it only supports XM
+(FastTracker II) modules.  Support for more formats is to be done.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'foxtracker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install foxtracker
+
+## Usage
+
+```ruby
+require "foxtracker/parser"
+
+xm = Foxtracker::Parser.read(
+  # path to xm file:
+  File.expand_path("./siuperdu[perxmldsosnmg v2.xm", __dir__),
+  # display debug output during parsing (default false)
+  debug: true
+)
+#=> #<Foxtracker::Format::ExtendedModule title="superdupersongxmldng" tracker="MilkyTracker 1.00.00" ...>
+
+xm
+  .patterns.first # the pattern 0
+  .channels.first # the first channel
+  .first          # the first row/note for the channel
+  .note           #=> 85 (C-7); the note value
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/foxtracker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Foxtracker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/foxtracker/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "foxtracker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/foxtracker

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "foxtracker"
+
+Foxtracker::Application.new(ARGV).run

data/foxtracker.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "foxtracker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "foxtracker"
+  spec.version       = Foxtracker::VERSION
+  spec.authors       = ["Georg Gadinger"]
+  spec.email         = ["nilsding@nilsding.org"]
+
+  spec.summary       = "a parser for tracker music formats"
+  spec.description   = "Foxtracker is a parser for tracker music formats.  Right now it only supports XM (FastTracker II) modules.  Support for more formats is to be done."
+  spec.homepage      = "https://github.com/nilsding/foxtracker"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dry-struct", "~> 0.5"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rt_rubocop_defaults", "~> 1.0"
+  spec.add_development_dependency "rubocop", "~> 0.58"
+end

data/lib/foxtracker.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "foxtracker/version"
+require "foxtracker/application"
+
+module Foxtracker
+end

data/lib/foxtracker/application.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "dry-types"
+require "dry-struct"
+
+require "foxtracker/parser"
+
+module Foxtracker
+  class Application
+    def initialize(argv)
+      @filename = argv.first
+    end
+
+    def run
+      xm = Foxtracker::Parser.read(@filename, debug: true)
+      require "pp"
+      pp xm
+    ensure
+      binding.irb
+    end
+  end
+end

data/lib/foxtracker/format/extended_module.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+
+require "foxtracker/types"
+require "foxtracker/format/extended_module/pattern"
+require "foxtracker/format/extended_module/instrument"
+
+module Foxtracker
+  module Format
+    class ExtendedModule < Dry::Struct
+      # Header
+      attribute :title, Types::Strict::String
+      attribute :tracker, Types::Strict::String
+      attribute :version_number, Types::Strict::Integer
+      attribute :header_size, Types::Strict::Integer
+      attribute :song_length, Types::Strict::Integer.constrained(min_size: 1, max_size: 256)
+      attribute :restart_position, Types::Strict::Integer
+      attribute :number_of_channels, Types::Strict::Integer
+      attribute :number_of_patterns, Types::Strict::Integer
+      attribute :number_of_instruments, Types::Strict::Integer
+      attribute :flags, Types::Strict::Integer
+      attribute :default_tempo, Types::Strict::Integer
+      attribute :default_bpm, Types::Strict::Integer
+      attribute :pattern_order, Types::Strict::Array.of(Types::Strict::Integer)
+
+      attribute :patterns, Types::Strict::Array.of(Pattern)
+      attribute :instruments, Types::Strict::Array.of(Instrument)
+    end
+  end
+end

data/lib/foxtracker/format/extended_module/instrument.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+
+require "foxtracker/types"
+require "foxtracker/format/extended_module/sample"
+
+module Foxtracker
+  module Format
+    class ExtendedModule < Dry::Struct
+      class Instrument < Dry::Struct
+        # first part -- these attributes MUST be set on an instrument
+        attribute :header_size, Types::Strict::Integer
+        attribute :name, Types::Strict::String
+        attribute :type, Types::Strict::Integer
+        attribute :number_of_samples, Types::Strict::Integer
+
+        # second part -- those are optional attributes
+        attribute :sample_header_size, Types::Strict::Integer.meta(omittable: true)
+        attribute :sample_keymap_assignments, Types::Strict::Array.of(Types::Strict::Integer)
+          .constrained(size: 96).meta(omittable: true)
+        # 48 bytes / 2 bytes = 24 words
+        attribute :volume_envelope, Types::Strict::Array.of(Types::Strict::Integer)
+          .constrained(size: 24).meta(omittable: true)
+        attribute :panning_envelope, Types::Strict::Array.of(Types::Strict::Integer)
+          .constrained(size: 24).meta(omittable: true)
+
+        # envelope points
+        attribute :number_of_volume_points, Types::Strict::Integer.meta(omittable: true)
+        attribute :number_of_panning_points, Types::Strict::Integer.meta(omittable: true)
+        attribute :volume_sustain_point, Types::Strict::Integer.meta(omittable: true)
+        attribute :volume_loop_start_point, Types::Strict::Integer.meta(omittable: true)
+        attribute :volume_loop_end_point, Types::Strict::Integer.meta(omittable: true)
+        attribute :panning_sustain_point, Types::Strict::Integer.meta(omittable: true)
+        attribute :panning_loop_start_point, Types::Strict::Integer.meta(omittable: true)
+        attribute :panning_loop_end_point, Types::Strict::Integer.meta(omittable: true)
+        attribute :volume_type, Types::Strict::String
+          .enum("on" => 0, "sustain" => 1, "loop" => 2, "sustain_and_loop" => 3)
+          .meta(omittable: true)
+        attribute :panning_type, Types::Strict::String
+          .enum("on" => 0, "sustain" => 1, "loop" => 2, "sustain_and_loop" => 3)
+          .meta(omittable: true)
+        attribute :vibrato_type, Types::Strict::Integer.meta(omittable: true)
+        attribute :vibrato_sweep, Types::Strict::Integer.meta(omittable: true)
+        attribute :vibrato_depth, Types::Strict::Integer.meta(omittable: true)
+        attribute :vibrato_rate, Types::Strict::Integer.meta(omittable: true)
+        attribute :volume_fadeout, Types::Strict::Integer.meta(omittable: true)
+        attribute :reserved, Types::Strict::Array.of(Types::Strict::Integer).meta(omittable: true)
+
+        attribute :samples, Types::Strict::Array.of(Sample).meta(omittable: true)
+      end
+    end
+  end
+end

data/lib/foxtracker/format/extended_module/note.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+
+require "foxtracker/types"
+
+module Foxtracker
+  module Format
+    class ExtendedModule < Dry::Struct
+      class Note < Dry::Struct
+        attribute :note, Types::Strict::Integer
+        attribute :instrument, Types::Strict::Integer
+        attribute :volume, Types::Strict::Integer
+        attribute :effect_type, Types::Strict::Integer
+        attribute :effect_param, Types::Strict::Integer
+      end
+    end
+  end
+end

data/lib/foxtracker/format/extended_module/pattern.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+
+require "foxtracker/types"
+require "foxtracker/format/extended_module/note"
+
+module Foxtracker
+  module Format
+    class ExtendedModule < Dry::Struct
+      class Pattern < Dry::Struct
+        attribute :header_size, Types::Strict::Integer
+        attribute :packing_type, Types::Strict::Integer
+        attribute :number_of_rows, Types::Strict::Integer.constrained(min_size: 1, max_size: 256)
+        attribute :packed_size, Types::Strict::Integer
+
+        attribute :channels, Types::Strict::Array.of(Types::Strict::Array.of(Note))
+      end
+    end
+  end
+end

data/lib/foxtracker/format/extended_module/sample.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+
+require "foxtracker/types"
+
+module Foxtracker
+  module Format
+    class ExtendedModule < Dry::Struct
+      class Sample < Dry::Struct
+        attribute :sample_length, Types::Strict::Integer
+        attribute :sample_loop_start, Types::Strict::Integer
+        attribute :sample_loop_length, Types::Strict::Integer
+
+        attribute :volume, Types::Strict::Integer
+        attribute :finetune, Types::Strict::Integer
+        attribute :type, Types::Strict::Integer
+        attribute :panning, Types::Strict::Integer
+        attribute :relative_note_number, Types::Strict::Integer
+        attribute :packing_type, Types::Strict::Integer # Types::Strict::String.enum("delta" => 0, "adpcm" => 0xAD)
+        attribute :name, Types::Strict::String
+
+        # attribute :raw_data, Types::Strict::String
+        attribute :data, Types::Strict::Array.of(Types::Strict::Integer)
+
+        # returns the sample looping type (:none, :forward, or :pingpong)
+        def looping_type
+          ExtendedModule::Helpers.sample_looping_type(type)
+        end
+
+        # returns the sample type (8 bit or 16 bit)
+        def sample_type
+          ExtendedModule::Helpers.sample_type(type)
+        end
+
+        # returns if this sample is to be looped
+        def looping?
+          !sample_loop_length.zero?
+        end
+
+        # HACK: to remove :data from inspect output as sample data is really too spammy
+        # https://github.com/dry-rb/dry-struct/blob/cb41a5a03/lib/dry/struct.rb#L178
+        def inspect
+          klass = self.class
+          attrs = klass
+                  .attribute_names
+                  .reject { |key| key == :data }
+                  .map { |key| " #{key}=#{@attributes[key].inspect}" }
+                  .join
+          "#<#{klass.name || klass.inspect}#{attrs}>"
+        end
+      end
+    end
+  end
+end

data/lib/foxtracker/parser.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "foxtracker/parser/extended_module"
+
+module Foxtracker
+  module Parser
+    module_function
+
+    def read(filename, debug: false)
+      parse IO.binread(filename), debug: debug
+    end
+
+    def parse(bin, debug: false)
+      ExtendedModule.parse(bin, debug: debug)
+    end
+  end
+end

data/lib/foxtracker/parser/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Foxtracker
+  module Parser
+    class Base
+      def self.parse(*args)
+        new.parse(*args)
+      end
+
+      def parse(*_args)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/foxtracker/parser/extended_module.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+require "foxtracker/parser/base"
+require "foxtracker/parser/support/extended_module"
+require "foxtracker/format/extended_module"
+
+module Foxtracker
+  module Parser
+    class ExtendedModule < Base
+      def parse(bin, debug: false)
+        bin = -bin
+        @debug = debug
+        args = {}
+        offset = 0
+
+        ##########
+        # header #
+        ##########
+        raise "not an XM module" unless bin[offset...(offset += 17)].casecmp("Extended module: ").zero?
+
+        args[:title] = bin[offset...(offset += 20)].rstrip
+        raise "invalid XM module" unless bin[offset...(offset += 1)] == "\x1A"
+
+        args[:tracker] = bin[offset...(offset += 20)].rstrip
+
+        args[:version_number] = bin[offset...(offset += 2)].unpack1("S<")
+
+        args[:header_size] = bin[offset...(offset += 4)].unpack1("L<")
+
+        %i[song_length restart_position number_of_channels number_of_patterns
+           number_of_instruments flags default_tempo default_bpm].each do |attr|
+          args[attr] = bin[offset...(offset += 2)].unpack1("S<")
+        end
+
+        args[:pattern_order] = bin[offset...(offset += args[:song_length])].unpack("C*")
+
+        if @debug
+          puts "song #{args[:title].inspect}"
+          puts "tracker #{args[:tracker].inspect} (#{format('%#06x', args[:version_number])})"
+          puts "-" * 25
+        end
+
+        ############
+        # patterns #
+        ############
+        offset, args[:patterns] = parse_patterns(bin, args)
+
+        ###############
+        # instruments #
+        ###############
+        offset, args[:instruments] = parse_instruments(bin, args, offset)
+
+        Format::ExtendedModule.new(args)
+      end
+
+      private
+
+      def parse_patterns(bin, xm_args)
+        patterns = []
+        offset = xm_args[:header_size] + 60
+
+        xm_args[:number_of_patterns].times do |pattern_no|
+          patterns << {}.tap do |pattern_args|
+            pattern_args[:header_size] = bin[offset...(offset += 4)].unpack1("L<")
+            pattern_args[:packing_type] = bin[offset...(offset += 1)].unpack1("C")
+            pattern_args[:number_of_rows] = bin[offset...(offset += 2)].unpack1("S<")
+            pattern_args[:packed_size] = bin[offset...(offset += 2)].unpack1("S<")
+            puts "pattern #{pattern_no.to_s(16)}" if @debug
+            pattern_args[:channels] = parse_pattern(
+              bin[offset...(offset += pattern_args[:packed_size])], xm_args, pattern_args
+            )
+            # offset += pattern_args[:packed_size] # skip for now
+          end
+        end
+
+        [offset, patterns]
+      end
+
+      def parse_pattern(bin, xm_args, pattern_args)
+        pattern = Array.new(xm_args[:number_of_channels])
+        offset = 0
+        pattern_args[:number_of_rows].times do
+          xm_args[:number_of_channels].times do |chan|
+            pattern[chan] ||= []
+            first_byte = bin[offset...(offset += 1)].unpack1("C")
+            note = { note: 0, instrument: 0, volume: 0, effect_type: 0, effect_param: 0 }
+            if first_byte & 128 == 128 # packed note
+              note[:note]         = bin[offset...(offset += 1)].unpack1("C") if first_byte & 1 == 1
+              note[:instrument]   = bin[offset...(offset += 1)].unpack1("C") if first_byte & 2 == 2
+              note[:volume]       = bin[offset...(offset += 1)].unpack1("C") if first_byte & 4 == 4
+              note[:effect_type]  = bin[offset...(offset += 1)].unpack1("C") if first_byte & 8 == 8
+              note[:effect_param] = bin[offset...(offset += 1)].unpack1("C") if first_byte & 16 == 16
+              pattern[chan] << note
+              next
+            end
+            note[:note]         = first_byte
+            note[:instrument]   = bin[offset...(offset += 1)].unpack1("C")
+            note[:volume]       = bin[offset...(offset += 1)].unpack1("C")
+            note[:effect_type]  = bin[offset...(offset += 1)].unpack1("C")
+            note[:effect_param] = bin[offset...(offset += 1)].unpack1("C")
+            pattern[chan] << note
+          end
+        end
+        puts pattern.transpose.map { |chan| chan.map { |note| format("%02d %2x %2x %2x %2x", note[:note], note[:instrument], note[:volume], note[:effect_type], note[:effect_param]) }.join(" | ") }.join("\n") if @debug
+        pattern
+      end
+
+      def parse_instruments(bin, xm_args, offset)
+        instruments = []
+
+        xm_args[:number_of_instruments].times do
+          instruments << {}.tap do |instrument_args|
+            # 1st part
+            instrument_args[:header_size] = bin[offset...(offset += 4)].unpack1("L<")
+            instrument_args[:name] = bin[offset...(offset += 22)].rstrip
+            instrument_args[:type] = bin[offset...(offset += 1)].unpack1("C")
+            instrument_args[:number_of_samples] = bin[offset...(offset += 2)].unpack1("S<")
+
+            if @debug
+              puts "instrument #{instrument_args[:name].inspect}:"
+              puts "- header_size: #{format('%#06x', instrument_args[:header_size])}"
+              puts "- number_of_samples: #{instrument_args[:number_of_samples]}"
+            end
+            if instrument_args[:number_of_samples].zero?
+              offset -= 33 # realignment hack from xmp
+              next
+            end
+
+            # 2nd part
+            instrument_args[:sample_header_size] = bin[offset...(offset += 4)].unpack1("L<")
+            puts "- sample_header_size: #{format('%#06x', instrument_args[:sample_header_size])}" if @debug
+            instrument_args[:sample_keymap_assignments] = bin[offset...(offset += 96)].unpack("C*")
+            instrument_args[:volume_envelope] = bin[offset...(offset += 48)].unpack("S<*")
+            instrument_args[:panning_envelope] = bin[offset...(offset += 48)].unpack("S<*")
+
+            %i[number_of_volume_points number_of_panning_points
+               volume_sustain_point volume_loop_start_point volume_loop_end_point
+               panning_sustain_point panning_loop_start_point panning_loop_end_point
+               volume_type panning_type
+               vibrato_type vibrato_sweep vibrato_depth vibrato_rate].each do |attr|
+              instrument_args[attr] = bin[offset...(offset += 1)].unpack1("C")
+              if @debug
+                print "- #{attr}: #{format('%#04x', instrument_args[attr])} -- "
+                p instrument_args[attr]
+              end
+            end
+
+            instrument_args[:volume_fadeout] = bin[offset...(offset += 2)].unpack1("S<")
+            instrument_args[:reserved] = bin[offset...(offset += 22)].unpack("S<*")
+            puts "- volume_fadeout: #{format('%#06x', instrument_args[:volume_fadeout])}" if @debug
+
+            offset, instrument_args[:samples] = parse_samples(bin, instrument_args, offset)
+          end
+        end
+
+        [offset, instruments]
+      end
+
+      def parse_samples(bin, instrument_args, offset)
+        samples = []
+
+        # first the sample headers ...
+        puts "- samples:" if @debug
+        instrument_args[:number_of_samples].times do
+          samples << {}.tap do |sample_args|
+            start_offset = offset
+            sample_args[:sample_length] = bin[offset...(offset += 4)].unpack1("L<")
+            sample_args[:sample_loop_start] = bin[offset...(offset += 4)].unpack1("L<")
+            sample_args[:sample_loop_length] = bin[offset...(offset += 4)].unpack1("L<")
+
+            sample_args[:volume] = bin[offset...(offset += 1)].unpack1("C")
+            sample_args[:finetune] = bin[offset...(offset += 1)].unpack1("c")
+            sample_args[:type] = bin[offset...(offset += 1)].unpack1("C")
+            sample_args[:panning] = bin[offset...(offset += 1)].unpack1("C")
+            sample_args[:relative_note_number] = bin[offset...(offset += 1)].unpack1("c")
+            sample_args[:packing_type] = bin[offset...(offset += 1)].unpack1("C")
+
+            sample_args[:name] = bin[offset...(offset += 22)].rstrip
+            if @debug
+              puts "  - name: #{sample_args[:name].inspect}"
+              puts "    type: #{Support::ExtendedModule.sample_type(sample_args[:type])}bit"
+              puts "    length: #{format('%#06x', sample_args[:sample_length])}"
+              puts "    loop_start: #{format('%#06x', sample_args[:sample_loop_start])}"
+              puts "    loop_length: #{format('%#06x', sample_args[:sample_loop_length])}"
+              puts "    volume: #{format('%#04x', sample_args[:volume])}"
+              puts "    finetune: #{format('%#04x', sample_args[:finetune])}"
+              puts "    panning: #{format('%#04x', sample_args[:panning])}"
+            end
+            diff = instrument_args[:sample_header_size] - (offset - start_offset)
+            puts "    offset diff from instrument header: #{diff}" if @debug
+            raise unless diff.zero?
+          end
+        end
+
+        # ... then the sample data!
+        samples.each do |sample_args|
+          sample_args[:raw_data] = bin[offset...(offset += sample_args[:sample_length])]
+          sample_args[:data] = unpack_sample_data(sample_args)
+        end
+
+        [offset, samples]
+      end
+
+      def unpack_sample_data(sample_args)
+        puts "unpacking sample #{sample_args[:name].inspect} ..." if @debug
+        unpack_str = case Support::ExtendedModule.sample_type(sample_args[:type])
+                     when 8 then "c*"
+                     when 16 then "s<*"
+                     else
+                       raise "this should never happen(tm)"
+                     end
+        packed_samples = sample_args.delete(:raw_data).unpack(unpack_str)
+
+        raise "ADPCM samples are not supported yet" if sample_args[:packing_type] == 0xAD
+
+        # delta compression
+        [].tap do |samples|
+          previous_sample = 0
+          packed_samples.each do |packed_sample|
+            samples << (previous_sample += packed_sample)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/foxtracker/parser/support/extended_module.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Foxtracker
+  module Parser
+    module Support
+      module ExtendedModule
+        module_function
+
+        # returns the sample looping type (:none, :forward, or :pingpong)
+        def sample_looping_type(sample_type_byte)
+          case sample_type_byte & 0b11
+          when 0 then :none
+          when 1 then :forward
+          when 2 then :pingpong
+          else
+            raise "this should never happen(tm)"
+          end
+        end
+
+        # returns the sample type (8 bit or 16 bit)
+        def sample_type(sample_type_byte)
+          ((sample_type_byte & 0b1000) >> 3).zero? ? 8 : 16
+        end
+      end
+    end
+  end
+end

data/lib/foxtracker/types.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "dry-types"
+
+module Foxtracker
+  class Types
+    include Dry::Types.module
+  end
+end

data/lib/foxtracker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Foxtracker
+  VERSION = "0.1.0.pre1337"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: foxtracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre1337
+platform: ruby
+authors:
+- Georg Gadinger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rt_rubocop_defaults
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+description: Foxtracker is a parser for tracker music formats.  Right now it only
+  supports XM (FastTracker II) modules.  Support for more formats is to be done.
+email:
+- nilsding@nilsding.org
+executables:
+- foxtracker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/foxtracker
+- foxtracker.gemspec
+- lib/foxtracker.rb
+- lib/foxtracker/application.rb
+- lib/foxtracker/format/extended_module.rb
+- lib/foxtracker/format/extended_module/instrument.rb
+- lib/foxtracker/format/extended_module/note.rb
+- lib/foxtracker/format/extended_module/pattern.rb
+- lib/foxtracker/format/extended_module/sample.rb
+- lib/foxtracker/parser.rb
+- lib/foxtracker/parser/base.rb
+- lib/foxtracker/parser/extended_module.rb
+- lib/foxtracker/parser/support/extended_module.rb
+- lib/foxtracker/types.rb
+- lib/foxtracker/version.rb
+homepage: https://github.com/nilsding/foxtracker
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: a parser for tracker music formats
+test_files: []