mtk 0.0.1 → 0.0.2

data/spec/mtk/timeline_spec.rb

@@ -8,6 +8,15 @@ describe MTK::Timeline do
   let(:timeline_hash) { { 0 => [note1], 1 => [note1, note2] } }
   let(:timeline) { Timeline.from_hash(timeline_raw_data) }
 
+  let(:unquantized_data) { { 0.0 => [note1], 0.7 => [note1], 1.24 => [note1], 1.25 => [note1] } }
+  let(:unquantized_timeline) { Timeline.from_hash(unquantized_data) }
+  let(:quantization_interval) { 0.5 }
+  let(:quantized_data) { { 0.0 => [note1], 0.5 => [note1], 1.0 => [note1], 1.5 => [note1] } }
+
+  let(:shifted_data) { { 5 => [note1], 6 => [note1, note2] } }
+  let(:reverse_shifted_data) { { -5 => [note1], -4 => [note1, note2] } }
+  let(:shift_amount) { 5 }
+
   it "is Enumerable" do
     Timeline.new.should be_a Enumerable
   end
@@ -35,7 +44,9 @@ describe MTK::Timeline do
   end
 
   describe "from_a" do
-    it "creates a timeline from an Enumerable"
+    it "creates a timeline from an Enumerable" do
+      Timeline.from_a(timeline_hash.to_a).should == timeline
+    end
   end
 
   describe "#to_hash" do
@@ -51,7 +62,9 @@ describe MTK::Timeline do
   end
 
   describe "#merge" do
-    it "merges all the time,event pairs in the given Enumerable into this Timeline"
+    it "merges all the time,event pairs in the given Enumerable into this Timeline" do
+      timeline.merge({ 3 => note2 }).should == Timeline.from_hash( timeline_raw_data.merge({ 3 => note2 }) )
+    end
   end
 
   describe "#empty?" do
@@ -98,7 +111,10 @@ describe MTK::Timeline do
       timeline[5].should == [note1, note2]
     end
 
-    it "accepts either a single event or a list of events as its second argument"
+    it "accepts a list of events as its second argument" do
+      timeline.add 5, [note1, note2]
+      timeline[5].should == [note1, note2]
+    end
   end
 
   describe "#delete" do
@@ -142,24 +158,16 @@ describe MTK::Timeline do
   end
 
   describe "#each" do
-    it "yields each |time,single_event| pair" do
-      yielded = []
-      timeline.each{|t,e| yielded << [t,e] }
-      yielded.should == [ [0,note1], [1,note1], [1,note2] ]
-    end
-  end
-
-  describe "#each_time" do
     it "yields each |time,event_list| pair" do
       yielded = []
-      timeline.each_time{|t,es| yielded << [t,es] }
+      timeline.each{|time,events| yielded << [time,events] }
       yielded.should == [ [0,[note1]], [1,[note1,note2]] ]
     end
   end
 
   describe "#map" do
     it "returns a new Timeline where each [time,event] pair is replaced by the result of block" do
-      mapped = timeline.map{|time,event| [time+1, event.transpose(time+2)] }
+      mapped = timeline.map{|time,events| [time+1, events.map{|e| e.transpose(time+2) }] }
       mapped.should == { 1 => [note1.transpose(2)], 2 => [note1.transpose(3), note2.transpose(3)] }
     end
 
@@ -171,7 +179,7 @@ describe MTK::Timeline do
 
   describe "#map!" do
     it "maps the Timeline in place" do
-      timeline.map! {|time,event| [time+1, event.transpose(time+2)] }
+      timeline.map! {|time,events| [time+1, events.map{|e| e.transpose(time+2) }] }
       timeline.should == { 1 => [note1.transpose(2)], 2 => [note1.transpose(3), note2.transpose(3)] }
     end
   end
@@ -203,7 +211,86 @@ describe MTK::Timeline do
       timeline.should == timeline_hash
     end
   end
-  
+
+  describe "#quantize" do
+    it "maps all times to the nearest multiple of the given interval" do
+      unquantized_timeline.quantize(quantization_interval).should == quantized_data
+    end
+    it "returns a new Timeline and does not modify the original" do
+      unquantized_timeline.quantize(quantization_interval)
+      unquantized_timeline.should == unquantized_data
+    end
+  end
+
+  describe "#quantize!" do
+    it "maps all times to the nearest multiple of the given interval" do
+      unquantized_timeline.quantize!(quantization_interval).should == quantized_data
+    end
+
+    it "modifies the Timeline in place" do
+      unquantized_timeline.quantize!(quantization_interval)
+      unquantized_timeline.should == quantized_data
+    end
+  end
+
+  describe "#shift" do
+    it "shifts all times by the given amount" do
+      timeline.shift(shift_amount).should == shifted_data
+    end
+
+    it "goes back in time for negative arguments" do
+      timeline.shift(-shift_amount).should == reverse_shifted_data
+    end
+
+    it "returns an instance of the same type" do
+      timeline.shift(shift_amount).should be_a timeline.class
+    end
+
+    it "returns a new Timeline and does not modify the original" do
+      timeline.shift(shift_amount).should_not equal timeline
+    end
+  end
+
+  describe "#shift!" do
+    it "shifts all times by the given amount" do
+      timeline.shift!(shift_amount).should == shifted_data
+    end
+
+    it "goes back in time for negative arguments" do
+      timeline.shift!(-shift_amount).should == reverse_shifted_data
+    end
+
+    it "modifies the timeline in place" do
+      timeline.shift!(shift_amount).should equal timeline
+    end
+  end
+
+  describe "#shift_to" do
+    it "shifts so the start is at the given time" do
+      Timeline.from_hash(shifted_data).shift_to(0).should == timeline
+      Timeline.from_hash(reverse_shifted_data).shift_to(0).should == timeline
+    end
+
+    it "returns an instance of the same type" do
+      timeline.shift_to(shift_amount).should be_a timeline.class
+    end
+
+    it "returns a new Timeline and does not modify the original" do
+      timeline.shift_to(shift_amount).should_not equal timeline
+    end
+  end
+
+  describe "#shift_to!" do
+    it "shifts so the start is at the given time" do
+      Timeline.from_hash(shifted_data).shift_to!(0).should == timeline
+      Timeline.from_hash(reverse_shifted_data).shift_to!(0).should == timeline
+    end
+
+    it "modifies the timeline in place" do
+      timeline.shift_to!(shift_amount).should equal timeline
+    end
+  end
+
   describe "#flatten" do
     it "flattens nested timelines so that all nested subtimes are converted to absolute times in a single timeline" do
       timeline[10] = Timeline.from_hash({ 0 => note2, 1 => note1 })
@@ -230,5 +317,21 @@ describe MTK::Timeline do
       timeline.clone.should_not equal(timeline)
     end
   end
+
+  describe ".quantize_time" do
+    it "takes a time and an interval, and returns the nearest multiple of the interval to the time" do
+      Timeline.quantize_time(23,10).should == 20
+      Timeline.quantize_time(27,10).should == 30
+      Timeline.quantize_time(30,10).should == 30
+    end
+
+    it "rounds up when exactly between 2 intervals" do
+      Timeline.quantize_time(25,10).should == 30
+    end
+
+    it "handles fractional intervals" do
+      Timeline.quantize_time(13,2.5).should == 12.5
+    end
+  end
 end
 

data/spec/spec_helper.rb

@@ -1,7 +1,8 @@
 require 'mtk'
-require 'mtk/patterns'
 include MTK
-include Pitches
 include PitchClasses
-include Dynamics
+include Pitches
+include Intensities
+include Durations
 include Intervals
+

metadata

@@ -2,7 +2,7 @@
 name: mtk
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Adam Murray
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-08 00:00:00 Z
+date: 2011-07-09 00:00:00 Z
 dependencies: []
 
 description: 
@@ -23,49 +23,86 @@ extra_rdoc_files: []
 
 files: 
 - Rakefile
+- INTRO.md
 - README.md
-- lib/mtk/chord.rb
-- lib/mtk/constants/dynamics.rb
-- lib/mtk/constants/intervals.rb
-- lib/mtk/constants/pitch_classes.rb
-- lib/mtk/constants/pitches.rb
-- lib/mtk/constants/pseudo_constants.rb
+- LICENSE.txt
+- .yardopts
+- lib/mtk/_constants/durations.rb
+- lib/mtk/_constants/intensities.rb
+- lib/mtk/_constants/intervals.rb
+- lib/mtk/_constants/pitch_classes.rb
+- lib/mtk/_constants/pitches.rb
+- lib/mtk/_numeric_extensions.rb
 - lib/mtk/event.rb
+- lib/mtk/helper/collection.rb
+- lib/mtk/helper/event_builder.rb
+- lib/mtk/helper/pseudo_constants.rb
+- lib/mtk/lang/grammar.rb
+- lib/mtk/lang/mtk_grammar.citrus
 - lib/mtk/midi/file.rb
+- lib/mtk/midi/jsound_input.rb
+- lib/mtk/midi/jsound_output.rb
 - lib/mtk/note.rb
-- lib/mtk/numeric_extensions.rb
+- lib/mtk/pattern/abstract_pattern.rb
 - lib/mtk/pattern/choice.rb
-- lib/mtk/pattern/note_sequence.rb
-- lib/mtk/pattern/pitch_sequence.rb
+- lib/mtk/pattern/cycle.rb
+- lib/mtk/pattern/enumerator.rb
+- lib/mtk/pattern/function.rb
+- lib/mtk/pattern/lines.rb
+- lib/mtk/pattern/palindrome.rb
 - lib/mtk/pattern/sequence.rb
-- lib/mtk/patterns.rb
 - lib/mtk/pitch.rb
 - lib/mtk/pitch_class.rb
 - lib/mtk/pitch_class_set.rb
 - lib/mtk/pitch_set.rb
+- lib/mtk/sequencer/abstract_sequencer.rb
+- lib/mtk/sequencer/rhythmic_sequencer.rb
+- lib/mtk/sequencer/step_sequencer.rb
 - lib/mtk/timeline.rb
-- lib/mtk/util/mappable.rb
+- lib/mtk/transform/invertible.rb
+- lib/mtk/transform/mappable.rb
+- lib/mtk/transform/set_theory_operations.rb
+- lib/mtk/transform/transposable.rb
 - lib/mtk.rb
-- spec/mtk/chord_spec.rb
-- spec/mtk/constants/dynamics_spec.rb
-- spec/mtk/constants/intervals_spec.rb
-- spec/mtk/constants/pitch_classes_spec.rb
-- spec/mtk/constants/pitches_spec.rb
+- spec/mtk/_constants/durations_spec.rb
+- spec/mtk/_constants/intensities_spec.rb
+- spec/mtk/_constants/intervals_spec.rb
+- spec/mtk/_constants/pitch_classes_spec.rb
+- spec/mtk/_constants/pitches_spec.rb
+- spec/mtk/_numeric_extensions_spec.rb
 - spec/mtk/event_spec.rb
+- spec/mtk/helper/collection_spec.rb
+- spec/mtk/helper/event_builder_spec.rb
+- spec/mtk/helper/pseudo_constants_spec.rb
+- spec/mtk/lang/grammar_spec.rb
 - spec/mtk/midi/file_spec.rb
 - spec/mtk/note_spec.rb
-- spec/mtk/numeric_extensions_spec.rb
+- spec/mtk/pattern/abstract_pattern_spec.rb
 - spec/mtk/pattern/choice_spec.rb
-- spec/mtk/pattern/note_sequence_spec.rb
-- spec/mtk/pattern/pitch_sequence_spec.rb
+- spec/mtk/pattern/cycle_spec.rb
+- spec/mtk/pattern/function_spec.rb
+- spec/mtk/pattern/lines_spec.rb
+- spec/mtk/pattern/note_cycle_spec.rb.bak
+- spec/mtk/pattern/palindrome_spec.rb
+- spec/mtk/pattern/pitch_cycle_spec.rb.bak
+- spec/mtk/pattern/pitch_sequence_spec.rb.bak
 - spec/mtk/pattern/sequence_spec.rb
 - spec/mtk/pitch_class_set_spec.rb
 - spec/mtk/pitch_class_spec.rb
 - spec/mtk/pitch_set_spec.rb
 - spec/mtk/pitch_spec.rb
+- spec/mtk/sequencer/abstract_sequencer_spec.rb
+- spec/mtk/sequencer/rhythmic_sequencer_spec.rb
+- spec/mtk/sequencer/step_sequencer_spec.rb
 - spec/mtk/timeline_spec.rb
 - spec/spec_helper.rb
 - spec/test.mid
+- examples/crescendo.rb
+- examples/dynamic_pattern.rb
+- examples/play_midi.rb
+- examples/print_midi.rb
+- examples/random_tone_row.rb
+- examples/tone_row_melody.rb
 homepage: http://github.com/adamjmurray/mtk
 licenses: []
 
@@ -92,6 +129,6 @@ rubyforge_project:
 rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: Musical ToolKit for Ruby
+summary: Music ToolKit for Ruby
 test_files: []
 

data/lib/mtk/chord.rb

@@ -1,47 +0,0 @@
-module MTK
-
-  # A multi-pitch, note-like {Event} defined by a {PitchSet}, intensity, and duration
-  class Chord < Event
-
-    # the {PitchSet} of the chord
-    attr_reader :pitch_set
-
-    def initialize(pitches, intensity, duration)
-      @pitch_set = if pitches.is_a? PitchSet
-        pitches
-      else
-        PitchSet.new(pitches)
-      end
-      super(intensity, duration)
-    end
-
-    def self.from_hash(hash)
-      new hash[:pitch_set], hash[:intensity], hash[:duration]
-    end
-
-    def to_hash
-      super.merge({ :pitch_set => @pitch_set })
-    end
-
-    def pitches
-      @pitch_set.pitches
-    end
-
-    def transpose(interval)
-      self.class.new(@pitch_set + interval, @intensity, @duration)
-    end
-
-    def == other
-      super and other.respond_to? :pitch_set and @pitch_set == other.pitch_set
-    end
-
-    def to_s
-      "Chord(#{pitch_set}, #{super})"
-    end
-
-    def inspect
-      "Chord(#{pitch_set}, #{super})"
-    end
-  end
-
-end

data/lib/mtk/constants/dynamics.rb

@@ -1,56 +0,0 @@
-module MTK
-
-  # Defines values for standard dynamic symbols.
-  #
-  # These can be thought of like constants, but in order to distinguish 'f' (forte) from the {PitchClass} 'F'
-  # it was necessary to use lower-case names and therefore define them as "pseudo constant" methods.
-  # The methods are available either throught the module (MTK::Dynamics::f) or via mixin (include MTK::Dynamics;  f)
-  #
-  # These values are intensities in the range 0.0 - 1.0, so they can be easily scaled (unlike MIDI velocities).
-  #
-  # @note Including this module shadows Ruby's built-in p() method. 
-  #   If you include this module, you can access the built-in p() method via Kernel.p()
-  #
-  # @see Note
-  module Dynamics
-    extend MTK::PseudoConstants
-    
-    # NOTE: the yard doc macros here only fill in [$2] with the actual value when generating docs under Ruby 1.9+
-    
-    # pianississimo 
-    # @macro [attach] dynamics.define_constant
-    #   @attribute [r]
-    #   @return [$2] intensity value for $1   
-    define_constant 'ppp', 0.125
-
-    # pianissimo      
-    define_constant 'pp', 0.25
-
-    # piano
-    # @note Including this module shadows Ruby's built-in p() method. 
-    #   If you include this module, you can access the built-in p() method via Kernel.p()
-    define_constant 'p', 0.375
-
-    # mezzo-piano
-    define_constant 'mp', 0.5
-
-    # mezzo-forte
-    define_constant 'mf', 0.625
-
-    # forte
-    define_constant 'f', 0.75
-    
-    # fortissimo
-    define_constant 'ff', 0.875
-
-    # fortississimo
-    define_constant 'fff', 1.0
-
-    def self.[](name)
-      send name
-    rescue
-      nil
-    end
-
-  end
-end

data/lib/mtk/constants/pitch_classes.rb

@@ -1,18 +0,0 @@
-module MTK
-
-  # Defines a constant for each {PitchClass} in the Western chromatic scale.
-
-  module PitchClasses
-
-    # An array of all pitch class constants defined in this module
-    PITCH_CLASSES = []
-
-    for name in PitchClass::NAMES
-      pc = PitchClass.from_name name
-      PITCH_CLASSES << pc
-      const_set name, pc
-    end
-
-  end
-
-end

data/lib/mtk/constants/pitches.rb

@@ -1,24 +0,0 @@
-module MTK
-
-  # Defines a constants for each {Pitch} in the standard MIDI range using scientific pitch notation.
-  #
-  # See http://en.wikipedia.org/wiki/Scientific_pitch_notation
-  #
-  # Note that because the character '#' cannot be used in the name of a constant,
-  # The "black key" pitches are all named as flats with 'b' (for example, Gb3 or Cb4)
-
-  module Pitches
-
-    # An array of all the pitch constants defined in this module
-    PITCHES = []
-
-    128.times do |note_number|
-      pitch = Pitch.from_i( note_number )
-      PITCHES << pitch
-      octave_str = pitch.octave.to_s.sub(/-/,'_') # '_1' for -1
-      const_set "#{pitch.pitch_class}#{octave_str}", pitch
-    end
-
-  end
-
-end

data/lib/mtk/pattern/note_sequence.rb

@@ -1,60 +0,0 @@
-module MTK
-  module Pattern
-
-    # A {Sequence} of {Note}s
-    class NoteSequence
-
-      attr_reader :pitch_sequence, :intensity_sequence, :duration_sequence
-
-      attr_accessor :pitch, :intensity, :duration
-
-      def initialize(pitches, intensities=nil, durations=nil, defaults={})
-        @pitch_sequence     = PitchSequence.new(pitches)
-        @intensity_sequence = Sequence.new(intensities)
-        @duration_sequence  = Sequence.new(durations)
-        @default = {:pitch => Pitches::C4, :intensity => Dynamics::mf, :duration => 1}.merge defaults
-        reset
-      end
-
-      def pitches
-        @pitch_sequence.elements
-      end
-
-      def intensities
-        @intensity_sequence.elements
-      end
-
-      def durations
-        @duration_sequence.elements
-      end
-
-      # reset the Sequence to the beginning
-      def reset
-        @pitch_sequence.reset
-        @intensity_sequence.reset
-        @duration_sequence.reset
-
-        @pitch = @default[:pitch]
-        @intensity = @default[:intensity]
-        @duration = @default[:duration]
-      end
-
-      # return next {Note} in sequence
-      def next
-        @pitch = @pitch_sequence.next || @pitch
-        @intensity = @intensity_sequence.next || @intensity
-        @duration = @duration_sequence.next || @duration
-
-
-        case @pitch
-          when PitchSet,Array then Chord.new(@pitch, @intensity, @duration)
-          else Note.new(@pitch, @intensity, @duration)
-        end
-      end
-
-    end
-
-  end
-end
-
-

data/lib/mtk/pattern/pitch_sequence.rb

@@ -1,22 +0,0 @@
-module MTK
-  module Pattern
-
-    # A {Sequence} of pitch-related elements, which may be {Pitch}es, {PitchClass}es, {PitchSet}s, or {Intervals} (Numeric)
-    class PitchSequence < Sequence
-
-      protected
-
-      # extend value_of to handle intervals and PitchClasses
-      def value_of element
-        element = super # eval Procs
-        case element
-          when Numeric then @value + element if @value # add interval
-          when PitchClass then @value.nearest(element) if @value
-          else element
-        end
-      end
-
-    end
-
-  end
-end

data/lib/mtk/patterns.rb

@@ -1,4 +0,0 @@
-require 'mtk/pattern/sequence'
-require 'mtk/pattern/pitch_sequence'
-require 'mtk/pattern/note_sequence'
-require 'mtk/pattern/choice'

data/spec/mtk/chord_spec.rb

@@ -1,74 +0,0 @@
-require 'spec_helper'
-
-describe MTK::Chord do
-
-  let(:pitch_set) { PitchSet.new [C4, E4, G4] }
-  let(:intensity) { mf }
-  let(:duration) { 2.5 }
-  let(:chord) { Chord.new(pitch_set, intensity, duration) }
-
-  it "can be constructed with a PitchSet" do
-    pitch_set = PitchSet.new([C4])
-    Chord.new( pitch_set, intensity, duration ).pitch_set.should == pitch_set
-  end
-
-  it "can be constructed with an Array of Pitches" do
-    Chord.new( [C4], intensity, duration ).pitch_set.should == PitchSet.new([C4])
-  end
-
-  describe "#pitch_set" do
-    it "is the pitch_set used to create the Chord" do
-      chord.pitch_set.should == pitch_set
-    end
-
-    it "is a read-only attribute" do
-      lambda{ chord.pitch_set = PitchSet.new }.should raise_error
-    end
-  end
-
-  describe "#pitches" do
-    it "is the list of pitches in the pitch_set" do
-      chord.pitches.should == chord.pitch_set.pitches
-    end
-  end
-
-  describe "from_hash" do
-    it "constructs a Chord using a hash" do
-      Chord.from_hash({ :pitch_set => pitch_set, :intensity => intensity, :duration => duration }).should == chord
-    end
-  end
-
-  describe "#to_hash" do
-    it "is a hash containing all the attributes of the Chord" do
-      chord.to_hash.should == { :pitch_set => pitch_set, :intensity => intensity, :duration => duration }
-    end
-  end
-
-  describe '#transpose' do
-    it 'adds the given interval to the @pitch_set' do
-      (chord.transpose 2.semitones).should == Chord.new(pitch_set+2, intensity, duration)
-    end
-    it 'does not affect the immutability of the Chord' do
-      (chord.transpose 2.semitones).should_not == chord
-    end
-  end
-
-  describe "#==" do
-    it "is true when the pitch_sets, intensities, and durations are equal" do
-      chord.should == Chord.new(pitch_set, intensity, duration)
-    end
-
-    it "is false when the pitch_sets are not equal" do
-      chord.should_not == Chord.new(pitch_set + 1, intensity, duration)
-    end
-
-    it "is false when the intensities are not equal" do
-      chord.should_not == Chord.new(pitch_set, intensity * 0.5, duration)
-    end
-
-    it "is false when the durations are not equal" do
-      chord.should_not == Chord.new(pitch_set, intensity, duration * 2)
-    end
-  end
-
-end

data/spec/mtk/constants/pitch_classes_spec.rb

@@ -1,35 +0,0 @@
-require 'spec_helper'
-
-describe MTK::PitchClasses do
-  let(:cases) {
-    [
-        [PitchClasses::C,  'C',   0],
-        [PitchClasses::Db, 'Db',  1],
-        [PitchClasses::D,  'D',   2],
-        [PitchClasses::Eb, 'Eb',  3],
-        [PitchClasses::E,  'E',   4],
-        [PitchClasses::F,  'F',   5],
-        [PitchClasses::Gb, 'Gb',  6],
-        [PitchClasses::G,  'G',   7],
-        [PitchClasses::Ab, 'Ab',  8],
-        [PitchClasses::A,  'A',   9],
-        [PitchClasses::Bb, 'Bb', 10],
-        [PitchClasses::B,  'B',  11],
-    ]
-  }
-
-  it "defines constants for the 12 pitch classes in the twelve-tone octave" do
-    cases.length.should == 12
-    cases.each do |const, name, int_value|
-      const.name.should == name
-      const.to_i.should == int_value
-    end
-  end
-
-  describe "PITCH_CLASSES" do
-    it "contains the 12 pitch class constants" do
-      PitchClasses::PITCH_CLASSES.length.should == 12
-      PitchClasses::PITCH_CLASSES.should == cases.map{ |const,_,__| const }
-    end
-  end
-end