Skip to content

Visualize Your Ideas With Code

feat: add option to group output by scenes (#477)

misclicl99345937e7ac
diff --git a/packages/core/src/app/Exporter.ts b/packages/core/src/app/Exporter.ts
index fcdbaed6..013dd2be 100644
--- a/packages/core/src/app/Exporter.ts
+++ b/packages/core/src/app/Exporter.ts
@@ -35,11 +35,15 @@ export interface Exporter {
*
* @param canvas - A canvas containing the rendered frame.
* @param frame - The frame number.
+ * @param sceneFrame - The frame number within the scene.
+ * @param sceneName - The name of the scene with which the frame is associated.
* @param signal - An abort signal triggered if the user aborts the rendering.
*/
handleFrame(
canvas: HTMLCanvasElement,
frame: number,
+ sceneFrame: number,
+ sceneName: string,
signal: AbortSignal,
): Promise<void>;
diff --git a/packages/core/src/app/ImageExporter.ts b/packages/core/src/app/ImageExporter.ts
index 02a856fa..e364d0bf 100644
--- a/packages/core/src/app/ImageExporter.ts
+++ b/packages/core/src/app/ImageExporter.ts
@@ -1,7 +1,7 @@
-import type {RendererSettings} from './Renderer';
-import type {Exporter} from './Exporter';
-import type {Logger} from './Logger';
-import type {CanvasOutputMimeType} from '../types';
+import {CanvasOutputMimeType} from '../types';
+import {Exporter} from './Exporter';
+import {Logger} from './Logger';
+import {RendererSettings} from './Renderer';
const EXPORT_FRAME_LIMIT = 256;
const EXPORT_RETRY_DELAY = 1000;
@@ -12,9 +12,10 @@ const EXPORT_RETRY_DELAY = 1000;
export class ImageExporter implements Exporter {
private readonly frameLookup = new Map<number, Callback>();
private frameCounter = 0;
- private name = 'unknown';
+ private projectName = 'unknown';
private quality = 1;
private fileType: CanvasOutputMimeType = 'image/png';
+ private groupByScene = false;
public constructor(private readonly logger: Logger) {
if (import.meta.hot) {
@@ -25,9 +26,10 @@ export class ImageExporter implements Exporter {
}
public async configure(settings: RendererSettings) {
- this.name = settings.name;
+ this.projectName = settings.name;
this.quality = settings.quality;
this.fileType = settings.fileType;
+ this.groupByScene = settings.groupByScene;
}
public async start() {
@@ -37,6 +39,8 @@ export class ImageExporter implements Exporter {
public async handleFrame(
canvas: HTMLCanvasElement,
frame: number,
+ sceneFrame: number,
+ sceneName: string,
signal: AbortSignal,
) {
if (this.frameLookup.has(frame)) {
@@ -56,12 +60,16 @@ export class ImageExporter implements Exporter {
this.frameCounter--;
this.frameLookup.delete(frame);
});
+
import.meta.hot!.send('motion-canvas:export', {
frame,
- isStill: false,
+ sceneFrame,
data: canvas.toDataURL(this.fileType, this.quality),
mimeType: this.fileType,
- project: this.name,
+ subDirectories: this.groupByScene
+ ? [this.projectName, sceneName]
+ : [this.projectName],
+ groupByScene: this.groupByScene,
});
}
}
diff --git a/packages/core/src/app/ProjectMetadata.ts b/packages/core/src/app/ProjectMetadata.ts
index 16eaa209..5ad861cf 100644
--- a/packages/core/src/app/ProjectMetadata.ts
+++ b/packages/core/src/app/ProjectMetadata.ts
@@ -26,6 +26,7 @@ function createProjectMetadata() {
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),
}),
};
}
@@ -61,6 +62,7 @@ export class ProjectMetadata extends ObjectMetaField<
range: [number, number];
size: Vector2;
audioOffset: number;
+ groupByScene: boolean;
} {
return {
...this.shared.get(),
diff --git a/packages/core/src/app/Renderer.ts b/packages/core/src/app/Renderer.ts
index fca1f2d0..885ad511 100644
--- a/packages/core/src/app/Renderer.ts
+++ b/packages/core/src/app/Renderer.ts
@@ -16,6 +16,7 @@ export interface RendererSettings extends StageSettings {
fps: number;
fileType: CanvasOutputMimeType;
quality: number;
+ groupByScene: boolean;
}
export enum RendererState {
@@ -142,15 +143,14 @@ export class Renderer {
);
if (import.meta.hot) {
- import.meta.hot!.send('motion-canvas:export', {
+ import.meta.hot.send('motion-canvas:export', {
frame,
- isStill: true,
data: this.stage.finalBuffer.toDataURL(
settings.fileType,
settings.quality,
),
mimeType: settings.fileType,
- project: this.project.name,
+ subDirectories: ['still', this.project.name],
});
}
} catch (e: any) {
@@ -172,6 +172,7 @@ export class Renderer {
const to = this.status.secondsToFrames(settings.range[1]);
await this.reloadScenes(settings);
+ await this.playback.recalculate();
if (signal.aborted) return RendererResult.Aborted;
await this.playback.reset();
if (signal.aborted) return RendererResult.Aborted;
@@ -232,9 +233,14 @@ export class Renderer {
this.playback.currentScene!,
this.playback.previousScene,
);
+
+ const sceneFrame =
+ this.playback.frame - this.playback.currentScene.firstFrame;
await this.exporter.handleFrame(
this.stage.finalBuffer,
this.playback.frame,
+ sceneFrame,
+ this.playback.currentScene.name,
signal,
);
}
diff --git a/packages/core/src/vite-env.d.ts b/packages/core/src/vite-env.d.ts
index fb307abd..f593cbb9 100644
--- a/packages/core/src/vite-env.d.ts
+++ b/packages/core/src/vite-env.d.ts
@@ -7,11 +7,12 @@ declare module 'vite/types/customEvent' {
'motion-canvas:meta': {source: string; data: any};
'motion-canvas:meta-ack': {source: string};
'motion-canvas:export': {
- frame: number;
data: string;
+ subDirectories: string[];
mimeType: string;
- project: string;
- isStill: boolean;
+ frame: number;
+ sceneFrame?: number;
+ groupByScene?: boolean;
};
'motion-canvas:export-ack': {frame: number};
'motion-canvas:assets': {urls: string[]};
diff --git a/packages/ui/src/components/settings/RenderingSettings.tsx b/packages/ui/src/components/settings/RenderingSettings.tsx
index 71fe10c4..83d13f88 100644
--- a/packages/ui/src/components/settings/RenderingSettings.tsx
+++ b/packages/ui/src/components/settings/RenderingSettings.tsx
@@ -69,6 +69,16 @@ export function RenderingSettings() {
/>
</Group>
)}
+ <Group>
+ <Label>group by scene</Label>
+ <Input
+ type="checkbox"
+ checked={state.groupByScene}
+ onChange={() => {
+ meta.rendering.groupByScene.set(!state.groupByScene);
+ }}
+ />
+ </Group>
</>
);
}
diff --git a/packages/vite-plugin/src/main.ts b/packages/vite-plugin/src/main.ts
index 839214a4..e6cbe6a4 100644
--- a/packages/vite-plugin/src/main.ts
+++ b/packages/vite-plugin/src/main.ts
@@ -345,20 +345,27 @@ export default ({
});
server.ws.on(
'motion-canvas:export',
- async ({frame, mimeType, data, project, isStill}, client) => {
+ async (
+ {data, frame, sceneFrame, subDirectories, mimeType, groupByScene},
+ client,
+ ) => {
+ const name = (groupByScene ? sceneFrame : frame)
+ .toString()
+ .padStart(6, '0');
const extension = mime.extension(mimeType);
- const name = frame.toString().padStart(6, '0') + '.' + extension;
- const file = isStill
- ? path.join(outputPath, 'still', project, name)
- : path.join(outputPath, project, name);
-
- const directory = path.dirname(file);
- if (!fs.existsSync(directory)) {
- fs.mkdirSync(directory, {recursive: true});
+ const outputFilePath = path.join(
+ outputPath,
+ ...subDirectories,
+ `${name}.${extension}`,
+ );
+ const outputDirectory = path.dirname(outputFilePath);
+
+ if (!fs.existsSync(outputDirectory)) {
+ fs.mkdirSync(outputDirectory, {recursive: true});
}
const base64Data = data.slice(data.indexOf(',') + 1);
- await fs.promises.writeFile(file, base64Data, {
+ await fs.promises.writeFile(outputFilePath, base64Data, {
encoding: 'base64',
});
client.send('motion-canvas:export-ack', {frame});