@vvfx/ge-ir 0.0.1-beta.2 → 0.0.1-beta.3

package/dist/ge2ir/types.d.ts

@@ -5,6 +5,7 @@ export interface GE2IROptions {
 }
 export type { GE2IRPassthroughMetadata } from '../shared/ge2ir-metadata';
 export interface GESceneContext {
+    compositionId: string;
     width: number;
     height: number;
     frameRate: number;
@@ -22,3 +23,4 @@ export interface GESceneContext {
     textureById: GEPoolIndex;
     itemIdToTrackId: Map<string, string>;
 }
+export type GEJsonContext = GESceneContext;

package/dist/index.js

@@ -3,7 +3,7 @@
  * Description: Galacean Effects and animation IR bidirectional conversion package
  * Author: Ant Group CO., Ltd.
  * Contributors: 澄弈
- * Version: v0.0.1-beta.2
+ * Version: v0.0.1-beta.3
  */
 
 'use strict';
@@ -23,6 +23,11 @@ function _extends() {
     return _extends.apply(this, arguments);
 }
 
+function _type_of(obj) {
+    "@swc/helpers - typeof";
+    return obj && typeof Symbol !== "undefined" && obj.constructor === Symbol ? "symbol" : typeof obj;
+}
+
 function _array_like_to_array(arr, len) {
     if (len == null || len > arr.length) len = arr.length;
     for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
@@ -126,6 +131,9 @@ var DEFAULT_CLIP_MODE = 1;
     var childTrackIds = [];
     childTrackIds.push(toDataPath(buildActivationTrack(collector, delay, duration, endBehavior)));
     childTrackIds.push(toDataPath(buildTransformTrack(collector, delay, duration, endBehavior, animation)));
+    if (isPrecompItemType(itemType)) {
+        childTrackIds.push(toDataPath(buildSubCompositionTrack(collector, delay, duration, endBehavior)));
+    }
     if (!isNullItemType(itemType)) {
         childTrackIds.push(toDataPath(buildSpriteColorTrack(collector, delay, duration, endBehavior, animation)));
     }
@@ -138,7 +146,10 @@ var DEFAULT_CLIP_MODE = 1;
     return objectBindingTrackId;
 }
 function isNullItemType(itemType) {
-    return itemType === 'null' || itemType === '3';
+    return itemType === 'null' || itemType === '3' || isPrecompItemType(itemType);
+}
+function isPrecompItemType(itemType) {
+    return itemType === 'precomp' || itemType === '7';
 }
 function buildActivationTrack(collector, delay, duration, endBehavior) {
     var assetId = createId();
@@ -226,6 +237,28 @@ function buildSpriteColorTrack(collector, delay, duration, endBehavior, animatio
     });
     return trackId;
 }
+function buildSubCompositionTrack(collector, delay, duration, endBehavior) {
+    var assetId = createId();
+    collector.miscs.push({
+        id: assetId,
+        dataType: 'SubCompositionPlayableAsset'
+    });
+    var trackId = createId();
+    collector.miscs.push({
+        id: trackId,
+        dataType: 'SubCompositionTrack',
+        children: [],
+        clips: [
+            {
+                start: roundNumber(delay, 4),
+                duration: roundNumber(duration, 4),
+                endBehavior: endBehavior,
+                asset: toDataPath(assetId)
+            }
+        ]
+    });
+    return trackId;
+}
 
 var DEFAULT_OUT_TANGENT = {
     x: 0.33,
@@ -774,11 +807,6 @@ function getTimeContext(layer) {
     };
 }
 
-function _type_of(obj) {
-    "@swc/helpers - typeof";
-    return obj && typeof Symbol !== "undefined" && obj.constructor === Symbol ? "symbol" : typeof obj;
-}
-
 function readGE2IRMetadata(ir, layer) {
     if (ir.source !== 'ge') {
         return undefined;
@@ -788,7 +816,7 @@ function readGE2IRMetadata(ir, layer) {
         return undefined;
     }
     var namespaced = metadata['ge2ir'];
-    if (isRecord$1(namespaced)) {
+    if (isRecord$4(namespaced)) {
         return namespaced;
     }
     var legacy = readLegacyGE2IRMetadata(metadata);
@@ -802,27 +830,46 @@ function readLegacyGE2IRMetadata(metadata) {
     var colorOverLifetime = metadata['colorOverLifetime'];
     var geComponentId = metadata['geComponentId'];
     var geMask = metadata['geMask'];
-    if (isRecord$1(positionOverLifetime)) {
+    var precompRefId = metadata['precompRefId'];
+    var precompContent = metadata['precompContent'];
+    if (isRecord$4(positionOverLifetime)) {
         legacy.positionOverLifetime = positionOverLifetime;
     }
-    if (isRecord$1(rotationOverLifetime)) {
+    if (isRecord$4(rotationOverLifetime)) {
         legacy.rotationOverLifetime = rotationOverLifetime;
     }
-    if (isRecord$1(sizeOverLifetime)) {
+    if (isRecord$4(sizeOverLifetime)) {
         legacy.sizeOverLifetime = sizeOverLifetime;
     }
-    if (isRecord$1(colorOverLifetime)) {
+    if (isRecord$4(colorOverLifetime)) {
         legacy.colorOverLifetime = colorOverLifetime;
     }
     if (typeof geComponentId === 'string') {
         legacy.geComponentId = geComponentId;
     }
-    if (isRecord$1(geMask)) {
+    if (isRecord$4(geMask)) {
         legacy.geMask = geMask;
     }
+    if (typeof precompRefId === 'string') {
+        legacy.precompRefId = precompRefId;
+    }
+    if (isRecord$4(precompContent)) {
+        legacy.precompContent = precompContent;
+    }
     return legacy;
 }
-function isRecord$1(value) {
+function readGE2IRCompositionMetadata(ir) {
+    if (ir.source !== 'ge') {
+        return undefined;
+    }
+    var metadata = ir.metadata;
+    if (metadata == null) {
+        return undefined;
+    }
+    var namespaced = metadata['ge2ir'];
+    return isRecord$4(namespaced) ? namespaced : undefined;
+}
+function isRecord$4(value) {
     return value != null && (typeof value === "undefined" ? "undefined" : _type_of(value)) === 'object' && !Array.isArray(value);
 }
 
@@ -1704,6 +1751,61 @@ function processNullLayer(layer, ctx) {
         layerIndex: layerIndex
     });
 }
+function processPrecompLayer(layer, ctx) {
+    var itemId = createId();
+    var layerIndex = layer.index;
+    ctx.layerToItemId[layerIndex] = itemId;
+    var _computeLayerTiming = computeLayerTiming(layer, ctx.frameRate), delay = _computeLayerTiming.delay, layerDuration = _computeLayerTiming.layerDuration;
+    var animation = buildTransformAnimation(layer, ctx);
+    var position = computeStaticPosition(layer, ctx);
+    var objectBindingTrackId = buildTimelineTracks(ctx.collector, delay, layerDuration, 4, animation, 'precomp');
+    var geMetadata = readGE2IRMetadata(ctx.ir, layer);
+    var content = buildPrecompContent(geMetadata == null ? void 0 : geMetadata.precompContent, geMetadata == null ? void 0 : geMetadata.precompRefId);
+    var item = {
+        id: itemId,
+        dataType: 'VFXItemData',
+        name: layer.name,
+        duration: layerDuration,
+        type: '7',
+        visible: layer.visibility.enabled && !layer.visibility.hidden,
+        endBehavior: 4,
+        delay: delay,
+        renderLevel: 'B+',
+        content: content,
+        components: [],
+        transform: buildGETransform(position, [
+            0,
+            0,
+            0
+        ], [
+            1,
+            1,
+            1
+        ])
+    };
+    ctx.collector.items.push(item);
+    ctx.processedItems.push({
+        itemId: itemId,
+        objectBindingTrackId: objectBindingTrackId,
+        layerIndex: layerIndex
+    });
+}
+function buildPrecompContent(rawContent, refId) {
+    var content = rawContent != null ? cloneRecord(rawContent) : {};
+    var rawOptions = content['options'];
+    var options = isRecord$3(rawOptions) ? _extends({}, rawOptions) : {};
+    if (refId != null) {
+        options['refId'] = refId;
+    }
+    content['options'] = options;
+    return content;
+}
+function cloneRecord(value) {
+    return JSON.parse(JSON.stringify(value));
+}
+function isRecord$3(value) {
+    return value != null && (typeof value === "undefined" ? "undefined" : _type_of(value)) === 'object' && !Array.isArray(value);
+}
 /**
  * Emit a null+sprite pair: the null carries the layer transform and sits at
  * the layer's logical position; the sprite/text child carries the visual
@@ -2927,10 +3029,16 @@ function applyVisibilityStep(ir, state) {
     });
     collector.items.reverse();
     processedItems.reverse();
-    return assembleScene(workingIR, collector, processedItems, duration);
+    return mergePreservedPrecompScene(assembleScene(workingIR, collector, processedItems, duration), workingIR);
 }
 function processLayer(layer, ctx) {
-    if (layer.type === 'null' || layer.type === 'precomp') {
+    if (layer.type === 'precomp') {
+        if (hasGEPrecompMetadata(ctx.ir, layer)) {
+            processPrecompLayer(layer, ctx);
+        } else {
+            processNullLayer(layer, ctx);
+        }
+    } else if (layer.type === 'null') {
         processNullLayer(layer, ctx);
     } else if (ctx.parentIndexSet.has(layer.index)) {
         processParentLayer(layer, ctx);
@@ -2938,6 +3046,10 @@ function processLayer(layer, ctx) {
         processVisualLayer(layer, ctx);
     }
 }
+function hasGEPrecompMetadata(ir, layer) {
+    var metadata = readGE2IRMetadata(ir, layer);
+    return (metadata == null ? void 0 : metadata.precompRefId) != null || (metadata == null ? void 0 : metadata.precompContent) != null;
+}
 /**
  * Extend parent layers' endFrame to cover transform-only children's time spans.
  *
@@ -2975,6 +3087,209 @@ function processLayer(layer, ctx) {
     }
     return clonedLayers;
 }
+function mergePreservedPrecompScene(generated, ir) {
+    var _loop = function() {
+        var pool = _step.value;
+        result[pool] = mergePool(asArray(generated[pool]), asArray(sourceScene[pool]).filter(function(entry) {
+            return !isExcludedPoolEntry(pool, entry, excluded);
+        }));
+    };
+    var metadata = readGE2IRCompositionMetadata(ir);
+    var sourceScene = metadata == null ? void 0 : metadata.sourceScene;
+    if (sourceScene == null) {
+        return generated;
+    }
+    var result = _extends({}, generated);
+    var sourceCompositionId = metadata == null ? void 0 : metadata.sourceCompositionId;
+    var excluded = collectRootCompositionIds(sourceScene, sourceCompositionId);
+    var pools = [
+        'images',
+        'fonts',
+        'plugins',
+        'components',
+        'geometries',
+        'materials',
+        'items',
+        'shaders',
+        'bins',
+        'textures',
+        'animations',
+        'miscs'
+    ];
+    for(var _iterator = _create_for_of_iterator_helper_loose(pools), _step; !(_step = _iterator()).done;)_loop();
+    result['compositions'] = mergePool(asRecordArray(generated['compositions']), asRecordArray(sourceScene['compositions']).filter(function(comp) {
+        return comp['id'] !== sourceCompositionId;
+    }));
+    return result;
+}
+function collectRootCompositionIds(sourceScene, sourceCompositionId) {
+    var excluded = {
+        components: new Set(),
+        items: new Set(),
+        miscs: new Set()
+    };
+    if (sourceCompositionId == null) {
+        return excluded;
+    }
+    var components = asRecordArray(sourceScene['components']);
+    var items = asRecordArray(sourceScene['items']);
+    var miscs = asRecordArray(sourceScene['miscs']);
+    var componentById = indexById(components);
+    var itemById = indexById(items);
+    var miscById = indexById(miscs);
+    var rootComposition = asRecordArray(sourceScene['compositions']).find(function(composition) {
+        return composition['id'] === sourceCompositionId;
+    });
+    if (rootComposition == null) {
+        return excluded;
+    }
+    for(var _iterator = _create_for_of_iterator_helper_loose(asDataPathArray(rootComposition['components'])), _step; !(_step = _iterator()).done;){
+        var componentRef = _step.value;
+        var componentId = componentRef.id;
+        var component = componentById.get(componentId);
+        if (component == null) {
+            continue;
+        }
+        excluded.components.add(componentId);
+        for(var _iterator1 = _create_for_of_iterator_helper_loose(asDataPathArray(component['items'])), _step1; !(_step1 = _iterator1()).done;){
+            var itemRef = _step1.value;
+            collectItemAndOwnedComponents(itemRef.id, itemById, excluded);
+        }
+        var timelineAssetId = readDataPathId(component['timelineAsset']);
+        if (timelineAssetId != null) {
+            collectMiscGraph(timelineAssetId, miscById, excluded);
+        }
+        for(var _iterator2 = _create_for_of_iterator_helper_loose(asRecordArray(component['sceneBindings'])), _step2; !(_step2 = _iterator2()).done;){
+            var binding = _step2.value;
+            var trackId = readDataPathId(binding['key']);
+            if (trackId != null) {
+                collectMiscGraph(trackId, miscById, excluded);
+            }
+        }
+    }
+    return excluded;
+}
+function collectItemAndOwnedComponents(itemId, itemById, excluded) {
+    var item = itemById.get(itemId);
+    if (item == null || excluded.items.has(itemId)) {
+        return;
+    }
+    excluded.items.add(itemId);
+    for(var _iterator = _create_for_of_iterator_helper_loose(asDataPathArray(item['components'])), _step; !(_step = _iterator()).done;){
+        var componentRef = _step.value;
+        excluded.components.add(componentRef.id);
+    }
+}
+function collectMiscGraph(miscId, miscById, excluded) {
+    if (excluded.miscs.has(miscId)) {
+        return;
+    }
+    var misc = miscById.get(miscId);
+    if (misc == null) {
+        return;
+    }
+    excluded.miscs.add(miscId);
+    for(var _iterator = _create_for_of_iterator_helper_loose(asDataPathArray(misc['tracks'])), _step; !(_step = _iterator()).done;){
+        var childRef = _step.value;
+        collectMiscGraph(childRef.id, miscById, excluded);
+    }
+    for(var _iterator1 = _create_for_of_iterator_helper_loose(asDataPathArray(misc['children'])), _step1; !(_step1 = _iterator1()).done;){
+        var childRef1 = _step1.value;
+        collectMiscGraph(childRef1.id, miscById, excluded);
+    }
+    for(var _iterator2 = _create_for_of_iterator_helper_loose(asRecordArray(misc['clips'])), _step2; !(_step2 = _iterator2()).done;){
+        var clip = _step2.value;
+        var assetId = readDataPathId(clip['asset']);
+        if (assetId != null) {
+            collectMiscGraph(assetId, miscById, excluded);
+        }
+    }
+}
+function isExcludedPoolEntry(pool, entry, excluded) {
+    if (!isRecord$2(entry)) {
+        return false;
+    }
+    var id = entry['id'];
+    if (typeof id !== 'string') {
+        return false;
+    }
+    if (pool === 'components') {
+        return excluded.components.has(id);
+    }
+    if (pool === 'items') {
+        return excluded.items.has(id);
+    }
+    if (pool === 'miscs') {
+        return excluded.miscs.has(id);
+    }
+    return false;
+}
+function mergePool(generated, preserved) {
+    var result = [].concat(generated);
+    var seen = new Set();
+    for(var _iterator = _create_for_of_iterator_helper_loose(result), _step; !(_step = _iterator()).done;){
+        var entry = _step.value;
+        var key = poolEntryKey(entry);
+        if (key != null) {
+            seen.add(key);
+        }
+    }
+    for(var _iterator1 = _create_for_of_iterator_helper_loose(preserved), _step1; !(_step1 = _iterator1()).done;){
+        var entry1 = _step1.value;
+        var key1 = poolEntryKey(entry1);
+        if (key1 != null) {
+            if (seen.has(key1)) {
+                continue;
+            }
+            seen.add(key1);
+        }
+        result.push(cloneJson$1(entry1));
+    }
+    return result;
+}
+function poolEntryKey(entry) {
+    var id = isRecord$2(entry) ? entry['id'] : undefined;
+    if (typeof id === 'string') {
+        return "id:" + id;
+    }
+    return "json:" + JSON.stringify(entry);
+}
+function asArray(value) {
+    return Array.isArray(value) ? value : [];
+}
+function asRecordArray(value) {
+    return Array.isArray(value) ? value.filter(function(entry) {
+        return entry != null && (typeof entry === "undefined" ? "undefined" : _type_of(entry)) === 'object' && !Array.isArray(entry);
+    }) : [];
+}
+function asDataPathArray(value) {
+    return Array.isArray(value) ? value.filter(function(entry) {
+        return isRecord$2(entry) && typeof entry['id'] === 'string';
+    }) : [];
+}
+function readDataPathId(value) {
+    return isRecord$2(value) && typeof value['id'] === 'string' ? value['id'] : undefined;
+}
+function indexById(entries) {
+    var map = new Map();
+    for(var _iterator = _create_for_of_iterator_helper_loose(entries), _step; !(_step = _iterator()).done;){
+        var entry = _step.value;
+        var id = entry['id'];
+        if (typeof id === 'string') {
+            map.set(id, entry);
+        }
+    }
+    return map;
+}
+function cloneJson$1(value) {
+    if (value === undefined) {
+        return value;
+    }
+    return JSON.parse(JSON.stringify(value));
+}
+function isRecord$2(value) {
+    return value != null && (typeof value === "undefined" ? "undefined" : _type_of(value)) === 'object' && !Array.isArray(value);
+}
 
 function buildPoolIndex(pool) {
     var map = new Map();
@@ -3072,6 +3387,7 @@ function buildSceneContext(scene, options) {
     var textureById = buildPoolIndex(textures);
     var itemIdToTrackId = buildSceneBindings(componentById, miscById, composition);
     return {
+        compositionId: compositionId,
         width: width,
         height: height,
         frameRate: frameRate,
@@ -4335,7 +4651,7 @@ function hasParentTransformSignal(desc, ctx) {
         return true;
     }
     var transform = desc.item['transform'];
-    return isRecord(transform) && (hasNonDefaultScale(transform) || hasNonDefaultEulerHint(transform));
+    return isRecord$1(transform) && (hasNonDefaultScale(transform) || hasNonDefaultEulerHint(transform));
 }
 function hasNoIndependentChildTransform(desc, ctx) {
     var timeline = parseTimeline(desc.itemId, ctx);
@@ -4349,7 +4665,7 @@ function hasTransformPayload(asset) {
 }
 function hasNonDefaultScale(transform) {
     var scale = transform['scale'];
-    if (!isRecord(scale)) {
+    if (!isRecord$1(scale)) {
         return false;
     }
     var x = typeof scale['x'] === 'number' ? scale['x'] : 1;
@@ -4359,7 +4675,7 @@ function hasNonDefaultScale(transform) {
 }
 function hasNonDefaultEulerHint(transform) {
     var eulerHint = transform['eulerHint'];
-    if (!isRecord(eulerHint)) {
+    if (!isRecord$1(eulerHint)) {
         return false;
     }
     var x = typeof eulerHint['x'] === 'number' ? eulerHint['x'] : 0;
@@ -4368,7 +4684,7 @@ function hasNonDefaultEulerHint(transform) {
     return Math.abs(x) > 1e-6 || Math.abs(y) > 1e-6 || Math.abs(z) > 1e-6;
 }
 function hasNonEmptyRecord(value) {
-    return isRecord(value) && Object.keys(value).length > 0;
+    return isRecord$1(value) && Object.keys(value).length > 0;
 }
 function readItemEndBehavior(item) {
     var endBehavior = item['endBehavior'];
@@ -4377,7 +4693,7 @@ function readItemEndBehavior(item) {
 function nearlyEqual(a, b) {
     return Math.abs(a - b) < 1e-6;
 }
-function isRecord(value) {
+function isRecord$1(value) {
     return value != null && (typeof value === "undefined" ? "undefined" : _type_of(value)) === 'object' && !Array.isArray(value);
 }
 function mergeNullAndSprite(nullDesc, childDesc, ctx) {
@@ -4431,8 +4747,8 @@ function mergeNullAndSprite(nullDesc, childDesc, ctx) {
     // side overwrites the other's GE round-trip data.
     if (childDesc.layer.metadata != null) {
         var _merged_metadata;
-        var parentGE2IR = isRecord((_merged_metadata = merged.metadata) == null ? void 0 : _merged_metadata['ge2ir']) ? merged.metadata['ge2ir'] : undefined;
-        var childGE2IR = isRecord(childDesc.layer.metadata['ge2ir']) ? childDesc.layer.metadata['ge2ir'] : undefined;
+        var parentGE2IR = isRecord$1((_merged_metadata = merged.metadata) == null ? void 0 : _merged_metadata['ge2ir']) ? merged.metadata['ge2ir'] : undefined;
+        var childGE2IR = isRecord$1(childDesc.layer.metadata['ge2ir']) ? childDesc.layer.metadata['ge2ir'] : undefined;
         merged.metadata = _extends({}, merged.metadata, childDesc.layer.metadata);
         if (parentGE2IR != null || childGE2IR != null) {
             merged.metadata['ge2ir'] = _extends({}, parentGE2IR != null ? parentGE2IR : {}, childGE2IR != null ? childGE2IR : {});
@@ -4540,7 +4856,8 @@ function convertGEToIR(scene, options) {
         outPoint: ctx.outPoint,
         backgroundColor: ctx.backgroundColor,
         endBehavior: ctx.endBehavior,
-        layers: layers
+        layers: layers,
+        metadata: buildCompositionMetadata(scene, ctx.compositionId, itemIds, ctx)
     };
 }
 function parseItemToLayer(item, itemId, index, ctx) {
@@ -4564,6 +4881,8 @@ function parseItemToLayer(item, itemId, index, ctx) {
         type = 'shape';
     } else if ((componentData == null ? void 0 : componentData.type) === 'image') {
         type = 'image';
+    } else if (geType === '7') {
+        type = 'precomp';
     } else if ((componentData == null ? void 0 : componentData.solidColor) != null) {
         type = 'solid';
     } else if (geType === '1') {
@@ -4754,7 +5073,9 @@ function parseItemToLayer(item, itemId, index, ctx) {
     }
     var geComponentId = componentData == null ? void 0 : componentData.geComponentId;
     var rawMask = componentData == null ? void 0 : componentData.rawMask;
-    if (rawTransformPassthrough != null || rawColorOverLifetime != null || geComponentId != null || rawMask != null) {
+    var precompContent = geType === '7' ? item['content'] : undefined;
+    var precompRefId = isRecord(precompContent == null ? void 0 : precompContent['options']) ? precompContent['options']['refId'] : undefined;
+    if (rawTransformPassthrough != null || rawColorOverLifetime != null || geComponentId != null || rawMask != null || typeof precompRefId === 'string' || precompContent != null) {
         // Mask round-trip: geComponentId is the rendezvous key linking a target's
         // mask.reference.id (a GE1 component id) to the regenerated GE2 component id.
         // ir2ge copies ge2ir.geMask onto the rebuilt component and a post-process pass
@@ -4765,6 +5086,10 @@ function parseItemToLayer(item, itemId, index, ctx) {
             geComponentId: geComponentId
         }, rawMask != null && {
             geMask: rawMask
+        }, typeof precompRefId === 'string' && {
+            precompRefId: precompRefId
+        }, precompContent != null && {
+            precompContent: cloneJson(precompContent)
         });
         layer.metadata = _extends({}, layer.metadata, {
             ge2ir: ge2irMetadata
@@ -4772,6 +5097,29 @@ function parseItemToLayer(item, itemId, index, ctx) {
     }
     return layer;
 }
+function buildCompositionMetadata(scene, compositionId, itemIds, ctx) {
+    if (!hasPrecompItem(itemIds, ctx)) {
+        return undefined;
+    }
+    return {
+        ge2ir: {
+            sourceCompositionId: compositionId,
+            sourceScene: cloneJson(scene)
+        }
+    };
+}
+function hasPrecompItem(itemIds, ctx) {
+    return itemIds.some(function(itemId) {
+        var _ctx_itemById_get;
+        return ((_ctx_itemById_get = ctx.itemById.get(itemId)) == null ? void 0 : _ctx_itemById_get['type']) === '7';
+    });
+}
+function cloneJson(value) {
+    return JSON.parse(JSON.stringify(value));
+}
+function isRecord(value) {
+    return value != null && (typeof value === "undefined" ? "undefined" : _type_of(value)) === 'object' && !Array.isArray(value);
+}
 
 /**
  * Read-side accessors for the `IRLayerNode.specific.lottie` slot.