🎥 Make videos programmatically with React
`@remotion/studio`: Apply `lut()` when dropping .cube files onto videos
Jonny Burgereb12237ede98
diff --git a/packages/studio/src/components/AssetSelectorItem.tsx b/packages/studio/src/components/AssetSelectorItem.tsxindex 0cb8e69984..ac96761bb2 100644--- a/packages/studio/src/components/AssetSelectorItem.tsx+++ b/packages/studio/src/components/AssetSelectorItem.tsx@@ -50,6 +50,7 @@ import {} from './asset-context-menu';import {AssetFileIcon} from './AssetFileIcon';import {ContextMenu} from './ContextMenu';+import {LUT_ASSET_DRAG_TYPE} from './effect-drag-and-drop';import {getAssetElementFromPath} from './import-assets';import type {RenderInlineAction} from './InlineAction';import {InlineAction} from './InlineAction';@@ -127,7 +128,11 @@ export const getCanDragAsset = ({readOnlyStudio: boolean;relativePath: string;}) => {- return !readOnlyStudio && getAssetElementFromPath(relativePath) !== null;+ return (+ !readOnlyStudio &&+ (getAssetElementFromPath(relativePath) !== null ||+ getPreviewFileType(relativePath) === 'lut')+ );};export const getAssetFolderContextMenuItems = ({@@ -583,6 +588,9 @@ const AssetSelectorItem: React.FC<{durationInSeconds,});e.dataTransfer.setData(dragData.mimeType, dragData.payload);+ if (previewFileType === 'lut') {+ e.dataTransfer.setData(LUT_ASSET_DRAG_TYPE, '');+ }},[canDragAsset, previewFileType, relativePath],);diff --git a/packages/studio/src/components/Canvas.tsx b/packages/studio/src/components/Canvas.tsxindex cdbc6117e8..4bf0eb53b5 100644--- a/packages/studio/src/components/Canvas.tsx+++ b/packages/studio/src/components/Canvas.tsx@@ -59,7 +59,11 @@ import {isFileDragEvent, isSupportedDropEvent} from './drop-handler-data';import EditorGuides from './EditorGuides';import {EditorRulers} from './EditorRuler';import {useIsRulerVisible} from './EditorRuler/use-is-ruler-visible';-import {getEffectDragData} from './effect-drag-and-drop';+import {+ getEffectDragData,+ isEffectDragOverTarget,+ isLutEffectDrop,+} from './effect-drag-and-drop';import {getElementDragData, hasElementDragType} from './element-drag-and-drop';import {handleDrop} from './handle-drop';import {@@ -755,6 +759,11 @@ export const Canvas: React.FC<{return;}+ if (isEffectDragOverTarget(event)) {+ setCompositionDropPreview(null);+ return;+ }+const mayBeCanvasCapture =isFileDragEvent(event) && !window.remotion_isReadOnlyStudio;const canDropElementIntoNewComposition =@@ -924,6 +933,11 @@ export const Canvas: React.FC<{return;}+ if (isLutEffectDrop(event)) {+ event.preventDefault();+ return;+ }+const localFiles = isFileDragEvent(event)? Array.from(event.dataTransfer?.files ?? []): null;diff --git a/packages/studio/src/components/Preview.tsx b/packages/studio/src/components/Preview.tsxindex 39c7575e9c..bb9b5439b9 100644--- a/packages/studio/src/components/Preview.tsx+++ b/packages/studio/src/components/Preview.tsx@@ -198,13 +198,50 @@ const CompWhenItHasDimensions: React.FC<{const onPointerEnter = () => setCanvasHovered(true);const onPointerLeave = () => setCanvasHovered(false);+ const onDragOver = (event: DragEvent) => {+ const rect = compositionContainer.getBoundingClientRect();+ setCanvasHovered(+ event.clientX >= rect.left &&+ event.clientX <= rect.right &&+ event.clientY >= rect.top &&+ event.clientY <= rect.bottom,+ );+ };++ const onDragLeave = (event: DragEvent) => {+ if (+ event.relatedTarget instanceof Node &&+ compositionContainer.contains(event.relatedTarget)+ ) {+ return;+ }++ onDragOver(event);+ };++ const onDragEnd = () => {+ requestAnimationFrame(() =>+ setCanvasHovered(compositionContainer.matches(':hover')),+ );+ };+setCanvasHovered(compositionContainer.matches(':hover'));compositionContainer.addEventListener('pointerenter', onPointerEnter);compositionContainer.addEventListener('pointerleave', onPointerLeave);+ document.addEventListener('dragenter', onDragOver, {capture: true});+ document.addEventListener('dragover', onDragOver, {capture: true});+ document.addEventListener('dragleave', onDragLeave, {capture: true});+ document.addEventListener('drop', onDragEnd, {capture: true});+ document.addEventListener('dragend', onDragEnd, {capture: true});return () => {compositionContainer.removeEventListener('pointerenter', onPointerEnter);compositionContainer.removeEventListener('pointerleave', onPointerLeave);+ document.removeEventListener('dragenter', onDragOver, {capture: true});+ document.removeEventListener('dragover', onDragOver, {capture: true});+ document.removeEventListener('dragleave', onDragLeave, {capture: true});+ document.removeEventListener('drop', onDragEnd, {capture: true});+ document.removeEventListener('dragend', onDragEnd, {capture: true});};}, [canvasContent.type]);diff --git a/packages/studio/src/components/SelectedOutlinePolygon.tsx b/packages/studio/src/components/SelectedOutlinePolygon.tsxindex 19096758a4..ed47c05929 100644--- a/packages/studio/src/components/SelectedOutlinePolygon.tsx+++ b/packages/studio/src/components/SelectedOutlinePolygon.tsx@@ -1,5 +1,5 @@import {CanvasInternals} from '@remotion/sdk';-import React, {useContext, useMemo, useRef, useState} from 'react';+import React, {useContext, useEffect, useMemo, useRef, useState} from 'react';import {Internals} from 'remotion';import {StudioServerConnectionCtx} from '../helpers/client-id';import {@@ -14,10 +14,9 @@ import type {getSequenceAnnotationAttributes} from '../helpers/sequence-annotatiimport {EditorShowGuidesContext} from '../state/editor-guides';import {EditorSnappingContext} from '../state/editor-snapping';import {- addEffectFromDragData,- getEffectDragData,+ addEffectFromDrop,hasEffectDragType,- hasExplicitEffectDragType,+ LUT_EFFECT_DROP_TARGET_ATTR,} from './effect-drag-and-drop';import {forceSpecificCursor,@@ -133,6 +132,23 @@ const SelectedOutlinePolygonUnmemoized: React.FC<{const polygonRef = useRef<SVGPolygonElement>(null);const {selectItems} = useTimelineSelection();const [effectDropHovered, setEffectDropHovered] = useState(false);+ useEffect(() => {+ if (!effectDropHovered) {+ return;+ }++ const clearEffectDropHover = () => setEffectDropHovered(false);+ document.addEventListener('drop', clearEffectDropHover, {capture: true});+ document.addEventListener('dragend', clearEffectDropHover, {capture: true});+ return () => {+ document.removeEventListener('drop', clearEffectDropHover, {+ capture: true,+ });+ document.removeEventListener('dragend', clearEffectDropHover, {+ capture: true,+ });+ };+ }, [effectDropHovered]);const visible = showSelectedOutline || hovered;const getEffectDropTarget = React.useCallback(() => {if (@@ -415,24 +431,12 @@ const SelectedOutlinePolygonUnmemoized: React.FC<{return;}- const dragData = getEffectDragData(event.dataTransfer);- if (!dragData) {- if (hasExplicitEffectDragType(event.dataTransfer)) {- event.preventDefault();- event.stopPropagation();- setEffectDropHovered(false);- showNotification('Could not read effect drag data', 3000);- }-- return;- }-event.preventDefault();event.stopPropagation();setEffectDropHovered(false);- await addEffectFromDragData({- dragData,+ await addEffectFromDrop({+ dataTransfer: event.dataTransfer,fileName: effectDrop.fileName,nodePathInfo: effectDrop.nodePathInfo,clientId: effectDrop.clientId,@@ -449,6 +453,8 @@ const SelectedOutlinePolygonUnmemoized: React.FC<{{...{[PREVENT_CLEAR_SELECTION_ON_POINTER_DOWN_ATTR]: 'true',[SELECTED_OUTLINE_KEY_ATTR]: outline.key,+ [LUT_EFFECT_DROP_TARGET_ATTR]:+ getEffectDropTarget() !== null ? 'true' : undefined,}}outline={outline}directlySelected={directlySelected}diff --git a/packages/studio/src/components/Timeline/TimelineSequenceItem.tsx b/packages/studio/src/components/Timeline/TimelineSequenceItem.tsxindex 7340741baa..d5c91ffbe2 100644--- a/packages/studio/src/components/Timeline/TimelineSequenceItem.tsx+++ b/packages/studio/src/components/Timeline/TimelineSequenceItem.tsx@@ -59,10 +59,9 @@ import {CompositionOrStillIcon} from '../CompositionOrStillIcon';import {useConfirmationDialog} from '../ConfirmationDialog';import {ContextMenu} from '../ContextMenu';import {- addEffectFromDragData,- getEffectDragData,+ addEffectFromDrop,hasEffectDragType,- hasExplicitEffectDragType,+ LUT_EFFECT_DROP_TARGET_ATTR,} from '../effect-drag-and-drop';import {ExpandedTracksGetterContext,@@ -416,6 +415,23 @@ const TimelineSequenceItemInner: React.FC<{}, [selected, selectedItems]);const containsSelection = useTimelineRowContainsSelection(nodePathInfo);const [effectDropHovered, setEffectDropHovered] = useState(false);+ useEffect(() => {+ if (!effectDropHovered) {+ return;+ }++ const clearEffectDropHover = () => setEffectDropHovered(false);+ document.addEventListener('drop', clearEffectDropHover, {capture: true});+ document.addEventListener('dragend', clearEffectDropHover, {capture: true});+ return () => {+ document.removeEventListener('drop', clearEffectDropHover, {+ capture: true,+ });+ document.removeEventListener('dragend', clearEffectDropHover, {+ capture: true,+ });+ };+ }, [effectDropHovered]);const [isRenaming, setIsRenaming] = useState(false);const [sequenceDropIndicator, setSequenceDropIndicator] =useState<ReorderSequencePosition | null>(null);@@ -1622,24 +1638,12 @@ const TimelineSequenceItemInner: React.FC<{return;}- const dragData = getEffectDragData(e.dataTransfer);- if (!dragData) {- if (hasExplicitEffectDragType(e.dataTransfer)) {- e.preventDefault();- e.stopPropagation();- setEffectDropHovered(false);- showNotification('Could not read effect drag data', 3000);- }-- return;- }-e.preventDefault();e.stopPropagation();setEffectDropHovered(false);- await addEffectFromDragData({- dragData,+ await addEffectFromDrop({+ dataTransfer: e.dataTransfer,fileName: validatedLocation.source,nodePathInfo,clientId: previewServerState.clientId,@@ -1752,6 +1756,9 @@ const TimelineSequenceItemInner: React.FC<{const annotatedTrackRow = (<div+ {...{+ [LUT_EFFECT_DROP_TARGET_ATTR]: canDropEffect ? 'true' : undefined,+ }}{...getSequenceAnnotationAttributes({sequence,location: originalLocation,diff --git a/packages/studio/src/components/Timeline/use-timeline-asset-drop.ts b/packages/studio/src/components/Timeline/use-timeline-asset-drop.tsindex e7b6c1cd5a..74a3771900 100644--- a/packages/studio/src/components/Timeline/use-timeline-asset-drop.ts+++ b/packages/studio/src/components/Timeline/use-timeline-asset-drop.ts@@ -6,7 +6,11 @@ import {useCachedCompositionComponentInfo} from '../../helpers/open-in-editor';import {SetSelectedModalContext} from '../../state/modals';import {handleCanvasCaptureDrop} from '../canvas-capture-drop';import {isFileDragEvent, isSupportedDropEvent} from '../drop-handler-data';-import {getEffectDragData} from '../effect-drag-and-drop';+import {+ getEffectDragData,+ isEffectDragOverTarget,+ isLutEffectDrop,+} from '../effect-drag-and-drop';import {getElementDragData, hasElementDragType} from '../element-drag-and-drop';import {handleDrop} from '../handle-drop';import {showNotification} from '../Notifications/NotificationCenter';@@ -99,6 +103,11 @@ export const useTimelineAssetDrop = () => {return;}+ if (isEffectDragOverTarget(event)) {+ setAssetDropFrame(null);+ return;+ }+const canDropElementIntoNewComposition =compositionComponentInfo?.canAddSequence === false &&canReceiveElementDrop &&@@ -137,6 +146,11 @@ export const useTimelineAssetDrop = () => {return;}+ if (isLutEffectDrop(event)) {+ event.preventDefault();+ return;+ }+const localFiles = isFileDragEvent(event)? Array.from(dataTransfer.files): null;diff --git a/packages/studio/src/components/effect-drag-and-drop.ts b/packages/studio/src/components/effect-drag-and-drop.tsindex fc09027f53..2054583c48 100644--- a/packages/studio/src/components/effect-drag-and-drop.ts+++ b/packages/studio/src/components/effect-drag-and-drop.ts@@ -6,22 +6,65 @@ import {type EffectDefinition,getRequiredPackageForEffectImportPath,} from '@remotion/studio-shared';+import {staticFile} from 'remotion';import {getBrowserStudioEffectOperations} from '../helpers/browser-studio-operations';+import {parseCubeLut} from '../helpers/cube-lut';+import {getPreviewFileType} from '../helpers/get-preview-file-type';import type {SequenceNodePathInfo} from '../helpers/get-timeline-sequence-sort-key';import {installRequiredPackages} from '../helpers/install-required-package';import {addEffect} from './effect-operations-api';import {showNotification} from './Notifications/NotificationCenter';import type {useTimelineSelection} from './Timeline/TimelineSelection';-export const hasEffectDragType = (dataTransfer: DataTransfer) => {+export const LUT_ASSET_DRAG_TYPE = 'application/vnd.remotion.lut';+export const LUT_EFFECT_DROP_TARGET_ATTR =+ 'data-remotion-lut-effect-drop-target';++export const hasExplicitEffectDragType = (dataTransfer: DataTransfer) => {return (StudioProtocolInternals.getDragPreviewMetadata(dataTransfer.types)?.type ==='effect');};-export const hasExplicitEffectDragType = (dataTransfer: DataTransfer) => {- return hasEffectDragType(dataTransfer);+export const hasEffectDragType = (dataTransfer: DataTransfer) => {+ return (+ hasExplicitEffectDragType(dataTransfer) ||+ Array.from(dataTransfer.types).includes(LUT_ASSET_DRAG_TYPE) ||+ // File names are unavailable during native file drags until the drop.+ Array.from(dataTransfer.types).includes('Files')+ );+};++export const isLutEffectDrop = (event: DragEvent) => {+ const {dataTransfer, target} = event;+ if (+ dataTransfer === null ||+ !(target instanceof Element) ||+ target.closest(`[${LUT_EFFECT_DROP_TARGET_ATTR}="true"]`) === null+ ) {+ return false;+ }++ const files = Array.from(dataTransfer.files);+ if (files.length > 0) {+ return files.length === 1 && getPreviewFileType(files[0].name) === 'lut';+ }++ const parsed = StudioProtocolInternals.parseDragData(dataTransfer);+ return (+ parsed?.type === 'asset' &&+ getPreviewFileType(parsed.data.assetPath) === 'lut'+ );+};++export const isEffectDragOverTarget = (event: DragEvent) => {+ return (+ event.dataTransfer !== null &&+ hasEffectDragType(event.dataTransfer) &&+ event.target instanceof Element &&+ event.target.closest(`[${LUT_EFFECT_DROP_TARGET_ATTR}="true"]`) !== null+ );};export const getEffectDragData = (@@ -31,26 +74,75 @@ export const getEffectDragData = (return parsed?.type === 'effect' ? parsed.data : null;};-export const addEffectFromDragData = ({+export const addEffectFromDrop = async ({clientId,- dragData,+ dataTransfer,fileName,nodePathInfo,selectItems,}: {readonly clientId: string;- readonly dragData: EffectDragData;+ readonly dataTransfer: DataTransfer;readonly fileName: string;readonly nodePathInfo: SequenceNodePathInfo;readonly selectItems: ReturnType<typeof useTimelineSelection>['selectItems'];}) => {- return addEffectToSequence({- clientId,- effect: dragData.effect,- fileName,- nodePathInfo,- selectItems,- });+ try {+ const dragData = getEffectDragData(dataTransfer);+ let effect = dragData?.effect ?? null;+ if (effect === null) {+ const files = Array.from(dataTransfer.files);+ const parsed = StudioProtocolInternals.parseDragData(dataTransfer);+ let content: string;+ if (files.length === 1 && getPreviewFileType(files[0].name) === 'lut') {+ content = await files[0].text();+ } else if (+ files.length === 0 &&+ parsed?.type === 'asset' &&+ getPreviewFileType(parsed.data.assetPath) === 'lut'+ ) {+ const response = await fetch(staticFile(parsed.data.assetPath));+ if (!response.ok) {+ throw new Error(`Could not read LUT file ${parsed.data.assetPath}`);+ }++ content = await response.text();+ } else {+ if (hasExplicitEffectDragType(dataTransfer)) {+ showNotification('Could not read effect drag data', 3000);+ }++ return;+ }++ content = content.replace(/^\uFEFF/, '').replace(/\r\n?|\n/g, '\n');+ const lut = parseCubeLut(content);+ if (lut.type !== '3d') {+ throw new Error('lut() only supports 3D .cube files.');+ }++ // lut() uses domain headers for the input range.+ content = content.replace(+ /^\s*LUT_3D_INPUT_RANGE[^\n]*$/gm,+ `DOMAIN_MIN ${lut.domainMin.join(' ')}\nDOMAIN_MAX ${lut.domainMax.join(' ')}`,+ );+ effect = {+ name: 'lut',+ importPath: '@remotion/effects/lut',+ config: {content},+ };+ }++ await addEffectToSequence({+ clientId,+ effect,+ fileName,+ nodePathInfo,+ selectItems,+ });+ } catch (err) {+ showNotification((err as Error).message, 4000);+ }};export const addEffectToSequence = async ({