musicality 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2138ce48e8476b381ac46a6bdc6c9b5578de656
-  data.tar.gz: f95722c9c8a4818701880bbe733ccc7684ee41ef
+  metadata.gz: 1b76956290ba2ff351587624b43db12c84fc99a5
+  data.tar.gz: 02460a5a7b390c335ffac5c8050b76bb280fd149
 SHA512:
-  metadata.gz: 9787df99b773046c025138212a9b67494e6ef080211ef429ae04519900e7f3e51dd68c5f0bccb68e762c918e77362fee23a9effb6df8dd06876674914e6d727c
-  data.tar.gz: 965abe4f0fd8e897f99909a4d8a6b8c1967f2e45cb8291357d11e60d7c7666660ac9b4f11c5c21f2653de16bb1f74e0e307156183d42ece31d871802d1d07f64
+  metadata.gz: ed2d94a4bd155e24a072481ed45027b362475c68628d41be6cf1e565e08636564fd71375f01936fbb74a7fe13dfcd5bcd22649117b76e5d179ffa83d19031d53
+  data.tar.gz: 05d65518d4f9d8abb5bda61490cdfa18d4458148648b46f6edc4ba518d10caaf6f12c9dea74522cc4615fd650441a0892e43057928d97b358dcdc2eacc6d540a

data/README.md

@@ -58,13 +58,56 @@ twinkle = Score::Measured.new(TWO_FOUR, 120) do |s|
 end
 ```
 
-To continue the above example, a score can be prepare for MIDI playback using the `Score::Measured#to_midi_seq` method.
+## MIDI Sequencing
+
+A score can be prepared for MIDI playback using the `ScoreSequencer` class or `#to_midi_seq` method. To continue the previous example,
 ```ruby
 TEMPO_SAMPLE_RATE = 500
 seq = twinkle.to_midi_seq TEMPO_SAMPLE_RATE
 File.open('twinkle.mid', 'wb'){ |fout| seq.write(fout) }
 ```
-## 
+## Score DSL
+
+The score DSL is an internal DSL (built on Ruby) that consists of a *score* block with additional blocks inside this to add sections, notes, and tempo/meter/dynamic changes.
+
+Here is an example of a score file.
+```ruby
+measured_score FOUR_FOUR, 120 do
+  title "Twinkle, Twinkle, Little Star"
+
+  Cmaj = [C3,E3,G3]
+  Fmaj = [F2,A2,C3]
+  Gmaj = [G2,B2,D3]
+  section "A" do
+    notes(
+      "rhand" => q(C4,C4,G4,G4,A4,A4) + h(G4) +
+                 q(F4,F4,E4,E4,D4,D4) + h(C4),
+      "lhand" => h(Cmaj,Cmaj,Fmaj,Cmaj) + 
+                 h(Fmaj,Cmaj,Gmaj,Cmaj)
+    )
+  end
+
+  section "B" do
+    notes(
+      "rhand" => q(G4,G4,F4,F4,E4,E4) + h(D4),
+      "lhand" => h(Cmaj,Fmaj,Cmaj,Gmaj)
+    )
+  end
+  repeat "B"
+  repeat "A"
+end
+```
+
+The above score file is processed by the `ScoreDSL.load` method, as in:
+```ruby
+require 'musicality'
+include Musicality
+include Meters
+include Pitches
+
+dsl = ScoreDSL.load 'twinkle.score'
+score = dsl.score
+``` 
 
 ## Contributing
 

data/bin/lilify

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+
+exe_name = File.basename(__FILE__)
+
+doc = <<DOCOPT
+Loads a musicality score from YAML file, and converts it to a Lilypond file for engraving.
+
+Usage:
+  #{exe_name} <input> [PART TITLE] ... [options]
+  #{exe_name} -h | --help
+  #{exe_name} --version
+
+Arguments:
+  input A musicality score file (may be packed as a hash) in YAML format
+  PART name of a part in the score (e.g. "lhand")
+  TITLE The title to give the part (e.g. "Left Hand")
+  
+Options:
+  --all         Select all parts for engraving, and use part name as the title if not given
+  -h --help     Show this screen.
+  --version     Show version.
+  --outfile=OUTF Name of output Lilypond file
+
+DOCOPT
+
+require 'docopt'
+begin
+  args = Docopt::docopt(doc)
+  puts args
+rescue Docopt::Exit => e
+  puts e.message
+  exit
+end
+
+require 'musicality'
+
+if args["--version"]
+  puts "#{exe_name} from musicality v#{Musicality::VERSION}"
+  exit
+end
+
+require 'yaml'
+include Musicality
+
+fin_name = args["<input>"]
+File.open(fin_name) do |fin|
+  print "Reading file '#{fin_name}'..."
+  score = YAML.load(fin.read)
+  
+  if score.is_a? Hash
+    score = Score.unpack(score)
+  end
+  puts "done"
+  
+  if score.valid?
+    part_names = args["PART"]
+    part_titles = args["TITLE"]
+    name_title_map = 
+
+    make_lilypond_args = {
+      :part_titles => Hash[[part_names,part_titles].transpose] 
+    }
+    unless args["--all"]
+      make_lilypond_args[:selected_parts] = part_names
+    end
+
+    print "Making Lilypond instructions..."
+    engraver = ScoreEngraver.new(score)
+    lilypond_text = engraver.make_lilypond(make_lilypond_args)
+    puts "done"
+
+    fout_name = args["--outfile"]
+    if fout_name.nil?
+      fout_name = "#{File.dirname(fin_name)}/#{File.basename(fin_name,File.extname(fin_name))}.ly"
+    end
+    print "Writing Lilypond file '#{fout_name}'..."
+    File.write(fout_name, lilypond_text)
+    puts "done"
+  else
+    puts "Score is not valid. See errors:"
+    puts score.errors.join("\n")
+  end
+end

data/bin/midify

@@ -33,8 +33,14 @@ rescue Docopt::Exit => e
   exit
 end
 
-require 'yaml'
 require 'musicality'
+
+if args["--version"]
+  puts "#{exe_name} in musicality v#{Musicality::VERSION}"
+  exit
+end
+
+require 'yaml'
 include Musicality
 
 fin_name = args["<input>"]

data/lib/musicality.rb

@@ -69,6 +69,7 @@ require 'musicality/composition/util/adding_sequence'
 require 'musicality/composition/util/compound_sequence'
 require 'musicality/composition/util/random_sampler'
 require 'musicality/composition/util/probabilities'
+require 'musicality/composition/util/note_generation'
 
 require 'musicality/composition/model/pitch_class'
 require 'musicality/composition/model/pitch_classes'
@@ -76,15 +77,14 @@ require 'musicality/composition/model/scale'
 require 'musicality/composition/model/scale_class'
 require 'musicality/composition/model/scale_classes'
 
-require 'musicality/composition/note_generation'
-require 'musicality/composition/transposition'
-
 require 'musicality/composition/generation/counterpoint_generator'
 require 'musicality/composition/generation/random_rhythm_generator'
 
 require 'musicality/composition/dsl/score_methods'
 require 'musicality/composition/dsl/score_dsl'
 
+require 'musicality/composition/convenience_methods'
+
 #
 # Performance
 #
@@ -115,4 +115,5 @@ require 'musicality/printing/lilypond/errors'
 require 'musicality/printing/lilypond/pitch_engraving'
 require 'musicality/printing/lilypond/note_engraving'
 require 'musicality/printing/lilypond/meter_engraving'
-require 'musicality/printing/lilypond/score_engraver'
+require 'musicality/printing/lilypond/score_engraver'
+require 'musicality/printing/lilypond/score_engraving'

data/lib/musicality/composition/convenience_methods.rb

@@ -0,0 +1,53 @@
+module Musicality
+
+def transpose notes, diff
+  notes.map {|n| n.transpose(diff) }
+end
+module_function :transpose
+
+def s(*pitch_groups)
+  pitch_groups.map {|pg| Note.sixteenth(pg) }
+end
+module_function :s
+
+def ds(*pitch_groups)
+  pitch_groups.map {|pg| Note.dotted_sixteenth(pg) }
+end
+module_function :ds
+
+def e(*pitch_groups)
+  pitch_groups.map {|pg| Note.eighth(pg) }
+end
+module_function :e
+
+def de(*pitch_groups)
+  pitch_groups.map {|pg| Note.dotted_eighth(pg) }
+end
+module_function :e
+
+def q(*pitch_groups)
+  pitch_groups.map {|pg| Note.quarter(pg) }
+end
+module_function :q
+
+def dq(*pitch_groups)
+  pitch_groups.map {|pg| Note.dotted_quarter(pg) }
+end
+module_function :dq
+
+def h(*pitch_groups)
+  pitch_groups.map {|pg| Note.half(pg) }
+end
+module_function :h
+
+def dh(*pitch_groups)
+  pitch_groups.map {|pg| Note.dotted_half(pg) }
+end
+module_function :dh
+
+def w(*pitch_groups)
+  pitch_groups.map {|pg| Note.whole(pg) }
+end
+module_function :w
+
+end

data/lib/musicality/composition/dsl/score_dsl.rb

@@ -1,24 +1,21 @@
 module Musicality
 
-class ScoreDSL
+class ScoreDSL  
   def self.load fname
     dsl = ScoreDSL.new
     dsl.instance_eval(File.read(fname), fname)
     dsl
   end
 
+  attr_reader :score
   def initialize
     @score = nil
   end
 
-  def score start_meter, start_tempo, &block
+  def measured_score start_meter, start_tempo, &block
     @score = Score::Measured.new(start_meter,start_tempo)
     @score.instance_eval(&block)
   end
-
-  def score_yaml
-    @score.pack.to_yaml
-  end
 end
 
 end

data/lib/musicality/composition/{note_generation.rb → util/note_generation.rb}

@@ -28,19 +28,4 @@ def make_notes rhythm, pitch_groups
 end
 module_function :make_notes
 
-def e(pitch_groups)
-  pitch_groups.map {|pg| Note.eighth(pg) }
-end
-module_function :e
-
-def q(pitch_groups)
-  pitch_groups.map {|pg| Note.quarter(pg) }
-end
-module_function :q
-
-def dq(pitch_groups)
-  pitch_groups.map {|pg| Note.dotted_quarter(pg) }
-end
-module_function :dq
-
 end

data/lib/musicality/notation/model/note.rb

@@ -103,7 +103,7 @@ class Note
   
   {
     :sixteenth => Rational(1,16),
-    :dotted_SIXTEENTH => Rational(3,32),
+    :dotted_sixteenth => Rational(3,32),
     :eighth => Rational(1,8),
     :dotted_eighth => Rational(3,16),
     :quarter => Rational(1,4),

data/lib/musicality/notation/model/score.rb

@@ -3,7 +3,8 @@ module Musicality
 class Score
   include Validatable
   attr_accessor :parts, :program
-
+  attr_writer :title, :composer
+  
   def title value = nil
     if value.nil?
       return @title

data/lib/musicality/printing/lilypond/score_engraver.rb

@@ -44,7 +44,7 @@ class ScoreEngraver
       output += "    \\time #{@start_meter.to_lilypond}\n"
     end
 
-    line = ""
+    line = "    "
     part.notes.each_index do |i|
       note = part.notes[i]
       begin
@@ -54,12 +54,12 @@ class ScoreEngraver
       end
 
       if (line.size + str.size) > MAX_LINE_LEN
-        output += "    " + line
-        line = ""
+        output += line + "\n"
+        line = "    "
       end
       line += str
     end
-    output += "    " + line
+    output += line + "\n"
 
     output += "  }\n"
   end

data/lib/musicality/printing/lilypond/score_engraving.rb

@@ -0,0 +1,12 @@
+module Musicality
+
+class Score
+  class TempoBased < Score
+    # See ScoreEngraver#make_lilypond for details on supported keyword args
+    def to_lilypond **kwargs
+      ScoreEngraver.new(self).make_lilypond(**kwargs)
+    end
+  end
+end
+
+end

data/lib/musicality/version.rb

@@ -1,3 +1,3 @@
 module Musicality
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/spec/composition/convenience_methods_spec.rb

@@ -0,0 +1,60 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe 'transpose' do
+  it 'should map given notes to new notes, transposing by given diff' do
+    notes = "/4A2,C2 /4D2,F2,Gb2 /8 /8E4".to_notes
+    semitones = 3
+    notes2 = transpose(notes,semitones)
+    
+    notes2.size.should eq(notes.size)
+    notes2.each_index do |i|
+      notes2[i].pitches.each_with_index do |pitch2,j|
+        pitch = notes[i].pitches[j]
+        pitch2.diff(pitch).should eq(semitones)
+      end
+    end
+  end
+end
+
+{
+  :s => "1/16".to_r,
+  :ds => "3/32".to_r,
+  :e => "1/8".to_r,
+  :de => "3/16".to_r,
+  :q => "1/4".to_r,
+  :dq => "3/8".to_r,
+  :h => "1/2".to_r,
+  :dh => "3/4".to_r,
+  :w => '1'.to_r
+}.each do |method,dur|
+  describe method do
+    context 'given no args' do
+      it 'should produce an empty array' do
+        send(method).should eq([])
+      end
+    end
+
+    context 'given one pitch' do
+      it 'should produce an array with one note, with proper duration' do
+        send(method,*[C2]).should eq([Note.new(dur,C2)])
+      end
+    end
+
+    context 'given one pitch group' do
+      it 'should produce an array with one note, given pitch group, and with proper duration' do
+        send(method,*[[C2,E2,G2]]).should eq([Note.new(dur,[C2,E2,G2])])
+      end
+    end
+
+    context 'given many pitch groups' do
+      it 'should produce an array of notes with same pitch groups, and with proper duration' do
+        pg1 = A3
+        pg2 = [B3,G3]
+        pg3 = F4
+        send(method,*[pg1,pg2,pg3]).should eq([
+          Note.new(dur,pg1), Note.new(dur,pg2), Note.new(dur,pg3)
+        ])
+      end
+    end
+  end
+end

data/spec/composition/{note_generation_spec.rb → util/note_generation_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe 'make_note' do
   it 'should return a Note' do

data/spec/notation/model/note_spec.rb

@@ -48,7 +48,7 @@ describe Note do
   
   {
     :sixteenth => Rational(1,16),
-    :dotted_SIXTEENTH => Rational(3,32),
+    :dotted_sixteenth => Rational(3,32),
     :eighth => Rational(1,8),
     :dotted_eighth => Rational(3,16),
     :quarter => Rational(1,4),

data/spec/notation/model/score_spec.rb

@@ -1,6 +1,38 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Score do
+  describe '#title' do
+    context 'given no arg' do
+      it 'should return the title' do
+        Score.new(:title => "MyTitle").title.should eq("MyTitle")
+      end
+    end
+
+    context 'given an arg' do
+      it 'should assign the given value to title' do
+        score = Score.new(:title => "MyTitle")
+        score.title("A Better Title")
+        score.title.should eq("A Better Title")
+      end
+    end
+  end
+
+  describe '#composer' do
+    context 'given no arg' do
+      it 'should return the composer' do
+        Score.new(:composer => "Beethoven").composer.should eq("Beethoven")
+      end
+    end
+
+    context 'given an arg' do
+      it 'should assign the given value to composer' do
+        score = Score.new(:composer => "Beethoven")
+        score.composer("Mozart")
+        score.composer.should eq("Mozart")
+      end
+    end
+  end
+
   describe '#collated?' do
     context 'has program with more than one segment' do
       it 'should return false' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: musicality
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - James Tunnell
@@ -116,6 +116,7 @@ description: "The library is based around an abstract representation for music n
 email:
 - jamestunnell@gmail.com
 executables:
+- lilify
 - midify
 extensions: []
 extra_rdoc_files: []
@@ -128,6 +129,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/lilify
 - bin/midify
 - examples/composition/auto_counterpoint.rb
 - examples/composition/part_generator.rb
@@ -137,6 +139,7 @@ files:
 - examples/notation/song1.rb
 - examples/notation/song2.rb
 - lib/musicality.rb
+- lib/musicality/composition/convenience_methods.rb
 - lib/musicality/composition/dsl/score_dsl.rb
 - lib/musicality/composition/dsl/score_methods.rb
 - lib/musicality/composition/generation/counterpoint_generator.rb
@@ -146,11 +149,10 @@ files:
 - lib/musicality/composition/model/scale.rb
 - lib/musicality/composition/model/scale_class.rb
 - lib/musicality/composition/model/scale_classes.rb
-- lib/musicality/composition/note_generation.rb
-- lib/musicality/composition/transposition.rb
 - lib/musicality/composition/util/adding_sequence.rb
 - lib/musicality/composition/util/biinfinite_sequence.rb
 - lib/musicality/composition/util/compound_sequence.rb
+- lib/musicality/composition/util/note_generation.rb
 - lib/musicality/composition/util/probabilities.rb
 - lib/musicality/composition/util/random_sampler.rb
 - lib/musicality/composition/util/repeating_sequence.rb
@@ -233,18 +235,19 @@ files:
 - lib/musicality/printing/lilypond/part_engraver.rb
 - lib/musicality/printing/lilypond/pitch_engraving.rb
 - lib/musicality/printing/lilypond/score_engraver.rb
+- lib/musicality/printing/lilypond/score_engraving.rb
 - lib/musicality/validatable.rb
 - lib/musicality/version.rb
 - musicality.gemspec
+- spec/composition/convenience_methods_spec.rb
 - spec/composition/generation/random_rhythm_generator_spec.rb
 - spec/composition/model/pitch_class_spec.rb
 - spec/composition/model/pitch_classes_spec.rb
 - spec/composition/model/scale_class_spec.rb
 - spec/composition/model/scale_spec.rb
-- spec/composition/note_generation_spec.rb
-- spec/composition/transposition_spec.rb
 - spec/composition/util/adding_sequence_spec.rb
 - spec/composition/util/compound_sequence_spec.rb
+- spec/composition/util/note_generation_spec.rb
 - spec/composition/util/probabilities_spec.rb
 - spec/composition/util/random_sampler_spec.rb
 - spec/composition/util/repeating_sequence_spec.rb
@@ -323,15 +326,15 @@ signing_key:
 specification_version: 4
 summary: Music notation, composition, and performance
 test_files:
+- spec/composition/convenience_methods_spec.rb
 - spec/composition/generation/random_rhythm_generator_spec.rb
 - spec/composition/model/pitch_class_spec.rb
 - spec/composition/model/pitch_classes_spec.rb
 - spec/composition/model/scale_class_spec.rb
 - spec/composition/model/scale_spec.rb
-- spec/composition/note_generation_spec.rb
-- spec/composition/transposition_spec.rb
 - spec/composition/util/adding_sequence_spec.rb
 - spec/composition/util/compound_sequence_spec.rb
+- spec/composition/util/note_generation_spec.rb
 - spec/composition/util/probabilities_spec.rb
 - spec/composition/util/random_sampler_spec.rb
 - spec/composition/util/repeating_sequence_spec.rb

data/lib/musicality/composition/transposition.rb

@@ -1,8 +0,0 @@
-module Musicality
-
-def transpose notes, diff
-  notes.map {|n| n.transpose(diff) }
-end
-module_function :transpose
-
-end

data/spec/composition/transposition_spec.rb

@@ -1,17 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-
-describe 'transpose' do
-  it 'should map given notes to new notes, transposing by given diff' do
-    notes = "/4A2,C2 /4D2,F2,Gb2 /8 /8E4".to_notes
-    semitones = 3
-    notes2 = transpose(notes,semitones)
-    
-    notes2.size.should eq(notes.size)
-    notes2.each_index do |i|
-      notes2[i].pitches.each_with_index do |pitch2,j|
-        pitch = notes[i].pitches[j]
-        pitch2.diff(pitch).should eq(semitones)
-      end
-    end
-  end
-end