Skip to content

🎥 Make videos programmatically with React

Reduce Studio overhead for heavy compositions

Jonny Burgerbec874427eaf
diff --git a/packages/sdk/src/use-canvas-outlines.ts b/packages/sdk/src/use-canvas-outlines.ts
index 03c1c69e65..11368df2d1 100644
--- a/packages/sdk/src/use-canvas-outlines.ts
+++ b/packages/sdk/src/use-canvas-outlines.ts
@@ -1,4 +1,4 @@
-import {useEffect, useMemo, useRef} from 'react';
+import {useEffect, useLayoutEffect, useMemo, useRef} from 'react';
import type {SequenceNodePathInfo} from './get-timeline-sequence-sort-key';
import type {CanvasHoverController} from './hover';
import {useCanvasHover} from './hover';
@@ -60,6 +60,65 @@ export const useCanvasOutlines = <Target extends CanvasOutlineRenderTarget>({
() => new Map(targets.map((target) => [target.key, target])),
[targets],
);
+ const previousOrderInputsRef = useRef<{
+ readonly sequences: readonly CanvasOutlineSequenceParent[];
+ readonly targets: readonly (CanvasOutlineOrderTarget & {
+ readonly key: string;
+ })[];
+ readonly targetsByKey: ReadonlyMap<string, CanvasOutlineOrderTarget>;
+ } | null>(null);
+ const orderInputs = useMemo(() => {
+ const previous = previousOrderInputsRef.current;
+ if (
+ previous !== null &&
+ previous.sequences.length === sequences.length &&
+ previous.sequences.every(
+ (sequence, index) =>
+ sequence.id === sequences[index].id &&
+ sequence.parent === sequences[index].parent,
+ ) &&
+ previous.targets.length === targets.length &&
+ previous.targets.every((target, index) => {
+ const next = targets[index];
+ return (
+ target.key === next.key &&
+ target.selected === next.selected &&
+ target.containsSelection === next.containsSelection &&
+ target.sequence.id === next.sequence.id &&
+ target.sequence.parent === next.sequence.parent &&
+ target.sequence.controls?.componentIdentity ===
+ (next.sequence.controls?.componentIdentity ?? null)
+ );
+ })
+ ) {
+ return previous;
+ }
+
+ // Playback refreshes targets and their editing callbacks even when stacking
+ // is unchanged. Snapshot only the metadata used by the pairwise sort, while
+ // returning the live targetsByKey above to the renderer.
+ const orderTargets = targets.map((target) => ({
+ key: target.key,
+ selected: target.selected,
+ containsSelection: target.containsSelection,
+ sequence: {
+ id: target.sequence.id,
+ parent: target.sequence.parent,
+ controls: {
+ componentIdentity:
+ target.sequence.controls?.componentIdentity ?? null,
+ },
+ },
+ }));
+ return {
+ sequences: sequences.map(({id, parent}) => ({id, parent})),
+ targets: orderTargets,
+ targetsByKey: new Map(orderTargets.map((target) => [target.key, target])),
+ };
+ }, [sequences, targets]);
+ useLayoutEffect(() => {
+ previousOrderInputsRef.current = orderInputs;
+ }, [orderInputs]);
// Moving a captured polygon in the DOM can cancel the host's pointer session.
const renderingOrderRef = useRef<readonly string[]>([]);
@@ -70,8 +129,8 @@ export const useCanvasOutlines = <Target extends CanvasOutlineRenderTarget>({
if (!freezeOrder || renderingOrderRef.current.length === 0) {
const ordered = orderCanvasOutlinesForRendering({
outlines,
- sequences,
- targetsByKey,
+ sequences: orderInputs.sequences,
+ targetsByKey: orderInputs.targetsByKey,
});
renderingOrderRef.current = ordered.map((outline) => outline.key);
return ordered;
@@ -91,7 +150,7 @@ export const useCanvasOutlines = <Target extends CanvasOutlineRenderTarget>({
const outline = currentOutlinesByKey.get(key);
return outline === undefined ? [] : [outline];
});
- }, [freezeOrder, outlines, sequences, targetsByKey]);
+ }, [freezeOrder, orderInputs, outlines]);
const outlinesByKey = useMemo(
() => new Map(outlines.map((outline) => [outline.key, outline])),
[outlines],
diff --git a/packages/studio/src/components/Timeline/TimelinePackedTrack.tsx b/packages/studio/src/components/Timeline/TimelinePackedTrack.tsx
index 8ced5110fc..bfb14bec7f 100644
--- a/packages/studio/src/components/Timeline/TimelinePackedTrack.tsx
+++ b/packages/studio/src/components/Timeline/TimelinePackedTrack.tsx
@@ -3,7 +3,10 @@ import type {TSequence} from 'remotion';
import {TIMELINE_TRACK_SEPARATOR} from '../../helpers/colors';
import {TIMELINE_ITEM_BORDER_BOTTOM} from '../../helpers/timeline-layout';
import {getTimelineSceneRange} from './get-timeline-scene-range';
-import type {TimelineTransitionRange} from './get-timeline-transition-ranges';
+import {
+ getTimelineTransitionRangesByStart,
+ type TimelineTransitionRange,
+} from './get-timeline-transition-ranges';
import type {TimelineTrackWithDisplayGroup} from './timeline-display-groups';
import {
TIMELINE_PACKED_AUXILIARY_ROW_HEIGHT,
@@ -23,70 +26,75 @@ const TimelinePackedTrackItem: React.FC<{
readonly item: TimelineTrackWithDisplayGroup;
readonly previous: TSequence | null;
readonly next: TSequence | null;
- readonly transitionRanges: readonly TimelineTransitionRange[];
+ readonly transitionRangesByStart: ReadonlyMap<
+ number,
+ TimelineTransitionRange
+ >;
readonly top: number;
readonly height: number;
-}> = React.memo(({item, previous, next, transitionRanges, top, height}) => {
- const parentSceneRange = useContext(TimelineSceneRangeContext);
- return (
- <TimelineSceneRangeContext.Provider
- value={
- item.sequence.timelineTrack?.role === 'clip'
- ? getTimelineSceneRange({
- sequence: item.sequence,
- transitionRanges,
- previous,
- next,
- // The containing row already clips the parent transition.
- range: parentSceneRange
- ? {
- ...parentSceneRange,
- transitionInEnd: null,
- transitionOutStart: null,
- }
- : null,
- })
- : parentSceneRange
- }
- >
- <div
- data-timeline-track-item-id={item.sequence.id}
- style={{
- position: 'absolute',
- zIndex:
- item.sequence.timelineTrack?.role === 'transition'
- ? 1
- : item.sequence.controls?.componentIdentity ===
- 'dev.remotion.transitions.TransitionSeries.Sequence'
- ? undefined
- : 0,
- top,
- left: 0,
- // The clip supplies its own pixel width. Empty row space must
- // not intercept clicks on other clips or the marquee.
- width: 0,
- height: height - TIMELINE_ITEM_BORDER_BOTTOM,
- }}
+}> = React.memo(
+ ({item, previous, next, transitionRangesByStart, top, height}) => {
+ const parentSceneRange = useContext(TimelineSceneRangeContext);
+ return (
+ <TimelineSceneRangeContext.Provider
+ value={
+ item.sequence.timelineTrack?.role === 'clip'
+ ? getTimelineSceneRange({
+ sequence: item.sequence,
+ transitionRangesByStart,
+ previous,
+ next,
+ // The containing row already clips the parent transition.
+ range: parentSceneRange
+ ? {
+ ...parentSceneRange,
+ transitionInEnd: null,
+ transitionOutStart: null,
+ }
+ : null,
+ })
+ : parentSceneRange
+ }
>
- <TimelineSequence
- s={item.sequence}
- labelStartFrame={null}
- cascadedStart={item.cascadedStart}
- localStart={item.localStart}
- parentVisibleStart={item.parentVisibleStart}
- parentVisibleEnd={item.parentVisibleEnd}
- connectedCompositions={
- item.connectedCompositions ?? noConnectedCompositions
- }
- nodePathInfo={item.nodePathInfo}
- keyframeDisplayOffset={item.keyframeDisplayOffset}
- keyframePlaybackRate={item.keyframePlaybackRate}
- sequenceFrameOffset={item.sequenceFrameOffset}
- />
- </div>
- </TimelineSceneRangeContext.Provider>
- );
-});
+ <div
+ data-timeline-track-item-id={item.sequence.id}
+ style={{
+ position: 'absolute',
+ zIndex:
+ item.sequence.timelineTrack?.role === 'transition'
+ ? 1
+ : item.sequence.controls?.componentIdentity ===
+ 'dev.remotion.transitions.TransitionSeries.Sequence'
+ ? undefined
+ : 0,
+ top,
+ left: 0,
+ // The clip supplies its own pixel width. Empty row space must
+ // not intercept clicks on other clips or the marquee.
+ width: 0,
+ height: height - TIMELINE_ITEM_BORDER_BOTTOM,
+ }}
+ >
+ <TimelineSequence
+ s={item.sequence}
+ labelStartFrame={null}
+ cascadedStart={item.cascadedStart}
+ localStart={item.localStart}
+ parentVisibleStart={item.parentVisibleStart}
+ parentVisibleEnd={item.parentVisibleEnd}
+ connectedCompositions={
+ item.connectedCompositions ?? noConnectedCompositions
+ }
+ nodePathInfo={item.nodePathInfo}
+ keyframeDisplayOffset={item.keyframeDisplayOffset}
+ keyframePlaybackRate={item.keyframePlaybackRate}
+ sequenceFrameOffset={item.sequenceFrameOffset}
+ />
+ </div>
+ </TimelineSceneRangeContext.Provider>
+ );
+ },
+);
export const TimelinePackedTrack: React.FC<{
readonly track: TimelineTrackWithDisplayGroup;
@@ -140,6 +148,10 @@ export const TimelinePackedTrack: React.FC<{
useLayoutEffect(() => {
previousTransitionRangesRef.current = transitionRanges;
}, [transitionRanges]);
+ const transitionRangesByStart = useMemo(
+ () => getTimelineTransitionRangesByStart(transitionRanges),
+ [transitionRanges],
+ );
return (
<div
@@ -188,7 +200,7 @@ export const TimelinePackedTrack: React.FC<{
? row.items[index + 1].sequence
: null
}
- transitionRanges={transitionRanges}
+ transitionRangesByStart={transitionRangesByStart}
top={row.top}
height={row.height}
/>
diff --git a/packages/studio/src/components/Timeline/get-timeline-scene-range.ts b/packages/studio/src/components/Timeline/get-timeline-scene-range.ts
index f58c8b5afd..d39e69a175 100644
--- a/packages/studio/src/components/Timeline/get-timeline-scene-range.ts
+++ b/packages/studio/src/components/Timeline/get-timeline-scene-range.ts
@@ -7,13 +7,16 @@ export const getTimelineSceneRange = ({
previous,
next,
range,
- transitionRanges,
+ transitionRangesByStart,
}: {
readonly sequence: TSequence;
readonly previous: TSequence | null;
readonly next: TSequence | null;
readonly range: TimelineSceneRange | null;
- readonly transitionRanges: readonly TimelineTransitionRange[];
+ readonly transitionRangesByStart: ReadonlyMap<
+ number,
+ TimelineTransitionRange
+ >;
}): TimelineSceneRange => {
const sceneEnd = sequence.from + sequence.duration;
const previousEnd = previous
@@ -21,13 +24,13 @@ export const getTimelineSceneRange = ({
: sequence.from;
const incomingTransition =
sequence.timelineTrack?.role === 'clip' && previousEnd > sequence.from
- ? transitionRanges.find((item) => item.from === sequence.from)
+ ? transitionRangesByStart.get(sequence.from)
: undefined;
const outgoingTransition =
sequence.timelineTrack?.role === 'clip' &&
next !== null &&
next.from < sceneEnd
- ? transitionRanges.find((item) => item.from === next.from)
+ ? transitionRangesByStart.get(next.from)
: undefined;
const from = Math.max(
range?.from ?? -Infinity,
diff --git a/packages/studio/src/components/Timeline/get-timeline-transition-ranges.ts b/packages/studio/src/components/Timeline/get-timeline-transition-ranges.ts
index 8e624bd9aa..60faf693e9 100644
--- a/packages/studio/src/components/Timeline/get-timeline-transition-ranges.ts
+++ b/packages/studio/src/components/Timeline/get-timeline-transition-ranges.ts
@@ -6,6 +6,21 @@ export type TimelineTransitionRange = {
readonly end: number;
};
+export const getTimelineTransitionRangesByStart = (
+ ranges: readonly TimelineTransitionRange[],
+): ReadonlyMap<number, TimelineTransitionRange> => {
+ const byStart = new Map<number, TimelineTransitionRange>();
+ for (const range of ranges) {
+ // Keep the first matching transition, as with an array lookup. NaN must
+ // not match itself, even though Map treats NaN keys as equal.
+ if (!Number.isNaN(range.from) && !byStart.has(range.from)) {
+ byStart.set(range.from, range);
+ }
+ }
+
+ return byStart;
+};
+
export const getTimelineTransitionRanges = (
items: readonly TSequence[],
): TimelineTransitionRange[] => {
diff --git a/packages/studio/src/components/Timeline/timeline-series-layout.ts b/packages/studio/src/components/Timeline/timeline-series-layout.ts
index 22c39bed92..9bc029b602 100644
--- a/packages/studio/src/components/Timeline/timeline-series-layout.ts
+++ b/packages/studio/src/components/Timeline/timeline-series-layout.ts
@@ -2,6 +2,7 @@ import type {TSequence} from 'remotion';
import {getTimelineSceneRange} from './get-timeline-scene-range';
import {
getTimelineTransitionRanges,
+ getTimelineTransitionRangesByStart,
type TimelineTransitionRange,
} from './get-timeline-transition-ranges';
import type {TimelineTrackWithDisplayGroup} from './timeline-display-groups';
@@ -50,7 +51,10 @@ export const getTimelineSeriesLayout = ({
}
const scenesBySeries = new Map<number, TimelineTrackWithDisplayGroup[]>();
- const transitionsBySeries = new Map<number, TimelineTransitionRange[]>();
+ const transitionsBySeries = new Map<
+ number,
+ ReadonlyMap<number, TimelineTransitionRange>
+ >();
const seriesByScene = new Map<string, number>();
if (compactSeries) {
for (let index = 0; index < rows.length; index++) {
@@ -83,8 +87,10 @@ export const getTimelineSeriesLayout = ({
scenesBySeries.set(index, scenes);
transitionsBySeries.set(
index,
- getTimelineTransitionRanges(
- row.childScenes.map((item) => item.sequence),
+ getTimelineTransitionRangesByStart(
+ getTimelineTransitionRanges(
+ row.childScenes.map((item) => item.sequence),
+ ),
),
);
for (const scene of scenes) {
@@ -180,7 +186,7 @@ export const getTimelineSeriesLayout = ({
const next = roleScenes[sceneIndex + 1]?.sequence;
const sceneRange = getTimelineSceneRange({
sequence,
- transitionRanges: transitionsBySeries.get(index) ?? [],
+ transitionRangesByStart: transitionsBySeries.get(index)!,
previous: previous ?? null,
next: next ?? null,
range,