Visualize Your Ideas With Code
refactor: use auto meta fields in video settings (#566)
Jacob5eb4db1f3c6c
diff --git a/packages/core/src/app/ImageExporter.ts b/packages/core/src/app/ImageExporter.tsindex e364d0bf..cdf6b234 100644--- a/packages/core/src/app/ImageExporter.ts+++ b/packages/core/src/app/ImageExporter.ts@@ -2,6 +2,7 @@ import {CanvasOutputMimeType} from '../types';import {Exporter} from './Exporter';import {Logger} from './Logger';import {RendererSettings} from './Renderer';+import {clamp} from '../tweening';const EXPORT_FRAME_LIMIT = 256;const EXPORT_RETRY_DELAY = 1000;@@ -27,7 +28,7 @@ export class ImageExporter implements Exporter {public async configure(settings: RendererSettings) {this.projectName = settings.name;- this.quality = settings.quality;+ this.quality = clamp(0, 1, settings.quality / 100);this.fileType = settings.fileType;this.groupByScene = settings.groupByScene;}diff --git a/packages/core/src/app/ProjectMetadata.ts b/packages/core/src/app/ProjectMetadata.tsindex 5ad861cf..a69c2ee0 100644--- a/packages/core/src/app/ProjectMetadata.ts+++ b/packages/core/src/app/ProjectMetadata.ts@@ -1,41 +1,53 @@import {+ BoolMetaField,ColorMetaField,+ EnumMetaField,MetaField,+ NumberMetaField,ObjectMetaField,RangeMetaField,Vector2MetaField,} from '../meta';import {CanvasColorSpace, Color, CanvasOutputMimeType, Vector2} from '../types';+import {ColorSpaces, FileTypes, FrameRates, Scales} from './presets';+import type {Project} from './Project';-function createProjectMetadata() {- return {+function createProjectMetadata(project: Project) {+ const meta = {version: new MetaField('version', 1),- shared: new ObjectMetaField('shared', {+ shared: new ObjectMetaField('General', {background: new ColorMetaField('background', null),range: new RangeMetaField('range', [0, Infinity]),- size: new Vector2MetaField('size', new Vector2(1920, 1080)),- audioOffset: new MetaField('audioOffset', 0),+ size: new Vector2MetaField('resolution', new Vector2(1920, 1080)),+ audioOffset: new NumberMetaField('audio offset', 0),}),- preview: new ObjectMetaField('preview', {- fps: new MetaField('fps', 30),- resolutionScale: new MetaField('scale', 1),+ preview: new ObjectMetaField('Preview', {+ fps: new NumberMetaField('frame rate', 30).setPresets(FrameRates),+ resolutionScale: new EnumMetaField('scale', Scales, 1),}),- rendering: new ObjectMetaField('rendering', {- fps: new MetaField('fps', 60),- resolutionScale: new MetaField('scale', 2),- colorSpace: new MetaField('color space', 'srgb' as CanvasColorSpace),- fileType: new MetaField('file type', 'image/png' as CanvasOutputMimeType),- quality: new MetaField('quality', 1),- groupByScene: new MetaField('group by scene', false),+ rendering: new ObjectMetaField('Rendering', {+ fps: new NumberMetaField('frame rate', 60).setPresets(FrameRates),+ resolutionScale: new EnumMetaField('scale', Scales, 1),+ colorSpace: new EnumMetaField('color space', ColorSpaces),+ fileType: new EnumMetaField('file type', FileTypes),+ quality: new NumberMetaField('quality (%)', 100).setRange(0, 100),+ groupByScene: new BoolMetaField('group by scene', false),}),};++ meta.shared.audioOffset.disable(!project.audio);+ meta.rendering.fileType.onChanged.subscribe(value => {+ meta.rendering.quality.disable(value === 'image/png');+ });++ return meta;}export class ProjectMetadata extends ObjectMetaField<ReturnType<typeof createProjectMetadata>> {- public constructor() {- super('project', createProjectMetadata());+ public constructor(project: Project) {+ super('project', createProjectMetadata(project));}public getFullPreviewSettings(): {diff --git a/packages/core/src/app/presets.ts b/packages/core/src/app/presets.tsnew file mode 100644index 00000000..4f16ac41--- /dev/null+++ b/packages/core/src/app/presets.ts@@ -0,0 +1,25 @@+import {CanvasColorSpace, CanvasOutputMimeType} from '../types';+import {MetaOption} from '../meta';++export const Scales: MetaOption<number>[] = [+ {value: 0.25, text: '0.25x (Quarter)'},+ {value: 0.5, text: `0.5x (Half)`},+ {value: 1, text: `1.0x (Full)`},+ {value: 2, text: `2.0x (Double)`},+];++export const ColorSpaces: MetaOption<CanvasColorSpace>[] = [+ {value: 'srgb', text: 'sRGB'},+ {value: 'display-p3', text: 'DCI-P3'},+];++export const FileTypes: MetaOption<CanvasOutputMimeType>[] = [+ {value: 'image/png', text: 'png'},+ {value: 'image/jpeg', text: 'jpeg'},+ {value: 'image/webp', text: 'webp'},+];++export const FrameRates: MetaOption<number>[] = [+ {value: 30, text: '30 FPS'},+ {value: 60, text: '60 FPS'},+];diff --git a/packages/core/src/meta/MetaField.ts b/packages/core/src/meta/MetaField.tsindex 2c4c0c25..11557366 100644--- a/packages/core/src/meta/MetaField.ts+++ b/packages/core/src/meta/MetaField.ts@@ -27,6 +27,17 @@ export class MetaField<protected readonly value: ValueDispatcher<TValue>;+ /**+ * Triggered when the field becomes disabled or enabled.+ *+ * @eventProperty+ */+ public get onDisabled() {+ return this.disabled.subscribable;+ }++ protected readonly disabled = new ValueDispatcher(false);+/*** @param name - The name of this field displayed in the editor.* @param value - The initial value of this field.@@ -73,4 +84,13 @@ export class MetaField<public clone(): this {return new (<any>this.constructor)(this.name, this.get());}++ /**+ * Disable or enable the field in the editor.+ *+ * @param value - Whether the field should be disabled.+ */+ public disable(value = true) {+ this.disabled.current = value;+ }}diff --git a/packages/core/src/meta/NumberMetaField.ts b/packages/core/src/meta/NumberMetaField.tsindex c6b05288..335ba89c 100644--- a/packages/core/src/meta/NumberMetaField.ts+++ b/packages/core/src/meta/NumberMetaField.ts@@ -7,9 +7,19 @@ import {MetaOption} from './MetaOption';export class NumberMetaField extends MetaField<any, number> {public readonly type = Number;protected presets: MetaOption<number>[] = [];+ protected min?: number;+ protected max?: number;public parse(value: any): number {- return parseFloat(value);+ let parsed = parseFloat(value);+ if (this.min !== undefined && parsed < this.min) {+ parsed = this.min;+ }+ if (this.max !== undefined && parsed > this.max) {+ parsed = this.max;+ }++ return parsed;}public getPresets() {@@ -20,4 +30,10 @@ export class NumberMetaField extends MetaField<any, number> {this.presets = options;return this;}++ public setRange(min?: number, max?: number): this {+ this.min = min;+ this.max = max;+ return this;+ }}diff --git a/packages/core/src/meta/RangeMetaField.ts b/packages/core/src/meta/RangeMetaField.tsindex ca7a2a00..ad53edcf 100644--- a/packages/core/src/meta/RangeMetaField.ts+++ b/packages/core/src/meta/RangeMetaField.ts@@ -13,6 +13,11 @@ export class RangeMetaField extends MetaField<[number, number | null],[number, number]> {+ public static readonly symbol = Symbol.for(+ '@motion-canvas/core/meta/RangeMetaField',+ );+ public readonly type = RangeMetaField.symbol;+public override parse(value: [number, number | null]): [number, number] {return this.parseRange(Infinity, value[0], value[1] ?? Infinity);}diff --git a/packages/ui/src/components/meta/MetaFieldView.tsx b/packages/ui/src/components/meta/MetaFieldView.tsxindex b84dda88..5c6a3bbd 100644--- a/packages/ui/src/components/meta/MetaFieldView.tsx+++ b/packages/ui/src/components/meta/MetaFieldView.tsx@@ -5,10 +5,13 @@ import {StringMetaFieldView} from './StringMetaFieldView';import {BoolMetaFieldView} from './BoolMetaFieldView';import {ObjectMetaFieldView} from './ObjectMetaFieldView';import {EnumMetaFieldView} from './EnumMetaFieldView';-import {EnumMetaField} from '@motion-canvas/core/lib/meta';-import {Color, Vector2} from '@motion-canvas/core/lib/types';import {ColorMetaFieldView} from './ColorMetaFieldView';import {Vector2MetaFieldView} from './Vector2MetaFieldView';+import {UnknownMetaFieldView} from './UnknownMetaFieldView';+import {RangeMetaFieldView} from './RangeMetaFieldView';+import {EnumMetaField, RangeMetaField} from '@motion-canvas/core/lib/meta';+import {Color, Vector2} from '@motion-canvas/core/lib/types';+import {useSubscribableValue} from '../../hooks';interface MetaFieldViewProps {field: MetaField<any>;@@ -23,11 +26,13 @@ const TYPE_MAP = new Map<any, FiledView>([[EnumMetaField.symbol, EnumMetaFieldView],[Color.symbol, ColorMetaFieldView],[Vector2.symbol, Vector2MetaFieldView],+ [RangeMetaField.symbol, RangeMetaFieldView],[Object, ObjectMetaFieldView],]);export function MetaFieldView({field}: MetaFieldViewProps) {- const Field: FiledView = TYPE_MAP.get(field.type) ?? StringMetaFieldView;+ const Field: FiledView = TYPE_MAP.get(field.type) ?? UnknownMetaFieldView;+ const disabled = useSubscribableValue(field.onDisabled);- return <Field field={field} />;+ return disabled ? <></> : <Field field={field} />;}diff --git a/packages/ui/src/components/meta/NumberMetaFieldView.tsx b/packages/ui/src/components/meta/NumberMetaFieldView.tsxindex 04831bbe..8197419f 100644--- a/packages/ui/src/components/meta/NumberMetaFieldView.tsx+++ b/packages/ui/src/components/meta/NumberMetaFieldView.tsx@@ -15,6 +15,7 @@ export function NumberMetaFieldView({field}: NumberMetaFieldViewProps) {<Label>{field.name}</Label>{presets.length ? (<InputSelect+ type="number"value={value}onChange={value => {field.set(value);@@ -24,8 +25,6 @@ export function NumberMetaFieldView({field}: NumberMetaFieldViewProps) {) : (<Inputtype="number"- min={0}- max={100}value={value}onChange={event => {field.set((event.target as HTMLInputElement).value);diff --git a/packages/ui/src/components/meta/ObjectMetaFieldView.tsx b/packages/ui/src/components/meta/ObjectMetaFieldView.tsxindex c96a05e0..53d79a88 100644--- a/packages/ui/src/components/meta/ObjectMetaFieldView.tsx+++ b/packages/ui/src/components/meta/ObjectMetaFieldView.tsx@@ -1,7 +1,5 @@-import {Group, Label} from '../controls';import type {ObjectMetaField} from '@motion-canvas/core/lib/meta';import {MetaFieldView} from './MetaFieldView';-import {Separator} from '../controls/Separator';export interface ObjectMetaFieldViewProps {field: ObjectMetaField<any>;@@ -10,10 +8,6 @@ export interface ObjectMetaFieldViewProps {export function ObjectMetaFieldView({field}: ObjectMetaFieldViewProps) {return (<>- <Group>- <Label />- <Separator>{field.name}</Separator>- </Group>{[...field].map(subfield => (<MetaFieldView field={subfield} />))}diff --git a/packages/ui/src/components/meta/RangeMetaFieldView.tsx b/packages/ui/src/components/meta/RangeMetaFieldView.tsxnew file mode 100644index 00000000..f5acfae9--- /dev/null+++ b/packages/ui/src/components/meta/RangeMetaFieldView.tsx@@ -0,0 +1,56 @@+import {Group, Input, Label} from '../controls';+import type {RangeMetaField} from '@motion-canvas/core/lib/meta';+import {useApplication} from '../../contexts';+import {+ useDuration,+ usePreviewSettings,+ useSubscribableValue,+} from '../../hooks';++export interface RangeMetaFieldViewProps {+ field: RangeMetaField;+}++export function RangeMetaFieldView({field}: RangeMetaFieldViewProps) {+ const {player} = useApplication();+ const duration = useDuration();+ const range = useSubscribableValue(field.onChanged);+ // We use the preview framerate for all editing purposes.+ const {fps} = usePreviewSettings();++ const startFrame = player.status.secondsToFrames(range[0]);+ const endFrame = player.status.secondsToFrames(range[1]);++ return (+ <Group>+ <Label>{field.name}</Label>+ <Input+ min={0}+ max={endFrame}+ type={'number'}+ value={startFrame}+ onChange={event => {+ let start = parseInt((event.target as HTMLInputElement).value);+ if (isNaN(start)) {+ start = 0;+ }+ field.update(start, endFrame, duration, fps);+ }}+ />+ <Input+ min={startFrame}+ max={duration}+ type={'number'}+ placeholder="end"+ value={endFrame >= Infinity ? '' : endFrame}+ onChange={event => {+ let end = parseInt((event.target as HTMLInputElement).value);+ if (isNaN(end)) {+ end = Infinity;+ }+ field.update(startFrame, end, duration, fps);+ }}+ />+ </Group>+ );+}diff --git a/packages/ui/src/components/meta/UnknownMetaFieldView.tsx b/packages/ui/src/components/meta/UnknownMetaFieldView.tsxnew file mode 100644index 00000000..a2bb48b0--- /dev/null+++ b/packages/ui/src/components/meta/UnknownMetaFieldView.tsx@@ -0,0 +1,13 @@+import {useSubscribableValue} from '../../hooks';+import {MetaField} from '@motion-canvas/core/lib/meta';+import {AutoField} from '../fields';++export interface UnknownMetaFieldViewProps {+ field: MetaField<any>;+}++export function UnknownMetaFieldView({field}: UnknownMetaFieldViewProps) {+ const value = useSubscribableValue(field.onChanged);++ return <AutoField label={field.name} value={value} />;+}diff --git a/packages/ui/src/components/meta/index.ts b/packages/ui/src/components/meta/index.tsindex 7fd7918d..b95acd30 100644--- a/packages/ui/src/components/meta/index.ts+++ b/packages/ui/src/components/meta/index.ts@@ -4,5 +4,7 @@ export * from './EnumMetaFieldView';export * from './MetaFieldView';export * from './NumberMetaFieldView';export * from './ObjectMetaFieldView';+export * from './RangeMetaFieldView';export * from './StringMetaFieldView';+export * from './UnknownMetaFieldView';export * from './Vector2MetaFieldView';diff --git a/packages/ui/src/components/settings/PreviewSettings.tsx b/packages/ui/src/components/settings/PreviewSettings.tsxdeleted file mode 100644index cb131eeb..00000000--- a/packages/ui/src/components/settings/PreviewSettings.tsx+++ /dev/null@@ -1,34 +0,0 @@-import {usePreviewSettings} from '../../hooks';-import {Group, InputSelect, Label, Select} from '../controls';-import {useApplication} from '../../contexts';-import {FrameRates, Scales} from './options';--export function PreviewSettings() {- const {meta} = useApplication();- const state = usePreviewSettings();-- return (- <>- <Group>- <Label>frame rate</Label>- <InputSelect- type="number"- min={1}- value={state.fps.toString()}- onChange={value => {- meta.preview.fps.set(parseInt(value));- }}- options={FrameRates}- />- </Group>- <Group>- <Label>scale</Label>- <Select- options={Scales}- value={state.resolutionScale}- onChange={value => meta.preview.resolutionScale.set(value)}- />- </Group>- </>- );-}diff --git a/packages/ui/src/components/settings/RenderingSettings.tsx b/packages/ui/src/components/settings/RenderingSettings.tsxdeleted file mode 100644index 0981e4df..00000000--- a/packages/ui/src/components/settings/RenderingSettings.tsx+++ /dev/null@@ -1,83 +0,0 @@-import {useRenderingSettings} from '../../hooks';-import {Checkbox, Group, Input, InputSelect, Label, Select} from '../controls';-import {useApplication} from '../../contexts';-import type {- CanvasColorSpace,- CanvasOutputMimeType,-} from '@motion-canvas/core/lib/types';-import {ColorSpaces, FileTypes, FrameRates, Scales} from './options';--export function RenderingSettings() {- const {meta} = useApplication();- const state = useRenderingSettings();-- return (- <>- <Group>- <Label>frame rate</Label>- <InputSelect- type="number"- min={1}- value={state.fps.toString()}- onChange={value => {- meta.rendering.fps.set(parseInt(value));- }}- options={FrameRates}- />- </Group>- <Group>- <Label>scale</Label>- <Select- options={Scales}- value={state.resolutionScale}- onChange={value => meta.rendering.resolutionScale.set(value)}- />- </Group>- <Group>- <Label>color space</Label>- <Select- options={ColorSpaces}- value={state.colorSpace}- onChange={value =>- meta.rendering.colorSpace.set(value as CanvasColorSpace)- }- />- </Group>- <Group>- <Label>file type</Label>- <Select- options={FileTypes}- value={state.fileType}- onChange={value =>- meta.rendering.fileType.set(value as CanvasOutputMimeType)- }- />- </Group>- {state.fileType !== 'image/png' && (- <Group>- <Label>quality (%)</Label>- <Input- type="number"- min={0}- max={100}- value={state.quality * 100}- onChange={event => {- meta.rendering.quality.set(- parseFloat((event.target as HTMLInputElement).value) / 100,- );- }}- />- </Group>- )}- <Group>- <Label>group by scene</Label>- <Checkbox- checked={state.groupByScene}- onChange={() => {- meta.rendering.groupByScene.set(!state.groupByScene);- }}- />- </Group>- </>- );-}diff --git a/packages/ui/src/components/settings/SharedSettings.tsx b/packages/ui/src/components/settings/SharedSettings.tsxdeleted file mode 100644index 479a0987..00000000--- a/packages/ui/src/components/settings/SharedSettings.tsx+++ /dev/null@@ -1,100 +0,0 @@-import {useApplication} from '../../contexts';-import {useDuration, usePreviewSettings, useSharedSettings} from '../../hooks';-import {ColorInput, Group, Input, Label} from '../controls';-import {Add} from '../icons';-import styles from '../sidebar/Sidebar.module.scss';--export function SharedSettings() {- const {player, project, meta} = useApplication();- const duration = useDuration();- const state = useSharedSettings();- // We use the preview framerate for all editing purposes.- const {fps} = usePreviewSettings();-- const startFrame = player.status.secondsToFrames(state.range[0]);- const endFrame = player.status.secondsToFrames(state.range[1]);-- return (- <>- <Group>- <Label>background</Label>- <ColorInput- value={state.background}- onChange={value => {- meta.shared.background.set(value ? value : null);- }}- />- </Group>- <Group>- <Label>range</Label>- <Input- min={0}- max={endFrame}- type={'number'}- value={startFrame}- onChange={event => {- let start = parseInt((event.target as HTMLInputElement).value);- if (isNaN(start)) {- start = 0;- }- meta.shared.range.update(start, endFrame, duration, fps);- }}- />- <Input- min={startFrame}- max={duration}- type={'number'}- placeholder="end"- value={endFrame >= Infinity ? '' : endFrame}- onChange={event => {- let end = parseInt((event.target as HTMLInputElement).value);- if (isNaN(end)) {- end = Infinity;- }- meta.shared.range.update(startFrame, end, duration, fps);- }}- />- </Group>- <Group>- <Label>resolution</Label>- <Input- type="number"- min={1}- value={state.size.width}- onChange={event => {- const value = parseInt((event.target as HTMLInputElement).value);- meta.shared.size.set([value, state.size.height]);- }}- />- <Add className={styles.times} />- <Input- type="number"- min={1}- value={state.size.height}- onChange={event => {- const value = parseInt((event.target as HTMLInputElement).value);- meta.shared.size.set([state.size.width, value]);- }}- />- </Group>{' '}- {project.audio && (- <Group>- <Label>audio offset</Label>- <Input- type={'number'}- value={state.audioOffset.toFixed(4)}- onChange={event => {- let audioOffset = parseFloat(- (event.target as HTMLInputElement).value,- );- if (isNaN(audioOffset)) {- audioOffset = 0;- }- meta.shared.audioOffset.set(audioOffset);- }}- />- </Group>- )}- </>- );-}diff --git a/packages/ui/src/components/settings/index.ts b/packages/ui/src/components/settings/index.tsdeleted file mode 100644index 9596477c..00000000--- a/packages/ui/src/components/settings/index.ts+++ /dev/null@@ -1,3 +0,0 @@-export * from './PreviewSettings';-export * from './RenderingSettings';-export * from './SharedSettings';diff --git a/packages/ui/src/components/settings/options.ts b/packages/ui/src/components/settings/options.tsdeleted file mode 100644index 96cb9c21..00000000--- a/packages/ui/src/components/settings/options.ts+++ /dev/null@@ -1,22 +0,0 @@-export const Scales = [- {value: 0.25, text: '0.25x (Quarter)'},- {value: 0.5, text: `0.5x (Half)`},- {value: 1, text: `1.0x (Full)`},- {value: 2, text: `2.0x (Double)`},-];--export const ColorSpaces = [- {value: 'srgb', text: 'sRGB'},- {value: 'display-p3', text: 'DCI-P3'},-];--export const FileTypes = [- {value: 'image/png', text: 'png'},- {value: 'image/jpeg', text: 'jpeg'},- {value: 'image/webp', text: 'webp'},-];--export const FrameRates = [- {value: '30', text: '30 FPS'},- {value: '60', text: '60 FPS'},-];diff --git a/packages/ui/src/components/sidebar/VideoSettings.tsx b/packages/ui/src/components/sidebar/VideoSettings.tsxindex 98a90d58..462776b6 100644--- a/packages/ui/src/components/sidebar/VideoSettings.tsx+++ b/packages/ui/src/components/sidebar/VideoSettings.tsx@@ -2,21 +2,23 @@ import {usePresenterState, useRendererState, useStorage} from '../../hooks';import {ButtonSelect, Group, Label} from '../controls';import {Pane} from '../tabs';import {useApplication} from '../../contexts';-import {PreviewSettings, RenderingSettings, SharedSettings} from '../settings';import {Expandable} from '../fields';import {PresenterState, RendererState} from '@motion-canvas/core';+import {MetaFieldView} from '../meta';export function VideoSettings() {+ const {meta} = useApplication();+return (<Pane title="Video Settings" id="settings-pane">- <Expandable title="General" open>- <SharedSettings />+ <Expandable title={meta.shared.name} open>+ <MetaFieldView field={meta.shared} /></Expandable>- <Expandable title="Preview">- <PreviewSettings />+ <Expandable title={meta.preview.name}>+ <MetaFieldView field={meta.preview} /></Expandable>- <Expandable title="Rendering">- <RenderingSettings />+ <Expandable title={meta.rendering.name}>+ <MetaFieldView field={meta.rendering} /></Expandable><Group><Label />