JOCLoudness 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3df471c2ebdf1e1e25de968b5ab074a267a79a05
-  data.tar.gz: 9d13fc517b4901bde3e184692a62aefa2e2e3d99
+  metadata.gz: 0cd5d2552d8fb90f3fbc2eadfaa80d37285c3120
+  data.tar.gz: dc05cf8feb070410238e93fcb6a08899a96efccd
 SHA512:
-  metadata.gz: cdb7f39ba81828c04f7bef651ee9bd7b733a2c353e745d0a05be8cb71b53d73cbca896f6fc8e2b04e25f3a9edc8bbb9df02cfc720aa3162694d389d654013330
-  data.tar.gz: 27e15a6d9dd5bd67a4f5eb5d680f9659fa393e83fb811de19693d74bdecec1de2048f75339c21996a5158592936e0c8b90d4b5915c52aa0da49e0b5cc58f603d
+  metadata.gz: 44d689ed177c7115f5a94b6fa7dbb0222fd1032070b8a677e61f478e33a2cf33dfefa6019b4a96e092c061e17d565763870367d69c85b3062f918a3b34946fd9
+  data.tar.gz: 3bf8dc5ea09ce4ecd48d0762200b41a13fd5f7a16ff17dbfb5ad45604b9265086a8ab96e28fc695f49642e1b38f65e31661cfb30e4ec0e5a9145c2a5ae86011e

data/lib/WavReader/wavfile.rb

@@ -0,0 +1,173 @@
+#file: wavfile.rb
+require_relative './wavheader'
+require_relative './wavsamples'
+
+#Wavfile class, used to read an audio wav file
+#It is able to read wav files with:
+#* Any sampling frequency
+#* Any number of channels
+#* PCM 8,16,24 bits per sample
+#* FLOAT 36 bits per sample
+#*Headers of 16, 18, 40 bytes 
+class Wavfile
+	
+  #Initialize wavreader
+  # @param filename [String] sets the path audio file to read. Example "c:\audio\test.wav"
+	def initialize(filename)
+		@filename = filename
+		@mainheader = nil
+		@logger = nil
+		@wavfile = nil
+		
+		@lHeaderOffsetbytes = 0;
+	end
+
+  # Set logger (optional)
+  # @param logger [Logger] a referce to Logger class
+	def Setlogger(logger)
+		@logger = logger
+	end
+  
+	# Reads the wav header file
+	def ReadHeader
+		Log(Logger::DEBUG,"Start reading wav header of #{@filename}")
+		
+		begin  
+			#Read wav header
+			@mainheader = nil
+			@mainheader = Wavheader.new
+		
+			@wavfile = File.open(@filename, 'r')
+			@mainheader.read(@wavfile)
+			
+			@lHeaderOffsetbytes = @mainheader.cfirstdatabyte.abs_offset;
+			
+			Log(Logger::DEBUG,"lHeaderOffsetbytes:  #{@lHeaderOffsetbytes}")
+			
+		rescue Exception => e  
+			Log(Logger::ERROR,"Error reading wav header of #{e.message}, Trace: #{e.backtrace.inspect}")
+		end  		
+		
+		Log(Logger::DEBUG,@mainheader)
+					
+	end
+
+  # Returns audio file information
+  # @return [Array] with sampling frecuency and number of channels [fs nch]
+  def GetFileInfo 
+    return [@mainheader.ulSampleRate,@mainheader.nchannels] 
+  end
+
+  # Returns audio samples array 
+  # @param n [int] sample index (starts in n = 0)
+  # @param bNormalize [Bollean] if normalize == true the returned samples are normalized (max value = 1.0), if not the original readed value us returned
+  # @return [Array] with audio samples (1 sample per channel). Example [0.323 0.322] 
+	def GetAudioSamples (sampleindex, bNormalize = true)
+		if (@wavfile == nil)
+			Log(Logger::WARN, "The file is not opened")
+		else
+			begin  
+				Log(Logger::DEBUG,"Start reading sample pos #{@sampleindex}")
+				
+				#Seek to sample position channel 0
+				lsamplesizebytes = (@mainheader.sBitsPerSample / 8)
+				loffsetbytes = @lHeaderOffsetbytes + sampleindex * (@mainheader.nchannels * lsamplesizebytes)
+				
+				Log(Logger::DEBUG,"loffsetbytes: #{loffsetbytes} of #{@wavfile.size}")
+							
+				if (loffsetbytes >= @wavfile.size)
+				  Log(Logger::DEBUG,"EOF reached!")
+					nil
+				else
+					@wavfile.seek(loffsetbytes)
+				
+					#Create PCM samples
+					samples = nil
+					nmax = 1;
+					
+					if (@mainheader.nformattag == Wavheader::PCM)
+						#Read PCM sample 8 bits/sample (-128 ... 0 ... +127)
+						if (@mainheader.sBitsPerSample == 8)
+							samples = Wavsample8b.new(:num_channels => @mainheader.nchannels)
+							nmax = 128
+						end
+						#Read PCM sample 16 bits/sample (-32768 ... 0 ... +32767)
+						if (@mainheader.sBitsPerSample == 16)
+							samples = Wavsample16b.new(:num_channels => @mainheader.nchannels)
+							nmax = 32768
+						end
+						#Read PCM sample 24 bits/sample (-8388608 ... 0 ... +8388607)
+						if (@mainheader.sBitsPerSample == 24)
+							samples = Wavsample24b.new(:num_channels => @mainheader.nchannels)
+							nmax = 8388608
+						end										
+					end
+
+					#Create FLOAT samples
+					if (@mainheader.nformattag == Wavheader::FLOAT)				
+						samples = WavsampleFloat.new(:num_channels => @mainheader.nchannels)
+					end
+					
+					if (samples != nil)				
+						#Read sample from file
+						samples.read(@wavfile)
+					else
+						raise 'Sample not compatible (Is not PCM neither FLOAT)'
+					end
+					
+					Log(Logger::DEBUG,samples)
+					
+					samplesRetArray = samples.samples
+					
+					if (samplesRetArray != nil) and (@mainheader.nformattag == Wavheader::PCM) and (bNormalize == true)
+            samplesRetArray = samplesRetArray.collect {|x| x.to_f / nmax.to_f}
+					end
+          
+          Log(Logger::DEBUG,"Samples normalized = #{samplesRetArray.to_s}")
+          
+          samplesRetArray 
+          					
+				end
+			rescue Exception => e  
+				Log(Logger::ERROR,"Error reading wav sample in pos #{sampleindex}. Error: #{e.message}, Trace: #{e.backtrace.inspect}")
+			end
+		end 
+	end
+	
+	# Close the audio opened file
+	def Close	
+		Log(Logger::DEBUG,"Start closing #{@filename}")
+	
+		if (@wavfile != nil)
+			@wavfile.close
+			@wavfile = nil
+		end 
+		
+		Log(Logger::DEBUG,"Closed: #{@filename}")
+		
+		@filename = nil
+	end
+
+private
+
+	def Log (type, message)
+	
+		if (@logger != nil)
+			if (type == Logger::FATAL)
+				@logger.fatal(message)
+			end
+			if (type == Logger::ERROR)
+				@logger.error(message)
+			end
+			if (type == Logger::WARN)
+				@logger.warn(message)
+			end
+			if (type == Logger::INFO)
+				@logger.info(message)
+			end
+			if (type == Logger::DEBUG)
+				@logger.debug(message)
+			end	
+		end 		
+	end
+end

data/lib/WavReader/wavheader.rb

@@ -0,0 +1,47 @@
+#file: wavheader.rb
+require 'bindata'
+
+# define main wav header
+class Wavheader < BinData::Record
+	hide :cfirstdatabyte
+	
+	PCM = 1
+	FLOAT = 3
+
+	#WAV header 
+	endian :little
+	
+	string :cid, :read_length => 4, :asserted_value => 'RIFF'
+	uint32 :ulChunksSizeTotal
+	string :cidwave, :read_length => 4, :asserted_value => 'WAVE'
+	string :cidfmt, :read_length => 4, :asserted_value => 'fmt '
+	uint32 :ulChunkSize
+	 
+	uint16 :nformattag #1 = PCM, 2 = FLOAT
+	uint16 :nchannels #Number of channels
+	uint32 :ulSampleRate #Sample rate
+	uint32 :ulAvgBytesSec #Bytes per sec avg
+	uint16 :sBlockAlign #Bytes x sample * num channels
+	uint16 :sBitsPerSample #bits per sample
+	 
+	 # The following fields are optional depending on ulChunkSize
+	 
+	struct  :subheader18, :onlyif => lambda {ulChunkSize == 18} do
+		uint16 :sSizeofExtension #Must be 2	end
+	end
+	
+	struct  :subheader40, :onlyif => lambda {ulChunkSize == 40} do
+		uint16 :sSizeofExtension, :asserted_value => 22
+		uint16 :sValidbitspersample #Valid bits per sample
+		uint32 :ulChannelmask #Speaker position mask (Use to be 0)
+		string :cGuidSubFormat, :read_length => 16 #GUID data format code
+		string :cfact, :read_length => 4, :asserted_value => 'fact' 
+		uint32 :lChunkFactSize, :read_length => 4, :asserted_value => 4
+		uint32 :lSampleLength, :read_length => 4 #Number of samples (per channel)
+	end
+	
+	string :cdata, :read_length => 4, :asserted_value => 'data'
+	uint32 :uDataChunkSize
+	
+	uint8 :cfirstdatabyte
+end

data/lib/WavReader/wavsamples.rb

@@ -0,0 +1,46 @@
+#file: wavsamples.rb
+require 'bindata'
+
+# define wav 8b per sample
+class Wavsample8b < BinData::Record
+	#WAV sample 8bits per sample
+	mandatory_parameter :num_channels	
+	endian :little
+	
+	array :samples, :initial_length => :num_channels do
+    int8 :s
+  end
+end
+
+# define wav 16b per sample
+class Wavsample16b < BinData::Record
+	#WAV sample 16bits per sample
+	mandatory_parameter :num_channels	
+	endian :little
+	
+	array :samples, :initial_length => :num_channels do
+    int16 :s
+  end
+end
+
+# define wav 24b per sample
+class Wavsample24b < BinData::Record
+	#WAV sample 24bits per sample
+	mandatory_parameter :num_channels	
+	endian :little
+	
+	array :samples, :initial_length => :num_channels do
+    int24 :s
+  end
+end
+
+# define wav IEEE FLOAT per sample
+class WavsampleFloat < BinData::Record
+	#WAV sample FLOAT 
+	mandatory_parameter :num_channels	
+	endian :little
+	
+	array :samples, :initial_length => :num_channels do
+    float :s
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: JOCLoudness
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Jordi Cenzano
@@ -44,6 +44,9 @@ files:
 - lib/Loudness/Mean/MeanFast.rb
 - lib/Loudness/PreFilter/PREFilter.rb
 - lib/Loudness/RlbFilter/RLBFilter.rb
+- lib/WavReader/wavfile.rb
+- lib/WavReader/wavheader.rb
+- lib/WavReader/wavsamples.rb
 homepage: http://rubygems.org/gems/JOCLoudness
 licenses:
 - MIT