feat: Initial integration with ABPF

This is a draft integration with the ABPF framework. For now, this removes the old Apply On Play logic; not sure if we want to put this back for a transition period.
anatawa12 · Sep 5, 2023 · 34edbda · 34edbda
1 parent 340cd30
commit 34edbda
Show file tree

Hide file tree

Showing 39 changed files with 48 additions and 1,024 deletions.
diff --git a/Editor/OptimizerProcessor.cs b/Editor/OptimizerProcessor.cs
@@ -1,49 +1,50 @@
 
 using System;
-using Anatawa12.ApplyOnPlay;
+using System.Collections.Immutable;
+using Anatawa12.AvatarOptimizer;
 using Anatawa12.AvatarOptimizer.ErrorReporting;
-using UnityEngine;
+using nadena.dev.ndmf;
 using VRC.SDK3.Avatars.Components;
-using VRC.SDKBase.Editor.BuildPipeline;
+
+[assembly: ExportsPlugin(typeof(OptimizerPlugin))]
 
 namespace Anatawa12.AvatarOptimizer
 {
+    internal class OptimizerPlugin : Plugin
+    {
+        public override string QualifiedName => "Anatawa12.AvatarOptimizer";
+
+        public override ImmutableList<string> RunsAfter => ImmutableList<string>.Empty.Add("nadena.dev.modular-avatar");
+
+        public override ImmutableList<PluginPass> Passes => ImmutableList<PluginPass>.Empty
+            .Add(new EarlyOptimizerProcessor())
+            .Add(new OptimizerProcessor());
+    }
+
     /// <summary>
     /// the Processor runs before removing EditorOnly
     /// </summary>
-    internal class EarlyOptimizerProcessor : IVRCSDKPreprocessAvatarCallback, IApplyOnPlayCallback
+    internal class EarlyOptimizerProcessor : PluginPass
     {
-        public int callbackOrder => -2048;
+        public override BuiltInPhase ExecutionPhase => BuiltInPhase.Resolving;
+
         public string CallbackName => "Avatar Optimizer Early (Before IEditorOnly Deletion)";
         public string CallbackId => "com.anatawa12.avatar-optimizer.early";
 
-        public bool ApplyOnPlay(GameObject avatarGameObject, ApplyReason reason)
-        {
-            ProcessObject(new OptimizerSession(avatarGameObject, Utils.CreateOutputAssetFile(avatarGameObject, reason),
-                reason == ApplyReason.EnteringPlayMode));
-            return true;
-        }
+        private static bool _processing;
 
-        public bool OnPreprocessAvatar(GameObject avatarGameObject)
+        public override ImmutableList<string> RunsBefore => ImmutableList<string>.Empty
+            .Add(SystemPassNames.RemoveEditorOnly);
+
+        public override void Process(BuildContext context)
         {
-            try
-            {
-                ProcessObject(new OptimizerSession(avatarGameObject, true, false));
-                return true;
-            }
-            catch (Exception e)
-            {
-                Debug.LogError(e);
-                return false;
-            }
+            ProcessObject(new OptimizerSession(context.AvatarRootObject, false, false));
         }
-
-        private static bool _processing;
-
+
         internal static void ProcessObject(OptimizerSession session)
         {
             if (_processing) return;
-            using (Utils.StartEditingScope(true))
+            //using (Utils.StartEditingScope(true))
             using (BuildReport.ReportingOnAvatar(session.GetRootComponent<VRCAvatarDescriptor>()))
             {
                 try
@@ -72,44 +73,24 @@ private static void DoProcessObject(OptimizerSession session)
         }
     }
 
-    internal class OptimizerProcessor : IVRCSDKPreprocessAvatarCallback, IVRCSDKPostprocessAvatarCallback, IApplyOnPlayCallback
+    internal class OptimizerProcessor : PluginPass
     {
-        public int callbackOrder => 0;
+        public override BuiltInPhase ExecutionPhase => BuiltInPhase.Optimization;
+
         public string CallbackName => "Avatar Optimizer Main";
         public string CallbackId => "com.anatawa12.avatar-optimizer.main";
-
-        public bool ApplyOnPlay(GameObject avatarGameObject, ApplyReason reason)
-        {
-            ProcessObject(new OptimizerSession(avatarGameObject, Utils.CreateOutputAssetFile(avatarGameObject, reason),
-                reason == ApplyReason.EnteringPlayMode));
-            return true;
-        }
-
-        public bool OnPreprocessAvatar(GameObject avatarGameObject)
-        {
-            try
-            {
-                ProcessObject(new OptimizerSession(avatarGameObject, true, false));
-                return true;
-            }
-            catch (Exception e)
-            {
-                Debug.LogError(e);
-                return false;
-            }
-        }
-
-        public void OnPostprocessAvatar()
+
+        public override void Process(BuildContext context)
         {
-            Utils.DeleteTemporalDirectory();
+            ProcessObject(new OptimizerSession(context.AvatarRootObject, false, false));
         }
 
         private static bool _processing;
 
         public static void ProcessObject(OptimizerSession session)
         {
             if (_processing) return;
-            using (Utils.StartEditingScope(true))
+            //using (Utils.StartEditingScope(true))
             using (BuildReport.ReportingOnAvatar(session.GetRootComponent<VRCAvatarDescriptor>()))
             {
                 try
@@ -145,8 +126,6 @@ private static void DoProcessObject(OptimizerSession session)
             new Processors.MakeChildrenProcessor(early: false).Process(session);
 
             new Processors.ApplyObjectMapping().Apply(session);
-
-            session.MarkDirtyAll();
         }
     }
 }
diff --git a/Editor/OptimizerSession.cs b/Editor/OptimizerSession.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using nadena.dev.ndmf;
 using UnityEditor;
 using UnityEngine;
 using Object = UnityEngine.Object;
@@ -15,8 +16,14 @@ internal class OptimizerSession
         public bool IsTest { get; }
         public ObjectMappingBuilder MappingBuilder { get; }
 
+        public OptimizerSession(BuildContext context)
+        : this(context.AvatarRootObject, null, false)
+        {
+
+        }
+
         public OptimizerSession(GameObject rootObject, bool addToAsset, bool isTest) :
-            this(rootObject, addToAsset ? Utils.CreateAssetFile() : null, isTest)
+            this(rootObject, null, isTest)
         {
         }
 

diff --git a/Editor/Utils.cs b/Editor/Utils.cs
@@ -3,7 +3,6 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
-using Anatawa12.ApplyOnPlay;
 using JetBrains.Annotations;
 using Unity.Collections;
 using UnityEditor;
@@ -312,68 +311,6 @@ public static GameObject NewGameObject(string name, Transform parent)
             return rootObject;
         }
 
-        private const string TemporalDirPath = "Assets/9999-OptimizerGeneratedTemporalAssets";
-        private const string OutputDirPath = "Assets/AvatarOptimizerOutput";
-
-        public static void DeleteTemporalDirectory()
-        {
-            AssetDatabase.SaveAssets();
-            AssetDatabase.DeleteAsset(TemporalDirPath);
-            FileUtil.DeleteFileOrDirectory(TemporalDirPath);
-        }
-
-        [CanBeNull]
-        public static DummyObject CreateOutputAssetFile(GameObject avatarGameObject, ApplyReason reason)
-        {
-            switch (reason)
-            {
-                case ApplyReason.EnteringPlayMode:
-                    return ApplyOnPlayConfig.Generate ? CreateAssetFile() : null;
-                case ApplyReason.ManualBake:
-                default:
-                    return CreateOutputAssetFile(avatarGameObject);
-            }
-        }
-
-        public static DummyObject CreateAssetFile()
-        {
-            var obj = ScriptableObject.CreateInstance<DummyObject>();
-            Directory.CreateDirectory(TemporalDirPath);
-            AssetDatabase.CreateAsset(obj, $"{TemporalDirPath}/{GUID.Generate()}.asset");
-            return obj;
-        }
-
-        public static DummyObject CreateOutputAssetFile(GameObject avatar)
-        {
-            var name = avatar.name;
-            if (name.EndsWith("(Clone)", StringComparison.Ordinal))
-                name = name.Substring(0, name.Length - "(Clone)".Length);
-            return CreateOutputAssetFile(name);
-        }
-
-        public static DummyObject CreateOutputAssetFile(string name)
-        {
-            Directory.CreateDirectory(OutputDirPath);
-            name = string.Join("_", name.Split(Path.GetInvalidFileNameChars()));
-            var path = GetUniqueFileName($"{OutputDirPath}/{name}", "asset");
-            var obj = ScriptableObject.CreateInstance<DummyObject>();
-            AssetDatabase.CreateAsset(obj, path);
-            return obj;
-        }
-
-        private static string GetUniqueFileName(string name, string extension)
-        {
-            // TOCTOU is allowed for now
-            string PathIfNotExists(string path) => File.Exists(path) || Directory.Exists(path) ? null : path;
-
-            if (PathIfNotExists($"{name}.{extension}") is string firstTry) return firstTry;
-
-            for (var number = 0; ; number++)
-            {
-                if (PathIfNotExists($"{name} ({number}).{extension}") is string otherTry) return otherTry;
-            }
-        }
-
         public static ZipWithNextEnumerable<T> ZipWithNext<T>(this IEnumerable<T> enumerable) =>
             new ZipWithNextEnumerable<T>(enumerable);
 

diff --git a/Editor/com.anatawa12.avatar-optimizer.editor.asmdef b/Editor/com.anatawa12.avatar-optimizer.editor.asmdef
@@ -9,7 +9,8 @@
         "GUID:f69eeb3e25674f4a9bd20e6d7e69e0e6",
         "GUID:2633ab9fa94544a69517fc9a1bc143c9",
         "GUID:b9880ca0b6584453a2627bd3c038759f",
-        "GUID:8542dbf824204440a818dbc2377cb4d6"
+        "GUID:8542dbf824204440a818dbc2377cb4d6",
+        "GUID:62ced99b048af7f4d8dfe4bed8373d76"
     ],
     "includePlatforms": [
         "Editor"
@@ -25,7 +26,8 @@
         "VRCSDK3A.dll",
         "VRCSDKBase-Editor.dll",
         "VRCSDKBase.dll",
-        "System.Memory.dll"
+        "System.Memory.dll",
+        "System.Collections.Immutable.dll"
     ],
     "autoReferenced": false,
     "defineConstraints": [],

diff --git a/Internal/ApplyOnPlay.meta b/Internal/ApplyOnPlay.meta
diff --git a/Internal/ApplyOnPlay/Editor.meta b/Internal/ApplyOnPlay/Editor.meta
diff --git a/Internal/ApplyOnPlay/Editor/ApplyOnPlayCallbackRegistry.cs b/Internal/ApplyOnPlay/Editor/ApplyOnPlayCallbackRegistry.cs
diff --git a/Internal/ApplyOnPlay/Editor/ApplyOnPlayCallbackRegistry.cs.meta b/Internal/ApplyOnPlay/Editor/ApplyOnPlayCallbackRegistry.cs.meta