@remotion/player
Version:
React component for embedding a Remotion preview into your app
370 lines (369 loc) • 17.1 kB
JavaScript
import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
import React, { forwardRef, Suspense, useCallback, useContext, useEffect, useImperativeHandle, useMemo, useRef, useState, } from 'react';
import { Internals } from 'remotion';
import { calculateCanvasTransformation, calculateContainerStyle, calculateOuter, calculateOuterStyle, } from './calculate-scale.js';
import { ErrorBoundary } from './error-boundary.js';
import { PLAYER_CSS_CLASSNAME } from './player-css-classname.js';
import { Controls } from './PlayerControls.js';
import { usePlayback } from './use-playback.js';
import { usePlayer } from './use-player.js';
import { IS_NODE } from './utils/is-node.js';
import { useClickPreventionOnDoubleClick } from './utils/use-click-prevention-on-double-click.js';
import { useElementSize } from './utils/use-element-size.js';
const reactVersion = React.version.split('.')[0];
if (reactVersion === '0') {
throw new Error(`Version ${reactVersion} of "react" is not supported by Remotion`);
}
const doesReactVersionSupportSuspense = parseInt(reactVersion, 10) >= 18;
const PlayerUI = ({ controls, style, loop, autoPlay, allowFullscreen, inputProps, clickToPlay, showVolumeControls, doubleClickToFullscreen, spaceKeyToPlayOrPause, errorFallback, playbackRate, renderLoading, renderPoster, className, moveToBeginningWhenEnded, showPosterWhenUnplayed, showPosterWhenEnded, showPosterWhenPaused, showPosterWhenBuffering, inFrame, outFrame, initiallyShowControls, renderFullscreen: renderFullscreenButton, renderPlayPauseButton, alwaysShowControls, showPlaybackRateControl, posterFillMode, bufferStateDelayInMilliseconds, hideControlsWhenPointerDoesntMove, }, ref) => {
var _a, _b, _c;
const config = Internals.useUnsafeVideoConfig();
const video = Internals.useVideo();
const container = useRef(null);
const canvasSize = useElementSize(container, {
triggerOnWindowResize: false,
shouldApplyCssTransforms: false,
});
const [hasPausedToResume, setHasPausedToResume] = useState(false);
const [shouldAutoplay, setShouldAutoPlay] = useState(autoPlay);
const [isFullscreen, setIsFullscreen] = useState(() => false);
const [seeking, setSeeking] = useState(false);
const supportsFullScreen = useMemo(() => {
if (typeof document === 'undefined') {
return false;
}
return Boolean(document.fullscreenEnabled || document.webkitFullscreenEnabled);
}, []);
const player = usePlayer();
usePlayback({
loop,
playbackRate,
moveToBeginningWhenEnded,
inFrame,
outFrame,
frameRef: player.remotionInternal_currentFrameRef,
});
useEffect(() => {
if (hasPausedToResume && !player.playing) {
setHasPausedToResume(false);
player.play();
}
}, [hasPausedToResume, player]);
useEffect(() => {
const { current } = container;
if (!current) {
return;
}
const onFullscreenChange = () => {
setIsFullscreen(document.fullscreenElement === current ||
document.webkitFullscreenElement === current);
};
document.addEventListener('fullscreenchange', onFullscreenChange);
document.addEventListener('webkitfullscreenchange', onFullscreenChange);
return () => {
document.removeEventListener('fullscreenchange', onFullscreenChange);
document.removeEventListener('webkitfullscreenchange', onFullscreenChange);
};
}, []);
const toggle = useCallback((e) => {
if (player.isPlaying()) {
player.pause();
}
else {
player.play(e);
}
}, [player]);
const requestFullscreen = useCallback(() => {
if (!allowFullscreen) {
throw new Error('allowFullscreen is false');
}
if (!supportsFullScreen) {
throw new Error('Browser doesnt support fullscreen');
}
if (!container.current) {
throw new Error('No player ref found');
}
if (container.current.webkitRequestFullScreen) {
container.current.webkitRequestFullScreen();
}
else {
container.current.requestFullscreen();
}
}, [allowFullscreen, supportsFullScreen]);
const exitFullscreen = useCallback(() => {
if (document.webkitExitFullscreen) {
document.webkitExitFullscreen();
}
else {
document.exitFullscreen();
}
}, []);
useEffect(() => {
const { current } = container;
if (!current) {
return;
}
const fullscreenChange = () => {
var _a;
const element = (_a = document.webkitFullscreenElement) !== null && _a !== void 0 ? _a : document.fullscreenElement;
if (element && element === container.current) {
player.emitter.dispatchFullscreenChange({
isFullscreen: true,
});
}
else {
player.emitter.dispatchFullscreenChange({
isFullscreen: false,
});
}
};
current.addEventListener('webkitfullscreenchange', fullscreenChange);
current.addEventListener('fullscreenchange', fullscreenChange);
return () => {
current.removeEventListener('webkitfullscreenchange', fullscreenChange);
current.removeEventListener('fullscreenchange', fullscreenChange);
};
}, [player.emitter]);
const durationInFrames = (_a = config === null || config === void 0 ? void 0 : config.durationInFrames) !== null && _a !== void 0 ? _a : 1;
const layout = useMemo(() => {
if (!config || !canvasSize) {
return null;
}
return calculateCanvasTransformation({
canvasSize,
compositionHeight: config.height,
compositionWidth: config.width,
previewSize: 'auto',
});
}, [canvasSize, config]);
const scale = (_b = layout === null || layout === void 0 ? void 0 : layout.scale) !== null && _b !== void 0 ? _b : 1;
const initialScaleIgnored = useRef(false);
useEffect(() => {
if (!initialScaleIgnored.current) {
initialScaleIgnored.current = true;
return;
}
player.emitter.dispatchScaleChange(scale);
}, [player.emitter, scale]);
const { setMediaVolume, setMediaMuted } = useContext(Internals.SetMediaVolumeContext);
const { mediaMuted, mediaVolume } = useContext(Internals.MediaVolumeContext);
useEffect(() => {
player.emitter.dispatchVolumeChange(mediaVolume);
}, [player.emitter, mediaVolume]);
const isMuted = mediaMuted || mediaVolume === 0;
useEffect(() => {
player.emitter.dispatchMuteChange({
isMuted,
});
}, [player.emitter, isMuted]);
const [showBufferIndicator, setShowBufferState] = useState(false);
useEffect(() => {
let timeout = null;
let stopped = false;
const onBuffer = () => {
requestAnimationFrame(() => {
if (bufferStateDelayInMilliseconds === 0) {
setShowBufferState(true);
}
else {
timeout = setTimeout(() => {
if (!stopped) {
setShowBufferState(true);
}
}, bufferStateDelayInMilliseconds);
}
});
};
const onResume = () => {
requestAnimationFrame(() => {
setShowBufferState(false);
if (timeout) {
clearTimeout(timeout);
}
});
};
player.emitter.addEventListener('waiting', onBuffer);
player.emitter.addEventListener('resume', onResume);
return () => {
player.emitter.removeEventListener('waiting', onBuffer);
player.emitter.removeEventListener('resume', onResume);
setShowBufferState(false);
if (timeout) {
clearTimeout(timeout);
}
stopped = true;
};
}, [bufferStateDelayInMilliseconds, player.emitter]);
useImperativeHandle(ref, () => {
const methods = {
play: player.play,
pause: () => {
// If, after .seek()-ing, the player was explicitly paused, we don't resume
setHasPausedToResume(false);
player.pause();
},
toggle,
getContainerNode: () => container.current,
getCurrentFrame: player.getCurrentFrame,
isPlaying: () => player.playing,
seekTo: (f) => {
const lastFrame = durationInFrames - 1;
const frameToSeekTo = Math.max(0, Math.min(lastFrame, f));
// continue playing after seeking if the player was playing before
if (player.isPlaying()) {
const pauseToResume = frameToSeekTo !== lastFrame || loop;
setHasPausedToResume(pauseToResume);
player.pause();
}
if (frameToSeekTo === lastFrame && !loop) {
player.emitter.dispatchEnded();
}
player.seek(frameToSeekTo);
},
isFullscreen: () => isFullscreen,
requestFullscreen,
exitFullscreen,
getVolume: () => {
if (mediaMuted) {
return 0;
}
return mediaVolume;
},
setVolume: (vol) => {
if (typeof vol !== 'number') {
throw new TypeError(`setVolume() takes a number, got value of type ${typeof vol}`);
}
if (isNaN(vol)) {
throw new TypeError(`setVolume() got a number that is NaN. Volume must be between 0 and 1.`);
}
if (vol < 0 || vol > 1) {
throw new TypeError(`setVolume() got a number that is out of range. Must be between 0 and 1, got ${typeof vol}`);
}
setMediaVolume(vol);
},
isMuted: () => isMuted,
mute: () => {
setMediaMuted(true);
},
unmute: () => {
setMediaMuted(false);
},
getScale: () => scale,
pauseAndReturnToPlayStart: () => {
player.pauseAndReturnToPlayStart();
},
};
return Object.assign(player.emitter, methods);
}, [
durationInFrames,
exitFullscreen,
isFullscreen,
loop,
mediaMuted,
isMuted,
mediaVolume,
player,
requestFullscreen,
setMediaMuted,
setMediaVolume,
toggle,
scale,
]);
const VideoComponent = video ? video.component : null;
const outerStyle = useMemo(() => {
return calculateOuterStyle({ canvasSize, config, style });
}, [canvasSize, config, style]);
const outer = useMemo(() => {
return calculateOuter({ config, layout, scale });
}, [config, layout, scale]);
const containerStyle = useMemo(() => {
return calculateContainerStyle({ canvasSize, config, layout, scale });
}, [canvasSize, config, layout, scale]);
const onError = useCallback((error) => {
player.pause();
// Pay attention to `this context`
player.emitter.dispatchError(error);
}, [player]);
const onFullscreenButtonClick = useCallback((e) => {
e.stopPropagation();
requestFullscreen();
}, [requestFullscreen]);
const onExitFullscreenButtonClick = useCallback((e) => {
e.stopPropagation();
exitFullscreen();
}, [exitFullscreen]);
const onSingleClick = useCallback((e) => {
toggle(e);
}, [toggle]);
const onSeekStart = useCallback(() => {
setSeeking(true);
}, []);
const onSeekEnd = useCallback(() => {
setSeeking(false);
}, []);
const onDoubleClick = useCallback(() => {
if (isFullscreen) {
exitFullscreen();
}
else {
requestFullscreen();
}
}, [exitFullscreen, isFullscreen, requestFullscreen]);
const [handleClick, handleDoubleClick] = useClickPreventionOnDoubleClick(onSingleClick, onDoubleClick, doubleClickToFullscreen && allowFullscreen && supportsFullScreen);
useEffect(() => {
if (shouldAutoplay) {
player.play();
setShouldAutoPlay(false);
}
}, [shouldAutoplay, player]);
const loadingMarkup = useMemo(() => {
return renderLoading
? renderLoading({
height: outerStyle.height,
width: outerStyle.width,
isBuffering: showBufferIndicator,
})
: null;
}, [outerStyle.height, outerStyle.width, renderLoading, showBufferIndicator]);
const currentScale = useMemo(() => {
return {
type: 'scale',
scale,
};
}, [scale]);
if (!config) {
return null;
}
const poster = renderPoster
? renderPoster({
height: posterFillMode === 'player-size'
? outerStyle.height
: config.height,
width: posterFillMode === 'player-size'
? outerStyle.width
: config.width,
isBuffering: showBufferIndicator,
})
: null;
if (poster === undefined) {
throw new TypeError('renderPoster() must return a React element, but undefined was returned');
}
const shouldShowPoster = poster &&
[
showPosterWhenPaused && !player.isPlaying() && !seeking,
showPosterWhenEnded && player.isLastFrame && !player.isPlaying(),
showPosterWhenUnplayed && !player.hasPlayed && !player.isPlaying(),
showPosterWhenBuffering && showBufferIndicator && player.isPlaying(),
].some(Boolean);
const { left, top, width, height, ...outerWithoutScale } = outer;
const content = (_jsxs(_Fragment, { children: [_jsx("div", { style: outer, onPointerUp: clickToPlay ? handleClick : undefined, onDoubleClick: doubleClickToFullscreen ? handleDoubleClick : undefined, children: _jsxs("div", { style: containerStyle, className: PLAYER_CSS_CLASSNAME, children: [VideoComponent ? (_jsx(ErrorBoundary, { onError: onError, errorFallback: errorFallback, children: _jsx(Internals.ClipComposition, { children: _jsx(Internals.CurrentScaleContext.Provider, { value: currentScale, children: _jsx(VideoComponent, { ...((_c = video === null || video === void 0 ? void 0 : video.props) !== null && _c !== void 0 ? _c : {}), ...(inputProps !== null && inputProps !== void 0 ? inputProps : {}) }) }) }) })) : null, shouldShowPoster && posterFillMode === 'composition-size' ? (_jsx("div", { style: {
...outerWithoutScale,
width: config.width,
height: config.height,
}, onPointerUp: clickToPlay ? handleClick : undefined, onDoubleClick: doubleClickToFullscreen ? handleDoubleClick : undefined, children: poster })) : null] }) }), shouldShowPoster && posterFillMode === 'player-size' ? (_jsx("div", { style: outer, onPointerUp: clickToPlay ? handleClick : undefined, onDoubleClick: doubleClickToFullscreen ? handleDoubleClick : undefined, children: poster })) : null, controls ? (_jsx(Controls, { fps: config.fps, durationInFrames: config.durationInFrames, player: player, containerRef: container, onFullscreenButtonClick: onFullscreenButtonClick, isFullscreen: isFullscreen, allowFullscreen: allowFullscreen, showVolumeControls: showVolumeControls, onExitFullscreenButtonClick: onExitFullscreenButtonClick, spaceKeyToPlayOrPause: spaceKeyToPlayOrPause, onSeekEnd: onSeekEnd, onSeekStart: onSeekStart, inFrame: inFrame, outFrame: outFrame, initiallyShowControls: initiallyShowControls, canvasSize: canvasSize, renderFullscreenButton: renderFullscreenButton, renderPlayPauseButton: renderPlayPauseButton, alwaysShowControls: alwaysShowControls, showPlaybackRateControl: showPlaybackRateControl, buffering: showBufferIndicator, hideControlsWhenPointerDoesntMove: hideControlsWhenPointerDoesntMove, onDoubleClick: doubleClickToFullscreen ? handleDoubleClick : undefined, onPointerUp: clickToPlay ? handleClick : undefined })) : null] }));
if (IS_NODE && !doesReactVersionSupportSuspense) {
return (_jsx("div", { ref: container, style: outerStyle, className: className, children: content }));
}
return (_jsx("div", { ref: container, style: outerStyle, className: className, children: _jsx(Suspense, { fallback: loadingMarkup, children: content }) }));
};
export default forwardRef(PlayerUI);