@remotion/captions 4.0.216

package/LICENSE.md

@@ -0,0 +1,49 @@
+# Remotion License
+
+In Remotion 5.0, the license will slightly change. [View the changes here](https://github.com/remotion-dev/remotion/pull/3750).
+
+---
+
+Depending on the type of your legal entity, you are granted permission to use Remotion for your project. Individuals and small companies are allowed to use Remotion to create videos for free (even commercial), while a company license is required for for-profit organizations of a certain size. This two-tier system was designed to ensure funding for this project while still allowing the source code to be available and the program to be free for most. Read below for the exact terms of use.
+
+- [Free license](#free-license)
+- [Company license](#company-license)
+
+## Free license
+
+Copyright © 2024 [Remotion](https://www.remotion.dev)
+
+### Eligibility
+
+You are eligible to use Remotion for free if you are:
+
+- an individual
+- a for-profit organization with up to 3 employees
+- a non-profit or not-for-profit organization
+- evaluating whether Remotion is a good fit, and are not yet using it in a commercial way
+
+### Allowed use cases
+
+Permission is hereby granted, free of charge, to any person eligible for the "Free license", to use the software non-commercially or commercially for the purpose of creating videos and images and to modify the software to their own liking, for the purpose of fulfilling their custom use case or to contribute bug fixes or improvements back to Remotion.
+
+### Disallowed use cases
+
+It is not allowed to copy or modify Remotion code for the purpose of selling, renting, licensing, relicensing, or sublicensing your own derivate of Remotion.
+
+### Warranty notice
+
+The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall the author or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.
+
+### Support
+
+Support is provided on a best-we-can-do basis via GitHub Issues and Discord.
+
+## Company license
+
+You are required to obtain a company license to use Remotion if you are not within the group of entities eligible for a free license. This license will enable you to use Remotion for the allowed use cases specified in the free license, and give you access to prioritized support (read the [Support Policy](https://www.remotion.dev/docs/support)).
+
+Visit [remotion.pro](https://www.remotion.pro/license) for pricing and to buy a license.
+
+### FAQs
+
+Are you not sure whether you need a company license because of an edge case? Here are some [frequently asked questions](https://www.remotion.pro/faq).

package/README.md

@@ -0,0 +1,18 @@
+# @remotion/captions
+ 
+Primitives for dealing with captions
+ 
+[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/captions.svg?style=flat&color=black&label=Downloads)](https://npmcharts.com/compare/@remotion/captions?minimal=true)
+ 
+## Installation
+ 
+```bash
+npm install @remotion/captions --save-exact
+```
+ 
+When installing a Remotion package, make sure to align the version of all `remotion` and `@remotion/*` packages to the same version.
+Remove the `^` character from the version number to use the exact version.
+ 
+## Usage
+ 
+See the [documentation](https://remotion.dev/docs/captions) for more information.

package/dist/caption.d.ts

@@ -0,0 +1,7 @@
+export type Caption = {
+    text: string;
+    startMs: number;
+    endMs: number;
+    timestampMs: number | null;
+    confidence: number | null;
+};

package/dist/caption.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/create-tiktok-style-captions.d.ts

@@ -0,0 +1,19 @@
+import type { Caption } from './caption';
+export type TikTokToken = {
+    text: string;
+    fromMs: number;
+    toMs: number;
+};
+export type TikTokPage = {
+    text: string;
+    startMs: number;
+    tokens: TikTokToken[];
+};
+export type CreateTikTokStyleCaptionsInput = {
+    captions: Caption[];
+    combineTokensWithinMilliseconds: number;
+};
+export type CreateTikTokStyleCaptionsOutput = {
+    pages: TikTokPage[];
+};
+export declare function createTikTokStyleCaptions({ captions, combineTokensWithinMilliseconds, }: CreateTikTokStyleCaptionsInput): CreateTikTokStyleCaptionsOutput;

package/dist/create-tiktok-style-captions.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTikTokStyleCaptions = createTikTokStyleCaptions;
+function createTikTokStyleCaptions({ captions, combineTokensWithinMilliseconds, }) {
+    const tikTokStyleCaptions = [];
+    let currentText = '';
+    let currentTokens = [];
+    let currentFrom = 0;
+    let currentTo = 0;
+    captions.forEach((item, index) => {
+        const { text } = item;
+        // If text starts with a space, push the currentText (if it exists) and start a new one
+        if (text.startsWith(' ') &&
+            currentTo - currentFrom > combineTokensWithinMilliseconds) {
+            if (currentText !== '') {
+                tikTokStyleCaptions.push({
+                    text: currentText.trimStart(),
+                    startMs: currentFrom,
+                    tokens: currentTokens,
+                });
+            }
+            // Start a new sentence
+            currentText = text.trimStart();
+            currentTokens = [
+                { text: currentText, fromMs: item.startMs, toMs: item.endMs },
+            ].filter((t) => t.text !== '');
+            currentFrom = item.startMs;
+            currentTo = item.endMs;
+        }
+        else {
+            // Continuation or start of a new sentence without leading space
+            if (currentText === '') {
+                // It's the start of the document or after a sentence that started with a space
+                currentFrom = item.startMs;
+            }
+            currentText += text;
+            currentText = currentText.trimStart();
+            if (text.trim() !== '') {
+                currentTokens.push({
+                    text: currentTokens.length === 0 ? currentText.trimStart() : text,
+                    fromMs: item.startMs,
+                    toMs: item.endMs,
+                });
+            }
+            currentTo = item.endMs;
+        }
+        // Ensure the last sentence is added
+        if (index === captions.length - 1 && currentText !== '') {
+            tikTokStyleCaptions.push({
+                text: currentText,
+                startMs: currentFrom,
+                tokens: currentTokens,
+            });
+        }
+    });
+    return { pages: tikTokStyleCaptions };
+}

package/dist/ensure-max-characters-per-line.d.ts

@@ -0,0 +1,9 @@
+import type { Caption } from './caption';
+export type EnsureMaxCharactersPerLineInput = {
+    captions: Caption[];
+    maxCharsPerLine: number;
+};
+export type EnsureMaxCharactersPerLineOutput = {
+    segments: Caption[][];
+};
+export declare const ensureMaxCharactersPerLine: ({ captions, maxCharsPerLine, }: EnsureMaxCharactersPerLineInput) => EnsureMaxCharactersPerLineOutput;

package/dist/ensure-max-characters-per-line.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureMaxCharactersPerLine = void 0;
+const splitWords = (inputCaptions) => {
+    const captions = [];
+    for (let i = 0; i < inputCaptions.length; i++) {
+        const w = inputCaptions[i];
+        const words = w.text.split(' ');
+        for (let j = 0; j < words.length; j++) {
+            const word = words[j];
+            captions.push({
+                text: j === 0 ? ` ${word}` : word,
+                startMs: w.startMs,
+                endMs: w.endMs,
+                confidence: w.confidence,
+                timestampMs: w.timestampMs,
+            });
+        }
+    }
+    return captions;
+};
+const ensureMaxCharactersPerLine = ({ captions, maxCharsPerLine, }) => {
+    const splitted = splitWords(captions);
+    const segments = [];
+    let currentSegment = [];
+    for (let i = 0; i < splitted.length; i++) {
+        const w = splitted[i];
+        const remainingWords = splitted.slice(i + 1);
+        const filledCharactersInLine = currentSegment
+            .map((s) => s.text.length)
+            .reduce((a, b) => a + b, 0);
+        const preventOrphanWord = remainingWords.length < 4 &&
+            remainingWords.length > 1 &&
+            filledCharactersInLine > maxCharsPerLine / 2;
+        if (filledCharactersInLine + w.text.length > maxCharsPerLine ||
+            preventOrphanWord) {
+            segments.push(currentSegment);
+            currentSegment = [];
+        }
+        currentSegment.push(w);
+    }
+    segments.push(currentSegment);
+    return { segments };
+};
+exports.ensureMaxCharactersPerLine = ensureMaxCharactersPerLine;

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export { Caption } from './caption';
+export { createTikTokStyleCaptions, CreateTikTokStyleCaptionsInput, CreateTikTokStyleCaptionsOutput, TikTokPage, TikTokToken, } from './create-tiktok-style-captions';
+export { EnsureMaxCharactersPerLineInput, EnsureMaxCharactersPerLineOutput, } from './ensure-max-characters-per-line';
+export { parseSrt, ParseSrtInput, ParseSrtOutput } from './parse-srt';
+export { serializeSrt, SerializeSrtInput } from './serialize-srt';
+export declare const CaptionsInternals: {
+    ensureMaxCharactersPerLine: ({ captions, maxCharsPerLine, }: import("./ensure-max-characters-per-line").EnsureMaxCharactersPerLineInput) => import("./ensure-max-characters-per-line").EnsureMaxCharactersPerLineOutput;
+};

package/dist/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CaptionsInternals = exports.serializeSrt = exports.parseSrt = exports.createTikTokStyleCaptions = void 0;
+const ensure_max_characters_per_line_1 = require("./ensure-max-characters-per-line");
+var create_tiktok_style_captions_1 = require("./create-tiktok-style-captions");
+Object.defineProperty(exports, "createTikTokStyleCaptions", { enumerable: true, get: function () { return create_tiktok_style_captions_1.createTikTokStyleCaptions; } });
+var parse_srt_1 = require("./parse-srt");
+Object.defineProperty(exports, "parseSrt", { enumerable: true, get: function () { return parse_srt_1.parseSrt; } });
+var serialize_srt_1 = require("./serialize-srt");
+Object.defineProperty(exports, "serializeSrt", { enumerable: true, get: function () { return serialize_srt_1.serializeSrt; } });
+exports.CaptionsInternals = {
+    ensureMaxCharactersPerLine: ensure_max_characters_per_line_1.ensureMaxCharactersPerLine,
+};

package/dist/parse-srt.d.ts

@@ -0,0 +1,8 @@
+import type { Caption } from './caption';
+export type ParseSrtInput = {
+    input: string;
+};
+export type ParseSrtOutput = {
+    captions: Caption[];
+};
+export declare const parseSrt: ({ input }: ParseSrtInput) => ParseSrtOutput;

package/dist/parse-srt.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseSrt = void 0;
+function toSeconds(time) {
+    const [first, second, third] = time.split(':');
+    if (!first) {
+        throw new Error(`Invalid timestamp:${time}`);
+    }
+    if (!second) {
+        throw new Error(`Invalid timestamp:${time}`);
+    }
+    if (!third) {
+        throw new Error(`Invalid timestamp:${time}`);
+    }
+    const [seconds, millis] = third.split(',');
+    if (!seconds) {
+        throw new Error(`Invalid timestamp:${time}`);
+    }
+    if (!millis) {
+        throw new Error(`Invalid timestamp:${time}`);
+    }
+    return (parseInt(first, 10) * 3600 +
+        parseInt(second, 10) * 60 +
+        parseInt(seconds, 10) +
+        parseInt(millis, 10) / 1000);
+}
+const parseSrt = ({ input }) => {
+    const inputLines = input.split('\n');
+    const captions = [];
+    for (let i = 0; i < inputLines.length; i++) {
+        const line = inputLines[i];
+        const nextLine = inputLines[i + 1];
+        if ((line === null || line === void 0 ? void 0 : line.match(/([0-9]+)/)) && (nextLine === null || nextLine === void 0 ? void 0 : nextLine.includes(' --> '))) {
+            const nextLineSplit = nextLine.split(' --> ');
+            const start = toSeconds(nextLineSplit[0]);
+            const end = toSeconds(nextLineSplit[1]);
+            captions.push({
+                text: '',
+                startMs: start * 1000,
+                endMs: end * 1000,
+                confidence: 1,
+                timestampMs: ((start + end) / 2) * 1000,
+            });
+        }
+        else if (line === null || line === void 0 ? void 0 : line.includes(' --> ')) {
+            continue;
+        }
+        else if ((line === null || line === void 0 ? void 0 : line.trim()) === '') {
+            captions[captions.length - 1].text = captions[captions.length - 1].text.trim();
+        }
+        else {
+            captions[captions.length - 1].text += line + '\n';
+        }
+    }
+    return {
+        captions: captions.map((l) => {
+            return {
+                ...l,
+                text: l.text.trimEnd(),
+            };
+        }),
+    };
+};
+exports.parseSrt = parseSrt;

package/dist/serialize-srt.d.ts

@@ -0,0 +1,5 @@
+import type { Caption } from './caption';
+export type SerializeSrtInput = {
+    lines: Caption[][];
+};
+export declare const serializeSrt: ({ lines }: SerializeSrtInput) => string;

package/dist/serialize-srt.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeSrt = void 0;
+const formatSingleSrtTimestamp = (timestamp) => {
+    const hours = Math.floor(timestamp / 3600000);
+    const minutes = Math.floor((timestamp % 3600000) / 60000);
+    const seconds = Math.floor((timestamp % 60000) / 1000);
+    const milliseconds = Math.floor(timestamp % 1000);
+    return `${String(hours).padStart(2, '0')}:${String(minutes).padStart(2, '0')}:${String(seconds).padStart(2, '0')},${String(milliseconds).padStart(3, '0')}`;
+};
+const formatSrtTimestamp = (startMs, endMs) => {
+    return `${formatSingleSrtTimestamp(startMs)} --> ${formatSingleSrtTimestamp(endMs)}`;
+};
+const serializeSrt = ({ lines }) => {
+    let currentIndex = 0;
+    return lines
+        .map((s) => {
+        currentIndex++;
+        if (s.length === 0) {
+            return null;
+        }
+        const firstTimestamp = s[0].startMs;
+        const lastTimestamp = s[s.length - 1].endMs;
+        return [
+            // Index
+            currentIndex,
+            formatSrtTimestamp(firstTimestamp, lastTimestamp),
+            // Text
+            s.map((caption) => caption.text).join(''),
+        ].join('\n');
+    })
+        .filter(Boolean)
+        .join('\n\n');
+};
+exports.serializeSrt = serializeSrt;

package/dist/test/ensure-max-characters.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/ensure-max-characters.test.js

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const bun_test_1 = require("bun:test");
+const ensure_max_characters_per_line_1 = require("../ensure-max-characters-per-line");
+(0, bun_test_1.test)('Ensure max characters per line', () => {
+    const captions = [
+        {
+            confidence: 1,
+            endMs: 6000,
+            startMs: 3000,
+            text: 'This is a demonstration of SRT subtitles.',
+            timestampMs: 4500,
+        },
+        {
+            confidence: 1,
+            endMs: 10500,
+            startMs: 7000,
+            text: 'You can use SRT files to add subtitles to your videos.',
+            timestampMs: 8750,
+        },
+    ];
+    // TODO: This creates captions that are not nice!
+    (0, bun_test_1.expect)((0, ensure_max_characters_per_line_1.ensureMaxCharactersPerLine)({ captions, maxCharsPerLine: 42 })).toEqual({
+        segments: [
+            [
+                {
+                    text: ' This',
+                    startMs: 3000,
+                    endMs: 6000,
+                    confidence: 1,
+                    timestampMs: 4500,
+                },
+                {
+                    text: 'is',
+                    startMs: 3000,
+                    endMs: 6000,
+                    confidence: 1,
+                    timestampMs: 4500,
+                },
+                {
+                    text: 'a',
+                    startMs: 3000,
+                    endMs: 6000,
+                    confidence: 1,
+                    timestampMs: 4500,
+                },
+                {
+                    text: 'demonstration',
+                    startMs: 3000,
+                    endMs: 6000,
+                    confidence: 1,
+                    timestampMs: 4500,
+                },
+                {
+                    text: 'of',
+                    startMs: 3000,
+                    endMs: 6000,
+                    confidence: 1,
+                    timestampMs: 4500,
+                },
+                {
+                    text: 'SRT',
+                    startMs: 3000,
+                    endMs: 6000,
+                    confidence: 1,
+                    timestampMs: 4500,
+                },
+                {
+                    text: 'subtitles.',
+                    startMs: 3000,
+                    endMs: 6000,
+                    confidence: 1,
+                    timestampMs: 4500,
+                },
+                {
+                    text: ' You',
+                    startMs: 7000,
+                    endMs: 10500,
+                    confidence: 1,
+                    timestampMs: 8750,
+                },
+            ],
+            [
+                {
+                    text: 'can',
+                    startMs: 7000,
+                    endMs: 10500,
+                    confidence: 1,
+                    timestampMs: 8750,
+                },
+                {
+                    text: 'use',
+                    startMs: 7000,
+                    endMs: 10500,
+                    confidence: 1,
+                    timestampMs: 8750,
+                },
+                {
+                    text: 'SRT',
+                    startMs: 7000,
+                    endMs: 10500,
+                    confidence: 1,
+                    timestampMs: 8750,
+                },
+                {
+                    text: 'files',
+                    startMs: 7000,
+                    endMs: 10500,
+                    confidence: 1,
+                    timestampMs: 8750,
+                },
+                {
+                    text: 'to',
+                    startMs: 7000,
+                    endMs: 10500,
+                    confidence: 1,
+                    timestampMs: 8750,
+                },
+                {
+                    text: 'add',
+                    startMs: 7000,
+                    endMs: 10500,
+                    confidence: 1,
+                    timestampMs: 8750,
+                },
+                {
+                    text: 'subtitles',
+                    startMs: 7000,
+                    endMs: 10500,
+                    confidence: 1,
+                    timestampMs: 8750,
+                },
+            ],
+            [
+                {
+                    text: 'to',
+                    startMs: 7000,
+                    endMs: 10500,
+                    confidence: 1,
+                    timestampMs: 8750,
+                },
+                {
+                    text: 'your',
+                    startMs: 7000,
+                    endMs: 10500,
+                    confidence: 1,
+                    timestampMs: 8750,
+                },
+                {
+                    text: 'videos.',
+                    startMs: 7000,
+                    endMs: 10500,
+                    confidence: 1,
+                    timestampMs: 8750,
+                },
+            ],
+        ],
+    });
+});

package/dist/test/srt.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/srt.test.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const bun_test_1 = require("bun:test");
+const parse_srt_1 = require("../parse-srt");
+const serialize_srt_1 = require("../serialize-srt");
+const input = `
+1
+00:00:00,000 --> 00:00:02,500
+Welcome to the Example Subtitle File!
+
+2
+00:00:03,000 --> 00:00:06,000
+This is a demonstration of SRT subtitles.
+
+3
+00:00:07,000 --> 00:00:10,500
+You can use SRT files to add subtitles to your videos.
+
+`.trim();
+(0, bun_test_1.test)('Should create captions', () => {
+    const { captions } = (0, parse_srt_1.parseSrt)({ input });
+    (0, bun_test_1.expect)(captions).toEqual([
+        {
+            confidence: 1,
+            endMs: 2500,
+            startMs: 0,
+            text: 'Welcome to the Example Subtitle File!',
+            timestampMs: 1250,
+        },
+        {
+            confidence: 1,
+            endMs: 6000,
+            startMs: 3000,
+            text: 'This is a demonstration of SRT subtitles.',
+            timestampMs: 4500,
+        },
+        {
+            confidence: 1,
+            endMs: 10500,
+            startMs: 7000,
+            text: 'You can use SRT files to add subtitles to your videos.',
+            timestampMs: 8750,
+        },
+    ]);
+    const serialized = (0, serialize_srt_1.serializeSrt)({ lines: captions.map((c) => [c]) });
+    (0, bun_test_1.expect)(serialized).toEqual(input);
+});

package/dist/test/tiktok.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/tiktok.test.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const bun_test_1 = require("bun:test");
+const create_tiktok_style_captions_1 = require("../create-tiktok-style-captions");
+const captions = [
+    {
+        text: 'Using',
+        startMs: 40,
+        endMs: 300,
+        timestampMs: 200,
+        confidence: 0.948258,
+    },
+    {
+        text: " Remotion's",
+        startMs: 300,
+        endMs: 900,
+        timestampMs: 440,
+        confidence: 0.548411,
+    },
+    {
+        text: ' TikTok',
+        startMs: 900,
+        endMs: 1260,
+        timestampMs: 1080,
+        confidence: 0.953265,
+    },
+    {
+        text: ' template,',
+        startMs: 1260,
+        endMs: 1950,
+        timestampMs: 1600,
+        confidence: 0.968126,
+    },
+];
+(0, bun_test_1.test)('Should create captions', () => {
+    const { pages: tikTokStyleCaptions } = (0, create_tiktok_style_captions_1.createTikTokStyleCaptions)({
+        captions,
+        combineTokensWithinMilliseconds: 500,
+    });
+    (0, bun_test_1.expect)(tikTokStyleCaptions).toEqual([
+        {
+            text: "Using Remotion's",
+            startMs: 40,
+            tokens: [
+                {
+                    text: 'Using',
+                    fromMs: 40,
+                    toMs: 300,
+                },
+                {
+                    text: " Remotion's",
+                    fromMs: 300,
+                    toMs: 900,
+                },
+            ],
+        },
+        {
+            text: 'TikTok template,',
+            startMs: 900,
+            tokens: [
+                {
+                    text: 'TikTok',
+                    fromMs: 900,
+                    toMs: 1260,
+                },
+                {
+                    text: ' template,',
+                    fromMs: 1260,
+                    toMs: 1950,
+                },
+            ],
+        },
+    ]);
+});

package/package.json

@@ -0,0 +1,33 @@
+{
+  "repository": {
+    "url": "https://github.com/remotion-dev/remotion/tree/main/packages/captions"
+  },
+  "name": "@remotion/captions",
+  "version": "4.0.216",
+  "description": "Primitives for dealing with captions",
+  "main": "dist/index.js",
+  "sideEffects": false,
+  "bugs": {
+    "url": "https://github.com/remotion-dev/remotion/issues"
+  },
+  "files": [
+    "dist"
+  ],
+  "author": "Jonny Burger <jonny@remotion.dev>",
+  "license": "MIT",
+  "dependencies": {},
+  "peerDependencies": {},
+  "devDependencies": {},
+  "keywords": [
+    "remotion"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://remotion.dev/docs/captions",
+  "scripts": {
+    "formatting": "prettier src --check",
+    "lint": "eslint src --ext ts,tsx",
+    "test": "bun test src"
+  }
+}