remotion 4.0.0-offthread.9 → 4.0.0-prefetch.10

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
-remotion:build: cache hit, replaying output 5b5753c06aaad965
-remotion:build: 
-remotion:build: > remotion@3.0.16 build /Users/jonathanburger/remotion/packages/core
-remotion:build: > tsc -d
-remotion:build: 
+remotion:build: cache hit, replaying output a583398c93291d66
+remotion:build: 
+remotion:build: > remotion@3.2.16 build /Users/jonathanburger/remotion/packages/core
+remotion:build: > tsc -d
+remotion:build: 

package/README.md

@@ -1,15 +1,19 @@
 <p align="center">
   <a href="https://github.com/remotion-dev/logo">
-    <img src="https://github.com/remotion-dev/logo/raw/main/withtitle/element-0.png">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://github.com/remotion-dev/logo/raw/main/animated-logo-banner-dark.gif">
+      <img alt="Animated Remotion Logo" src="https://github.com/remotion-dev/logo/raw/main/animated-logo-banner-light.gif">
+    </picture>
   </a>
 </p>
 
-[![Discord Shield](https://discordapp.com/api/guilds/809501355504959528/widget.png?style=shield)](https://discord.gg/6VzzNDwUwV)
-[![NPM Version](http://img.shields.io/npm/v/remotion.svg?style=flat)](https://www.npmjs.org/package/remotion)
+[![Discord Shield](https://discordapp.com/api/guilds/809501355504959528/widget.png?style=shield)](https://remotion.dev/discord)
+[![NPM Version](https://img.shields.io/npm/v/remotion.svg?style=flat)](https://www.npmjs.org/package/remotion)
 [![NPM Downloads](https://img.shields.io/npm/dm/remotion.svg?style=flat)](https://npmcharts.com/compare/remotion?minimal=true)
 [![Install Size](https://packagephobia.now.sh/badge?p=remotion)](https://packagephobia.now.sh/result?p=remotion)
+<a href="https://twitter.com/remotion_dev"><img src="https://img.shields.io/twitter/follow/remotion_dev?label=Twitter&style=social" alt="Twitter"></a>
 
-Remotion is a suite of libraries building a foundation for **creating videos programmatically using React.**
+Remotion is a framework for **creating videos programmatically using React.**
 
 ## Why create videos in React?
 
@@ -17,35 +21,42 @@ Remotion is a suite of libraries building a foundation for **creating videos pro
 - **Leverage programming**: Use variables, functions, APIs, math and algorithms to create new effects
 - **Leverage React**: Reusable components, Powerful composition, Fast Refresh, Package ecosystem
 
-## Example videos
-
-- **Remotion Trailer** [Watch](https://www.youtube.com/watch?v=gwlDorikqgY) • [Source code](https://github.com/remotion-dev/trailer) • The announcement video for Remotion was written in Remotion itself!
-- **AnySticker Welcome Video** [Watch](https://www.youtube.com/watch?v=Y0SNPeTz09w) • [Source code](https://github.com/JonnyBurger/anysticker-tutorials) • An in-app explainer video for my app AnySticker.
-- **Spotify Wrapped Recreated** [Watch](https://twitter.com/JNYBGR/status/1360269270526136320) • [Tutorial](https://www.youtube.com/watch?v=I-y_5H9-3gk) • [Source code](https://github.com/JonnyBurger/remotion-wrapped) • A recreation of Spotify Wrapped where you can override all text and images via command line.
-- **"Game changer or no game changer" intro** [Watch](https://youtu.be/ga_xAZo9m7k?t=61) • [Source code](https://github.com/JonnyBurger/gamechanger-or-no-gamechanger-intro) • An intro for a quiz show I did with William Candillon.
-- **"The X in MDX" talk** [Watch](https://twitter.com/pomber/status/1359556846688886789) • [Source code](https://github.com/pomber/record-talk-with-remotion) • A re-recording of [this talk](https://www.youtube.com/watch?v=xEu3t-KJVVg) using Remotion.
-- **Redesigning the Scatterplot** [Watch](https://twitter.com/BrooksLybrand/status/1371547875109445635) • [Source code](https://github.com/brookslybrand/redesigning-scatterplots) • An animated section of Edward R. Tufte's book [The Visual Display of Quantitative Information](https://www.amazon.com/Visual-Display-Quantitative-Information/dp/0961392142/ref=sr_1_1?crid=3HQZSBUUROV09&dchild=1&keywords=the+visual+display+of+quantitative+information&qid=1615907320&sprefix=the+visual+disp%2Caps%2C190&sr=8-1).
-- **News Podcast Maker** [Watch](https://www.youtube.com/watch?v=Mwo5iNlWryg) • [Source code](https://github.com/FelippeChemello/podcast-maker/) • A fully automated News Podcast Maker.
-
-Feel free to pull request your creations!
+## Created with Remotion
+
+<table>
+<tr>
+<td align="center">
+<img style="width: 290px" src="packages/docs/static/img/fireship-quick.gif" />
+<p>"This video was made with code" <em>- Fireship</em> <a href="https://youtu.be/deg8bOoziaE">Watch</a> • <a href="https://github.com/wcandillon/remotion-fireship">Source</a></p>
+</td>
+<td align="center">
+<img style="width: 240px" src="packages/docs/static/img/github-unwrapped.gif" />
+<p>GitHub Unwrapped - Personalized year in Review <a href="https://githubunwrapped.com">Try</a> • <a href="https://github.com/remotion-dev/github-unwrapped">Source</a></p>
+</td>
+<td align="center">
+<em>View more in the <a href="https://remotion.dev/showcase">Remotion Showcase</a>!</em>
+</td>
+</tr>
+</table>
 
 ## Get started
 
-If you already have Yarn and FFMPEG installed, type
+If you already have Node.JS installed, type
 
 ```console
-yarn create video
+npm init video
 ```
 
 to get started. Otherwise, read the [installation page](https://www.remotion.dev/docs/) in the documentation.
 
 ## Documentation
 
-Head to [**remotion.dev**](https://www.remotion.dev) to learn the in and outs of Remotion!
+Documentation: [**remotion.dev/docs**](https://www.remotion.dev/docs)  
+API Reference: [**remotion.dev/api**](https://www.remotion.dev/api)
 
 ## License
 
-Be aware of that Remotion has a special license and requires obtaining a company license in some cases. Read the [LICENSE](LICENSE.md) documentation for more information.
+Be aware of that Remotion has a special license and requires obtaining a company license in some cases. Read the [LICENSE](LICENSE.md) page for more information.
 
 ## Contributing
 

package/dist/AbsoluteFill.d.ts

@@ -1,2 +1,6 @@
-import React, { HTMLAttributes } from 'react';
-export declare const AbsoluteFill: React.FC<HTMLAttributes<HTMLDivElement>>;
+import React from 'react';
+/**
+ * An absolutely positioned <div> element with 100% width, height, and a column flex style
+ * @link https://www.remotion.dev/docs/absolute-fill
+ */
+export declare const AbsoluteFill: React.ForwardRefExoticComponent<Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "key" | keyof React.HTMLAttributes<HTMLDivElement>> & React.RefAttributes<HTMLDivElement>>;

package/dist/AbsoluteFill.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AbsoluteFill = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 const react_1 = require("react");
-const AbsoluteFill = (props) => {
+const AbsoluteFillRefForwarding = (props, ref) => {
     const { style, ...other } = props;
     const actualStyle = (0, react_1.useMemo)(() => {
         return {
@@ -19,6 +19,10 @@ const AbsoluteFill = (props) => {
             ...style,
         };
     }, [style]);
-    return (0, jsx_runtime_1.jsx)("div", { style: actualStyle, ...other });
+    return (0, jsx_runtime_1.jsx)("div", { ref: ref, style: actualStyle, ...other });
 };
-exports.AbsoluteFill = AbsoluteFill;
+/**
+ * An absolutely positioned <div> element with 100% width, height, and a column flex style
+ * @link https://www.remotion.dev/docs/absolute-fill
+ */
+exports.AbsoluteFill = (0, react_1.forwardRef)(AbsoluteFillRefForwarding);

package/dist/CanUseRemotionHooks.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+export declare const CanUseRemotionHooks: React.Context<boolean>;
+export declare const CanUseRemotionHooksProvider: React.FC<{
+    children: React.ReactNode;
+}>;

package/dist/CanUseRemotionHooks.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CanUseRemotionHooksProvider = exports.CanUseRemotionHooks = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+exports.CanUseRemotionHooks = (0, react_1.createContext)(false);
+const CanUseRemotionHooksProvider = ({ children }) => {
+    return ((0, jsx_runtime_1.jsx)(exports.CanUseRemotionHooks.Provider, { value: true, children: children }));
+};
+exports.CanUseRemotionHooksProvider = CanUseRemotionHooksProvider;

package/dist/Composition.d.ts

@@ -1,8 +1,5 @@
-import React, { ComponentType, FC } from 'react';
-export declare const Folder: FC<{
-    name: string;
-    children: React.ReactNode;
-}>;
+import type { ComponentType } from 'react';
+import React from 'react';
 declare type LooseComponentType<T> = ComponentType<T> | ((props: T) => React.ReactNode);
 export declare type CompProps<T> = {
     lazyComponent: () => Promise<{
@@ -21,5 +18,5 @@ declare type CompositionProps<T> = StillProps<T> & {
     fps: number;
     durationInFrames: number;
 };
-export declare const Composition: <T>({ width, height, fps, durationInFrames, id, defaultProps, ...compProps }: CompositionProps<T>) => null;
+export declare const Composition: <T>({ width, height, fps, durationInFrames, id, defaultProps, ...compProps }: CompositionProps<T>) => React.ReactPortal | null;
 export {};

package/dist/Composition.js

@@ -1,47 +1,45 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Composition = exports.Folder = void 0;
+exports.Composition = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 const react_1 = require("react");
+const react_dom_1 = require("react-dom");
+const CanUseRemotionHooks_1 = require("./CanUseRemotionHooks");
 const CompositionManager_1 = require("./CompositionManager");
+const input_props_1 = require("./config/input-props");
+const delay_render_1 = require("./delay-render");
+const Folder_1 = require("./Folder");
+const get_environment_1 = require("./get-environment");
+const internals_1 = require("./internals");
+const loading_indicator_1 = require("./loading-indicator");
 const nonce_1 = require("./nonce");
-const truthy_1 = require("./truthy");
+const portal_node_1 = require("./portal-node");
 const use_lazy_component_1 = require("./use-lazy-component");
+const use_video_1 = require("./use-video");
 const validate_composition_id_1 = require("./validation/validate-composition-id");
 const validate_dimensions_1 = require("./validation/validate-dimensions");
 const validate_duration_in_frames_1 = require("./validation/validate-duration-in-frames");
-const validate_folder_name_1 = require("./validation/validate-folder-name");
 const validate_fps_1 = require("./validation/validate-fps");
-const FolderContext = (0, react_1.createContext)({
-    folderName: null,
-    parentName: null,
-});
-const Folder = ({ name, children, }) => {
-    const parent = (0, react_1.useContext)(FolderContext);
-    const { registerFolder, unregisterFolder } = (0, react_1.useContext)(CompositionManager_1.CompositionManager);
-    (0, validate_folder_name_1.validateFolderName)(name);
-    const parentNameArr = [parent.parentName, parent.folderName].filter(truthy_1.truthy);
-    const parentName = parentNameArr.length === 0 ? null : parentNameArr.join('/');
-    const value = (0, react_1.useMemo)(() => {
-        return {
-            folderName: name,
-            parentName,
-        };
-    }, [name, parentName]);
+const Fallback = () => {
     (0, react_1.useEffect)(() => {
-        registerFolder(name, parentName);
-        return () => {
-            unregisterFolder(name, parentName);
-        };
-    }, [name, parent.folderName, parentName, registerFolder, unregisterFolder]);
-    return ((0, jsx_runtime_1.jsx)(FolderContext.Provider, { value: value, children: children }));
+        const fallback = (0, delay_render_1.delayRender)('Waiting for Root component to unsuspend');
+        return () => (0, delay_render_1.continueRender)(fallback);
+    }, []);
+    return null;
 };
-exports.Folder = Folder;
 const Composition = ({ width, height, fps, durationInFrames, id, defaultProps, ...compProps }) => {
     const { registerComposition, unregisterComposition } = (0, react_1.useContext)(CompositionManager_1.CompositionManager);
+    const video = (0, use_video_1.useVideo)();
     const lazy = (0, use_lazy_component_1.useLazyComponent)(compProps);
     const nonce = (0, nonce_1.useNonce)();
-    const { folderName, parentName } = (0, react_1.useContext)(FolderContext);
+    const canUseComposition = (0, react_1.useContext)(internals_1.Internals.CanUseRemotionHooks);
+    if (canUseComposition) {
+        if (typeof window !== 'undefined' && window.remotion_isPlayer) {
+            throw new Error('<Composition> was mounted inside the `component` that was passed to the <Player>. See https://remotion.dev/docs/wrong-composition-mount for help.');
+        }
+        throw new Error('<Composition> mounted inside another composition. See https://remotion.dev/docs/wrong-composition-mount for help.');
+    }
+    const { folderName, parentName } = (0, react_1.useContext)(Folder_1.FolderContext);
     (0, react_1.useEffect)(() => {
         // Ensure it's a URL safe id
         if (!id) {
@@ -51,7 +49,7 @@ const Composition = ({ width, height, fps, durationInFrames, id, defaultProps, .
         (0, validate_dimensions_1.validateDimension)(width, 'width', 'of the <Composition/> component');
         (0, validate_dimensions_1.validateDimension)(height, 'height', 'of the <Composition/> component');
         (0, validate_duration_in_frames_1.validateDurationInFrames)(durationInFrames, 'of the <Composition/> component');
-        (0, validate_fps_1.validateFps)(fps, 'as a prop of the <Composition/> component');
+        (0, validate_fps_1.validateFps)(fps, 'as a prop of the <Composition/> component', false);
         registerComposition({
             durationInFrames,
             fps,
@@ -81,6 +79,20 @@ const Composition = ({ width, height, fps, durationInFrames, id, defaultProps, .
         nonce,
         parentName,
     ]);
+    if ((0, get_environment_1.getRemotionEnvironment)() === 'preview' &&
+        video &&
+        video.component === lazy) {
+        const Comp = lazy;
+        const inputProps = (0, input_props_1.getInputProps)();
+        return (0, react_dom_1.createPortal)((0, jsx_runtime_1.jsx)(CanUseRemotionHooks_1.CanUseRemotionHooksProvider, { children: (0, jsx_runtime_1.jsx)(react_1.Suspense, { fallback: (0, jsx_runtime_1.jsx)(loading_indicator_1.Loading, {}), children: (0, jsx_runtime_1.jsx)(Comp, { ...defaultProps, ...inputProps }) }) }), (0, portal_node_1.portalNode)());
+    }
+    if ((0, get_environment_1.getRemotionEnvironment)() === 'rendering' &&
+        video &&
+        video.component === lazy) {
+        const Comp = lazy;
+        const inputProps = (0, input_props_1.getInputProps)();
+        return (0, react_dom_1.createPortal)((0, jsx_runtime_1.jsx)(CanUseRemotionHooks_1.CanUseRemotionHooksProvider, { children: (0, jsx_runtime_1.jsx)(react_1.Suspense, { fallback: (0, jsx_runtime_1.jsx)(Fallback, {}), children: (0, jsx_runtime_1.jsx)(Comp, { ...defaultProps, ...inputProps }) }) }), (0, portal_node_1.portalNode)());
+    }
     return null;
 };
 exports.Composition = Composition;

package/dist/CompositionManager.d.ts

@@ -1,4 +1,6 @@
-import React, { ComponentType, LazyExoticComponent } from 'react';
+import type { ComponentType, LazyExoticComponent } from 'react';
+import React from 'react';
+import type { TFolder } from './Folder';
 export declare type TComposition<T = unknown> = {
     width: number;
     height: number;
@@ -48,12 +50,7 @@ export declare type TAsset = {
     mediaFrame: number;
     playbackRate: number;
 };
-export declare type RenderAssetInfo = {
-    assets: TAsset[][];
-    imageSequenceName: string;
-    firstFrameIndex: number;
-    downloadDir: string;
-};
+declare type BaseMetadata = Pick<TCompMetadata, 'durationInFrames' | 'fps' | 'defaultProps' | 'height' | 'width'>;
 export declare type CompositionManagerContext = {
     compositions: TComposition[];
     registerComposition: <T>(comp: TComposition<T>) => void;
@@ -62,6 +59,8 @@ export declare type CompositionManagerContext = {
     unregisterFolder: (name: string, parent: string | null) => void;
     currentComposition: string | null;
     setCurrentComposition: (curr: string) => void;
+    setCurrentCompositionMetadata: (metadata: BaseMetadata) => void;
+    currentCompositionMetadata: BaseMetadata | null;
     registerSequence: (seq: TSequence) => void;
     unregisterSequence: (id: string) => void;
     registerAsset: (asset: TAsset) => void;
@@ -74,10 +73,6 @@ export declare const CompositionManager: React.Context<CompositionManagerContext
 export declare const compositionsRef: React.RefObject<{
     getCompositions: () => TCompMetadata[];
 }>;
-export declare type TFolder = {
-    name: string;
-    parent: string | null;
-};
 export declare const CompositionManagerProvider: React.FC<{
     children: React.ReactNode;
 }>;

package/dist/CompositionManager.js

@@ -34,6 +34,7 @@ exports.CompositionManager = (0, react_1.createContext)({
     unregisterFolder: () => undefined,
     currentComposition: null,
     setCurrentComposition: () => undefined,
+    setCurrentCompositionMetadata: () => undefined,
     registerSequence: () => undefined,
     unregisterSequence: () => undefined,
     registerAsset: () => undefined,
@@ -41,6 +42,7 @@ exports.CompositionManager = (0, react_1.createContext)({
     sequences: [],
     assets: [],
     folders: [],
+    currentCompositionMetadata: null,
 });
 exports.compositionsRef = react_1.default.createRef();
 const CompositionManagerProvider = ({ children }) => {
@@ -51,6 +53,7 @@ const CompositionManagerProvider = ({ children }) => {
     const [assets, setAssets] = (0, react_1.useState)([]);
     const [folders, setFolders] = (0, react_1.useState)([]);
     const [sequences, setSequences] = (0, react_1.useState)([]);
+    const [currentCompositionMetadata, setCurrentCompositionMetadata] = (0, react_1.useState)(null);
     const registerComposition = (0, react_1.useCallback)((comp) => {
         setCompositions((comps) => {
             if (comps.find((c) => c.id === comp.id)) {
@@ -127,21 +130,24 @@ const CompositionManagerProvider = ({ children }) => {
             folders,
             registerFolder,
             unregisterFolder,
+            currentCompositionMetadata,
+            setCurrentCompositionMetadata,
         };
     }, [
         compositions,
-        currentComposition,
         registerComposition,
-        registerSequence,
         unregisterComposition,
+        currentComposition,
+        registerSequence,
         unregisterSequence,
         registerAsset,
         unregisterAsset,
         sequences,
         assets,
+        folders,
         registerFolder,
         unregisterFolder,
-        folders,
+        currentCompositionMetadata,
     ]);
     return ((0, jsx_runtime_1.jsx)(exports.CompositionManager.Provider, { value: contextValue, children: children }));
 };

package/dist/Folder.d.ts

@@ -0,0 +1,15 @@
+import type { FC } from 'react';
+export declare type TFolder = {
+    name: string;
+    parent: string | null;
+};
+declare type FolderContextType = {
+    folderName: string | null;
+    parentName: string | null;
+};
+export declare const FolderContext: import("react").Context<FolderContextType>;
+export declare const Folder: FC<{
+    name: string;
+    children: React.ReactNode;
+}>;
+export {};

package/dist/Folder.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Folder = exports.FolderContext = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const CompositionManager_1 = require("./CompositionManager");
+const truthy_1 = require("./truthy");
+const validate_folder_name_1 = require("./validation/validate-folder-name");
+exports.FolderContext = (0, react_1.createContext)({
+    folderName: null,
+    parentName: null,
+});
+const Folder = ({ name, children, }) => {
+    const parent = (0, react_1.useContext)(exports.FolderContext);
+    const { registerFolder, unregisterFolder } = (0, react_1.useContext)(CompositionManager_1.CompositionManager);
+    (0, validate_folder_name_1.validateFolderName)(name);
+    const parentNameArr = [parent.parentName, parent.folderName].filter(truthy_1.truthy);
+    const parentName = parentNameArr.length === 0 ? null : parentNameArr.join('/');
+    const value = (0, react_1.useMemo)(() => {
+        return {
+            folderName: name,
+            parentName,
+        };
+    }, [name, parentName]);
+    (0, react_1.useEffect)(() => {
+        registerFolder(name, parentName);
+        return () => {
+            unregisterFolder(name, parentName);
+        };
+    }, [name, parent.folderName, parentName, registerFolder, unregisterFolder]);
+    return ((0, jsx_runtime_1.jsx)(exports.FolderContext.Provider, { value: value, children: children }));
+};
+exports.Folder = Folder;

package/dist/Img.js

@@ -4,11 +4,13 @@ exports.Img = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 const react_1 = require("react");
 const delay_render_1 = require("./delay-render");
-const ImgRefForwarding = ({ onError, ...props }, ref) => {
+const preload_1 = require("./preload");
+const ImgRefForwarding = ({ onError, src, ...props }, ref) => {
     const imageRef = (0, react_1.useRef)(null);
     (0, react_1.useImperativeHandle)(ref, () => {
         return imageRef.current;
     });
+    const actualSrc = (0, preload_1.usePreload)(src);
     const didGetError = (0, react_1.useCallback)((e) => {
         var _a;
         if (onError) {
@@ -20,7 +22,10 @@ const ImgRefForwarding = ({ onError, ...props }, ref) => {
     }, [onError]);
     // If image source switches, make new handle
     (0, react_1.useLayoutEffect)(() => {
-        const newHandle = (0, delay_render_1.delayRender)('Loading <Img> with src=' + props.src);
+        if (process.env.NODE_ENV === 'test') {
+            return;
+        }
+        const newHandle = (0, delay_render_1.delayRender)('Loading <Img> with src=' + src);
         const { current } = imageRef;
         const didLoad = () => {
             (0, delay_render_1.continueRender)(newHandle);
@@ -36,7 +41,7 @@ const ImgRefForwarding = ({ onError, ...props }, ref) => {
             current === null || current === void 0 ? void 0 : current.removeEventListener('load', didLoad);
             (0, delay_render_1.continueRender)(newHandle);
         };
-    }, [props.src]);
-    return (0, jsx_runtime_1.jsx)("img", { ...props, ref: imageRef, onError: didGetError });
+    }, [src]);
+    return ((0, jsx_runtime_1.jsx)("img", { ...props, ref: imageRef, src: actualSrc, onError: didGetError }));
 };
 exports.Img = (0, react_1.forwardRef)(ImgRefForwarding);

package/dist/RemotionRoot.js

@@ -7,6 +7,7 @@ const shared_audio_tags_1 = require("./audio/shared-audio-tags");
 const CompositionManager_1 = require("./CompositionManager");
 const delay_render_1 = require("./delay-render");
 const nonce_1 = require("./nonce");
+const preload_state_1 = require("./preload-state");
 const random_1 = require("./random");
 const timeline_position_state_1 = require("./timeline-position-state");
 const RemotionRoot = ({ children }) => {
@@ -61,10 +62,10 @@ const RemotionRoot = ({ children }) => {
             });
         }
     }, []);
-    return ((0, jsx_runtime_1.jsx)(nonce_1.NonceContext.Provider, { value: nonceContext, children: (0, jsx_runtime_1.jsx)(timeline_position_state_1.TimelineContext.Provider, { value: timelineContextValue, children: (0, jsx_runtime_1.jsx)(timeline_position_state_1.SetTimelineContext.Provider, { value: setTimelineContextValue, children: (0, jsx_runtime_1.jsx)(CompositionManager_1.CompositionManagerProvider, { children: (0, jsx_runtime_1.jsx)(shared_audio_tags_1.SharedAudioContextProvider
-                    // In the preview, which is mostly played on Desktop, we opt out of the autoplay policy fix as described in https://github.com/remotion-dev/remotion/pull/554, as it mostly applies to mobile.
-                    , { 
+    return ((0, jsx_runtime_1.jsx)(nonce_1.NonceContext.Provider, { value: nonceContext, children: (0, jsx_runtime_1.jsx)(timeline_position_state_1.TimelineContext.Provider, { value: timelineContextValue, children: (0, jsx_runtime_1.jsx)(timeline_position_state_1.SetTimelineContext.Provider, { value: setTimelineContextValue, children: (0, jsx_runtime_1.jsx)(preload_state_1.PreloadProvider, { children: (0, jsx_runtime_1.jsx)(CompositionManager_1.CompositionManagerProvider, { children: (0, jsx_runtime_1.jsx)(shared_audio_tags_1.SharedAudioContextProvider
                         // In the preview, which is mostly played on Desktop, we opt out of the autoplay policy fix as described in https://github.com/remotion-dev/remotion/pull/554, as it mostly applies to mobile.
-                        numberOfAudioTags: 0, children: children }) }) }) }) }));
+                        , { 
+                            // In the preview, which is mostly played on Desktop, we opt out of the autoplay policy fix as described in https://github.com/remotion-dev/remotion/pull/554, as it mostly applies to mobile.
+                            numberOfAudioTags: 0, children: children }) }) }) }) }) }));
 };
 exports.RemotionRoot = RemotionRoot;

package/dist/{sequencing/index.d.ts → Sequence.d.ts}

@@ -7,13 +7,23 @@ export declare type SequenceContextType = {
     id: string;
 };
 export declare const SequenceContext: React.Context<SequenceContextType | null>;
+declare type LayoutAndStyle = {
+    layout: 'none';
+} | {
+    layout?: 'absolute-fill';
+    style?: React.CSSProperties;
+};
 export declare type SequenceProps = {
     children: React.ReactNode;
     from: number;
     durationInFrames?: number;
     name?: string;
-    layout?: 'absolute-fill' | 'none';
     showInTimeline?: boolean;
     showLoopTimesInTimeline?: number;
-};
-export declare const Sequence: React.FC<SequenceProps>;
+} & LayoutAndStyle;
+/**
+ * A component that time-shifts its children and wraps them in an absolutely positioned <div>.
+ * @link https://www.remotion.dev/docs/sequence
+ */
+export declare const Sequence: React.ForwardRefExoticComponent<SequenceProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/dist/{sequencing/index.js → Sequence.js}

@@ -3,25 +3,30 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Sequence = exports.SequenceContext = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 const react_1 = require("react");
-const CompositionManager_1 = require("../CompositionManager");
-const get_timeline_clip_name_1 = require("../get-timeline-clip-name");
-const nonce_1 = require("../nonce");
-const timeline_position_state_1 = require("../timeline-position-state");
-const use_frame_1 = require("../use-frame");
-const use_unsafe_video_config_1 = require("../use-unsafe-video-config");
+const AbsoluteFill_1 = require("./AbsoluteFill");
+const CompositionManager_1 = require("./CompositionManager");
+const get_environment_1 = require("./get-environment");
+const get_timeline_clip_name_1 = require("./get-timeline-clip-name");
+const nonce_1 = require("./nonce");
+const timeline_position_state_1 = require("./timeline-position-state");
+const use_video_config_1 = require("./use-video-config");
 exports.SequenceContext = (0, react_1.createContext)(null);
-const Sequence = ({ from, durationInFrames = Infinity, children, name, layout = 'absolute-fill', showInTimeline = true, showLoopTimesInTimeline, }) => {
+const SequenceRefForwardingFunction = ({ from, durationInFrames = Infinity, children, name, showInTimeline = true, showLoopTimesInTimeline, ...other }, ref) => {
+    const { layout = 'absolute-fill' } = other;
     const [id] = (0, react_1.useState)(() => String(Math.random()));
     const parentSequence = (0, react_1.useContext)(exports.SequenceContext);
     const { rootId } = (0, react_1.useContext)(timeline_position_state_1.TimelineContext);
     const cumulatedFrom = parentSequence
         ? parentSequence.cumulatedFrom + parentSequence.relativeFrom
         : 0;
-    const actualFrom = cumulatedFrom + from;
     const nonce = (0, nonce_1.useNonce)();
     if (layout !== 'absolute-fill' && layout !== 'none') {
         throw new TypeError(`The layout prop of <Sequence /> expects either "absolute-fill" or "none", but you passed: ${layout}`);
     }
+    // @ts-expect-error
+    if (layout === 'none' && typeof other.style !== 'undefined') {
+        throw new TypeError('If layout="none", you may not pass a style.');
+    }
     if (typeof durationInFrames !== 'number') {
         throw new TypeError(`You passed to durationInFrames an argument of type ${typeof durationInFrames}, but it must be a number.`);
     }
@@ -38,16 +43,12 @@ const Sequence = ({ from, durationInFrames = Infinity, children, name, layout =
     if (from % 1 !== 0) {
         throw new TypeError(`The "from" prop of a sequence must be an integer, but got ${from}.`);
     }
-    const absoluteFrame = (0, use_frame_1.useAbsoluteCurrentFrame)();
-    const unsafeVideoConfig = (0, use_unsafe_video_config_1.useUnsafeVideoConfig)();
-    const compositionDuration = unsafeVideoConfig
-        ? unsafeVideoConfig.durationInFrames
-        : 0;
-    const actualDurationInFrames = Math.min(compositionDuration - from, parentSequence
-        ? Math.min(parentSequence.durationInFrames +
-            (parentSequence.cumulatedFrom + parentSequence.relativeFrom) -
-            actualFrom, durationInFrames)
-        : durationInFrames);
+    const absoluteFrame = (0, timeline_position_state_1.useTimelinePosition)();
+    const videoConfig = (0, use_video_config_1.useVideoConfig)();
+    const parentSequenceDuration = parentSequence
+        ? Math.min(parentSequence.durationInFrames - from, durationInFrames)
+        : durationInFrames;
+    const actualDurationInFrames = Math.max(0, Math.min(videoConfig.durationInFrames - from, parentSequenceDuration));
     const { registerSequence, unregisterSequence } = (0, react_1.useContext)(CompositionManager_1.CompositionManager);
     const contextValue = (0, react_1.useMemo)(() => {
         var _a;
@@ -70,6 +71,9 @@ const Sequence = ({ from, durationInFrames = Infinity, children, name, layout =
     }, [children, name]);
     (0, react_1.useEffect)(() => {
         var _a;
+        if ((0, get_environment_1.getRemotionEnvironment)() !== 'preview') {
+            return;
+        }
         registerSequence({
             from,
             duration: actualDurationInFrames,
@@ -87,7 +91,6 @@ const Sequence = ({ from, durationInFrames = Infinity, children, name, layout =
         };
     }, [
         durationInFrames,
-        actualFrom,
         id,
         name,
         registerSequence,
@@ -101,23 +104,26 @@ const Sequence = ({ from, durationInFrames = Infinity, children, name, layout =
         nonce,
         showLoopTimesInTimeline,
     ]);
-    const endThreshold = (() => {
-        return actualFrom + durationInFrames - 1;
-    })();
-    const content = absoluteFrame < actualFrom
+    const endThreshold = cumulatedFrom + from + durationInFrames - 1;
+    const content = absoluteFrame < cumulatedFrom + from
         ? null
         : absoluteFrame > endThreshold
             ? null
             : children;
-    return ((0, jsx_runtime_1.jsx)(exports.SequenceContext.Provider, { value: contextValue, children: content === null ? null : layout === 'absolute-fill' ? ((0, jsx_runtime_1.jsx)("div", { style: {
-                position: 'absolute',
-                display: 'flex',
-                width: '100%',
-                height: '100%',
-                top: 0,
-                bottom: 0,
-                left: 0,
-                right: 0,
-            }, children: content })) : (content) }));
+    const styleIfThere = other.layout === 'none' ? undefined : other.style;
+    const defaultStyle = (0, react_1.useMemo)(() => {
+        return {
+            flexDirection: undefined,
+            ...(styleIfThere !== null && styleIfThere !== void 0 ? styleIfThere : {}),
+        };
+    }, [styleIfThere]);
+    if (ref !== null && layout === 'none') {
+        throw new TypeError('It is not supported to pass both a `ref` and `layout="none"` to <Sequence />.');
+    }
+    return ((0, jsx_runtime_1.jsx)(exports.SequenceContext.Provider, { value: contextValue, children: content === null ? null : layout === 'absolute-fill' ? ((0, jsx_runtime_1.jsx)(AbsoluteFill_1.AbsoluteFill, { ref: ref, style: defaultStyle, children: content })) : (content) }));
 };
-exports.Sequence = Sequence;
+/**
+ * A component that time-shifts its children and wraps them in an absolutely positioned <div>.
+ * @link https://www.remotion.dev/docs/sequence
+ */
+exports.Sequence = (0, react_1.forwardRef)(SequenceRefForwardingFunction);

package/dist/Still.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-import { StillProps } from './Composition';
+import type { StillProps } from './Composition';
 export declare const Still: <T>(props: StillProps<T>) => JSX.Element;