Add option to adjust volume after msupcm++ generation

Author: MattEqualsCoder

MSUScripter/Configs/MsuSongMsuPcmInfo.cs

@@ -40,6 +40,12 @@ public class MsuSongMsuPcmInfo
     [Description("Normalize the current track to the specified RMS level, overrides the global normalization value")]
     public double? Normalization { get; set; }
 
+    [Description("Alter the volume after msupcm++ has generated the PCM file")]
+    public float? PostGenerateVolumeModifier { get; set; }
+    
+    [Description("If the volume modifier after msupcm++ generation should be adding decibels")]
+    public bool IsPostGenerateVolumeDecibels { get; set; }
+    
     [Description("Apply dynamic range compression to the current track")]
     public bool? Compression { get; set; }
 

MSUScripter/MSUScripter.csproj

@@ -8,7 +8,7 @@
     <AvaloniaUseCompiledBindingsByDefault>true</AvaloniaUseCompiledBindingsByDefault>
     <ApplicationIcon>MSUScripterIcon.ico</ApplicationIcon>
     <PackageIcon>MSUScripterIcon.ico</PackageIcon>
-    <Version>5.0.3</Version>
+    <Version>5.1.0-beta.1</Version>
     <RuntimeFrameworkVersion>9.0.0</RuntimeFrameworkVersion>
     <IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion>
     <LangVersion>12</LangVersion>

MSUScripter/Models/MsuProjectGenerationCache.cs

@@ -10,15 +10,20 @@ public class MsuProjectGenerationCache
 
 public class MsuProjectSongCache
 {
+    public const int CurrentCacheVersion = 1;
     public ulong JsonHash { get; init; }
     public int JsonLength { get; init; }
     public DateTime FileGenerationTime { get; init; }
     public long FileLength { get; init; }
+    public int? CacheVersion { get; init; }
+    public float PostGenerateVolumeModifier { get; init; }
+    public bool IsPostGenerateVolumeDecibels { get; init; }
 
     public static bool IsValid(MsuProjectSongCache? a, MsuProjectSongCache? b)
     {
         if (a is null || b is null) return false;
         return a.JsonHash == b.JsonHash && a.JsonLength == b.JsonLength &&
-               a.FileGenerationTime == b.FileGenerationTime & a.FileLength == b.FileLength;
+               a.FileGenerationTime == b.FileGenerationTime & a.FileLength == b.FileLength && a.CacheVersion == b.CacheVersion &&
+               Math.Abs(a.PostGenerateVolumeModifier - b.PostGenerateVolumeModifier) < 0.01 &&  a.IsPostGenerateVolumeDecibels == b.IsPostGenerateVolumeDecibels;
     }
 }

MSUScripter/Program.cs

@@ -121,6 +121,7 @@ private static IServiceCollection ConfigureServices(IServiceCollection collectio
             .AddSingleton<StatusBarService>()
             .AddSingleton<PythonCompanionService>()
             .AddSingleton<DependencyInstallerService>()
+            .AddSingleton<PcmModifierService>()
             .AddAvaloniaControlServices<Program>()
             .AddTransient<ApplicationInitializationService>();
 

MSUScripter/Services/MsuPcmService.cs

@@ -43,7 +43,8 @@ public class MsuPcmService(
     ConverterService converterService,
     YamlService yamlService,
     IAudioPlayerService audioPlayerService,
-    DependencyInstallerService dependencyInstallerService)
+    DependencyInstallerService dependencyInstallerService,
+    PcmModifierService pcmModifierService)
 {
     private string _cacheFolder2 = "";
     private string _msuPcmPath = string.Empty;
@@ -212,7 +213,7 @@ public async Task<GeneratePcmFileResponse> CreatePcm(MsuProject project, MsuSong
         }
 
         project.GenerationCache.Songs.TryGetValue(song.Id, out var previousCache);
-        var currentCache = cacheResults ? GetSongCacheData(jsonResponse.JsonText, outputPath) : null;
+        var currentCache = cacheResults ? GetSongCacheData(jsonResponse.JsonText, outputPath, song) : null;
 
         if (MsuProjectSongCache.IsValid(previousCache, currentCache))
         {
@@ -272,8 +273,17 @@ public async Task<GeneratePcmFileResponse> CreatePcm(MsuProject project, MsuSong
                     Directory.CreateDirectory(directory);
                 }
 
-                logger.LogInformation("Moving generated PCM to {Path}", outputPath);
-                File.Move(tempPcmPath, outputPath);
+                if (song.MsuPcmInfo.PostGenerateVolumeModifier is >= .01f or <= -.01f)
+                {
+                    logger.LogInformation("Modifying PCM file and copying to {Path}", outputPath);
+                    pcmModifierService.UpdatePcmFile(tempPcmPath, outputPath, song);
+                }
+                else
+                {
+                    logger.LogInformation("Moving generated PCM to {Path}", outputPath);
+                    File.Move(tempPcmPath, outputPath);
+                }
+                
             }
             catch (Exception ex)
             {
@@ -287,7 +297,7 @@ public async Task<GeneratePcmFileResponse> CreatePcm(MsuProject project, MsuSong
         // Move to the cache
         if (cacheResults)
         {
-            currentCache = GetSongCacheData(jsonResponse.JsonText, outputPath);
+            currentCache = GetSongCacheData(jsonResponse.JsonText, outputPath, song);
 
             if (currentCache != null)
             {
@@ -337,7 +347,7 @@ public void SaveGenerationCache(MsuProject project)
         }
     }
 
-    private MsuProjectSongCache? GetSongCacheData(string json, string outputPath)
+    private MsuProjectSongCache? GetSongCacheData(string json, string outputPath, MsuSongInfo song)
     {
         if (!File.Exists(outputPath))
         {
@@ -353,6 +363,9 @@ public void SaveGenerationCache(MsuProject project)
             JsonLength = json.Length,
             FileGenerationTime = fileInfo.LastWriteTime,
             FileLength = fileInfo.Length,
+            CacheVersion = MsuProjectSongCache.CurrentCacheVersion,
+            PostGenerateVolumeModifier = song.MsuPcmInfo.PostGenerateVolumeModifier ?? 0,
+            IsPostGenerateVolumeDecibels = song.MsuPcmInfo.IsPostGenerateVolumeDecibels,
         };
     }
 

MSUScripter/Services/PcmModifierService.cs

@@ -0,0 +1,60 @@
+using System;
+using System.IO;
+using System.Linq;
+using MSUScripter.Configs;
+using NAudio.Wave;
+using NAudio.Wave.SampleProviders;
+
+namespace MSUScripter.Services;
+
+public class PcmModifierService
+{
+    public void UpdatePcmFile(string tempFile, string outFile, MsuSongInfo song)
+    {
+        var volumeMultiplier = song.MsuPcmInfo.IsPostGenerateVolumeDecibels
+            ? MathF.Pow(10, song.MsuPcmInfo.PostGenerateVolumeModifier!.Value / 20f)
+            : song.MsuPcmInfo.PostGenerateVolumeModifier!.Value / 100f;
+
+        var waveFormat = new WaveFormat(
+            rate: 44100,
+            bits: 16,
+            channels: 2
+        );
+
+        using var inputStream = File.OpenRead(tempFile);
+
+        // Get the bytes for looping
+        var headerBytes = new byte[8];
+        inputStream.ReadExactly(headerBytes, 0, 8);
+        inputStream.Position = 0;
+        
+        // Load the source, convert to samples, apply modifiers, and convert back to PCM
+        using var rawSource = new RawSourceWaveStream(inputStream, waveFormat);
+        var sampleProvider = rawSource.ToSampleProvider();
+        var volumeProvider = new VolumeSampleProvider(sampleProvider)
+        {
+            Volume = volumeMultiplier
+        };
+        var pcm16Provider = new SampleToWaveProvider16(volumeProvider);
+
+        using var outputStream = File.Create(outFile);
+        var buffer = new byte[4096];
+        int bytesRead;
+        var isFirstRead = true;
+        
+        // Write the modified stream to file, using the previous first 8 bytes
+        while ((bytesRead = pcm16Provider.Read(buffer, 0, buffer.Length)) > 0)
+        {
+            if (isFirstRead)
+            {
+                isFirstRead = false;
+                outputStream.Write(headerBytes, 0, 8);
+                outputStream.Write(buffer.Skip(8).ToArray(), 0, bytesRead - 8);
+            }
+            else
+            {
+                outputStream.Write(buffer, 0, bytesRead);
+            }
+        }
+    }
+}

MSUScripter/Text/ApplicationText.cs

@@ -123,6 +123,8 @@ public static void SetLanguage(ApplicationText newLanguage)
     public string MsuPcmTempoToolTip { get; } = "Alter the tempo of the current track by a specified ratio.";
     public string MsuPcmCompressionLabel { get; } = "Compression";
     public string MsuPcmCompressionToolTip { get; } = "Apply dynamic range compression to the current track. Helps to minimize very loud and very quiet portions of the track.";
+    public string PostGenerationVolumeLabel { get; } = "Post Generation Volume Modifier";
+    public string PostGenerationVolumeToolTip { get; } = "Alter the volume after MsuPcm++ has generated the PCM file. If set, anyone generating the PCM themselves with MsuPcm++ via the tracks json file will not see these changes.";
     public string MsuPcmDitherLabel { get; } = "Dither";
     public string MsuPcmDitherToolTip { get; } = "Whether or not to apply audio dither to the final output. If set, overrides the default value.";
 

MSUScripter/ViewModels/MsuSongAdvancedPanelViewModel.cs

@@ -55,6 +55,8 @@ public class MsuSongAdvancedPanelViewModel : SavableViewModelBase
     [Reactive] public double? Normalization { get; set; }
 
     [Reactive] public bool? Compression { get; set; }
+    [Reactive] public float? PostGenerateVolumeModifier { get; set; }
+    [Reactive] public bool IsPostGenerateVolumeDecibels { get; set; }
 
     [Reactive] public bool? Dither { get; set; }
     [Reactive] public bool ShowDither { get; set; }
@@ -272,6 +274,8 @@ public void SetSelectedTreeData(MsuSongAdvancedPanelViewModelModelTreeData treeD
         Tempo = treeData.MsuPcmInfo.Tempo;
         Normalization = treeData.MsuPcmInfo.Normalization;
         Compression = treeData.MsuPcmInfo.Compression;
+        PostGenerateVolumeModifier = treeData.MsuPcmInfo.PostGenerateVolumeModifier;
+        IsPostGenerateVolumeDecibels = treeData.MsuPcmInfo.IsPostGenerateVolumeDecibels;
         _isTopLevelMsuPcmInfo = treeData.ParentIndex < 0;
         if (_isTopLevelMsuPcmInfo)
         {
@@ -312,6 +316,8 @@ public override void SaveChanges()
         _currentSongMsuPcmInfo.Tempo = Tempo;
         _currentSongMsuPcmInfo.Normalization = Normalization;
         _currentSongMsuPcmInfo.Compression = Compression;
+        _currentSongMsuPcmInfo.PostGenerateVolumeModifier = PostGenerateVolumeModifier;
+        _currentSongMsuPcmInfo.IsPostGenerateVolumeDecibels = IsPostGenerateVolumeDecibels;
         _currentSongMsuPcmInfo.Dither = Dither;
 
         if (_isTopLevelMsuPcmInfo)

MSUScripter/Views/MsuSongAdvancedPanel.axaml

@@ -478,29 +478,60 @@
                     <views:FormLabel 
                         Grid.Column="0" 
                         Grid.Row="12" 
+                        Grid.ColumnSpan="3"
                         Margin="0 8 3 2"
                         LabelText="{Binding Text.MsuPcmNormalizationLabel}"
                         ToolTipText="{Binding Text.MsuPcmNormalizationToolTip}"
                     />
                     <controls:NumericUpDownNoScroll 
                         Grid.Row="13" 
                         Grid.Column="0" 
-                        Grid.ColumnSpan="2"
+                        Grid.ColumnSpan="3"
                         Margin="0 0 3 0"
                         Value="{Binding Normalization}"
                     />
 
+                    <!-- Post Generation Volume -->
+                    <views:FormLabel 
+                        Grid.Column="3" 
+                        Grid.Row="12" 
+                        Grid.ColumnSpan="3"
+                        Margin="3 8 0 2"
+                        LabelText="{Binding Text.PostGenerationVolumeLabel}"
+                        ToolTipText="{Binding Text.PostGenerationVolumeToolTip}"
+                    />
+                    <Grid 
+                        Grid.Row="13" 
+                        Grid.Column="3" 
+                        Grid.ColumnSpan="3" 
+                        ColumnDefinitions="*, Auto"
+                    >
+                        <controls:NumericUpDownNoScroll 
+                            Grid.Column="0"
+                            Margin="3 0 3 0"
+                            Value="{Binding PostGenerateVolumeModifier}"
+                        />
+                        <controls:BoolComboBox 
+                            Grid.Column="1" 
+                            TrueDisplayText="Db"
+                            FalseDisplayText="%"
+                            Value="{Binding IsPostGenerateVolumeDecibels}"
+                            Width="50"
+                        />
+                    </Grid>
+                    
                     <!-- Tempo -->
                     <views:FormLabel 
-                        Grid.Column="2"
-                        Grid.Row="12"
+                        Grid.Column="0"
+                        Grid.Row="14"
+                        Grid.ColumnSpan="2"
                         Margin="3 8 3 2"
                         LabelText="{Binding Text.MsuPcmTempoLabel}"
                         ToolTipText="{Binding Text.MsuPcmTempoToolTip}"
                     />
                     <controls:NumericUpDownNoScroll 
-                        Grid.Row="13" 
-                        Grid.Column="2" 
+                        Grid.Row="15" 
+                        Grid.Column="0" 
                         Grid.ColumnSpan="2"
                         Margin="3 0 3 0"
                         Value="{Binding Tempo}"
@@ -509,36 +540,37 @@
 
                     <!-- Compression -->
                     <views:FormLabel 
-                        Grid.Column="4" 
-                        Grid.Row="12" 
-                        Margin="3 8 0 2"
+                        Grid.Column="2" 
+                        Grid.Row="14"
+                        Grid.ColumnSpan="2"
+                        Margin="3 8 3 2"
                         LabelText="{Binding Text.MsuPcmCompressionLabel}"
                         ToolTipText="{Binding Text.MsuPcmCompressionToolTip}"
                     />
                     <controls:BoolComboBox 
-                        Grid.Row="13" 
-                        Grid.Column="4" 
+                        Grid.Row="15" 
+                        Grid.Column="2" 
                         Grid.ColumnSpan="2"
-                        Margin="3 0 0 0"
+                        Margin="3 0 3 0"
                         Value="{Binding Compression, Mode=TwoWay}"
                         AllowNulls="True"
                     ></controls:BoolComboBox>
 
-                    <!-- Compression -->
+                    <!-- Dither -->
                     <views:FormLabel 
-                        Grid.Column="0" 
+                        Grid.Column="4" 
                         Grid.Row="14" 
-                        Margin="0 8 3 2"
-                        IsVisible="{Binding ShowDither}"
+                        Grid.ColumnSpan="2"
+                        Margin="3 8 0 2"
                         LabelText="{Binding Text.MsuPcmDitherLabel}"
                         ToolTipText="{Binding Text.MsuPcmDitherToolTip}"
                     />
                     <controls:BoolComboBox 
                         Grid.Row="15" 
-                        Grid.Column="0" 
-                        Grid.ColumnSpan="3"
-                        Margin="0 0 3 0"
-                        IsVisible="{Binding ShowDither}"
+                        Grid.Column="4" 
+                        Grid.ColumnSpan="2"
+                        Margin="3 0 0 0"
+                        IsEnabled="{Binding ShowDither}"
                         Value="{Binding Dither, Mode=TwoWay}"
                         AllowNulls="True"
                     ></controls:BoolComboBox>