sidtool 0.0.2 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c9e6e4a8741217ee0274bdb1b6fedb7f9c170bf89466b801ad8a1857a7cc59b
-  data.tar.gz: f2c57a83771df5654ae6c5e257eeff3ec0d94ae1d9a8db94da58f5eed2e7dee8
+  metadata.gz: 18bb0264bfc225b9bf717f464da9e9abc46777a93d3edd5ef985244fcc7e609d
+  data.tar.gz: 9a9b61aee40dadb92111f5cfc3b12e85db24f37c98f33d3981244aa8e04a1097
 SHA512:
-  metadata.gz: bf153ba88e818359ee5df8b32de316959c9215142416a29997b204cc4545210ae33efb01e0a60155c81b1251a398cfe81736e6e1dc08392cfec0396005a3278a
-  data.tar.gz: 8533881bb398f17eb54ef530fe3bb23f24fe8bde3214c87ec994da8c35faaa10d4e372fffc99ffab3b23add8f15ce2e268150d1cfa4736afffc159c5b32d44c0
+  metadata.gz: d21cd9a7aa43ae31afb6173aac169182f2cf1836fa25314dfba2633c37fc5cab74fcd9ff174000e0749e9f98db4d856860110da049308c74b769b4f7cbef3084
+  data.tar.gz: 56423bc991f5d6e74c56205e438967fe9ad8a12c83f0955708c3c88eddb4dc6017cb2d28f1bcfd73d8d6faa73a028eb8c944fa38261d2ea3b540303f257c1645

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.0.5
+* Bumped to mos6510 version 0.1.2 which depends on a version of mini_racer that supports
+  Ruby 3.1.
+
+## 0.0.4
+* Bumped to mos6510 version 0.1.1 which depends on a version of mini_racer that can compile
+  and install on my machine.
+
+## 0.0.3
+* Add midi support.
+
 ## 0.0.2
 * Process 15000 frames (10 minutes) instead of 1500 (half a minute) by default.
 * Only release a synth once. This fixes various sound effects that would just end up with a

data/Gemfile.lock

@@ -1,20 +1,20 @@
 PATH
   remote: .
   specs:
-    sidtool (0.0.2)
-      mos6510 (~> 0.1.0)
+    sidtool (0.0.5)
+      mos6510 (~> 0.1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.2)
     diff-lcs (1.3)
-    libv8 (7.3.492.27.1-x86_64-darwin-18)
+    libv8-node (16.10.0.0-x86_64-darwin)
     method_source (0.9.2)
-    mini_racer (0.2.6)
-      libv8 (>= 6.9.411)
-    mos6510 (0.1.0)
-      mini_racer (~> 0.2.6)
+    mini_racer (0.6.2)
+      libv8-node (~> 16.10.0.0)
+    mos6510 (0.1.2)
+      mini_racer (~> 0.6.2)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -44,4 +44,4 @@ DEPENDENCIES
   sidtool!
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -1,24 +1,36 @@
 # Sidtool
 
-Convert Commodore 64 SID music in the form of `.sid` files into other formats! This is still VERY
-much work in progress... the code is ugly and will probably create horrible results for you :-)
+Convert Commodore 64 SID music in the form of `.sid` files into other formats!
 
-Basically, it's a massive hack made for fun and no profit.
-
-The vision, though, is to extract the actual information from `.sid` files, which are files storing
-music for the Commodore 64. This sounds like an easy task.
+Basically, it's a massive hack made for fun and no profit. The vision, though, is to extract the
+actual information from `.sid` files, which are files storing music for the Commodore 64.
 
 `.sid` files contain actual Commodore 64 machine code that writes to registers corresponding to the
 Commodore 64 sound chip, the SID (Sound Interface Device). Which means that in order to play back a
 `.sid` file like it would sound on an actual Commodore 64, you will have to simulate both the
 processor and the sound chip.
 
-This project does not attempt to simulate the SID chip to produce authentic sounds - lots of those
-players already exist - but instead has a very simple implementation that produces data that can be
-used to play back the songs. You know, almost as notes.
+This project does not attempt to produce an authentic playback of the sounds - lots of those
+players already exist - but instead lets you export a Commodore 64 song into a format that lets
+you edit and experiment with the song. Want to change the instruments? Go ahead. Want to take out
+parts of the song and use in other projects? You can do that. Want to just listen to your favourite
+Commodore 64 song played back by a piano? Definitely do that!
+
+## Supported Output Formats
+
+### Ruby
+
+You can get a simple Ruby file which defines a list of synths to play at certain points in time.
+This can be used to play back the music in [Sonic Pi](https://sonic-pi.net) (see below), or you
+can write a Ruby script to do your own post-processing.
 
-Currently the only output format is a Ruby file which defines a list of synths to play at certain
-points in time. This can be used to play back the music in [Sonic Pi](https://sonic-pi.net).
+### Midi
+
+If you just want to listen to a `.sid` file, the easiest way is to export to midi file format and
+open the file in a player such as [VLC](https://www.videolan.org/vlc/index.html). However, if you
+want to further edit the result, import the file in a music editor such as GarageBand on a Mac.
+Then you can use all of the tools provided by your music editor to change instruments and rearrange
+the song. 
 
 ## Limitations
 
@@ -46,16 +58,20 @@ Show information, like the author and number of songs in a file:
 
     $ sidtool --info <input file>
 
-Convert the default song from a file to a Ruby list:
+Convert the default song from a `.sid` file to a midi file:
+
+    $ sidtool --out <output file> --format midi <input file>
+
+Convert the default song from a file to a Ruby list (`--format ruby` is the default):
 
     $ sidtool --out <output file> <input file>
 
-The output can then be used to play back the music, for example in Sonic Pi:
+The Ruby output can then be used to play back the music, for example in Sonic Pi:
 
 ```ruby
 load '<path to your output file from before>'
 
-previous_frame = 1
+previous_frame = 0
 ::SYNTHS.each do |synth|
   current_frame = synth[0]
   frames_to_sleep = current_frame - previous_frame

data/bin/sidtool

@@ -4,12 +4,17 @@ require 'mos6510'
 require 'optparse'
 
 DEFAULT_FRAMES_TO_PROCESS = 15000
+EXPORTERS = {
+  'ruby' => Sidtool::RubyFileWriter,
+  'midi' => Sidtool::MidiFileWriter
+}
 
 params = {}
 OptionParser.new do |parser|
   parser.banner = 'Usage: sidtool [options] <intputfile.sid>'
 
   parser.on('-i', '--info', 'Show file information')
+  parser.on('--format FORMAT', 'Output format, "ruby" (default) or "midi"')
   parser.on('-o', '--out FILENAME', 'Output file (Ruby array)')
   parser.on('-s', '--song NUMBER', Integer, 'Song number to process (defaults to the start song in the file)')
   parser.on('-f', '--frames NUMBER', Integer, "Number of frames to process (default #{DEFAULT_FRAMES_TO_PROCESS})")
@@ -32,6 +37,10 @@ output_file = params[:out]
 show_info = !!params[:info]
 raise 'Either provide -i or -o, or I have nothing to do!' unless output_file || show_info
 
+format = params[:format] || EXPORTERS.keys.first
+exporter_class = EXPORTERS[format]
+raise "Invalid format: #{format}. Valid formats: #{EXPORTERS.keys.join(', ')}" unless exporter_class
+
 song = params[:song] || sid_file.start_song
 raise 'Song must be at least 1' if song < 1
 raise "File only has #{sid_file.songs} songs" if song > sid_file.songs
@@ -74,11 +83,5 @@ if output_file
 
   STDERR.puts("Processed #{frames} frames")
 
-  File.open(output_file, 'w') do |file|
-    file.puts '::SYNTHS = ['
-    Sidtool::STATE.synths.each do |synth|
-      file.puts synth.to_a.inspect + ','
-    end
-    file.puts ']'
-  end
+  exporter_class.new(sid.synths_for_voices).write_to(output_file)
 end

data/lib/sidtool/midi_file_writer.rb

@@ -0,0 +1,198 @@
+module Sidtool
+  class MidiFileWriter
+    DeltaTime = Struct.new(:time) do
+      def bytes
+        quantity = time
+        seven_bit_segments = []
+        while true
+          seven_bit_segments << (quantity & 127)
+          quantity = quantity >> 7
+          break if quantity == 0
+        end
+        result = seven_bit_segments.reverse.map { |segment| segment | 128 }
+        result[-1] &= 127
+        result
+      end
+    end
+
+    TrackName = Struct.new(:name) do
+      def bytes
+        [
+          0xFF, 0x03,
+          name.length,
+          *name.bytes
+        ]
+      end
+    end
+
+    TimeSignature = Struct.new(:numerator, :denominator_power_of_two, :clocks_per_metronome_click, :number_of_32th_nodes_per_24_clocks) do
+      def bytes
+        [
+          0xFF, 0x58, 0x04,
+          numerator,
+          denominator_power_of_two,
+          clocks_per_metronome_click,
+          number_of_32th_nodes_per_24_clocks
+        ]
+      end
+    end
+
+    KeySignature = Struct.new(:sharps_or_flats, :is_major) do
+      def bytes
+        [
+          0xFF, 0x59, 0x02,
+          sharps_or_flats,
+          is_major ? 0 : 1
+        ]
+      end
+    end
+
+    EndOfTrack = Struct.new(:nothing) do
+      def bytes
+        [
+          0xFF, 0x2F, 0x00
+        ]
+      end
+    end
+
+    ProgramChange = Struct.new(:channel, :program_number) do
+      def bytes
+        raise "Channel too big: #{channel}" if channel > 15
+        raise "Program number is too big: #{program_number}" if program_number > 255
+        [
+          0xC0 + channel,
+          program_number
+        ]
+      end
+    end
+
+    NoteOn = Struct.new(:channel, :key) do
+      def bytes
+        raise "Channel too big: #{channel}" if channel > 15
+        raise "Key is too big: #{key}" if key > 255
+        [
+          0x90 + channel,
+          key,
+          40 # Default velocity
+        ]
+      end
+    end
+
+    NoteOff = Struct.new(:channel, :key) do
+      def bytes
+        raise "Channel too big: #{channel}" if channel > 15
+        raise "Key is too big: #{key}" if key > 255
+        [
+          0x80 + channel,
+          key,
+          40 # Default velocity
+        ]
+      end
+    end
+
+    def initialize(synths_for_voices)
+      @synths_for_voices = synths_for_voices
+    end
+
+    def write_to(path)
+      tracks = @synths_for_voices.map { |synths| build_track(synths) }
+
+      File.open(path, 'wb') do |file|
+        write_header(file)
+        tracks.each_with_index { |track, index| write_track(file, track, "Voice #{index + 1}") }
+      end
+    end
+
+    def build_track(synths)
+      waveforms = [:tri, :saw, :pulse, :noise]
+
+      track = []
+      current_frame = 0
+      synths.each do |synth|
+        channel = waveforms.index(synth.waveform) || raise("Unknown waveform #{synth.waveform}")
+        track << DeltaTime[synth.start_frame - current_frame]
+        track << NoteOn[channel, synth.tone]
+        current_frame = synth.start_frame
+
+        current_tone = synth.tone
+        synth.controls.each do |start_frame, tone|
+          track << DeltaTime[start_frame - current_frame]
+          track << NoteOff[channel, current_tone]
+          track << DeltaTime[0]
+          track << NoteOn[channel, tone]
+          current_tone = tone
+          current_frame = start_frame
+        end
+
+        end_frame = [current_frame, synth.start_frame + (FRAMES_PER_SECOND * (synth.attack + synth.decay + synth.sustain_length)).to_i].max
+        track << DeltaTime[end_frame - current_frame]
+        track << NoteOff[channel, current_tone]
+
+        current_frame = end_frame
+      end
+
+      track
+    end
+
+    private
+    def write_header(file)
+      # Type
+      file << 'MThd'
+
+      # Length
+      write_uint32(file, 6)
+
+      # Format
+      write_uint16(file, 1)
+
+      # Number of tracks
+      write_uint16(file, 3)
+
+      # Division
+      # Default tempo is 120 BPM - 120 quarter-notes per minute. Which is 2 quarter-notes per second. If we then define
+      # 25 ticks per quarter-note, we end up with a timing of 50 ticks per second.
+      write_uint16(file, 25)
+    end
+
+    def write_track(file, track, name)
+      track_with_metadata = [
+        DeltaTime[0], TrackName[name],
+        DeltaTime[0], TimeSignature[4, 2, 24, 8],
+        DeltaTime[0], KeySignature[0, 0],
+
+        DeltaTime[0], ProgramChange[0, 1],  # Triangular - maps to piano
+        DeltaTime[0], ProgramChange[1, 25], # Saw - maps to guitar
+        DeltaTime[0], ProgramChange[2, 33], # Pulse - maps to bass
+        DeltaTime[0], ProgramChange[3, 41]  # Noise -  maps to strings
+      ] +
+      track +
+      [
+        DeltaTime[0], EndOfTrack[]
+      ]
+      track_bytes = track_with_metadata.flat_map(&:bytes)
+
+      # Type
+      file << 'MTrk'
+
+      # Length
+      write_uint32(file, track_bytes.length)
+
+      file << track_bytes.pack('c' * track_bytes.length)
+    end
+
+    def write_uint32(file, value)
+      bytes = [(value >> 24) & 255, (value >> 16) & 255, (value >> 8) & 255, value & 255]
+      file << bytes.pack('cccc')
+    end
+
+    def write_uint16(file, value)
+      bytes = [(value >> 8) & 255, value & 255]
+      file << bytes.pack('cc')
+    end
+
+    def write_byte(file, value)
+      bytes = [value & 255]
+      file << bytes.pack('c')
+    end
+  end
+end

data/lib/sidtool/ruby_file_writer.rb

@@ -0,0 +1,17 @@
+module Sidtool
+  class RubyFileWriter
+    def initialize(synths_for_voices)
+      @synths_for_voices = synths_for_voices
+    end
+
+    def write_to(path)
+      File.open(path, 'w') do |file|
+        file.puts '::SYNTHS = ['
+        @synths_for_voices.flatten.sort_by(&:start_frame).each do |synth|
+          file.puts synth.to_a.inspect + ','
+        end
+        file.puts ']'
+      end
+    end
+  end
+end

data/lib/sidtool/sid.rb

@@ -2,7 +2,6 @@ module Sidtool
   class Sid
     def initialize
       @voices = [Voice.new, Voice.new, Voice.new]
-      @synths = []
 
       @frequency_low = @frequency_high = 0
       @pulse_low = @pulse_high = 0
@@ -44,5 +43,9 @@ module Sidtool
     def stop!
       @voices.each(&:stop!)
     end
+
+    def synths_for_voices
+      @voices.map(&:synths)
+    end
   end
 end

data/lib/sidtool/state.rb

@@ -1,11 +1,9 @@
 module Sidtool
   class State
     attr_accessor :current_frame
-    attr_accessor :synths
 
     def initialize
       @current_frame = 0
-      @synths = []
     end
   end
 end

data/lib/sidtool/synth.rb

@@ -1,9 +1,12 @@
 module Sidtool
   class Synth
-    attr_writer :waveform
-    attr_writer :attack
-    attr_writer :decay
-    attr_writer :release
+    attr_reader :start_frame
+    attr_accessor :waveform
+    attr_accessor :attack
+    attr_accessor :decay
+    attr_reader :sustain_length
+    attr_accessor :release
+    attr_reader :controls
 
     def initialize(start_frame)
       @start_frame = start_frame
@@ -48,10 +51,13 @@ module Sidtool
     end
 
     def to_a
-      tone = sid_frequency_to_nearest_midi(@frequency)
       [@start_frame, tone, @waveform, @attack.round(3), @decay.round(3), @sustain_length.round(3), @release.round(3), @controls]
     end
 
+    def tone
+      sid_frequency_to_nearest_midi(@frequency)
+    end
+
     private
     def sid_frequency_to_nearest_midi(sid_frequency)
       actual_frequency = sid_frequency_to_actual_frequency(sid_frequency)

data/lib/sidtool/version.rb

@@ -1,3 +1,3 @@
 module Sidtool
-  VERSION = '0.0.2'
+  VERSION = '0.0.5'
 end

data/lib/sidtool/voice.rb

@@ -7,41 +7,43 @@ module Sidtool
     attr_writer :control_register
     attr_writer :attack_decay
     attr_writer :sustain_release
+    attr_reader :synths
 
     def initialize
       @frequency_low = @frequency_high = 0
       @pulse_low = @pulse_high = 0
       @attack_decay = @sustain_release = 0
       @control_register = 0
-      @synth = nil
+      @current_synth = nil
+      @synths = []
     end
 
     def finish_frame
       if gate
-        if @synth&.released?
-          @synth.stop!
-          @synth = nil
+        if @current_synth&.released?
+          @current_synth.stop!
+          @current_synth = nil
         end
 
         if frequency > 0
-          if !@synth
-            @synth = Synth.new(STATE.current_frame)
-            STATE.synths << @synth
+          if !@current_synth
+            @current_synth = Synth.new(STATE.current_frame)
+            @synths << @current_synth
           end
-          @synth.frequency = frequency
-          @synth.waveform = waveform
-          @synth.attack = attack
-          @synth.decay = decay
-          @synth.release = release
+          @current_synth.frequency = frequency
+          @current_synth.waveform = waveform
+          @current_synth.attack = attack
+          @current_synth.decay = decay
+          @current_synth.release = release
         end
       else
-        @synth&.release!
+        @current_synth&.release!
       end
     end
 
     def stop!
-      @synth&.stop!
-      @synth = nil
+      @current_synth&.stop!
+      @current_synth = nil
     end
 
     private

data/lib/sidtool.rb

@@ -2,6 +2,8 @@ require 'sidtool/version'
 
 module Sidtool
   require 'sidtool/file_reader'
+  require 'sidtool/ruby_file_writer'
+  require 'sidtool/midi_file_writer'
   require 'sidtool/synth'
   require 'sidtool/voice'
   require 'sidtool/sid'

data/sidtool.gemspec

@@ -12,13 +12,15 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/olefriis/sidtool'
   spec.license       = 'MIT'
 
+  spec.required_ruby_version = '>= 2.3'
+
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.executables   = 'sidtool'
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'mos6510', '~> 0.1.0'
+  spec.add_dependency 'mos6510', '~> 0.1.2'
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidtool
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - Ole Friis Østergaard
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-01 00:00:00.000000000 Z
+date: 2022-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mos6510
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.2
-description: 
+description:
 email:
 - olefriis@gmail.com
 executables:
@@ -101,6 +101,8 @@ files:
 - bin/sidtool
 - lib/sidtool.rb
 - lib/sidtool/file_reader.rb
+- lib/sidtool/midi_file_writer.rb
+- lib/sidtool/ruby_file_writer.rb
 - lib/sidtool/sid.rb
 - lib/sidtool/state.rb
 - lib/sidtool/synth.rb
@@ -111,7 +113,7 @@ homepage: https://github.com/olefriis/sidtool
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -119,15 +121,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Convert SID tunes to other formats
 test_files: []