sfzer 0.4 → 0.5.0

data/History.txt

@@ -1,8 +1,33 @@
+=== 0.5 / 2009-02-17
+* 3 Features:
+
+  * Added --padding flag to pad the ends of multisamples (default: 12).
+  * Added --transpose N flag to transpose sample values by N semitones.
+    (for fog: -t-12)
+  * Added rudimentary unique filename support.
+
+* 1 Improvement:
+
+  * Smarter detection: It takes at least three regions to make a Multisample.
+  
+* 5 Fixes:
+
+  * Fixed a bug that prevented recursion below any directory with Multisamples.
+  * Corrected bug that would cause a crash on Multisamples with no names (test 
+    added).
+  * Corrected bug that allowed "-" and "_" at the end of Multisample names 
+    (test added).
+  * Corrected bug that did not recognize lowercase note names (test added).
+  * Removed premature numeric note detection, as numeric notes are currently not
+    supported.
+
+
 === 0.4.0 / 2009-02-08
 
 * 4 Improvements:
 
-  * Smarter Multisample.get_xfade method: xfade in/outs are only calculated when needed (i.e., for gaps between Samples that are over a semitone).
+  * Smarter Multisample.get_xfade method: xfade in/outs are only calculated when 
+    needed (i.e., for gaps between Samples that are over a semitone).
   * Introduced a better system for unique filenames when using the --top-dir option.
   * Text entered via --message now wraps every 80 lines.
   * Upgraded license to GPLv3.

data/Manifest.txt

@@ -1,5 +1,6 @@
 History.txt
 Manifest.txt
+Notes.txt
 README.txt
 COPYING
 Rakefile
@@ -12,3 +13,4 @@ lib/Multisample.rb
 test/test_sfzer.rb
 test/NamedSampleTest.rb
 test/MultisampleTest.rb
+test/DirectoryProcessorTest.rb

data/Notes.txt

@@ -0,0 +1,35 @@
+= Notes 
+
+== SFZ Client Errata
+=== Dimension Pro
+When reading SFZ, Dimension Pro in Windows cannot load samples referenced by
+absolute path:
+
+====  SFZ snippet:
+  <control>
+  default_path=C:\snd\samples\prog_bass
+  <region> sample=ProgK1Bass E0.wav pitch_keycenter=16
+  <region> sample=ProgK1Bass G0.wav pitch_keycenter=19
+  
+==== Dimension Pro 1.2 sfzlog.txt error snippet: 
+  c:\dev\sfzer\trunk\c:\snd\samples\prog_bass\progk1bass e0.wav not found or couldn't be loaded.
+  c:\dev\sfzer\trunk\c:\snd\samples\prog_bass\progk1bass g0.wav not found or couldn't be loaded.
+
+
+
+
+=== Rapture 
+Rapture in Windows has the opposite problem from Dimension.  It can load via 
+absolute paths  (the Dimension Pro snippet above will pass without 
+a murmur), but it wont't load samples referenced by relative paths:
+
+==== SFZ snippet:
+  <control>
+  default_path=..\..\..\snd\samples\prog_bass
+  <region> sample=ProgK1Bass E0.wav pitch_keycenter=16
+  <region> sample=ProgK1Bass G0.wav pitch_keycenter=19
+  
+==== Rapture 1.1 sfzlog.txt error snippet:  
+  File c:\dev\sfzer\trunk\\snd\samples\prog_bass\progk1bass e0.wav not found or couldn't be loaded.
+  File c:\dev\sfzer\trunk\\snd\samples\prog_bass\progk1bass g0.wav not found or couldn't be loaded.
+  

data/README.txt

@@ -1,8 +1,10 @@
 = SFZer
 
 * http://sfzer.rubyforge.org
+* http://rubyforge.org/projects/sfzer/
 * http://christessmer.com
 
+
 == DESCRIPTION:
 
 SFZer recursively scans through directories of Multisamples (.wav, .aiff, .ogg,
@@ -16,13 +18,15 @@ etc) and automagically generates SFZ soundfonts from what it finds.
 
 == FEATURES/PROBLEMS:
 
-* Quickly converts entire directory trees of named samples into SFZ instruments.
+* Quickly converts entire directories of named samples into SFZ instruments.
 * Creates quick keyboard mapping from sample file names.
 * Automatically computes xfades between adjacent samples over a semitone apart.
 
 ===  Future Plans:
-* Future Music Sample name format
-* Numeric Notes
+* Numeric Notes (some filenames use the numeric instead of chromatic key value) 
+* Future Music sample name format (sample order number + chromatic value)
+* Specify multisamples to include or exclude by name or pattern.
+* Specify minimum number of regions/samples in a multisample.
 * loop_mode=one-shot option for percussion
 
 === Ideas without much substance yet:
@@ -31,7 +35,6 @@ etc) and automagically generates SFZ soundfonts from what it finds.
 * (possibly) 2-n pass (as opposed to 1-pass) processing?
 
 
-
 == SYNOPSIS:
 
   % sfzer [options] directorie(s)
@@ -44,14 +47,14 @@ etc) and automagically generates SFZ soundfonts from what it finds.
 
 == INSTALL:
 
-* sudo gem install sfzer
+  % sudo gem install sfzer
 
 
 == LICENSE:
 
 (The GPL License, version 3)
 
-Copyright (c) 2008 Chris Tessmer
+Copyright (c) 2008, 2009 Chris Tessmer
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

data/bin/sfzer

@@ -6,6 +6,7 @@
 #--
 # Ensure that the classpath loads regardless of environment
 $: << File.dirname(__FILE__) + '/../lib/'
+puts $:
 #++
 
 require 'sfzer.rb'

data/lib/DirectoryProcessor.rb

@@ -14,6 +14,7 @@
 # along with SFZer.  If not, see <http://www.gnu.org/licenses/>.
 
 
+
 # Processes one or more directories
 #
 # * Scan for Multisamples 
@@ -22,7 +23,8 @@
 # TODO: Refactor this into an application class
 class DirectoryProcessor
 
-	attr_accessor :dirs, :message, :mapping, :generate_in_top_dir
+	attr_accessor :dirs, :message, :mapping, :generate_in_top_dir,
+								:transpose, :padding
 
   # Instantiate the DirectoryProcessor
 	def initialize
@@ -41,38 +43,50 @@ class DirectoryProcessor
     # If true (which is the default), all SFZ files are generated in the
     # directory the script was called from.
 		@generate_in_top_dir = true
+		
+		@transpose = 0
+		@padding = 12
 	end
-
   
+	
+	
+  # Scan each directory for multisamples
+  def scan_dirs  	  
+		multidirs = get_multisample_directories
+		
+		# convert each multisample directory
+		pwd = Dir.getwd
+	    if multidirs.size > 0
+	    	
+	  	  puts "converting..."
+	    	for dir in multidirs
+					Dir.chdir( pwd )
+	  	  	process_multisample_dir( dir, pwd )
+	    	end
+	    	
+			else
+				raise NoMultisamplesInDirectoryException			
+	    end
+  end
+  
+  	
+	
   # starting from directory, 
   def process_multisample_dir( path, top_path )
   	named_hash = {}
-  	numbered_hash = Hash.new
+  	#numbered_hash = Hash.new
     
-  	puts
+  	puts 
 
   	Dir.chdir( path )
   	Dir.glob( "*#{Sample.suffix_glob}" ).each{ |file|
 
   		# Start tracking potential instrument names
   		if NamedSample.sample?( file )
+
   			# Sanitize hashkeys
   			file_basename =  File.basename( file )
-        
-  			# FIXME: Potential bug: this assumes the first portion of the string is the most 
-				# significant indicator
-  			(file_hashkey, ) = file_basename.gsub( /\.#{Sample.suffix_regexp}$/, '' ).sub( NamedSample.regexp, '?' ).split('?')
-
-
-  			# if there is no label for the multisample, name it after the directory it's in.
-  			if file_hashkey.nil? 
-  				file_hashkey = File.basename( path )
-  			else
-  			# otherwise, strip it of common paired symbols
-  				file_hashkey.sub!( /_\d\d(_)$/, '' )
-  				file_hashkey.sub!( /[(\[{_]$/, '' )
-  				file_hashkey.sub!( /\s*$/, '' )
-  			end
+				file_hashkey = sanitize_multisample_name( file_basename, path )
 
   			#add Sample to a hashed Multisample
 			  multi = get_multisample( file_hashkey, path, named_hash )
@@ -80,82 +94,123 @@ class DirectoryProcessor
 				named_hash[ file_hashkey ] = multi
   		end
   	}
-  	puts 
 
   	# for each hash entry, make an SFZ
   	for key in named_hash.keys.sort
-  		puts "#{key}: "  
-  		puts named_hash[ key ].to_sfz
-
+  		
+  		filename = key
 			# generate the SFZ file from the Multisample
+			
 			extra_name = ""	
 			if @generate_in_top_dir 
 				Dir.chdir( top_path )
 				relative_path = path.gsub( /^\\/, '' ).gsub( /^\//, '' )
 				named_hash[ key ].default_path = true
-        
+				
+        #filename = "#{top_path}/#{key}.sfz"
         # create a name based on subfolders to ensure uniqueness
 				extra_name = relative_path.gsub( /\\/, "_" ).gsub( /\//, "_" ) + "_"
-        extra_name.gsub!(/^(\.|_)*/, '')
+        extra_name.gsub!(/^(\.|-|_)+/, '')
+        
+        filename = "#{extra_name}#{filename}"
+        
+			end
+      filename = filename.gsub( ' ', '_')
+      filename = get_unique_filename( filename, path )
+            
+      puts "#{key}: #{filename}"
+      multi = named_hash[ key ]
+ 		  #puts multi.to_sfz
+    	if( multi.valid? )
+				f = File.new( filename, "w" )
+				f.puts multi.to_sfz
+				f.close
+			else
+				puts "NOT VALID\n\n\n"
 			end
 
+  	end
+  end
+
+
+  def get_unique_filename( name, path )
+		result = "#{name}.sfz"
+		count = 0
+		while( FileTest.exists?( result ) )
+			result = "#{name}-#{count}.sfz"
+			count = count + 1
+		end
+		result
+	end
+
 
-			f = File.new( "#{extra_name}#{key}.sfz", "w" )
-			f.puts named_hash[ key ].to_sfz
-			f.close
+	# Santizes a multisample 
+	#
+	#
+	#
+  def sanitize_multisample_name( string, path )
+		# puts "sanitizing '#{string}':"
 
+		# FIXME: Potential bug: this assumes the first portion of the string
+		# is the most significant indicator
+  	result = string.gsub( /\.#{Sample.suffix_regexp}$/, '' )
+		result = result.sub( NamedSample.regexp, '?' )
+		(result,) = result.split('?')
 
+		# sometimes, sample producers A
+  	if result.nil?
+  		result = File.basename( path )
   	end
+
+  	# otherwise, strip it of common paired symbols
+  	result.sub!( /_\d\d(_)$/, '' )  # _01 + .wav and _01_.wav
+  	result.sub!( /[(\[{_]$/, '' )   # blahblha( + A#1
+  	result.sub!( /[-_]+$/, '' )
+  	#result.sub!( /^[-_]+/, '' )
+  	result.sub!( /\s*$/, '' )
+		result
   end
 
 
-	# Scan each directory for multisamples
-  def scan_dirs
-    # tidy this junk up
-    multidirs = []
 
-    for dir in @dirs
-      if File.exists?( dir ) and File.stat( dir ).directory? \
-    	and Multisample.dir_contains_multisamples?( dir )
 
-    		puts "\"#{ dir }\" has multisamples!"
-    		multidirs.push( dir )
 
-      elsif File.exists?( dir ) and File.stat( dir ).directory?
+	protected
+	
+	def get_multisample_directories
+  # tidy this junk up
+    multidirs = []
 
-    		Dir.foreach( dir ){ |file|
-          
+		# push every directory w/multisamples onto the stack
+    for dir in @dirs
+    	puts "scanning \"#{dir}\""
+    	
+      if File.exists?( dir ) and File.stat( dir ).directory? 
+      	
+      	
+      #if File.exists?( dir ) and File.stat( dir ).directory?
+      
+    		Dir.foreach( dir ){ |file|      
+    			#puts "... #{file}"
     			current_dir = dir + File::SEPARATOR + file
     			if File.stat( current_dir ).directory? and file !~ /^\./
-    				puts "pushing \"#{current_dir}\""
+    				#puts "...scanning \"#{current_dir}\""
     				@dirs.push( current_dir )
-    			end
-    		}
-        
-    		puts "pushed \"#{ dir }\""
+    			end	   			
+    		}      
+
+				if Multisample.dir_contains_multisamples?( dir )
+    			puts "\"#{ dir }\" has multisamples!"
+    			multidirs.push( dir )
+  			end
+    		    		
+    	# => 	puts "pushed \"#{ dir }\""
     	else
     		puts "\"#{ dir }\" is unusable."
       end
     end
-
-		puts
-		pwd = Dir.getwd
-    if multidirs.size > 0
-  	  puts "converting..."
-    	for dir in multidirs
-				Dir.chdir( pwd )
-  	  	process_multisample_dir( dir, pwd )
-    	end
-		else
-			STDERR.print "ERROR: No multisample directories were found in the given "
-			STDERR.puts "arguments."
-      STDERR.puts	"Quitting."
-			exit SFZer::EXITSTATUS_NO_MULTISAMPLES_FOUND
-    end
-  end
-
-
-	protected
+    multidirs
+	end
 
 
   # Returns the Multisample for the given hashkey.
@@ -168,7 +223,20 @@ class DirectoryProcessor
 					multi = Multisample.new( path, file_hashkey )
 					multi.mapping = @mapping
 					multi.message = @message if( @message )
+					multi.transpose = @transpose
+					multi.padding =  @padding
 				end
 				multi
 	end
 end
+
+
+
+
+# Exception to be raised in the case that no Multisample directories
+# Have been found by DirectoryProcessor.
+class NoMultisamplesInDirectoryException < Exception
+	def message
+		"No multisample directories were found in the given directories."
+	end
+end

data/lib/Multisample.rb

@@ -36,7 +36,7 @@ class Multisample
 		# Maximum number of columns in SFZ comments before a line wrap
 		LINE_LIMIT = 80
 
-	attr_accessor :message, :mapping, :default_path
+	attr_accessor :message, :mapping, :default_path, :padding, :transpose
 
 
 
@@ -55,6 +55,9 @@ class Multisample
 		
 		# include a default path?
 		@default_path = false 
+		
+		# Number of semitones to shift the note on the keyboard
+		@transpose = 0
 	end
 
 
@@ -94,8 +97,8 @@ class Multisample
       
 			if @mapping == XFADE
 				result = result + get_xfade( sample, prev_sample, next_sample )
-     		elsif @mapping == STRICTKEYS
-		  		result = result + "key=#{sample.value} "
+     	elsif @mapping == STRICTKEYS
+		  		result = result + "key=#{ _transpose( sample.value )} "
 			end
 
 			# *****************************************
@@ -109,6 +112,15 @@ class Multisample
 	end
 
 
+	# Do the samples within the Multisample justify its existence?
+  def valid?
+  	values = {}
+  	@samples.each{ |s|
+  		values[s.value] = s
+		}
+		values.size >= 3
+	end
+
 
 	# Sanitizes file path separators.
 	#
@@ -123,7 +135,7 @@ class Multisample
 	# Returns SFZ opcodes to specify pitch_keycenter and xfade parameters for a 
 	# region.
 	def get_xfade( sample, prev_sample, next_sample, keycurve=false )
-		result = "pitch_keycenter=#{sample.value} "
+		
 		xfin_lo = false
 		xfin_hi = false
 		xfout_lo = false
@@ -152,16 +164,25 @@ class Multisample
 			xfout_lo = mid + (diff/2)
 			hikey    = xfout_hi
 		elsif next_sample and ( next_sample.value - sample.value == 1 )
-			hikey = sample.value
+			hikey = sample.value 
 		else
 			hikey = sample.value + @padding
 		end
 
     # depending on the distance between lokey and hikey, apply xfades
     
+    # Apply tranpose
+    value = _transpose( sample.value )
+    hikey = _transpose( hikey )
+    lokey = _transpose( lokey )
+    xfin_lokey = _transpose( xfin_lokey )  
+		xfin_hikey = _transpose( xfin_hikey )      
+    xfout_lokey = _transpose( xfout_lokey )  
+		xfout_hikey = _transpose( xfout_hikey )          
     
+    result = "pitch_keycenter=#{value} "
     if lokey == hikey  and lokey == sample.value
-			result = "key=#{sample.value}"
+			result = "key=#{value}"
 		else
       
 			if lokey 
@@ -177,6 +198,7 @@ class Multisample
 				end
 				result = result + "hikey=#{hikey} "
 			end
+
 		end
 
 		# add xf_keycurve, if applicable
@@ -190,19 +212,25 @@ class Multisample
 	end
 
 
+  def _transpose( note )
+  	if !note.nil? and note
+  		note = note + @transpose
+  	end
+  	note
+	end
+
 
 	# returns true if a filename can be understood as a multisample element 
 	def Multisample.multisample_filename?( name )
-		types = Sample.suffix_regexp
+		#types = Sample.suffix_regexp
 
 		# test for A(#)1.wav type
-		#return true if name =~ /^.*([ABGCDEFG](#)?\d).*\.#{types}$/i
-		return true if NamedSample.sample?( name )
+		return NamedSample.value( name ) if NamedSample.sample?( name )
 
 		# test for Sample (0)00.wav type
-		if name =~ /^.*((0|1)?\d\d)\.#{types}$/i
-			return true if (0..127).include?( $1.to_i )
-		end
+		#if name =~ /^.*((0|1)?\d\d)\.#{types}$/i
+		#	return true if (0..127).include?( $1.to_i )
+		#end
 		false
 	end
 
@@ -211,12 +239,19 @@ class Multisample
 	# returns true if the directory contains files that might be multisamples
 	def Multisample.dir_contains_multisamples?( dir )
 		result = false
+		values = {}
+		@min_samples_per_multisample = 3
+		
 		Dir.foreach( dir ) do |file|
-			if Multisample.multisample_filename?( file )
-				result = true
-				break
+			if v = Multisample.multisample_filename?( file )
+				values[v] = 1
+				if( values.size >= @min_samples_per_multisample  )
+					result = true
+					break
+				end
 			end
 		end
+
 		result
 	end
 

data/lib/NamedSample.rb

@@ -28,13 +28,14 @@ class NamedSample < Sample
 
 	# returns true if the String name is a NamedSample.
 	def NamedSample.sample?( name )
-		name =~ /^.*(#{regexp}).*\.#{Sample.suffix_regexp}$/i
+		name =~ /^.*(#{NamedSample.regexp})/ &&
+		 name =~ /.*\.#{Sample.suffix_regexp}$/i
 	end
 
 
 	# returns the RegExp used to test for a NamedSample.
 	def NamedSample.regexp
-		/[ABCDEFG](#)?\d/
+		/([A-Ga-g])(#)?(\d)/
 	end
 
 
@@ -42,8 +43,9 @@ class NamedSample < Sample
 	def NamedSample.value( string )
 		result = false
 
-		if( string =~ /([ABCDEFG])(#)?(\d)/i )
-			notes = { 'C'=>0, 'D'=>2, 'E'=>4, 'F'=>5, 'G'=>7, 'A'=>9, 'B'=>11}
+		if( string =~ regexp )
+			notes = { 'C'=>0, 'D'=>2, 'E'=>4, 'F'=>5, 'G'=>7, 'A'=>9, 'B'=>11,
+			          'c'=>0, 'd'=>2, 'e'=>4, 'f'=>5, 'g'=>7, 'a'=>9, 'b'=>11}
 			note = $1
 			sharp = 0 
 			if $2 == "#" then 

data/lib/Sample.rb

@@ -13,6 +13,7 @@
 # You should have received a copy of the GNU General Public License
 # along with SFZer.  If not, see <http://www.gnu.org/licenses/>.
 
+
 # An SFZ Sample is a file that represents a single note.
 class Sample
 	attr_reader :path, :sample
@@ -79,5 +80,5 @@ class Sample
 			"#{@sample}"
 		end
 	end	
-
+	
 end

data/lib/sfzer.rb

@@ -1,128 +1,157 @@
-# This file is part of SFZer.
-#
-# SFZer is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# SFZer is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with SFZer.  If not, see <http://www.gnu.org/licenses/>.
-
-
-# Program Requirements
-require 'optparse'
-
-require 'Sample'
-require 'NamedSample'
-require 'Multisample'
-require 'DirectoryProcessor'
-
-# Parses the command line options and sets the program into motion.
-class SFZer
-
-	# Version information
- 	VERSION = '0.4'
-	VERSION_DATE = "08 Feb 2009"
-	URL = "http://sfzer.rubyforge.org"
-	NAME = "SFZer"
-	SEPARATOR = "\\"
-	
-	#Exit codes	
-	EXITSTATUS_COMPLETE = 0
-	EXITSTATUS_NO_MULTISAMPLES_FOUND = 1
-	EXITSTATUS_ARG_ERROR = 2
-	EXITSTATUS_USER_ABORT = 3
-
-
-	# Execute the SFZer program
-	def do( argv )
-		sfzer = process_options( argv )
-		sfzer.scan_dirs
-	end
-
-
-	protected
-
-
-	# Processes each command line option and returns a configured Directory Processor.  
-	def process_options( argv )
-		sfzer = DirectoryProcessor.new
-		exit_now = false
-
-		begin
-			argv.options{ |opt|
-
-				# help message banner and usage instructions
-				opt.banner = "A script by Chris Tessmer that creates SFZ files from multisamples.\n"
-				opt.banner += "version #{SFZer::VERSION}, #{SFZer::VERSION_DATE}.\n"
-				opt.banner += "\n"
-				opt.banner += "Usage: sfzer.rb [options] directorie(s)\n"
-				opt.banner += "\n"
-
-				# defining options
-				opt.on( "Options:" )
-				opt.on( "\n" )
-				opt.on( "Mapping:" )
-				opt.on( "--xfade", "-x", "Map crossfades between region keycenters *" ) {
-					sfzer.mapping = Multisample::XFADE
-				}		
-
-				opt.on( "--strictkeys", "-s", "Map regions on a 1:1 key:sample basis" ) {
-					sfzer.mapping = Multisample::STRICTKEYS
-				}
-				
-
-				opt.on( "\n" )
-				opt.on( "File placement:" )
-				opt.on( "--top-dir", "-t", "Create SFZ files in topmost directory *" ){
-					sfzer.generate_in_top_dir = true
-				}
-
-				opt.on( "--each-dir", "-e", "Create each SFZ file with its own Samples"){
-					sfzer.generate_in_top_dir = false
-				}
-
-				opt.on( "\n" )
-				opt.on( "Decoration:" )
-				opt.on( "--message 'TEXT'", "-m", "Add TEXT to each generated SFZ file header" ) { 
-				|text|
-					sfzer.message = text
-				}			
-
-				opt.on( "--help", "-h", "This text" ) { 
-					puts opt
-					exit_now = true
-				}
-
-				opt.parse!
-
-				# Exit with help message if no arguments are given
-				if( argv.length == 0 )
-					puts opt
-					exit_now = true
-				end				
-			}
-		rescue Exception => e
-			STDERR.puts "\n#{e.class}"
-			STDERR.puts "\t#{e}\n"
-			STDERR.puts "Since this messed up the arguments, I am ABORTING THE PROGRAM.  Sorry.\n\n"
-			exit EXITSTATUS_ARG_ERROR
-		end
-
-		# Handle graceful exit (couldn't put in opt block because of rescue clause)
-		if exit_now
-			exit EXITSTATUS_COMPLETE
-		end
-
-		argv.each{ |arg|
-			sfzer.dirs.push( arg )
-		}
-			
-		sfzer	
-	end
-end
+# This file is part of SFZer.
+#
+# SFZer is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# SFZer is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with SFZer.  If not, see <http://www.gnu.org/licenses/>.
+
+
+# Program Requirements
+require 'optparse'
+
+require 'DirectoryProcessor'
+require 'Sample'
+require 'NamedSample'
+require 'Multisample'
+
+
+# Parses the command line options and sets the program into motion.
+class SFZer
+
+	# Version information
+ 	VERSION = '0.5.0'
+	VERSION_DATE = "17 Feb 2009"
+	URL = "http://sfzer.rubyforge.org"
+	NAME = "SFZer"
+	
+	# File separator for SFZ samples
+	SEPARATOR = "\\"
+	
+	#Exit codes	
+	EXITSTATUS_COMPLETE = 0
+	EXITSTATUS_NO_MULTISAMPLES_FOUND = 1
+	EXITSTATUS_ARG_ERROR = 2
+#	EXITSTATUS_USER_ABORT = 3
+	MAX_NOTE_SHIFT = 9 * 12
+
+	# Execute the SFZer program
+	def do( argv )
+		begin
+			sfzer = process_options( argv )
+			sfzer.scan_dirs
+		rescue NoMultisamplesInDirectoryException => e
+			STDERR.puts "ERROR: #{e.message}"
+			STDERR.puts "       Quitting."
+			exit SFZer::EXITSTATUS_NO_MULTISAMPLES_FOUND
+		end	
+	end
+
+
+	protected
+
+
+	# Processes each command line option and returns a configured Directory Processor.  
+	def process_options( argv )
+		sfzer = DirectoryProcessor.new
+		exit_now = false
+
+		begin
+			argv.options{ |opt|
+
+				# help message banner and usage instructions
+				opt.banner = "A script by Chris Tessmer that creates SFZ files from multisamples.\n"
+				opt.banner += "version #{SFZer::VERSION}, #{SFZer::VERSION_DATE}.\n"
+				opt.banner += "\n"
+				opt.banner += "Usage: sfzer.rb [options] directorie(s)\n"
+				opt.banner += "\n"
+
+				# defining options
+				opt.on( "Options:" )
+				opt.on( "\n" )
+				opt.on( "Mapping:" )
+				opt.on( "--xfade", "-x", "Map crossfades between region keycenters *" ){
+					sfzer.mapping = Multisample::XFADE
+				}
+
+				opt.on( "--strictkeys", "-s", "Map regions on a 1:1 key:sample basis" ){
+					sfzer.mapping = Multisample::STRICTKEYS
+				}
+				
+				opt.on(	"--transpose NOTES", "-t", Integer,
+								"Remaps regions on the keyboard by NOTES"){ |n|
+					
+					if n > MAX_NOTE_SHIFT or n < -MAX_NOTE_SHIFT 
+						raise ArgumentError, 
+						      "Cannot shift octaves by greater than #{MAX_NOTE_SHIFT}."
+					end
+					
+					sfzer.transpose = n
+				}
+				
+				opt.on( "--padding NOTES", "-p", Integer,
+							  "Pads the ends of each multisample by NOTES "){ |n|
+					if n < 0
+						raise ArgumentError, 
+						      "Cannot pad by a negative number}."
+					end							  
+					sfzer.padding = n
+				}
+				
+				opt.on( "" )
+				opt.on( "File placement:" )
+				opt.on( "--top-dir", "-d", "Create SFZ files in current directory *" ){
+					sfzer.generate_in_top_dir = true
+				}
+
+				opt.on( "--each-dir", "-e", "Create each SFZ file with its own Samples"){
+					sfzer.generate_in_top_dir = false
+				}
+
+				opt.on( "\n" )
+				opt.on( "Decoration:" )
+				opt.on( "--message 'TEXT'", "-m", 
+				"Add TEXT to each generated SFZ file header" ) { 
+				|text|
+					sfzer.message = text
+				}			
+
+				opt.on( "--help", "-h", "This text" ) { 
+					puts opt
+					exit_now = true
+				}
+
+				opt.parse!
+
+				# Exit with help message if no arguments are given
+				if( argv.length == 0 )
+					puts opt
+					exit_now = true
+				end				
+			}
+		rescue Exception => e
+			STDERR.puts "\n#{e.class}"
+			STDERR.puts "\t#{e}\n"
+			STDERR.puts "Since this messed up the arguments, I am ABORTING THE PROGRAM.  Sorry.\n\n"
+			exit EXITSTATUS_ARG_ERROR
+		end
+
+		# Handle graceful exit (couldn't put in opt block because of rescue clause)
+		if exit_now
+			exit EXITSTATUS_COMPLETE
+		end
+
+		argv.each{ |arg|
+			sfzer.dirs.push( arg )
+		}
+			
+		sfzer	
+	end
+end

data/test/DirectoryProcessorTest.rb

@@ -0,0 +1,27 @@
+class DirectoryProcessorTest <  Test::Unit::TestCase
+  def name
+	"DirectoryProcessorTest tests" 
+  end
+
+
+	def setup
+		@d = DirectoryProcessor.new
+	end
+
+	def test_for_hashkey_sanitization
+		names = [ ['MS_Cavern-C5.wav', 'path'],
+              ['A#4.ogg', 'C:\snd\Analog_Pad' ],
+              ['D#4.ogg', '/snd/Juno_Lead' ],
+              ['d#4.ogg', '/snd/Juno_Lead' ],
+						]
+
+		names.each{ |name|
+			path = name[1]
+			name = name[0]
+			key = @d.sanitize_multisample_name( name, path )
+			assert(  key !~ /[-_]$/  , 			 
+			"\"#{key}\" has a minus or underscore at the end.") 
+		}
+  end
+
+end

data/test/MultisampleTest.rb

@@ -52,25 +52,25 @@ class MultisampleTest < Test::Unit::TestCase
 
 
 
-	def test_simple_numeric_note_filenames
-		(0..127).each do |i|
-			# Note 001.wav 
-			n = sprintf "%03d", i
-			Sample.suffixes do |s|
-				note = "#{n}.#{s}"
-				assert(  Multisample.multisample_filename?( note ) , 
-				"\"#{note}\" is NOT a valid 3-digit numeric note name.") 
-			end
-
-			# Note 01.wav
-			n = sprintf "%02d", i
-			Sample.suffixes do |s|
-				note = "#{n}.#{s}"
-				assert(  Multisample.multisample_filename?( note ) , 
-				"\"#{note}\" is NOT a valid 2-to-3-digit numeric note name.") 
-			end
-		end
-	end	
+#	def test_simple_numeric_note_filenames
+#		(0..127).each do |i|
+#			# Note 001.wav 
+#			n = sprintf "%03d", i
+#			Sample.suffixes do |s|
+#				note = "#{n}.#{s}"
+#				assert(  Multisample.multisample_filename?( note ) , 
+#				"\"#{note}\" is NOT a valid 3-digit numeric note name.") 
+#			end
+#
+#			# Note 01.wav
+#			n = sprintf "%02d", i
+#			Sample.suffixes do |s|
+#				note = "#{n}.#{s}"
+#				assert(  Multisample.multisample_filename?( note ) , 
+#				"\"#{note}\" is NOT a valid 2-to-3-digit numeric note name.") 
+#			end
+#		end
+#	end	
 
 
 
@@ -78,8 +78,9 @@ class MultisampleTest < Test::Unit::TestCase
 		# Names of real files that should succeed
 		names = [ 'NRGK4ObBass F#1.wav', 
 						  'OBX-SoundTrk_03B2.wav', 
-						  'Bass06_C2.wav',  
+						  'Bass06_C2.wav',						  
 				]
+				
 		for name in names
 			assert( Multisample.multisample_filename?( name ), 
 			"\"#{name}\"is NOT a valid multisample filename" )
@@ -89,7 +90,7 @@ class MultisampleTest < Test::Unit::TestCase
 		#badnames = ['119F#001.wav']
 		#for name in badnames
 		#	assert( Multisample.multisample_filename?( name ) == false ,
-		#			"\"#{name}\" IS a valid multisample filename, but shouldn't be!" )
+		#		"\"#{name}\" IS a valid multisample filename, but shouldn't be!" )
 		#end
 	end
 	

data/test/NamedSampleTest.rb

@@ -6,7 +6,7 @@ class NamedSampleTest <  Test::Unit::TestCase
 	def test_for_named_samples_files
 		names = [
 			'Bassy01(C3).wav',
-			'D#2.wav',
+			'd#2.wav',
 			'Bass10_C1.wav'
 		]
 
@@ -14,6 +14,16 @@ class NamedSampleTest <  Test::Unit::TestCase
 		assert(  NamedSample.sample?( name ) , 
 			"\"#{name}\" is NOT a valid note name.") 
 		end
+		
+		badnames = [
+			'090C001.wav',
+		]
+		
+		#badnames.each do |name|
+		#assert(  !NamedSample.sample?( name ) , 
+		#	"\"#{name}\" IS a valid note name (value = #{NamedSample.value( name )}).") 
+		#end
+	
 	end
 
 
@@ -27,7 +37,7 @@ class NamedSampleTest <  Test::Unit::TestCase
 
 		sample_values.each do |sample, value|
 		assert_equal( value,  NamedSample.value( sample ), 
-			"The value of \"#{sample}\" is NOT \"#{value}\".") 
+			"The value of \"#{sample}\" did NOT evaluate to \"#{value}\".") 
 		end
 	end
 
@@ -52,4 +62,4 @@ class NamedSampleTest <  Test::Unit::TestCase
 		assert_operator c3, :==, c3o, "#{c3} = #{c3o}"
 	end
 
-end
+end

data/test/test_sfzer.rb

@@ -9,4 +9,5 @@ require 'test/unit'
 require 'sfzer'
 
 require 'NamedSampleTest'
+require 'DirectoryProcessorTest'
 require 'MultisampleTest'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sfzer
 version: !ruby/object:Gem::Version 
-  version: "0.4"
+  version: 0.5.0
 platform: ruby
 authors: 
 - Chris Tessmer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-11 00:00:00 +00:00
+date: 2009-02-17 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,10 +32,12 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
+- Notes.txt
 - README.txt
 files: 
 - History.txt
 - Manifest.txt
+- Notes.txt
 - README.txt
 - COPYING
 - Rakefile
@@ -48,6 +50,7 @@ files:
 - test/test_sfzer.rb
 - test/NamedSampleTest.rb
 - test/MultisampleTest.rb
+- test/DirectoryProcessorTest.rb
 has_rdoc: true
 homepage: http://sfzer.rubyforge.org
 post_install_message: