🎥 Make videos programmatically with React
Make automatic Sequence outlines available in Canvas
JonnyBurger153ca7bda31f
diff --git a/packages/canvas/src/canvas-internals.ts b/packages/canvas/src/canvas-internals.tsindex 037df543f8..9f89540b18 100644--- a/packages/canvas/src/canvas-internals.ts+++ b/packages/canvas/src/canvas-internals.ts@@ -1,4 +1,8 @@// Shared with Remotion Studio through CanvasInternals on the package root.+export {+ collectCommitOrderFromFiber,+ installFiberCommitOrderObserver,+} from './install-fiber-sequence-order-observer';export {calculateTimeline} from './calculate-timeline';export {useIsCanvasSequenceHovered} from './hover';export type {diff --git a/packages/canvas/src/canvas.tsx b/packages/canvas/src/canvas.tsxindex 33b10a02e5..860a8a98d4 100644--- a/packages/canvas/src/canvas.tsx+++ b/packages/canvas/src/canvas.tsx@@ -1,11 +1,18 @@import type {PlayerProps, PlayerRef} from '@remotion/player';import {Player, PlayerInternals} from '@remotion/player';import type {RefObject} from 'react';-import React, {forwardRef, useCallback, useEffect, useMemo} from 'react';-import type {AnyZodObject, TSequence} from 'remotion';+import React, {+ forwardRef,+ useCallback,+ useEffect,+ useLayoutEffect,+ useMemo,+} from 'react';+import {Internals, type AnyZodObject, type TSequence} from 'remotion';import type {CanvasController} from './canvas-controller';import {getCanvasControllerInternals} from './canvas-controller';import {CanvasOutlineOverlay} from './canvas-outline-overlay';+import {installFiberCommitOrderObserver} from './install-fiber-sequence-order-observer';import type {CanvasSequenceNodePathResolver} from './sequence-node-path';import {getCanvasSequenceNodePathInfo} from './sequence-node-path';@@ -41,6 +48,14 @@ const CanvasFn = <useEffect(() => {return () => internals.clear();}, [internals]);+ // React Refresh (used by Browser Studio) or React DevTools must have+ // registered the renderer before this commit. Install before the commit hook+ // fires so the initial outline nodes are discovered as well.+ useLayoutEffect(() => {+ if (showOutlines && typeof window !== 'undefined') {+ installFiberCommitOrderObserver(window);+ }+ }, [showOutlines]);const overlay = useMemo(() =>showOutlines ? (@@ -56,14 +71,18 @@ const CanvasFn = <PlayerInternals.TimelineSequenceObserverContext.Provider,{value: onTimelineSequenceChange},React.createElement(- PlayerInternals.CanvasOverlayContext.Provider,- {value: overlay},+ Internals.SequenceOutlineContext.Provider,+ {value: showOutlines},React.createElement(- Player as React.ComponentType,- {- ...(playerProps as Record<string, unknown>),- ref,- } as Record<string, unknown>,+ PlayerInternals.CanvasOverlayContext.Provider,+ {value: overlay},+ React.createElement(+ Player as React.ComponentType,+ {+ ...(playerProps as Record<string, unknown>),+ ref,+ } as Record<string, unknown>,+ ),),),);diff --git a/packages/studio/src/helpers/install-fiber-sequence-order-observer.ts b/packages/canvas/src/install-fiber-sequence-order-observer.tssimilarity index 92%rename from packages/studio/src/helpers/install-fiber-sequence-order-observer.tsrename to packages/canvas/src/install-fiber-sequence-order-observer.tsindex 5619b3582c..e5ca8a3334 100644--- a/packages/studio/src/helpers/install-fiber-sequence-order-observer.ts+++ b/packages/canvas/src/install-fiber-sequence-order-observer.ts@@ -120,13 +120,12 @@ export const collectCommitOrderFromFiber = (root: FiberRoot) => {compositionsAndFoldersByManager.set(compositionManagerId, []);}- if (- hasFiberMarker(fiber, Internals.CommitOrderInternals.sequenceMarker) &&- sequenceManagerId !== null- ) {- const sequenceId = getStringProp(fiber.memoizedProps, 'sequenceId');- if (sequenceId !== null) {- sequencesByManager.get(sequenceManagerId)?.push(sequenceId);+ if (hasFiberMarker(fiber, Internals.CommitOrderInternals.sequenceMarker)) {+ if (sequenceManagerId !== null) {+ const sequenceId = getStringProp(fiber.memoizedProps, 'sequenceId');+ if (sequenceId !== null) {+ sequencesByManager.get(sequenceManagerId)?.push(sequenceId);+ }}const props = fiber.memoizedProps;@@ -203,6 +202,7 @@ export const collectCommitOrderFromFiber = (root: FiberRoot) => {}return {+ outlineCount: outlineNodesByRef.size,sequenceManagers: [...sequencesByManager].map(([managerId, sequenceIds]) => ({managerId, sequenceIds}),),@@ -233,17 +233,21 @@ export const installFiberCommitOrderObserver = (const [, root] = args;const order = collectCommitOrderFromFiber(root);if (+ order.outlineCount > 0 ||order.sequenceManagers.length > 0 ||order.compositionManagers.length > 0) {target.dispatchEvent(new CustomEvent(Internals.CommitOrderInternals.eventName, {- detail: order,+ detail: {+ sequenceManagers: order.sequenceManagers,+ compositionManagers: order.compositionManagers,+ },}),);}} catch {- // Fiber is private React API. An unsupported shape must not break Studio.+ // Fiber is private React API. An unsupported shape must not break the host.}return previousOnCommitFiberRoot?.apply(this, args);diff --git a/packages/core/src/Sequence.tsx b/packages/core/src/Sequence.tsxindex 3b4c0f26ef..a57e18ba96 100644--- a/packages/core/src/Sequence.tsx+++ b/packages/core/src/Sequence.tsx@@ -29,7 +29,10 @@ import {validateSequenceCrop,} from './sequence-crop.js';import {SequenceOrderMarker} from './sequence-order-marker.js';-import {SequenceOutlineInternals} from './sequence-outline.js';+import {+ SequenceOutlineContext,+ SequenceOutlineInternals,+} from './sequence-outline.js';import type {SequenceContextType} from './SequenceContext.js';import {SequenceContext} from './SequenceContext.js';import {SequenceRegistrationContext} from './SequenceManager.js';@@ -319,13 +322,15 @@ const RegularSequenceRefForwardingFunction: React.ForwardRefRenderFunction<Math.min(videoConfig.durationInFrames - from, parentSequenceDuration),);const sequenceRegistrationEnabled = useContext(SequenceRegistrationContext);+ const canvasOutlinesEnabled = useContext(SequenceOutlineContext);const env = useRemotionEnvironment();+ const shouldDiscoverOutline = env.isStudio || canvasOutlinesEnabled;const automaticOutlineRef = useMemo(() =>- env.isStudio && layout === 'none' && !passedRefForOutline+ shouldDiscoverOutline && layout === 'none' && !passedRefForOutline? SequenceOutlineInternals.createRef(): null,- [env.isStudio, layout, passedRefForOutline],+ [shouldDiscoverOutline, layout, passedRefForOutline],);const wrapperRefForOutline = useRef<HTMLDivElement | null>(null);const refForOutline =@@ -689,7 +694,7 @@ const RegularSequenceRefForwardingFunction: React.ForwardRefRenderFunction<}if (hidden) {- return env.isStudio ? (+ return shouldDiscoverOutline ? (<SequenceOrderMarkersequenceId={id}outlineChildrenRef={automaticOutlineRef}@@ -715,7 +720,7 @@ const RegularSequenceRefForwardingFunction: React.ForwardRefRenderFunction<</SequenceContext.Provider>);- return env.isStudio ? (+ return shouldDiscoverOutline ? (<SequenceOrderMarkersequenceId={id}outlineChildrenRef={automaticOutlineRef}diff --git a/packages/core/src/internals.ts b/packages/core/src/internals.tsindex 1698017a38..9591c424f3 100644--- a/packages/core/src/internals.ts+++ b/packages/core/src/internals.ts@@ -167,7 +167,10 @@ import {OverrideIdsToNodePathsSettersContext,} from './sequence-node-path.js';import {CommitOrderInternals} from './sequence-order-marker.js';-import {SequenceOutlineInternals} from './sequence-outline.js';+import {+ SequenceOutlineContext,+ SequenceOutlineInternals,+} from './sequence-outline.js';import type {ResolvedStackLocation} from './sequence-stack-traces.js';import {SequenceStackTracesUpdateContext} from './sequence-stack-traces.js';import {SequenceWithoutSchema} from './Sequence.js';@@ -340,6 +343,7 @@ export const Internals = {SequenceRegistrationContext,CommitOrderInternals,SequenceOutlineInternals,+ SequenceOutlineContext,SequenceStackTracesUpdateContext,baseSchema,sequenceSchema,diff --git a/packages/core/src/sequence-outline.ts b/packages/core/src/sequence-outline.tsindex 5f59b9b711..298b62800e 100644--- a/packages/core/src/sequence-outline.ts+++ b/packages/core/src/sequence-outline.ts@@ -1,8 +1,11 @@import type {RefObject} from 'react';+import React from 'react';type OutlineNode = Element | Text;type OutlineRef = RefObject<Element | null>;+export const SequenceOutlineContext = React.createContext(false);+// Keep automatic groups separate from the public, single-element outlineRef.// A group only exposes .current when it has exactly one element, so consumers// that require an actual element never accidentally act on part of a group.diff --git a/packages/studio/src/previewEntry.tsx b/packages/studio/src/previewEntry.tsxindex b4968c5fc3..bca80c8238 100644--- a/packages/studio/src/previewEntry.tsx+++ b/packages/studio/src/previewEntry.tsx@@ -1,3 +1,4 @@+import {CanvasInternals} from '@remotion/canvas';import React from 'react';import ReactDOM from 'react-dom/client';import {Internals} from 'remotion';@@ -5,12 +6,11 @@ import {NoReactInternals} from 'remotion/no-react';import {NoRegisterRoot} from './components/NoRegisterRoot';import {startErrorOverlay} from './error-overlay/entry-basic';import {BACKGROUND_HEX} from './helpers/colors';-import {installFiberCommitOrderObserver} from './helpers/install-fiber-sequence-order-observer';import {studioCssVariables} from './helpers/studio-css-variables';import {enableHotMiddleware} from './hot-middleware-client/client';import {Studio} from './Studio';-installFiberCommitOrderObserver(window);+CanvasInternals.installFiberCommitOrderObserver(window);Internals.CSSUtils.injectCSS(studioCssVariables);Internals.CSSUtils.injectCSS(diff --git a/packages/studio/src/test/fiber-sequence-order-observer.test.ts b/packages/studio/src/test/fiber-sequence-order-observer.test.tsindex 13ebe46713..e5fef7632c 100644--- a/packages/studio/src/test/fiber-sequence-order-observer.test.ts+++ b/packages/studio/src/test/fiber-sequence-order-observer.test.ts@@ -1,9 +1,9 @@import {afterEach, expect, test} from 'bun:test';+import {CanvasInternals} from '@remotion/canvas';import {Internals} from 'remotion';-import {- collectCommitOrderFromFiber,- installFiberCommitOrderObserver,-} from '../helpers/install-fiber-sequence-order-observer';++const {collectCommitOrderFromFiber, installFiberCommitOrderObserver} =+ CanvasInternals;type TestFiber = {child: TestFiber | null;@@ -113,6 +113,7 @@ test('collects sequence, composition, and folder order per manager', () => {};expect(collectCommitOrderFromFiber(root)).toEqual({+ outlineCount: 0,sequenceManagers: [{managerId: 'sequences', sequenceIds: ['left', 'right']},],