cemu-smm - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

index.js

 const crc32 = require("buffer-crc32");
+const jimp  = require("jimp");
 
@@ -13,2 +14,11 @@ const fs    = require("fs");
 const TNL_JPEG_MAX_SIZE = 0xC7F8;
+const TNL_DIMENSION = [
+    [ 720, 81 ],
+    [ 320, 240 ]
+];
+const TNL_ASPECT_RATIO = [
+    TNL_DIMENSION[0][0] / TNL_DIMENSION[0][1],
+    TNL_DIMENSION[1][0] / TNL_DIMENSION[1][1]
+];
+const TNL_ASPECT_RATIO_THRESHOLD = [ 3.5, 0.3 ];
 
@@ -149,3 +159,3 @@ module.exports = {
                                 let tnl = new Tnl(coursePath + "/thumbnail0.tnl");
-                                let jpeg = await tnl.toJpeg();
+                                let jpeg = await tnl.toJpeg(true);
                                 fs.writeFile(coursePath + "/thumbnail0.jpg", jpeg, null, () => {
@@ -161,3 +171,3 @@ resolve();
                                 let tnl = new Tnl(coursePath + "/thumbnail1.tnl");
-                                let jpeg = await tnl.toJpeg();
+                                let jpeg = await tnl.toJpeg(false);
                                 fs.writeFile(coursePath + "/thumbnail1.jpg", jpeg, null, () => {
@@ -201,23 +211,66 @@ resolve();
 
-    fromJpeg: async function () {
+    fromJpeg: async function (isWide, doClip = false) {
 
-        return new Promise((resolve, reject) => {
-            fs.readFile(this.pathToFile, (err, data) => {
-                if (err) throw err;
-                if (data.length > TNL_JPEG_MAX_SIZE) {
-                    reject("File size too big. Maximum length is 0xC7F8 bytes.");
+        return new Promise(async (resolve, reject) => {
+
+            // image pre-processing
+            let image = await jimp.read(this.pathToFile);
+
+            if (isWide === null) {
+                let aspectRatio = image.bitmap.width / image.bitmap.height;
+                if (aspectRatio > TNL_ASPECT_RATIO[0] - TNL_ASPECT_RATIO_THRESHOLD[0] && aspectRatio < TNL_ASPECT_RATIO[0] + TNL_ASPECT_RATIO_THRESHOLD[0]) {
+                    isWide = true;
+                } else if (aspectRatio > TNL_ASPECT_RATIO[1] - TNL_ASPECT_RATIO_THRESHOLD[1] && aspectRatio < TNL_ASPECT_RATIO[1] + TNL_ASPECT_RATIO_THRESHOLD[1]) {
+                    isWide = false;
                 }
-                let length = Buffer.alloc(4);
-                length.writeUInt32BE(data.length, 0);
+                if (isWide === null) {
+                    isWide = TNL_ASPECT_RATIO[0] - TNL_ASPECT_RATIO_THRESHOLD[0] - aspectRatio <= TNL_ASPECT_RATIO[1] + TNL_ASPECT_RATIO_THRESHOLD[1] + aspectRatio;
+                }
+            }
 
-                let padding = Buffer.alloc(0xC800 - data.length - 8);
+            if (isWide) {
+                if (doClip) {
+                    image.cover(TNL_DIMENSION[0][0], TNL_DIMENSION[0][1]);
+                } else {
+                    image.contain(TNL_DIMENSION[0][0], TNL_DIMENSION[0][1]);
+                }
+            } else {
+                if (doClip) {
+                    image.cover(TNL_DIMENSION[1][0], TNL_DIMENSION[1][1]);
+                } else {
+                    image.contain(TNL_DIMENSION[1][0], TNL_DIMENSION[1][1]);
+                }
+            }
 
-                let fileWithoutCrc = Buffer.concat([length, data, padding], 0xC800 - 4);
+            // wrap tnl data around jpeg
+            let data = await new Promise((resolve) => {
+                image.getBuffer(jimp.MIME_JPEG, (err, buffer) => { resolve(buffer); });
+            });
 
-                let crcBuffer = Buffer.alloc(4);
-                crcBuffer.writeUInt32BE(crc32.unsigned(fileWithoutCrc), 0);
+            // lower quality until it fits
+            let quality = 100;
+            while (data.length > TNL_JPEG_MAX_SIZE) {
+                quality -= 5;
+                if (quality < 0) {
+                    reject("File could not be transformed into jpeg with lowest quality setting.");
+                }
+                data = await new Promise((resolve) => {
+                    image.quality(quality);
+                    image.getBuffer(jimp.MIME_JPEG, (err, buffer) => { resolve(buffer); });
+                });
+            }
 
-                let tnl = Buffer.concat([crcBuffer, fileWithoutCrc], TNL_SIZE);
-                resolve(tnl);
-            })
+            let length = Buffer.alloc(4);
+            length.writeUInt32BE(data.length, 0);
+
+            let padding = Buffer.alloc(0xC800 - data.length - 8);
+
+            let fileWithoutCrc = Buffer.concat([length, data, padding], 0xC800 - 4);
+
+            let crcBuffer = Buffer.alloc(4);
+            crcBuffer.writeUInt32BE(crc32.unsigned(fileWithoutCrc), 0);
+
+            let tnl = Buffer.concat([crcBuffer, fileWithoutCrc], TNL_SIZE);
+            resolve(tnl);
+
         });
@@ -224,0 +277,0 @@

package.json

 {
   "name": "cemu-smm",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "This is a module to simplify all kinds of tasks with Loadiine Super Mario Maker save files and respectively Cemu",
@@ -12,3 +12,4 @@ "main": "index.js",
   "dependencies": {
-    "buffer-crc32": "latest"
+    "buffer-crc32": "latest",
+    "jimp": "^0.2.27"
   },
@@ -15,0 +16,0 @@ "repository": {

README.md

@@ -39,10 +39,89 @@ # cemu-smm
   fs.writeFileSync("path/to/newly/created/jpeg", jpeg);
-
+  
   // convert jpeg to tnl
   jpeg = smm.loadImage("path/to/your/jpeg/file");
+  
+  // default conversion
   tnl = await jpeg.fromJpeg();
   fs.writeFileSync("path/to/newly/created/tnl", tnl);
+    
+  // to wide
+  tnl = await jpeg.fromJpeg(true);
+  fs.writeFileSync("path/to/newly/created/tnl", tnl);
+    
+  // to 4:3
+  tnl = await jpeg.fromJpeg(false);
+  fs.writeFileSync("path/to/newly/created/tnl", tnl);
+  
 })();
 ```
 
+## API
+
+### Reorder
+
+Load your save
+```js
+let save = await smm.loadSave("path/to/your/cemu/save/mlc01/emulatorSave/updateID");
+```
+
+When calling
+```js
+save.reorder();
+```
+
+![Alt text](https://raw.githubusercontent.com/Tarnadas/cemu-smm/master/test/reorder_before.jpg)
+
+becomes
+
+![Alt text](https://raw.githubusercontent.com/Tarnadas/cemu-smm/master/test/reorder_after.jpg)
+
+### TNL to JPEG
+
+Load an image with
+```js
+let tnl = smm.loadImage("path/to/your/tnl/file");
+```
+Do the conversion with
+```js
+let jpeg = await jpeg.fromJpeg([isWide, [doCrop = false]]);
+```
+Save your file
+```js
+fs.writeFileSync("path/to/newly/created/jpeg", jpeg);
+```
+
+### JPEG to TNL
+
+Load an image with
+```js
+let jpeg = smm.loadImage("path/to/your/jpeg/file");
+```
+Do the conversion with
+```js
+let tnl = await jpeg.fromJpeg([isWide, [doCrop = false]]);
+```
+If ```isWide === true```, thumbnail0 will be created, otherwise thumbnail1.
+
+If ```isWide === null```, the algorithm tries to guess the correct aspect ratio.
+
+If ```doCrop === false```, parts of the image may be letter boxed.
+
+If ```doCrop === false```, parts of the image may be cropped.
+
+Images will automatically be resized to fit Super Mario Maker standards. You can even convert 4k images. If the file is still too big after rescaling, the quality of the JPEG will be shrinked.
+
+Save your file
+```js
+fs.writeFileSync("path/to/newly/created/jpeg", tnl);
+```
+
+### JPEG mass export
+
+To convert all tnl files inside your save to jpeg, call
+```js
+save.exportJpeg();
+```
+Navigate to your save folder and find jpeg files inside course folders.
+
 ## License
@@ -49,0 +128,0 @@

No alert changes

Improved metrics

Total package byte prevSize

16423

increased by29.82%

Lines of code

238

increased by19%

Number of lines in readme file

136

increased by138.6%

Number of low supply chain risk alerts

1

decreased by-50%

Worsened metrics

Dependency count

2

increased by100%

Number of package files

5

decreased by-16.67%

Dependency changes

• + Addedjimp@^0.2.27

• + Addedajv@6.12.6(transitive)

• + Addedasn1@0.2.6(transitive)

• + Addedassert-plus@1.0.0(transitive)

• + Addedasynckit@0.4.0(transitive)

• + Addedaws-sign2@0.7.0(transitive)

• + Addedaws4@1.13.1(transitive)

• + Addedbcrypt-pbkdf@1.0.2(transitive)

• + Addedbignumber.js@2.4.0(transitive)

• + Addedbmp-js@0.0.3(transitive)

• + Addedbuffer-equal@0.0.1(transitive)

• + Addedcaseless@0.12.0(transitive)

• + Addedcentra@2.7.0(transitive)

• + Addedcombined-stream@1.0.8(transitive)

• + Addedcore-util-is@1.0.2(transitive)

• + Addeddashdash@1.14.1(transitive)

• + Addeddelayed-stream@1.0.0(transitive)

• + Addeddom-walk@0.1.2(transitive)

• + Addedecc-jsbn@0.1.2(transitive)

• + Addedes6-promise@3.3.1(transitive)

• + Addedexif-parser@0.1.12(transitive)

• + Addedextend@3.0.2(transitive)

• + Addedextsprintf@1.3.0(transitive)

• + Addedfast-deep-equal@3.1.3(transitive)

• + Addedfast-json-stable-stringify@2.1.0(transitive)

• + Addedfile-type@3.9.0(transitive)

• + Addedfollow-redirects@1.15.6(transitive)

• + Addedforever-agent@0.6.1(transitive)

• + Addedform-data@2.3.3(transitive)

• + Addedgetpass@0.1.7(transitive)

• + Addedglobal@4.4.0(transitive)

• + Addedhar-schema@2.0.0(transitive)

• + Addedhar-validator@5.1.5(transitive)

• + Addedhttp-signature@1.2.0(transitive)

• + Addedip-regex@1.0.3(transitive)

• + Addedis-function@1.0.2(transitive)

• + Addedis-typedarray@1.0.0(transitive)

• + Addedisstream@0.1.2(transitive)

• + Addedjimp@0.2.28(transitive)

• + Addedjpeg-js@0.2.0(transitive)

• + Addedjsbn@0.1.1(transitive)

• + Addedjson-schema@0.4.0(transitive)

• + Addedjson-schema-traverse@0.4.1(transitive)

• + Addedjson-stringify-safe@5.0.1(transitive)

• + Addedjsprim@1.4.2(transitive)

• + Addedload-bmfont@1.4.2(transitive)

• + Addedmime@1.6.0(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedmin-document@2.19.0(transitive)

• + Addedminimist@0.0.8(transitive)

• + Addedmkdirp@0.5.1(transitive)

• + Addedoauth-sign@0.9.0(transitive)

• + Addedparse-bmfont-ascii@1.0.6(transitive)

• + Addedparse-bmfont-binary@1.0.6(transitive)

• + Addedparse-bmfont-xml@1.1.6(transitive)

• + Addedparse-headers@2.0.5(transitive)

• + Addedperformance-now@2.1.0(transitive)

• + Addedphin@3.7.1(transitive)

• + Addedpixelmatch@4.0.2(transitive)

• + Addedpngjs@3.4.0(transitive)

• + Addedprocess@0.11.10(transitive)

• + Addedpsl@1.9.0(transitive)

• + Addedpunycode@2.3.1(transitive)

• + Addedqs@6.5.3(transitive)

• + Addedread-chunk@1.0.1(transitive)

• + Addedrequest@2.88.2(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsax@1.4.1(transitive)

• + Addedsshpk@1.18.0(transitive)

• + Addedstream-to@0.2.2(transitive)

• + Addedstream-to-buffer@0.1.0(transitive)

• + Addedtinycolor2@1.6.0(transitive)

• + Addedtough-cookie@2.5.0(transitive)

• + Addedtunnel-agent@0.6.0(transitive)

• + Addedtweetnacl@0.14.5(transitive)

• + Addeduri-js@4.4.1(transitive)

• + Addedurl-regex@3.2.0(transitive)

• + Addeduuid@3.4.0(transitive)

• + Addedverror@1.10.0(transitive)

• + Addedxhr@2.6.0(transitive)

• + Addedxml-parse-from-string@1.0.1(transitive)

• + Addedxml2js@0.5.0(transitive)

• + Addedxmlbuilder@11.0.1(transitive)

• + Addedxtend@4.0.2(transitive)