Add palette remap (#173)

* start adding palette remap functionality

* progress

* working implementation

* sort swatches

* clear selected image preview

* null hints

Author: LeftofZen

Dat/PaletteMap.cs

@@ -4,6 +4,32 @@
 
 namespace OpenLoco.Dat
 {
+	public enum ColourRemapSwatch
+	{
+		Amber,
+		AvocadoGreen,
+		Black,
+		Blue,
+		Brass,
+		Bronze,
+		Brown,
+		Copper,
+		GrassGreen,
+		Green,
+		Lavender,
+		Orange,
+		Purple,
+		Red,
+		Rose,
+		SeaGreen,
+		Teal,
+		Yellow,
+		//MiscGrey,
+		//MiscYellow,
+		PrimaryRemap,
+		SecondaryRemap,
+	}
+
 	public class PaletteMap
 	{
 		public PaletteMap(string filename)
@@ -47,10 +73,10 @@ public static (Color Color, byte Index) Transparent
 		public (Color Color, byte Index)[] TextRendering
 			=> Palette[1..7];
 
-		public (Color Color, byte Index)[] PrimaryRemapColours
+		public (Color Color, byte Index)[] PrimaryRemap
 			=> [.. Palette[7..10], .. Palette[246..255]];
 
-		public (Color Color, byte Index)[] SecondaryRemapColours
+		public (Color Color, byte Index)[] SecondaryRemap
 			=> Palette[202..214];
 
 		public (Color Color, byte Index) ChunkedTransparent
@@ -60,7 +86,7 @@ public static (Color Color, byte Index) Transparent
 			=> [.. Palette[10..202], .. Palette[214..246]];
 
 		public (Color Color, byte Index)[] ReservedColours
-			=> [Transparent, .. TextRendering, .. PrimaryRemapColours, .. SecondaryRemapColours, ChunkedTransparent];
+			=> [Transparent, .. TextRendering, .. PrimaryRemap, .. SecondaryRemap, ChunkedTransparent];
 
 		#region Colour Swatches
 
@@ -112,7 +138,7 @@ public static (Color Color, byte Index) Transparent
 
 		#endregion
 
-		public byte[] ConvertRgba32ImageToG1Data(Image<Rgba32> img, G1ElementFlags flags)
+		public byte[] ConvertRgba32ImageToG1Data(Image<Rgba32> img, G1ElementFlags flags, ColourRemapSwatch primary, ColourRemapSwatch secondary)
 		{
 			var pixels = img.Width * img.Height;
 			var isBgr = flags.HasFlag(G1ElementFlags.IsBgr24);
@@ -141,7 +167,34 @@ public byte[] ConvertRgba32ImageToG1Data(Image<Rgba32> img, G1ElementFlags flags
 			return bytes;
 		}
 
-		public bool TryConvertG1ToRgba32Bitmap(G1Element32 g1Element, out Image<Rgba32>? image)
+		public (Color Color, byte Index)[]? GetRemapSwatchFromName(ColourRemapSwatch swatch)
+			=> swatch switch
+			{
+				ColourRemapSwatch.Black => Black,
+				ColourRemapSwatch.Bronze => Bronze,
+				ColourRemapSwatch.Copper => Copper,
+				ColourRemapSwatch.Yellow => Yellow,
+				ColourRemapSwatch.Rose => Rose,
+				ColourRemapSwatch.GrassGreen => GrassGreen,
+				ColourRemapSwatch.AvocadoGreen => AvocadoGreen,
+				ColourRemapSwatch.Green => Green,
+				ColourRemapSwatch.Brass => Brass,
+				ColourRemapSwatch.Lavender => Lavender,
+				ColourRemapSwatch.Blue => Blue,
+				ColourRemapSwatch.SeaGreen => SeaGreen,
+				ColourRemapSwatch.Purple => Purple,
+				ColourRemapSwatch.Red => Red,
+				ColourRemapSwatch.Orange => Orange,
+				ColourRemapSwatch.Teal => Teal,
+				ColourRemapSwatch.Brown => Brown,
+				ColourRemapSwatch.Amber => Amber,
+				ColourRemapSwatch.PrimaryRemap => PrimaryRemap,
+				ColourRemapSwatch.SecondaryRemap => SecondaryRemap,
+				_ => default,
+			};
+
+
+		public bool TryConvertG1ToRgba32Bitmap(G1Element32 g1Element, ColourRemapSwatch primary, ColourRemapSwatch secondary, out Image<Rgba32>? image)
 		{
 			image = new Image<Rgba32>(g1Element.Width, g1Element.Height);
 
@@ -167,10 +220,35 @@ public bool TryConvertG1ToRgba32Bitmap(G1Element32 g1Element, out Image<Rgba32>?
 					else
 					{
 						var paletteIndex = g1Element.ImageData[index];
-						image[x, y] = paletteIndex == 0 && g1Element.Flags.HasFlag(G1ElementFlags.HasTransparency)
-							? Transparent.Color
-							: Palette[paletteIndex].Color;
+						Color? colour = null;
+
+						if (SecondaryRemap.Any(x => x.Index == paletteIndex))
+						{
+							//Debugger.Break();
+						}
+
+						if (paletteIndex == 0 && g1Element.Flags.HasFlag(G1ElementFlags.HasTransparency))
+						{
+							colour = Transparent.Color;
+						}
+						else if (PrimaryRemap.Index().SingleOrDefault(x => x.Item.Index == paletteIndex) is (int, (Color, byte)) itemP && itemP.Index != 0)
+						{
+							var swatch = GetRemapSwatchFromName(primary);
+							if (swatch != null)
+							{
+								colour = swatch[itemP.Index].Color;
+							}
+						}
+						else if (SecondaryRemap.Index().SingleOrDefault(x => x.Item.Index == paletteIndex) is (int, (Color, byte)) itemS && itemS.Index != 0)
+						{
+							var swatch = GetRemapSwatchFromName(secondary);
+							if (swatch != null)
+							{
+								colour = swatch[itemS.Index].Color;
+							}
+						}
 
+						image[x, y] = colour ?? Palette[paletteIndex].Color;
 						index++;
 					}
 				}

Gui/Models/ObjectEditorModel.cs

@@ -244,7 +244,7 @@ public bool TryLoadObject(FileSystemItem filesystemItem, out UiDatLocoFile? uiLo
 						{
 							foreach (var i in locoObject.G1Elements)
 							{
-								if (PaletteMap.TryConvertG1ToRgba32Bitmap(i, out var image))
+								if (PaletteMap.TryConvertG1ToRgba32Bitmap(i, ColourRemapSwatch.PrimaryRemap, ColourRemapSwatch.SecondaryRemap, out var image))
 								{
 									images.Add(image!);
 								}
@@ -275,7 +275,7 @@ public bool TryLoadObject(FileSystemItem filesystemItem, out UiDatLocoFile? uiLo
 						{
 							foreach (var i in locoObject.G1Elements)
 							{
-								if (PaletteMap.TryConvertG1ToRgba32Bitmap(i, out var image))
+								if (PaletteMap.TryConvertG1ToRgba32Bitmap(i, ColourRemapSwatch.PrimaryRemap, ColourRemapSwatch.SecondaryRemap, out var image))
 								{
 									images.Add(image!);
 								}

Gui/ViewModels/DatTypes/G1ViewModel.cs

@@ -1,3 +1,4 @@
+using OpenLoco.Dat;
 using OpenLoco.Dat.FileParsing;
 using OpenLoco.Gui.Models;
 using ReactiveUI.Fody.Helpers;
@@ -36,7 +37,7 @@ public override void Load()
 			{
 				try
 				{
-					if (Model.PaletteMap.TryConvertG1ToRgba32Bitmap(e, out var image))
+					if (Model.PaletteMap.TryConvertG1ToRgba32Bitmap(e, ColourRemapSwatch.PrimaryRemap, ColourRemapSwatch.SecondaryRemap, out var image))
 					{
 						images.Add(image!);
 					}

Gui/ViewModels/SubObjectTypes/ImageTableViewModel.cs

@@ -26,32 +26,6 @@
 
 namespace OpenLoco.Gui.ViewModels
 {
-	public enum ColourSwatches
-	{
-		Black,
-		Bronze,
-		Copper,
-		Yellow,
-		Rose,
-		GrassGreen,
-		AvocadoGreen,
-		Green,
-		Brass,
-		Lavender,
-		Blue,
-		SeaGreen,
-		Purple,
-		Red,
-		Orange,
-		Teal,
-		Brown,
-		Amber,
-		MiscGrey,
-		MiscYellow,
-		PrimaryRemap,
-		SecondaryRemap,
-	}
-
 	public record SpriteOffset(
 		[property: JsonPropertyName("path")] string Path,
 		[property: JsonPropertyName("x")] int16_t X,
@@ -66,10 +40,13 @@ public class ImageTableViewModel : ReactiveObject, IExtraContentViewModel
 		readonly IImageTableNameProvider NameProvider;
 		readonly ILogger Logger;
 
-		public ColourSwatches[] ColourSwatchesArr { get; } = (ColourSwatches[])Enum.GetValues(typeof(ColourSwatches));
+		public ColourRemapSwatch[] ColourSwatchesArr { get; } = Enum.GetValues<ColourRemapSwatch>();
 
 		[Reactive]
-		public ColourSwatches SelectedColourSwatch { get; set; } = ColourSwatches.PrimaryRemap;
+		public ColourRemapSwatch SelectedPrimarySwatch { get; set; } = ColourRemapSwatch.PrimaryRemap;
+
+		[Reactive]
+		public ColourRemapSwatch SelectedSecondarySwatch { get; set; } = ColourRemapSwatch.SecondaryRemap;
 
 		readonly DispatcherTimer animationTimer;
 		int currentFrameIndex;
@@ -100,9 +77,6 @@ public Avalonia.Size SelectedBitmapPreviewBorder
 		[Reactive]
 		public ICommand CropAllImagesCommand { get; set; }
 
-		[Reactive]
-		public int Zoom { get; set; } = 1;
-
 		// where the actual image data is stored
 		[Reactive]
 		public IList<Image<Rgba32>> Images { get; set; }
@@ -118,7 +92,7 @@ public Avalonia.Size SelectedBitmapPreviewBorder
 		public SelectionModel<Bitmap> SelectionModel { get; set; }
 
 		public UIG1Element32? SelectedG1Element
-			=> SelectedImageIndex == -1 || G1Provider.G1Elements.Count == 0
+			=> SelectedImageIndex == -1 || G1Provider.G1Elements.Count == 0 || SelectedImageIndex >= G1Provider.G1Elements.Count
 			? null
 			: new UIG1Element32(SelectedImageIndex, GetImageName(NameProvider, SelectedImageIndex), G1Provider.G1Elements[SelectedImageIndex]);
 
@@ -143,10 +117,12 @@ public ImageTableViewModel(IHasG1Elements g1ElementProvider, IImageTableNameProv
 				.Subscribe(_ => this.RaisePropertyChanged(nameof(Images)));
 			_ = this.WhenAnyValue(o => o.PaletteMap)
 				.Subscribe(_ => this.RaisePropertyChanged(nameof(Images)));
-			_ = this.WhenAnyValue(o => o.Zoom)
-				.Subscribe(_ => this.RaisePropertyChanged(nameof(Images)));
+			_ = this.WhenAnyValue(o => o.SelectedPrimarySwatch).Skip(1)
+				.Subscribe(_ => RecalcImages());
+			_ = this.WhenAnyValue(o => o.SelectedSecondarySwatch).Skip(1)
+				.Subscribe(_ => RecalcImages());
 			_ = this.WhenAnyValue(o => o.Images)
-				.Subscribe(_ => Bitmaps = new ObservableCollection<Bitmap?>(G1ImageConversion.CreateAvaloniaImages(Images)));
+				.Subscribe(_ => Bitmaps = [.. G1ImageConversion.CreateAvaloniaImages(Images)]);
 			_ = this.WhenAnyValue(o => o.SelectedImageIndex)
 				.Subscribe(_ => this.RaisePropertyChanged(nameof(SelectedG1Element)));
 			_ = this.WhenAnyValue(o => o.SelectedG1Element)
@@ -323,7 +299,7 @@ void LoadSprite(string filename, uint imageOffset, short xOffset, short yOffset,
 
 				var newElement = new G1Element32(imageOffset, (int16_t)img.Width, (int16_t)img.Height, xOffset, yOffset, flags, zoomOffset)
 				{
-					ImageData = PaletteMap.ConvertRgba32ImageToG1Data(img, flags)
+					ImageData = PaletteMap.ConvertRgba32ImageToG1Data(img, flags, SelectedPrimarySwatch, SelectedSecondarySwatch)
 				};
 
 				G1Provider.G1Elements.Add(newElement);
@@ -332,6 +308,34 @@ void LoadSprite(string filename, uint imageOffset, short xOffset, short yOffset,
 			}
 		}
 
+		public void RecalcImages()
+		{
+			// unfortunately no way to "copy" the selection from old to new
+			SelectionModel.Clear();
+
+			// clear existing images
+			Logger.Info("Clearing current G1Element32s and existing object images");
+			Images.Clear();
+			Bitmaps.Clear();
+
+			foreach (var g1 in G1Provider.G1Elements)
+			{
+				if (PaletteMap.TryConvertG1ToRgba32Bitmap(g1, SelectedPrimarySwatch, SelectedSecondarySwatch, out var img) && img != null)
+				{
+					Images.Add(img);
+					Bitmaps.Add(G1ImageConversion.CreateAvaloniaImage(img));
+				}
+				else
+				{
+					Logger.Error("Unable to convert G1 to image");
+				}
+			}
+
+			this.RaisePropertyChanged(nameof(Bitmaps));
+			this.RaisePropertyChanged(nameof(Images));
+			SelectedImageIndex = -1;
+		}
+
 		// todo: second half should be in model
 		public async Task ExportImages()
 		{
@@ -458,7 +462,7 @@ void UpdateImage(Image<Rgba32> img, int index, short? xOffset, short? yOffset)
 				Width = (int16_t)img.Width,
 				Height = (int16_t)img.Height,
 				Flags = currG1.Flags,
-				ImageData = PaletteMap.ConvertRgba32ImageToG1Data(img, currG1.Flags),
+				ImageData = PaletteMap.ConvertRgba32ImageToG1Data(img, currG1.Flags, SelectedPrimarySwatch, SelectedSecondarySwatch),
 				XOffset = xOffset ?? currG1.XOffset,
 				YOffset = yOffset ?? currG1.YOffset,
 			};

Gui/Views/ImageTableView.axaml

@@ -41,6 +41,8 @@
 					</Flyout>
 				</Button.Flyout>
 			</Button>
+			<ComboBox ItemsSource="{Binding ColourSwatchesArr}" SelectedItem="{Binding SelectedPrimarySwatch}" HorizontalAlignment="Stretch" Margin="2" Padding="2" ToolTip.Tip="Primary remap swatch" />
+			<ComboBox ItemsSource="{Binding ColourSwatchesArr}" SelectedItem="{Binding SelectedSecondarySwatch}" HorizontalAlignment="Stretch" Margin="2" Padding="2" ToolTip.Tip="Secondary remap swatch" />
 			<Button Command="{Binding CropAllImagesCommand}" HorizontalAlignment="Stretch" Margin="2" Padding="2" ToolTip.Tip="Crops all images and adjusts offsets">
 				<DockPanel>
 					<materialIcons:MaterialIcon Kind="Crop" Width="24" Height="24" Margin="2" />

ObjectService/Server.cs

@@ -172,7 +172,7 @@ public async Task<IResult> GetObjectImages(int uniqueObjectId, LocoDb db, [FromS
 				var count = 0;
 				foreach (var g1 in locoObj!.Value!.LocoObject!.G1Elements)
 				{
-					if (!PaletteMap.TryConvertG1ToRgba32Bitmap(g1, out var image))
+					if (!PaletteMap.TryConvertG1ToRgba32Bitmap(g1, ColourRemapSwatch.PrimaryRemap, ColourRemapSwatch.SecondaryRemap, out var image))
 					{
 						continue;
 					}

Tests/ImagePaletteConversionTests.cs

@@ -69,9 +69,9 @@ public void G1ElementToPNGAndBack(string objectSource)
 				var i = 0;
 				foreach (var element in g1Elements)
 				{
-					if (paletteMap.TryConvertG1ToRgba32Bitmap(element, out var image0))
+					if (paletteMap.TryConvertG1ToRgba32Bitmap(element, ColourRemapSwatch.PrimaryRemap, ColourRemapSwatch.SecondaryRemap, out var image0))
 					{
-						var g1Bytes = paletteMap.ConvertRgba32ImageToG1Data(image0!, element.Flags);
+						var g1Bytes = paletteMap.ConvertRgba32ImageToG1Data(image0!, element.Flags, ColourRemapSwatch.PrimaryRemap, ColourRemapSwatch.SecondaryRemap);
 						Assert.That(g1Bytes, Is.EqualTo(element.ImageData), $"[{i++}]");
 					}
 				}