🎥 Make videos programmatically with React
`@remotion/studio`: Copy Basic captions source into projects
Jonny Burgerc9dafce79348
diff --git a/bun.lock b/bun.lockindex 6c50200519..544cdbafb0 100644--- a/bun.lock+++ b/bun.lock@@ -250,12 +250,6 @@"@remotion/eslint-config-internal": "workspace:*","@typescript/native-preview": "catalog:","eslint": "catalog:",- "react": "catalog:",- "remotion": "workspace:*",- },- "peerDependencies": {- "react": ">=16.8.0",- "remotion": "workspace:*",},},"packages/claude-code-plugin": {@@ -10679,8 +10673,6 @@"@remotion/canvas/react-dom": ["[email protected]", "", { "dependencies": { "scheduler": "^0.27.0" }, "peerDependencies": { "react": "^19.2.3" } }, "sha512-yELu4WmLPw5Mr/lmeEpox5rw3RETacE++JgHqQzd2dg+YbJuat3jH4ingc+WPZhxaoFzdv9y33G+F7Nl5O0GBg=="],- "@remotion/captions/react": ["[email protected]", "", {}, "sha512-Ku/hhYbVjOQnXDZFv2+RibmLFGwFdeeKHFcOTlrt7xplBnya5OGn/hIRDsqDiSUcfORsDC7MPxwork8jBwsIWA=="],-"@remotion/cli/react": ["[email protected]", "", {}, "sha512-Ku/hhYbVjOQnXDZFv2+RibmLFGwFdeeKHFcOTlrt7xplBnya5OGn/hIRDsqDiSUcfORsDC7MPxwork8jBwsIWA=="],"@remotion/cli/react-dom": ["[email protected]", "", { "dependencies": { "scheduler": "^0.27.0" }, "peerDependencies": { "react": "^19.2.3" } }, "sha512-yELu4WmLPw5Mr/lmeEpox5rw3RETacE++JgHqQzd2dg+YbJuat3jH4ingc+WPZhxaoFzdv9y33G+F7Nl5O0GBg=="],diff --git a/packages/browser-studio/src/browser-studio-operations.ts b/packages/browser-studio/src/browser-studio-operations.tsindex b52e4b55da..e3d732fa91 100644--- a/packages/browser-studio/src/browser-studio-operations.ts+++ b/packages/browser-studio/src/browser-studio-operations.ts@@ -1,5 +1,6 @@import {addEffect as addEffectCodemod,+ basicCaptionsElementSource,computeSequencePropsStatusFromContent,computeSequencePropsSubscriptionFromContent,deleteJsxNodes,@@ -9,6 +10,7 @@ import {duplicateJsxNodes as duplicateJsxNodesCodemod,findProjectFile,getCanUpdateDefaultPropsForProject,+ getBasicCaptionsElementFile,getCompositionComponentInfo,getCompositionFile,getFolderFile,@@ -1912,11 +1914,16 @@ export const createBrowserStudioOperations = ({try {const project = getProject();const absolutePath = findProjectFile({filePath: fileName, project});+ const elementFile = getBasicCaptionsElementFile({+ fileName: absolutePath,+ readFileContents: (candidate) => project.files[candidate] ?? null,+ });const result = insertBasicCaptionsCodemod({input: project.files[absolutePath],nodePath,captions,durationInFrames,+ importPath: elementFile.importPath,});const nodePathMutation = controller.applyMutation({undoRedoNavigation: null,@@ -1924,7 +1931,13 @@ export const createBrowserStudioOperations = ({fileName: absolutePath,mutate: () => ({...project,- files: {...project.files, [absolutePath]: result.output},+ files: {+ ...project.files,+ ...(elementFile.shouldWrite+ ? {[elementFile.fileName]: basicCaptionsElementSource}+ : {}),+ [absolutePath]: result.output,+ },}),nodePathMutationFiles: [{diff --git a/packages/browser-studio/src/test/browser-studio-operations.test.ts b/packages/browser-studio/src/test/browser-studio-operations.test.tsindex 0759a3aa6a..3144128930 100644--- a/packages/browser-studio/src/test/browser-studio-operations.test.ts+++ b/packages/browser-studio/src/test/browser-studio-operations.test.ts@@ -1,4 +1,5 @@import {expect, test} from 'bun:test';+import {basicCaptionsElementSource} from '@remotion/studio-codemods';import {createElementPayload} from '@remotion/studio-protocol';import type {EventSourceEvent} from '@remotion/studio-shared';import type {InteractivitySchema} from 'remotion';@@ -423,7 +424,10 @@ registerRoot(Root);`,}expect(currentProject.files[fileName]).toContain(- "import {BasicCaptions} from '@remotion/captions/basic-captions';",+ "import {BasicCaptions} from './basic-captions.element';",+ );+ expect(currentProject.files['/project/src/basic-captions.element.tsx']).toBe(+ basicCaptionsElementSource,);expect(currentProject.files[fileName]).toContain('<BasicCaptions captions={[',@@ -435,6 +439,9 @@ registerRoot(Root);`,});expect((await operations.undo()).success).toBe(true);expect(currentProject.files[fileName]).toBe(initialSource);+ expect(+ currentProject.files['/project/src/basic-captions.element.tsx'],+ ).toBeUndefined();});test('reports invalid timeline Solid input without changing the project', async () => {diff --git a/packages/captions/bundle.ts b/packages/captions/bundle.tsindex 6e6e687cfa..24f8465e8e 100644--- a/packages/captions/bundle.ts+++ b/packages/captions/bundle.ts@@ -14,14 +14,4 @@ const text = await file.text();await Bun.write('dist/esm/index.mjs', text);-const basicCaptions = await build({- entrypoints: ['src/basic-captions.tsx'],- naming: '[name].mjs',- external: ['react', 'react/jsx-runtime', 'remotion'],-});-await Bun.write(- 'dist/esm/basic-captions.mjs',- await basicCaptions.outputs[0].text(),-);-export {};diff --git a/packages/captions/package.json b/packages/captions/package.jsonindex 9729a127a5..2580d3a4b9 100644--- a/packages/captions/package.json+++ b/packages/captions/package.json@@ -21,15 +21,10 @@"author": "Jonny Burger <[email protected]>","license": "MIT","dependencies": {},- "peerDependencies": {- "react": ">=16.8.0",- "remotion": "workspace:*"- },+ "peerDependencies": {},"devDependencies": {"@remotion/eslint-config-internal": "workspace:*","eslint": "catalog:",- "react": "catalog:",- "remotion": "workspace:*","@typescript/native-preview": "catalog:"},"keywords": [@@ -37,12 +32,6 @@],"exports": {"./package.json": "./package.json",- "./basic-captions": {- "types": "./dist/basic-captions.d.ts",- "module": "./dist/esm/basic-captions.mjs",- "import": "./dist/esm/basic-captions.mjs",- "require": "./dist/basic-captions.js"- },".": {"types": "./dist/index.d.ts","module": "./dist/esm/index.mjs",diff --git a/packages/captions/src/basic-captions.tsx b/packages/studio-codemods/src/basic-captions-element-source.tssimilarity index 55%rename from packages/captions/src/basic-captions.tsxrename to packages/studio-codemods/src/basic-captions-element-source.tsindex af8c7d58c9..93d0adccbe 100644--- a/packages/captions/src/basic-captions.tsx+++ b/packages/studio-codemods/src/basic-captions-element-source.ts@@ -1,4 +1,4 @@-import React, {forwardRef, useImperativeHandle, useMemo, useRef} from 'react';+export const basicCaptionsElementSource = `import React, {forwardRef, useImperativeHandle, useMemo, useRef} from 'react';import {Interactive,Sequence,@@ -10,36 +10,70 @@ import {type SequenceControls,type SequenceProps,} from 'remotion';-import type {Caption} from './caption';-import {createTikTokStyleCaptions} from './create-tiktok-style-captions';-export type BasicCaptionsProps = InteractiveBaseProps &+type Caption = {+ text: string;+ startMs: number;+ endMs: number;+ timestampMs: number | null;+ confidence: number | null;+ pageBreakAfter?: boolean;+};++type BasicCaptionsProps = InteractiveBaseProps &InteractiveTransformProps &- Pick<- SequenceProps,- 'from' | 'durationInFrames' | 'trimBefore' | 'width' | 'height'- > & {+ Pick<SequenceProps, 'from' | 'durationInFrames' | 'trimBefore' | 'width' | 'height'> & {readonly captions: Caption[];readonly playbackRate?: number;readonly combineTokensWithinMilliseconds?: number;};-const CaptionContent: React.FC<- Pick<- BasicCaptionsProps,- 'captions' | 'playbackRate' | 'combineTokensWithinMilliseconds'- >-> = ({captions, playbackRate = 1, combineTokensWithinMilliseconds = 2000}) => {+const BasicCaptionsContent: React.FC<{+ readonly captions: Caption[];+ readonly playbackRate: number;+ readonly combineTokensWithinMilliseconds: number;+}> = ({captions, playbackRate, combineTokensWithinMilliseconds}) => {const frame = useCurrentFrame();const {fps} = useVideoConfig();- const pages = useMemo(- () =>- createTikTokStyleCaptions({- captions,- combineTokensWithinMilliseconds,- }).pages,- [captions, combineTokensWithinMilliseconds],- );+ const pages = useMemo(() => {+ const result: {text: string; startMs: number; durationMs: number}[] = [];+ let text = '';+ let startMs = 0;+ let endMs = 0;+ const add = () => {+ result.push({text: text.trim(), startMs, durationMs: 0});+ };++ for (const caption of captions) {+ if (+ text &&+ caption.text.startsWith(' ') &&+ endMs - startMs > combineTokensWithinMilliseconds+ ) {+ add();+ text = '';+ }+ if (!text) {+ startMs = caption.startMs;+ }+ text = (text + caption.text).trimStart();+ endMs = caption.endMs;+ if (caption.pageBreakAfter && text) {+ add();+ text = '';+ }+ }+ if (text) {+ add();+ }+ for (let i = 0; i < result.length; i++) {+ result[i].durationMs =+ i + 1 < result.length+ ? result[i + 1].startMs - result[i].startMs+ : endMs - result[i].startMs;+ }+ return result;+ }, [captions, combineTokensWithinMilliseconds]);const currentTimeMs = (frame / fps) * 1000 * playbackRate;const page = pages.find((candidate) =>@@ -70,7 +104,7 @@ const CaptionContent: React.FC<whiteSpace: 'pre-wrap',}}>- {page.text.trim()}+ {page.text}</div>);};@@ -112,13 +146,13 @@ const BasicCaptionsInner = forwardRef<({captions,- combineTokensWithinMilliseconds,+ combineTokensWithinMilliseconds = 2000,controls,durationInFrames,from,height = 220,name,- playbackRate,+ playbackRate = 1,style,trimBefore,width = 900,@@ -155,7 +189,7 @@ const BasicCaptionsInner = forwardRef<...style,}}>- <CaptionContent+ <BasicCaptionsContentcaptions={captions}combineTokensWithinMilliseconds={combineTokensWithinMilliseconds}playbackRate={playbackRate}@@ -172,3 +206,36 @@ export const BasicCaptions = Interactive.withSchema({schema: basicCaptionsSchema,supportsEffects: false,}) as React.FC<BasicCaptionsProps>;+`;++export const getBasicCaptionsElementFile = ({+ fileName,+ readFileContents,+}: {+ fileName: string;+ readFileContents: (fileName: string) => string | null;+}): {+ fileName: string;+ importPath: string;+ shouldWrite: boolean;+} => {+ const separatorIndex = Math.max(+ fileName.lastIndexOf('/'),+ fileName.lastIndexOf('\\'),+ );+ const directory = fileName.slice(0, separatorIndex + 1);+ for (let index = 0; index < 1000; index++) {+ const baseName = `basic-captions${index === 0 ? '' : `-${index + 1}`}.element`;+ const candidate = `${directory}${baseName}.tsx`;+ const existing = readFileContents(candidate);+ if (existing === null || existing === basicCaptionsElementSource) {+ return {+ fileName: candidate,+ importPath: `./${baseName}`,+ shouldWrite: existing === null,+ };+ }+ }++ throw new Error('Could not find an available filename for Basic captions');+};diff --git a/packages/studio-codemods/src/index.ts b/packages/studio-codemods/src/index.tsindex 662560a904..c64e6376a7 100644--- a/packages/studio-codemods/src/index.ts+++ b/packages/studio-codemods/src/index.ts@@ -86,6 +86,10 @@ export {simpleDiff} from './simple-diff';export {splitJsxSequence} from './split-jsx-sequence';export {splitVideoFromAudio} from './split-video-from-audio';export {insertBasicCaptions} from './insert-basic-captions';+export {+ basicCaptionsElementSource,+ getBasicCaptionsElementFile,+} from './basic-captions-element-source';export {getCompositionDefaultPropsLine,updateDefaultProps,diff --git a/packages/studio-codemods/src/insert-basic-captions.ts b/packages/studio-codemods/src/insert-basic-captions.tsindex 374ec149dd..61d212bd64 100644--- a/packages/studio-codemods/src/insert-basic-captions.ts+++ b/packages/studio-codemods/src/insert-basic-captions.ts@@ -30,6 +30,7 @@ export const insertBasicCaptions = ({nodePath,captions,durationInFrames,+ importPath = './basic-captions.element',prettierConfigOverride = null,}: {input: string;@@ -43,6 +44,7 @@ export const insertBasicCaptions = ({pageBreakAfter?: boolean;}[];durationInFrames: number | null;+ importPath?: string;prettierConfigOverride?: Record<string, unknown> | null;}): {output: string;@@ -96,7 +98,7 @@ export const insertBasicCaptions = ({ast,importedName: 'BasicCaptions',localName,- sourcePath: '@remotion/captions/basic-captions',+ sourcePath: importPath,});const copiedAttributes = media.openingElement.attributes.filter(diff --git a/packages/studio-server/src/preview-server/routes/insert-basic-captions.ts b/packages/studio-server/src/preview-server/routes/insert-basic-captions.tsindex 3c9eb547d8..806af05f3e 100644--- a/packages/studio-server/src/preview-server/routes/insert-basic-captions.ts+++ b/packages/studio-server/src/preview-server/routes/insert-basic-captions.ts@@ -1,5 +1,9 @@-import {readFileSync} from 'node:fs';+import {lstatSync, readFileSync} from 'node:fs';import {RenderInternals} from '@remotion/renderer';+import {+ basicCaptionsElementSource,+ getBasicCaptionsElementFile,+} from '@remotion/studio-codemods';import type {InsertBasicCaptionsRequest,InsertBasicCaptionsResponse,@@ -12,7 +16,7 @@ import {formatLogFileLocation} from '../format-log-file-location';import {broadcastSequenceNodePathMutation} from '../sequence-node-path-mutation';import {printUndoHint,- pushToUndoStack,+ pushTransactionToUndoStack,suppressUndoStackInvalidation,} from '../undo-stack';import {@@ -36,32 +40,85 @@ export const insertBasicCaptionsHandler: ApiHandler<action: 'modify',});const fileContents = readFileSync(absolutePath, 'utf-8');+ const elementFile = getBasicCaptionsElementFile({+ fileName: absolutePath,+ readFileContents: (candidate) => {+ const {absolutePath: elementPath} = resolveFileInsideProject({+ remotionRoot,+ fileName: candidate,+ action: 'create',+ });+ let stat;+ try {+ stat = lstatSync(elementPath);+ } catch (error) {+ if ((error as NodeJS.ErrnoException).code === 'ENOENT') {+ return null;+ }++ throw error;+ }++ if (!stat.isFile()) {+ throw new Error(`Cannot use ${elementPath} for Basic captions`);+ }++ return readFileSync(elementPath, 'utf-8');+ },+ });const {output, logLine, nodePathRemappings} = insertBasicCaptions({input: fileContents,nodePath,captions,durationInFrames,+ importPath: elementFile.importPath,});const nodePathMutation = broadcastSequenceNodePathMutation([{absolutePath, remappings: nodePathRemappings}],null,);- pushToUndoStack({- filePath: absolutePath,- oldContents: fileContents,- newContents: null,+ pushTransactionToUndoStack({+ snapshots: [+ ...(elementFile.shouldWrite+ ? [+ {+ filePath: elementFile.fileName,+ oldContents: null,+ newContents: basicCaptionsElementSource,+ logLine: 1,+ nodePathRemappings: null,+ },+ ]+ : []),+ {+ filePath: absolutePath,+ oldContents: fileContents,+ newContents: output,+ logLine,+ nodePathRemappings,+ },+ ],logLevel,remotionRoot,- logLine,description: {undoMessage: '↩️ Insertion of Basic captions',redoMessage: '↪️ Insertion of Basic captions',},entryType: 'insert-basic-captions',suppressHmrOnFileRestore: false,- nodePathRemappings,+ undoRedoNavigation: null,});+ if (elementFile.shouldWrite) {+ suppressUndoStackInvalidation(elementFile.fileName);+ writeFileAndNotifyFileWatchers({+ file: elementFile.fileName,+ content: basicCaptionsElementSource,+ originatorClientId: undefined,+ metadata: null,+ });+ }+suppressUndoStackInvalidation(absolutePath);writeFileAndNotifyFileWatchers({file: absolutePath,diff --git a/packages/studio-server/src/test/insert-basic-captions.test.ts b/packages/studio-server/src/test/insert-basic-captions.test.tsindex d2ac769bce..f3ce2ef8ed 100644--- a/packages/studio-server/src/test/insert-basic-captions.test.ts+++ b/packages/studio-server/src/test/insert-basic-captions.test.ts@@ -1,7 +1,14 @@import {expect, test} from 'bun:test';-import {mkdtempSync, readFileSync, rmSync, writeFileSync} from 'node:fs';+import {+ mkdtempSync,+ readFileSync,+ readdirSync,+ rmSync,+ writeFileSync,+} from 'node:fs';import {tmpdir} from 'node:os';import path from 'node:path';+import {basicCaptionsElementSource} from '@remotion/studio-codemods';import {insertBasicCaptions} from '../codemods/insert-basic-captions';import {createFileWatcherRegistry,@@ -83,8 +90,18 @@ export const Comp = () => (const written = readFileSync(entryPoint, 'utf-8');expect(written).toContain(- `import {BasicCaptions} from '@remotion/captions/basic-captions';`,+ `import {BasicCaptions} from './basic-captions.element';`,);+ expect(written).not.toContain('@remotion/captions/basic-captions');+ expect(+ readFileSync(+ path.join(remotionRoot, 'basic-captions.element.tsx'),+ 'utf-8',+ ),+ ).toBe(basicCaptionsElementSource);+ expect(+ readdirSync(remotionRoot).filter((file) => file.endsWith('.element.tsx')),+ ).toEqual(['basic-captions.element.tsx']);expect(written.match(/<BasicCaptions/g)).toHaveLength(2);expect(written).toContain('"text": " Hello"');expect(written.replace(/\s+/g, ' ')).toContain(