@remotion/media-utils 4.0.0-2x.1 → 4.0.0-alpha.111

package/dist/audio-buffer/audio-url-helpers.d.ts

@@ -1 +1,5 @@
+/**
+ * @description This API takes an AudioBuffer instance and converts it to a Base 64 Data URL so it can be passed to an <Audio /> tag.
+ * @see [Documentation](https://www.remotion.dev/docs/audio-buffer-to-data-url)
+ */
 export declare const audioBufferToDataUrl: (buffer: AudioBuffer) => string;

package/dist/audio-buffer/audio-url-helpers.js

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.audioBufferToDataUrl = void 0;
 const audio_buffer_to_wav_1 = require("./audio-buffer-to-wav");
+/**
+ * @description This API takes an AudioBuffer instance and converts it to a Base 64 Data URL so it can be passed to an <Audio /> tag.
+ * @see [Documentation](https://www.remotion.dev/docs/audio-buffer-to-data-url)
+ */
 const audioBufferToDataUrl = (buffer) => {
     const wavAsArrayBuffer = (0, audio_buffer_to_wav_1.audioBufferToWav)(buffer, {
         float32: true,

package/dist/get-audio-data.d.ts

@@ -1,2 +1,6 @@
 import type { AudioData } from './types';
+/**
+ * @description Takes an audio src, loads it and returns data and metadata for the specified source.
+ * @see [Documentation](https://www.remotion.dev/docs/get-audio-data)
+ */
 export declare const getAudioData: (src: string) => Promise<AudioData>;

package/dist/get-audio-data.js

@@ -7,7 +7,10 @@ const metadataCache = {};
 const limit = (0, p_limit_1.pLimit)(3);
 const fetchWithCorsCatch = async (src) => {
     try {
-        const response = await fetch(src);
+        const response = await fetch(src, {
+            mode: 'cors',
+            referrerPolicy: 'no-referrer-when-downgrade',
+        });
         return response;
     }
     catch (err) {
@@ -51,6 +54,10 @@ const fn = async (src) => {
     metadataCache[src] = metadata;
     return metadata;
 };
+/**
+ * @description Takes an audio src, loads it and returns data and metadata for the specified source.
+ * @see [Documentation](https://www.remotion.dev/docs/get-audio-data)
+ */
 const getAudioData = (src) => {
     return limit(fn, src);
 };

package/dist/get-audio-duration-in-seconds.d.ts

@@ -1,8 +1,9 @@
 /**
- * Get the audio file passed in parameter duration in seconds
+ * @default Get the audio file passed in parameter duration in seconds
  * @async
  * @param src path to the audio file
  * @return {number} duration of the audio file in seconds
+ * @see [Documentation](https://www.remotion.dev/docs/get-audio-duration-in-seconds)
  */
 export declare const getAudioDurationInSeconds: (src: string) => Promise<number>;
 /**

package/dist/get-audio-duration-in-seconds.js

@@ -33,10 +33,11 @@ const fn = (src) => {
     });
 };
 /**
- * Get the audio file passed in parameter duration in seconds
+ * @default Get the audio file passed in parameter duration in seconds
  * @async
  * @param src path to the audio file
  * @return {number} duration of the audio file in seconds
+ * @see [Documentation](https://www.remotion.dev/docs/get-audio-duration-in-seconds)
  */
 const getAudioDurationInSeconds = (src) => {
     return limit(fn, src);

package/dist/get-video-metadata.d.ts

@@ -1,2 +1,6 @@
 import type { VideoMetadata } from './types';
+/**
+ * @description Takes a src to a video, loads it and returns metadata for the specified source.
+ * @see [Documentation](https://www.remotion.dev/docs/get-video-metadata)
+ */
 export declare const getVideoMetadata: (src: string) => Promise<VideoMetadata>;

package/dist/get-video-metadata.js

@@ -45,6 +45,10 @@ const fn = (src) => {
         video.addEventListener('error', onError, { once: true });
     });
 };
+/**
+ * @description Takes a src to a video, loads it and returns metadata for the specified source.
+ * @see [Documentation](https://www.remotion.dev/docs/get-video-metadata)
+ */
 const getVideoMetadata = (src) => {
     return limit(fn, src);
 };

package/dist/get-waveform-portion.d.ts

@@ -3,6 +3,10 @@ declare type Bar = {
     index: number;
     amplitude: number;
 };
+/**
+ * @description Takes bulky waveform data (for example fetched by getAudioData()) and returns a trimmed and simplified version of it, for simpler visualization
+ * @see [Documentation](https://www.remotion.dev/docs/get-waveform-portion)
+ */
 export declare const getWaveformPortion: ({ audioData, startTimeInSeconds, durationInSeconds, numberOfSamples, }: {
     audioData: AudioData;
     startTimeInSeconds: number;

package/dist/get-waveform-portion.js

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getWaveformPortion = void 0;
 const get_wave_form_samples_1 = require("./get-wave-form-samples");
+/**
+ * @description Takes bulky waveform data (for example fetched by getAudioData()) and returns a trimmed and simplified version of it, for simpler visualization
+ * @see [Documentation](https://www.remotion.dev/docs/get-waveform-portion)
+ */
 const getWaveformPortion = ({ audioData, startTimeInSeconds, durationInSeconds, numberOfSamples, }) => {
     const startSample = Math.floor((startTimeInSeconds / audioData.durationInSeconds) *
         audioData.channelWaveforms[0].length);

package/dist/use-audio-data.d.ts

@@ -1,2 +1,9 @@
 import type { AudioData } from './types';
+/**
+ * @description Wraps the getAudioData() function into a hook and does 3 things:
+ * @description Keeps the audio data in a state
+ * @description Wraps the function in a delayRender() / continueRender() pattern.
+ * @description Handles the case where the component gets unmounted while the fetching is in progress and a React error is thrown.
+ * @see [Documentation](https://www.remotion.dev/docs/use-audio-data)
+ */
 export declare const useAudioData: (src: string) => AudioData | null;

package/dist/use-audio-data.js

@@ -4,6 +4,13 @@ exports.useAudioData = void 0;
 const react_1 = require("react");
 const remotion_1 = require("remotion");
 const get_audio_data_1 = require("./get-audio-data");
+/**
+ * @description Wraps the getAudioData() function into a hook and does 3 things:
+ * @description Keeps the audio data in a state
+ * @description Wraps the function in a delayRender() / continueRender() pattern.
+ * @description Handles the case where the component gets unmounted while the fetching is in progress and a React error is thrown.
+ * @see [Documentation](https://www.remotion.dev/docs/use-audio-data)
+ */
 const useAudioData = (src) => {
     if (!src) {
         throw new TypeError("useAudioData requires a 'src' parameter");

package/dist/visualize-audio.js

@@ -4,6 +4,11 @@ exports.visualizeAudio = void 0;
 const get_visualization_1 = require("./fft/get-visualization");
 const max_value_cached_1 = require("./fft/max-value-cached");
 const cache = {};
+/**
+ * @description Takes in AudioData (preferably fetched by the useAudioData() hook) and processes it in a way that makes visualizing the audio that is playing at the current frame easy.
+ * @description part of @remotion/media-utils
+ * @see [Documentation](https://www.remotion.dev/docs/visualize-audio)
+ */
 const visualizeAudioFrame = ({ audioData: metadata, frame, fps, numberOfSamples, }) => {
     const cacheKey = metadata.resultId + frame + fps + numberOfSamples;
     if (cache[cacheKey]) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remotion/media-utils",
-	"version": "4.0.0-2x.1+76868b791",
+	"version": "4.0.0-alpha.111+6fd1a79a5",
 	"description": "Utility functions for audio and video",
 	"main": "dist/index.js",
 	"sideEffects": false,
@@ -9,7 +9,7 @@
 		"watch": "tsc -w",
 		"build": "tsc -d"
 	},
-	"author": "",
+	"author": "Jonny Burger <jonny@remotion.dev>",
 	"license": "MIT",
 	"repository": {
 		"url": "https://github.com/remotion-dev/remotion"
@@ -18,7 +18,7 @@
 		"url": "https://github.com/remotion-dev/remotion/issues"
 	},
 	"dependencies": {
-		"remotion": "4.0.0-2x.1+76868b791"
+		"remotion": "4.0.0-alpha.111+6fd1a79a5"
 	},
 	"peerDependencies": {
 		"react": ">=16.8.0",
@@ -27,9 +27,9 @@
 	"devDependencies": {
 		"@jonny/eslint-config": "3.0.266",
 		"@types/node": "^16.7.5",
-		"@types/react": "18.0.1",
-		"eslint": "8.13.0",
-		"prettier": "^2.0.5",
+		"@types/react": "18.0.26",
+		"eslint": "8.25.0",
+		"prettier": "^2.7.1",
 		"prettier-plugin-organize-imports": "^2.3.4",
 		"typescript": "^4.7.0"
 	},
@@ -38,11 +38,10 @@
 		"ffmpeg",
 		"video",
 		"react",
-		"puppeteer",
 		"player"
 	],
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "76868b791ce0f109ee1ae24eac7c8d38b95dee3d"
+	"gitHead": "6fd1a79a5bab8c77aa15cab08a51916419c1c4b4"
 }

package/.prettierrc.js

@@ -1,14 +0,0 @@
-module.exports = {
-	singleQuote: true,
-	bracketSpacing: false,
-	useTabs: true,
-	overrides: [
-		{
-			files: ['*.yml'],
-			options: {
-				singleQuote: false,
-			},
-		},
-	],
-	plugins: [require.resolve('prettier-plugin-organize-imports')],
-};

package/dist/create-smooth-svg-path.d.ts

@@ -1,4 +0,0 @@
-export declare const smoothenSvgPath: (points: [
-    number,
-    number
-][]) => string;

package/dist/create-smooth-svg-path.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.smoothenSvgPath = void 0;
-const line = (pointA, pointB) => {
-    const lengthX = pointB[0] - pointA[0];
-    const lengthY = pointB[1] - pointA[1];
-    return {
-        length: Math.sqrt(lengthX ** 2 + lengthY ** 2),
-        angle: Math.atan2(lengthY, lengthX),
-    };
-};
-const controlPoint = (current, previous, next, reverse) => {
-    const p = previous || current;
-    const n = next || current;
-    // The smoothing ratio
-    const smoothing = 0.2;
-    // Properties of the opposed-line
-    const o = line(p, n);
-    const angle = o.angle + (reverse ? Math.PI : 0);
-    const length = o.length * smoothing;
-    const x = current[0] + Math.cos(angle) * length;
-    const y = current[1] + Math.sin(angle) * length;
-    return [x, y];
-};
-const smoothenSvgPath = (points) => {
-    return points.reduce((acc, current, i, a) => {
-        if (i === 0) {
-            return `M ${current[0]},${current[1]}`;
-        }
-        const [x, y] = current;
-        const previous = a[i - 1];
-        const twoPrevious = a[i - 2];
-        const next = a[i + 1];
-        const [cp1x, cp1y] = controlPoint(previous, twoPrevious, current, false);
-        const [cp2x, cp2y] = controlPoint(current, previous, next, true);
-        return `${acc} C ${cp1x},${cp1y} ${cp2x},${cp2y} ${x},${y}`;
-    }, '');
-};
-exports.smoothenSvgPath = smoothenSvgPath;

package/dist/get-audio-duration.d.ts

@@ -1,11 +0,0 @@
-/**
- * Get the audio file passed in parameter duration in seconds
- * @async
- * @param src path to the audio file
- * @return {number} duration of the audio file in seconds
- */
-export declare const getAudioDurationInSeconds: (src: string) => Promise<number>;
-/**
- * @deprecated Renamed to `getAudioDurationInSeconds`
- */
-export declare const getAudioDuration: (src: string) => Promise<number>;

package/dist/get-audio-duration.js

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAudioDuration = exports.getAudioDurationInSeconds = void 0;
-const p_limit_1 = require("./p-limit");
-const limit = (0, p_limit_1.pLimit)(3);
-const metadataCache = {};
-const fn = (src) => {
-    if (metadataCache[src]) {
-        return Promise.resolve(metadataCache[src]);
-    }
-    if (typeof document === 'undefined') {
-        throw new Error('getAudioDuration() is only available in the browser.');
-    }
-    const audio = document.createElement('audio');
-    audio.src = src;
-    return new Promise((resolve, reject) => {
-        const onError = () => {
-            reject(audio.error);
-            cleanup();
-        };
-        const onLoadedMetadata = () => {
-            metadataCache[src] = audio.duration;
-            resolve(audio.duration);
-            cleanup();
-        };
-        const cleanup = () => {
-            audio.removeEventListener('loadedmetadata', onLoadedMetadata);
-            audio.removeEventListener('error', onError);
-            audio.remove();
-        };
-        audio.addEventListener('loadedmetadata', onLoadedMetadata, { once: true });
-        audio.addEventListener('error', onError, { once: true });
-    });
-};
-/**
- * Get the audio file passed in parameter duration in seconds
- * @async
- * @param src path to the audio file
- * @return {number} duration of the audio file in seconds
- */
-const getAudioDurationInSeconds = (src) => {
-    return limit(fn, src);
-};
-exports.getAudioDurationInSeconds = getAudioDurationInSeconds;
-/**
- * @deprecated Renamed to `getAudioDurationInSeconds`
- */
-const getAudioDuration = (src) => (0, exports.getAudioDurationInSeconds)(src);
-exports.getAudioDuration = getAudioDuration;

package/dist/validate-channel.d.ts

@@ -1 +0,0 @@
-export declare const validateChannel: (channel: unknown, numberOfChannels: number) => void;

package/dist/validate-channel.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateChannel = void 0;
-const validateChannel = (channel, numberOfChannels) => {
-    if (typeof channel !== 'number') {
-        throw new TypeError(`"channel" must be a number`);
-    }
-    if (channel % 1 !== 0) {
-        throw new TypeError(`"channel" must an integer, got ${channel}`);
-    }
-    if (Number.isNaN(channel)) {
-        throw new TypeError(`The channel parameter is NaN.`);
-    }
-    if (channel < 0) {
-        throw new TypeError('"channel" cannot be negative');
-    }
-    if (channel > numberOfChannels - 1) {
-        throw new TypeError(`"channel" must be ${numberOfChannels - 1} or lower. The audio has ${numberOfChannels} channels`);
-    }
-};
-exports.validateChannel = validateChannel;

package/dist/visualize-audio-waveform.d.ts

@@ -1,11 +0,0 @@
-import { AudioData } from './types';
-declare type FnParameters = {
-    audioData: AudioData;
-    frame: number;
-    fps: number;
-    windowInSeconds: number;
-    numberOfSamples: number;
-    channel: number;
-};
-export declare const visualizeAudioWaveform: ({ ...parameters }: FnParameters) => number[];
-export {};

package/dist/visualize-audio-waveform.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.visualizeAudioWaveform = void 0;
-const get_waveform_portion_1 = require("./get-waveform-portion");
-const cache = {};
-const visualizeAudioWaveformFrame = ({ audioData, frame, fps, numberOfSamples, windowInSeconds, channel, }) => {
-    if (windowInSeconds * audioData.sampleRate < numberOfSamples) {
-        throw new TypeError(windowInSeconds +
-            's audiodata does not have ' +
-            numberOfSamples +
-            ' bars. Increase windowInSeconds or decrease numberOfSamples');
-    }
-    const cacheKey = audioData.resultId + frame + fps + numberOfSamples + 'waveform';
-    if (cache[cacheKey]) {
-        return cache[cacheKey];
-    }
-    const time = frame / fps;
-    const startTimeInSeconds = time - windowInSeconds / 2;
-    return (0, get_waveform_portion_1.getWaveformPortion)({
-        audioData,
-        startTimeInSeconds,
-        durationInSeconds: windowInSeconds,
-        numberOfSamples,
-        outputRange: 'minus-one-to-one',
-        channel,
-    });
-};
-const visualizeAudioWaveform = ({ ...parameters }) => {
-    const data = visualizeAudioWaveformFrame(parameters);
-    return data.map((value) => value.amplitude);
-};
-exports.visualizeAudioWaveform = visualizeAudioWaveform;

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-	"extends": "../tsconfig.settings.json",
-	"compilerOptions": {
-		"composite": true,
-		"rootDir": "src",
-		"outDir": "dist"
-	},
-	"include": ["src"],
-	"references": [{"path": "../core"}]
-}