Skip to content

🎥 Make videos programmatically with React

Elements: Add mirrored audio spectrum

Igor Samokhovets40dad2d29994
diff --git a/packages/docs/elements/audio/index.mdx b/packages/docs/elements/audio/index.mdx
new file mode 100644
index 0000000000..e70683aea0
--- /dev/null
+++ b/packages/docs/elements/audio/index.mdx
@@ -0,0 +1,10 @@
+---
+title: Audio
+description: Audio-reactive Elements for visualizing voices, podcasts, music, and other sounds.
+---
+
+import {ElementLibrary} from '@site/src/components/Elements/ElementLibrary';
+
+# Audio
+
+<ElementLibrary category="audio" />
diff --git a/packages/docs/elements/audio/mirrored-spectrum/index.mdx b/packages/docs/elements/audio/mirrored-spectrum/index.mdx
new file mode 100644
index 0000000000..259e3db7f9
--- /dev/null
+++ b/packages/docs/elements/audio/mirrored-spectrum/index.mdx
@@ -0,0 +1,12 @@
+---
+title: Mirrored Audio Spectrum
+description: A mirrored frequency spectrum that works well for visualizing voices and podcasts.
+image: /elements/audio-mirrored-spectrum-preview.png
+---
+
+import {ElementPage} from '@site/src/components/Elements/ElementPage';
+import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+
+# Mirrored Audio Spectrum
+
+<ElementPage definition={elementDefinitions['audio/mirrored-spectrum']} sourceFile="./mirrored-spectrum.tsx" />
diff --git a/packages/docs/elements/audio/mirrored-spectrum/mirrored-spectrum.tsx b/packages/docs/elements/audio/mirrored-spectrum/mirrored-spectrum.tsx
new file mode 100644
index 0000000000..9e13a85e0e
--- /dev/null
+++ b/packages/docs/elements/audio/mirrored-spectrum/mirrored-spectrum.tsx
@@ -0,0 +1,174 @@
+import {Audio} from '@remotion/media';
+import {useWindowedAudioData, visualizeAudio} from '@remotion/media-utils';
+import React, {forwardRef, useImperativeHandle, useRef} from 'react';
+import {
+ Interactive,
+ Sequence,
+ useCurrentFrame,
+ useVideoConfig,
+ type InteractiveBaseProps,
+ type InteractiveTransformProps,
+ type InteractivitySchema,
+ type SequenceControls,
+} from 'remotion';
+
+type MirroredAudioSpectrumProps = InteractiveBaseProps &
+ InteractiveTransformProps & {
+ readonly audioSrc?: string;
+ readonly barColor?: string;
+ readonly numberOfBars?: number;
+ };
+
+const mirroredAudioSpectrumSchema = {
+ ...Interactive.baseSchema,
+ audioSrc: {
+ type: 'asset',
+ default:
+ 'https://remotion.media/elements/remotion-made-this-picture-move.mp3',
+ description: 'Audio source',
+ },
+ barColor: {
+ type: 'color',
+ default: '#f4b941',
+ description: 'Bar color',
+ },
+ numberOfBars: {
+ type: 'number',
+ min: 3,
+ max: 127,
+ step: 2,
+ default: 65,
+ description: 'Number of bars',
+ hiddenFromList: false,
+ keyframable: false,
+ },
+ ...Interactive.transformSchema,
+} as const satisfies InteractivitySchema;
+
+const MirroredAudioSpectrumContent: React.FC<{
+ readonly audioSrc: string;
+ readonly barColor: string;
+ readonly numberOfBars: number;
+ readonly outlineRef: React.RefObject<HTMLDivElement | null>;
+ readonly style: MirroredAudioSpectrumProps['style'];
+}> = ({audioSrc, barColor, numberOfBars, outlineRef, style}) => {
+ const frame = useCurrentFrame();
+ const {fps} = useVideoConfig();
+ const {audioData, dataOffsetInSeconds} = useWindowedAudioData({
+ fps,
+ frame,
+ src: audioSrc,
+ windowInSeconds: 10,
+ });
+ const roundedNumberOfBars = Math.max(
+ 3,
+ Math.min(127, Math.round(numberOfBars)),
+ );
+ const numberOfFrequencies = Math.ceil(roundedNumberOfBars / 2);
+ const frequencyData = audioData
+ ? visualizeAudio({
+ audioData,
+ dataOffsetInSeconds,
+ fps,
+ frame,
+ numberOfSamples: 256,
+ optimizeFor: 'speed',
+ })
+ : [];
+ const frequencyDataSubset = frequencyData.slice(0, numberOfFrequencies);
+ const frequenciesToDisplay = [
+ ...frequencyDataSubset.slice(roundedNumberOfBars % 2).reverse(),
+ ...frequencyDataSubset,
+ ];
+
+ return (
+ <div
+ ref={outlineRef}
+ style={{
+ alignItems: 'center',
+ boxSizing: 'border-box',
+ display: 'flex',
+ gap: 8,
+ height: 300,
+ justifyContent: 'center',
+ width: 900,
+ ...style,
+ }}
+ >
+ <Audio showInTimeline={false} src={audioSrc} />
+ {frequenciesToDisplay.map((value, index) => (
+ <div
+ key={index}
+ style={{
+ backgroundColor: barColor,
+ borderRadius: 999,
+ flex: 1,
+ height: Math.max(4, 300 * Math.sqrt(value)),
+ minWidth: 2,
+ }}
+ />
+ ))}
+ </div>
+ );
+};
+
+const MirroredAudioSpectrumInner = forwardRef<
+ HTMLDivElement,
+ MirroredAudioSpectrumProps & {readonly controls: SequenceControls | undefined}
+>(
+ (
+ {
+ audioSrc = 'https://remotion.media/elements/remotion-made-this-picture-move.mp3',
+ barColor = '#f4b941',
+ controls,
+ name,
+ numberOfBars = 65,
+ style,
+ ...sequenceProps
+ },
+ ref,
+ ) => {
+ const outlineRef = useRef<HTMLDivElement>(null);
+ useImperativeHandle(ref, () => outlineRef.current as HTMLDivElement, []);
+
+ return (
+ <Sequence
+ layout="none"
+ {...sequenceProps}
+ controls={controls}
+ name={name ?? '<MirroredAudioSpectrum>'}
+ outlineRef={outlineRef}
+ >
+ <MirroredAudioSpectrumContent
+ audioSrc={audioSrc}
+ barColor={barColor}
+ numberOfBars={numberOfBars}
+ outlineRef={outlineRef}
+ style={style}
+ />
+ </Sequence>
+ );
+ },
+);
+
+const InteractiveMirroredAudioSpectrum = Interactive.withSchema({
+ Component: MirroredAudioSpectrumInner,
+ componentName: '<MirroredAudioSpectrum>',
+ componentIdentity: null,
+ schema: mirroredAudioSpectrumSchema,
+ supportsEffects: false,
+}) as React.FC<MirroredAudioSpectrumProps>;
+
+export const MirroredAudioSpectrum: React.FC<MirroredAudioSpectrumProps> = (
+ props,
+) => {
+ return (
+ <InteractiveMirroredAudioSpectrum
+ audioSrc="https://remotion.media/elements/remotion-made-this-picture-move.mp3"
+ barColor="#f4b941"
+ name="Mirrored audio spectrum"
+ numberOfBars={65}
+ {...props}
+ />
+ );
+};
diff --git a/packages/docs/src/components/Elements/element-definitions.ts b/packages/docs/src/components/Elements/element-definitions.ts
index 4248f46a6a..798b2d3d92 100644
--- a/packages/docs/src/components/Elements/element-definitions.ts
+++ b/packages/docs/src/components/Elements/element-definitions.ts
@@ -3,6 +3,7 @@ import type {
ElementInstallationMode,
} from '@remotion/studio-protocol';
import type {ComponentType} from 'react';
+import {MirroredAudioSpectrum} from '../../../elements/audio/mirrored-spectrum/mirrored-spectrum';
import {LiquidContours} from '../../../elements/backgrounds/liquid-contours/liquid-contours';
import {NotebookPaper} from '../../../elements/backgrounds/notebook-paper/notebook-paper';
import {PaperTexture} from '../../../elements/backgrounds/paper-texture/paper-texture';
@@ -69,6 +70,29 @@ export type ElementDefinition = {
};
const elementImplementations = {
+ 'audio/mirrored-spectrum': {
+ component: MirroredAudioSpectrum,
+ contributors: [{username: 'JonnyBurger', contribution: 'Author'}],
+ description:
+ 'A mirrored frequency spectrum that works well for visualizing voices and podcasts.',
+ dependencies: [
+ {name: '@remotion/media', version: null},
+ {name: '@remotion/media-utils', version: null},
+ ],
+ durationInFrames: 271,
+ elementHeight: 300,
+ elementWidth: 900,
+ fps: 30,
+ height: 1080,
+ posterFrame: 105,
+ preview: {
+ posterUrl: '/elements/audio-mirrored-spectrum-preview.png',
+ videoUrl: '/elements/audio-mirrored-spectrum-preview.mp4',
+ },
+ safeArea: 120,
+ installationMode: 'component-owned-sequence',
+ width: 1920,
+ },
'backgrounds/liquid-contours': {
component: LiquidContours,
contributors: [],
diff --git a/packages/docs/src/components/Elements/element-registry.ts b/packages/docs/src/components/Elements/element-registry.ts
index 3bfd81b7f5..544b20673d 100644
--- a/packages/docs/src/components/Elements/element-registry.ts
+++ b/packages/docs/src/components/Elements/element-registry.ts
@@ -1,4 +1,5 @@
export const elementCategories = [
+ {category: 'audio', label: 'Audio'},
{category: 'backgrounds', label: 'Backgrounds'},
{category: 'captions', label: 'Captions'},
{category: 'data', label: 'Charts & Data'},
@@ -13,6 +14,10 @@ export const elementCategories = [
export type ElementCategory = (typeof elementCategories)[number]['category'];
export const elementRegistry = {
+ 'audio/mirrored-spectrum': {
+ category: 'audio',
+ displayName: 'Mirrored Audio Spectrum',
+ },
'backgrounds/liquid-contours': {
category: 'backgrounds',
displayName: 'Liquid Contours',
diff --git a/packages/docs/src/test/elements.test.ts b/packages/docs/src/test/elements.test.ts
index 9dafef68fc..a841891432 100644
--- a/packages/docs/src/test/elements.test.ts
+++ b/packages/docs/src/test/elements.test.ts
@@ -502,6 +502,11 @@ describe('Elements sidebar', () => {
const categories = elementsCategory.items.slice(3);
const expectedCategories = [
+ {
+ category: 'audio',
+ label: 'Audio',
+ items: ['audio/mirrored-spectrum/index'],
+ },
{
category: 'backgrounds',
label: 'Backgrounds',
@@ -655,6 +660,7 @@ describe('Element preview definitions', () => {
test('only Elements with one interactive timeline item own their Sequence', () => {
const componentOwnedSequenceSlugs = new Set([
+ 'audio/mirrored-spectrum',
'captions/moving-pill-captions',
'captions/popping-word-captions',
'captions/word-highlight-captions',
diff --git a/packages/docs/static/elements/audio-mirrored-spectrum-preview.mp4 b/packages/docs/static/elements/audio-mirrored-spectrum-preview.mp4
new file mode 100644
index 0000000000..bad692de26
Binary files /dev/null and b/packages/docs/static/elements/audio-mirrored-spectrum-preview.mp4 differ
diff --git a/packages/docs/static/elements/audio-mirrored-spectrum-preview.png b/packages/docs/static/elements/audio-mirrored-spectrum-preview.png
new file mode 100644
index 0000000000..87996e6892
Binary files /dev/null and b/packages/docs/static/elements/audio-mirrored-spectrum-preview.png differ