beats 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b76857d49851dc03ef574dadcbbc01aff5aaea9f
-  data.tar.gz: df598d61cfaa1a0ecb8f1bd493dc8b1f0436869e
+SHA256:
+  metadata.gz: 8ae934eac074a47b7bb5f587fd96eb457f0ddabfbf18f5667e838dd01832c247
+  data.tar.gz: ee54703a136d795679807ea67f4f5cb79532f090d0c641f924590a036a35b2d9
 SHA512:
-  metadata.gz: 59bd59d74a085c9d60c0f4584a9a6704c58aa05e4856d24884e4e5de622e578cd9e7a1a47edb35e172b8b1ff2f67c0386b7d99db238dcaf11d3f366a57ec42d7
-  data.tar.gz: 7ab6c3283977bcda76772ae287e67d2d120fdd8623fe777364dfc70bd6a1250b3c50e96bec6e047d7da199dd6ec6877b02cbf4e0b7d9009a480becdf92498656
+  metadata.gz: 2f2e931c783acab297d17187cadd51ebbba9cd5bd55ec9a81a6fddd15b0d95b8b03027508cbed4e3b07740a3e0d04d25e9e000b06074b916bc23cc6e4e0df3ed
+  data.tar.gz: f6fe7883c7a9f21d62d252eec3f646aa2af5f47acda24d20dc43c8761fcf84c87716a2cbc53248fdcf31f4c7832cb5d24353ea49520ada5555a6a9cb85234898

data/LICENSE

@@ -1,6 +1,6 @@
-== BEATS
+== Beats Drum Machine
 
-# Copyright (c) 2010-17 Joel Strait
+# Copyright (c) 2010-18 Joel Strait
 #
 # Permission is hereby granted, free of charge, to any person
 # obtaining a copy of this software and associated documentation

data/README.markdown

@@ -27,23 +27,23 @@ Beats is a command-line drum machine written in pure Ruby. Feed it a song notate
       - cowbell:  ....XX.X..X.X...
       - deep:     .............X..
 
-And [here's what it sounds like](http://beatsdrummachine.com/media/beat.mp3) after getting the Beats treatment. What a glorious groove!
+And [here's what it sounds like](https://beatsdrummachine.com/media/beat.mp3) after getting the Beats treatment. What a glorious groove!
 
-For more, check out [beatsdrummachine.com](http://beatsdrummachine.com)
+For more, check out [beatsdrummachine.com](https://beatsdrummachine.com)
 
 
 Installation
 ------------
 
-To install the latest stable version (2.1.0) from [rubygems.org](http://rubygems.org/gems/beats), run the following from the command line:
+To install the latest stable version (2.1.1) from [rubygems.org](https://rubygems.org/gems/beats), run the following from the command line:
 
     gem install beats
 
-Note that if you are installing using the default version of Ruby that comes with MacOS X, you might get a file permission error. If that happens, use `sudo gem install beats` instead. If you are using RVM, plain `gem install beats` should work fine.
+Note: if you're installing using the default version of Ruby that comes with macOS, you might get a file permission error. If that happens, use `sudo gem install beats` instead. If you're using a version manager such as rbenv, chruby, or RVM, plain `gem install beats` should work fine.
 
 Once installed, you can then run Beats from the command-line using the `beats` command.
 
-Beats is not very useful unless you have some sounds to use with it. You can download some example sounds from [http://beatsdrummachine.com](http://beatsdrummachine.com/download#drum-kits).
+Beats is not very useful unless you have some sounds to use with it. You can download some example sounds from [https://beatsdrummachine.com](https://beatsdrummachine.com/download#drum-kits).
 
 
 Usage
@@ -51,87 +51,25 @@ Usage
 
 Beats runs from the command-line. Run `beats -h` to see the available options. For more detailed instructions, visit [https://github.com/jstrait/beats/wiki/Usage](https://github.com/jstrait/beats/wiki/Usage) on the [Beats Wiki](https://github.com/jstrait/beats/wiki).
 
-Check out [this tutorial at beatsdrummachine.com](http://beatsdrummachine.com/tutorial/) to see an example of how to create a beat from sratch.
+Check out [this tutorial at beatsdrummachine.com](https://beatsdrummachine.com/tutorial/) to see an example of how to create a beat from sratch.
 
 
-What's New
-----------
+What's New in v2.1.1
+--------------------
 
-The latest version of Beats is 2.1.0, released on September 9, 2017.
+The latest version of Beats is 2.1.1, released on June 29, 2018. It contains these changes:
 
-This version adds support for *composite sounds*. That is, sounds that are made by combining two or more sounds together. They are a more succinct way of writing songs where multiple tracks play the same rhythm.
+* Several error messages are improved to be more accurate or specific.
+* **Bug fix**: Songs can now use *.wav files with more than 2 channels. Previously, using a sound with more than 2 channels would cause a fatal `Invalid sample data array in AudioUtils.normalize()` error.
+* **Bug fix**: If a sound is defined multiple times in a Kit, the final definition should be used as the winner. However, previously this did not occur if the earlier definition was for a composite sound. For example, with this Kit:
 
-Composite sounds can be defined in the Kit by putting multiple sound files in an array:
-
-    Kit:
-      - bass:         bass.wav                    # A traditional non-composite sound
-      - combo_snare:  [clap.wav, 808_snare.wav]   # A composite sound
-
-The `combo_snare` sound above is a composite sound made by combining `clap.wav` and `808_snare.wav` together. It can then be used in a pattern:
-
-    Verse:
-      - bass:         X.......X.......
-      - combo_snare:  ....X.......X...
-
-This is equivalent to the following song:
-
-    Kit:
-      - bass:   bass.wav
-      - clap:   clap.wav
-      - snare:  808_snare.wav
-
-    Verse:
-      - bass:   X.......X.......
-      - clap:   ....X.......X...
-      - snare:  ....X.......X...
-
-When using the `-s` command-line option to write each track to its own *.wav file, each sub-sound in a composite sound will be written to its own file. For example, this song:
-
-    Kit:
-      - combo_snare:  [clap.wav, 808_snare.wav]
-
-    Verse:
-      - combo_snare:  X...X...X...X...
-
-...will be written to two different files, `combo_snare-clap.wav` and `combo_snare-808_snare.wav`, when using the `-s` option.
-
-Finally, when defining a track in a pattern, multiple sounds can be given in an array as a composite sound. Kit sounds and non-Kit sounds can be used together:
-
-    Kit:
-      - bass:         bass.wav
-      - combo_snare:  [clap.wav, 808_snare.wav]
-
-    Verse:
-      - [bass, combo_snare, other_sound.wav]:   X...X...X...X...
-
-This is a equivalent to:
-
-    Kit:
-      - bass:   bass.wav
-      - clap:   clap.wav
-      - snare:  808_snare.wav
-
-    Verse:
-      - bass:             X...X...X...X...
-      - clap:             X...X...X...X...
-      - snare:            X...X...X...X...
-      - other_sound.wav:  X...X...X...X...
-
-
-
-What's Slightly Less New
-------------------------
+      Kit:
+        - sound: [sound1.wav, sound2.wav]
+        - sound: sound3.wav
 
-The previous version of Beats is 2.0.0, released on September 4, 2017. It is primarily a modernization release, and contains some relatively small backwards incompatible changes.
+  `sound` will now be bound to `sound3.wav`, not `[sound1.wav, sound2.wav]`.
 
-* Track rhythms can now have spaces in them. For example, `X... .... X... ....` is now a valid rhythm. Spaces are ignored, and don't affect the rhythm. For example, `X...    X...` is treated as the same rhythm as `X...X...`
-* Wave files using `WAVEFORMATEXTENSIBLE` format can now be used, due to upgrading the WaveFile gem dependency to v0.8.1 behind the scenes.
-* Installing the gem is now simpler, since it no longer requires installing the legacy `syck` YAML parser via an extension.
-* A `Fixnum is deprecated` message is no longer shown when using Ruby 2.4
-* **Backwards incompatible changes**:
-  * Song files containing a `Structure` section are no longer supported. A `Flow` section should be used instead. Support for the `Structure` section has been deprecated since v1.2.1 (released in 2011).
-  * Track rhythms can no longer start with a `|` character. For example, `|X...X...` is no longer a valid rhythm. However, bar lines are still allowed to appear elsewhere in the rhythm. For example, `X...X...|X...X...|` _is_ a valid rhythm. The reason for this change is that a rhythm starting with `|` is parsed as a YAML scalar block now that Beats is using the Psych YAML library behind the scenes. The fact that the old Syck YAML library didn't treat rhythms starting with a `|` as a YAML scalar block appears to have been a bug in Syck?
-* The minimum supported Ruby version is now 1.9.3, instead of 1.8.7
+For info about previous releases, visit https://github.com/jstrait/beats/releases.
 
 
 Local Development
@@ -160,4 +98,3 @@ Contact me (Joel Strait) by sending a GitHub message or opening a GitHub issue.
 License
 -------
 Beats Drum Machine is released under the MIT license.
-

data/bin/beats

@@ -2,13 +2,8 @@
 
 start_time = Time.now
 
-$:.unshift File.dirname(__FILE__) + "/../lib"
-gem "wavefile", "=0.8.1"
 require "optparse"
-require "yaml"
-require "wavefile"
 require "beats"
-require "wavefile/cachingwriter"
 
 include Beats
 
@@ -79,9 +74,9 @@ begin
   input_file_name = ARGV[0]
   output_file_name = ARGV[1]
 
-  beats = BeatsRunner.new(input_file_name, output_file_name, options)
+  beats_runner = BeatsRunner.new(input_file_name, output_file_name, options)
 
-  output = beats.run()
+  output = beats_runner.run()
   duration = output[:duration]
   puts "#{duration.minutes}:#{duration.seconds.to_s.rjust(2, '0')} of audio written in #{Time.now - start_time} seconds."
 rescue => error

data/lib/beats.rb

@@ -1,15 +1,21 @@
-require 'beats/audioengine'
-require 'beats/audioutils'
-require 'beats/beatsrunner'
+require 'yaml'
+
+gem "wavefile", "=0.8.1"
+require 'wavefile'
+require 'wavefile/caching_writer'
+
+require 'beats/audio_engine'
+require 'beats/audio_utils'
+require 'beats/beats_runner'
 require 'beats/kit'
 require 'beats/kit_builder'
 require 'beats/pattern'
 require 'beats/song'
-require 'beats/songparser'
-require 'beats/songoptimizer'
+require 'beats/song_parser'
+require 'beats/song_optimizer'
 require 'beats/track'
 require 'beats/transforms/song_swinger'
 
 module Beats
-  VERSION = "2.1.0"
+  VERSION = "2.1.1"
 end

data/lib/beats/{audioengine.rb → audio_engine.rb}

@@ -12,7 +12,6 @@ module Beats
   #
   class AudioEngine
     SAMPLE_RATE = 44100
-    PACK_CODE = "s*"   # All output sample data is assumed to be 16-bit
 
     def initialize(song, kit)
       @song = song
@@ -37,8 +36,8 @@ module Beats
         unless packed_pattern_cache.member?(key)
           sample_data = generate_pattern_sample_data(@song.patterns[pattern_name], incoming_overflow)
 
-          packed_pattern_cache[key] = { :primary => WaveFile::Buffer.new(sample_data[:primary], format),
-                                        :overflow => WaveFile::Buffer.new(sample_data[:overflow], format) }
+          packed_pattern_cache[key] = { primary:  WaveFile::Buffer.new(sample_data[:primary], format),
+                                        overflow: WaveFile::Buffer.new(sample_data[:overflow], format) }
         end
 
         writer.write(packed_pattern_cache[key][:primary])
@@ -63,10 +62,10 @@ module Beats
     def generate_track_sample_data(track, sound)
       trigger_step_lengths = track.trigger_step_lengths
       if trigger_step_lengths == [0]
-        return {:primary => [], :overflow => []}    # Is this really what should happen? Why throw away overflow?
+        return {primary: [], overflow: []}    # Is this really what should happen? Why throw away overflow?
       end
 
-      fill_value = (@kit.num_channels == 1) ? 0 : [0, 0]
+      fill_value = (@kit.num_channels == 1) ? 0 : Array.new(@kit.num_channels, 0)
       primary_sample_data = [].fill(fill_value, 0, AudioUtils.step_start_sample(track.step_count, @step_sample_length))
 
       step_index = trigger_step_lengths[0]
@@ -83,7 +82,7 @@ module Beats
 
       overflow_sample_data = (sound == [] || trigger_step_lengths.length == 1) ? [] : sound[trigger_sample_length...(sound.length)]
 
-      {:primary => primary_sample_data, :overflow => overflow_sample_data}
+      {primary: primary_sample_data, overflow: overflow_sample_data}
     end
 
     # Composites the sample data for each of the pattern's tracks, and returns the overflow sample data
@@ -93,7 +92,7 @@ module Beats
       # Unless cached, composite each track's sample data.
       if @composited_pattern_cache[pattern].nil?
         primary_sample_data, overflow_sample_data = composite_pattern_tracks(pattern)
-        @composited_pattern_cache[pattern] = {:primary => primary_sample_data.dup, :overflow => overflow_sample_data.dup}
+        @composited_pattern_cache[pattern] = {primary: primary_sample_data.dup, overflow: overflow_sample_data.dup}
       else
         primary_sample_data = @composited_pattern_cache[pattern][:primary].dup
         overflow_sample_data = @composited_pattern_cache[pattern][:overflow].dup
@@ -106,7 +105,7 @@ module Beats
                                                                            overflow_sample_data)
       primary_sample_data = AudioUtils.scale(primary_sample_data, @kit.num_channels, @song.total_tracks)
 
-      {:primary => primary_sample_data, :overflow => overflow_sample_data}
+      {primary: primary_sample_data, overflow: overflow_sample_data}
     end
 
     def composite_pattern_tracks(pattern)

data/lib/beats/{audioutils.rb → audio_utils.rb}

@@ -7,6 +7,10 @@ module Beats
     # of the longest input array.
     # WARNING: Incoming arrays can be modified.
     def self.composite(sample_arrays, num_channels)
+      if num_channels < 1
+        raise ArgumentError, "`num_channels` must be 1 or greater"
+      end
+
       if sample_arrays == []
         return []
       end
@@ -16,14 +20,26 @@ module Beats
 
       composited_output = sample_arrays.slice!(0)
       sample_arrays.each do |sample_array|
-        unless sample_array == []
-          if num_channels == 1
-            sample_array.length.times {|i| composited_output[i] += sample_array[i] }
-          elsif num_channels == 2
-            sample_array.length.times do |i|
-              composited_output[i] = [composited_output[i][0] + sample_array[i][0],
-                                      composited_output[i][1] + sample_array[i][1]]
+        if num_channels == 1
+          sample_array.length.times {|i| composited_output[i] += sample_array[i] }
+        elsif num_channels == 2
+          sample_array.length.times do |i|
+            # Setting composited_output[i][<channel_index>] won't necessary work,
+            # because each sub array might point to the same array, causing more
+            # samples to be set than expected. For example, a sample buffer initialized
+            # using `[].fill([0, 0], 0, 1000)` will result in an array where each index
+            # is a pointer to the same array instance.
+            composited_output[i] = [composited_output[i][0] + sample_array[i][0],
+                                    composited_output[i][1] + sample_array[i][1]]
+          end
+        elsif num_channels > 2
+          sample_array.each_with_index do |sub_array, i|
+            composited_sub_array = []
+            sub_array.each_with_index do |sample, j|
+              composited_sub_array << composited_output[i][j] + sample
             end
+
+            composited_output[i] = composited_sub_array
           end
         end
       end
@@ -35,21 +51,23 @@ module Beats
     # Scales the amplitude of the incoming sample array by *scale* amount. Can be used in conjunction
     # with composite() to make sure composited sample arrays don't have an amplitude greater than 1.0.
     def self.scale(sample_array, num_channels, scale)
-      if sample_array == []
+      if num_channels < 1
+        raise ArgumentError, "`num_channels` must be 1 or greater"
+      end
+
+      if scale == 1 || sample_array == []
         return sample_array
       end
 
-      if scale > 1
-        if num_channels == 1
-          sample_array = sample_array.map {|sample| sample / scale }
-        elsif num_channels == 2
-          sample_array = sample_array.map {|sample| [sample[0] / scale, sample[1] / scale]}
-        else
-          raise StandardError, "Invalid sample data array in AudioUtils.normalize()"
+      if num_channels == 1
+        sample_array.map {|sample| sample / scale }
+      elsif num_channels == 2
+        sample_array.map {|sample_frame| [sample_frame[0] / scale, sample_frame[1] / scale]}
+      elsif num_channels > 2
+        sample_array.map do |sample_frame|
+          sample_frame.map {|sample| sample / scale }
         end
       end
-
-      sample_array
     end
 
 

data/lib/beats/{beatsrunner.rb → beats_runner.rb}

@@ -18,7 +18,7 @@ module Beats
 
     def run
       base_path = @options[:base_path] || File.dirname(@input_file_name)
-      song, kit = SongParser.new.parse(base_path, File.read(@input_file_name))
+      song, kit = SongParser.parse(base_path, File.read(@input_file_name))
 
       song = normalize_for_pattern_option(song)
       songs_to_generate = normalize_for_split_option(song)
@@ -29,7 +29,7 @@ module Beats
         AudioEngine.new(optimized_song, kit).write_to_file(output_file_name)
       end
 
-      {:duration => durations.last}
+      {duration: durations.last}
     end
 
   private

data/lib/beats/kit.rb

@@ -6,15 +6,16 @@ module Beats
 
     def initialize(items, num_channels, bits_per_sample)
       @items = items
+      @labels = @items.keys.freeze
       @num_channels = num_channels
       @bits_per_sample = bits_per_sample
     end
 
-    attr_reader :num_channels, :bits_per_sample
+    attr_reader :labels, :num_channels, :bits_per_sample
 
     # Returns the sample data for a sound contained in the Kit. If the all sounds in the
-    # kit are mono, then this will be a flat Array of Fixnums between -32768 and 32767.
-    # Otherwise, this will be an Array of Fixnums pairs between -32768 and 32767.
+    # kit are mono, then this will be a flat Array of Integers between -32768 and 32767.
+    # Otherwise, this will be an Array of Integers pairs between -32768 and 32767.
     #
     # label - The name of the sound to get sample data for. If the sound was defined in
     #         the Kit section of a song file, this will generally be a descriptive label
@@ -23,11 +24,11 @@ module Beats
     #
     # Examples
     #
-    #   # If @num_channels is 1, a flat Array of Fixnums:
+    #   # If @num_channels is 1, a flat Array of Integers:
     #   get_sample_data("bass")
     #   # => [154, 7023, 8132, 2622, -132, 34, ..., -6702]
     #
-    #   # If @num_channels is 2, a Array of Fixnums pairs:
+    #   # If @num_channels is 2, a Array of Integers pairs:
     #   get_sample_data("snare")
     #   # => [[57, 1265], [-452, 10543], [-2531, 12643], [-6372, 11653], ..., [5482, 25673]]
     #

data/lib/beats/kit_builder.rb

@@ -20,19 +20,22 @@ module Beats
     def add_item(label, filenames)
       if filenames.is_a?(Array)
         if filenames.empty?
-          raise SoundFileNotFoundError, "Kit sound '#{label}' has an empty composite pattern (i.e. \"[]\"), which is not valid."
+          raise SoundFileNotFoundError, "Kit sound '#{label}' is an empty composite sound (i.e. \"[]\"), which is not valid."
         end
 
+        @composite_replacements[label] = []
+
         filenames.each do |filename|
           unless filename.is_a?(String)
             raise SoundFileNotFoundError, "The Kit sound '#{label}' contains an invalid file: '#{filename}'"
           end
-          @labels_to_filenames["#{label}-#{File.basename(filename, ".*")}"] = absolute_file_name(filename)
+          composite_replacement = "#{label}-#{File.basename(filename, ".*")}"
+          @labels_to_filenames[composite_replacement] = absolute_file_name(filename)
+          @composite_replacements[label] << composite_replacement
         end
-
-        @composite_replacements[label] = filenames.map {|filename| "#{label}-#{File.basename(filename, ".*")}" }
       else
         @labels_to_filenames[label] = absolute_file_name(filenames)
+        @composite_replacements.delete(label)
       end
     end
 
@@ -80,10 +83,11 @@ module Beats
           sample_buffer = buffer
         end
       rescue Errno::ENOENT
-        raise SoundFileNotFoundError, "Sound file #{filename} not found."
-      rescue StandardError
-        raise InvalidSoundFormatError, "Sound file #{filename} is either not a sound file, " +
-                                       "or is in an unsupported format. BEATS can handle 8, 16, 24, or 32-bit PCM *.wav files."
+        raise SoundFileNotFoundError, "Sound file `#{filename}` not found."
+      rescue WaveFile::UnsupportedFormatError
+        raise InvalidSoundFormatError, "Sound file `#{filename}` is not a supported *.wav format. Beats can use *.wav files with a sample format of 8/16/24/32 PCM or floating point."
+      rescue WaveFile::InvalidFormatError
+        raise InvalidSoundFormatError, "Sound file `#{filename}` is either not a sound file, or is in an unsupported format. Beats can use *.wav files with a sample format of 8/16/24/32 PCM or floating point."
       end
 
       sample_buffer

data/lib/beats/pattern.rb

@@ -5,28 +5,19 @@ module Beats
   # This object is like sheet music; the AudioEngine is responsible creating actual
   # audio data for a Pattern (with the help of a Kit).
   class Pattern
-    def initialize(name)
+    def initialize(name, tracks=[])
       @name = name
       @tracks = {}
-    end
 
-    # Adds a new track to the pattern.
-    def track(name, rhythm)
-      track_key = unique_track_name(name)
-      new_track = Track.new(name, rhythm)
-      @tracks[track_key] = new_track
+      longest_track_length = tracks.map {|track| track.rhythm.length }.max
 
-      # If the new track is longer than any of the previously added tracks,
-      # pad the other tracks with trailing . to make them all the same length.
-      # Necessary to prevent incorrect overflow calculations for tracks.
-      longest_track_length = step_count
-      @tracks.values.each do |track|
-        if track.rhythm.length < longest_track_length
-          track.rhythm += "." * (longest_track_length - track.rhythm.length)
-        end
+      tracks.each do |track|
+        track_key = unique_track_name(track.name)
+        new_track = Track.new(track.name, track.rhythm.ljust(longest_track_length, Track::REST))
+        @tracks[track_key] = new_track
       end
 
-      new_track
+      @tracks.freeze
     end
 
     def step_count