Update docs, bump to 1.1.0

Author: Sam Byass

Fmod5Sharp/ChunkData/UnknownChunkData.cs

@@ -4,7 +4,7 @@ namespace Fmod5Sharp.ChunkData
 {
 	internal class UnknownChunkData : IChunkData
 	{
-		public byte[] UnknownData;
+		public byte[] UnknownData = new byte[0];
 
 		public void Read(BinaryReader reader, uint expectedSize)
 		{

Fmod5Sharp/Fmod5Sharp.csproj

@@ -6,7 +6,7 @@
         <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
         <Configurations>Release;Debug</Configurations>
         <Platforms>x86;x64;AnyCPU</Platforms>
-        <Version>1.0.1</Version>
+        <Version>1.1.0</Version>
         <PackageId>Fmod5Sharp</PackageId>
         <RepositoryType>git</RepositoryType>
         <RepositoryUrl>https://github.com/SamboyCoding/Fmod5Sharp.git</RepositoryUrl>

Fmod5Sharp/FmodGcadPcmRebuilder.cs

@@ -39,7 +39,7 @@ private static short[] GetPcmData(FmodSample sample)
             {
                 //Each byte is a scale and a predictor
                 var combined = adpcm[inIndex++];
-                var scale = (1 << (combined & 0xF));
+                var scale = 1 << (combined & 0xF);
                 var predictor = combined >> 4;
 
                 //Coefficients are based on the predictor value
@@ -55,7 +55,7 @@ private static short[] GetPcmData(FmodSample sample)
                     var adpcmSample = (int) (s % 2 == 0 ? GetHighNibbleSigned(adpcm[inIndex]) : GetLowNibbleSigned(adpcm[inIndex++]));
 
                     //Adaptive processing
-                    adpcmSample = ((adpcmSample * scale) << 11);
+                    adpcmSample = (adpcmSample * scale) << 11;
                     adpcmSample = (adpcmSample + 1024 + coeff1 * hist1 + coeff2 * hist2) >> 11;
                     var clampedSample = Clamp16(adpcmSample);
 

Fmod5Sharp/FmodSampleChunk.cs

@@ -11,7 +11,9 @@ internal class FmodSampleChunk : IBinaryReadable
 		public FmodSampleChunkType ChunkType;
 		public uint ChunkSize;
 		public bool MoreChunks;
+#pragma warning disable 8618 //Non-nullable value is not defined.
 		internal IChunkData ChunkData;
+#pragma warning restore 8618
 
 		void IBinaryReadable.Read(BinaryReader reader)
 		{

README.md

@@ -4,7 +4,7 @@
 [![NuGet](https://img.shields.io/nuget/v/Fmod5Sharp?)](https://www.nuget.org/packages/Fmod5Sharp/)
 
 This library allows you to read FMOD 5 sound bank files (they start with the characters FSB5) into their contained samples,
-and then export those samples to ogg files (assuming the contained data is vorbis-encoded).
+and then export those samples to standard file formats (assuming the contained data format is supported).
 
 Support for more encodings can be added as requested.
 
@@ -38,11 +38,39 @@ uint numChannels = samples[0].Channels; //2 for stereo, 1 for mono.
 ```
 
 And, you can convert the audio data back to a standard format.
-For example if `bank.Header.AudioType == FmodAudioType.VORBIS`:
 ```c#
-var oggFileBytes = FmodVorbisRebuilder.RebuildOggFile(samples[0]);
-//Now you can save oggFileBytes to an .ogg file on your disk and play it using your favourite audio player.
+var success = samples[0].RebuildAsStandardFileFormat(out var dataBytes, out var fileExtension);
+//Assuming success == true, then this file format was supported and you should have some data and an extension (without the leading .).
+//Now you can save dataBytes to an file with the given extension on your disk and play it using your favourite audio player.
 //Or you can use any standard library to convert the byte array to a different format, if you so desire.
 ```
 
-If the user's system does not have libopus or libvorbis, this will throw a `DllNotFoundException`.
+If the user's system does not have libopus or libvorbis, and the data is vorbis-encoded, this will throw a `DllNotFoundException`.
+
+You can also check if a given format type is supported and, if so, what extension it will result in, like so:
+```c#
+bool isSupported = bank.Header.AudioType.IsSupported();
+
+//Null if not supported
+string? extension = bank.Header.AudioType.FileExtension();
+```
+
+Alternatively, you can consult the table below:
+
+| Format | Supported? | Extension | Notes |
+| :-----: | :--------------: | :---------: | :----------: |
+| PCM8 | ✔️ | wav | |
+| PCM16 | ✔️ | wav | |
+| PCM24 | ❌ | | |
+| PCM32 | ✔️ | wav | |
+| PCMFLOAT | ❌ | | |
+| GCADPCM | ✔️ | wav | Tested with single-channel files. Not tested with stereo, but should work in theory. |
+| IMAADPCM | ❌ | | |
+| VAG | ❌ | | |
+| HEVAG | ❌ | | |
+| XMA | ❌ | | |
+| MPEG | ❌ | | |
+| CELT | ❌ | | |
+| AT9 | ❌ | | | 
+| XWMA | ❌ | | |
+| VORBIS | ✔️ | ogg | Requires native libraries on user's system. |