sfzer 0.4

data/History.txt

@@ -0,0 +1,39 @@
+=== 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).
+  * 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.
+  
+* 3 Fixes:
+
+  * Corrected @padding bug: @padding now only applies to the edge samples.
+  * Fixed file separator bug that created incompatible SFZ files when run from unix shells (Test added).
+  * Added non-intrusive path declarations to the sfzer executable and the project Rakefile for maximum compatibility.
+
+
+=== 0.3.0 / 2008-03-09
+
+* 2 Features:
+
+  * Added @padding to extend the edges of keycentered Multisample regions.
+  * Supports relative paths to samples (so all SFZ files can be generated in the same, top-level directory.
+
+
+=== 0.2.0 / 2008-02-18
+
+* 3 Features:
+
+  * xfade support.
+  * Introduced cli option handling.
+  * Introduced script exit codes. 
+
+* 1 Fix:
+  * Corrected note/octave mapping: c1 up through b1 == octave 1 (Test added).
+
+
+=== 0.1.0 / 2008-02-16
+
+* First working version.

data/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+Manifest.txt
+README.txt
+COPYING
+Rakefile
+bin/sfzer
+lib/sfzer.rb
+lib/DirectoryProcessor.rb
+lib/Sample.rb
+lib/NamedSample.rb
+lib/Multisample.rb
+test/test_sfzer.rb
+test/NamedSampleTest.rb
+test/MultisampleTest.rb

data/README.txt

@@ -0,0 +1,67 @@
+= SFZer
+
+* http://sfzer.rubyforge.org
+* http://christessmer.com
+
+== DESCRIPTION:
+
+SFZer recursively scans through directories of Multisamples (.wav, .aiff, .ogg,
+etc) and automagically generates SFZ soundfonts from what it finds.
+
+
+=== Related Projects:
+* The *SFZ* format: http://www.cakewalk.com/DevXchange/sfz.asp
+* The *makesfz.pl* perl scripts , by Peter L. Jones: http://www.drealm.info/sfz/
+
+
+== FEATURES/PROBLEMS:
+
+* Quickly converts entire directory trees 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
+* loop_mode=one-shot option for percussion
+
+=== Ideas without much substance yet:
+* Option to force SFZv1 and SFZv2 output (nothing requires this yet)
+* Default effect/ CC controller options 
+* (possibly) 2-n pass (as opposed to 1-pass) processing?
+
+
+
+== SYNOPSIS:
+
+  % sfzer [options] directorie(s)
+
+
+== REQUIREMENTS:
+
+* Ruby
+
+
+== INSTALL:
+
+* sudo gem install sfzer
+
+
+== LICENSE:
+
+(The GPL License, version 3)
+
+Copyright (c) 2008 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
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+
+# Add lib/ and test/ to the load paths
+$: << "./lib"
+$: << "./test"
+
+require 'rubygems'
+require 'hoe'
+require './lib/sfzer.rb'
+
+
+Hoe.new('sfzer', SFZer::VERSION) do |p|
+  # p.rubyforge_name = 'sfzerx' # if different than lowercase project name
+   p.developer('Chris Tessmer', 'http://christessmer.com')
+   p.remote_rdoc_dir = '' # Release to root
+end
+
+# vim: syntax=Ruby

data/bin/sfzer

@@ -0,0 +1,13 @@
+#!/usr/bin/ruby
+#
+# SFZer, by Chris Tessmer ( http://christessmer.com )
+#
+
+#--
+# Ensure that the classpath loads regardless of environment
+$: << File.dirname(__FILE__) + '/../lib/'
+#++
+
+require 'sfzer.rb'
+s = SFZer.new
+s.do( ARGV )

data/lib/DirectoryProcessor.rb

@@ -0,0 +1,174 @@
+# 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/>.
+
+
+# Processes one or more directories
+#
+# * Scan for Multisamples 
+#   * 
+#
+# TODO: Refactor this into an application class
+class DirectoryProcessor
+
+	attr_accessor :dirs, :message, :mapping, :generate_in_top_dir
+
+  # Instantiate the DirectoryProcessor
+	def initialize
+		# root directories to look for samples under
+		@dirs = []
+    
+    # optional message to place in the header of each SFZ file
+		@message = false
+    
+    # keymapping setting, set to a Multisample contant.  
+    # The currently supported values are:
+    # * Multisample::XFADE (default )
+    # * Multisample::STRICTKEYS
+		@mapping = Multisample::XFADE
+    
+    # If true (which is the default), all SFZ files are generated in the
+    # directory the script was called from.
+		@generate_in_top_dir = true
+	end
+
+  
+  # starting from directory, 
+  def process_multisample_dir( path, top_path )
+  	named_hash = {}
+  	numbered_hash = Hash.new
+    
+  	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
+
+  			#add Sample to a hashed Multisample
+			  multi = get_multisample( file_hashkey, path, named_hash )
+				multi.add( NamedSample.new( file_basename ) )
+				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
+
+			# 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
+        
+        # create a name based on subfolders to ensure uniqueness
+				extra_name = relative_path.gsub( /\\/, "_" ).gsub( /\//, "_" ) + "_"
+        extra_name.gsub!(/^(\.|_)*/, '')
+			end
+
+
+			f = File.new( "#{extra_name}#{key}.sfz", "w" )
+			f.puts named_hash[ key ].to_sfz
+			f.close
+
+
+  	end
+  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?
+
+    		Dir.foreach( dir ){ |file|
+          
+    			current_dir = dir + File::SEPARATOR + file
+    			if File.stat( current_dir ).directory? and file !~ /^\./
+    				puts "pushing \"#{current_dir}\""
+    				@dirs.push( current_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
+
+
+  # Returns the Multisample for the given hashkey.
+  # If no Multisample exists under that hashkey, a new Multisample is created.
+	def get_multisample( file_hashkey, path, named_hash )
+				multi = false 
+				if named_hash.has_key?( file_hashkey )
+  				multi = named_hash[ file_hashkey ]
+  			else
+					multi = Multisample.new( path, file_hashkey )
+					multi.mapping = @mapping
+					multi.message = @message if( @message )
+				end
+				multi
+	end
+end

data/lib/Multisample.rb

@@ -0,0 +1,320 @@
+# 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/>.
+
+
+
+# A Multisample is a collection of related Samples that can form an intrument.
+class Multisample
+	# Region-mapping constants
+	
+		# auto-xfade (usually best)
+		XFADE = 0 
+   
+		# 1:1 key map (usually worst)   
+		STRICTKEYS = 1           
+
+	# Keycurve constants
+	
+		# Gain keycurve
+		KEYCURVE_GAIN = 3  
+   
+		# Power keycurve
+		KEYCURVE_POWER = 4 
+		
+		# Maximum number of columns in SFZ comments before a line wrap
+		LINE_LIMIT = 80
+
+	attr_accessor :message, :mapping, :default_path
+
+
+
+	# instantiate the Multisample
+	def initialize( path, name=false )
+		#TODO: Raise Exception if path not valid
+		@path=path
+		@samples=Array.new
+		@name = "Unnamed Multisample"
+		if name 
+			@name=name.chomp.gsub(/^\s*/, '').gsub(/\s*$/, '')
+		end
+		@mapping  = XFADE	
+		@message  = false	  # SFZ header message
+		@padding  = 12   	  # padding in semitones
+		
+		# include a default path?
+		@default_path = false 
+	end
+
+
+
+	# add a Sample to the Multisample
+	def add( sample )
+		@samples.push( sample )
+		@samples.sort!
+	end
+
+
+
+	# Sreturn a String representation of the Multisample
+	def to_s
+		"Multisample \"#{@name}\" [#{@samples.size}]: " + @samples.sort.to_s
+	end
+
+
+
+	# Returns a string of SFZ elements
+	def to_sfz
+		result = sfz_banner
+
+		if @default_path
+			sanitized_path = sanitize_file_path( @path )
+			result = result + "\n<control>\ndefault_path=#{sanitized_path}\\\n\n"
+		end
+
+		maxfilenamesize = max_sample_filename_size
+
+		#result = result + "// Keyboard/Sample mappings:\n"
+		@samples.each_index{ |i|
+			sample=@samples[i]
+			prev_sample = get_previous_sample( i )
+			next_sample = get_next_sample( i )
+			result = result + "<region> sample=" +  sanitize_file_path( sample.sample.ljust( maxfilenamesize + 1 ) )
+      
+			if @mapping == XFADE
+				result = result + get_xfade( sample, prev_sample, next_sample )
+     		elsif @mapping == STRICTKEYS
+		  		result = result + "key=#{sample.value} "
+			end
+
+			# *****************************************
+			# TODO: PLACE FUTURE  PER-SAMPLE LOGIC HERE
+			# *****************************************
+
+			 result = result + "\n"
+		}
+
+		result 
+	end
+
+
+
+	# Sanitizes file path separators.
+	#
+	# Whilst every path separator within Ruby must be "/" (Unix), evey path
+	# separator within SFZ must be "\" (DOS).
+	def sanitize_file_path( f )
+		f.gsub( File::SEPARATOR, "\\" )
+	end
+
+
+
+	# 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
+		xfout_hi = false
+		lokey = false
+		hikey = false
+
+		# calculate xfade ins from previous sample
+		if prev_sample and ( prev_sample.value < (sample.value-1) )
+			mid     = ( sample.value + prev_sample.value ) / 2
+			diff    = sample.value - mid
+			xfin_lo = mid - (diff/2)
+			xfin_hi = mid + (diff/2)
+			lokey   = xfin_lo
+		elsif prev_sample and ( sample.value - prev_sample.value == 1 )
+			lokey = sample.value
+		else
+			lokey = sample.value - @padding
+		end
+
+		#calculate xfade outs into next sample
+		if next_sample and ( next_sample.value > (sample.value+1) )
+			mid      = ( sample.value + next_sample.value ) / 2
+			diff     = sample.value - mid
+			xfout_hi = mid - (diff/2)
+			xfout_lo = mid + (diff/2)
+			hikey    = xfout_hi
+		elsif next_sample and ( next_sample.value - sample.value == 1 )
+			hikey = sample.value
+		else
+			hikey = sample.value + @padding
+		end
+
+    # depending on the distance between lokey and hikey, apply xfades
+    
+    
+    if lokey == hikey  and lokey == sample.value
+			result = "key=#{sample.value}"
+		else
+      
+			if lokey 
+				result = result + "lokey=#{lokey} "
+				if xfin_lo and xfin_hi
+					result = result + "xfin_lokey=#{xfin_lo} xfin_hikey=#{xfin_hi} "
+				end
+			end
+			
+			if hikey 
+				if xfout_lo and xfout_hi
+					result = result + "xfout_lokey=#{xfout_lo} xfout_hikey=#{xfout_hi} "
+				end
+				result = result + "hikey=#{hikey} "
+			end
+		end
+
+		# add xf_keycurve, if applicable
+		if keycurve == KEYCURVE_GAIN
+			result = result + "xf_keycurve=gain"
+		elsif keycurve == KEYCURVE_POWER
+			result = result + "xf_keycurve=power"
+		end
+
+		result
+	end
+
+
+
+	# returns true if a filename can be understood as a multisample element 
+	def Multisample.multisample_filename?( name )
+		types = Sample.suffix_regexp
+
+		# test for A(#)1.wav type
+		#return true if name =~ /^.*([ABGCDEFG](#)?\d).*\.#{types}$/i
+		return true 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
+		false
+	end
+
+
+
+	# returns true if the directory contains files that might be multisamples
+	def Multisample.dir_contains_multisamples?( dir )
+		result = false
+		Dir.foreach( dir ) do |file|
+			if Multisample.multisample_filename?( file )
+				result = true
+				break
+			end
+		end
+		result
+	end
+
+
+
+	protected
+
+	# returns the maximum filename length of all Samples within the Multisample
+	def max_sample_filename_size
+		# Find the maximum length of sample filenames
+		# NOTE: this seems inefficient
+		maxfilenamesize = 0
+		@samples.each{ |sample|
+			if sample.sample.size > maxfilenamesize
+				maxfilenamesize = sample.sample.size
+			end	
+		}
+		maxfilenamesize
+	end
+
+
+
+	# Returns the previous Sample in the Multisample (relative to a given Sample)
+	def get_previous_sample( i )
+			prev_sample=false
+			if i>0 and (not @samples[ i-1 ].nil?) 
+				prev_sample = @samples[ i-1 ]
+			end
+			prev_sample
+	end
+
+
+
+	# Returns the next Sample in the Multisample (relative to a given Sample)
+	def get_next_sample( i )
+			next_sample=false
+			if not @samples[ i+1 ].nil? 
+				next_sample = @samples[ i+1 ]
+			end
+			next_sample
+	end
+
+
+	public 
+	
+	# Returns the Multisample's SFZ header as a string.
+	def sfz_banner
+		separator = "//----------------------------------------------------------------------------"
+		result = ""
+
+
+		if @name
+			result = result + "//\n"
+			result = result + "// "+ "*** SFZ Intrument: #{@name} ***".center(76) + "\n"
+			result = result + "//\n"
+		end
+
+		# add optional message to SFZ header
+		if @message and @message.chomp.size > 0
+			result = result + separator + "\n"
+			result = result + sfz_banner_message( @message )
+
+		end
+
+		# add generator message to SFZ header
+		result = result + separator + "\n"
+		result = result + "// Generated on #{Time.now.strftime("%Y/%m/%d %I:%M%p") } "
+		result = result + "by #{SFZer::NAME} v#{SFZer::VERSION} (#{SFZer::URL})\n"
+		result = result + "#{separator}\n"
+	result	
+	end
+	
+	# Returns a formatted message formatted to the SFZ
+	def sfz_banner_message( fulltext )
+		limit = 76
+		result = ""
+		result = result + "//\n"
+		
+		fulltext.each_line{ |text|
+			while text.length > limit
+				subtext = text.slice( 0 .. ( limit - 1 ) )
+				text = text.slice( limit .. text.length )
+
+				# don't cut off words; break at spaces
+				i = subtext.rindex( ' ' )
+				if i > ( limit / 2 )
+					nub = subtext.slice( i+1, subtext.length )
+					subtext = subtext.slice( 0..i )
+					text = nub + text
+				end
+
+				result = result + "// " + subtext.center( limit ) + "\n"
+			end
+
+			result = result + "// " + text.center( limit ) + "\n" 
+		}
+		result = result + "//\n"	
+		
+		result
+	end
+end