Skip to content

🎥 Make videos programmatically with React

`@remotion/studio`: Add Unwrap to context menus

JonnyBurger0ae523649bc7
diff --git a/packages/studio/src/components/SelectedOutlineElement.tsx b/packages/studio/src/components/SelectedOutlineElement.tsx
index 3ac5913012..3e232a99d6 100644
--- a/packages/studio/src/components/SelectedOutlineElement.tsx
+++ b/packages/studio/src/components/SelectedOutlineElement.tsx
@@ -38,6 +38,7 @@ import {
findCopyableFrameElement,
getSequenceContextMenuItems,
} from './Timeline/get-sequence-context-menu-items';
+import {getSequenceUnwrapMenuItem} from './Timeline/get-sequence-unwrap-menu-item';
import {getTimelineAssetLinkInfo} from './Timeline/timeline-asset-link';
import {
getTimelineSequenceSelectionKey,
@@ -126,7 +127,9 @@ const SelectedOutlineElementUnmemoized: React.FC<
const deleteTimelineItems = useDeleteTimelineItems();
const selectAsset = useSelectAsset();
const selectComposition = useSelectComposition();
- const {compositions} = useContext(Internals.CompositionManager);
+ const {compositions, canvasContent} = useContext(
+ Internals.CompositionManager,
+ );
const {setSelectedModal} = useContext(SetSelectedModalContext);
const currentSelection = useCurrentTimelineSelectionStateAsRef();
const {setManuallyEnabled} = useContext(Transform3DModeStateContext);
@@ -318,6 +321,18 @@ const SelectedOutlineElementUnmemoized: React.FC<
const canRotate = !sourceEditDisabled && outline.path === null;
const outlineElement =
contextMenuTarget.sequence.refForOutline?.current ?? null;
+ const unwrapMenuItem = await getSequenceUnwrapMenuItem({
+ canEditSource:
+ !sourceEditDisabled && previewServerState.type === 'connected',
+ compositionId:
+ canvasContent?.type === 'composition'
+ ? canvasContent.compositionId
+ : null,
+ isTransition:
+ contextMenuTarget.sequence.timelineTrack?.role === 'transition',
+ nodePath,
+ });
+
return getSequenceContextMenuItems({
assetLinkInfo,
canOpenInEditor,
@@ -408,6 +423,7 @@ const SelectedOutlineElementUnmemoized: React.FC<
sequence: contextMenuTarget.sequence,
sourceActions: sourceEditingEnabled
? [
+ ...(unwrapMenuItem ? [unwrapMenuItem] : []),
...(contextMenuTarget.nodePathInfo.supportsEffects
? [
{
@@ -510,6 +526,7 @@ const SelectedOutlineElementUnmemoized: React.FC<
});
}, [
canConfigureApps,
+ canvasContent,
codingAgentInfo,
confirm,
deleteTimelineItems,
diff --git a/packages/studio/src/components/Timeline/TimelineSequence.tsx b/packages/studio/src/components/Timeline/TimelineSequence.tsx
index 0b49de7b2b..1b1555d82b 100644
--- a/packages/studio/src/components/Timeline/TimelineSequence.tsx
+++ b/packages/studio/src/components/Timeline/TimelineSequence.tsx
@@ -69,6 +69,7 @@ import {
getSequenceContextMenuItems,
} from './get-sequence-context-menu-items';
import {getSequenceSplitMenuItem} from './get-sequence-split-menu-item';
+import {getSequenceUnwrapMenuItem} from './get-sequence-unwrap-menu-item';
import {getSequencesContextForAgents} from './get-sequences-context-for-agents';
import {getTimelineMediaStartFrame} from './get-timeline-media-start-frame';
import {
@@ -1452,6 +1453,7 @@ const useTimelineSequenceState = (props: TimelineSequenceProps) => {
const showPremounting = showPremountingSetting || premountSelected;
const previewConnected = previewServerState.type === 'connected';
const previewInteractive = previewConnected && isStudioInteractivityEnabled();
+ const {canvasContent} = useContext(Internals.CompositionManager);
const {setPropStatuses} = useContext(Internals.VisualModeSettersContext);
const {setSelectedModal} = useContext(SetSelectedModalContext);
const selectAsset = useSelectAsset();
@@ -1651,7 +1653,7 @@ const useTimelineSequenceState = (props: TimelineSequenceProps) => {
validatedLocation?.source,
]);
const getContextMenuItems = useCallback(
- (event: MouseEvent) => {
+ async (event: MouseEvent) => {
const contextMenuTarget =
event.target instanceof Element
? event.target.closest<HTMLElement>(`[${TIMELINE_MARQUEE_ITEM_ATTR}]`)
@@ -1684,6 +1686,16 @@ const useTimelineSequenceState = (props: TimelineSequenceProps) => {
});
}
+ const unwrapMenuItem = await getSequenceUnwrapMenuItem({
+ canEditSource: previewInteractive && Boolean(validatedLocation?.source),
+ compositionId:
+ canvasContent?.type === 'composition'
+ ? canvasContent.compositionId
+ : null,
+ isTransition: s.timelineTrack?.role === 'transition',
+ nodePath,
+ });
+
const splitMenuItem = getSequenceSplitMenuItem({
nodePathInfo,
sequence: s,
@@ -1742,6 +1754,7 @@ const useTimelineSequenceState = (props: TimelineSequenceProps) => {
sequence: s,
sourceActions: isStudioInteractivityEnabled()
? [
+ ...(unwrapMenuItem ? [unwrapMenuItem] : []),
...(splitMenuItem ? [splitMenuItem] : []),
...(freezeFrameMenuItem ? [freezeFrameMenuItem] : []),
]
@@ -1752,6 +1765,7 @@ const useTimelineSequenceState = (props: TimelineSequenceProps) => {
},
[
assetContextMenu,
+ canvasContent,
canOpenInEditor,
canConfigureApps,
codingAgentInfo,
diff --git a/packages/studio/src/components/Timeline/TimelineSequenceItem.tsx b/packages/studio/src/components/Timeline/TimelineSequenceItem.tsx
index e0a7841069..82c5beb782 100644
--- a/packages/studio/src/components/Timeline/TimelineSequenceItem.tsx
+++ b/packages/studio/src/components/Timeline/TimelineSequenceItem.tsx
@@ -85,6 +85,7 @@ import {
getSequenceContextMenuItems,
} from './get-sequence-context-menu-items';
import {getSequenceSplitMenuItem} from './get-sequence-split-menu-item';
+import {getSequenceUnwrapMenuItem} from './get-sequence-unwrap-menu-item';
import {getSequencesContextForAgents} from './get-sequences-context-for-agents';
import {getCurrentFrame} from './imperative-state';
import {saveSequenceProps} from './save-sequence-prop';
@@ -390,6 +391,7 @@ const TimelineSequenceItemInner: React.FC<{
const {previewServerState} = useContext(StudioServerConnectionCtx);
const previewConnected = previewServerState.type === 'connected';
const previewInteractive = previewConnected && isStudioInteractivityEnabled();
+ const {canvasContent} = useContext(Internals.CompositionManager);
const isStill = useIsStill();
const canMutateEffects =
previewConnected && isStudioSelectionEnabled() && canUseEffectOperations();
@@ -1377,7 +1379,7 @@ const TimelineSequenceItemInner: React.FC<{
}, [canRotate, nodePathInfo, selectItem, setManuallyEnabled]);
const getContextMenuItems = useCallback(
- (event: MouseEvent) => {
+ async (event: MouseEvent) => {
const contextMenuTarget =
event.currentTarget instanceof HTMLElement ? event.currentTarget : null;
if (assetContextMenu !== null) {
@@ -1408,6 +1410,16 @@ const TimelineSequenceItemInner: React.FC<{
});
}
+ const unwrapMenuItem = await getSequenceUnwrapMenuItem({
+ canEditSource: previewInteractive && Boolean(validatedLocation?.source),
+ compositionId:
+ canvasContent?.type === 'composition'
+ ? canvasContent.compositionId
+ : null,
+ isTransition: sequence.timelineTrack?.role === 'transition',
+ nodePath,
+ });
+
const splitMenuItem = getSequenceSplitMenuItem({
nodePathInfo,
sequence,
@@ -1540,6 +1552,7 @@ const TimelineSequenceItemInner: React.FC<{
subMenu: null,
value: 'rename-sequence',
},
+ ...(unwrapMenuItem ? [unwrapMenuItem] : []),
...(!isPackedTrack && splitMenuItem ? [splitMenuItem] : []),
...(!isPackedTrack && freezeFrameMenuItem
? [freezeFrameMenuItem]
@@ -1552,6 +1565,7 @@ const TimelineSequenceItemInner: React.FC<{
},
[
assetContextMenu,
+ canvasContent,
canAddEffect,
canCrop,
canRotate,
diff --git a/packages/studio/src/components/Timeline/get-sequence-unwrap-menu-item.ts b/packages/studio/src/components/Timeline/get-sequence-unwrap-menu-item.ts
new file mode 100644
index 0000000000..849c03e0cd
--- /dev/null
+++ b/packages/studio/src/components/Timeline/get-sequence-unwrap-menu-item.ts
@@ -0,0 +1,60 @@
+import type {SequencePropsSubscriptionKey} from 'remotion';
+import type {ComboboxValue} from '../NewComposition/ComboBox';
+import {showNotification} from '../Notifications/NotificationCenter';
+import {unwrapNode} from '../unwrap-node-api';
+
+export const getSequenceUnwrapMenuItem = async ({
+ canEditSource,
+ compositionId,
+ isTransition,
+ nodePath,
+}: {
+ readonly canEditSource: boolean;
+ readonly compositionId: string | null;
+ readonly isTransition: boolean;
+ readonly nodePath: SequencePropsSubscriptionKey | null;
+}): Promise<ComboboxValue | null> => {
+ if (
+ !canEditSource ||
+ compositionId === null ||
+ isTransition ||
+ nodePath === null
+ ) {
+ return null;
+ }
+
+ const request = {
+ fileName: nodePath.absolutePath,
+ compositionId,
+ nodePath: nodePath.nodePath,
+ };
+ try {
+ const result = await unwrapNode({...request, dryRun: true});
+ if (!result.success || !result.canUnwrap) {
+ return null;
+ }
+ } catch {
+ return null;
+ }
+
+ return {
+ type: 'item',
+ id: 'unwrap-sequence',
+ label: 'Unwrap',
+ value: 'unwrap-sequence',
+ keyHint: null,
+ leftItem: null,
+ quickSwitcherLabel: null,
+ subMenu: null,
+ disabled: false,
+ onClick: () => {
+ unwrapNode({...request, dryRun: false})
+ .then((result) => {
+ if (!result.success) {
+ showNotification(result.reason, 4000);
+ }
+ })
+ .catch((error: Error) => showNotification(error.message, 4000));
+ },
+ };
+};