JOCLoudness 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 233b016a7113d6d0d79533b247d6962922467c1a
-  data.tar.gz: 3aae6b46fdf8eb78b818b3318fd9a46562d5f9d1
+  metadata.gz: 70c06a0cf74b5717a783f385af081385f7bf95ef
+  data.tar.gz: 26cb1be5891ff54a3f3445d6c0a5d2fe27cd668c
 SHA512:
-  metadata.gz: afa516ea690e777fff9c5bef87bae79fddf1750022f5c4bc42135cbec06152d6784f510349bf6b9f54c6d3dbfeb92c959f15e6b87a6180338cf50f84d654822e
-  data.tar.gz: af9f65f0f1ae9df978eadf8acfb4aba34c2d9c1fcada4418a87df2624608c47e1f3c19491358a34e6625ecbe9d3828f557f561ce3cfe2a4f888e4e8e441b59dc
+  metadata.gz: 52d59b4628a720eb3b943b45f4c76b09d045bfddb650de0a1c7f029981e80909d041ff30ea75ba2650fd798e183ceea1abd44792229e293e4228edfb067acdc2
+  data.tar.gz: 7131eb87e6101ece6f4f60acd452ce954a4cdcbab4699f73d86f951f2e17a890941a062c23526959fc408d73123ac731dd11897262f878ec860a956078f5ee80

data/lib/Loudness/IIRFilter/IIRFilter.rb

@@ -1,9 +1,8 @@
 #file: IIRFilter.rb
 
-
-class IIRFilter
-  
-  # Ini obj
+#IIR filter 
+class IIRFilter  
+    
   def initialize(order)
     @OldSamples = nil
     @ACoefs= nil

data/lib/Loudness/JOCLoud.rb

@@ -3,9 +3,10 @@ require_relative './RlbFilter/RLBFilter.rb'
 require_relative './PreFilter/PREFilter.rb'
 require_relative './Mean/MeanFast.rb'
 
+#Loudness computation class (Based on ITU-R BS.1770)
 class JOCLoud
   
-  # Ini obj
+  # Constructor
   def initialize    
     @logger = nil
     
@@ -24,11 +25,14 @@ class JOCLoud
     @iscomputingLKFS = false
   end
 
-  #Set logger
+  # Set logger (optional)
   def Setlogger(logger)
     @logger = logger
   end
 
+  # Initialize class
+  # @param fs [int] the sampling frecuency of wav file. It's used to compute the properly filter coeficients.
+  # @param nchannels [int] the number of audio channels of wav file.
   def ini(fs, nchannels)    
   
     @fs = fs
@@ -67,6 +71,8 @@ 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)
+  # @param channelweights [Array] 
   def SetChannelWeigths(channelweights)
 
     if (@iscomputingLKFS == true)
@@ -108,6 +114,8 @@ class JOCLoud
     end
   end
   
+  # Returns the loudness of the wav file
+  # @return [Float] the resulting loudness in LKFS
   def GetLoudnessLKFS
     meanvals = Array.new
     nc = 0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: JOCLoudness
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jordi Cenzano