🎥 Make videos programmatically with React
Use captions package in generated Basic captions element
Jonny Burgerc048a7bf024d
diff --git a/packages/studio-codemods/src/basic-captions-element-source.ts b/packages/studio-codemods/src/basic-captions-element-source.tsindex 9bae355e7b..7c155e5d3d 100644--- a/packages/studio-codemods/src/basic-captions-element-source.ts+++ b/packages/studio-codemods/src/basic-captions-element-source.ts@@ -1,6 +1,8 @@import {parseAst} from './sequence-props/parse-ast';-export const basicCaptionsElementSource = `import React, {forwardRef, useImperativeHandle, useMemo, useRef} from 'react';+export const basicCaptionsElementSource = `import type {Caption} from '@remotion/captions';+import {createTikTokStyleCaptions} from '@remotion/captions';+import React, {forwardRef, useImperativeHandle, useMemo, useRef} from 'react';import {Interactive,Sequence,@@ -13,15 +15,6 @@ import {type SequenceProps,} from 'remotion';-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'> & {@@ -38,45 +31,14 @@ const BasicCaptionsContent: React.FC<{}> = ({captions, playbackRate, trimBefore, combineTokensWithinMilliseconds}) => {const frame = useCurrentFrame();const {fps} = useVideoConfig();- 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 pages = useMemo(+ () =>+ createTikTokStyleCaptions({+ captions,+ combineTokensWithinMilliseconds,+ }).pages,+ [captions, combineTokensWithinMilliseconds],+ );// The Sequence frame already includes trimBefore; only elapsed frames speed up.const currentTimeMs =((trimBefore + (frame - trimBefore) * playbackRate) / fps) * 1000;@@ -109,7 +71,7 @@ const BasicCaptionsContent: React.FC<{whiteSpace: 'pre-wrap',}}>- {page.text}+ {page.text.trim()}</div>);};diff --git a/packages/studio-server/src/test/insert-basic-captions.test.ts b/packages/studio-server/src/test/insert-basic-captions.test.tsindex 0ac3542fac..ab8256dad6 100644--- a/packages/studio-server/src/test/insert-basic-captions.test.ts+++ b/packages/studio-server/src/test/insert-basic-captions.test.ts@@ -102,6 +102,9 @@ export const Comp = () => ('utf-8',),).toBe(basicCaptionsElementSource);+ expect(basicCaptionsElementSource).toContain(+ "import {createTikTokStyleCaptions} from '@remotion/captions';",+ );expect(readdirSync(remotionRoot).filter((file) => file.endsWith('.element.tsx')),).toEqual(['basic-captions.element.tsx']);diff --git a/packages/studio/src/test/caption-queue-processor.test.tsx b/packages/studio/src/test/caption-queue-processor.test.tsxindex e102045789..97c21cb1ac 100644--- a/packages/studio/src/test/caption-queue-processor.test.tsx+++ b/packages/studio/src/test/caption-queue-processor.test.tsx@@ -1,4 +1,5 @@import {afterEach, expect, mock, test} from 'bun:test';+import type {PackageInstallSpec} from '@remotion/studio-shared';import {act, cleanup, render, waitFor} from '@testing-library/react';import {type ContextType, useContext} from 'react';import {makeBrowserStudioOperations} from './make-browser-studio-operations';@@ -38,6 +39,18 @@ const resamplingCalls: Array<{audioStreamIndex: number | null;requestInit: Omit<RequestInit, 'signal'> | null;}> = [];+const packageInstallCalls: (readonly PackageInstallSpec[])[] = [];++mock.module('../api/install-package', () => ({+ installPackages: (dependencies: readonly PackageInstallSpec[]) => {+ packageInstallCalls.push(dependencies);+ return Promise.resolve({});+ },+}));++mock.module('../components/Notifications/NotificationCenter', () => ({+ showNotification: () => undefined,+}));const resampledWaveform = new Float32Array(32_000).fill(0.25);@@ -166,6 +179,7 @@ afterEach(async () => {test('downloads a model in the queued job before transcribing', async () => {disposalCalls = 0;resamplingCalls.length = 0;+ packageInstallCalls.length = 0;modelLoadCall = undefined;modelLoadProgressCallback = undefined;transcriptionCall = undefined;@@ -351,7 +365,7 @@ test('downloads a model in the queued job before transcribing', async () => {expect(disposalCalls).toBe(1);const insertedRequests: Array<{endpoint: string; body: unknown}> = [];- window.remotion_installedPackages = ['@remotion/captions'];+ window.remotion_installedPackages = [];Object.defineProperty(window, 'remotion_browserStudio', {configurable: true,value: null,@@ -435,6 +449,9 @@ test('downloads a model in the queued job before transcribing', async () => {},},]);+ expect(packageInstallCalls).toEqual([+ [{name: '@remotion/captions', version: null}],+ ]);expect(writtenFiles).toHaveLength(1);const browserRequests: unknown[] = [];