🎥 Make videos programmatically with React
remotion: Subscribe visual elements only to their own source prop status
Cursor Agent51ccfc4049fa
diff --git a/packages/core/src/SequenceManager.tsx b/packages/core/src/SequenceManager.tsxindex d831005636..c1dc23bccb 100644--- a/packages/core/src/SequenceManager.tsx+++ b/packages/core/src/SequenceManager.tsx@@ -235,6 +235,17 @@ export const VisualModePropStatusesRefContext =current: {},});+export type VisualModePropStatusesSubscription = {+ subscribe: (key: string | null, listener: () => void) => () => void;+ getSnapshot: (key: string | null) => CanUpdateSequencePropsResponse | null;+};++export const VisualModePropStatusesSubscriptionContext =+ React.createContext<VisualModePropStatusesSubscription>({+ subscribe: () => () => undefined,+ getSnapshot: () => null,+ });+const defaultVisualModeDragOverrides: VisualModeDragOverrides = {getDragOverrides: () => {throw new Error('VisualModeDragOverridesContext not initialized');@@ -251,7 +262,7 @@ export const VisualModeDragOverridesRefContext = React.createContext<React.RefObject<VisualModeDragOverrides>>({current: defaultVisualModeDragOverrides});-const useDragOverrideSnapshot = <T,>(+const useVisualModeSnapshot = <T,>(subscribe: (listener: () => void) => () => void,getSnapshot: () => T,): T => {@@ -288,7 +299,26 @@ export const useDragOverridesForNodePath = (() => scopedSubscription?.getSnapshot(key) ?? emptyDragOverrides,[key, scopedSubscription],);- return useDragOverrideSnapshot(subscribe, getSnapshot);+ return useVisualModeSnapshot(subscribe, getSnapshot);+};++// Every visual element reads its own status. Subscribing to the whole map would+// rerender all of them whenever any status in the project changes.+export const usePropStatusForNodePath = (+ nodePath: SequencePropsSubscriptionKey | null,+): CanUpdateSequencePropsResponse | null => {+ const subscription = useContext(VisualModePropStatusesSubscriptionContext);+ const key =+ nodePath === null ? null : makeSequencePropsSubscriptionKey(nodePath);+ const subscribe = useCallback(+ (listener: () => void) => subscription.subscribe(key, listener),+ [key, subscription],+ );+ const getSnapshot = useCallback(+ () => subscription.getSnapshot(key),+ [key, subscription],+ );+ return useVisualModeSnapshot(subscribe, getSnapshot);};export const useActiveFromDragOverrideKeys = (): ReadonlySet<string> => {@@ -316,7 +346,7 @@ export const useEffectDragOverridesForNodePath = (scopedSubscription?.getEffectSnapshot(key) ?? emptyEffectDragOverrides,[key, scopedSubscription],);- return useDragOverrideSnapshot(subscribe, getSnapshot);+ return useVisualModeSnapshot(subscribe, getSnapshot);};export const VisualModeSettersContext = React.createContext<VisualModeSetters>({@@ -384,8 +414,17 @@ export const SequenceManagerProvider: React.FC<{});const [propStatuses, setPropStatusesMapState] = useState<PropStatuses>({});const propStatusesRef = useRef(propStatuses);+ const propStatusListeners = useRef(new Map<string, Set<() => void>>());useIsomorphicLayoutEffect(() => {+ const previous = propStatusesRef.current;propStatusesRef.current = propStatuses;+ for (const [key, listeners] of propStatusListeners.current) {+ if (previous[key] !== propStatuses[key]) {+ for (const listener of listeners) {+ listener();+ }+ }+ }}, [propStatuses]);const setDragOverridesBatch = useCallback(@@ -734,6 +773,32 @@ export const SequenceManagerProvider: React.FC<{propStatuses,};}, [propStatuses]);+ const propStatusesSubscription = useMemo<VisualModePropStatusesSubscription>(+ () => ({+ subscribe: (key, listener) => {+ if (key === null) {+ return () => undefined;+ }++ let listeners = propStatusListeners.current.get(key);+ if (!listeners) {+ listeners = new Set();+ propStatusListeners.current.set(key, listeners);+ }++ listeners.add(listener);+ return () => {+ listeners.delete(listener);+ if (listeners.size === 0) {+ propStatusListeners.current.delete(key);+ }+ };+ },+ getSnapshot: (key) =>+ key === null ? null : (propStatusesRef.current[key] ?? null),+ }),+ [],+ );const dragOverridesContext: VisualModeDragOverrides = useMemo(() => {return {@@ -772,28 +837,32 @@ export const SequenceManagerProvider: React.FC<{return (<SequenceRegistryProvider><VisualModePropStatusesRefContext.Provider value={propStatusesRef}>- <VisualModePropStatusesContext.Provider value={propStatusesContext}>- <SequenceManagerScopeProviders- dragOverridesSubscription={dragOverridesSubscription}- fromKeys={dragOverrideState.fromKeys}- >- <VisualModeDragOverridesContext.Provider- value={dragOverridesContext}+ <VisualModePropStatusesSubscriptionContext.Provider+ value={propStatusesSubscription}+ >+ <VisualModePropStatusesContext.Provider value={propStatusesContext}>+ <SequenceManagerScopeProviders+ dragOverridesSubscription={dragOverridesSubscription}+ fromKeys={dragOverrideState.fromKeys}>- <VisualModeDragOverridesRefContext.Provider- value={dragOverridesRef}+ <VisualModeDragOverridesContext.Provider+ value={dragOverridesContext}>- <VisualModeSettersContext.Provider value={settersContext}>- <VisualModeBatchSettersContext.Provider- value={batchSettersContext}- >- {children}- </VisualModeBatchSettersContext.Provider>- </VisualModeSettersContext.Provider>- </VisualModeDragOverridesRefContext.Provider>- </VisualModeDragOverridesContext.Provider>- </SequenceManagerScopeProviders>- </VisualModePropStatusesContext.Provider>+ <VisualModeDragOverridesRefContext.Provider+ value={dragOverridesRef}+ >+ <VisualModeSettersContext.Provider value={settersContext}>+ <VisualModeBatchSettersContext.Provider+ value={batchSettersContext}+ >+ {children}+ </VisualModeBatchSettersContext.Provider>+ </VisualModeSettersContext.Provider>+ </VisualModeDragOverridesRefContext.Provider>+ </VisualModeDragOverridesContext.Provider>+ </SequenceManagerScopeProviders>+ </VisualModePropStatusesContext.Provider>+ </VisualModePropStatusesSubscriptionContext.Provider></VisualModePropStatusesRefContext.Provider></SequenceRegistryProvider>);diff --git a/packages/core/src/effects/use-memoized-effects.ts b/packages/core/src/effects/use-memoized-effects.tsindex bca93b56ca..de0ce5c4a0 100644--- a/packages/core/src/effects/use-memoized-effects.ts+++ b/packages/core/src/effects/use-memoized-effects.ts@@ -13,11 +13,12 @@ import {OverrideIdsToNodePathsGettersContext} from '../sequence-node-path.js';import type {CannotUpdateEffectReason,CannotUpdateSequenceReason,+ CanUpdateSequencePropsResponse,} from '../SequenceManager.js';import {makeSequencePropsSubscriptionKey,useEffectDragOverridesForNodePath,- VisualModePropStatusesContext,+ usePropStatusForNodePath,type SequencePropsSubscriptionKey,} from '../SequenceManager.js';import {useCurrentFrameWithOptionalSubscription} from '../use-current-frame.js';@@ -239,16 +240,15 @@ type EffectStatus =props: Record<string, CanUpdateSequencePropStatus>;};-export const getEffectPropStatusesCtx = ({- propStatuses,- nodePath,+const getEffectStatusForSequenceStatus = ({+ status,effectIndex,+ videoConfigValues,}: {- propStatuses: PropStatuses;- nodePath: SequencePropsSubscriptionKey;+ status: CanUpdateSequencePropsResponse | null;effectIndex: number;+ videoConfigValues: VideoConfigValues | null;}): EffectStatus => {- const status = propStatuses[makeSequencePropsSubscriptionKey(nodePath)];if (!status) {return {type: 'cannot-update-sequence', reason: 'not-found'};}@@ -268,15 +268,30 @@ export const getEffectPropStatusesCtx = ({return {type: 'can-update-effect',- props: evaluateSourcePropStatuses(effect.props, nodePath.videoConfigValues),+ props: evaluateSourcePropStatuses(effect.props, videoConfigValues),};};-export const getPropStatusesCtx = (- propStatuses: PropStatuses,- nodePath: SequencePropsSubscriptionKey,+export const getEffectPropStatusesCtx = ({+ propStatuses,+ nodePath,+ effectIndex,+}: {+ propStatuses: PropStatuses;+ nodePath: SequencePropsSubscriptionKey;+ effectIndex: number;+}): EffectStatus => {+ return getEffectStatusForSequenceStatus({+ status: propStatuses[makeSequencePropsSubscriptionKey(nodePath)] ?? null,+ effectIndex,+ videoConfigValues: nodePath.videoConfigValues,+ });+};++export const getPropStatusesForSequenceStatus = (+ status: CanUpdateSequencePropsResponse | null,+ videoConfigValues: VideoConfigValues | null,) => {- const status = propStatuses[makeSequencePropsSubscriptionKey(nodePath)];if (!status) {return undefined;}@@ -285,7 +300,17 @@ export const getPropStatusesCtx = (return undefined;}- return evaluateSourcePropStatuses(status.props, nodePath.videoConfigValues);+ return evaluateSourcePropStatuses(status.props, videoConfigValues);+};++export const getPropStatusesCtx = (+ propStatuses: PropStatuses,+ nodePath: SequencePropsSubscriptionKey,+) => {+ return getPropStatusesForSequenceStatus(+ propStatuses[makeSequencePropsSubscriptionKey(nodePath)] ?? null,+ nodePath.videoConfigValues,+ );};export type GetPropStatusesType = typeof getPropStatusesCtx;@@ -314,8 +339,6 @@ export const useMemoizedEffects = ({readonly effects: EffectDefinitionAndStack<unknown>[];} | null>(null);- const {propStatuses} = useContext(VisualModePropStatusesContext);-const {overrideIdToNodePathMappings} = useContext(OverrideIdsToNodePathsGettersContext,);@@ -326,6 +349,7 @@ export const useMemoizedEffects = ({? (overrideIdToNodePathMappings[overrideId] ?? null): null;const effectDragOverrides = useEffectDragOverridesForNodePath(nodePath);+ const sequenceStatus = usePropStatusForNodePath(nodePath);const effectPropStatuses = useMemo(() =>@@ -334,14 +358,14 @@ export const useMemoizedEffects = ({return null;}- const status = getEffectPropStatusesCtx({- propStatuses,- nodePath: {...nodePath, videoConfigValues},+ const status = getEffectStatusForSequenceStatus({+ status: sequenceStatus,effectIndex,+ videoConfigValues,});return status.type === 'can-update-effect' ? status.props : null;}),- [effects.length, nodePath, propStatuses, videoConfigValues],+ [effects.length, nodePath, sequenceStatus, videoConfigValues],);const animatedEffects = useMemo(() =>diff --git a/packages/core/src/internals.ts b/packages/core/src/internals.tsindex f7efb0dbf8..58fd570087 100644--- a/packages/core/src/internals.ts+++ b/packages/core/src/internals.ts@@ -229,6 +229,7 @@ import {VisualModeDragOverridesRefContext,VisualModePropStatusesContext,VisualModePropStatusesRefContext,+ VisualModePropStatusesSubscriptionContext,VisualModeSettersContext,type CanUpdateEffectPropsResponse,type CanUpdateEffectPropsResponseFalse,@@ -396,6 +397,7 @@ export const Internals = {CompositionSetters,VisualModePropStatusesContext,VisualModePropStatusesRefContext,+ VisualModePropStatusesSubscriptionContext,VisualModeBatchSettersContext,VisualModeDragOverridesContext,VisualModeDragOverridesRefContext,diff --git a/packages/core/src/test/sequence-register-once.test.tsx b/packages/core/src/test/sequence-register-once.test.tsxindex f286cfd152..00a34da527 100644--- a/packages/core/src/test/sequence-register-once.test.tsx+++ b/packages/core/src/test/sequence-register-once.test.tsx@@ -31,6 +31,7 @@ import {VisualModeBatchSettersContext,VisualModePropStatusesContext,VisualModePropStatusesRefContext,+ VisualModePropStatusesSubscriptionContext,VisualModeSettersContext,} from '../SequenceManager.js';import {Series} from '../series/index.js';@@ -157,6 +158,15 @@ const SequenceTestWrapperWithVisualModeOverrides: React.FC<[visualModeOverrides],);+ const visualPropStatusesSubscription = useMemo(+ () => ({+ subscribe: () => () => undefined,+ getSnapshot: (key: string | null) =>+ key === null ? null : (visualModeOverrides?.propStatuses[key] ?? null),+ }),+ [visualModeOverrides],+ );+const overrideIdToNodePathContext = useMemo(() => ({overrideIdToNodePathMappings:@@ -199,11 +209,17 @@ const SequenceTestWrapperWithVisualModeOverrides: React.FC<<ObserveSequenceRegistrationsonRegisterSequence={registerSequence}/>- <VisualModePropStatusesContext.Provider value={visualPropStatuses}>- <VisualModeSettersContext.Provider value={visualSetters}>- {children}- </VisualModeSettersContext.Provider>- </VisualModePropStatusesContext.Provider>+ <VisualModePropStatusesSubscriptionContext.Provider+ value={visualPropStatusesSubscription}+ >+ <VisualModePropStatusesContext.Provider+ value={visualPropStatuses}+ >+ <VisualModeSettersContext.Provider value={visualSetters}>+ {children}+ </VisualModeSettersContext.Provider>+ </VisualModePropStatusesContext.Provider>+ </VisualModePropStatusesSubscriptionContext.Provider></SequenceManagerProvider></OverrideIdsToNodePathsGettersContext.Provider></Internals.RemotionEnvironmentContext>diff --git a/packages/core/src/with-interactivity-schema.ts b/packages/core/src/with-interactivity-schema.tsindex a6b2c5b770..05a6b33372 100644--- a/packages/core/src/with-interactivity-schema.ts+++ b/packages/core/src/with-interactivity-schema.ts@@ -12,7 +12,7 @@ import type {SequenceControls,} from './CompositionManager.js';import {deleteNestedKey} from './delete-nested-key.js';-import {getPropStatusesCtx} from './effects/use-memoized-effects.js';+import {getPropStatusesForSequenceStatus} from './effects/use-memoized-effects.js';import {getStackForControls,setStackForControls,@@ -33,7 +33,7 @@ import {createRuntimeValueStore} from './runtime-value-store.js';import {OverrideIdsToNodePathsGettersContext} from './sequence-node-path.js';import {useDragOverridesForNodePath,- VisualModePropStatusesContext,+ usePropStatusForNodePath,} from './SequenceManager.js';import {useCurrentFrameWithOptionalSubscription} from './use-current-frame.js';import {useRemotionEnvironment} from './use-remotion-environment.js';@@ -254,8 +254,6 @@ export const withInteractivitySchema = <});}- // eslint-disable-next-line react-hooks/rules-of-hooks- const {propStatuses} = useContext(VisualModePropStatusesContext);// eslint-disable-next-line react-hooks/rules-of-hooksconst nodePathMapping = useContext(OverrideIdsToNodePathsGettersContext);// eslint-disable-next-line react-hooks/rules-of-hooks@@ -333,15 +331,11 @@ export const withInteractivitySchema = <// eslint-disable-next-line react-hooks/rules-of-hooksconst dragOverrides = useDragOverridesForNodePath(nodePath);// eslint-disable-next-line react-hooks/rules-of-hooks+ const sequenceStatus = usePropStatusForNodePath(nodePath);+ // eslint-disable-next-line react-hooks/rules-of-hooksconst propStatus = useMemo(- () =>- nodePath === null- ? undefined- : getPropStatusesCtx(propStatuses, {- ...nodePath,- videoConfigValues,- }),- [nodePath, propStatuses, videoConfigValues],+ () => getPropStatusesForSequenceStatus(sequenceStatus, videoConfigValues),+ [sequenceStatus, videoConfigValues],);// Runtime props already update through their owner. Only overrides with// keyframes need this wrapper to subscribe to the advancing clock.diff --git a/packages/transitions/src/test/transition-series-stack.test.tsx b/packages/transitions/src/test/transition-series-stack.test.tsxindex e1c3f28048..f480292baa 100644--- a/packages/transitions/src/test/transition-series-stack.test.tsx+++ b/packages/transitions/src/test/transition-series-stack.test.tsx@@ -115,6 +115,14 @@ const SequenceTestWrapper: React.FC<{() => ({propStatuses}),[propStatuses],);+ const visualModePropStatusesSubscription = useMemo(+ () => ({+ subscribe: () => () => undefined,+ getSnapshot: (key: string | null) =>+ key === null ? null : (propStatuses[key] ?? null),+ }),+ [propStatuses],+ );const overrideIdToNodePathContext = useMemo(() => ({overrideIdToNodePathMappings}),[overrideIdToNodePathMappings],@@ -141,15 +149,19 @@ const SequenceTestWrapper: React.FC<{<ObserveSequenceRegistrationsonRegisterSequence={onRegisterSequence}/>- <Internals.VisualModePropStatusesContext.Provider- value={visualModePropStatuses}+ <Internals.VisualModePropStatusesSubscriptionContext.Provider+ value={visualModePropStatusesSubscription}>- <Internals.VisualModeSettersContext.Provider- value={visualModeSetters}+ <Internals.VisualModePropStatusesContext.Provider+ value={visualModePropStatuses}>- {children}- </Internals.VisualModeSettersContext.Provider>- </Internals.VisualModePropStatusesContext.Provider>+ <Internals.VisualModeSettersContext.Provider+ value={visualModeSetters}+ >+ {children}+ </Internals.VisualModeSettersContext.Provider>+ </Internals.VisualModePropStatusesContext.Provider>+ </Internals.VisualModePropStatusesSubscriptionContext.Provider></Internals.SequenceManagerProvider></Internals.OverrideIdsToNodePathsGettersContext.Provider></Internals.TimelineContext.Provider>