🎥 Make videos programmatically with React
`@remotion/studio`: Read composition state on demand for actions
JonnyBurger6292faf678db
diff --git a/packages/core/src/CompositionManagerContext.tsx b/packages/core/src/CompositionManagerContext.tsxindex de45debf2d..c2b6de86bc 100644--- a/packages/core/src/CompositionManagerContext.tsx+++ b/packages/core/src/CompositionManagerContext.tsx@@ -65,13 +65,21 @@ export type CompositionManagerContext = {canvasContent: CanvasContent | null;};-export const CompositionManager = createContext<CompositionManagerContext>({+const defaultCompositionManagerContext: CompositionManagerContext = {compositions: [],folders: [],currentCompositionMetadata: null,currentAssetMetadata: null,canvasContent: null,-});+};++export const CompositionManager = createContext<CompositionManagerContext>(+ defaultCompositionManagerContext,+);++export const CompositionManagerRefContext = createContext<{+ readonly current: CompositionManagerContext;+}>({current: defaultCompositionManagerContext});export const CompositionSetters = createContext<CompositionManagerSetters>({setCanvasContent: () => undefined,diff --git a/packages/core/src/CompositionManagerProvider.tsx b/packages/core/src/CompositionManagerProvider.tsxindex 6d8f6a2711..e26dac0dac 100644--- a/packages/core/src/CompositionManagerProvider.tsx+++ b/packages/core/src/CompositionManagerProvider.tsx@@ -18,6 +18,7 @@ import type {} from './CompositionManagerContext';import {CompositionManager,+ CompositionManagerRefContext,CompositionSetters,} from './CompositionManagerContext';import type {BaseMetadata} from './CompositionManagerContext.js';@@ -172,6 +173,9 @@ export const CompositionManagerProvider = ({canvasContent,]);+ const compositionManagerRef = useRef(compositionManagerContextValue);+ compositionManagerRef.current = compositionManagerContextValue;+if (registrationError !== null) {throw registrationError;}@@ -182,9 +186,11 @@ export const CompositionManagerProvider = ({onSnapshot={onCommitRegistrations}><CompositionManager.Provider value={compositionManagerContextValue}>- <CompositionSetters.Provider value={compositionManagerSetters}>- {children}- </CompositionSetters.Provider>+ <CompositionManagerRefContext.Provider value={compositionManagerRef}>+ <CompositionSetters.Provider value={compositionManagerSetters}>+ {children}+ </CompositionSetters.Provider>+ </CompositionManagerRefContext.Provider></CompositionManager.Provider></CompositionRegistryProvider>);diff --git a/packages/core/src/internals.ts b/packages/core/src/internals.tsindex bfe59971fc..c682ddbc92 100644--- a/packages/core/src/internals.ts+++ b/packages/core/src/internals.ts@@ -46,6 +46,7 @@ import {compositionsRef} from './CompositionManager.js';import type {CompositionManagerContext} from './CompositionManagerContext.js';import {CompositionManager,+ CompositionManagerRefContext,CompositionSetters,} from './CompositionManagerContext.js';import {CompositionManagerProvider} from './CompositionManagerProvider.js';@@ -386,6 +387,7 @@ export const Internals = {resolveTrimProps,VideoForPreview,CompositionManager,+ CompositionManagerRefContext,CompositionSetters,VisualModePropStatusesContext,VisualModePropStatusesRefContext,diff --git a/packages/studio/src/components/CompSelectorRef.tsx b/packages/studio/src/components/CompSelectorRef.tsxindex 4ccc1564e8..cbc21b40e1 100644--- a/packages/studio/src/components/CompSelectorRef.tsx+++ b/packages/studio/src/components/CompSelectorRef.tsx@@ -18,7 +18,9 @@ import {useSelectComposition} from './InitialCompositionLoader';export const CompSelectorRef: React.FC<{readonly children: React.ReactNode;}> = ({children}) => {- const {compositions} = useContext(Internals.CompositionManager);+ const compositionManagerRef = useContext(+ Internals.CompositionManagerRefContext,+ );const {compositionFoldersExpanded, setCompositionFoldersExpanded} =useContext(FolderContext);@@ -41,9 +43,10 @@ export const CompSelectorRef: React.FC<{() => {return {expandComposition: (compName) => {- const compositionToExpand = compositions.find(- (c) => c.id === compName,- );+ const compositionToExpand =+ compositionManagerRef.current.compositions.find(+ (c) => c.id === compName,+ );if (!compositionToExpand) {return;}@@ -68,7 +71,9 @@ export const CompSelectorRef: React.FC<{});},selectComposition: (compName) => {- const comp = compositions.find((c) => c.id === compName);+ const comp = compositionManagerRef.current.compositions.find(+ (c) => c.id === compName,+ );if (!comp) {throw new Error(`Composition ${compName} not found`);}@@ -81,7 +86,7 @@ export const CompSelectorRef: React.FC<{};},[- compositions,+ compositionManagerRef,selectComposition,setCompositionFoldersExpanded,toggleFolder,diff --git a/packages/studio/src/components/NewComposition/DeleteComposition.tsx b/packages/studio/src/components/NewComposition/DeleteComposition.tsxindex a5171996cd..4aa13e356a 100644--- a/packages/studio/src/components/NewComposition/DeleteComposition.tsx+++ b/packages/studio/src/components/NewComposition/DeleteComposition.tsx@@ -32,7 +32,9 @@ const DeleteCompositionLoaded: React.FC<{const {unresolved} = context;const compositionStack = unresolved.stack ?? null;- const {compositions} = useContext(Internals.CompositionManager);+ const compositionManagerRef = useContext(+ Internals.CompositionManagerRefContext,+ );const {setCanvasContent} = useContext(Internals.CompositionSetters);const selectComposition = useSelectComposition();const navigationAfterDelete = useRef<@@ -91,7 +93,9 @@ const DeleteCompositionLoaded: React.FC<{currentCanvasContent?.type === 'composition' &¤tCanvasContent.compositionId === compositionId;const fallback = isSelected- ? (compositions.find(({id}) => id !== compositionId) ?? null)+ ? (compositionManagerRef.current.compositions.find(+ ({id}) => id !== compositionId,+ ) ?? null): undefined;navigationAfterDelete.current = fallback;diff --git a/packages/studio/src/components/NewComposition/use-rename-static-file.ts b/packages/studio/src/components/NewComposition/use-rename-static-file.tsindex ada88cc445..166960132e 100644--- a/packages/studio/src/components/NewComposition/use-rename-static-file.ts+++ b/packages/studio/src/components/NewComposition/use-rename-static-file.ts@@ -74,7 +74,9 @@ export const useRenameStaticFile = ({readonly relativePath: string;readonly staticFiles: StaticFile[];}) => {- const {canvasContent} = useContext(Internals.CompositionManager);+ const compositionManagerRef = useContext(+ Internals.CompositionManagerRefContext,+ );const {setCanvasContent} = useContext(Internals.CompositionSetters);return useCallback(@@ -111,6 +113,7 @@ export const useRenameStaticFile = ({newRelativePath,});+ const {canvasContent} = compositionManagerRef.current;if (canvasContent?.type === 'asset' &&canvasContent.asset === relativePath@@ -129,6 +132,6 @@ export const useRenameStaticFile = ({return false;}},- [canvasContent, relativePath, setCanvasContent, staticFiles],+ [compositionManagerRef, relativePath, setCanvasContent, staticFiles],);};diff --git a/packages/studio/src/components/RenderQueue/RenderQueueRemoveItem.tsx b/packages/studio/src/components/RenderQueue/RenderQueueRemoveItem.tsxindex 5a5d8410b0..42100bf3ae 100644--- a/packages/studio/src/components/RenderQueue/RenderQueueRemoveItem.tsx+++ b/packages/studio/src/components/RenderQueue/RenderQueueRemoveItem.tsx@@ -15,7 +15,9 @@ export const RenderQueueRemoveItem: React.FC<{}> = ({job}) => {const isClientJob = isClientRenderJob(job);const {removeClientJob} = useContext(RenderQueueContext);- const {canvasContent} = useContext(Internals.CompositionManager);+ const compositionManagerRef = useContext(+ Internals.CompositionManagerRefContext,+ );const {setCanvasContent} = useContext(Internals.CompositionSetters);const onClick: React.MouseEventHandler = useCallback(@@ -23,6 +25,7 @@ export const RenderQueueRemoveItem: React.FC<{e.stopPropagation();if (isClientJob) {+ const {canvasContent} = compositionManagerRef.current;if (canvasContent &&canvasContent.type === 'output' &&@@ -41,7 +44,13 @@ export const RenderQueueRemoveItem: React.FC<{showNotification(`Could not remove item: ${err.message}`, 2000);});},- [job, isClientJob, removeClientJob, canvasContent, setCanvasContent],+ [+ job,+ isClientJob,+ removeClientJob,+ compositionManagerRef,+ setCanvasContent,+ ],);const icon: React.CSSProperties = useMemo(() => {diff --git a/packages/studio/src/components/SelectedOutlineElement.tsx b/packages/studio/src/components/SelectedOutlineElement.tsxindex 91c90be5a6..49b7d2fa5d 100644--- a/packages/studio/src/components/SelectedOutlineElement.tsx+++ b/packages/studio/src/components/SelectedOutlineElement.tsx@@ -127,8 +127,8 @@ const SelectedOutlineElementUnmemoized: React.FC<const deleteTimelineItems = useDeleteTimelineItems();const selectAsset = useSelectAsset();const selectComposition = useSelectComposition();- const {compositions, canvasContent} = useContext(- Internals.CompositionManager,+ const compositionManagerRef = useContext(+ Internals.CompositionManagerRefContext,);const {setSelectedModal} = useContext(SetSelectedModalContext);const currentSelection = useCurrentTimelineSelectionStateAsRef();@@ -169,7 +169,7 @@ const SelectedOutlineElementUnmemoized: React.FC<sequenceWasDragged: boolean,) => {const connectedCompositions = getConnectedCompositions({- compositions,+ compositions: compositionManagerRef.current.compositions,singleChildComponent: doubleClickTarget.sequence.singleChildComponent,});const nodePath = doubleClickTarget.nodePathInfo.sequenceSubscriptionKey;@@ -265,7 +265,7 @@ const SelectedOutlineElementUnmemoized: React.FC<return true;},[- compositions,+ compositionManagerRef,currentSelection,defaultEditorId,defaultOpenInTarget,@@ -321,6 +321,7 @@ const SelectedOutlineElementUnmemoized: React.FC<const canRotate = !sourceEditDisabled && outline.path === null;const outlineElement =contextMenuTarget.sequence.refForOutline?.current ?? null;+ const {canvasContent} = compositionManagerRef.current;const unwrapMenuItem = getSequenceUnwrapMenuItem({sequence: contextMenuTarget.sequence,sourceLocation:@@ -532,7 +533,7 @@ const SelectedOutlineElementUnmemoized: React.FC<});}, [canConfigureApps,- canvasContent,+ compositionManagerRef,codingAgentInfo,confirm,deleteTimelineItems,diff --git a/packages/studio/src/components/Timeline/TimelineSequence.tsx b/packages/studio/src/components/Timeline/TimelineSequence.tsxindex 17068b1d0d..4863b8fb58 100644--- a/packages/studio/src/components/Timeline/TimelineSequence.tsx+++ b/packages/studio/src/components/Timeline/TimelineSequence.tsx@@ -1453,11 +1453,13 @@ const useTimelineSequenceState = (props: TimelineSequenceProps) => {const showPremounting = showPremountingSetting || premountSelected;const previewConnected = previewServerState.type === 'connected';const previewInteractive = previewConnected && isStudioInteractivityEnabled();- const {canvasContent} = useContext(Internals.CompositionManager);+ const compositionManagerRef = useContext(+ Internals.CompositionManagerRefContext,+ );const {setPropStatuses} = useContext(Internals.VisualModeSettersContext);const {setSelectedModal} = useContext(SetSelectedModalContext);const selectAsset = useSelectAsset();- const assetContextMenu = useAssetTimelineContextMenu();+ const getAssetContextMenu = useAssetTimelineContextMenu();const selectComposition = useSelectComposition();const confirm = useConfirmationDialog();const deleteTimelineItems = useDeleteTimelineItems();@@ -1658,6 +1660,7 @@ const useTimelineSequenceState = (props: TimelineSequenceProps) => {event.target instanceof Element? event.target.closest<HTMLElement>(`[${TIMELINE_MARQUEE_ITEM_ATTR}]`): null;+ const assetContextMenu = getAssetContextMenu();if (assetContextMenu !== null) {return assetContextMenu;}@@ -1686,6 +1689,7 @@ const useTimelineSequenceState = (props: TimelineSequenceProps) => {});}+ const {canvasContent} = compositionManagerRef.current;const unwrapMenuItem = getSequenceUnwrapMenuItem({sequence: s,sourceLocation: validatedLocation,@@ -1771,8 +1775,8 @@ const useTimelineSequenceState = (props: TimelineSequenceProps) => {);},[- assetContextMenu,- canvasContent,+ getAssetContextMenu,+ compositionManagerRef,canOpenInEditor,canConfigureApps,codingAgentInfo,diff --git a/packages/studio/src/components/Timeline/TimelineSequenceItem.tsx b/packages/studio/src/components/Timeline/TimelineSequenceItem.tsxindex f2760339e4..46d2a46c57 100644--- a/packages/studio/src/components/Timeline/TimelineSequenceItem.tsx+++ b/packages/studio/src/components/Timeline/TimelineSequenceItem.tsx@@ -391,7 +391,9 @@ const TimelineSequenceItemInner: React.FC<{const {previewServerState} = useContext(StudioServerConnectionCtx);const previewConnected = previewServerState.type === 'connected';const previewInteractive = previewConnected && isStudioInteractivityEnabled();- const {canvasContent} = useContext(Internals.CompositionManager);+ const compositionManagerRef = useContext(+ Internals.CompositionManagerRefContext,+ );const isStill = useIsStill();const canMutateEffects =previewConnected && isStudioSelectionEnabled() && canUseEffectOperations();@@ -401,7 +403,7 @@ const TimelineSequenceItemInner: React.FC<{const {setSelectedModal} = useContext(SetSelectedModalContext);const {isHighestContext} = useKeybinding();const selectAsset = useSelectAsset();- const assetContextMenu = useAssetTimelineContextMenu();+ const getAssetContextMenu = useAssetTimelineContextMenu();const selectComposition = useSelectComposition();const deleteTimelineItems = useDeleteTimelineItems();const {onSelect, selectable, selected, selectedItems, selectItem} =@@ -1382,6 +1384,7 @@ const TimelineSequenceItemInner: React.FC<{(event: MouseEvent) => {const contextMenuTarget =event.currentTarget instanceof HTMLElement ? event.currentTarget : null;+ const assetContextMenu = getAssetContextMenu();if (assetContextMenu !== null) {return assetContextMenu;}@@ -1410,6 +1413,7 @@ const TimelineSequenceItemInner: React.FC<{});}+ const {canvasContent} = compositionManagerRef.current;const unwrapMenuItem = getSequenceUnwrapMenuItem({sequence,sourceLocation: validatedLocation,@@ -1563,8 +1567,8 @@ const TimelineSequenceItemInner: React.FC<{);},[- assetContextMenu,- canvasContent,+ getAssetContextMenu,+ compositionManagerRef,canAddEffect,canCrop,canRotate,diff --git a/packages/studio/src/components/Timeline/use-asset-timeline-context-menu.ts b/packages/studio/src/components/Timeline/use-asset-timeline-context-menu.tsindex 5093f697df..3332122b9a 100644--- a/packages/studio/src/components/Timeline/use-asset-timeline-context-menu.ts+++ b/packages/studio/src/components/Timeline/use-asset-timeline-context-menu.ts@@ -1,4 +1,4 @@-import {useContext, useMemo} from 'react';+import {useCallback, useContext} from 'react';import {Internals} from 'remotion';import {getBrowserStudioOperations} from '../../helpers/browser-studio-operations';import {StudioServerConnectionCtx} from '../../helpers/client-id';@@ -8,11 +8,16 @@ import {showNotification} from '../Notifications/NotificationCenter';import {openInFileExplorer} from '../RenderQueue/actions';import {getCopyContextForAgentsMenuItem} from './get-copy-context-for-agents-menu-item';-export const useAssetTimelineContextMenu = (): ComboboxValue[] | null => {- const {canvasContent} = useContext(Internals.CompositionManager);+export const useAssetTimelineContextMenu = (): (() =>+ | ComboboxValue[]+ | null) => {+ const compositionManagerRef = useContext(+ Internals.CompositionManagerRefContext,+ );const {previewServerState} = useContext(StudioServerConnectionCtx);- return useMemo(() => {+ return useCallback(() => {+ const {canvasContent} = compositionManagerRef.current;if (canvasContent?.type !== 'asset') {return null;}@@ -52,5 +57,5 @@ export const useAssetTimelineContextMenu = (): ComboboxValue[] | null => {},copyContextItem,];- }, [canvasContent, previewServerState.type]);+ }, [compositionManagerRef, previewServerState.type]);};