Redid logic for map image generation.

gigamon-dev · gigamon-dev · commit a0a3134bccda · 2024-06-19T14:18:59.000-04:00
- Replaced ImageSharp with SkiaSharp.
- Changed the ?mapimage command to use a MemoryStream instead of write to a temporary file.
diff --git a/README.md b/README.md
@@ -39,8 +39,8 @@ To build the server,
 - [Microsoft.Data.Sqlite](https://www.nuget.org/packages/Microsoft.Data.Sqlite) - for an embedded database that persists player and arena data
 - [Microsoft.Extensions.ObjectPool](https://www.nuget.org/packages/Microsoft.Extensions.ObjectPool) - object pooling to reduce allocations and the need to garbage collect
 - [Microsoft.IO.RecyclableMemoryStream](https://www.nuget.org/packages/Microsoft.IO.RecyclableMemoryStream) - for an improved MemoryStream with regards to performance and garbage collection
-- [Npgsql](https://www.nuget.org/packages/Npgsql) - for connecting to a PostgreSQL database (optional)
-- [SixLabors.ImageSharp](https://www.nuget.org/packages/SixLabors.ImageSharp) - for creating images of maps
+- [Npgsql](https://www.nuget.org/packages/Npgsql) - for connecting to a PostgreSQL database (optional matchmaking functionality)
+- [SkiaSharp](https://www.nuget.org/packages/SkiaSharp) - for creating images of maps
 - [System.IO.Hashing](https://www.nuget.org/packages/System.IO.Hashing) - for a CRC-32 implementation compatible with zlib's
 
 ## License
diff --git a/src/Core/ComponentInterfaces/IMapData.cs b/src/Core/ComponentInterfaces/IMapData.cs
@@ -2,6 +2,7 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.Immutable;
+using System.IO;
 
 namespace SS.Core.ComponentInterfaces
 {
@@ -151,14 +152,27 @@ public interface IMapData : IComponentInterface
         /// <returns>A set of regions (empty if the coordinate is not in a region).</returns>
         ImmutableHashSet<MapRegion> RegionsAt(Arena arena, MapCoordinate coord);
 
-        /// <summary>
-        /// Saves an image of the map to a file.
-        /// </summary>
-        /// <param name="arena">The arena of the map to save.</param>
-        /// <param name="path">The path of the file. The image format is automatically determined based on the filename extension.</param>
-        /// <exception cref="ArgumentNullException">The <paramref name="arena"/> is <see langword="null"/>.</exception>
-        /// <exception cref="ArgumentException">The <paramref name="path"/> is null or white-space.</exception>
-        /// <exception cref="NotSupportedException">No encoder available for the provided <paramref name="path"/>.</exception>
-        void SaveImage(Arena arena, string path);
+		/// <summary>
+		/// Saves an image of the map to a file.
+		/// </summary>
+		/// <param name="arena">The arena of the map to save.</param>
+		/// <param name="path">The path of the file. The image format is automatically determined based on the filename extension.</param>
+		/// <exception cref="ArgumentNullException">The <paramref name="arena"/> is <see langword="null"/>.</exception>
+		/// <exception cref="ArgumentException">The <paramref name="path"/> is null or white-space.</exception>
+		/// <exception cref="ArgumentException">The <paramref name="path"/> file extension specifies an unsupported image format.</exception>
+		/// <exception cref="Exception">Error encoding image.</exception>
+		void SaveImage(Arena arena, string path);
+
+		/// <summary>
+		/// Saves an image of the map to a file.
+		/// </summary>
+		/// <param name="arena">The arena of the map to save.</param>
+		/// <param name="stream">The stream to write the image data to.</param>
+		/// <param name="imageFormat">The format to save the image as. Supported formats: 'png', 'jpg', and 'webp'.</param>
+		/// <exception cref="ArgumentNullException">The <paramref name="arena"/> is <see langword="null"/>.</exception>
+		/// <exception cref="ArgumentNullException">The <paramref name="stream"/> is <see langword="null"/>.</exception>
+		/// <exception cref="ArgumentException">Unsupported image format for the provided <paramref name="imageFormat"/>.</exception>
+		/// <exception cref="Exception">Error encoding image.</exception>
+		void SaveImage(Arena arena, Stream stream, ReadOnlySpan<char> imageFormat);
     }
 }
diff --git a/src/Core/Core.csproj b/src/Core/Core.csproj
@@ -17,7 +17,8 @@
     <PackageReference Include="Google.Protobuf" Version="3.26.1" />
     <PackageReference Include="Microsoft.Data.Sqlite" Version="8.0.4" />
     <PackageReference Include="Microsoft.Extensions.ObjectPool" Version="8.0.4" />
-    <PackageReference Include="SixLabors.ImageSharp" Version="3.1.4" />
+    <PackageReference Include="SkiaSharp" Version="2.88.8" />
+    <PackageReference Include="SkiaSharp.NativeAssets.Linux" Version="2.88.8" />
     <PackageReference Include="System.IO.Hashing" Version="8.0.0" />
   </ItemGroup>
 
diff --git a/src/Core/Map/BasicLvl.cs b/src/Core/Map/BasicLvl.cs
@@ -1,8 +1,9 @@
-﻿using SixLabors.ImageSharp;
-using SixLabors.ImageSharp.PixelFormats;
+﻿using SkiaSharp;
+using SS.Utilities;
 using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
+using System.IO;
 using System.IO.MemoryMappedFiles;
 using System.Runtime.InteropServices;
 
@@ -180,38 +181,114 @@ protected void ReadPlainTileData(MemoryMappedViewAccessor accessor, long positio
             IsTileDataLoaded = true;
         }
 
-        /// <summary>
-        /// Creates an image of the map, saving it to a specified <paramref name="path"/>.
-        /// The image format is automatically determined based on the filename extension.
-        /// </summary>
-        /// <param name="path"></param>
-        /// <exception cref="ArgumentException">The <paramref name="path"/> is null or white-space.</exception>
-        /// <exception cref="NotSupportedException">No encoder available for the provided <paramref name="path"/>.</exception>
-        public void SaveImage(string path)
+        // Note: It seems SkiaSharp only supports encoding to jpg, png, and webp even though it has many other image formats defined.
+        private static readonly Trie<SKEncodedImageFormat> _extensionToImageFormatTrie = new(false)
         {
-            if (string.IsNullOrWhiteSpace(path))
-                throw new ArgumentException("A path is required.", nameof(path));
+			//{ ".bmp", SKEncodedImageFormat.Bmp },
+			//{ "bmp", SKEncodedImageFormat.Bmp },
+			//{ ".gif", SKEncodedImageFormat.Gif },
+			//{ "gif", SKEncodedImageFormat.Gif },
+			//{ ".ico", SKEncodedImageFormat.Ico},
+			//{ "ico", SKEncodedImageFormat.Ico},
+			{ ".jpg", SKEncodedImageFormat.Jpeg },
+			{ "jpg", SKEncodedImageFormat.Jpeg },
+			{ ".jpeg", SKEncodedImageFormat.Jpeg },
+			{ "jpeg", SKEncodedImageFormat.Jpeg },
+			{ ".png", SKEncodedImageFormat.Png },
+			{ "png", SKEncodedImageFormat.Png },
+			{ ".webp", SKEncodedImageFormat.Webp },
+			{ "webp", SKEncodedImageFormat.Webp },
+			//{ ".heif", SKEncodedImageFormat.Heif },
+			//{ "heif", SKEncodedImageFormat.Heif },
+		};
 
-            using Image<Rgb24> image = new(1024, 1024, Color.Black);
+		/// <summary>
+		/// Creates an image of the map, saving it to a specified <paramref name="path"/>.
+		/// </summary>
+		/// <param name="path">The path to save the file to. The image format is automatically determined based on the filename extension.</param>
+		/// <exception cref="ArgumentException">The <paramref name="path"/> is null or white-space.</exception>
+		/// <exception cref="ArgumentException">The <paramref name="path"/> file extension specifies an unsupported image format.</exception>
+		/// <exception cref="Exception">Error encoding image.</exception>
+		public void SaveImage(string path)
+        {
+            ArgumentException.ThrowIfNullOrWhiteSpace(path);
 
-            foreach (KeyValuePair<MapCoordinate, MapTile> kvp in _tileLookup)
-            {
-                Color color = kvp.Value switch
-                {
-                    { IsDoor: true } => Color.Blue,
-                    { IsSafe: true } => Color.LightGreen,
-                    { IsTurfFlag: true } => Color.Yellow,
-                    { IsGoal: true } => Color.Red,
-                    { IsWormhole: true } => Color.Purple,
-                    { IsFlyOver: true } => Color.DarkGray,
-                    { IsFlyUnder: true } => Color.DarkGray,
-                    _ => Color.White
-                };
-
-                image[kvp.Key.X, kvp.Key.Y] = color;
-            }
+            string extension = Path.GetExtension(path);
+            if (!_extensionToImageFormatTrie.TryGetValue(extension, out SKEncodedImageFormat format))
+                throw new ArgumentException("Unsupported image format.", nameof(path));
 
-            image.Save(path);
-        }
-    }
+            using SKBitmap bitmap = CreateBitmap();
+
+			bool success = false;
+
+			using (FileStream fs = new(path, FileMode.CreateNew))
+			{
+				success = bitmap.Encode(fs, format, 100);
+			}
+
+			if (!success)
+			{
+				try
+				{
+					File.Delete(path);
+				}
+				catch
+				{
+				}
+
+                throw new Exception($"Error encoding as {format}.");
+			}
+		}
+
+		/// <summary>
+		/// Creates an image of the map, saving it to a specified <paramref name="path"/>.
+		/// </summary>
+		/// <param name="imageFormat">The format to save the image as.</param>
+		/// <exception cref="ArgumentException">The <paramref name="imageFormat"/> is white-space.</exception>
+		/// <exception cref="ArgumentException">Unsupported image format for the provided <paramref name="imageFormat"/>.</exception>
+		/// <exception cref="Exception">Error encoding image.</exception>
+		public void SaveImage(Stream stream, ReadOnlySpan<char> imageFormat)
+        {
+            ArgumentNullException.ThrowIfNull(stream);
+
+            if (imageFormat.IsWhiteSpace())
+                throw new ArgumentException("Cannot be whitespace.", nameof(imageFormat));
+
+			if (!_extensionToImageFormatTrie.TryGetValue(imageFormat, out SKEncodedImageFormat format))
+				throw new ArgumentException("Unsupported image format.", nameof(imageFormat));
+
+            using SKBitmap bitmap = CreateBitmap();
+
+            if (!bitmap.Encode(stream, format, 100))
+				throw new Exception($"Error encoding as {format}.");
+		}
+
+		private SKBitmap CreateBitmap()
+        {
+			SKImageInfo info = new(1024, 1024);
+			SKBitmap bitmap = new(info);
+
+			using SKCanvas canvas = new(bitmap);
+			canvas.Clear(SKColors.Black);
+
+			foreach (KeyValuePair<MapCoordinate, MapTile> kvp in _tileLookup)
+			{
+				SKColor color = kvp.Value switch
+				{
+					{ IsDoor: true } => SKColors.Blue,
+					{ IsSafe: true } => SKColors.LightGreen,
+					{ IsTurfFlag: true } => SKColors.Yellow,
+					{ IsGoal: true } => SKColors.Red,
+					{ IsWormhole: true } => SKColors.Purple,
+					{ IsFlyOver: true } => SKColors.DarkGray,
+					{ IsFlyUnder: true } => SKColors.DarkGray,
+					_ => SKColors.White
+				};
+
+				canvas.DrawPoint(kvp.Key.X, kvp.Key.Y, color);
+			}
+
+            return bitmap;
+		}
+	}
 }
diff --git a/src/Core/Modules/MapData.cs b/src/Core/Modules/MapData.cs
@@ -455,11 +455,8 @@ ImmutableHashSet<MapRegion> IMapData.RegionsAt(Arena arena, short x, short y)
 
         void IMapData.SaveImage(Arena arena, string path)
         {
-            if (arena == null)
-                throw new ArgumentNullException(nameof(arena));
-
-            if (string.IsNullOrWhiteSpace(path))
-                throw new ArgumentException("A path is required.", nameof(path));
+			ArgumentNullException.ThrowIfNull(arena);
+            ArgumentException.ThrowIfNullOrWhiteSpace(path);
 
             if (!arena.TryGetExtraData(_adKey, out ArenaData ad))
                 throw new Exception("missing lvl data");
@@ -476,9 +473,29 @@ void IMapData.SaveImage(Arena arena, string path)
             }
         }
 
-        #endregion
+		void IMapData.SaveImage(Arena arena, Stream stream, ReadOnlySpan<char> imageFormat)
+        {
+            ArgumentNullException.ThrowIfNull(arena);
+			ArgumentNullException.ThrowIfNull(stream);
+
+			if (!arena.TryGetExtraData(_adKey, out ArenaData ad))
+				throw new Exception("missing lvl data");
+
+			ad.Lock.EnterReadLock();
+
+			try
+			{
+				ad.Lvl.SaveImage(stream, imageFormat);
+			}
+			finally
+			{
+				ad.Lock.ExitReadLock();
+			}
+		}
+
+		#endregion
 
-        private async void Callback_ArenaAction(Arena arena, ArenaAction action)
+		private async void Callback_ArenaAction(Arena arena, ArenaAction action)
         {
             if (arena == null)
                 return;
diff --git a/src/Core/Modules/PlayerCommand.cs b/src/Core/Modules/PlayerCommand.cs
@@ -3260,7 +3260,7 @@ private void Command_mapinfo(ReadOnlySpan<char> command, ReadOnlySpan<char> para
             Args = "[<image file extension>]",
             Description = $"""
                 Downloads an image of the map.
-                The image format can optionally be specified. The default is '{DefaultMapImageFormat}'.
+                Available formats: png (default), jpg, and webp.
                 """)]
         private void Command_mapimage(ReadOnlySpan<char> command, ReadOnlySpan<char> parameters, Player player, ITarget target)
         {
@@ -3296,40 +3296,26 @@ private void Command_mapimage(ReadOnlySpan<char> command, ReadOnlySpan<char> par
             if (!imageFileName.TryWrite($"{fileNameWithoutExtension}.{extension}", out int charsWritten) || imageFileName.Length != charsWritten)
                 return;
 
-            // Create file name for temp file.
-            const string prefix = "mapimage-";
-            Span<char> tempFileName = stackalloc char[prefix.Length + 32 + 1 + extension.Length];
-            if (!tempFileName.TryWrite($"{prefix}{Guid.NewGuid():N}.{extension}", out charsWritten) || tempFileName.Length != charsWritten)
-                return;
-
-            string path = Path.Join("tmp", tempFileName);
-
+            MemoryStream stream = new();
+            
             // Create the image of the map.
-            // TODO: Use a worker thread to do file I/O, including the call to _fileTransfer.SendFile.
             try
             {
-                _mapData.SaveImage(arena, path);
+                _mapData.SaveImage(arena, stream, extension);
+                stream.Position = 0;
             }
             catch (Exception ex)
             {
+                stream.Dispose();
                 _chat.SendMessage(player, $"Error saving image.");
                 _chat.SendWrappedText(player, ex.Message);
                 return;
             }
 
             // Send the image.
-            if (!_fileTransfer.SendFile(player, path, imageFileName, true))
+            if (!_fileTransfer.SendFile(player, stream, imageFileName))
             {
-                // Cleanup the temp file.
-                try
-                {
-                    File.Delete(path);
-                }
-                catch(Exception ex)
-                {
-                    _logManager.LogP(LogLevel.Warn, nameof(PlayerCommand), player, $"Failed to delete temporary image file '{path}'. {ex.Message}");
-                }
-
+                stream.Dispose();
                 _chat.SendMessage(player, $"Error sending image.");
                 return;
             }
