MusicMaster 0.0.1.20101110 → 1.0.0.20120307

data/lib/MusicMaster/FilesNamer.rb

@@ -0,0 +1,253 @@
+#--
+# Copyright (c) 2011 - 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require 'MusicMaster/Hash'
+
+module MusicMaster
+
+  module FilesNamer
+
+    # Get the directory in which files are recorded
+    #
+    # Return::
+    # * _String_: Directory to record files to
+    def getRecordedDir
+      return @MusicMasterConf[:Directories][:Record]
+    end
+
+    # Get the directory in which static audio files are stored
+    #
+    # Return::
+    # * _String_: Directory to store static audio files to
+    def getWaveDir
+      return @MusicMasterConf[:Directories][:Wave]
+    end
+
+    # Get the directory in which recorded files are analyzed
+    #
+    # Return::
+    # * _String_: Directory to store analysis results of recorded files to
+    def getAnalyzedRecordedDir
+      return @MusicMasterConf[:Directories][:AnalyzeRecord]
+    end
+
+    # Get the directory in which files are cleaned
+    #
+    # Return::
+    # * _String_: Directory to clean files to
+    def getCleanedDir
+      return @MusicMasterConf[:Directories][:Clean]
+    end
+
+    # Get the directory in which files are calibrated
+    #
+    # Return::
+    # * _String_: Directory to calibrate files to
+    def getCalibratedDir
+      return @MusicMasterConf[:Directories][:Calibrate]
+    end
+
+    # Get the directory in which Wave files are processed
+    #
+    # Return::
+    # * _String_: Directory to process files to
+    def getProcessesWaveDir
+      return @MusicMasterConf[:Directories][:ProcessWave]
+    end
+
+    # Get the directory in which recorded files are processed
+    #
+    # Return::
+    # * _String_: Directory to process files to
+    def getProcessesRecordDir
+      return @MusicMasterConf[:Directories][:ProcessRecord]
+    end
+
+    # Get the directory in which mix files are processed
+    #
+    # Return::
+    # * _String_: Directory to mix files to
+    def getMixDir
+      return @MusicMasterConf[:Directories][:Mix]
+    end
+
+    # Get the directory in which final mix files are linked
+    #
+    # Return::
+    # * _String_: Directory storing links to final mix files
+    def getFinalMixDir
+      return @MusicMasterConf[:Directories][:FinalMix]
+    end
+
+    # Get the directory in which files are delivered
+    #
+    # Return::
+    # * _String_: Directory to deliver files to
+    def getDeliverDir
+      return @MusicMasterConf[:Directories][:Deliver]
+    end
+
+    # Get the recorded file name of a given list of tracks on a given environment
+    #
+    # Parameters::
+    # * *iEnv* (_Symbol_): The environment
+    # * *iLstTracks* (<em>list<Integer></em>): The list of tracks being recorded
+    # Return::
+    # * _String_: Name of the Wave file
+    def getRecordedFileName(iEnv, iLstTracks)
+      return "#{getRecordedDir}/#{iEnv}.#{iLstTracks.sort.join('.')}.wav"
+    end
+
+    # Get the recorded silence file name on a given recording environment
+    #
+    # Parameters::
+    # * *iEnv* (_Symbol_): The environment
+    # Return::
+    # * _String_: Name of the Wave file
+    def getRecordedSilenceFileName(iEnv)
+      return "#{getRecordedDir}/#{iEnv}.Silence.wav"
+    end
+
+    # Get the recorded calibration file name, recording from a recording environment in order to be compared later with a reference environment.
+    #
+    # Parameters::
+    # * *iEnvReference* (_Symbol_): The reference environment
+    # * *iEnvRecording* (_Symbol_): The recording environment
+    # Return::
+    # * _String_: Name of the Wave file
+    def getRecordedCalibrationFileName(iEnvReference, iEnvRecording)
+      return "#{getRecordedDir}/Calibration.#{iEnvRecording}.#{iEnvReference}.wav"
+    end
+
+    # Get the calibrated recorded file name
+    #
+    # Parameters::
+    # * *iRecordedBaseName* (_String_): Base name of the recorded track
+    # Return::
+    # * _String_: Name of the Wave file
+    def getCalibratedFileName(iRecordedBaseName)
+      return "#{getCalibratedDir}/#{iRecordedBaseName}.Calibrated.wav"
+    end
+
+    # Get the name of a source wave file
+    #
+    # Parameters::
+    # * *iFileName* (_String_): Name of the Wave file used to generate this source wave file
+    # Return::
+    # * _String_: Name of the Wave file
+    def getWaveSourceFileName(iFileName)
+      if (File.exists?(iFileName))
+        # Use the original one
+        return iFileName
+      else
+        # We will generate a new one
+        return "#{getWaveDir}/#{File.basename(iFileName)}"
+      end
+    end
+
+    # Get the name of an analysis file taken from a recorded file
+    #
+    # Parameters::
+    # * *iBaseName* (_String_): Base name of the recorded file (without extension)
+    # Return::
+    # * _String_: The analysis file name
+    def getRecordedAnalysisFileName(iBaseName)
+      return "#{getAnalyzedRecordedDir}/#{iBaseName}.analyze"
+    end
+
+    # Get the name of a FFT profike file taken from a recorded file
+    #
+    # Parameters::
+    # * *iBaseName* (_String_): Base name of the recorded file (without extension)
+    # Return::
+    # * _String_: The FFT profile file name
+    def getRecordedFFTProfileFileName(iBaseName)
+      return "#{getAnalyzedRecordedDir}/#{iBaseName}.fftprofile"
+    end
+
+    # Get the name of the file generated after removing silences from it.
+    #
+    # Parameters::
+    # * *iBaseName* (_String_): Base name of the file
+    # Return::
+    # * _String_: The generated file name
+    def getSilenceRemovedFileName(iBaseName)
+      return "#{getCleanedDir}/#{iBaseName}.01.SilenceRemover.wav"
+    end
+
+    # Get the name of the file generated after applying a cut from it.
+    #
+    # Parameters::
+    # * *iBaseName* (_String_): Base name of the file
+    # * *iCutInfo* (<em>[String,String]</em>): The cut information, used to extract only a part of the file (begin and end markers, in seconds or samples)
+    # Return::
+    # * _String_: The generated file name
+    def getCutFileName(iBaseName, iCutInfo)
+      return "#{getCleanedDir}/#{iBaseName}.02.Cut.#{iCutInfo.join('_')}.wav"
+    end
+
+    # Get the name of the file generated after applying a DC remover from it.
+    #
+    # Parameters::
+    # * *iBaseName* (_String_): Base name of the file
+    # Return::
+    # * _String_: The generated file name
+    def getDCRemovedFileName(iBaseName)
+      return "#{getCleanedDir}/#{iBaseName}.03.DCShifter.wav"
+    end
+
+    # Get the name of the file generated after applying a noise gate from it.
+    #
+    # Parameters::
+    # * *iBaseName* (_String_): Base name of the file
+    # Return::
+    # * _String_: The generated file name
+    def getNoiseGateFileName(iBaseName)
+      return "#{getCleanedDir}/#{iBaseName}.04.NoiseGate.wav"
+    end
+
+    # Get the name of a file to processed
+    #
+    # Parameters::
+    # * *iDir* (_String_): Directory where to store the processed file
+    # * *iBaseName* (_String_): Base name of the processed file source
+    # * *iIdxProcess* (_Integer_): Index of the process
+    # * *iProcessName* (_String_): Name of the process to apply
+    # * *iProcessParams* (<em>map<Symbol,Object></em>): Process parameters
+    def getProcessedFileName(iDir, iBaseName, iIdxProcess, iProcessName, iProcessParams)
+      # If the base name contains already an ID, integrate it in the new ID
+      lMatch = iBaseName.match(/^(.*)\.([[:xdigit:]]{32,32})$/)
+      if (lMatch == nil)
+        return "#{iDir}/#{iBaseName}.#{iIdxProcess}.#{iProcessName}.#{iProcessParams.unique_id}.wav"
+      else
+        lNewBaseName = lMatch[1]
+        lNewProcessParams = {
+          :__InheritedID__ => lMatch[2]
+        }.merge(iProcessParams)
+        return "#{iDir}/#{lNewBaseName}.#{iIdxProcess}.#{iProcessName}.#{lNewProcessParams.unique_id}.wav"
+      end
+    end
+
+    # Get the name of a file to be mixed
+    #
+    # Parameters::
+    # * *iDir* (_String_): Directory where to store the mixed file
+    # * *iMixName* (_String_): Name of the mix
+    # * *iMixTracksConf* (<em>map<Symbol,Object></em>): Mix tracks' parameters
+    def getMixFileName(iDir, iMixName, iMixTracksConf)
+      return "#{iDir}/#{iMixName}.#{iMixTracksConf.unique_id}.wav"
+    end
+
+    # Get the name of a final mix file (the symbolic link)
+    #
+    # Parameters::
+    # * *iMixName* (_String_): Name of the mix
+    def getFinalMixFileName(iMixName)
+      return "#{getFinalMixDir}/#{iMixName}.wav"
+    end
+
+  end
+
+end

data/lib/MusicMaster/Formats/MP3.rb

@@ -0,0 +1,50 @@
+#--
+# Copyright (c) 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module MusicMaster
+
+  module Formats
+
+    class MP3
+
+      # Give the file extension
+      #
+      # Return::
+      # * _String_: The file extension (without .)
+      def getFileExt
+        return 'mp3'
+      end
+
+      # Deliver a file.
+      # The delivered file can be a shortcut to the source one.
+      #
+      # Parameters::
+      # * *iSrcFileName* (_String_): The source file to deliver from
+      # * *iDstFileName* (_String_): The destination file to be delivered
+      # * *iFormatConf* (<em>map<Symbol,Object></em>): The format configuration
+      # * *iMetadata* (<em>map<Symbol,Object></em>): The metadata that can be used while delivering the file
+      def deliver(iSrcFileName, iDstFileName, iFormatConf, iMetadata)
+        # TODO: Implement it using an external tool, and make regression testing
+        lTranslatedParams = []
+        iParams.each do |iParam, iValue|
+          case iParam
+          when :SampleRate
+            lTranslatedParams << "Sample rate: #{iValue} Hz"
+          when :BitRate
+            lTranslatedParams << "Bit rate: #{iValue} kbps"
+          else
+            log_warn "Unknown MP3 format parameter: #{iParam} (value #{iValue.inspect}). Ignoring it."
+          end
+        end
+        puts "Convert file #{iSrcFileName} into file #{iDstFileName} in MP3 format with following parameters: #{lTranslatedParams.join(', ')}"
+        puts 'Press Enter when done.'
+        $stdin.gets
+      end
+
+    end
+
+  end
+
+end

data/lib/MusicMaster/Formats/Test.rb

@@ -0,0 +1,44 @@
+#--
+# Copyright (c) 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module MusicMaster
+
+  module Formats
+
+    class Test
+
+      # Give the file extension
+      #
+      # Return::
+      # * _String_: The file extension (without .)
+      def getFileExt
+        return 'test.rb'
+      end
+
+      # Deliver a file.
+      # The delivered file can be a shortcut to the source one.
+      #
+      # Parameters::
+      # * *iSrcFileName* (_String_): The source file to deliver from
+      # * *iDstFileName* (_String_): The destination file to be delivered
+      # * *iFormatConf* (<em>map<Symbol,Object></em>): The format configuration
+      # * *iMetadata* (<em>map<Symbol,Object></em>): The metadata that can be used while delivering the file
+      def deliver(iSrcFileName, iDstFileName, iFormatConf, iMetadata)
+        log_debug "Deliver for test purposes file #{iDstFileName}"
+        File.open(iDstFileName, 'w') do |oFile|
+          oFile.write({
+            :SrcFileName => iSrcFileName,
+            :DstFileName => iDstFileName,
+            :FormatConf => iFormatConf,
+            :Metadata => iMetadata
+          }.inspect)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/MusicMaster/Formats/Wave.rb

@@ -0,0 +1,80 @@
+#--
+# Copyright (c) 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module MusicMaster
+
+  module Formats
+
+    # Wave file format.
+    # Take the following parameters:
+    # * *:Dither* (_Boolean_): Do we apply dither while converting ?
+    # * *:SampleRate* (_Integer_): Sample rate in Hz (ie 44100, 192000 ...)
+    # * *:BitDepth* (_Integer_): Number of bits used to encode 1 sample on 1 channel (ie 8, 16, 24...)
+    class Wave
+
+      # Give the file extension
+      #
+      # Return::
+      # * _String_: The file extension (without .)
+      def getFileExt
+        return 'wav'
+      end
+
+      # Deliver a file.
+      # The delivered file can be a shortcut to the source one.
+      #
+      # Parameters::
+      # * *iSrcFileName* (_String_): The source file to deliver from
+      # * *iDstFileName* (_String_): The destination file to be delivered
+      # * *iFormatConf* (<em>map<Symbol,Object></em>): The format configuration
+      # * *iMetadata* (<em>map<Symbol,Object></em>): The metadata that can be used while delivering the file
+      def deliver(iSrcFileName, iDstFileName, iFormatConf, iMetadata)
+        # Check if we can just make a shortcut
+        lShortcut = true
+        if (!iFormatConf.empty?)
+          if (iFormatConf[:Dither])
+            lShortcut = false
+          else
+            # Need to get the source file attributes (sample rate and bit depth)
+            require 'WSK/Common'
+            self.class.module_eval('include WSK::Common')
+            accessInputWaveFile(iSrcFileName) do |iHeader, iInputData|
+              lShortcut = !(((iFormatConf[:SampleRate] != nil) and
+                             (iFormatConf[:SampleRate] != iHeader.SampleRate)) or
+                            ((iFormatConf[:BitDepth] != nil) and
+                             (iFormatConf[:BitDepth] != iHeader.NbrBitsPerSample)))
+              next nil
+            end
+          end
+        end
+        if (lShortcut)
+          # Just create a shortcut
+          createShortcut(iSrcFileName, iDstFileName)
+        else
+          # We need to convert the Wave file: call SSRC
+          lTranslatedParams = [ '--profile standard', '--twopass' ]
+          iFormatConf.each do |iParam, iValue|
+            case iParam
+            when :SampleRate
+              lTranslatedParams << "--rate #{iValue}"
+            when :BitDepth
+              lTranslatedParams << "--bits #{iValue}"
+            when :Dither
+              lTranslatedParams << '--dither 4' if (iValue == true)
+            else
+              log_warn "Unknown Wave format parameter: #{iParam} (value #{iValue.inspect}). Ignoring it."
+            end
+          end
+          lCmd = "#{@MusicMasterConf[:Formats]['Wave'][:SRCCmdLine]} #{lTranslatedParams.sort.join(' ')} \"#{iSrcFileName}\" \"#{iDstFileName}\""
+          log_info "=> #{lCmd}"
+          raise "Error while executing SSRC command \"#{lCmd}\": error code #{$?.exitstatus}" if (!system(lCmd)) or ($?.exitstatus != 0)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/MusicMaster/Hash.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+#--
+# Copyright (c) 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require 'yaml'
+require 'digest/md5'
+
+class Hash
+
+  # Get a unique ID that will always be the same for any Hash having the same content
+  #
+  # Return::
+  # * _String_: The unique ID
+  def unique_id
+    return Digest::MD5.hexdigest(self.to_a.sort.to_yaml)
+  end
+
+end

data/lib/MusicMaster/Launcher.rb

@@ -0,0 +1,241 @@
+#--
+# Copyright (c) 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require 'fileutils'
+require 'optparse'
+require 'rUtilAnts/Logging'
+RUtilAnts::Logging::install_logger_on_object(:no_dialogs => true)
+require 'MusicMaster/Utils'
+require 'MusicMaster/FilesNamer'
+require 'MusicMaster/RakeProcesses'
+
+module MusicMaster
+
+  class Launcher
+
+    include MusicMaster::Utils
+
+    # Constructor
+    def initialize
+      parsePlugins
+      @DisplayHelp = false
+      @Debug = false
+
+      require 'optparse'
+      @Options = OptionParser.new
+      @Options.banner = "#{$0} [--help] [--debug] #{getOptionsBanner} <ConfigFile>"
+      @Options.on( '--help',
+        'Display help') do
+        @DisplayHelp = true
+      end
+      @Options.on( '--debug',
+        'Activate debug logs') do
+        @Debug = true
+      end
+      completeOptionParser(@Options)
+    end
+
+    # Execute the process
+    #
+    # Parameters::
+    # * *iArgs* (<em>list<String></em>): The list of arguments
+    # Return::
+    # * _Integer_: The error code
+    def execute(iArgs)
+      rErrorCode = 0
+
+      lError = nil
+      lConfFileName = nil
+      begin
+        lRemainingArgs = @Options.parse(iArgs)
+        if ((lRemainingArgs.size != 1) and
+            (!@DisplayHelp))
+          lError = RuntimeError.new("Please specify 1 config file (specified: \"#{lRemainingArgs.join(' ')}\")")
+        end
+        lConfFileName = lRemainingArgs.first
+      rescue Exception
+        lError = $!
+      end
+      if (lError == nil)
+        if (@DisplayHelp)
+          puts @Options
+        else
+          if (@Debug)
+            activate_log_debug(true)
+          end
+          # Read the MusicMaster configuration
+          begin
+            @MusicMasterConf = get_musicmaster_conf
+          rescue Exception
+            lError = $!
+          end
+          if (lError == nil)
+            # Read configuration
+            lError, lRecordConf = readConf(lConfFileName)
+            if (lError == nil)
+              # Check the conf. This is dependent on the process
+              lError = checkConf(lRecordConf)
+              if (lError == nil)
+                @RecordConf = lRecordConf
+                initialize_Utils
+                begin
+                  lRakeTarget = getRakeTarget
+                rescue
+                  lError = $!
+                end
+                if (lError == nil)
+                  if debug_activated?
+                    Rake::application.options.trace = true
+                    displayRakeTasks
+                  end
+                  begin
+                    Rake::Task[lRakeTarget].invoke
+                  rescue
+                    lError = $!
+                  end
+                  log_info 'Processed finished successfully.' if (lError == nil)
+                end
+              end
+            end
+          end
+        end
+      end
+      if (lError != nil)
+        log_err "#{lError}#{(debug_activated? and lError.backtrace) ? "\n#{lError.backtrace.join("\n")}" : ''}"
+        rErrorCode = 1
+      end
+
+      return rErrorCode
+    end
+
+    protected
+
+    # Give additional command line options banner
+    #
+    # Return::
+    # * _String_: Options banner
+    def getOptionsBanner
+      return ''
+    end
+
+    # Complete options with the specific ones of this binary
+    #
+    # Parameters::
+    # * *ioOptionParser* (_OptionParser_): The options parser to complete
+    def completeOptionParser(ioOptionParser)
+    end
+
+    # Check configuration.
+    #
+    # Parameters::
+    # * *iConf* (<em>map<Symbol,Object></em>): The configuration
+    # Return::
+    # * _Exception_: Error, or nil in case of success
+    def checkConf(iConf)
+      return nil
+    end
+
+    # Initialize Rake processes and return the task to be built
+    #
+    # Return::
+    # * _Symbol_: Rake target to execute
+    def getRakeTarget
+      return nil
+    end
+
+    private
+
+    include FilesNamer
+    include RakeProcesses
+    include Utils
+
+    # Get the global MusicMaster configuration
+    # Read it from:
+    # 1. The environment variable MUSICMASTER_CONF_PATH
+    # 2. The installed MusicMaster directory
+    # 3. The current directory
+    #
+    # Return::
+    # * <em>map<Symbol,Object></em>: The MusicMaster configuration
+    def get_musicmaster_conf
+      rMusicMasterConf = nil
+
+      lConfSource = nil
+      # 1. Find from the environment
+      lConfigFileName = ENV['MUSICMASTER_CONF_PATH']
+      if (lConfigFileName == nil)
+        # 2. Find from the MusicMaster directory
+        lConfigFileName = "#{File.dirname(__FILE__)}/musicmaster.conf.rb"
+        if (File.exists?(lConfigFileName))
+          lConfSource = 'MusicMaster package local libraries'
+        else
+          # 3. Find from the current directory
+          lConfigFileName = "musicmaster.conf.rb"
+          if (File.exists?(lConfigFileName))
+            lConfSource = 'current directory'
+          else
+            # 4. Failure
+          end
+        end
+      else
+        lConfSource = 'MUSICMASTER_CONF_PATH environment variable'
+      end
+
+      # Check the configuration
+      if (lConfSource == nil)
+        raise "No MusicMaster configuration file could be found. You can set it by setting MUSICMASTER_CONF_PATH environment variable, or create a musicmaster.conf.rb file either in #{File.dirname(__FILE__)} or the current directory."
+      else
+        if (File.exists?(lConfigFileName))
+          File.open(lConfigFileName, 'r') do |iFile|
+            begin
+              rMusicMasterConf = eval(iFile.read)
+            rescue Exception
+              raise "Invalid configuration file #{lConfigFileName} specified in #{lConfSource}: #{$!}"
+              rMusicMasterConf = nil
+            end
+          end
+        else
+          raise "Missing file #{lConfigFileName}, specified in #{lConfSource}"
+        end
+      end
+
+      return rMusicMasterConf
+    end
+
+    # Parse plugins
+    def parsePlugins
+      require 'rUtilAnts/Plugins'
+      RUtilAnts::Plugins::install_plugins_on_object
+      lLibDir = File.expand_path(File.dirname(__FILE__))
+      parse_plugins_from_dir('Processes', "#{lLibDir}/Processes", 'MusicMaster::Processes')
+      parse_plugins_from_dir('Formats', "#{lLibDir}/Formats", 'MusicMaster::Formats')
+    end
+
+    # Read configuration.
+    # Perform basic checks on it, independent of the process reading it.
+    #
+    # Parameters::
+    # * *iConfFile* (_String_): Configuration file
+    # Return::
+    # * _Exception_: Error, or nil in case of success
+    # * <em>map<Symbol,Object></em>: The configuration
+    def readConf(iConfFile)
+      rError = nil
+      rConf = nil
+
+      if (!File.exists?(iConfFile))
+        rError = RuntimeError.new("Missing configuration file: #{iConfFile}")
+      else
+        File.open(iConfFile, 'r') do |iFile|
+          rConf = eval(iFile.read)
+        end
+      end
+
+      return rError, rConf
+    end
+
+  end
+
+end