sfzer 0.4

data/lib/NamedSample.rb

@@ -0,0 +1,70 @@
+# 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 Sample with a note value (such as A1, C#4, F5, etc) in the filename.
+class NamedSample < Sample
+	include Comparable  # instant sortability; I love Mixins!
+
+	# Instantiate the NamedSample.
+	def initialize( sample, path=false )
+		super( sample, path )
+		@value = NamedSample.value( sample )
+	end
+
+
+	# returns true if the String name is a NamedSample.
+	def NamedSample.sample?( name )
+		name =~ /^.*(#{regexp}).*\.#{Sample.suffix_regexp}$/i
+	end
+
+
+	# returns the RegExp used to test for a NamedSample.
+	def NamedSample.regexp
+		/[ABCDEFG](#)?\d/
+	end
+
+
+	# returns the numeric value of a NamedSample
+	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}
+			note = $1
+			sharp = 0 
+			if $2 == "#" then 
+				sharp = 1
+			end
+			octave = $3.to_i
+			result = ((octave * 12) + 12) + notes[note] + sharp
+		end
+
+		result	
+	end	
+
+
+	# returns the numeric value of this instance of NamedSample
+	def value
+		@value
+	end
+
+
+	# required by the Comparable mixin; allows sorting
+	def <=>(anOther)  
+	  	value <=> anOther.value  
+	end  
+end

data/lib/Sample.rb

@@ -0,0 +1,83 @@
+# 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/>.
+
+# An SFZ Sample is a file that represents a single note.
+class Sample
+	attr_reader :path, :sample
+	# sample = full path to sample
+	def initialize( sample, path=false )
+		@sample = sample
+		@path = path
+	end
+
+	# ----------------------------------------------
+	# static methods 
+	# ----------------------------------------------
+	
+	# yields all the sample suffixes that SFZ supports
+	def Sample.suffixes
+		['wav', 'ogg', 'aif', 'aiff'].each	do |type|
+			yield type
+		end
+	end
+
+
+	# returns a regexp string for all possible sample suffixes
+	def Sample.suffix_regexp
+		# build filename suffix types
+		types = "("
+		Sample.suffixes do |s|
+			types = types + "#{s}|"
+		end	
+		types.chop!
+		types = types + ")"
+	end
+
+
+	# returns a Dir glob string for all possible sample suffixes
+	def Sample.suffix_glob
+		# build filename suffix types
+		types = "{"
+		Sample.suffixes do |s|
+			types = types + "#{s},"
+		end	
+		types.chop!
+		types = types + "}"
+	end
+
+	def Sample.sample?( name )
+		name =~ /*.#{Sample.suffix_regexp}$/i
+	end
+
+
+
+	def note
+		false
+	end
+
+
+	def value
+		false
+	end
+
+	def to_s
+		if @path
+			"#{@path}#{SFZer::SEPARATOR}#{@sample}"
+		else
+			"#{@sample}"
+		end
+	end	
+
+end

data/lib/sfzer.rb

@@ -0,0 +1,128 @@
+# 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

data/test/MultisampleTest.rb

@@ -0,0 +1,115 @@
+class MultisampleTest < Test::Unit::TestCase
+	# def setup
+	# end
+
+	# def teardown
+	# end
+
+	def name
+		"Multisample tests" 
+	end
+
+
+	# SFZ *REQUIRES* that path separators follow the DOS convention (i.e., lean forward)
+	def test_default_path_file_seperators_are_dos
+		test_paths = [
+			'test/path',
+			'./test/path/with/dot',
+			'../test/path/with/twodots',
+			'../test/path/with\\twodots'
+		]
+
+		test_paths.each{ |path|			
+			m = Multisample.new( path, "Default Path Test Multisample" )
+			m.default_path = path
+			sfz = m.to_sfz
+			line = /^(default_path=.*)$/.match( sfz )[1]
+			assert_no_match( /\//, line,	"\"#{line}\" does NOT contain only DOS path separators."   )
+		}
+	end
+
+
+
+
+	# Tests that A1.wav through G#8.wav are valid filenames
+	def test_simple_named_note_filenames
+		# construct notes
+		notes = Array.new
+		['A', 'B', 'C', 'D', 'E', 'F', 'G'].each do |a|
+			['1','2','3','4','5','6','7','8'].each do |n|
+				Sample.suffixes do |s|
+					notes.push "#{a}#{n}.#{s}"  # natural
+					notes.push "#{a}##{n}.#{s}" # sharp
+				end
+			end
+		end
+
+		notes.each do |note|
+		assert(  Multisample.multisample_filename?( note ) , 
+			"\"#{note}\" is NOT a valid named note name.") 
+		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	
+
+
+
+	def test_real_filenames
+		# Names of real files that should succeed
+		names = [ 'NRGK4ObBass F#1.wav', 
+						  'OBX-SoundTrk_03B2.wav', 
+						  'Bass06_C2.wav',  
+				]
+		for name in names
+			assert( Multisample.multisample_filename?( name ), 
+			"\"#{name}\"is NOT a valid multisample filename" )
+		end
+
+		#Names of real files that should fail
+		#badnames = ['119F#001.wav']
+		#for name in badnames
+		#	assert( Multisample.multisample_filename?( name ) == false ,
+		#			"\"#{name}\" IS a valid multisample filename, but shouldn't be!" )
+		#end
+	end
+	
+	
+	def test_banner_line_lengths
+		message = "(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/>." 
+		m = Multisample.new( "" )
+		m.message = message
+		max_line_length = 80
+		biggest_line_length_yet = 0
+   
+		s = m.sfz_banner
+		s.each_line{ |x|
+			if x.length > biggest_line_length_yet
+				biggest_line_length_yet = x.length
+			end
+		}
+   
+		assert_operator biggest_line_length_yet, :<=, max_line_length , "SFZ banner lines exceed #{max_line_length} characters per line:\n\n#{s}"
+	end
+end
+
+

data/test/NamedSampleTest.rb

@@ -0,0 +1,55 @@
+class NamedSampleTest <  Test::Unit::TestCase
+  def name
+	"NamedSample tests" 
+  end
+
+	def test_for_named_samples_files
+		names = [
+			'Bassy01(C3).wav',
+			'D#2.wav',
+			'Bass10_C1.wav'
+		]
+
+		names.each do |name|
+		assert(  NamedSample.sample?( name ) , 
+			"\"#{name}\" is NOT a valid note name.") 
+		end
+	end
+
+
+	def test_for_named_sample_values
+		sample_values = { 		
+			'C4.ogg' => 60,
+			'Bassy01(C3).wav' => 48,
+			'D#2.wav' => 39,
+			'Bass10_C1.wav' => 24
+		}
+
+		sample_values.each do |sample, value|
+		assert_equal( value,  NamedSample.value( sample ), 
+			"The value of \"#{sample}\" is NOT \"#{value}\".") 
+		end
+	end
+
+
+	def test_named_sample_comparables
+		c3 = NamedSample.new( "Bassy01(C3).wav" )
+		assert_equal( 48,  c3.value )
+
+		d2 = NamedSample.new( 'D#2.aif' )
+		assert_equal( 39,  d2.value )
+
+		c3o = NamedSample.new( "C3.ogg" )
+		assert_equal( 48,  c3o.value )
+		
+		# Since 
+		c1 = NamedSample.new( "C1.wav" ) #24
+		
+		b1 = NamedSample.new( "B1.wav" ) #35
+		
+		assert_operator b1, :>, c1, "#{b1} > #{c1}"
+		assert_operator d2, :<, c3, "#{d2} < #{c3}"
+		assert_operator c3, :==, c3o, "#{c3} = #{c3o}"
+	end
+
+end

data/test/test_sfzer.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/ruby -w
+
+lib = File.dirname(__FILE__) + '/../lib/' 
+test = File.dirname(__FILE__) + '/../test/'
+$: << lib
+$: << test
+
+require 'test/unit'
+require 'sfzer'
+
+require 'NamedSampleTest'
+require 'MultisampleTest'

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: sfzer
+version: !ruby/object:Gem::Version 
+  version: "0.4"
+platform: ruby
+authors: 
+- Chris Tessmer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-11 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.3
+    version: 
+description: SFZer recursively scans through directories of Multisamples (.wav, .aiff, .ogg, etc) and automagically generates SFZ soundfonts from what it finds.
+email: 
+- http://christessmer.com
+executables: 
+- sfzer
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- 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
+has_rdoc: true
+homepage: http://sfzer.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: sfzer
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: SFZer recursively scans through directories of Multisamples (.wav, .aiff, .ogg, etc) and automagically generates SFZ soundfonts from what it finds.
+test_files: 
+- test/test_sfzer.rb