remotion 3.3.45 → 3.3.52

package/dist/esm/audio/AudioForRendering.js

@@ -0,0 +1,108 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { forwardRef, useContext, useEffect, useImperativeHandle, useLayoutEffect, useMemo, useRef, } from 'react';
+import { getAbsoluteSrc } from '../absolute-src.js';
+import { CompositionManager } from '../CompositionManager.js';
+import { continueRender, delayRender } from '../delay-render.js';
+import { useRemotionEnvironment } from '../get-environment.js';
+import { random } from '../random.js';
+import { SequenceContext } from '../Sequence.js';
+import { useTimelinePosition } from '../timeline-position-state.js';
+import { useCurrentFrame } from '../use-current-frame.js';
+import { evaluateVolume } from '../volume-prop.js';
+import { useFrameForVolumeProp } from './use-audio-frame.js';
+const AudioForRenderingRefForwardingFunction = (props, ref) => {
+    const audioRef = useRef(null);
+    const absoluteFrame = useTimelinePosition();
+    const volumePropFrame = useFrameForVolumeProp();
+    const frame = useCurrentFrame();
+    const sequenceContext = useContext(SequenceContext);
+    const { registerAsset, unregisterAsset } = useContext(CompositionManager);
+    const environment = useRemotionEnvironment();
+    // Generate a string that's as unique as possible for this asset
+    // but at the same time the same on all threads
+    const id = useMemo(() => {
+        var _a;
+        return `audio-${random((_a = props.src) !== null && _a !== void 0 ? _a : '')}-${sequenceContext === null || sequenceContext === void 0 ? void 0 : sequenceContext.relativeFrom}-${sequenceContext === null || sequenceContext === void 0 ? void 0 : sequenceContext.cumulatedFrom}-${sequenceContext === null || sequenceContext === void 0 ? void 0 : sequenceContext.durationInFrames}`;
+    }, [props.src, sequenceContext]);
+    const { volume: volumeProp, playbackRate, allowAmplificationDuringRender, onDuration, ...nativeProps } = props;
+    const volume = evaluateVolume({
+        volume: volumeProp,
+        frame: volumePropFrame,
+        mediaVolume: 1,
+        allowAmplificationDuringRender: allowAmplificationDuringRender !== null && allowAmplificationDuringRender !== void 0 ? allowAmplificationDuringRender : false,
+    });
+    useImperativeHandle(ref, () => {
+        return audioRef.current;
+    }, []);
+    useEffect(() => {
+        var _a;
+        if (!props.src) {
+            throw new Error('No src passed');
+        }
+        if (!window.remotion_audioEnabled) {
+            return;
+        }
+        if (props.muted) {
+            return;
+        }
+        if (volume <= 0) {
+            return;
+        }
+        registerAsset({
+            type: 'audio',
+            src: getAbsoluteSrc(props.src),
+            id,
+            frame: absoluteFrame,
+            volume,
+            mediaFrame: frame,
+            playbackRate: (_a = props.playbackRate) !== null && _a !== void 0 ? _a : 1,
+            allowAmplificationDuringRender: allowAmplificationDuringRender !== null && allowAmplificationDuringRender !== void 0 ? allowAmplificationDuringRender : false,
+        });
+        return () => unregisterAsset(id);
+    }, [
+        props.muted,
+        props.src,
+        registerAsset,
+        absoluteFrame,
+        id,
+        unregisterAsset,
+        volume,
+        volumePropFrame,
+        frame,
+        playbackRate,
+        props.playbackRate,
+        allowAmplificationDuringRender,
+    ]);
+    const { src } = props;
+    // If audio source switches, make new handle
+    if (environment === 'rendering') {
+        // eslint-disable-next-line react-hooks/rules-of-hooks
+        useLayoutEffect(() => {
+            if (process.env.NODE_ENV === 'test') {
+                return;
+            }
+            const newHandle = delayRender('Loading <Audio> duration with src=' + src);
+            const { current } = audioRef;
+            const didLoad = () => {
+                if (current === null || current === void 0 ? void 0 : current.duration) {
+                    onDuration(src, current.duration);
+                }
+                continueRender(newHandle);
+            };
+            if (current === null || current === void 0 ? void 0 : current.duration) {
+                onDuration(src, current.duration);
+                continueRender(newHandle);
+            }
+            else {
+                current === null || current === void 0 ? void 0 : current.addEventListener('loadedmetadata', didLoad, { once: true });
+            }
+            // If tag gets unmounted, clear pending handles because video metadata is not going to load
+            return () => {
+                current === null || current === void 0 ? void 0 : current.removeEventListener('loadedmetadata', didLoad);
+                continueRender(newHandle);
+            };
+        }, [src, onDuration]);
+    }
+    return _jsx("audio", { ref: audioRef, ...nativeProps });
+};
+export const AudioForRendering = forwardRef(AudioForRenderingRefForwardingFunction);

package/dist/esm/audio/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Audio.js';
+export * from './props.js';

package/dist/esm/audio/index.js

@@ -0,0 +1,2 @@
+export * from './Audio.js';
+export * from './props.js';

package/dist/esm/audio/props.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import type { VolumeProp } from '../volume-prop.js';
+export declare type RemotionMainAudioProps = {
+    startFrom?: number;
+    endAt?: number;
+};
+export declare type RemotionAudioProps = Omit<React.DetailedHTMLProps<React.AudioHTMLAttributes<HTMLAudioElement>, HTMLAudioElement>, 'autoPlay' | 'controls' | 'onEnded' | 'nonce' | 'onResize' | 'onResizeCapture'> & {
+    volume?: VolumeProp;
+    playbackRate?: number;
+    acceptableTimeShiftInSeconds?: number;
+    allowAmplificationDuringRender?: boolean;
+};

package/dist/esm/audio/props.js

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

package/dist/esm/audio/shared-audio-tags.d.ts

@@ -0,0 +1,37 @@
+import React from 'react';
+import type { RemotionAudioProps } from './props.js';
+/**
+ * This functionality of Remotion will keep a certain amount
+ * of <audio> tags pre-mounted and by default filled with an empty audio track.
+ * If the user interacts, the empty audio will be played.
+ * If one of Remotions <Audio /> tags get mounted, the audio will not be rendered at this location, but into one of the prerendered audio tags.
+ *
+ * This helps with autoplay issues on iOS Safari and soon other browsers,
+ * which only allow audio playback upon user interaction.
+ *
+ * The behavior can be disabled by passing `0` as the number of shared audio tracks.
+ */
+declare type AudioElem = {
+    id: number;
+    props: RemotionAudioProps;
+    el: React.RefObject<HTMLAudioElement>;
+    audioId: string;
+};
+declare type SharedContext = {
+    registerAudio: (aud: RemotionAudioProps, audioId: string) => AudioElem;
+    unregisterAudio: (id: number) => void;
+    updateAudio: (options: {
+        id: number;
+        aud: RemotionAudioProps;
+        audioId: string;
+    }) => void;
+    playAllAudios: () => void;
+    numberOfAudioTags: number;
+};
+export declare const SharedAudioContext: React.Context<SharedContext | null>;
+export declare const SharedAudioContextProvider: React.FC<{
+    numberOfAudioTags: number;
+    children: React.ReactNode;
+}>;
+export declare const useSharedAudio: (aud: RemotionAudioProps, audioId: string) => AudioElem;
+export {};

package/dist/esm/audio/shared-audio-tags.js

@@ -0,0 +1,194 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import React, { createContext, createRef, useCallback, useContext, useInsertionEffect, useLayoutEffect, useMemo, useRef, useState, } from 'react';
+const EMPTY_AUDIO = 'data:audio/mp3;base64,/+MYxAAJcAV8AAgAABn//////+/gQ5BAMA+D4Pg+BAQBAEAwD4Pg+D4EBAEAQDAPg++hYBH///hUFQVBUFREDQNHmf///////+MYxBUGkAGIMAAAAP/29Xt6lUxBTUUzLjEwMFVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVV/+MYxDUAAANIAAAAAFVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVV';
+const compareProps = (obj1, obj2) => {
+    const keysA = Object.keys(obj1).sort();
+    const keysB = Object.keys(obj2).sort();
+    if (keysA.length !== keysB.length) {
+        return false;
+    }
+    for (let i = 0; i < keysA.length; i++) {
+        // Not the same keys
+        if (keysA[i] !== keysB[i]) {
+            return false;
+        }
+        // Not the same values
+        if (obj1[keysA[i]] !== obj2[keysB[i]]) {
+            return false;
+        }
+    }
+    return true;
+};
+const didPropChange = (key, newProp, prevProp) => {
+    // /music.mp3 and http://localhost:3000/music.mp3 are the same
+    if (key === 'src' &&
+        !prevProp.startsWith('data:') &&
+        !newProp.startsWith('data:')) {
+        return (new URL(prevProp, window.location.origin).toString() !==
+            new URL(newProp, window.location.origin).toString());
+    }
+    if (prevProp === newProp) {
+        return false;
+    }
+    return true;
+};
+export const SharedAudioContext = createContext(null);
+export const SharedAudioContextProvider = ({ children, numberOfAudioTags }) => {
+    const audios = useRef([]);
+    const [initialNumberOfAudioTags] = useState(numberOfAudioTags);
+    if (numberOfAudioTags !== initialNumberOfAudioTags) {
+        throw new Error('The number of shared audio tags has changed dynamically. Once you have set this property, you cannot change it afterwards.');
+    }
+    const refs = useMemo(() => {
+        return new Array(numberOfAudioTags).fill(true).map(() => {
+            return { id: Math.random(), ref: createRef() };
+        });
+    }, [numberOfAudioTags]);
+    const takenAudios = useRef(new Array(numberOfAudioTags).fill(false));
+    const rerenderAudios = useCallback(() => {
+        refs.forEach(({ ref, id }) => {
+            var _a;
+            const data = (_a = audios.current) === null || _a === void 0 ? void 0 : _a.find((a) => a.id === id);
+            const { current } = ref;
+            if (!current) {
+                // Whole player has been unmounted, the refs don't exist anymore.
+                // It is not an error anymore though
+                return;
+            }
+            if (data === undefined) {
+                current.src = EMPTY_AUDIO;
+                return;
+            }
+            if (!data) {
+                throw new TypeError('Expected audio data to be there');
+            }
+            Object.keys(data.props).forEach((key) => {
+                // @ts-expect-error
+                if (didPropChange(key, data.props[key], current[key])) {
+                    // @ts-expect-error
+                    current[key] = data.props[key];
+                }
+            });
+        });
+    }, [refs]);
+    const registerAudio = useCallback((aud, audioId) => {
+        var _a, _b;
+        const found = (_a = audios.current) === null || _a === void 0 ? void 0 : _a.find((a) => a.audioId === audioId);
+        if (found) {
+            return found;
+        }
+        const firstFreeAudio = takenAudios.current.findIndex((a) => a === false);
+        if (firstFreeAudio === -1) {
+            throw new Error(`Tried to simultaneously mount ${numberOfAudioTags + 1} <Audio /> tags at the same time. With the current settings, the maximum amount of <Audio /> tags is limited to ${numberOfAudioTags} at the same time. Remotion pre-mounts silent audio tags to help avoid browser autoplay restrictions. See https://remotion.dev/docs/player/autoplay#use-the-numberofsharedaudiotags-property for more information on how to increase this limit.`);
+        }
+        const { id, ref } = refs[firstFreeAudio];
+        const cloned = [...takenAudios.current];
+        cloned[firstFreeAudio] = id;
+        takenAudios.current = cloned;
+        const newElem = {
+            props: aud,
+            id,
+            el: ref,
+            audioId,
+        };
+        (_b = audios.current) === null || _b === void 0 ? void 0 : _b.push(newElem);
+        rerenderAudios();
+        return newElem;
+    }, [numberOfAudioTags, refs, rerenderAudios]);
+    const unregisterAudio = useCallback((id) => {
+        var _a;
+        const cloned = [...takenAudios.current];
+        const index = refs.findIndex((r) => r.id === id);
+        if (index === -1) {
+            throw new TypeError('Error occured in ');
+        }
+        cloned[index] = false;
+        takenAudios.current = cloned;
+        audios.current = (_a = audios.current) === null || _a === void 0 ? void 0 : _a.filter((a) => a.id !== id);
+        rerenderAudios();
+    }, [refs, rerenderAudios]);
+    const updateAudio = useCallback(({ aud, audioId, id, }) => {
+        var _a;
+        let changed = false;
+        audios.current = (_a = audios.current) === null || _a === void 0 ? void 0 : _a.map((prevA) => {
+            if (prevA.id === id) {
+                const isTheSame = compareProps(aud, prevA.props);
+                if (isTheSame) {
+                    return prevA;
+                }
+                changed = true;
+                return {
+                    ...prevA,
+                    props: aud,
+                    audioId,
+                };
+            }
+            return prevA;
+        });
+        if (changed) {
+            rerenderAudios();
+        }
+    }, [rerenderAudios]);
+    const playAllAudios = useCallback(() => {
+        refs.forEach((ref) => {
+            var _a;
+            (_a = ref.ref.current) === null || _a === void 0 ? void 0 : _a.play();
+        });
+    }, [refs]);
+    const value = useMemo(() => {
+        return {
+            registerAudio,
+            unregisterAudio,
+            updateAudio,
+            playAllAudios,
+            numberOfAudioTags,
+        };
+    }, [
+        numberOfAudioTags,
+        playAllAudios,
+        registerAudio,
+        unregisterAudio,
+        updateAudio,
+    ]);
+    return (_jsxs(SharedAudioContext.Provider, { value: value, children: [refs.map(({ id, ref }) => {
+                return _jsx("audio", { ref: ref, src: EMPTY_AUDIO }, id);
+            }), children] }));
+};
+export const useSharedAudio = (aud, audioId) => {
+    const ctx = useContext(SharedAudioContext);
+    /**
+     * We work around this in React 18 so an audio tag will only register itself once
+     */
+    const [elem] = useState(() => {
+        if (ctx && ctx.numberOfAudioTags > 0) {
+            return ctx.registerAudio(aud, audioId);
+        }
+        return {
+            el: React.createRef(),
+            id: Math.random(),
+            props: aud,
+            audioId,
+        };
+    });
+    /**
+     * Effects in React 18 fire twice, and we are looking for a way to only fire it once.
+     * - useInsertionEffect only fires once. If it's available we are in React 18.
+     * - useLayoutEffect only fires once in React 17.
+     */
+    const effectToUse = useInsertionEffect !== null && useInsertionEffect !== void 0 ? useInsertionEffect : useLayoutEffect;
+    if (typeof document !== 'undefined') {
+        effectToUse(() => {
+            if (ctx && ctx.numberOfAudioTags > 0) {
+                ctx.updateAudio({ id: elem.id, aud, audioId });
+            }
+        }, [aud, ctx, elem.id, audioId]);
+        effectToUse(() => {
+            return () => {
+                if (ctx && ctx.numberOfAudioTags > 0) {
+                    ctx.unregisterAudio(elem.id);
+                }
+            };
+        }, [ctx, elem.id]);
+    }
+    return elem;
+};

package/dist/esm/audio/use-audio-frame.d.ts

@@ -0,0 +1,6 @@
+export declare const useMediaStartsAt: () => number;
+/**
+ * When passing a function as the prop for `volume`,
+ * we calculate the way more intuitive value for currentFrame
+ */
+export declare const useFrameForVolumeProp: () => number;

package/dist/esm/audio/use-audio-frame.js

@@ -0,0 +1,18 @@
+import { useContext } from 'react';
+import { SequenceContext } from '../Sequence.js';
+import { useCurrentFrame } from '../use-current-frame.js';
+export const useMediaStartsAt = () => {
+    var _a;
+    const parentSequence = useContext(SequenceContext);
+    const startsAt = Math.min(0, (_a = parentSequence === null || parentSequence === void 0 ? void 0 : parentSequence.relativeFrom) !== null && _a !== void 0 ? _a : 0);
+    return startsAt;
+};
+/**
+ * When passing a function as the prop for `volume`,
+ * we calculate the way more intuitive value for currentFrame
+ */
+export const useFrameForVolumeProp = () => {
+    const frame = useCurrentFrame();
+    const startsAt = useMediaStartsAt();
+    return frame + startsAt;
+};

package/dist/esm/bezier.d.ts

@@ -0,0 +1 @@
+export declare function bezier(mX1: number, mY1: number, mX2: number, mY2: number): (x: number) => number;

package/dist/esm/bezier.js

@@ -0,0 +1,110 @@
+// Taken from https://github.com/facebook/react-native/blob/0b9ea60b4fee8cacc36e7160e31b91fc114dbc0d/Libraries/Animated/src/bezier.js
+const NEWTON_ITERATIONS = 4;
+const NEWTON_MIN_SLOPE = 0.001;
+const SUBDIVISION_PRECISION = 0.0000001;
+const SUBDIVISION_MAX_ITERATIONS = 10;
+const kSplineTableSize = 11;
+const kSampleStepSize = 1.0 / (kSplineTableSize - 1.0);
+const float32ArraySupported = typeof Float32Array === 'function';
+function a(aA1, aA2) {
+    return 1.0 - 3.0 * aA2 + 3.0 * aA1;
+}
+function b(aA1, aA2) {
+    return 3.0 * aA2 - 6.0 * aA1;
+}
+function c(aA1) {
+    return 3.0 * aA1;
+}
+// Returns x(t) given t, x1, and x2, or y(t) given t, y1, and y2.
+function calcBezier(aT, aA1, aA2) {
+    return ((a(aA1, aA2) * aT + b(aA1, aA2)) * aT + c(aA1)) * aT;
+}
+// Returns dx/dt given t, x1, and x2, or dy/dt given t, y1, and y2.
+function getSlope(aT, aA1, aA2) {
+    return 3.0 * a(aA1, aA2) * aT * aT + 2.0 * b(aA1, aA2) * aT + c(aA1);
+}
+function binarySubdivide({ aX, _aA, _aB, mX1, mX2, }) {
+    let currentX;
+    let currentT;
+    let i = 0;
+    let aA = _aA;
+    let aB = _aB;
+    do {
+        currentT = aA + (aB - aA) / 2.0;
+        currentX = calcBezier(currentT, mX1, mX2) - aX;
+        if (currentX > 0.0) {
+            aB = currentT;
+        }
+        else {
+            aA = currentT;
+        }
+    } while (Math.abs(currentX) > SUBDIVISION_PRECISION &&
+        ++i < SUBDIVISION_MAX_ITERATIONS);
+    return currentT;
+}
+function newtonRaphsonIterate(aX, _aGuessT, mX1, mX2) {
+    let aGuessT = _aGuessT;
+    for (let i = 0; i < NEWTON_ITERATIONS; ++i) {
+        const currentSlope = getSlope(aGuessT, mX1, mX2);
+        if (currentSlope === 0.0) {
+            return aGuessT;
+        }
+        const currentX = calcBezier(aGuessT, mX1, mX2) - aX;
+        aGuessT -= currentX / currentSlope;
+    }
+    return aGuessT;
+}
+export function bezier(mX1, mY1, mX2, mY2) {
+    if (!(mX1 >= 0 && mX1 <= 1 && mX2 >= 0 && mX2 <= 1)) {
+        throw new Error('bezier x values must be in [0, 1] range');
+    }
+    // Precompute samples table
+    const sampleValues = float32ArraySupported
+        ? new Float32Array(kSplineTableSize)
+        : new Array(kSplineTableSize);
+    if (mX1 !== mY1 || mX2 !== mY2) {
+        for (let i = 0; i < kSplineTableSize; ++i) {
+            sampleValues[i] = calcBezier(i * kSampleStepSize, mX1, mX2);
+        }
+    }
+    function getTForX(aX) {
+        let intervalStart = 0.0;
+        let currentSample = 1;
+        const lastSample = kSplineTableSize - 1;
+        for (; currentSample !== lastSample && sampleValues[currentSample] <= aX; ++currentSample) {
+            intervalStart += kSampleStepSize;
+        }
+        --currentSample;
+        // Interpolate to provide an initial guess for t
+        const dist = (aX - sampleValues[currentSample]) /
+            (sampleValues[currentSample + 1] - sampleValues[currentSample]);
+        const guessForT = intervalStart + dist * kSampleStepSize;
+        const initialSlope = getSlope(guessForT, mX1, mX2);
+        if (initialSlope >= NEWTON_MIN_SLOPE) {
+            return newtonRaphsonIterate(aX, guessForT, mX1, mX2);
+        }
+        if (initialSlope === 0.0) {
+            return guessForT;
+        }
+        return binarySubdivide({
+            aX,
+            _aA: intervalStart,
+            _aB: intervalStart + kSampleStepSize,
+            mX1,
+            mX2,
+        });
+    }
+    return function (x) {
+        if (mX1 === mY1 && mX2 === mY2) {
+            return x; // linear
+        }
+        // Because JavaScript number are imprecise, we should guarantee the extremes are right.
+        if (x === 0) {
+            return 0;
+        }
+        if (x === 1) {
+            return 1;
+        }
+        return calcBezier(getTForX(x), mY1, mY2);
+    };
+}

package/dist/esm/cancel-render.d.ts

@@ -0,0 +1 @@
+export declare function cancelRender(err: unknown): never;

package/dist/esm/cancel-render.js

@@ -0,0 +1,39 @@
+const isErrorLike = (err) => {
+    if (err === null) {
+        return false;
+    }
+    if (typeof err !== 'object') {
+        return false;
+    }
+    if (!('stack' in err)) {
+        return false;
+    }
+    // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error
+    // @ts-ignore we just asserted
+    if (typeof err.stack !== 'string') {
+        return false;
+    }
+    if (!('message' in err)) {
+        return false;
+    }
+    // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error
+    // @ts-ignore we just asserted
+    if (typeof err.message !== 'string') {
+        return false;
+    }
+    return true;
+};
+export function cancelRender(err) {
+    let error;
+    if (isErrorLike(err)) {
+        error = err;
+    }
+    else if (typeof err === 'string') {
+        error = Error(err);
+    }
+    else {
+        error = Error('Rendering was cancelled');
+    }
+    window.remotion_cancelledError = error.stack;
+    throw error;
+}

package/dist/esm/config/input-props.d.ts

@@ -0,0 +1 @@
+export declare const getInputProps: () => any;

package/dist/esm/config/input-props.js

@@ -0,0 +1,27 @@
+import { getRemotionEnvironment } from '../get-environment.js';
+let didWarnSSRImport = false;
+const warnOnceSSRImport = () => {
+    if (didWarnSSRImport) {
+        return;
+    }
+    didWarnSSRImport = true;
+    console.warn('Called `getInputProps()` on the server. This function is not available server-side and has returned an empty object.');
+    console.warn("To hide this warning, don't call this function on the server:");
+    console.warn("  typeof window === 'undefined' ? {} : getInputProps()");
+};
+export const getInputProps = () => {
+    if (typeof window === 'undefined') {
+        warnOnceSSRImport();
+        return {};
+    }
+    if (getRemotionEnvironment() === 'player-development' ||
+        getRemotionEnvironment() === 'player-production') {
+        throw new Error('You cannot call `getInputProps()` from a <Player>. Instead, the props are available as React props from component that you passed as `component` prop.');
+    }
+    const param = window.remotion_inputProps;
+    if (!param) {
+        return {};
+    }
+    const parsed = JSON.parse(param);
+    return parsed;
+};