Move Common functionality to Core project & rendering and Model support as well

PckStudio.Core/FileFormats/PckAudioFile.cs

@@ -0,0 +1,157 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using OMI.Formats.Languages;
+
+namespace PckStudio.Core.FileFormats
+{
+    public class PckAudioFile
+    {
+		public class InvalidCategoryException : Exception
+        {
+			public InvalidCategoryException(string message) : base(message)
+			{ }
+		}
+
+		public readonly int type = 1;
+
+        public AudioCategory[] Categories => Array.FindAll(_categories, c => c is not null);
+        private AudioCategory[] _categories { get; } = new AudioCategory[9];
+
+		public Dictionary<string, string> Credits { get; } = new Dictionary<string, string>();
+
+		public class AudioCategory
+        {
+			public enum EAudioType : int
+			{
+				Overworld,
+				Nether,
+				End,
+				Creative,
+				Menu,
+				Battle,
+				Tumble,
+				Glide,
+				BuildOff,
+			}
+
+			public enum EAudioParameterType : int
+			{
+				unk0, // dimension music
+				unk1, // unused music ?
+			}
+
+			public string Name { get; set; } = string.Empty;
+			public EAudioType AudioType { get; }
+			public List<string> SongNames { get;  } = new List<string>();
+            public EAudioParameterType parameterType { get; }
+
+			public AudioCategory(string name, EAudioParameterType parameterType, EAudioType audioType)
+			{
+				this.Name = name;
+				this.parameterType = parameterType;
+				this.AudioType = audioType;
+			}
+		}
+
+		public string[] GetCredits() => Credits.Values.ToArray();
+		public string GetCreditsString() => string.Join("\n", Credits.Values.ToArray());
+
+		public void AddCredits(params string[] credits)
+        {
+			foreach (var credit in credits)
+            {
+				AddCredit(credit);
+			}
+        }
+
+		/// <summary>
+		/// Applies internal Credits to loc file
+		/// </summary>
+		public void ApplyCredits(LOCFile locFile)
+        {
+            foreach (KeyValuePair<string, string> credit in Credits)
+            {
+				locFile.SetLocEntry(credit.Key, credit.Value);
+            }
+        }
+
+		/// <summary>
+		/// Clears and sets the new supplied <paramref name="credits"/>
+		/// </summary>
+		public void SetCredits(params string[] credits)
+        {
+			Credits.Clear();
+			AddCredits(credits);
+        }
+
+		public bool SetCredit(string creditId, string s)
+        {
+			if (!Credits.ContainsKey(creditId))
+				return false;
+			Credits[creditId] = s;
+			return true;
+		}
+
+		public void AddCredit(string credit)
+		{
+			Credits.Add($"IDS_CREDIT{(Credits.Count > 0 ? $"_{Credits.Count+1}" : string.Empty)}", credit);
+		}
+
+		public void AddCreditId(string creditId) => Credits.Add(creditId, string.Empty);
+
+
+		/// <exception cref="InvalidCategoryException"></exception>
+		public bool HasCategory(AudioCategory.EAudioType category) => GetCategory(category) is AudioCategory;
+
+		/// <exception cref="InvalidCategoryException"></exception>
+		public AudioCategory GetCategory(AudioCategory.EAudioType category)
+		{
+			if (category < AudioCategory.EAudioType.Overworld ||
+				category > AudioCategory.EAudioType.BuildOff)
+				throw new InvalidCategoryException(nameof(category));
+			return _categories[(int)category];
+		}
+
+		/// <exception cref="InvalidCategoryException"></exception>
+		public bool TryGetCategory(AudioCategory.EAudioType category, out AudioCategory audioCategory)
+        {
+			if (GetCategory(category) is AudioCategory a)
+            {
+				audioCategory = a;
+				return true;
+            }
+			audioCategory = null;
+			return false;
+        }
+
+		/// <returns>True when category was created, otherwise false</returns>
+		/// <exception cref="InvalidCategoryException"></exception>
+		public bool AddCategory(AudioCategory.EAudioParameterType parameterType, AudioCategory.EAudioType category, string name = "")
+		{
+			if (category < AudioCategory.EAudioType.Overworld ||
+				category > AudioCategory.EAudioType.BuildOff)
+				throw new InvalidCategoryException(nameof(category));
+			bool exists = HasCategory(category);
+			if (!exists)
+				_categories[(int)category] = new AudioCategory(name, parameterType, category);
+			return !exists;
+		}
+
+		/// <returns>True when category was created, otherwise false</returns>
+		/// <exception cref="InvalidCategoryException"></exception>
+		public bool AddCategory(AudioCategory.EAudioType category)
+			=> AddCategory(AudioCategory.EAudioParameterType.unk0, category);
+
+		/// <returns>True when category was removed, otherwise false</returns>
+		/// <exception cref="InvalidCategoryException"></exception>
+		public bool RemoveCategory(AudioCategory.EAudioType category)
+        {
+			bool exists = HasCategory(category);
+			if (exists)
+				_categories[(int)category] = null;
+			return exists;
+		}
+
+	}
+}