Modding talk:Audio - Revision history

imported>Margotbean: Text replacement - "tt>" to "samp>"

2021-11-04T18:48:20Z

Text replacement - "tt>" to "samp>"

← Older revision		Revision as of 18:48, 4 November 2021
Line 23:		Line 23:

	foreach (TrackInfo track in categoryGroup.OrderBy(p => p.Name).ThenBy(p => p.Index))		foreach (TrackInfo track in categoryGroup.OrderBy(p => p.Name).ThenBy(p => p.Index))
	output.AppendLine($"\|-\n\| <tt>{track.Name}</tt>\n\| <tt>{track.GetWavebankName()}</tt>\n\| <tt>{track.Index}</tt>\n\| data-sort-value=\"{track.Index}\"\| <tt>{track.GetSoundbankId()}</tt>\n\| ");		output.AppendLine($"\|-\n\| <samp>{track.Name}</samp>\n\| <samp>{track.GetWavebankName()}</samp>\n\| <samp>{track.Index}</samp>\n\| data-sort-value=\"{track.Index}\"\| <samp>{track.GetSoundbankId()}</samp>\n\| ");

	output.AppendLine("\|}");		output.AppendLine("\|}");
Line 148:		Line 148:
	\|-		\|-
	\| 1		\| 1
	\| <tt>Default</tt>		\| <samp>Default</samp>
	\| seems to be unused.		\| seems to be unused.
	\|-		\|-
	\| 2		\| 2
	\| <tt>Music</tt>		\| <samp>Music</samp>
	\|		\|
	\|-		\|-
	\| 3		\| 3
	\| <tt>Sound</tt>		\| <samp>Sound</samp>
	\|		\|
	\|-		\|-
	\| 4		\| 4
	\| <tt>Ambient</tt>		\| <samp>Ambient</samp>
	\| listed on the wiki as "Music (ambient)" just to group the music tracks.		\| listed on the wiki as "Music (ambient)" just to group the music tracks.
	\|-		\|-
	\| 5		\| 5
	\| <tt>Footsteps</tt>		\| <samp>Footsteps</samp>
	\|		\|
	\|}		\|}

	—<small>[[User:Pathoschild\|Pathoschild]] ([[User talk:Pathoschild\|talk]]) 05:21, 17 October 2021 (UTC)</small> (updated 00:12, 20 October 2021 (UTC))		—<small>[[User:Pathoschild\|Pathoschild]] ([[User talk:Pathoschild\|talk]]) 05:21, 17 October 2021 (UTC)</small> (updated 00:12, 20 October 2021 (UTC))

imported>Pathoschild: /* Track list export */ update for decimal index

2021-10-20T00:12:49Z

Track list export: update for decimal index

← Older revision		Revision as of 00:12, 20 October 2021
Line 1:		Line 1:
	==Track list export==		==Track list export==
	The initial track list was exported with this code, which can be run as a [[Modding:Modder Guide/Get Started\|C# mod]]:		The initial track list was exported with this code, which can be run as a [[Modding:Modder Guide/Get Started\|C# mod]] in Stardew Valley 1.5.5+:
	{{collapse\|source code\|content=<syntaxhighlight lang="c#">		{{collapse\|source code\|content=<syntaxhighlight lang="c#">
	/// <summary>The main entry point for the mod.</summary>		/// <summary>The main entry point for the mod.</summary>
Line 19:		Line 19:
	output.AppendLine($"==={categoryGroup.Key}===");		output.AppendLine($"==={categoryGroup.Key}===");
	output.AppendLine("{\| class=\"wikitable sortable\"");		output.AppendLine("{\| class=\"wikitable sortable\"");
	output.AppendLine("\|-\n! name\n! wavebank\n! soundbank ID\n! description");		output.AppendLine("\|-\n!rowspan=\"2\"\| name\n!rowspan=\"2\"\| wavebank\n!colspan=\"2\"\| soundbank index\n!rowspan=\"2\"\| description");
			output.AppendLine("\|-\n! decimal\n! hexadecimal");

	foreach (TrackInfo track in categoryGroup.OrderBy(p => p.Name).ThenBy(p => p.Index))		foreach (TrackInfo track in categoryGroup.OrderBy(p => p.Name).ThenBy(p => p.Index))
	output.AppendLine($"\|-\n\| <tt>{track.Name}</tt>\n\| <tt>{track.GetWavebankName()}</tt>\n\| data-sort-value=\"{track.Index}\"\| <tt>{track.GetSoundbankId()}</tt>\n\| ");		output.AppendLine($"\|-\n\| <tt>{track.Name}</tt>\n\| <tt>{track.GetWavebankName()}</tt>\n\| <tt>{track.Index}</tt>\n\| data-sort-value=\"{track.Index}\"\| <tt>{track.GetSoundbankId()}</tt>\n\| ");

	output.AppendLine("\|}");		output.AppendLine("\|}");
Line 167:		Line 168:
	\|}		\|}

	—<small>[[User:Pathoschild\|Pathoschild]] ([[User talk:Pathoschild\|talk]]) 05:21, 17 October 2021 (UTC)</small>		—<small>[[User:Pathoschild\|Pathoschild]] ([[User talk:Pathoschild\|talk]]) 05:21, 17 October 2021 (UTC)</small> (updated 00:12, 20 October 2021 (UTC))

imported>Pathoschild: /* Track list export */ update to export wavebank info

2021-10-17T05:21:44Z

Track list export: update to export wavebank info

Show changes

imported>Pathoschild: /* Track list export */ rework code a bit, add category info

2021-10-17T04:30:50Z

Track list export: rework code a bit, add category info

@@ Line 24: / Line 24: @@
+                 {
                      string soundIdLabel = sound.Id.ToString("X").ToLower().PadLeft(8, '0');
                      output.AppendLine($"|-\n| <tt>{sound.Name}</tt>\n| data-sort-value=\"{sound.Id}\"| <tt>{soundIdLabel}</tt>\n| ");
+                 }
@@ Line 50: / Line 51: @@
              foreach (XactSoundBankSound sound in entry.Value.sounds)
+             {
                  string name = entry.Key;
                  string category = this.GetCategoryName(sound.categoryID);
-                 // from variants
+                 // simple sound
                  if (sound.soundClips != null)
+                 {
                      foreach (XactClip clip in sound.soundClips)
+                     {
-                         foreach (var rawClipEvent in clip.clipEvents)
+                         foreach (ClipEvent rawClipEvent in clip.clipEvents)
+                         {
                              if (rawClipEvent is not PlayWaveEvent clipEvent)
@@ Line 71: / Line 82: @@
+                             }
-                             foreach (var variant in clipEvent.GetVariants())
+                             foreach (PlayWaveVariant variant in clipEvent.GetVariants())
+                             {
-                                 if (variant.track != 0)
+                                 hasVariants = true;
-                                     ids.Add(variant.track);
+                             }
+                         }
@@ Line 80: / Line 99: @@
+                 }
-                 // export tracks
+                 // invalid sound, should never happen
-                 if (ids.Any())
+                 if (!hasVariants)
+                     this.Monitor.Log($"Complex sound '{name}' unexpectedly has no variants.", LogLevel.Error);
+             }
+         }
@@ Line 130: / Line 130: @@
+}
 </syntaxhighlight>}}
-—<small>[[User:Pathoschild|Pathoschild]] ([[User talk:Pathoschild|talk]]) 03:22, 17 October 2021 (UTC)</small>

imported>Pathoschild: /* Track list export */ update code

2021-10-17T03:22:23Z

Track list export: update code

← Older revision		Revision as of 03:22, 17 October 2021
Line 24:		Line 24:
	{		{
	string soundIdLabel = sound.Id.ToString("X").ToLower().PadLeft(8, '0');		string soundIdLabel = sound.Id.ToString("X").ToLower().PadLeft(8, '0');
	output.AppendLine($"\|-\n\| <tt>{sound.Name}</tt>\n\| <tt>{soundIdLabel}</tt>\n\| ");		output.AppendLine($"\|-\n\| <tt>{sound.Name}</tt>\n\| data-sort-value=\"{sound.Id}\"\| <tt>{soundIdLabel}</tt>\n\| ");
	}		}

Line 81:		Line 81:

	// export tracks		// export tracks
	foreach (int id in ids)		if (ids.Any())
			{
			foreach (int id in ids)
			{
			yield return new SoundInfo
			{
			Category = category,
			Name = name,
			Id = id
			};
			}
			}
			else
	{		{
	yield return new SoundInfo		yield return new SoundInfo
Line 87:		Line 99:
	Category = category,		Category = category,
	Name = name,		Name = name,
	Id = id		Id = 0
	};		};
	}		}
Line 118:		Line 130:
	}		}
	</syntaxhighlight>}}		</syntaxhighlight>}}
	—<small>[[User:Pathoschild\|Pathoschild]] ([[User talk:Pathoschild\|talk]]) 02:18, 17 October 2021 (UTC)</small>		—<small>[[User:Pathoschild\|Pathoschild]] ([[User talk:Pathoschild\|talk]]) 03:22, 17 October 2021 (UTC)</small>

imported>Pathoschild: /* Track list export */ + sortable

2021-10-17T02:20:22Z

Track list export: + sortable

← Older revision		Revision as of 02:20, 17 October 2021
Line 18:		Line 18:
	{		{
	output.AppendLine($"==={categoryGroup.Key}===");		output.AppendLine($"==={categoryGroup.Key}===");
	output.AppendLine("{\| class=\"wikitable\"");		output.AppendLine("{\| class=\"wikitable sortable\"");
	output.AppendLine("\|-\n! name\n! soundbank ID\n! description");		output.AppendLine("\|-\n! name\n! soundbank ID\n! description");

imported>Pathoschild: + code for track list export

2021-10-17T02:19:00Z

+ code for track list export

New page

==Track list export==
The initial track list was exported with this quick code, which can be run as a [[Modding:Modder Guide/Get Started|C# mod]]:
{{collapse|source code|content=<syntaxhighlight lang="c#">
/// <summary>The main entry point for the mod.</summary>
public class ModEntry : Mod
{
/*********
** Public methods
*********/
/// <inheritdoc />
public override void Entry(IModHelper helper)
{
helper.Events.GameLoop.GameLaunched += (_, _) =>
{
StringBuilder output = new();

foreach (var categoryGroup in this.GetTracks().GroupBy(p => p.Category).OrderBy(p => p.Key))
{
output.AppendLine($"==={categoryGroup.Key}===");
output.AppendLine("{| class=\"wikitable\"");
output.AppendLine("|-\n! name\n! soundbank ID\n! description");

foreach (SoundInfo sound in categoryGroup.OrderBy(p => p.Name).ThenBy(p => p.Id))
{
string soundIdLabel = sound.Id.ToString("X").ToLower().PadLeft(8, '0');
output.AppendLine($"|-\n| <tt>{sound.Name}</tt>\n| <tt>{soundIdLabel}</tt>\n| ");
}

output.AppendLine("|}");
output.AppendLine();
}

string result = output.ToString();
this.Monitor.Log(result, LogLevel.Info);
};
}

/*********
** Private methods
*********/
/// <summary>Extract the music/sound tracks from the game's soundbank.</summary>
private IEnumerable<SoundInfo> GetTracks()
{
SoundBank soundBank = this.Helper.Reflection.GetField<SoundBank>(Game1.soundBank, "soundBank").GetValue();
Dictionary<string, CueDefinition> cues = this.Helper.Reflection.GetField<Dictionary<string, CueDefinition>>(soundBank, "_cues").GetValue();

foreach (var entry in cues)
{
foreach (XactSoundBankSound sound in entry.Value.sounds)
{
HashSet<int> ids = new();

// from main sound info
string name = entry.Key;
string category = this.GetCategoryName(sound.categoryID);
if (sound.trackIndex != 0)
ids.Add(sound.trackIndex);

// from variants
if (sound.soundClips != null)
{
foreach (XactClip clip in sound.soundClips)
{
foreach (var rawClipEvent in clip.clipEvents)
{
if (rawClipEvent is not PlayWaveEvent clipEvent)
{
this.Monitor.Log($"Unexpected clip event type '{rawClipEvent.GetType().FullName}'.", LogLevel.Error);
continue;
}

foreach (var variant in clipEvent.GetVariants())
{
if (variant.track != 0)
ids.Add(variant.track);
}
}
}
}

// export tracks
foreach (int id in ids)
{
yield return new SoundInfo
{
Category = category,
Name = name,
Id = id
};
}
}
}
}

/// <summary>Get a human-readable name for a raw audio category ID.</summary>
/// <param name="categoryId">The raw category ID.</param>
private string GetCategoryName(uint categoryId)
{
// the categories seem to be arbitrarily defined for Stardew Valley;
// these are approximate labels based on the tracks in each group.
return categoryId switch
{
2 => "Music",
3 => "Sound",
4 => "Music (ambient)",
5 => "Footsteps",
_ => categoryId.ToString()
};
}
}

public class SoundInfo
{
public string Category { get; set; }
public string Name { get; set; }
public int Id { get; set; }
}
</syntaxhighlight>}}
—<small>[[User:Pathoschild|Pathoschild]] ([[User talk:Pathoschild|talk]]) 02:18, 17 October 2021 (UTC)</small>