#12 Album Gain

Aural.xcodeproj/project.pbxproj

@@ -813,6 +813,7 @@
 		3E7E9F4C2C66B06F0011DE8E /* WaveformViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3E7E9F4B2C66B06F0011DE8E /* WaveformViewController.swift */; };
 		3E7E9F4E2C66B1AF0011DE8E /* WaveformWindowController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3E7E9F4D2C66B1AF0011DE8E /* WaveformWindowController.swift */; };
 		3E804D222C29F7840049AC27 /* GestureHandler.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3E804D212C29F7840049AC27 /* GestureHandler.swift */; };
+		3E8145C62C7A3850005BA9B9 /* AlbumReplayGain.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3E8145C52C7A3850005BA9B9 /* AlbumReplayGain.swift */; };
 		3E836E332868964D009371D4 /* PlayQueueContainer.xib in Resources */ = {isa = PBXBuildFile; fileRef = 3E836E322868964D009371D4 /* PlayQueueContainer.xib */; };
 		3E836E3B2868B9FD009371D4 /* UnifiedPlayerWindowController+EventHandling.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3E836E3A2868B9FD009371D4 /* UnifiedPlayerWindowController+EventHandling.swift */; };
 		3E86B5072C234A420097746A /* buildingLibrary.gif in Resources */ = {isa = PBXBuildFile; fileRef = 3E86B5062C234A420097746A /* buildingLibrary.gif */; };
@@ -1928,6 +1929,7 @@
 		3E7E9F4B2C66B06F0011DE8E /* WaveformViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WaveformViewController.swift; sourceTree = "<group>"; };
 		3E7E9F4D2C66B1AF0011DE8E /* WaveformWindowController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WaveformWindowController.swift; sourceTree = "<group>"; };
 		3E804D212C29F7840049AC27 /* GestureHandler.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GestureHandler.swift; sourceTree = "<group>"; };
+		3E8145C52C7A3850005BA9B9 /* AlbumReplayGain.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AlbumReplayGain.swift; sourceTree = "<group>"; };
 		3E836E322868964D009371D4 /* PlayQueueContainer.xib */ = {isa = PBXFileReference; lastKnownFileType = file.xib; path = PlayQueueContainer.xib; sourceTree = "<group>"; };
 		3E836E3A2868B9FD009371D4 /* UnifiedPlayerWindowController+EventHandling.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "UnifiedPlayerWindowController+EventHandling.swift"; sourceTree = "<group>"; };
 		3E86B5062C234A420097746A /* buildingLibrary.gif */ = {isa = PBXFileReference; lastKnownFileType = image.gif; path = buildingLibrary.gif; sourceTree = "<group>"; };
@@ -3015,6 +3017,7 @@
 				3E02175B2C23490E00865AC2 /* MetadataType.swift */,
 				3E02175C2C23490E00865AC2 /* PrimaryMetadata.swift */,
 				3E5701952C6EB16A007B8611 /* ReplayGain.swift */,
+				3E8145C52C7A3850005BA9B9 /* AlbumReplayGain.swift */,
 				3E02175D2C23490E00865AC2 /* Track.swift */,
 			);
 			path = Model;
@@ -6076,6 +6079,7 @@
 				3E02196D2C23490E00865AC2 /* PlaylistViewSelector.swift in Sources */,
 				3EAFB615267FF47200F0DC96 /* FilterBandSlider.swift in Sources */,
 				3EBF29292686947700D87021 /* FilterBandsTabButtonCell.swift in Sources */,
+				3E8145C62C7A3850005BA9B9 /* AlbumReplayGain.swift in Sources */,
 				3E6C127025CEBE0600BF0D07 /* FilterPresetBandsViewDelegate.swift in Sources */,
 				3E6C12E625CEBE8100BF0D07 /* FilterBandViewController.swift in Sources */,
 				3E0219322C23490E00865AC2 /* AudioInfo.swift in Sources */,
@@ -6708,6 +6712,7 @@
 				GCC_WARN_UNUSED_LABEL = YES;
 				GCC_WARN_UNUSED_PARAMETER = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
+				INFOPLIST_KEY_NSHumanReadableCopyright = "//  Copyright © 2024 Kartik Venugopal. All rights reserved.\n//\n//  This software is licensed under the MIT software license.\n//  See the file \"LICENSE\" in the project root directory for license terms.\n//";
 				MACOSX_DEPLOYMENT_TARGET = 10.12;
 				MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE;
 				MTL_FAST_MATH = YES;
@@ -6765,6 +6770,7 @@
 				GCC_WARN_UNUSED_LABEL = YES;
 				GCC_WARN_UNUSED_PARAMETER = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
+				INFOPLIST_KEY_NSHumanReadableCopyright = "//  Copyright © 2024 Kartik Venugopal. All rights reserved.\n//\n//  This software is licensed under the MIT software license.\n//  See the file \"LICENSE\" in the project root directory for license terms.\n//";
 				MACOSX_DEPLOYMENT_TARGET = 10.12;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				MTL_FAST_MATH = YES;
@@ -6793,6 +6799,7 @@
 				INFOPLIST_FILE = Info.plist;
 				INFOPLIST_KEY_CFBundleDisplayName = "Aural Player";
 				INFOPLIST_KEY_LSApplicationCategoryType = "public.app-category.music";
+				INFOPLIST_KEY_NSHumanReadableCopyright = "";
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/../Frameworks",
@@ -6830,6 +6837,7 @@
 				INFOPLIST_FILE = Info.plist;
 				INFOPLIST_KEY_CFBundleDisplayName = "Aural Player";
 				INFOPLIST_KEY_LSApplicationCategoryType = "public.app-category.music";
+				INFOPLIST_KEY_NSHumanReadableCopyright = "";
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/../Frameworks",

Aural.xcodeproj/xcuserdata/kven.xcuserdatad/IDETemplateMacros.plist

@@ -2,15 +2,15 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
-    <key>FILEHEADER</key>
-    <string>
-//  ___FILENAME___
-//  ___PACKAGENAME___
-//
-//  Copyright © 2021 Kartik Venugopal. All rights reserved.
-//
-//  This software is licensed under the MIT software license.
-//  See the file "LICENSE" in the project root directory for license terms.
-//  </string>
+	<key>FILEHEADER</key>
+	<string>
+// ___FILENAME___
+// Aural
+// 
+// Copyright © ___YEAR___ Kartik Venugopal. All rights reserved.
+// 
+// This software is licensed under the MIT software license.
+// See the file &quot;LICENSE&quot; in the project root directory for license terms.
+//</string>
 </dict>
-</plist>
+</plist>

Source/AppDelegate+Init.swift

@@ -104,12 +104,16 @@ extension AppDelegate {
         // (they are not referred to in code that is executed on app startup).
 
         //        _ = libraryDelegate
-        _ = mediaKeyHandler
-        _ = remoteControlManager
+        eagerlyInitializeObjects(mediaKeyHandler, remoteControlManager, replayGainScanner)
 
         WaveformView.initializeImageCache()
     }
 
+    ///
+    /// Does nothing ... simply referencing objects in the caller will cause them to be eagerly initialized.
+    ///
+    func eagerlyInitializeObjects(_ object: Any...) {}
+
     func beginPeriodicPersistence() {
 
         persistenceTaskExecutor = RepeatingTaskExecutor(intervalMillis: Self.persistenceTaskInterval * 1000,

Source/AppDelegate.swift

@@ -61,7 +61,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
     func applicationDidFinishLaunching(_ aNotification: Notification) {
 
         // Force eager loading of persistent state
-        _ = appPersistentState
+        eagerlyInitializeObjects(appPersistentState)
 
         if appSetup.setupRequired {
             performAppSetup()
@@ -79,7 +79,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
 //            fontSchemesManager.printNumObservers()
 //        }
     }
-    
+
     /// Opens the application with a single file (audio file or playlist)
     public func application(_ sender: NSApplication, openFile filename: String) -> Bool {
 

Source/Core/AudioGraph/CustomNodes/ReplayGainNode.swift

@@ -2,7 +2,7 @@
 //  ReplayGainNode.swift
 //  Aural
 //
-//  Copyright © 2021 Kartik Venugopal. All rights reserved.
+//  Copyright © 2024 Kartik Venugopal. All rights reserved.
 //
 //  This software is licensed under the MIT software license.
 //  See the file "LICENSE" in the project root directory for license terms.

Source/Core/AudioGraph/EffectsUnits/PresetsAndProfiles/ReplayGainPresets.swift

@@ -2,7 +2,7 @@
 //  ReplayGainPresets.swift
 //  Aural
 //
-//  Copyright © 2021 Kartik Venugopal. All rights reserved.
+//  Copyright © 2024 Kartik Venugopal. All rights reserved.
 //
 //  This software is licensed under the MIT software license.
 //  See the file "LICENSE" in the project root directory for license terms.

Source/Core/AudioGraph/EffectsUnits/ReplayGain/LoudnessScan/AVFReplayGainScanner.swift

@@ -44,7 +44,7 @@ class AVFReplayGainScanner: EBUR128LoudnessScannerProtocol {
         self.channelCount = audioFormat.channelCount
         self.sampleRate = audioFormat.sampleRate
 
-        ebur128 = try EBUR128State(channelCount: Int(channelCount), sampleRate: Int(sampleRate), mode: .samplePeak)
+        ebur128 = try EBUR128State(file: file, channelCount: Int(channelCount), sampleRate: Int(sampleRate), mode: .samplePeak)
 
         self.channelLayout = audioFormat.channelLayout ?? .defaultLayoutForChannelCount(channelCount)
 

Source/Core/AudioGraph/EffectsUnits/ReplayGain/LoudnessScan/FFmpegReplayGainScanner.swift

@@ -50,7 +50,7 @@ class FFmpegReplayGainScanner: EBUR128LoudnessScannerProtocol {
         sampleFormat = codec.sampleFormat.avFormat
         sampleRate = Int(codec.sampleRate)
 
-        ebur128 = try EBUR128State(channelCount: channelCount, sampleRate: sampleRate, mode: .samplePeak)
+        ebur128 = try EBUR128State(file: file, channelCount: channelCount, sampleRate: sampleRate, mode: .samplePeak)
 
         self.targetFormat = sampleFormat
 

Source/Core/AudioGraph/EffectsUnits/ReplayGain/LoudnessScan/ReplayGainAlbumScannerOperation.swift

@@ -2,7 +2,7 @@
 //  ReplayGainAlbumScannerOperation.swift
 //  Aural
 //
-//  Copyright © 2021 Kartik Venugopal. All rights reserved.
+//  Copyright © 2024 Kartik Venugopal. All rights reserved.
 //
 //  This software is licensed under the MIT software license.
 //  See the file "LICENSE" in the project root directory for license terms.
@@ -12,6 +12,8 @@ import Foundation
 
 class ReplayGainAlbumScannerOperation: Operation {
 
+    static let queue: OperationQueue = .init(opCount: System.numberOfActiveCores, qos: .userInitiated)
+
     let files: [URL]
 
     private var scanners: [EBUR128LoudnessScannerProtocol] = []
@@ -34,7 +36,7 @@ class ReplayGainAlbumScannerOperation: Operation {
     private var _isFinished = false
     override var isFinished: Bool {_isFinished}
 
-    init(files: [URL], completionHandler: @escaping (ReplayGainAlbumScannerOperation, EBUR128AlbumAnalysisResult?) -> Void) throws {
+    init(files: [URL], completionHandler: @escaping (ReplayGainAlbumScannerOperation, EBUR128AlbumAnalysisResult?) -> Void) {
 
         self.files = files
         self.completionHandler = completionHandler
@@ -67,13 +69,17 @@ class ReplayGainAlbumScannerOperation: Operation {
         // Do nothing if any of these flags is set.
         guard !isExecuting, !isFinished, !isCancelled else {return}
 
+        Self.queue.addOperations(dependencies, waitUntilFinished: true)
+
         // Update state for KVO.
         willChangeValue(forKey: "isExecuting")
         _isExecuting = true
         didChangeValue(forKey: "isExecuting")
 
         var result: EBUR128AlbumAnalysisResult? = nil
 
+        print("Starting album computation ... \(eburs.count) eburs, \(results.count) results")
+
         do {
             result = try EBUR128State.computeAlbumLoudnessAndPeak(with: eburs.array, andTrackResults: results.array)
         } catch {

Source/Core/AudioGraph/EffectsUnits/ReplayGain/LoudnessScan/ReplayGainScanner.swift

@@ -2,7 +2,7 @@
 //  ReplayGainScanner.swift
 //  Aural
 //
-//  Copyright © 2021 Kartik Venugopal. All rights reserved.
+//  Copyright © 2024 Kartik Venugopal. All rights reserved.
 //
 //  This software is licensed under the MIT software license.
 //  See the file "LICENSE" in the project root directory for license terms.
@@ -25,32 +25,43 @@ protocol EBUR128LoudnessScannerProtocol {
     var isCancelled: Bool {get}
 }
 
+typealias ReplayGainScanCompletionHandler = (ReplayGain?) -> Void
+
 class ReplayGainScanner {
 
-    let cache: ConcurrentMap<URL, EBUR128TrackAnalysisResult> = ConcurrentMap()
+    let trackGainCache: ConcurrentMap<URL, ReplayGain> = ConcurrentMap()
+    let albumGainCache: ConcurrentMap<String, AlbumReplayGain> = ConcurrentMap()
 
-    private var scanOp: ReplayGainTrackScannerOperation? = nil
+    private var scanOp: Operation? = nil
 
     init(persistentState: ReplayGainAnalysisCachePersistentState?) {
 
-        guard let cache = persistentState?.cache else {return}
+        if let trackGainCache = persistentState?.trackGainCache {
+
+            for (file, result) in trackGainCache {
+                self.trackGainCache[file] = result
+            }
+        }
 
-        for (file, result) in cache {
-            self.cache[file] = result
+        if let albumGainCache = persistentState?.albumGainCache {
+
+            for (albumName, result) in albumGainCache {
+                self.albumGainCache[albumName] = result
+            }
         }
 
-        print("ReplayGainScanner.init() read \(self.cache.count) cache entries")
+        print("ReplayGainScanner.init() read \(self.trackGainCache.count) trackGain cache entries and \(self.albumGainCache.count) albumGain cache entries.")
     }
 
-    func scan(forFile file: URL, _ completionHandler: @escaping (ReplayGain?) -> Void) {
+    func scanTrack(file: URL, _ completionHandler: @escaping ReplayGainScanCompletionHandler) {
 
         cancelOngoingScan()
 
         // First, check the cache
-        if let theResult = cache[file] {
+        if let theResult = trackGainCache[file] {
 
             // Cache hit
-            completionHandler(ReplayGain(ebur128AnalysisResult: theResult))
+            completionHandler(theResult)
             return
         }
 
@@ -65,8 +76,60 @@ class ReplayGainScanner {
             if let theResult = ebur128Result {
 
                 // Scan succeeded, cache the result
-                self?.cache[file] = theResult
-                completionHandler(ReplayGain(ebur128AnalysisResult: theResult))
+                let replayGain = ReplayGain(ebur128TrackAnalysisResult: theResult)
+                self?.trackGainCache[file] = replayGain
+                completionHandler(replayGain)
+
+            } else {
+
+                // Scan failed
+                completionHandler(nil)
+            }
+
+            self?.scanOp = nil
+        }
+
+        scanOp?.start()
+    }
+
+    func scanAlbum(named albumName: String, withFiles files: [URL], forFile file: URL, _ completionHandler: @escaping ReplayGainScanCompletionHandler) {
+
+        cancelOngoingScan()
+
+        // First, check the cache
+        if let theResult = albumGainCache[albumName], theResult.containsResultsForAllFiles(files), let trackResult = trackGainCache[file] {
+
+            // Cache hit
+            print("Album cache hit !!!")
+            completionHandler(trackResult)
+            return
+        }
+
+        // Cache miss, initiate a scan
+
+        print("\nScanning album '\(albumName)' with \(files.count) files: \(files.map {$0.lastPathComponent}) ...")
+
+        scanOp = ReplayGainAlbumScannerOperation(files: files) {[weak self] finishedScanOp, ebur128Result in
+
+            // A previously scheduled scan op may finish just before being cancelled. This check
+            // will prevent rogue completion handler execution.
+            guard self?.scanOp == finishedScanOp else {return}
+
+            if let theAlbumResult = ebur128Result {
+
+                for (trackFile, trackResult) in theAlbumResult.trackResults {
+
+                    self?.trackGainCache[trackFile] = ReplayGain(ebur128TrackAnalysisResult: trackResult,
+                                                                 ebur128AlbumAnalysisResult: theAlbumResult)
+                }
+
+                // Scan succeeded, cache the result
+                self?.albumGainCache[albumName] = AlbumReplayGain(albumName: albumName, files: files,
+                                                                  loudness: theAlbumResult.albumLoudness,
+                                                                  replayGain: theAlbumResult.albumReplayGain,
+                                                                  peak: theAlbumResult.albumPeak)
+
+                completionHandler(self?.trackGainCache[file])
 
             } else {
 
@@ -87,6 +150,6 @@ class ReplayGainScanner {
     }
 
     var persistentState: ReplayGainAnalysisCachePersistentState {
-        .init(cache: cache.map)
+        .init(trackGainCache: trackGainCache.map, albumGainCache: albumGainCache.map)
     }
 }

Source/Core/AudioGraph/EffectsUnits/ReplayGain/LoudnessScan/ReplayGainTrackScannerOperation.swift

@@ -2,7 +2,7 @@
 //  ReplayGainScannerOperation.swift
 //  Aural
 //
-//  Copyright © 2021 Kartik Venugopal. All rights reserved.
+//  Copyright © 2024 Kartik Venugopal. All rights reserved.
 //
 //  This software is licensed under the MIT software license.
 //  See the file "LICENSE" in the project root directory for license terms.

Source/Core/AudioGraph/EffectsUnits/ReplayGain/ReplayGainUnit.swift

@@ -2,7 +2,7 @@
 //  ReplayGainUnit.swift
 //  Aural
 //
-//  Copyright © 2021 Kartik Venugopal. All rights reserved.
+//  Copyright © 2024 Kartik Venugopal. All rights reserved.
 //
 //  This software is licensed under the MIT software license.
 //  See the file "LICENSE" in the project root directory for license terms.