WaveSwissKnife 0.2.0.20120302

data/lib/WSK/Actions/SilenceInserter.rb

@@ -0,0 +1,87 @@
+#--
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module WSK
+
+  module Actions
+
+    class SilenceInserter
+
+      include WSK::Common
+
+      # Number of samples in the silent buffer
+      #   Integer
+      SILENT_BUFFER_SIZE = 2097152
+
+      # Get the number of samples that will be written.
+      # This is called before execute, as it is needed to write the output file.
+      # It is possible to give a majoration: it will be padded with silence.
+      #
+      # Parameters::
+      # * *iInputData* (<em>WSK::Model::InputData</em>): The input data
+      # Return::
+      # * _Integer_: The number of samples to be written
+      def get_nbr_samples(iInputData)
+        @NbrBeginSilentSamples = readDuration(@BeginSilenceLength, iInputData.Header.SampleRate)
+        @NbrEndSilentSamples = readDuration(@EndSilenceLength, iInputData.Header.SampleRate)
+
+        return iInputData.NbrSamples+@NbrBeginSilentSamples+@NbrEndSilentSamples
+      end
+
+      # Execute
+      #
+      # Parameters::
+      # * *iInputData* (<em>WSK::Model::InputData</em>): The input data
+      # * *oOutputData* (_Object_): The output data to fill
+      # Return::
+      # * _Exception_: An error, or nil if success
+      def execute(iInputData, oOutputData)
+        pushSilence(iInputData, oOutputData, @NbrBeginSilentSamples)
+        pushFile(iInputData, oOutputData)
+        pushSilence(iInputData, oOutputData, @NbrEndSilentSamples)
+        
+        return nil
+      end
+      
+      private
+      
+      # Push silence in the file
+      #
+      # Parameters::
+      # * *iInputData* (<em>WSK::Model::InputData</em>): The input data
+      # * *oOutputData* (_Object_): The output data to fill
+      # * *iNbrSamples* (_Integer_): The number of silent samples to insert
+      def pushSilence(iInputData, oOutputData, iNbrSamples)
+        lRawSampleSize = (iInputData.Header.NbrChannels*iInputData.Header.NbrBitsPerSample)/8
+        lNbrCompleteBuffers = iNbrSamples/SILENT_BUFFER_SIZE
+        if (lNbrCompleteBuffers > 0)
+          lCompleteRawBuffer = "\000"*SILENT_BUFFER_SIZE*lRawSampleSize
+          lNbrCompleteBuffers.times do |iIdx|
+            oOutputData.pushRawBuffer(lCompleteRawBuffer)
+          end
+        end
+        lLastBufferSize = iNbrSamples % SILENT_BUFFER_SIZE
+        if (lLastBufferSize > 0)
+          oOutputData.pushRawBuffer("\000"*lLastBufferSize*lRawSampleSize)
+        end
+      end
+
+      # Push the file
+      #
+      # Parameters::
+      # * *iInputData* (<em>WSK::Model::InputData</em>): The input data
+      # * *oOutputData* (_Object_): The output data to fill
+      def pushFile(iInputData, oOutputData)
+        # Then write the file
+        iInputData.each_raw_buffer do |iInputRawBuffer, iNbrSamples, iNbrChannels|
+          oOutputData.pushRawBuffer(iInputRawBuffer)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/WSK/Actions/SilenceRemover.desc.rb

@@ -0,0 +1,30 @@
+#--
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+{
+  :OutputInterface => 'DirectStream',
+  :Options => {
+    :SilenceThreshold => [
+      '--silencethreshold <SilenceThreshold>', String,
+      '<SilenceThreshold>: Threshold to use to identify silent parts [default = 0]. It is possible to specify several values, for each channel, sperated with | (ie. 34|35). It is also possible to specify a range instead of a threshold with , (ie. -128,126 or -128,126|-127,132)',
+      'Specify the silence threshold'
+    ],
+    :Attack => [
+      '--attack <AttackDuration>', String,
+      '<AttackDuration>: Attack duration in samples or in float seconds (ie. 234 or 25.3s).',
+      'Specify the attack duration after the silence. This will keep the noise before the non-silent part.'
+    ],
+    :Release => [
+      '--release <ReleaseDuration>', String,
+      '<ReleaseDuration>: Release duration in samples or in float seconds (ie. 234 or 25.3s).',
+      'Specify the release duration before the silence. This will keep the noise after the non-silent part.'
+    ],
+    :NoiseFFTFileName => [
+      '--noisefft <FFTFile>', String,
+      '<FFTFile>: File containing the FFT profile of the reference noise.',
+      'This is used to compare potential noise profile with the real noise profile.'
+    ]
+  }
+}

data/lib/WSK/Actions/SilenceRemover.rb

@@ -0,0 +1,74 @@
+#--
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module WSK
+
+  module Actions
+
+    class SilenceRemover
+
+      include WSK::Common
+      include WSK::FFT
+
+      # Get the number of samples that will be written.
+      # This is called before execute, as it is needed to write the output file.
+      # It is possible to give a majoration: it will be padded with silence.
+      #
+      # Parameters::
+      # * *iInputData* (<em>WSK::Model::InputData</em>): The input data
+      # Return::
+      # * _Integer_: The number of samples to be written
+      def get_nbr_samples(iInputData)
+        lSilenceThresholds = readThresholds(@SilenceThreshold, iInputData.Header.NbrChannels)
+        @IdxFirstSample, lNextAboveThresholds = getNextNonSilentSample(iInputData, 0, lSilenceThresholds, nil, nil, false)
+        if (@IdxFirstSample == nil)
+          log_info 'The whole file is silent'
+          @IdxFirstSample = 0
+          @IdxLastSample = 0
+        else
+          lNoiseFFTMaxDistance, lNoiseFFTProfile = readFFTProfile(@NoiseFFTFileName)
+          @IdxLastSample, lNextAboveThresholds = getNextNonSilentSample(iInputData, iInputData.NbrSamples-1, lSilenceThresholds, lNoiseFFTProfile, lNoiseFFTMaxDistance, true)
+          if (@IdxLastSample == nil)
+            log_err "A beginning sample has been found (#{@IdxFirstSample}), but no ending sample could. This is a bug."
+            raise RuntimeError.new("A beginning sample has been found (#{@IdxFirstSample}), but no ending sample could. This is a bug.")
+          end
+          # Compute the limits of fadein and fadeout
+          lNbrAttack = readDuration(@Attack, iInputData.Header.SampleRate)
+          lNbrRelease = readDuration(@Release, iInputData.Header.SampleRate)
+          @IdxFirstSample -= lNbrAttack
+          if (@IdxFirstSample < 0)
+            log_warn "Attack duration #{lNbrAttack} makes first non silent sample negative. Setting it to 0. Please consider decreasing attack duration."
+            @IdxFirstSample = 0
+          end
+          @IdxLastSample += lNbrRelease
+          if (@IdxLastSample >= iInputData.NbrSamples)
+            log_warn "Release duration #{lNbrRelease} makes last non silent sample overflow. Setting it to the last sample (#{iInputData.NbrSamples - 1}). Please consider decreasing release duration."
+            @IdxLastSample = iInputData.NbrSamples - 1
+          end
+        end
+
+        return @IdxLastSample-@IdxFirstSample+1
+      end
+
+      # Execute
+      #
+      # Parameters::
+      # * *iInputData* (<em>WSK::Model::InputData</em>): The input data
+      # * *oOutputData* (_Object_): The output data to fill
+      # Return::
+      # * _Exception_: An error, or nil if success
+      def execute(iInputData, oOutputData)
+        iInputData.each_raw_buffer(@IdxFirstSample, @IdxLastSample) do |iInputRawBuffer, iNbrSamples, iNbrChannels|
+          oOutputData.pushRawBuffer(iInputRawBuffer)
+        end
+
+        return nil
+      end
+
+    end
+
+  end
+
+end

data/lib/WSK/Actions/VolumeProfile.desc.rb

@@ -0,0 +1,35 @@
+#--
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+{
+  :OutputInterface => 'DirectStream',
+  :Options => {
+    :FctFileName => [
+      '--function <FunctionFileName>', String,
+      '<FunctionFileName>: File that will contain the volume profile',
+      'Specify the file to write with the profile function'
+    ],
+    :Begin => [
+      '--begin <BeginPos>', String,
+      '<BeginPos>: Position to begin profiling volume from. Can be specified as a sample number or a float seconds (ie. 12.3s).',
+      'Specify the beginning of the profile'
+    ],
+    :End => [
+      '--end <EndPos>', String,
+      '<EndPos>: Position to end profiling volume to. Can be specified as a sample number or a float seconds (ie. 12.3s). -1 means to the end.',
+      'Specify the ending of the profile'
+    ],
+    :Interval => [
+      '--interval <Interval>', String,
+      '<Interval>: Number of samples defining an interval for the volume measurement. Can be specified as a sample number or a float seconds (ie. 12.3s).',
+      'Specify the granularity of the volume profile'
+    ],
+    :RMSRatio => [
+      '--rmsratio <Ratio>', Float,
+      '<Ratio>: Ratio of RMS measure vs Peak level measure, expressed in floats of range [0.0 .. 1.0]. 0.0 = Only Peak. 1.0 = Only RMS.',
+      'Specify the way the level is measured.'
+    ]
+  }
+}

data/lib/WSK/Actions/VolumeProfile.rb

@@ -0,0 +1,63 @@
+#--
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module WSK
+
+  module Actions
+
+    class VolumeProfile
+
+      include WSK::Common
+
+      # Get the number of samples that will be written.
+      # This is called before execute, as it is needed to write the output file.
+      # It is possible to give a majoration: it will be padded with silence.
+      #
+      # Parameters::
+      # * *iInputData* (<em>WSK::Model::InputData</em>): The input data
+      # Return::
+      # * _Integer_: The number of samples to be written
+      def get_nbr_samples(iInputData)
+        return 0
+      end
+
+      # Execute
+      #
+      # Parameters::
+      # * *iInputData* (<em>WSK::Model::InputData</em>): The input data
+      # * *oOutputData* (_Object_): The output data to fill
+      # Return::
+      # * _Exception_: An error, or nil if success
+      def execute(iInputData, oOutputData)
+        rError = nil
+
+        lIdxBegin = readDuration(@Begin, iInputData.Header.SampleRate)
+        lIdxEnd = readDuration(@End, iInputData.Header.SampleRate)
+        lInterval = readDuration(@Interval, iInputData.Header.SampleRate)
+        if (lIdxEnd == -1)
+          lIdxEnd = iInputData.NbrSamples - 1
+        end
+        if (lIdxEnd >= iInputData.NbrSamples)
+          rError = RuntimeError.new("Profile ends at #{lIdxEnd}, superceeding last sample (#{iInputData.NbrSamples-1})")
+        else
+          lFunction = WSK::Functions::Function.new
+          lFunction.read_from_input_volume(iInputData, lIdxBegin, lIdxEnd, lInterval, @RMSRatio)
+          # Normalize the volume function on a [-1..1] scale
+          lFunction.divide_by(Rational(2)**(iInputData.Header.NbrBitsPerSample-1))
+          lMinX, lMinY, lMaxX, lMaxY = lFunction.get_bounds
+          lDBMinY = lFunction.value_val_2_db(lMinY, Rational(1))
+          lDBMaxY = lFunction.value_val_2_db(lMaxY, Rational(1))
+          log_info "Dynamic range: [#{sprintf('%.2f',lMinY)} - #{sprintf('%.2f',lMaxY)}] ([#{sprintf('%.2f',lDBMinY)}db - #{sprintf('%.2f',lDBMaxY)}db] = #{sprintf('%.2f',lDBMaxY-lDBMinY)}db)"
+          lFunction.write_to_file(@FctFileName)
+        end
+
+        return rError
+      end
+
+    end
+
+  end
+
+end

data/lib/WSK/Common.rb

@@ -0,0 +1,292 @@
+#--
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module WSK
+
+  # Common methods
+  module Common
+
+    # Parse plugins
+    def parsePlugins
+      # Protect from re-entrance to avoid useless error messages in regression
+      if (defined?($WSK_PluginsParsed) == nil)
+        lLibDir = File.expand_path(File.dirname(__FILE__))
+        require 'rUtilAnts/Plugins'
+        RUtilAnts::Plugins::install_plugins_on_object
+        parse_plugins_from_dir('Actions', "#{lLibDir}/Actions", 'WSK::Actions')
+        parse_plugins_from_dir('OutputInterfaces', "#{lLibDir}/OutputInterfaces", 'WSK::OutputInterfaces')
+        $WSK_PluginsParsed = true
+      end
+    end
+
+    # Access a WAVE file for read access.
+    # Give its header information as well as a proxy to access its data.
+    # Proxies are used to cache accesses as they might be time consuming.
+    #
+    # Parameters::
+    # * *iFileName* (_String_): The file name to open
+    # * *CodeBlock*: The code block called when accessing the file:
+    #   * *iHeader* (<em>WSK::Model::Header</em>): The file header information
+    #   * *iInputData* (<em>WSK::Model::InputData</em>): The file data proxy
+    #   * Return::
+    #   * _Exception_: Error, or nil in case of success
+    # Return::
+    # * _Exception_: Error, or nil in case of success
+    def accessInputWaveFile(iFileName)
+      rError = nil
+
+      File.open(iFileName, 'rb') do |iFile|
+        log_info "Access #{iFileName}"
+        rError, lHeader, lInputData = getWaveFileAccesses(iFile)
+        if (rError == nil)
+          rError = yield(lHeader, lInputData)
+        end
+      end
+      
+      return rError
+    end
+    
+    # Give Header and Data access from an opened Wave file
+    #
+    # Parameters::
+    # * *iFile* (_IO_): The IO handler
+    # Return::
+    # * _Exception_: An error, or nil in case of success
+    # * <em>WSK::Model::Header</em>: The header
+    # * <em>WSK::Model::InputData</em>: The input data
+    def getWaveFileAccesses(iFile)
+      rError = nil
+      rHeader = nil
+      rInputData = nil
+      
+      # Read header
+      rError, rHeader = readHeader(iFile)
+      log_debug "Header: #{rHeader.inspect}"
+      if (rError == nil)
+        # Get a data handle
+        rInputData = WSK::Model::InputData.new(iFile, rHeader)
+        rError = rInputData.init_cursor
+      end
+
+      return rError, rHeader, rInputData
+    end
+
+    # Access a WAVE file for write access.
+    # Give its header information as well as a proxy to access its data.
+    # Proxies are used to cache accesses as they might be time consuming.
+    #
+    # Parameters::
+    # * *iFileName* (_String_): The file name to write
+    # * *iHeader* (<em>WSK::Model::Header</em>): The file header information to write
+    # * *iOutputInterface* (_Object_): The output interface
+    # * *iNbrOutputDataSamples* (_Integer_): The number of output data samples
+    # * *CodeBlock*: The code block called when accessing the file
+    #   * Return::
+    #   * _Exception_: Error, or nil in case of success
+    # Return::
+    # * _Exception_: Error, or nil in case of success
+    def accessOutputWaveFile(iFileName, iHeader, iOutputInterface, iNbrOutputDataSamples)
+      rError = nil
+
+      File.open(iFileName, 'wb') do |oFile|
+        # Initialize the output interface
+        rError = iOutputInterface.initInterface(oFile, iHeader, iNbrOutputDataSamples)
+        if (rError == nil)
+          # Write header
+          log_info "Write header in #{iFileName}"
+          rError = writeHeader(oFile, iHeader, iNbrOutputDataSamples)
+          if (rError == nil)
+            # Call client code
+            rError = yield
+            if (rError == nil)
+              # Finalize the output interface
+              lNbrSamplesWritten = iOutputInterface.finalize
+              # Pad with \x00 if lNbrSamplesWritten is below iNbrOutputDataSamples
+              if (lNbrSamplesWritten < iNbrOutputDataSamples)
+                log_warn "#{lNbrSamplesWritten} samples written out of #{iNbrOutputDataSamples}: padding with silence."
+                oFile.write(iHeader.getEncodedString([0]*(iNbrOutputDataSamples-lNbrSamplesWritten)*iHeader.NbrChannels))
+              elsif (lNbrSamplesWritten > iNbrOutputDataSamples)
+                log_warn "#{lNbrSamplesWritten} samples written, but #{iNbrOutputDataSamples} only were expected. #{lNbrSamplesWritten - iNbrOutputDataSamples} samples more."
+              end
+            end
+          end
+        end
+      end
+
+      return rError
+    end
+
+    # Read a duration and give its corresponding value in samples
+    # Throws an exception in case of bad format.
+    #
+    # Parameters::
+    # * *iStrDuration* (_String_): The duration to read
+    # * *iSampleRate* (_Integer_): Sample rate of the file for which this duration applies
+    # Return::
+    # * _Integer_: The number of samples corresponding to this duration
+    def readDuration(iStrDuration, iSampleRate)
+      rNbrSamples = nil
+
+      if (iStrDuration[-1..-1] == 's')
+        rNbrSamples = ((iStrDuration[0..-2].to_f)*iSampleRate).round
+      else
+        rNbrSamples = iStrDuration.to_i
+      end
+
+      return rNbrSamples
+    end
+
+    # Read a given threshold indication on the command line.
+    #
+    # Parameters::
+    # * *iStrThresholds* (_String_): The thresholds to read
+    # * *iNbrChannels* (_Integer_): Number of channels for the file being decoded
+    # Return::
+    # * <em>list< [Integer,Integer] ></em>: The list of min and max values, per channel
+    def readThresholds(iStrThresholds, iNbrChannels)
+      rThresholds = nil
+
+      if (iStrThresholds.split('|').size == 1)
+        if (iStrThresholds.split(',').size == 1)
+          rThresholds = [ [ -iStrThresholds.to_i, iStrThresholds.to_i ] ] * iNbrChannels
+        else
+          rThresholds = [iStrThresholds.split(',').map { |iStrValue| iStrValue.to_i }] * iNbrChannels
+        end
+      else
+        rThresholds = []
+        iStrThresholds.split('|').each do |iThresholdInfo|
+          if (iThresholdInfo.split(',').size == 1)
+            rThresholds << [ -iThresholdInfo.to_i, iThresholdInfo.to_i ]
+          else
+            rThresholds << iThresholdInfo.split(',').map { |iStrValue| iStrValue.to_i }
+          end
+        end
+      end
+
+      return rThresholds
+    end
+
+    # Read an FFT profile file
+    #
+    # Parameters::
+    # * *iFileName* (_String_): Name of the FFT profile file, or 'none' if none.
+    # Return::
+    # * _Integer_: Maximal FFT distance beyond which we consider being too far from the FFT profile
+    # * <em>[Integer,Integer,list<list<Integer>>]</em>: The FFT profile
+    def readFFTProfile(iFileName)
+      rFFTMaxDistance = nil
+      rFFTProfile = nil
+
+      if (iFileName != 'none')
+        if (File.exists?(iFileName))
+          # Load the reference FFT profile
+          File.open(iFileName, 'rb') do |iFile|
+            rFFTMaxDistance, rFFTProfile = Marshal.load(iFile.read)
+          end
+          # We add an arbitrary percentage to the average distance.
+          rFFTMaxDistance = (rFFTMaxDistance*1.01).to_i
+        else
+          log_err "Missing file #{iFileName}. Ignoring FFT."
+        end
+      end
+
+      return rFFTMaxDistance, rFFTProfile
+    end
+
+    # Convert a value to its db notation and % notation
+    #
+    # Parameters::
+    # * *iValue* (_Integer_): The value
+    # * *iMaxValue* (_Integer_): The maximal possible value
+    # Return::
+    # * _Float_: Its corresponding db
+    # * _Float_: Its corresponding percentage
+    def val2db(iValue, iMaxValue)
+      if (iValue == 0)
+        return -1.0/0, 0.0
+      else
+        if (defined?(@Log2) == nil)
+          @Log2 = Math.log(2.0)
+        end
+        return -6*(Math.log(Float(iMaxValue))-Math.log(Float(iValue.abs)))/@Log2, (Float(iValue.abs)*100)/Float(iMaxValue)
+      end
+    end
+
+    private
+
+    # Write the header to a file.
+    #
+    # Parameters::
+    # * *oFile* (_IO_): File to write
+    # * *iHeader* (<em>WSK::Model::Header</em>): The header to write
+    # * *iNbrOutputDataSamples* (_Integer_): The number of output data samples
+    # Return::
+    # * _Exception_: The exception, or nil in case of success
+    def writeHeader(oFile, iHeader, iNbrOutputDataSamples)
+      rError = nil
+
+      lBlockAlign = (iHeader.NbrChannels*iHeader.NbrBitsPerSample)/8
+      lOutputDataSize = iNbrOutputDataSamples * lBlockAlign
+      oFile.write("RIFF#{[lOutputDataSize+36].pack('V')}WAVEfmt #{[16, iHeader.AudioFormat, iHeader.NbrChannels, iHeader.SampleRate, iHeader.SampleRate * lBlockAlign, lBlockAlign, iHeader.NbrBitsPerSample].pack('VvvVVvv')}data#{[lOutputDataSize].pack('V')}")
+
+      return rError
+    end
+
+    # Get the header from a file.
+    # This also checks for unsupported types.
+    #
+    # Parameters::
+    # * *iFile* (_IO_): File to read
+    # Return::
+    # * _Exception_: The exception, or nil in case of success
+    # * <em>WSK::Model::Header</em>: The corresponding header, or nil in case of failure
+    def readHeader(iFile)
+      rError = nil
+      rHeader = nil
+
+      iFile.seek(0)
+      lBinaryHeader = iFile.read(12)
+      # Check if the format is ok
+      if (lBinaryHeader[0..3] != 'RIFF')
+        rError = RuntimeError.new('Invalid header: not RIFF')
+      elsif (lBinaryHeader[8..11] != 'WAVE')
+        rError = RuntimeError.new('Invalid header: not WAVE')
+      else
+        lReader = RIFFReader.new(iFile)
+        rError, lFMTSize = lReader.setFilePos('fmt ')
+        if (rError == nil)
+          # lFMTSize should be 18
+          if (lFMTSize >= 16)
+            lBinFormat = iFile.read(lFMTSize)
+            # Read values
+            lAudioFormat, lNbrChannels, lSampleRate, lByteRate, lBlockAlign, lNbrBitsPerSample = lBinFormat[0..17].unpack('vvVVvv')
+            # Check values
+            if (lBlockAlign != (lNbrChannels*lNbrBitsPerSample)/8)
+              rError = RuntimeError.new("Invalid header: Block alignment (#{lBlockAlign}) should be #{(lNbrChannels*lNbrBitsPerSample)/8}.")
+            elsif (lByteRate != lBlockAlign*lSampleRate)
+              rError = RuntimeError.new("Invalid header: Byte rate (#{lByteRate}) should be #{lBlockAlign*lSampleRate}.")
+            else
+              # OK, header is valid
+              rHeader = WSK::Model::Header.new(lAudioFormat, lNbrChannels, lSampleRate, lNbrBitsPerSample)
+            end
+          else
+            rError = RuntimeError.new("Invalid fmt header size: #{lFMTSize} should be >= 16.")
+          end
+        end
+      end
+
+      return rError, rHeader
+    end
+
+  end
+
+end
+
+require 'WSK/RIFFReader'
+require 'WSK/Model/InputData'
+require 'WSK/Model/Header'
+require 'WSK/FFT'
+require 'WSK/Maps'
+require 'WSK/Functions'