JOCLoudness 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70c06a0cf74b5717a783f385af081385f7bf95ef
-  data.tar.gz: 26cb1be5891ff54a3f3445d6c0a5d2fe27cd668c
+  metadata.gz: 3df471c2ebdf1e1e25de968b5ab074a267a79a05
+  data.tar.gz: 9d13fc517b4901bde3e184692a62aefa2e2e3d99
 SHA512:
-  metadata.gz: 52d59b4628a720eb3b943b45f4c76b09d045bfddb650de0a1c7f029981e80909d041ff30ea75ba2650fd798e183ceea1abd44792229e293e4228edfb067acdc2
-  data.tar.gz: 7131eb87e6101ece6f4f60acd452ce954a4cdcbab4699f73d86f951f2e17a890941a062c23526959fc408d73123ac731dd11897262f878ec860a956078f5ee80
+  metadata.gz: cdb7f39ba81828c04f7bef651ee9bd7b733a2c353e745d0a05be8cb71b53d73cbca896f6fc8e2b04e25f3a9edc8bbb9df02cfc720aa3162694d389d654013330
+  data.tar.gz: 27e15a6d9dd5bd67a4f5eb5d680f9659fa393e83fb811de19693d74bdecec1de2048f75339c21996a5158592936e0c8b90d4b5915c52aa0da49e0b5cc58f603d

data/README.md

@@ -0,0 +1,4 @@
+JOCLoudnessRuby
+===============
+
+The JOCLoudnessRuby is a native gem able to load a wav file and calculate its LKFS following the ITU-R BS.1770

data/lib/JOCLoudness.rb

@@ -1,4 +1,15 @@
-#file: JOCLoudness.rb 
+# JOCLoudness -- Wav loudness computation 
+# Copyright (c) 2014 Jordi Cenzano.
+
+if RUBY_VERSION <= "1.9"
+  fail "JOCLoudness requires ruby >= 1.9.3."
+end
+ 
 require 'logger'
 require_relative './WavReader/wavfile'
 require_relative './Loudness/jocLoud.rb'
+
+# = JOCLoudness
+# 
+# This ruby native gem is able to load a wav file and calculate its LKFS following the ITU-R BS.1770
+# 

data/lib/Loudness/IIRFilter/IIRFilter.rb

@@ -1,6 +1,6 @@
 #file: IIRFilter.rb
 
-#IIR filter 
+#IIR filter implementation
 class IIRFilter  
     
   def initialize(order)
@@ -15,7 +15,9 @@ class IIRFilter
         
   end
   
-  #Set filters coeficients
+  #Set IIR filter coeficients
+  # @param b [Array] sets the B coeficients of IIR filter example: [1.02, 0.99]
+  # @param a [Array] sets the A coeficients of IIR filter example: [1.02, 0.99]
   def SetCoefs (b, a)
     if ((a.kind_of?(Array) == false) or (b.kind_of?(Array) == false))
       raise 'Filter coeficinets must be an array'
@@ -29,7 +31,9 @@ class IIRFilter
      
   end
   
-  #Filter 1 sample
+  #Set IIR filter coeficients
+  # @param bsampleIn [Float] enters a new sample to filter
+  # @return [Float] the output filtered sample 
   def FilterSample (sampleIn)
     
     nFilterCoefs = @Order + 1;
@@ -76,7 +80,8 @@ class IIRFilter
     return ox
   end
  
-  #Show coefs
+  #Gets filter information
+  # @return [String] filter information 
   def Info
     return "IIR Filter Order #{@Order}\nACoefs #{@ACoefs}\nBCoefs #{@BCoefs}\n"
   end

data/lib/Loudness/JOCLoud.rb

@@ -6,7 +6,6 @@ require_relative './Mean/MeanFast.rb'
 #Loudness computation class (Based on ITU-R BS.1770)
 class JOCLoud
   
-  # Constructor
   def initialize    
     @logger = nil
     
@@ -26,6 +25,7 @@ class JOCLoud
   end
 
   # Set logger (optional)
+  # @param logger [Logger] a referce to Logger class
   def Setlogger(logger)
     @logger = logger
   end
@@ -71,7 +71,7 @@ class JOCLoud
     Log(Logger::DEBUG,"Endini")
   end
 
-  # Set audio channels weights (optional). The default channel weights for loudness computation are [1.0, 1.0, 1.0, 1.41, 1.41, 0, 0, 0] (lineal)
+  # Set audio channels weights (optional). The default channel weights for loudness computation are [1.0, 1.0, 1.0, 1.41, 1.41, 0, 0, 0] (linear). The channel order is [Left, Right, Centre, Left surround, Right Surround]
   # @param channelweights [Array] 
   def SetChannelWeigths(channelweights)
 
@@ -91,6 +91,8 @@ class JOCLoud
     Log(Logger::INFO,"Set new channel wheights: #{@channelweights}")
   end
   
+  # Adds a new audio sample array 
+  # @param dsample [Array]. The dsample Array must contain 1 Float sample (0...1) per audio channel. Example [0.987655, 0.983344]
   def Addsample (dsample)
     @iscomputingLKFS = true
   

data/lib/Loudness/Mean/MeanFast.rb

@@ -1,14 +1,16 @@
 #file: MeanFast.rb
 
-# define MeanFast
+#Conputes mean
 class MeanFast
   
+  #Specifies the type of mean to compute
+  #MEAN_TOTAL = regular mean
+  #MEAN_OVERLAPPED = not implemented yet
   module MEAN_MODE
     MEAN_OVERLAPPED = 1
     MEAN_TOTAL = 2
   end
   
-  # Ini obj
   def initialize
     @bIni = false
     @mode = MEAN_MODE::MEAN_TOTAL
@@ -31,7 +33,12 @@ class MeanFast
     Ini(@mode, 48000, 400, 0.75)
   end
   
-  def Ini(mode, fs, lMeanIntervalms, dOverlappingFactor)    
+  #Initializes the mean computation, and it sets the mean mode
+  # @param mode Must be = MEAN_TOTAL
+  # @param fs [int] not used in this version
+  # @param lMeanIntervalms [int] not used in this version
+  # @param dOverlappingFactor [Float] not used in this version 
+  def Ini(mode, fs = 0, lMeanIntervalms = 0, dOverlappingFactor = 0)    
     
     if (@bIni == true)
       raise 'ERROR bad state'
@@ -65,6 +72,8 @@ class MeanFast
     @bIni = true;
   end
   
+  #Adds a new sample to mean computation 
+  # @param dSample [Float] new sample
   def AddSample (dSample)
     rc = false
     
@@ -112,6 +121,8 @@ class MeanFast
     return rc
   end
   
+  #Adds a new sample to mean computation 
+  # @return [Float] the resulting mean value
   def GetMeanVal
     if (@mode == MEAN_MODE::MEAN_OVERLAPPED)
       raise 'ERROR function not valid in overlapped mean mode'

data/lib/Loudness/PreFilter/PREFilter.rb

@@ -2,16 +2,19 @@
 
 require_relative '../IIRFilter/IIRFilter.rb'
 
-# define PRE filter
+#PRE filter implementation
 class PREFilter < IIRFilter
   
-  # Ini obj
+  #Initialize PRE Filter implementation
+  # @param fs [int] sets the sampleing frecuency. It is used to compute the filter coeficients according to the PRE Filter definition in ITU-R BS.1770
   def initialize(fs)
     super 2 
     
     SetFreqSampling(fs)
   end
 
+  #Sets PRE Filter sampleing frecuency
+  # @param fs [int] sets the sampleing frecuency. It is used to compute the filter coeficients according to the PRE Filter definition in ITU-R BS.1770
   def SetFreqSampling (fs) 
     @fs = fs
     
@@ -30,6 +33,14 @@ class PREFilter < IIRFilter
 
     SetCoefs mBCoefs,mACoefs
   end 
+  
+  #Gets filter information
+  # @return [String] filter information 
+  def Info
+    return "PRE Filter--------\nFs = #{@fs} Hz\n#{super}\n------------------\n"
+  end
+
+private
 
   def CalcCoefs (fs, nGdb, dFc)
 
@@ -51,8 +62,4 @@ class PREFilter < IIRFilter
     return mBCoefs, mACoefs
   end
   
-  #Show info 
-  def Info
-    return "PRE Filter--------\nFs = #{@fs} Hz\n#{super}\n------------------\n"
-  end
 end

data/lib/Loudness/RlbFilter/RLBFilter.rb

@@ -2,16 +2,19 @@
 
 require_relative '../IIRFilter/IIRFilter.rb'
 
-# define RLB filter
+#RLB filter implementation
 class RLBFilter < IIRFilter
   
-  # Ini obj
+  #Initialize RLB Filter implementation
+  # @param fs [int] sets the sampleing frecuency. It is used to compute the filter coeficients according to the RLB Filter definition in ITU-R BS.1770
   def initialize(fs)
     super 2 
     
     SetFreqSampling(fs)
   end
 
+  #Sets RLB Filter sampleing frecuency
+  # @param fs [int] sets the sampleing frecuency. It is used to compute the filter coeficients according to the RLB Filter definition in ITU-R BS.1770
   def SetFreqSampling (fs) 
     @fs = fs
     
@@ -29,6 +32,14 @@ class RLBFilter < IIRFilter
 
     SetCoefs mBCoefs,mACoefs
   end 
+  
+  #Gets filter information
+  # @return [String] filter information 
+  def Info
+    return "RLB Filter--------\nFs = #{@fs} Hz\n#{super}\n------------------\n"
+  end
+
+private
 
   def CalcCoefs (fs, dFc)
     dK = Math.tan( (Math::PI * dFc.to_f) / fs.to_f )    
@@ -48,9 +59,4 @@ class RLBFilter < IIRFilter
   
     return mBCoefs, mACoefs
   end
-  
-  #Show info 
-  def Info
-    return "RLB Filter--------\nFs = #{@fs} Hz\n#{super}\n------------------\n"
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: JOCLoudness
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Jordi Cenzano
@@ -37,6 +37,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/JOCLoudness.rb
 - lib/Loudness/IIRFilter/IIRFilter.rb
 - lib/Loudness/JOCLoud.rb