Merge pull request #1041 from ReinaS-64892/feat-material-unused-prope…

…rty-remove

Feat material unused property remove

CHANGELOG-PRERELEASE.md

@@ -17,6 +17,10 @@ The format is based on [Keep a Changelog].
   - This component removes polygons like UV Tile Discard with Vertex Discard Mode.
 - Texture Optimizer support for tiling UV `#1268`
 - API for AtlasTexture Compability `#1269`
+- Automatically remove unnecessary material properties based on shader `#1041`
+  - This feature is added to `Remove Unused Objects` in `Trace and Optimize`.
+  - When you changed shader for an material, properties for previously used shaders might be remain
+  - This may increase your avatar size by unexpectedly including unused textures
 
 ### Changed
 - Transform gizmo are now hidden while you're editing box of Remove Mesh in Box `#1259`

CHANGELOG.md

@@ -44,6 +44,10 @@ The format is based on [Keep a Changelog].
 - Remove Mesh By UV Tile, a new way to remove polygons `#1263`
   - You now easily remove some polygons of models configured for UV Tile Discard.
   - This component removes polygons like UV Tile Discard with Vertex Discard Mode.
+- Automatically remove unnecessary material properties based on shader `#1041`
+  - This feature is added to `Remove Unused Objects` in `Trace and Optimize`.
+  - When you changed shader for an material, properties for previously used shaders might be remain
+  - This may increase your avatar size by unexpectedly including unused textures
 
 ### Changed
 - Skip Enablement Mismatched Renderers is now disabled by default `#1169`

Editor/OptimizerPlugin.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using Anatawa12.AvatarOptimizer.ndmf;
 using nadena.dev.ndmf;
 using nadena.dev.ndmf.builtin;
@@ -77,6 +77,7 @@ protected override void Configure()
                         .Then.Run(Processors.TraceAndOptimizes.AutoMergeSkinnedMesh.Instance)
                         .Then.Run(Processors.TraceAndOptimizes.FindUnusedObjects.Instance)
                         .Then.Run(Processors.TraceAndOptimizes.ConfigureRemoveZeroSizedPolygon.Instance)
+                        .Then.Run(Processors.TraceAndOptimizes.RemoveUnusedMaterialProperties.Instance)
                         .Then.Run(Processors.MergeBoneProcessor.Instance)
                         .Then.Run(Processors.RemoveZeroSizedPolygonProcessor.Instance)
                         .Then.Run(Processors.TraceAndOptimizes.OptimizeTexture.Instance)

Editor/Processors/TraceAndOptimize/RemoveUnusedMaterialProperties.cs

@@ -0,0 +1,125 @@
+using System.Collections.Generic;
+using System.Linq;
+using nadena.dev.ndmf;
+using UnityEditor;
+using UnityEngine;
+
+namespace Anatawa12.AvatarOptimizer.Processors.TraceAndOptimizes
+{
+    internal class RemoveUnusedMaterialProperties : TraceAndOptimizePass<RemoveUnusedMaterialProperties>
+    {
+        public override string DisplayName => "T&O: RemoveUnusedMaterialProperties";
+        protected override void Execute(BuildContext context, TraceAndOptimizeState state)
+        {
+            if (!state.RemoveUnusedObjects) { return; }
+            if (state.SkipRemoveMaterialUnusedProperties) { return; }
+
+            var renderers = context.GetComponents<Renderer>();
+            var cleaned = new HashSet<Material>();
+
+            void CleanMaterial(IEnumerable<Material?> materials)
+            {
+                foreach (var m in materials)
+                {
+                    if (m != null && !cleaned.Contains(m))
+                    {
+                        if (context.IsTemporaryAsset(m))
+                            RemoveUnusedProperties(m);
+                        cleaned.Add(m);
+                    }
+                }
+            }
+
+            foreach (var renderer in renderers)
+            {
+                if (renderer is SkinnedMeshRenderer smr)
+                {
+                    var meshInfo = context.GetMeshInfoFor(smr);
+                    foreach (var subMesh in meshInfo.SubMeshes)
+                        CleanMaterial(subMesh.SharedMaterials);
+                }
+                else
+                {
+                    CleanMaterial(renderer.sharedMaterials);
+                }
+
+                CleanMaterial(context.GetAnimationComponent(renderer).GetAllObjectProperties()
+                    .SelectMany(x => x.node.Value.PossibleValues)
+                    .OfType<Material>());
+            }
+        }
+
+        //MIT License
+        //Copyright (c) 2020-2021 lilxyzw
+        //https://github.com/lilxyzw/lilToon/blob/b96470d3dd9092b840052578048b2307fe6d8786/Assets/lilToon/Editor/lilMaterialUtils.cs#L658-L686
+        //
+        //https://light11.hatenadiary.com/entry/2018/12/04/224253
+        public static void RemoveUnusedProperties(Material material)
+        {
+            // TODO: support material variant
+            var so = new SerializedObject(material);
+            so.Update();
+            var savedProps = so.FindProperty("m_SavedProperties");
+
+            var texs = savedProps.FindPropertyRelative("m_TexEnvs");
+            DeleteUnused(ref texs, material);
+
+            var floats = savedProps.FindPropertyRelative("m_Floats");
+            DeleteUnused(ref floats, material);
+
+            var colors = savedProps.FindPropertyRelative("m_Colors");
+            DeleteUnused(ref colors, material);
+
+            so.ApplyModifiedProperties();
+        }
+
+        public static void DeleteUnused(ref SerializedProperty props, Material material)
+        {
+            for (var i = props.arraySize - 1; i >= 0; i--)
+            {
+                var porpertyName = props.GetArrayElementAtIndex(i).FindPropertyRelative("first").stringValue;
+                if (!material.HasProperty(porpertyName) && !fallbackShaderProperties.Contains(porpertyName))
+                {
+                    props.DeleteArrayElementAtIndex(i);
+                }
+            }
+        }
+
+        // TODO: change set of properties by fallback shader names
+        // https://creators.vrchat.com/avatars/shader-fallback-system
+        private static HashSet<string> fallbackShaderProperties = new HashSet<string>
+        {
+            "_MainTex",
+            "_MetallicGlossMap",
+            "_SpecGlossMap",
+            "_BumpMap",
+            "_ParallaxMap",
+            "_OcclusionMap",
+            "_EmissionMap",
+            "_DetailMask",
+            "_DetailAlbedoMap",
+            "_DetailNormalMap",
+            "_Color",
+            "_EmissionColor",
+            "_SpecColor",
+            "_Cutoff",
+            "_Glossiness",
+            "_GlossMapScale",
+            "_SpecularHighlights",
+            "_GlossyReflections",
+            "_SmoothnessTextureChannel",
+            "_Metallic",
+            "_SpecularHighlights",
+            "_GlossyReflections",
+            "_BumpScale",
+            "_Parallax",
+            "_OcclusionStrength",
+            "_DetailNormalMapScale",
+            "_UVSec",
+            "_Mode",
+            "_SrcBlend",
+            "_DstBlend",
+            "_ZWrite",
+        };
+    }
+}

Internal/TraceAndOptimizeBase/TraceAndOptimizeProcessor.cs

@@ -36,6 +36,7 @@ public class TraceAndOptimizeState
         public bool SkipMergeMaterials;
         public bool SkipRemoveEmptySubMesh;
         public bool SkipAnyStateToEntryExit;
+        public bool SkipRemoveMaterialUnusedProperties;
 
         public Dictionary<SkinnedMeshRenderer, HashSet<string>> PreserveBlendShapes =
             new Dictionary<SkinnedMeshRenderer, HashSet<string>>();
@@ -72,6 +73,7 @@ internal void Initialize(TraceAndOptimize config)
             SkipMergeMaterials = config.debugOptions.skipMergeMaterials;
             SkipRemoveEmptySubMesh = config.debugOptions.skipRemoveEmptySubMesh;
             SkipAnyStateToEntryExit = config.debugOptions.skipAnyStateToEntryExit;
+            SkipRemoveMaterialUnusedProperties = config.debugOptions.skipRemoveMaterialUnusedProperties;
 
             Enabled = true;
         }

Runtime/TraceAndOptimize.cs

@@ -138,6 +138,8 @@ internal struct DebugOptions
             public bool skipRemoveEmptySubMesh;
             [ToggleLeft]
             public bool skipAnyStateToEntryExit;
+            [ToggleLeft]
+            public bool skipRemoveMaterialUnusedProperties;
         }
     }
 }