niki 0.1.1 → 0.2.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    niki (0.1.0)
+    niki (0.2.1)
       unimidi
 
 GEM

data/Readme.md

@@ -47,8 +47,103 @@ Now you should install the gem and run the example!
     $ gem install niki
     $ ruby my_song.rb
 
-# TODO
+## Syntax reference
+
+A Niki Song is represented this way:
+
+    song = Niki::Song.new do
+
+      # +instrument+ lets you configure different instruments in different
+      # MIDI channels.
+      instrument :piano do
+        channel 3
+      end
+
+      instrument :drums do
+        channel 10
+
+        # You can define macros for notes:
+        note[:kick]  = c1 # Define a macro for the c1 note, name it :kick
+        note[:snare] = d1 # And the snare will be d1
+        note[:hh]    = e1 # And the hh will be e1
+      end
+
+      # You can define reusable riffs that you will be able to play with
+      # different instruments:
+      riff :simple_break do
+        note g3, 8
+        note f3, 8
+        note e3, 8
+        note d3, 8
+      end
+
+      # Define your song parts like this:
+      part :intro do
+        # Notes are defined like this:
+        #   +instrument+ +note or [array of notes]+, +duration+, +options+
+        #
+        # +instrument+
+        #   Instrument must be one of those you defined above.
+        #
+        # +note or [array of notes]+
+        #   Has to be a musical note like c3 or f2 or a chord like a3MAJ. It
+        #   can also be an array of notes. Examples of valid musical notes:
+        #
+        #   c2                  - a C in the 2nd octave
+        #   f4                  - an F in the 4th octave
+        #   +f4                 - an F sharp in the 4th octave
+        #   -d3                 - a D flat in the 3rd octave
+        #   f3MAJ               - a F major chord in the 3rd octave
+        #   -d3MIN              - a D flat minor chord in the 3rd octave
+        #   [c3, -e3, g3, -b3]  - a C min 7th chord in the 3rd octave
+        #   :kick               - whatever note you defined in your instrument
+        #
+        # +duration+
+        #   Duration can be expressed as a number representing a fraction.
+        #   For example, a quarter note (4 of them fit in a single
+        #   measure) is expressed with the number 4. An eighth note (8 of them
+        #   fit in a single measure) is expressed with 8, and so on.
+        #
+        # +options+
+        #   Options is an optional hash where you can specify the following
+        #   per-note settings:
+        #
+        #   :velocity => (a number between 0 and 127)
+        #   :base     => (a base note to add to some chord for example)
+        #
+        drums [:kick, :hh], 8
+        drums :hh, 8
+        drums :hh, 8
+
+        piano f2MAJ, 4
+        piano f2MAJ, 4
+        piano f2MAJ, 4
+        piano f2MAJ, 4
+        piano a2MIN, 4, :base => f2
+        piano silence, 4
+
+        # Play the previously defined riff with the piano.
+        riff :simple_break, :piano
+      end
+
+      # You can repeat any part!
+      repeat :intro
+
+      part :chorus do
+        drums :from => :intro # Use the drums from the intro
+
+        piano c2MAJ, 4
+        piano c2MAJ, 4
+        piano c2MAJ, 4
+        piano c2MAJ, 4
+        piano g2MAJ, 4
+        piano silence, 4
+        piano g2MAJ, 4
+        piano g2MAJ, 8
+        piano g2MAJ, 8
+      end
+    end
+
+    # Play the song!!!
+    song.play
 
-* Tests + refactor
-* Documentation
-* Expand this README

data/examples/my_song.rb

@@ -19,9 +19,42 @@ song = Niki::Song.new :tempo => 127 do
     channel 10
 
     note[:kick]  = c1
-    note[:snare] = c1.sharp
+    note[:snare] = +c1
     note[:hh]    = g1
-    note[:ohh]   = g1.sharp
+    note[:ohh]   = +g1
+  end
+
+  # Define reusable riffs with this snippet
+  riff :simple_notes do
+    note f2, 4
+
+    note f2, 8
+    note e2, 8
+    note f2, 8
+    note e2, 8
+    note f2, 8
+
+    note e3, 4
+    note c3, 4
+    note b2, 8
+    note c2, 8
+    note c2, 8
+    note g2, 4
+
+    note a2, 4
+
+    note a2, 8
+    note g2, 8
+    note a2, 8
+    note g2, 8
+    note a2, 8
+
+    note e3, 4
+    note c3, 4
+    note b2, 8
+    note c2, 8
+    note c2, 8
+    note g2, 4
   end
 
   part :intro do
@@ -38,7 +71,7 @@ song = Niki::Song.new :tempo => 127 do
       drums [:kick, :hh], 8
 
       drums :hh, 16
-      drums :hh, 16
+      drums silence, 16
       drums :hh, 16
       drums :hh, 16
       drums [:snare, :hh], 8
@@ -50,36 +83,8 @@ song = Niki::Song.new :tempo => 127 do
       drums :ohh, 8
     end
 
-    # Bass
-    bass f2, 4
-
-    bass f2, 8
-    bass e2, 8
-    bass f2, 8
-    bass e2, 8
-    bass f2, 8
-
-    bass e3, 4
-    bass c3, 4
-    bass b2, 8
-    bass c2, 8
-    bass c2, 8
-    bass g2, 4
-
-    bass a2, 4
-
-    bass a2, 8
-    bass g2, 8
-    bass a2, 8
-    bass g2, 8
-    bass a2, 8
-
-    bass e3, 4
-    bass c3, 4
-    bass b2, 8
-    bass c2, 8
-    bass c2, 8
-    bass g2, 4
+    # Play the simple notes riff with bass
+    riff :simple_notes, :bass
   end
 
   part :intro_ending do
@@ -116,46 +121,19 @@ song = Niki::Song.new :tempo => 127 do
     drums [:kick, :hh], 8
     drums :hh, 8
 
-    drums [:snare, :ooh], 4
-    drums [:snare, :ooh], 4
+    drums [:snare, :ohh], 4
+    drums [:snare, :ohh], 4
     drums :snare, 16
     drums :snare, 16
     drums :kick, 16
     drums :kick, 16
     drums :snare, 16
     drums :snare, 16
-    drums [:snare, :ooh], 16
+    drums [:snare, :ohh], 16
     drums :snare, 16
 
-    # Bass
-    bass f2, 4
-
-    bass f2, 8
-    bass e2, 8
-    bass f2, 8
-    bass e2, 8
-    bass f2, 8
-
-    bass e3, 4
-    bass c3, 4
-    bass b2, 8
-    bass c2, 8
-    bass c2, 8
-    bass g2, 4
-
-    bass a2, 4
-    bass a2, 4
-    bass a2, 4
-    bass a2, 4
-
-    bass b2, 8
-    bass b2, 8
-    bass b2, 8
-    bass c2, 8
-    bass c2, 8
-    bass c2, 8
-    bass d3, 8
-    bass e3, 8
+    # Play the simple notes riff with bass
+    riff :simple_notes, :bass
   end
 
   part :pre_chorus do
@@ -228,15 +206,15 @@ song = Niki::Song.new :tempo => 127 do
 
     # Drums
     7.times do
-      drums [:kick, :hh], 8
+      drums [:kick, :hh], 8, :velocity => 127
       drums :hh, 8
-      drums [:snare, :kick, :hh], 8
+      drums [:snare, :kick, :hh], 8, :velocity => 127
       drums :hh, 8
     end
-    drums :kick, 8
+    drums :kick, 8, :velocity => 127
     drums :hh, 16
     drums :hh, 16
-    drums [:snare, :kick], 16
+    drums [:snare, :kick], 16, :velocity => 127
     drums :snare, 16
     drums [:kick, :ohh], 8
 

data/lib/core_ext/array.rb

@@ -1,11 +1,11 @@
 class Array
-  def sharp
+  def +@
     map do |element|
       element + 1
     end
   end
 
-  def flat
+  def -@
     map do |element|
       element - 1
     end

data/lib/core_ext/fixnum.rb

@@ -1,8 +1,8 @@
 class Fixnum
-  def sharp
+  def +@
     self + 1
   end
-  def flat
+  def -@
     self - 1
   end
 end

data/lib/niki.rb

@@ -2,8 +2,114 @@ require 'core_ext/fixnum'
 require 'core_ext/array'
 require 'niki/chords'
 require 'niki/part'
+require 'niki/riff'
 require 'niki/song'
 require 'niki/instrument'
 
+# = Niki
+#
+# Niki is a Ruby DSL to describe and play musical pieces.
+#
+# == Syntax
+#
+# A Niki Song is represented this way:
+#
+#   song = Niki::Song.new do
+#
+#     # +instrument+ lets you configure different instruments in different
+#     # MIDI channels.
+#     instrument :piano do
+#       channel 3
+#     end
+#
+#     instrument :drums do
+#       channel 10
+#
+#       # You can define macros for notes:
+#       note[:kick]  = c1 # Define a macro for the c1 note, name it :kick
+#       note[:snare] = d1 # And the snare will be d1
+#       note[:hh]    = e1 # And the hh will be e1
+#     end
+#
+#     # You can define reusable riffs that you will be able to play with
+#     # different instruments:
+#     riff :simple_break do
+#       note g3, 8
+#       note f3, 8
+#       note e3, 8
+#       note d3, 8
+#     end
+#
+#     # Define your song parts like this:
+#     part :intro do
+#       # Notes are defined like this:
+#       #   +instrument+ +note or [array of notes]+, +duration+, +options+
+#       #
+#       # +instrument+
+#       #   Instrument must be one of those you defined above.
+#       #
+#       # +note or [array of notes]+
+#       #   Has to be a musical note like c3 or f2 or a chord like a3MAJ. It
+#       #   can also be an array of notes. Examples of valid musical notes:
+#       #
+#       #   c2                  - a C in the 2nd octave
+#       #   f4                  - an F in the 4th octave
+#       #   +f4                 - an F sharp in the 4th octave
+#       #   -d3                 - a D flat in the 3rd octave
+#       #   f3MAJ               - a F major chord in the 3rd octave
+#       #   -d3MIN              - a D flat minor chord in the 3rd octave
+#       #   [c3, -e3, g3, -b3]  - a C min 7th chord in the 3rd octave
+#       #   :kick               - whatever note you defined in your instrument
+#       #   silence             - a silent note
+#       #
+#       # +duration+
+#       #   Duration can be expressed as a number representing a fraction.
+#       #   For example, a quarter note (4 of them fit in a single
+#       #   measure) is expressed with the number 4. An eighth note (8 of them
+#       #   fit in a single measure) is expressed with 8, and so on.
+#       #
+#       # +options+
+#       #   Options is an optional hash where you can specify the following
+#       #   per-note settings:
+#       #
+#       #   :velocity => (a number between 0 and 127)
+#       #   :base     => (a base note to add to some chord for example)
+#       #
+#       drums [:kick, :hh], 8
+#       drums :hh, 8
+#       drums :hh, 8
+#
+#       piano f2MAJ, 4
+#       piano f2MAJ, 4
+#       piano f2MAJ, 4
+#       piano f2MAJ, 4
+#       piano a2MIN, 4, :base => f2
+#       piano silence, 4
+#
+#       # Play the previously defined riff with the piano.
+#       riff :simple_break, :piano
+#     end
+#
+#     # You can repeat any part!
+#     repeat :intro
+#
+#     part :chorus do
+#       drums :from => :intro # Use the drums from the intro
+#
+#       piano c2MAJ, 4
+#       piano c2MAJ, 4
+#       piano c2MAJ, 4
+#       piano c2MAJ, 4
+#       piano g2MAJ, 4
+#       piano silence, 4
+#       piano g2MAJ, 4
+#       piano g2MAJ, 8
+#       piano g2MAJ, 8
+#     end
+#   end
+#
+#   # Play the song!!!
+#   song.play
+#
 module Niki
 end

data/lib/niki/chords.rb

@@ -41,5 +41,9 @@ module Niki
 
     end
 
+    def silence
+      0
+    end
+
   end
 end

data/lib/niki/instrument.rb

@@ -33,23 +33,25 @@ module Niki
           duration = args.shift || 1
           options  = args.shift || {}
 
+          velocity = options[:v] || 100
+
           if note.is_a?(Hash) && note[:from]
             copy_from_part(note[:from], instrument_name)
             return
           end
 
           note = [note].flatten.map do |n|
-            if note.is_a?(Fixnum)
-              note
+            if n.is_a?(Fixnum)
+              n
             else
               # Try to fetch the note from the symbol
-              macros[note]
+              macros[n]
             end
           end
 
-          note.push options[:base]
+          note.push options[:base] if options[:base]
 
-          register_note(instrument_name, note, duration)
+          register_note(instrument_name, note, duration, velocity)
         end
       end
     end

data/lib/niki/part.rb

@@ -15,16 +15,23 @@ module Niki
       @notes[instrument_name] || []
     end
 
+    def riff(name, instrument_name, &blk)
+      riff = @song.get_riff(name)
+      riff.notes.each do |args|
+        send(instrument_name, *args)
+      end
+    end
+
     private
 
     def copy_from_part(name, type)
       part = @song.get_part(name)
-      @notes[type] = part.send(type)
+      @notes[type] = part.for_instrument(type)
     end
 
-    def register_note(instrument_name, note, duration)
+    def register_note(instrument_name, note, duration, velocity)
       @notes[instrument_name] ||= []
-      @notes[instrument_name] << [note, calculate_duration(duration)]
+      @notes[instrument_name] << [note, calculate_duration(duration), velocity]
     end
 
     def calculate_duration(duration)

data/lib/niki/riff.rb

@@ -0,0 +1,19 @@
+module Niki
+  class Riff
+    attr_reader :name, :notes
+
+    include Niki::Chords
+
+    def initialize(name, song, &block)
+      @name = name
+      @song = song
+
+      @notes = []
+      self.instance_exec(&block)
+    end
+
+    def note(*args)
+      @notes << args
+    end
+  end
+end

data/lib/niki/song.rb

@@ -13,6 +13,7 @@ module Niki
       @midi = UniMIDI::Output.first
       @parts = []
       @instruments = []
+      @riffs = []
       @channel = {}
       @tempo = options[:tempo]
       self.instance_eval &block
@@ -27,6 +28,10 @@ module Niki
       @instruments << Instrument.new(name, self, &block)
     end
 
+    def riff(name, &block)
+      @riffs << Riff.new(name, self, &block)
+    end
+
     def repeat(name, options = {})
       (options[:times] || 1).times do
         @parts << get_part(name)
@@ -52,14 +57,21 @@ module Niki
       channel = instrument.channel_number
 
       @midi.open do |out|
-        part.for_instrument(instrument.name).each do |notes, duration|
-          notes = [notes].flatten.compact
-          notes.each do |note|
-            out.puts NOTE_ON + channel, note, 100
+        last_note = nil
+        part.for_instrument(instrument.name).each do |notes, duration, velocity|
+          notes = [notes].flatten
+
+          notes.each_with_index do |note, i|
+            puts "#{instrument.name}\t\t\t#{part.name}\t\t\t#{note.inspect}\n"
+            if note == 0 # Silence
+              out.puts NOTE_OFF + channel, last_note, velocity
+            end
+            out.puts NOTE_ON + channel, note, velocity
+            last_note = note
           end
           sleep(duration)
           notes.each do |note|
-            out.puts NOTE_OFF + channel, note, 100
+            out.puts NOTE_OFF + channel, note, velocity
           end
         end
       end
@@ -69,6 +81,10 @@ module Niki
       @parts.detect {|p| p.name == name }
     end
 
+    def get_riff(name)
+      @riffs.detect {|p| p.name == name }
+    end
+
     private
 
     def has_part?(name)

data/lib/niki/version.rb

@@ -1,3 +1,3 @@
 module Niki
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,39 +1,35 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: niki
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.1
   prerelease: 
-  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Josep M. Bach
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-16 00:00:00 +02:00
+date: 2011-08-19 00:00:00.000000000 +02:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: unimidi
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2151940860 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *2151940860
 description: A DSL to describe and play structured musical pieces, i.e. songs
-email: 
+email:
 - josep.m.bach@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
@@ -47,36 +43,39 @@ files:
 - lib/niki/chords.rb
 - lib/niki/instrument.rb
 - lib/niki/part.rb
+- lib/niki/riff.rb
 - lib/niki/song.rb
 - lib/niki/version.rb
 - niki.gemspec
 has_rdoc: true
 homepage: http://github.com/txus/niki
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1761596756674548010
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1761596756674548010
 requirements: []
-
 rubyforge_project: niki
-rubygems_version: 1.6.1
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A DSL to describe and play structured musical pieces, i.e. songs
 test_files: []
-