MusicMaster 0.0.1.20101110 → 1.0.0.20120307

data/bin/Record.rb

@@ -1,141 +1,88 @@
 #!env ruby
 #--
-# Copyright (c) 2009-2010 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2009 - 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::initializeLogging('', '')
-require 'MusicMaster/Common'
-require 'MusicMaster/ConfLoader'
+require 'MusicMaster/Launcher'
 
 module MusicMaster
 
-  class Record
+  class Record < Launcher
 
-    # Constructor
-    def initialize
-      # List of perform partitions
-      # list< list< Integer > >
-      @LstPerforms = []
-      # List of patch tracks
-      # list< Integer >
-      @LstPatches = []
-      @WaveFiles = false
-      MusicMaster::parsePlugins
+    protected
+
+    # Give additional command line options banner
+    #
+    # Return::
+    # * _String_: Options banner
+    def getOptionsBanner
+      return '[--recordedfilesprepared] [--env <RecordingEnv>]*'
+    end
+
+    # Complete options with the specific ones of this binary
+    #
+    # Parameters::
+    # * *ioOptionParser* (_OptionParser_): The options parser to complete
+    def completeOptionParser(ioOptionParser)
+      @RecordedFilesPrepared = false
+      ioOptionParser.on( '--recordedfilesprepared',
+        'Recorded files are already prepared: no need to wait for user input while recording.') do
+        @RecordedFilesPrepared = true
+      end
+      @LstEnvToRecord = []
+      ioOptionParser.on( '--env <RecordingEnv>', String,
+        'Specify the recording environment to record. Can be used several times. If none specified, all environments will be recorded.') do |iArg|
+        @LstEnvToRecord << iArg.to_sym
+      end
     end
 
-    # Execute the recordings
+    # Check configuration.
     #
-    # Parameters:
-    # * *iArgs* (<em>list<String></em>): The list of arguments
-    # Return:
-    # * _Integer_: The error code
-    def execute(iArgs)
-      rErrorCode = 0
+    # Parameters::
+    # * *iConf* (<em>map<Symbol,Object></em>): The configuration
+    # Return::
+    # * _Exception_: Error, or nil in case of success
+    def checkConf(iConf)
+      rError = nil
 
-      lError = nil
-      # Read the arguments
-      if (iArgs.size != 1)
-        lError = RuntimeError.new('Usage: Record <ConfFile>')
-      else
-        # Read configuration
-        lError, lConf = MusicMaster::readRecordConf(iArgs[0])
-        if (lError == nil)
-          if (lConf[:Performs] != nil)
-            if (!lConf[:Performs].empty?)
-              # Record performances
-              lConf[:Performs].each do |iLstPerform|
-                puts "===== Record Perform partition #{iLstPerform.join(', ')} ====="
-                record("Perform.#{iLstPerform.join(' ')}.wav")
-              end
-              puts '===== Record Perform silence ====='
-              record('Perform.Silence.wav')
-            end
+      # Check that all tracks are assigned somewhere, just once
+      if ((iConf[:Recordings] != nil) and
+          (iConf[:Recordings][:Tracks] != nil))
+        lLstTracks = []
+        iConf[:Recordings][:Tracks].keys.each do |iLstTracks|
+          lLstTracks.concat(iLstTracks)
+        end
+        lAssignedTracks = {}
+        lLstTracks.each do |iIdxTrack|
+          if (lAssignedTracks.has_key?(iIdxTrack))
+            rError = RuntimeError.new("Track #{iIdxTrack} is recorded twice.")
+            break
+          else
+            lAssignedTracks[iIdxTrack] = nil
           end
-          if (lConf[:Patches] != nil)
-            lConf[:Patches].each do |iIdxTrack, iTrackConf|
-              # If the track has already a volume correction to be applied, ignore this step
-              if (iTrackConf[:VolCorrection] == nil)
-                puts "===== Record Perform volume preview for track #{iIdxTrack} ====="
-                record("Patch.#{iIdxTrack}.VolReference.wav")
-                puts "===== Measure the volume cuts from file Patch.#{iIdxTrack}.VolReference.wav and set them in the record conf file ====="
-                puts 'Enter when done.'
-                $stdin.gets
-              end
-            end
-            # Now we don't need anymore the volume setting for Perform.
-            lConf[:Patches].each do |iIdxTrack, iTrackConf|
-              lTryAgain = true
-              while (lTryAgain)
-                puts "===== Record the Patch track #{iIdxTrack} ====="
-                record("Patch.#{iIdxTrack}.wav")
-                puts 'Is the file correct ? (No peak limit reached ?) \'y\'=yes.'
-                lTryAgain = ($stdin.gets.chomp != 'y')
-              end
-              if (iTrackConf[:Effects] != nil)
-                MusicMaster::applyProcesses(iTrackConf[:Effects], "Patch.#{iIdxTrack}.wav", $MusicMasterConf[:Record][:TempDir])
-              end
-              puts "===== Record Patch silence for track #{iIdxTrack} ====="
-              record("Patch.#{iIdxTrack}.Silence.wav")
-              if (iTrackConf[:Effects] != nil)
-                MusicMaster::applyProcesses(iTrackConf[:Effects], "Patch.#{iIdxTrack}.Silence.wav", $MusicMasterConf[:Record][:TempDir])
-              end
-              if (iTrackConf[:VolCorrection] == nil)
-                puts "===== Record Patch volume preview for track #{iIdxTrack} ====="
-                record("Patch.#{iIdxTrack}.VolOriginal.wav")
-                if (iTrackConf[:Effects] != nil)
-                  MusicMaster::applyProcesses(iTrackConf[:Effects], "Patch.#{iIdxTrack}.VolOriginal.wav", $MusicMasterConf[:Record][:TempDir])
-                end
-              end
+        end
+        if (rError == nil)
+          lAssignedTracks.size.times do |iIdxTrack|
+            if (!lAssignedTracks.has_key?(iIdxTrack+1))
+              log_warn "Track #{iIdxTrack+1} is never recorded."
             end
           end
-          if (lConf[:WaveFiles])
-            puts '===== Generate Wave in Wave.*.wav files ====='
-            puts 'Press Enter to continue once done.'
-            $stdin.gets
-          end
-          logInfo 'Finished recording ok. Ready to use PrepareMix.rb and Mix.rb.'
         end
       end
-      if (lError != nil)
-        puts "!!! Error: #{lError}"
-        rErrorCode = 1
-      end
 
-      return rErrorCode
+      return rError
     end
 
-    # Record into a given file
+    # Initialize Rake processes and return the task to be built
     #
-    # Parameters:
-    # * *iFileName* (_String_): File name to record into
-    def record(iFileName)
-      lTryAgain = true
-      if (File.exists?(iFileName))
-        puts "File \"#{iFileName}\" already exists. Overwrite ? ['y' = yes]"
-        lTryAgain = ($stdin.gets.chomp == 'y')
-      end
-      while (lTryAgain)
-        puts "Record file \"#{iFileName}\""
-        puts 'Press Enter to continue once done. Type \'s\' to skip it.'
-        lSkip = ($stdin.gets.chomp == 's')
-        if (lSkip)
-          lTryAgain = false
-        else
-          # Get the last file that has been recorded
-          lFileName = $MusicMasterConf[:Record][:RecordedFileGetter].call
-          if (!File.exists?(lFileName))
-            logErr "File #{lFileName} does not exist. Could not get recorded file."
-          else
-            logInfo "Getting recorded file: #{lFileName} => #{iFileName}"
-            FileUtils::mv(lFileName, iFileName)
-            lTryAgain = false
-          end
-        end
-      end
+    # Return::
+    # * _Symbol_: Rake target to execute
+    def getRakeTarget
+      initialize_RakeProcesses(:RecordedFilesPrepared => @RecordedFilesPrepared, :LstEnvToRecord => @LstEnvToRecord)
+      generateRakeFor_GenerateSourceFiles
+
+      return :GenerateSourceFiles
     end
 
   end

data/bin/{Album.rb → old/Album.rb}

@@ -1,30 +1,30 @@
 #!env ruby
 #--
-# Copyright (c) 2009-2010 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
 require 'fileutils'
 require 'MusicMaster/Common'
 require 'rUtilAnts/Logging'
-RUtilAnts::Logging::initializeLogging('', '')
+RUtilAnts::Logging::install_logger_on_object
 require 'MusicMaster/ConfLoader'
 
 module MusicMaster
 
   # Execute the album
   #
-  # Parameters:
+  # Parameters::
   # * *iConf* (<em>map<Symbol,Object></em>): Configuration of the album
   def self.execute(iConf)
     lTracksDir = iConf[:TracksDir]
     if (!File.exists?(lTracksDir))
-      logErr "Missing directory #{lTracksDir}"
+      log_err "Missing directory #{lTracksDir}"
       raise RuntimeError.new("Missing directory #{lTracksDir}")
     else
       iConf[:Tracks].each_with_index do |iTrackInfo, iIdxTrack|
-        logInfo "===== Mastering Track #{iIdxTrack}: #{iTrackInfo[:TrackID]} version #{iTrackInfo[:Version]} ====="
-        lAlbumFile = "#{$MusicMasterConf[:Album][:Dir]}/#{iIdxTrack}_#{iTrackInfo[:TrackID]}.wav"
+        log_info "===== Mastering Track #{iIdxTrack}: #{iTrackInfo[:TrackID]} version #{iTrackInfo[:Version]} ====="
+        lAlbumFile = "#{@MusicMasterConf[:Album][:Dir]}/#{iIdxTrack}_#{iTrackInfo[:TrackID]}.wav"
         lCancel = false
         if (File.exists?(lAlbumFile))
           puts "File #{lAlbumFile} already exists. Overwrite it by mastering a new one ? [y='yes']"
@@ -32,26 +32,26 @@ module MusicMaster
         end
         if (!lCancel)
           # Find the last Master file for this Track
-          lMasterFiles = Dir.glob("#{lTracksDir}/#{iTrackInfo[:TrackID]}*/#{iTrackInfo[:Version]}/#{iConf[:TracksFilesSubDir]}#{$MusicMasterConf[:Master][:Dir]}/*.wav")
+          lMasterFiles = Dir.glob("#{lTracksDir}/#{iTrackInfo[:TrackID]}*/#{iTrackInfo[:Version]}/#{iConf[:TracksFilesSubDir]}#{@MusicMasterConf[:Master][:Dir]}/*.wav")
           if (lMasterFiles.empty?)
-            logErr "No Master files found for Track #{iTrackInfo[:TrackID]} version #{iTrackInfo[:Version]}"
+            log_err "No Master files found for Track #{iTrackInfo[:TrackID]} version #{iTrackInfo[:Version]}"
           else
             # Find the last one
             lFinalMasterFileName = lMasterFiles.sort[-1]
-            logInfo "Found final Master file from Track #{iTrackInfo[:TrackID]} version #{iTrackInfo[:Version]} in #{lFinalMasterFileName}"
+            log_info "Found final Master file from Track #{iTrackInfo[:TrackID]} version #{iTrackInfo[:Version]} in #{lFinalMasterFileName}"
             # Copy it
-            logInfo "Copying Master file to #{lAlbumFile} ..."
+            log_info "Copying Master file to #{lAlbumFile} ..."
             FileUtils::cp(lFinalMasterFileName, lAlbumFile)
             if (iTrackInfo[:AdditionalMastering] != nil)
-              lMasterTempDir = "#{$MusicMasterConf[:Album][:TempDir]}/#{iTrackInfo[:TrackID]}.#{iTrackInfo[:Version]}"
+              lMasterTempDir = "#{@MusicMasterConf[:Album][:TempDir]}/#{iTrackInfo[:TrackID]}.#{iTrackInfo[:Version]}"
               FileUtils::mkdir_p(lMasterTempDir)
               MusicMaster::applyProcesses(iTrackInfo[:AdditionalMastering], lAlbumFile, lMasterTempDir)
             end
             # Done.
-            logInfo "Setting file #{iIdxTrack} for Track #{iTrackInfo[:TrackID]} from #{lAlbumFile}"          
+            log_info "Setting file #{iIdxTrack} for Track #{iTrackInfo[:TrackID]} from #{lAlbumFile}"          
           end
         end
-        logInfo ''
+        log_info ''
       end
     end
   end
@@ -61,21 +61,21 @@ end
 rErrorCode = 0
 lConfFile = ARGV[0]
 if (lConfFile == nil)
-  logErr 'Usage: Album <ConfFile>'
+  log_err 'Usage: Album <ConfFile>'
   rErrorCode = 1
 elsif (!File.exists?(lConfFile))
-  logErr "File #{lConfFile} does not exist."
+  log_err "File #{lConfFile} does not exist."
   rErrorCode = 2
 else
   MusicMaster::parsePlugins
-  FileUtils::mkdir_p($MusicMasterConf[:Album][:Dir])
-  FileUtils::mkdir_p($MusicMasterConf[:Album][:TempDir])
+  FileUtils::mkdir_p(@MusicMasterConf[:Album][:Dir])
+  FileUtils::mkdir_p(@MusicMasterConf[:Album][:TempDir])
   lConf = nil
   File.open(lConfFile, 'r') do |iFile|
     lConf = eval(iFile.read)
   end
   MusicMaster::execute(lConf)
-  logInfo "===== Album finished in #{$MusicMasterConf[:Album][:Dir]}"
+  log_info "===== Album finished in #{@MusicMasterConf[:Album][:Dir]}"
 end
 
 exit rErrorCode

data/bin/{AnalyzeAlbum.rb → old/AnalyzeAlbum.rb}

@@ -1,32 +1,32 @@
 #!env ruby
 #--
-# Copyright (c) 2009-2010 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
 require 'fileutils'
 require 'MusicMaster/Common'
 require 'rUtilAnts/Logging'
-RUtilAnts::Logging::initializeLogging('', '')
+RUtilAnts::Logging::install_logger_on_object
 require 'MusicMaster/ConfLoader'
 
 module MusicMaster
 
   # Execute the album
   #
-  # Parameters:
+  # Parameters::
   # * *iConf* (<em>map<Symbol,Object></em>): Configuration of the album
   def self.execute(iConf)
     lTracksDir = iConf[:TracksDir]
     if (!File.exists?(lTracksDir))
-      logErr "Missing directory #{lTracksDir}"
+      log_err "Missing directory #{lTracksDir}"
       raise RuntimeError.new("Missing directory #{lTracksDir}")
     else
       # Analyze results, per Track
       lAnalyzeResults = []
       iConf[:Tracks].each_with_index do |iTrackInfo, iIdxTrack|
-        lTrackFileName = "#{$MusicMasterConf[:Album][:Dir]}/#{iIdxTrack}_#{iTrackInfo[:TrackID]}.wav"
-        MusicMaster::wsk(lTrackFileName, 'Dummy.wav', 'Analyze')
+        lTrackFileName = "#{@MusicMasterConf[:Album][:Dir]}/#{iIdxTrack}_#{iTrackInfo[:TrackID]}.wav"
+        wsk(lTrackFileName, 'Dummy.wav', 'Analyze')
         File.unlink('Dummy.wav')
         File.open('analyze.result', 'rb') do |iFile|
           lAnalyzeResults << Marshal.load(iFile.read)
@@ -34,13 +34,13 @@ module MusicMaster
         File.unlink('analyze.result')
       end
       # Display analyze results
-      logInfo ''
-      logInfo '===== Analyze results:'
+      log_info ''
+      log_info '===== Analyze results:'
       iConf[:Tracks].each_with_index do |iTrackInfo, iIdxTrack|
         lStrDBRMSValues = lAnalyzeResults[iIdxTrack][:DBRMSValues].map do |iValue|
           next sprintf('%.2f', iValue)
         end
-        logInfo "[#{iIdxTrack} - #{iTrackInfo[:TrackID]}]: RMS=(#{lStrDBRMSValues.join('db, ')}db) Max=#{sprintf('%.2f', lAnalyzeResults[iIdxTrack][:DBAbsMaxValue])}db Length=#{sprintf('%.2f', lAnalyzeResults[iIdxTrack][:DataLength])}s"
+        log_info "[#{iIdxTrack} - #{iTrackInfo[:TrackID]}]: RMS=(#{lStrDBRMSValues.join('db, ')}db) Max=#{sprintf('%.2f', lAnalyzeResults[iIdxTrack][:DBAbsMaxValue])}db Length=#{sprintf('%.2f', lAnalyzeResults[iIdxTrack][:DataLength])}s"
       end
     end
   end
@@ -50,10 +50,10 @@ end
 rErrorCode = 0
 lConfFile = ARGV[0]
 if (lConfFile == nil)
-  logErr 'Usage: AnalyzeAlbum <ConfFile>'
+  log_err 'Usage: AnalyzeAlbum <ConfFile>'
   rErrorCode = 1
 elsif (!File.exists?(lConfFile))
-  logErr "File #{lConfFile} does not exist."
+  log_err "File #{lConfFile} does not exist."
   rErrorCode = 2
 else
   lConf = nil

data/bin/{DeliverAlbum.rb → old/DeliverAlbum.rb}

@@ -1,35 +1,35 @@
 #!env ruby
 #--
-# Copyright (c) 2009-2010 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
 require 'MusicMaster/Common'
 require 'rUtilAnts/Logging'
-RUtilAnts::Logging::initializeLogging('', '')
+RUtilAnts::Logging::install_logger_on_object
 require 'MusicMaster/ConfLoader'
 
 module MusicMaster
 
   # Execute the delivery of the album
   #
-  # Parameters:
+  # Parameters::
   # * *iConf* (<em>map<Symbol,Object></em>): Configuration of the album
   def self.execute(iConf)
     lDeliveries = iConf[:Deliveries]
     if (lDeliveries == nil)
-      logWarn 'Configuration does not specify any delivery. Nothing to deliver.'
+      log_warn 'Configuration does not specify any delivery. Nothing to deliver.'
     else
       lTracksDir = iConf[:TracksDir]
       if (!File.exists?(lTracksDir))
-        logErr "Missing directory #{lTracksDir}"
+        log_err "Missing directory #{lTracksDir}"
         raise RuntimeError.new("Missing directory #{lTracksDir}")
       else
         iConf[:Tracks].each_with_index do |iTrackInfo, iIdxTrack|
           lBaseFileName = "#{iIdxTrack}_#{iTrackInfo[:TrackID]}"
-          lSourceFile = "#{$MusicMasterConf[:Album][:Dir]}/#{lBaseFileName}.wav"
+          lSourceFile = "#{@MusicMasterConf[:Album][:Dir]}/#{lBaseFileName}.wav"
           if (!File.exists?(lSourceFile))
-            logErr "Missing file #{lSourceFile}"
+            log_err "Missing file #{lSourceFile}"
           else
             lDeliveries.each do |iDeliveryName, iDeliveryConf|
               lExt = 'wav'
@@ -37,7 +37,7 @@ module MusicMaster
                   (iDeliveryConf[:FileFormat] == :MP3))
                 lExt = 'mp3'
               end
-              MusicMaster::src(lSourceFile, "#{$MusicMasterConf[:AlbumDeliver][:Dir]}/#{iDeliveryName}/#{lBaseFileName}.#{lExt}", iDeliveryConf)
+              MusicMaster::src(lSourceFile, "#{@MusicMasterConf[:AlbumDeliver][:Dir]}/#{iDeliveryName}/#{lBaseFileName}.#{lExt}", iDeliveryConf)
             end
           end
         end
@@ -50,19 +50,19 @@ end
 rErrorCode = 0
 lConfFile = ARGV[0]
 if (lConfFile == nil)
-  logErr 'Usage: DeliverAlbum <ConfFile>'
+  log_err 'Usage: DeliverAlbum <ConfFile>'
   rErrorCode = 1
 elsif (!File.exists?(lConfFile))
-  logErr "File #{lConfFile} does not exist."
+  log_err "File #{lConfFile} does not exist."
   rErrorCode = 2
 else
-  FileUtils::mkdir_p($MusicMasterConf[:AlbumDeliver][:Dir])
+  FileUtils::mkdir_p(@MusicMasterConf[:AlbumDeliver][:Dir])
   lConf = nil
   File.open(lConfFile, 'r') do |iFile|
     lConf = eval(iFile.read)
   end
   MusicMaster::execute(lConf)
-  logInfo "===== Album delivered in #{$MusicMasterConf[:AlbumDeliver][:Dir]}"
+  log_info "===== Album delivered in #{@MusicMasterConf[:AlbumDeliver][:Dir]}"
 end
 
 exit rErrorCode

data/bin/{Fct2Wave.rb → old/Fct2Wave.rb}

@@ -1,32 +1,32 @@
 #!env ruby
 #--
-# Copyright (c) 2009-2010 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
 require 'fileutils'
 require 'MusicMaster/Common'
 require 'rUtilAnts/Logging'
-RUtilAnts::Logging::initializeLogging('', '')
+RUtilAnts::Logging::install_logger_on_object
 require 'MusicMaster/ConfLoader'
 
 module MusicMaster
 
   # Execute the mastering
   #
-  # Parameters:
+  # Parameters::
   # * *iConf* (<em>map<Symbol,Object></em>): Configuration of the master
   # * *iWaveFile* (_String_): Wave file to master
-  # Return:
+  # Return::
   # * _String_: Name of the Wave file containing the result
   def self.execute(iConf, iWaveFile)
-    rWaveFileToProcess = "#{$MusicMasterConf[:Master][:Dir]}/#{File.basename(iWaveFile)}"
+    rWaveFileToProcess = "#{@MusicMasterConf[:Master][:Dir]}/#{File.basename(iWaveFile)}"
     
-    logInfo 'Copying Master file ...'
+    log_info 'Copying Master file ...'
     FileUtils::cp(iWaveFile, rWaveFileToProcess)
     # Execute each step of the mastering to the wave file
     if (iConf[:Mastering] != nil)
-      self.applyProcesses(iConf[:Mastering], rWaveFileToProcess, $MusicMasterConf[:Master][:Dir])
+      self.applyProcesses(iConf[:Mastering], rWaveFileToProcess, @MusicMasterConf[:Master][:Dir])
     end
 
     return rWaveFileToProcess
@@ -39,20 +39,20 @@ lFctFile, lInputWaveFile, lOutputWaveFile, lUnitDB = ARGV[0..4]
 if ((lFctFile == nil) or
     (lInputWaveFile == nil) or
     (lOutputWaveFile == nil))
-  logErr 'Usage: Master <FctFile> <InputWaveFile> <OutputWaveFile> [--unitdb]'
+  log_err 'Usage: Master <FctFile> <InputWaveFile> <OutputWaveFile> [--unitdb]'
   rErrorCode = 1
 elsif (!File.exists?(lFctFile))
-  logErr "File #{lFctFile} does not exist."
+  log_err "File #{lFctFile} does not exist."
   rErrorCode = 2
 elsif (!File.exists?(lInputWaveFile))
-  logErr "File #{lInputWaveFile} does not exist."
+  log_err "File #{lInputWaveFile} does not exist."
   rErrorCode = 3
 else
   lStrUnitDB = '0'
   if (lUnitDB == '--unitdb')
     lStrUnitDB = '1'
   end
-  MusicMaster::wsk(lInputWaveFile, lOutputWaveFile, 'DrawFct', "--function \"#{lFctFile}\" --unitdb #{lStrUnitDB}")
+  wsk(lInputWaveFile, lOutputWaveFile, 'DrawFct', "--function \"#{lFctFile}\" --unitdb #{lStrUnitDB}")
 end
 
 exit rErrorCode