remotion
Version:
Make videos programmatically
160 lines (159 loc) • 6.15 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.useMediaInTimeline = void 0;
const react_1 = require("react");
const SequenceContext_js_1 = require("./SequenceContext.js");
const SequenceManager_js_1 = require("./SequenceManager.js");
const use_audio_frame_js_1 = require("./audio/use-audio-frame.js");
const get_asset_file_name_js_1 = require("./get-asset-file-name.js");
const get_remotion_environment_js_1 = require("./get-remotion-environment.js");
const log_level_context_js_1 = require("./log-level-context.js");
const nonce_js_1 = require("./nonce.js");
const play_and_handle_not_allowed_error_js_1 = require("./play-and-handle-not-allowed-error.js");
const timeline_position_state_js_1 = require("./timeline-position-state.js");
const use_video_config_js_1 = require("./use-video-config.js");
const volume_prop_js_1 = require("./volume-prop.js");
const didWarn = {};
const warnOnce = (message) => {
if (didWarn[message]) {
return;
}
// eslint-disable-next-line no-console
console.warn(message);
didWarn[message] = true;
};
const useMediaInTimeline = ({ volume, mediaVolume, mediaRef, src, mediaType, playbackRate, displayName, id, stack, showInTimeline, premountDisplay, onAutoPlayError, isPremounting, }) => {
const videoConfig = (0, use_video_config_js_1.useVideoConfig)();
const { rootId, audioAndVideoTags } = (0, react_1.useContext)(timeline_position_state_js_1.TimelineContext);
const parentSequence = (0, react_1.useContext)(SequenceContext_js_1.SequenceContext);
const actualFrom = parentSequence
? parentSequence.relativeFrom + parentSequence.cumulatedFrom
: 0;
const { imperativePlaying } = (0, react_1.useContext)(timeline_position_state_js_1.TimelineContext);
const startsAt = (0, use_audio_frame_js_1.useMediaStartsAt)();
const { registerSequence, unregisterSequence } = (0, react_1.useContext)(SequenceManager_js_1.SequenceManager);
const [initialVolume] = (0, react_1.useState)(() => volume);
const logLevel = (0, log_level_context_js_1.useLogLevel)();
const mountTime = (0, log_level_context_js_1.useMountTime)();
const nonce = (0, nonce_js_1.useNonce)();
const duration = parentSequence
? Math.min(parentSequence.durationInFrames, videoConfig.durationInFrames)
: videoConfig.durationInFrames;
const doesVolumeChange = typeof volume === 'function';
const volumes = (0, react_1.useMemo)(() => {
if (typeof volume === 'number') {
return volume;
}
return new Array(Math.floor(Math.max(0, duration + startsAt)))
.fill(true)
.map((_, i) => {
return (0, volume_prop_js_1.evaluateVolume)({
frame: i + startsAt,
volume,
mediaVolume,
});
})
.join(',');
}, [duration, startsAt, volume, mediaVolume]);
(0, react_1.useEffect)(() => {
if (typeof volume === 'number' && volume !== initialVolume) {
warnOnce(`Remotion: The ${mediaType} with src ${src} has changed it's volume. Prefer the callback syntax for setting volume to get better timeline display: https://www.remotion.dev/docs/audio/volume`);
}
}, [initialVolume, mediaType, src, volume]);
(0, react_1.useEffect)(() => {
var _a, _b, _c;
if (!mediaRef.current) {
return;
}
if (!src) {
throw new Error('No src passed');
}
if (!(0, get_remotion_environment_js_1.getRemotionEnvironment)().isStudio &&
((_b = (_a = window.process) === null || _a === void 0 ? void 0 : _a.env) === null || _b === void 0 ? void 0 : _b.NODE_ENV) !== 'test') {
return;
}
if (!showInTimeline) {
return;
}
registerSequence({
type: mediaType,
src,
id,
duration,
from: 0,
parent: (_c = parentSequence === null || parentSequence === void 0 ? void 0 : parentSequence.id) !== null && _c !== void 0 ? _c : null,
displayName: displayName !== null && displayName !== void 0 ? displayName : (0, get_asset_file_name_js_1.getAssetDisplayName)(src),
rootId,
volume: volumes,
showInTimeline: true,
nonce,
startMediaFrom: 0 - startsAt,
doesVolumeChange,
loopDisplay: undefined,
playbackRate,
stack,
premountDisplay,
});
return () => {
unregisterSequence(id);
};
}, [
actualFrom,
duration,
id,
parentSequence,
src,
registerSequence,
rootId,
unregisterSequence,
videoConfig,
volumes,
doesVolumeChange,
nonce,
mediaRef,
mediaType,
startsAt,
playbackRate,
displayName,
stack,
showInTimeline,
premountDisplay,
]);
(0, react_1.useEffect)(() => {
const tag = {
id,
play: (reason) => {
if (!imperativePlaying.current) {
// Don't play if for example in a <Freeze> state.
return;
}
if (isPremounting) {
return;
}
return (0, play_and_handle_not_allowed_error_js_1.playAndHandleNotAllowedError)({
mediaRef,
mediaType,
onAutoPlayError,
logLevel,
mountTime,
reason,
});
},
};
audioAndVideoTags.current.push(tag);
return () => {
audioAndVideoTags.current = audioAndVideoTags.current.filter((a) => a.id !== id);
};
}, [
audioAndVideoTags,
id,
mediaRef,
mediaType,
onAutoPlayError,
imperativePlaying,
isPremounting,
logLevel,
mountTime,
]);
};
exports.useMediaInTimeline = useMediaInTimeline;