@makefully/dutifully 1.12.1 → 1.13.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.13.1
+
+- Harden `say` / ElevenLabs export when the result zip has no MP3 (clearer error, no unhandled ENOENT from ID3 metadata).
+
+## 1.13.0
+
+- Add `packfully` service client for packing images into texture atlases.
+
 ## 1.12.1
 
 - Preserve optional script-line `events` through Transcript for timed marker definitions.

package/README.md

@@ -40,7 +40,7 @@ cheerfully({
 });
 ```
 
-## Say (spoken notifications)
+### Say (spoken notifications)
 
 `say` generates short spoken phrases through Cheerfully's ElevenLabs service, caches the audio under `.cache/tts/`, and plays it locally via `node-web-audio-api`. Use it from npm scripts instead of wiring ElevenLabs into the consuming project:
 
@@ -109,6 +109,51 @@ This audio file process accepts ffmpeg commandline arguments to perform operatio
 }
 ```
 
+### Packfully
+
+This image-to-atlas service packs PNG/JPG/WebP sprites into texture atlases and downloads atlas PNG(s) plus descriptor file(s).
+
+```javascript
+{
+    "packfully": [{
+        "format": "texturepacker",
+        "src": "./example/sprites/",
+        "output": "./example/atlases/",
+        "options": {
+            "maxWidth": 2048,
+            "maxHeight": 2048,
+            "pot": true,
+            "smart": true,
+            "square": false,
+            "padding": 1,
+            "extrude": 1,
+            "border": 1,
+            "allowRotation": false,
+            "trim": true,
+            "trimThreshold": 0,
+            "prefix": "packed",
+            "scale": 1
+        },
+        "files": {
+            "hero.png": { "trim": false }
+        }
+    }]
+}
+```
+
+Use `exports: ["texturepacker", "createjs"]` (or `format`) to choose one or more atlas descriptors. Supported formats:
+
+* `texturepacker` / `json-hash` / `pixi` / `phaser-hash` — TexturePacker JSON Hash
+* `json-array` / `phaser-array` — TexturePacker JSON Array
+* `createjs` / `easeljs` — CreateJS SpriteSheet JSON
+* `spine` — Spine `.atlas` text
+* `css` — CSS sprite classes
+* `starling` / `sparrow` — Starling/Sparrow XML
+* `unity` — Unity-oriented JSON
+* `godot` — Godot atlas JSON
+
+Spacing: `padding` is empty gap beyond `extrude`; `extrude` is edge-pixel bleed into that gap; `border` is margin from the atlas edge.
+
 ### Polly
 
 This text-to-voice service requires a script as input and will download audio VO generated by Amazon Polly. You can set Polly settings in `cheerfully.json` like so:
@@ -215,7 +260,7 @@ Cheerfully resolves these against caption timings and exports them in parallel u
 
 ## Example
 
-Find an example script in the `./examples/` folder. You can run either `npm run test-elevenlabs` or `npm run test-polly` to create VO tracks in the examples folder that you can then use to try out `npm run test-rhubarb` and `npm run test-transcription`.
+Find an example script in the `./examples/` folder. You can run either `npm run test-elevenlabs` or `npm run test-polly` to create VO tracks in the examples folder that you can then use to try out `npm run test-rhubarb` and `npm run test-transcription`. Sample sprites for atlas packing are under `./example/sprites/`; run `npm run test-packfully` to pack them into `./example/atlases/`.
 
 These examples are specified using a JSON definition in `./cheerfully.json` which you can copy or modify to set different generation parameters as supported by Cheerfully.
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@makefully/dutifully",
-    "version": "1.12.1",
+    "version": "1.13.1",
     "description": "Client tools for Cheerfully service.",
     "main": "./src/index.js",
     "bin": {
@@ -19,6 +19,7 @@
         "test-allosaurus": "node ./cheer.js -service allosaurus",
         "test-elevenlabs": "node ./cheer.js -service elevenlabs",
         "test-ffmpeg": "node ./cheer.js -service ffmpeg",
+        "test-packfully": "node ./cheer.js -service packfully",
         "test-polly": "node ./cheer.js -service polly",
         "test-rasterize": "node ./cheer.js -service rasterize",
         "test-rhubarb": "node ./cheer.js -service rhubarb",
@@ -41,7 +42,10 @@
         "polly",
         "lipsync",
         "transcription",
-        "captions"
+        "captions",
+        "packfully",
+        "atlas",
+        "spritesheet"
     ],
     "author": "Derek Detweiler <derek@makefullystudios.com>",
     "contributors": [

package/src/classes/Packfully.js

@@ -0,0 +1,15 @@
+const
+    Cheer = require('./Cheer'),
+    Packfully = class Packfully extends Cheer {
+        beforeSend (archive) {
+            const
+                {src} = this.config;
+
+            if (src) {
+                archive.directory(src, false);
+            }
+            super.beforeSend(archive);
+        }
+    };
+
+module.exports = Packfully;

package/src/classes/TextToSpeech.js

@@ -82,8 +82,12 @@ const
             await ensureDir(output);
         }
 
-        Object.keys(captions).forEach(async (id) => {
+        const
+            ids = Object.keys(captions);
+
+        for (let i = 0; i < ids.length; i++) {
             const
+                id = ids[i],
                 text = captionText(captions[id]),
                 tags = {
                     album,
@@ -95,13 +99,13 @@ const
                 };
 
             await id3.update(tags, `${output}${id}.mp3`);
-            
+
             if (generated) {
                 console.log(`Voice generated for "${id}".`);
             } else {
                 console.log(`Voice meta data updated for "${id}".`);
             }
-        });
+        }
     },
     mapReduction = (map, list) => list.reduce((obj, file) => {
         const
@@ -167,7 +171,7 @@ const
             }
     
             if (updateAllMetaData && present.length) {
-                appendMP3Meta({
+                await appendMP3Meta({
                     album,
                     captions: mapReduction(files, present),
                     language,
@@ -186,9 +190,39 @@ const
             const
                 {album, encodedBy, config, transcripts, updateList} = this,
                 {files, output, language, voice} = config,
-                list = updateList ?? Object.keys(files).map((id) => `${id}.mp3`);
+                list = updateList ?? Object.keys(files).map((id) => `${id}.mp3`),
+                missing = [];
+
+            for (let i = 0; i < list.length; i++) {
+                const
+                    filename = list[i],
+                    fullPath = `${output}${filename}`;
+
+                try {
+                    await fs.access(fullPath);
+                } catch (e) {
+                    missing.push(filename);
+                }
+            }
+
+            if (missing.length) {
+                let detail = '';
+
+                try {
+                    const
+                        log = JSON.parse(await fs.readFile(`${output}log.json`, 'utf8'));
+
+                    if (log?.errors?.length) {
+                        detail = ` Server errors: ${log.errors.join('; ')}`;
+                    }
+                } catch (e) { /* no log.json */ }
+
+                throw new Error(
+                    `Voice export missing ${missing.length === 1 ? `"${missing[0]}"` : `${missing.length} files (${missing.join(', ')})`}.${detail}`
+                );
+            }
 
-            appendMP3Meta({
+            await appendMP3Meta({
                 album,
                 captions: files,
                 generated: true,

package/src/index.js

@@ -6,6 +6,7 @@ const
         allosaurus: LipSync,
         elevenlabs: require('./classes/ElevenLabs'),
         ffmpeg: require('./classes/FFMPEG'),
+        packfully: require('./classes/Packfully'),
         polly: require('./classes/Polly'),
         rasterize: require('./classes/Rasterize'),
         rhubarb: LipSync,

package/src/say.js

@@ -59,17 +59,20 @@ const
                 },
                 path: '',
                 voice,
-                output
+                output,
+                extract: true
             },
             handler = new ElevenLabs({
                 config,
                 contents: {
                     ...contents,
-                    service: 'elevenlabs'
+                    service: 'elevenlabs',
+                    extract: true
                 }
             });
 
         delete config.script;
+        delete config.src;
 
         await handler.prepare({
             difference: false,
@@ -79,7 +82,30 @@ const
             instanceId: `${contents.id}-say`
         });
 
-        return path.join(CACHE_DIR, `${key}.mp3`);
+        const
+            mp3File = path.join(CACHE_DIR, `${key}.mp3`);
+
+        try {
+            await fsp.access(mp3File);
+        } catch (e) {
+            let detail = '';
+
+            try {
+                const
+                    log = JSON.parse(await fsp.readFile(path.join(CACHE_DIR, 'log.json'), 'utf8'));
+
+                if (log?.errors?.length) {
+                    detail = ` ${log.errors.join('; ')}`;
+                }
+            } catch (err) { /* ignore */ }
+
+            throw new Error(
+                `Speech generation finished but "${mp3File}" was not created.${detail} ` +
+                'Check that the Cheerfully worker is running and picking up elevenlabs chores.'
+            );
+        }
+
+        return mp3File;
     };
 
 module.exports = async (textOrArgs = {}) => {