midiator 0.1.0

data/lib/midiator/drums.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+#
+# A module that you can include to get access to constants representing known
+# drum note numbers.
+#
+# == Authors
+#
+# * Ben Bleything <ben@bleything.net>
+#
+# == Copyright
+#
+# Copyright (c) 2008 Ben Bleything
+#
+# This code released under the terms of the MIT license.
+#
+
+module MIDIator::Drums # this file does not rdoc well, so uhh.... :nodoc:
+
+	##########################################################################
+	### G E N E R A L   M I D I   D R U M   N O T E S
+	##########################################################################
+	BassDrum1     = 36  ;;;  LongGuiro     = 74  ;;;  OpenHiHat     = 46
+	BassDrum2     = 35  ;;;  LongWhistle   = 72  ;;;  OpenHighConga = 63
+	Cabasa        = 69  ;;;  LowAgogo      = 68  ;;;  OpenTriangle  = 81
+	ChineseCymbal = 52  ;;;  LowBongo      = 61  ;;;  PedalHiHat    = 44
+	Claves        = 75  ;;;  LowConga      = 64  ;;;  RideBell      = 53
+	ClosedHiHat   = 42  ;;;  LowTimbale    = 66  ;;;  RideCymbal1   = 51
+	Cowbell       = 56  ;;;  LowTom1       = 43  ;;;  RideCymbal2   = 59
+	CrashCymbal1  = 49  ;;;  LowTom2       = 41  ;;;  ShortGuiro    = 73
+	CrashCymbal2  = 57  ;;;  LowWoodBlock  = 77  ;;;  ShortWhistle  = 71
+	HandClap      = 39  ;;;  Maracas       = 70  ;;;  SideStick     = 37
+	HighAgogo     = 67  ;;;  MidTom1       = 47  ;;;  SnareDrum1    = 38
+	HighBongo     = 60  ;;;  MidTom2       = 45  ;;;  SnareDrum2    = 40
+	HighTimbale   = 65  ;;;  MuteCuica     = 78  ;;;  SplashCymbal  = 55
+	HighTom1      = 50  ;;;  MuteHighConga = 62  ;;;  Tambourine    = 54
+	HighTom2      = 48  ;;;  MuteTriangle  = 80  ;;;  VibraSlap     = 58
+	HighWoodBlock = 76  ;;;  OpenCuica     = 79
+
+end

data/lib/midiator/exceptions.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+#
+# A collection of exceptions used by MIDIator.
+#
+# == Authors
+#
+# * Ben Bleything <ben@bleything.net>
+#
+# == Copyright
+#
+# Copyright (c) 2008 Ben Bleything
+#
+# This code released under the terms of the MIT license.
+#
+
+### Raised when the selected driver is unable to find any available MIDI
+### destinations.
+class MIDIator::NoMIDIDestinations < RuntimeError ; end

data/lib/midiator/interface.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+#
+# The main entry point into MIDIator.  Create a MIDIator::Interface object and
+# off you go.
+#
+# == Authors
+#
+# * Ben Bleything <ben@bleything.net>
+#
+# == Copyright
+#
+# Copyright (c) 2008 Ben Bleything
+#
+# This code released under the terms of the MIT license.
+#
+
+require 'midiator'
+
+class MIDIator::Interface
+	attr_reader :driver
+
+	### Automatically select a driver to use
+	def autodetect_driver
+		self.use( :winmm     ) if RUBY_PLATFORM.include? 'win32'
+		self.use( :core_midi ) if RUBY_PLATFORM.include? 'darwin'
+		self.use( :alsa      ) if RUBY_PLATFORM.include? 'linux'
+	end
+
+
+	### Attempts to load the MIDI system driver called +driver_name+.
+	def use( driver_name )
+		driver_path = "midiator/drivers/#{driver_name.to_s}"
+
+		begin
+			require driver_path
+		rescue LoadError => e
+			raise LoadError,
+				"Could not load driver '#{driver_name}'."
+		end
+
+		# Fix two side-effects of the camelization process... first, change
+		# instances of Midi to MIDI.  This fixes the acronym form but doesn't
+		# change, for instance, 'timidity'.
+		#
+		# Second, the require path is midiator/drivers/foo, but the module
+		# name is Driver singular, so fix that.
+		driver_class = driver_path.camelize.
+			gsub( /Midi/, 'MIDI' ).
+			sub( /::Drivers::/, '::Driver::')
+
+		# special case for the ALSA driver
+		driver_class.sub!( /Alsa/, 'ALSA' )
+
+		# special case for the WinMM driver
+		driver_class.sub!( /Winmm/, 'WinMM' )
+
+		# this little trick stolen from ActiveSupport.  It looks for a top-
+		# level module with the given name.
+		@driver = Object.module_eval( "::#{driver_class}" ).new
+	end
+
+
+	### A little shortcut method for playing the given +note+ for the specified
+	### +duration+.
+	def play( note, duration = 0.1, channel = 0, velocity = 100 )
+		@driver.note_on( note, channel, velocity )
+		sleep duration
+		@driver.note_off( note, channel, velocity )
+	end
+
+
+	### Does nothing for +duration+ seconds.
+	def rest( duration = 0.1 )
+		sleep duration
+	end
+
+	#######
+	private
+	#######
+
+	### Checks to see if the currently-loaded driver knows how to do +method+ and
+	### passes the message on if so.  Raises an exception (as normal) if not.
+	def method_missing( method, *args )
+		raise NoMethodError, "Neither MIDIator::Interface nor #{@driver.class} " +
+			"has a '#{method}' method." unless @driver.respond_to? method
+
+		return @driver.send( method, *args )
+	end
+
+end

data/lib/midiator/notes.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+#
+# A module that you can include to get access to constants representing the
+# available MIDI note space.
+#
+# == Authors
+#
+# * Ben Bleything <ben@bleything.net>
+#
+# == Copyright
+#
+# Copyright (c) 2008 Ben Bleything
+#
+# This code released under the terms of the MIT license.
+#
+
+module MIDIator::Notes # this file does not rdoc well, so uhh.... :nodoc:
+
+	##########################################################################
+	### O C T A V E   - 1 ;;; O C T A V E    0    ;;; O C T A V E   1
+	##########################################################################
+	Cn1  = 0  ; Bsn1 = 0  ;;; C0  = 12 ; Bs0 = 12 ;;; C1  = 24 ; Bs1 = 24
+	Csn1 = 1  ; Dbn1 = 1  ;;; Cs0 = 13 ; Db0 = 13 ;;; Cs1 = 25 ; Db1 = 25
+	Dn1  = 2  ;           ;;; D0  = 14 ;          ;;; D1  = 26 ;
+	Dsn1 = 3  ; Ebn1 = 3  ;;; Ds0 = 15 ; Eb0 = 15 ;;; Ds1 = 27 ; Eb1 = 27
+	En1  = 4  ; Fbn1 = 4  ;;; E0  = 16 ; Fb0 = 16 ;;; E1  = 28 ; Fb1 = 28
+	Fn1  = 5  ;           ;;; F0  = 17 ;          ;;; F1  = 29 ;
+	Fsn1 = 6  ; Gbn1 = 6  ;;; Fs0 = 18 ; Gb0 = 18 ;;; Fs1 = 30 ; Gb1 = 30
+	Gn1  = 7  ;           ;;; G0  = 19 ;          ;;; G1  = 31 ;
+	Gsn1 = 8  ; Abn1 = 8  ;;; Gs0 = 20 ; Ab0 = 20 ;;; Gs1 = 32 ; Ab1 = 32
+	An1  = 9  ;           ;;; A0  = 21 ;          ;;; A1  = 33 ;
+	Asn1 = 10 ; Bbn1 = 10 ;;; As0 = 22 ; Bb0 = 22 ;;; As1 = 34 ; Bb1 = 34
+	Bn1  = 11 ; Cb0  = 11 ;;; B0  = 23 ; Cb1 = 23 ;;; B1  = 35 ; Cb2 = 35
+
+	##########################################################################
+	### O C T A V E   2 ;;; O C T A V E    3    ;;; O C T A V E   4
+	##########################################################################
+	C2  = 36 ; Bs2 = 36 ;;; C3  = 48 ; Bs3 = 48 ;;; C4  = 60 ; Bs4 = 60
+	Cs2 = 37 ; Db2 = 37 ;;; Cs3 = 49 ; Db3 = 49 ;;; Cs4 = 61 ; Db4 = 61
+	D2  = 38 ;          ;;; D3  = 50 ;          ;;; D4  = 62 ;
+	Ds2 = 39 ; Eb2 = 39 ;;; Ds3 = 51 ; Eb3 = 51 ;;; Ds4 = 63 ; Eb4 = 63
+	E2  = 40 ; Fb2 = 40 ;;; E3  = 52 ; Fb3 = 52 ;;; E4  = 64 ; Fb4 = 64
+	F2  = 41 ;          ;;; F3  = 53 ;          ;;; F4  = 65 ;
+	Fs2 = 42 ; Gb2 = 42 ;;; Fs3 = 54 ; Gb3 = 54 ;;; Fs4 = 66 ; Gb4 = 66
+	G2  = 43 ;          ;;; G3  = 55 ;          ;;; G4  = 67 ;
+	Gs2 = 44 ; Ab2 = 44 ;;; Gs3 = 56 ; Ab3 = 56 ;;; Gs4 = 68 ; Ab4 = 68
+	A2  = 45 ;          ;;; A3  = 57 ;          ;;; A4  = 69 ;
+	As2 = 46 ; Bb2 = 46 ;;; As3 = 58 ; Bb3 = 58 ;;; As4 = 70 ; Bb4 = 70
+	B2  = 47 ; Cb3 = 47 ;;; B3  = 59 ; Cb4 = 59 ;;; B4  = 71 ; Cb5 = 71
+
+	##########################################################################
+	### O C T A V E   5 ;;; O C T A V E    6    ;;; O C T A V E   7
+	##########################################################################
+	C5  = 72 ; Bs5 = 72 ;;; C6  = 84 ; Bs6 = 84 ;;; C7  = 96  ; Bs7 = 96
+	Cs5 = 73 ; Db5 = 73 ;;; Cs6 = 85 ; Db6 = 85 ;;; Cs7 = 97  ; Db7 = 97
+	D5  = 74 ;          ;;; D6  = 86 ;          ;;; D7  = 98  ;
+	Ds5 = 75 ; Eb5 = 75 ;;; Ds6 = 87 ; Eb6 = 87 ;;; Ds7 = 99  ; Eb7 = 99
+	E5  = 76 ; Fb5 = 76 ;;; E6  = 88 ; Fb6 = 88 ;;; E7  = 100 ; Fb7 = 100
+	F5  = 77 ;          ;;; F6  = 89 ;          ;;; F7  = 101 ;
+	Fs5 = 78 ; Gb5 = 78 ;;; Fs6 = 90 ; Gb6 = 90 ;;; Fs7 = 102 ; Gb7 = 102
+	G5  = 79 ;          ;;; G6  = 91 ;          ;;; G7  = 103 ;
+	Gs5 = 80 ; Ab5 = 80 ;;; Gs6 = 92 ; Ab6 = 92 ;;; Gs7 = 104 ; Ab7 = 104
+	A5  = 81 ;          ;;; A6  = 93 ;          ;;; A7  = 105 ;
+	As5 = 82 ; Bb5 = 82 ;;; As6 = 94 ; Bb6 = 94 ;;; As7 = 106 ; Bb7 = 106
+	B5  = 83 ; Cb6 = 83 ;;; B6  = 95 ; Cb7 = 95 ;;; B7  = 107 ; Cb8 = 107
+
+	##########################################################################
+	### O C T A V E   8   ;;; O C T A V E    9
+	##########################################################################
+	C8  = 108 ; Bs8 = 108 ;;; C9  = 120 ; Bs9 = 120
+	Cs8 = 109 ; Db8 = 109 ;;; Cs9 = 121 ; Db9 = 121
+	D8  = 110 ;           ;;; D9  = 122 ;
+	Ds8 = 111 ; Eb8 = 111 ;;; Ds9 = 123 ; Eb9 = 123
+	E8  = 112 ; Fb8 = 112 ;;; E9  = 124 ; Fb9 = 124
+	F8  = 113 ;           ;;; F9  = 125 ;
+	Fs8 = 114 ; Gb8 = 114 ;;; Fs9 = 126 ; Gb9 = 126
+	G8  = 115 ;           ;;; G9  = 127 ;
+	Gs8 = 116 ; Ab8 = 116
+	A8  = 117 ;
+	As8 = 118 ; Bb8 = 118
+	B8  = 119 ; Cb9 = 119
+
+	# these notes are not valid MIDI notes but they're here to complete the
+	# octave.  Use at your own risk?
+	Gs9 = 128 ; Ab9 = 128
+	A9  = 129 ;
+	As9 = 130 ; Bb9 = 130
+	B9  = 131 ; Cb10 = 131
+
+	# Shortcuts!
+	MiddleC = 84
+
+end

data/lib/midiator/timer.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+#
+# A timer that allows you to schedule notes to be played in the future.
+#
+# == Authors
+#
+# * Topher Cyll
+# * Ben Bleything <ben@bleything.net>
+#
+# == Copyright
+#
+# Copyright (c) 2008 Ben Bleything
+#
+# This code released under the terms of the MIT license.
+#
+
+class MIDIator::Timer
+	attr_reader :resolution, :queue, :thread
+
+	### Create a new Timer object that ticks every +resolution+ seconds.
+	def initialize( resolution )
+		@resolution = resolution
+		@queue = []
+
+		@thread = Thread.new do
+			loop do
+				dispatch
+				sleep @resolution
+			end
+		end
+	end
+
+
+	### Empty the queue
+	def flush
+		@queue.clear
+	end
+
+
+	### Add a new job to be performed at +time+.
+	def at( time, &block )
+		time = time.to_f if time.kind_of? Time
+		@queue.push [ time, block ]
+	end
+
+	#######
+	private
+	#######
+
+	### Check to see if there is work to perform in this timeslice and
+	### do it if so.
+	def dispatch
+		now = Time.now.to_f
+
+		# move "ready" work out of the queue
+		ready, @queue = @queue.partition {|time, proc| time <= now }
+
+		# call all of the "ready" jobs, passing in the time
+		ready.each {|time, proc| proc.call( time ) }
+	end
+
+end

data/lib/string_extensions.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+#
+# Some extensions to the built-in Ruby String class.
+#
+# == Authors
+#
+# * Ben Bleything <ben@bleything.net>
+# * Various others as noted in the code
+#
+# == Copyright
+#
+# Copyright (c) 2008 Ben Bleything, except where noted.
+#
+# This code released under the terms of the MIT license.
+#
+
+class String
+	### NOTE: Stolen from ActiveSupport.  They hold the copyright.  Our
+	### modifications are making it a method on String and removing the
+	### lowerCamelCase option since we don't use it.
+	###
+	### +camelize+ converts strings to CamelCase.
+	###
+	### +camelize+ will also convert '/' to '::' which is useful for converting
+	### paths to namespaces.
+	###
+	### Examples
+	###   "active_record".camelize #=> "ActiveRecord"
+	###   "active_record/errors".camelize #=> "ActiveRecord::Errors"
+	def camelize
+		return self.gsub( /\/(.?)/ ) {
+			"::" + $1.upcase
+		}.
+		gsub( /(^|_)(.)/ ) {
+			$2.upcase
+		}
+	end
+
+	### NOTE: Stolen from ActiveSupport.  They hold the copyright.  The only
+	### modifications were to make it a String instance method instead of a
+	### function.
+	###
+	### The reverse of +camelize+. Makes an underscored form from the expression
+	### in the string.
+	###
+	### Changes '::' to '/' to convert namespaces to paths.
+	###
+	### Examples
+	###   "ActiveRecord".underscore #=> "active_record"
+	###   "ActiveRecord::Errors".underscore #=> active_record/errors
+	def underscore
+		return self.gsub( /::/, '/' ).
+		gsub( /([A-Z]+)([A-Z][a-z])/, '\1_\2' ).
+		gsub( /([a-z\d])([A-Z])/    , '\1_\2' ).
+		tr( "-", "_" ).
+		downcase
+	end
+
+end

data/misc/rake/packaging.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+#
+# Rake tasks related to packaging.
+#
+# == Authors
+#
+# * Ben Bleything <ben@bleything.net>
+#
+# == Copyright
+#
+# Copyright (c) 2008 Ben Bleything
+#
+# This code released under the terms of the MIT license.
+#
+
+require 'midiator'
+
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+
+### Task: gem
+gemspec = Gem::Specification.new do |gem|
+	gem.name    	= "midiator"
+	gem.version 	= MIDIator::VERSION
+
+	gem.summary     = "MIDIator - A a nice Ruby interface to your system's MIDI services."
+	gem.description = "MIDIator provides an OS-agnostic way to send live MIDI messages to " +
+					  "your machine's MIDI playback system."
+
+	gem.authors  = "Ben Bleything"
+	gem.email    = "ben@bleything.net"
+	gem.homepage = "http://projects.bleything.net/projects/show/midiator"
+
+	gem.rubyforge_project = 'midiator'
+
+	gem.has_rdoc = true
+
+	gem.files      	= RELEASE_FILES.
+		collect {|f| f.relative_path_from(BASE_DIR).to_s }
+	gem.test_files 	= SPEC_FILES.
+		collect {|f| f.relative_path_from(BASE_DIR).to_s }
+end
+
+Rake::GemPackageTask.new( gemspec ) do |task|
+	task.gem_spec = gemspec
+	task.need_tar = false
+	task.need_tar_gz = true
+	task.need_tar_bz2 = true
+	task.need_zip = true
+end

data/misc/rake/rdoc.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+#
+# Rake tasks for generating rdoc
+#
+# == Authors
+#
+# * Ben Bleything <ben@bleything.net>
+#
+# == Copyright
+#
+# Copyright (c) 2008 Ben Bleything
+#
+# This code released under the terms of the MIT license.
+#
+
+require 'rake/rdoctask'
+
+# uncomment for darkfish!
+# gem 'darkfish-rdoc'
+# require 'darkfish-rdoc'
+
+# uncomment for hanna!
+gem 'mislav-hanna'
+require 'hanna'
+
+### Task: rdoc
+Rake::RDocTask.new do |rdoc|
+	rdoc.rdoc_dir = 'docs/rdoc'
+	rdoc.title    = "MIDIator - a nice Ruby interface to your system's MIDI services."
+
+	rdoc.options += [
+		'-w', '4',
+		'-SHNa',
+		'-i', BASE_DIR.to_s,
+		# '-f', 'darkfish', # uncomment for darkfish!
+		'-T', 'hanna',    # uncomment for hanna!
+		'-m', 'README',
+		'-W', 'http://projects.bleything.net/repositories/changes/midiator/',
+	  ]
+
+	rdoc.rdoc_files.include 'README'
+	rdoc.rdoc_files.include 'LICENSE'
+	rdoc.rdoc_files.include 'LICENSE.prp'
+	rdoc.rdoc_files.include LIB_FILES.collect {|f| f.relative_path_from(BASE_DIR).to_s }
+end