feat: allow sheet export for animated textures

requires multiple file formats per format converter

Author: Krzyhau

Core/Conversion/FormatConverter.cs

@@ -11,7 +11,7 @@ namespace FEZRepacker.Core.Conversion
     /// </summary>
     public abstract class FormatConverter
     {
-        public abstract string FileFormat { get; }
+        public abstract string[] FileFormats { get; }
         public abstract Type FormatType { get; }
 
         public abstract FileBundle Convert(object? data);

Core/Conversion/FormatConverterSettings.cs

@@ -15,5 +15,12 @@ public struct FormatConverterSettings()
         /// If the flag is true, the converter will use a legacy bundle with separate files.
         /// </summary>
         public bool UseTrixelArtBundle = false;
+
+        /// <summary>
+        /// By default, <see cref="AnimatedTexture"/> is converted into GIF animation file. This is a lossy conversion,
+        /// dropping original atlas texture arrangement and leading to minor precision loss to color and frame duration.
+        /// If the flag is true, the converter will export animations into a bundle of atlas texture and JSON data.
+        /// </summary>
+        public bool UseAnimationSheet = false;
     }
 }

Core/Conversion/FormatConverters.cs

@@ -28,7 +28,7 @@ public static class FormatConverters
 
         public static FormatConverter? FindByExtension(string extension)
         {
-            return List.FirstOrDefault(x => x.FileFormat == extension);
+            return List.FirstOrDefault(x => x.FileFormats.Contains(extension));
         }
 
         public static FormatConverter? FindForFileBundle(FileBundle bundle)

Core/Conversion/Formats/AnimatedTextureConverter.cs

@@ -2,9 +2,11 @@
 using FEZRepacker.Core.Definitions.Game.XNA;
 using FEZRepacker.Core.FileSystem;
 using FEZRepacker.Core.Helpers;
+using FEZRepacker.Core.Helpers.Json;
 
 using SixLabors.ImageSharp;
 using SixLabors.ImageSharp.Formats.Gif;
+using SixLabors.ImageSharp.Formats.Png;
 using SixLabors.ImageSharp.PixelFormats;
 using SixLabors.ImageSharp.Processing;
 
@@ -14,23 +16,53 @@ namespace FEZRepacker.Core.Conversion.Formats
 {
     internal class AnimatedTextureConverter : FormatConverter<AnimatedTexture>
     {
-        const int FramePadding = 1;
+        private const string GifFileFormat = ".gif";
+        private const string BundleFileFormat = ".fezanim";
 
-        public override string FileFormat => ".gif";
+        public override string[] FileFormats => [GifFileFormat, BundleFileFormat];
 
         public override FileBundle ConvertTyped(AnimatedTexture txt)
         {
+            if (Settings.UseAnimationSheet)
+            {
+                var bundle = ConfiguredJsonSerializer.SerializeToFileBundle(BundleFileFormat, txt);
+                var atlasTexture = new Texture2D()
+                {
+                    Format = SurfaceFormat.Color,
+                    Width = txt.AtlasWidth,
+                    Height = txt.AtlasHeight,
+                    TextureData = txt.TextureData
+                };
+                using var animationAtlas = TexturesUtil.ImageFromTexture2D(atlasTexture);
+                bundle.AddFile(animationAtlas.SaveAsMemoryStream(new PngEncoder()), ".png");
+
+                return bundle;
+            }
+            
             using var animation = AnimatedTextureToGif(txt);
 
             var outStream = animation.SaveAsMemoryStream(
                 new GifEncoder { ColorTableMode = GifColorTableMode.Local }
             );
 
-            return FileBundle.Single(outStream, FileFormat);
+            return FileBundle.Single(outStream, GifFileFormat);
         }
 
         public override AnimatedTexture DeconvertTyped(FileBundle bundle)
         {
+            if (bundle.MainExtension == BundleFileFormat)
+            {
+                var animatedTexture = ConfiguredJsonSerializer.DeserializeFromFileBundle<AnimatedTexture>(bundle);
+
+                using var atlasImage = Image.Load<Rgba32>(bundle.RequireData(".png"));
+                var atlasTexture = TexturesUtil.ImageToTexture2D(atlasImage);
+
+                animatedTexture.AtlasWidth = atlasTexture.Width;
+                animatedTexture.AtlasHeight = atlasTexture.Height;
+                animatedTexture.TextureData = atlasTexture.TextureData;
+                return animatedTexture;
+            }
+            
             using var animation = Image.Load<Rgba32>(bundle.RequireData(""));
             return AnimationImageToAnimatedTexture(animation);
         }

Core/Conversion/Formats/ArtObjectConverter.cs

@@ -13,16 +13,18 @@ namespace FEZRepacker.Core.Conversion.Formats
 {
     internal class ArtObjectConverter : FormatConverter<ArtObject>
     {
-        public override string FileFormat => ".fezao";
+        private const string BundleFileFormat = ".fezao";
+        
+        public override string[] FileFormats => [BundleFileFormat];
 
         public override FileBundle ConvertTyped(ArtObject data)
         {
             if (!Settings.UseTrixelArtBundle)
             {
-                return FileBundle.Single(GetTransmissionFormatStream(data), FileFormat, ".glb");
+                return FileBundle.Single(GetTransmissionFormatStream(data), BundleFileFormat, ".glb");
             }
 
-            var bundle = ConfiguredJsonSerializer.SerializeToFileBundle(FileFormat, data);
+            var bundle = ConfiguredJsonSerializer.SerializeToFileBundle(BundleFileFormat, data);
 
             bundle.AddFile(GetTextureStream(data, TexturesUtil.CubemapPart.Albedo), ".png");
             bundle.AddFile(GetTextureStream(data, TexturesUtil.CubemapPart.Emission), ".apng");

Core/Conversion/Formats/EffectConverter.cs

@@ -5,7 +5,8 @@ namespace FEZRepacker.Core.Conversion.Formats
 {
     internal class EffectConverter : FormatConverter<Effect>
     {
-        public override string FileFormat => ".fxb";
+        private const string FileFormat = ".fxb";
+        public override string[] FileFormats => [FileFormat];
 
         public override FileBundle ConvertTyped(Effect data)
         {

Core/Conversion/Formats/LevelConverter.cs

@@ -7,12 +7,13 @@ namespace FEZRepacker.Core.Conversion.Formats
 {
     internal class LevelConverter : FormatConverter<Level>
     {
-        public override string FileFormat => ".fezlvl";
+        private const string BundleFileFormat = ".fezlvl";
+        public override string[] FileFormats => [BundleFileFormat];
 
         public override FileBundle ConvertTyped(Level data)
         {
             var levelModel = new LevelJsonModel(data);
-            return ConfiguredJsonSerializer.SerializeToFileBundle(FileFormat, levelModel);
+            return ConfiguredJsonSerializer.SerializeToFileBundle(BundleFileFormat, levelModel);
         }
 
         public override Level DeconvertTyped(FileBundle bundle)

Core/Conversion/Formats/MapTreeConverter.cs

@@ -7,13 +7,14 @@ namespace FEZRepacker.Core.Conversion.Formats
 {
     internal class MapTreeConverter : FormatConverter<MapTree>
     {
-        public override string FileFormat => ".fezmap";
+        private const string BundleFileFormat = ".fezmap";
+        public override string[] FileFormats => [BundleFileFormat];
 
         public override FileBundle ConvertTyped(MapTree data)
         {
             var mapModel = new MapTreeJsonModel();
             mapModel.SerializeFrom(data);
-            return ConfiguredJsonSerializer.SerializeToFileBundle(FileFormat, mapModel);
+            return ConfiguredJsonSerializer.SerializeToFileBundle(BundleFileFormat, mapModel);
         }
 
         public override MapTree DeconvertTyped(FileBundle bundle)

Core/Conversion/Formats/NpcMetadataConverter.cs

@@ -6,11 +6,12 @@ namespace FEZRepacker.Core.Conversion.Formats
 {
     internal class NpcMetadataConverter : FormatConverter<NpcMetadata>
     {
-        public override string FileFormat => ".feznpc";
+        private const string BundleFileFormat = ".feznpc";
+        public override string[] FileFormats => [BundleFileFormat];
 
         public override FileBundle ConvertTyped(NpcMetadata data)
         {
-            return ConfiguredJsonSerializer.SerializeToFileBundle(FileFormat, data);
+            return ConfiguredJsonSerializer.SerializeToFileBundle(BundleFileFormat, data);
         }
 
         public override NpcMetadata DeconvertTyped(FileBundle bundle)

Core/Conversion/Formats/SkyConverter.cs

@@ -6,11 +6,12 @@ namespace FEZRepacker.Core.Conversion.Formats
 {
     internal class SkyConverter : FormatConverter<Sky>
     {
-        public override string FileFormat => ".fezsky";
+        private const string BundleFileFormat = ".fezsky";
+        public override string[] FileFormats => [BundleFileFormat];
 
         public override FileBundle ConvertTyped(Sky data)
         {
-            return ConfiguredJsonSerializer.SerializeToFileBundle(FileFormat, data);
+            return ConfiguredJsonSerializer.SerializeToFileBundle(BundleFileFormat, data);
         }
 
         public override Sky DeconvertTyped(FileBundle bundle)