internal AudioCategory(AudioEngine audioEngine, string name, BinaryReader reader)
{
Debug.Assert(audioEngine != null);
Debug.Assert(!string.IsNullOrEmpty(name));
_sounds = new List <XactSound>();
Name = name;
_engine = audioEngine;
maxInstances = reader.ReadByte();
instanceLimit = maxInstances != 0xff;
fadeIn = reader.ReadUInt16() / 1000f;
fadeOut = reader.ReadUInt16() / 1000f;
byte instanceFlags = reader.ReadByte();
fadeType = (CrossfadeType)(instanceFlags & 0x7);
InstanceBehavior = (MaxInstanceBehavior)(instanceFlags >> 3);
reader.ReadUInt16(); //unkn
Volume = XactHelpers.ParseVolumeFromDecibels(reader.ReadByte());
byte visibilityFlags = reader.ReadByte();
isBackgroundMusic = (visibilityFlags & 0x1) != 0;
isPublic = (visibilityFlags & 0x2) != 0;
}
public XactClip(SoundBank soundBank, BinaryReader clipReader, bool useReverb)
{
State = SoundState.Stopped;
UseReverb = useReverb;
var volumeDb = XactHelpers.ParseDecibels(clipReader.ReadByte());
_defaultVolume = XactHelpers.ParseVolumeFromDecibels(volumeDb);
var clipOffset = clipReader.ReadUInt32();
// Read the filter info.
var filterQAndFlags = clipReader.ReadUInt16();
FilterEnabled = (filterQAndFlags & 1) == 1;
FilterMode = (FilterMode)((filterQAndFlags >> 1) & 3);
FilterQ = (filterQAndFlags >> 3) * 0.01f;
FilterFrequency = clipReader.ReadUInt16();
var oldPosition = clipReader.BaseStream.Position;
clipReader.BaseStream.Seek(clipOffset, SeekOrigin.Begin);
var numEvents = clipReader.ReadByte();
_events = new ClipEvent[numEvents];
for (var i = 0; i < numEvents; i++)
{
var eventInfo = clipReader.ReadUInt32();
var randomOffset = clipReader.ReadUInt16() * 0.001f;
// TODO: eventInfo still has 11 bits that are unknown!
var eventId = eventInfo & 0x1F;
var timeStamp = ((eventInfo >> 5) & 0xFFFF) * 0.001f;
_ = eventInfo >> 21;
switch (eventId)
{
case 0:
// Stop Event
throw new NotImplementedException("Stop event");
case 1:
{
// Unknown!
clipReader.ReadByte();
// Event flags
var eventFlags = clipReader.ReadByte();
_ = (eventFlags & 0x01) == 0x01;
_ = (eventFlags & 0x02) == 0x02;
_ = (eventFlags & 0x04) == 0x04;
int trackIndex = clipReader.ReadUInt16();
int waveBankIndex = clipReader.ReadByte();
var loopCount = clipReader.ReadByte();
_ = clipReader.ReadUInt16() / 100f;
_ = clipReader.ReadUInt16() / 100f;
_events[i] = new PlayWaveEvent(
this,
timeStamp,
randomOffset,
soundBank,
new[] { waveBankIndex },
new[] { trackIndex },
null,
0,
VariationType.Ordered,
null,
null,
null,
loopCount,
false);
break;
}
case 3:
{
// Unknown!
clipReader.ReadByte();
// Event flags
var eventFlags = clipReader.ReadByte();
_ = (eventFlags & 0x01) == 0x01;
_ = (eventFlags & 0x02) == 0x02;
_ = (eventFlags & 0x04) == 0x04;
var loopCount = clipReader.ReadByte();
_ = clipReader.ReadUInt16() / 100f;
_ = clipReader.ReadUInt16() / 100f;
// The number of tracks for the variations.
var numTracks = clipReader.ReadUInt16();
// Not sure what most of this is.
var moreFlags = clipReader.ReadByte();
var newWaveOnLoop = (moreFlags & 0x40) == 0x40;
// The variation playlist type seems to be
// stored in the bottom 4bits only.
var variationType = (VariationType)(moreFlags & 0x0F);
// Unknown!
clipReader.ReadBytes(5);
// Read in the variation playlist.
var waveBanks = new int[numTracks];
var tracks = new int[numTracks];
var weights = new byte[numTracks];
var totalWeights = 0;
for (var j = 0; j < numTracks; j++)
{
tracks[j] = clipReader.ReadUInt16();
waveBanks[j] = clipReader.ReadByte();
var minWeight = clipReader.ReadByte();
var maxWeight = clipReader.ReadByte();
weights[j] = (byte)(maxWeight - minWeight);
totalWeights += weights[j];
}
_events[i] = new PlayWaveEvent(
this,
timeStamp,
randomOffset,
soundBank,
waveBanks,
tracks,
weights,
totalWeights,
variationType,
null,
null,
null,
loopCount,
newWaveOnLoop);
break;
}
case 4:
{
// Unknown!
clipReader.ReadByte();
// Event flags
var eventFlags = clipReader.ReadByte();
_ = (eventFlags & 0x01) == 0x01;
_ = (eventFlags & 0x02) == 0x02;
_ = (eventFlags & 0x04) == 0x04;
int trackIndex = clipReader.ReadUInt16();
int waveBankIndex = clipReader.ReadByte();
var loopCount = clipReader.ReadByte();
_ = clipReader.ReadUInt16() / 100f;
_ = clipReader.ReadUInt16() / 100f;
// Pitch variation range
var minPitch = clipReader.ReadInt16() / 1000f;
var maxPitch = clipReader.ReadInt16() / 1000f;
// Volume variation range
var minVolume = XactHelpers.ParseVolumeFromDecibels(clipReader.ReadByte());
var maxVolume = XactHelpers.ParseVolumeFromDecibels(clipReader.ReadByte());
// Filter variation
var minFrequency = clipReader.ReadSingle();
var maxFrequency = clipReader.ReadSingle();
var minQ = clipReader.ReadSingle();
var maxQ = clipReader.ReadSingle();
// Unknown!
clipReader.ReadByte();
var variationFlags = clipReader.ReadByte();
// Enable pitch variation
Vector2?pitchVar = null;
if ((variationFlags & 0x10) == 0x10)
{
pitchVar = new Vector2(minPitch, maxPitch - minPitch);
}
// Enable volume variation
Vector2?volumeVar = null;
if ((variationFlags & 0x20) == 0x20)
{
volumeVar = new Vector2(minVolume, maxVolume - minVolume);
}
// Enable filter variation
Vector4?filterVar = null;
if ((variationFlags & 0x40) == 0x40)
{
filterVar = new Vector4(minFrequency, maxFrequency - minFrequency, minQ, maxQ - minQ);
}
_events[i] = new PlayWaveEvent(
this,
timeStamp,
randomOffset,
soundBank,
new[] { waveBankIndex },
new[] { trackIndex },
null,
0,
VariationType.Ordered,
volumeVar,
pitchVar,
filterVar,
loopCount,
false);
break;
}
case 6:
{
// Unknown!
clipReader.ReadByte();
// Event flags
var eventFlags = clipReader.ReadByte();
_ = (eventFlags & 0x01) == 0x01;
_ = (eventFlags & 0x02) == 0x02;
_ = (eventFlags & 0x04) == 0x04;
var loopCount = clipReader.ReadByte();
_ = clipReader.ReadUInt16() / 100f;
_ = clipReader.ReadUInt16() / 100f;
// Pitch variation range
var minPitch = clipReader.ReadInt16() / 1000f;
var maxPitch = clipReader.ReadInt16() / 1000f;
// Volume variation range
var minVolume = XactHelpers.ParseVolumeFromDecibels(clipReader.ReadByte());
var maxVolume = XactHelpers.ParseVolumeFromDecibels(clipReader.ReadByte());
// Filter variation range
var minFrequency = clipReader.ReadSingle();
var maxFrequency = clipReader.ReadSingle();
var minQ = clipReader.ReadSingle();
var maxQ = clipReader.ReadSingle();
// Unknown!
clipReader.ReadByte();
// TODO: Still has unknown bits!
var variationFlags = clipReader.ReadByte();
// Enable pitch variation
Vector2?pitchVar = null;
if ((variationFlags & 0x10) == 0x10)
{
pitchVar = new Vector2(minPitch, maxPitch - minPitch);
}
// Enable volume variation
Vector2?volumeVar = null;
if ((variationFlags & 0x20) == 0x20)
{
volumeVar = new Vector2(minVolume, maxVolume - minVolume);
}
// Enable filter variation
Vector4?filterVar = null;
if ((variationFlags & 0x40) == 0x40)
{
filterVar = new Vector4(minFrequency, maxFrequency - minFrequency, minQ, maxQ - minQ);
}
// The number of tracks for the variations.
var numTracks = clipReader.ReadUInt16();
// Not sure what most of this is.
var moreFlags = clipReader.ReadByte();
var newWaveOnLoop = (moreFlags & 0x40) == 0x40;
// The variation playlist type seems to be
// stored in the bottom 4bits only.
var variationType = (VariationType)(moreFlags & 0x0F);
// Unknown!
clipReader.ReadBytes(5);
// Read in the variation playlist.
var waveBanks = new int[numTracks];
var tracks = new int[numTracks];
var weights = new byte[numTracks];
var totalWeights = 0;
for (var j = 0; j < numTracks; j++)
{
tracks[j] = clipReader.ReadUInt16();
waveBanks[j] = clipReader.ReadByte();
var minWeight = clipReader.ReadByte();
var maxWeight = clipReader.ReadByte();
weights[j] = (byte)(maxWeight - minWeight);
totalWeights += weights[j];
}
_events[i] = new PlayWaveEvent(
this,
timeStamp,
randomOffset,
soundBank,
waveBanks,
tracks,
weights,
totalWeights,
variationType,
volumeVar,
pitchVar,
filterVar,
loopCount,
newWaveOnLoop);
break;
}
case 7:
// Pitch Event
throw new NotImplementedException("Pitch event");
case 8:
{
// Unknown!
clipReader.ReadBytes(2);
// Event flags
var eventFlags = clipReader.ReadByte();
var isAdd = (eventFlags & 0x01) == 0x01;
// The replacement or additive volume.
var decibles = clipReader.ReadSingle() / 100f;
var volume = XactHelpers.ParseVolumeFromDecibels(decibles + (isAdd ? volumeDb : 0));
// Unknown!
clipReader.ReadBytes(9);
_events[i] = new VolumeEvent(
this, timeStamp, randomOffset, volume);
break;
}
case 17:
// Volume Repeat Event
throw new NotImplementedException("Volume repeat event");
case 9:
// Marker Event
throw new NotImplementedException("Marker event");
default:
throw new NotSupportedException("Unknown event " + eventId);
}
}
clipReader.BaseStream.Seek(oldPosition, SeekOrigin.Begin);
}
public XactSound(AudioEngine engine, SoundBank soundBank, BinaryReader soundReader)
{
_soundBank = soundBank;
var flags = soundReader.ReadByte();
_complexSound = (flags & 0x1) != 0;
var hasRPCs = (flags & 0x0E) != 0;
var hasDSPs = (flags & 0x10) != 0;
_categoryId = soundReader.ReadUInt16();
_volume = XactHelpers.ParseVolumeFromDecibels(soundReader.ReadByte());
_pitch = soundReader.ReadInt16() / 1000f;
soundReader.ReadByte(); //priority
soundReader.ReadUInt16(); // filter stuff?
int numClips = 0;
if (_complexSound)
{
numClips = soundReader.ReadByte();
}
else
{
_trackIndex = soundReader.ReadUInt16();
_waveBankIndex = soundReader.ReadByte();
}
if (!hasRPCs)
{
RpcCurves = Array.Empty <int>();
}
else
{
var current = soundReader.BaseStream.Position;
// This doesn't seem to be used... might have been there
// to allow for some future file format expansion.
var dataLength = soundReader.ReadUInt16();
var numPresets = soundReader.ReadByte();
RpcCurves = new int[numPresets];
for (var i = 0; i < numPresets; i++)
{
RpcCurves[i] = engine.GetRpcIndex(soundReader.ReadUInt32());
}
// Just in case seek to the right spot.
soundReader.BaseStream.Seek(current + dataLength, SeekOrigin.Begin);
}
if (!hasDSPs)
{
_useReverb = false;
}
else
{
// The file format for this seems to follow the pattern for
// the RPC curves above, but in this case XACT only supports
// a single effect... Microsoft Reverb... so just set it.
_useReverb = true;
soundReader.BaseStream.Seek(7, SeekOrigin.Current);
}
if (_complexSound)
{
_soundClips = new XactClip[numClips];
for (int i = 0; i < numClips; i++)
{
_soundClips[i] = new XactClip(soundBank, soundReader, _useReverb);
}
}
var category = engine.Categories[_categoryId];
category.AddSound(this);
}
private float UpdateRpcCurves()
{
var volume = 1f;
// Evaluate the runtime parameter controls.
var rpcCurves = _currentSound.RpcCurves;
if (rpcCurves.Length > 0)
{
var pitch = 0f;
var reverbMix = 1f;
float?filterFrequency = null;
float?filterQFactor = null;
for (var i = 0; i < rpcCurves.Length; i++)
{
var rpcCurve = _engine.RpcCurves[rpcCurves[i]];
// Some curves are driven by global variables
// and others by cue instance variables.
float value;
if (rpcCurve.IsGlobal)
{
value = rpcCurve.Evaluate(_engine.GetGlobalVariable(rpcCurve.Variable));
}
else
{
value = rpcCurve.Evaluate(_variables[rpcCurve.Variable].Value);
}
// Process the final curve value based on the parameter type it is.
switch (rpcCurve.Parameter)
{
case RpcParameter.Volume:
volume *= XactHelpers.ParseVolumeFromDecibels(value / 100f);
break;
case RpcParameter.Pitch:
pitch += value / 1000f;
break;
case RpcParameter.ReverbSend:
reverbMix *= XactHelpers.ParseVolumeFromDecibels(value / 100f);
break;
case RpcParameter.FilterFrequency:
filterFrequency = value;
break;
case RpcParameter.FilterQFactor:
filterQFactor = value;
break;
default:
throw new ArgumentOutOfRangeException(nameof(rpcCurve.Parameter));
}
}
pitch = MathHelper.Clamp(pitch, -1f, 1f);
if (volume < 0f)
{
volume = 0f;
}
_currentSound.UpdateState(
_engine, volume, pitch, reverbMix, filterFrequency, filterQFactor);
}
return(volume);
}