spessoplayer 0.7.8-beta → 0.8.0-beta

package/COMMAND-LINE-OPTIONS.md

@@ -2,7 +2,8 @@
 
 ### spessoplayer [options] \<midi\> \<soundfont\> [outFile]
 
-### --volume, /volume, -v, /v:
+### --volume, /volume,
+#### &nbsp;&nbsp;-v, /v:
   Volume to set (*default: 100%*)
 
   Available formats:
@@ -10,33 +11,40 @@
   - **percentages** (*example 70%*);
   - **decimals** (*example 0.9*);
 
-### --reverb-volume, /reverb-volume, -rvb, /rvb:
+### --reverb-volume, /reverb-volume,
+#### &nbsp;&nbsp;-rvb, /rvb:
   Volume to set for reverb (*default: none*)
-  
+
   Same formats as volume
 
-### --effects, /effects, -e, /e: 
+### --effects, /effects,
+#### &nbsp;&nbsp;-e, /e:
 Adds any effects that SoX provides (*e.g "reverb,fade 1"*)
 
-### --loop, /loop, -l, /l:
+### --loop, /loop,
+#### &nbsp;&nbsp;-l, /l:
   Loop x amount of times (*default: 0*)
 
 &nbsp;&nbsp;&nbsp;<sub>(It might be slow with bigger numbers)</sub>
 
-### --loop-start, /loop-start, -ls, /ls:
+### --loop-start, /loop-start,
+#### &nbsp;&nbsp;-ls, /ls:
 When the loop starts
 
-### --loop-end, /loop-end, -le, /le:
+### --loop-end, /loop-end,
+#### &nbsp;&nbsp;-le, /le:
 When the loop ends
 
-### --sample-rate, /sample-rate, -r, /r:
+### --sample-rate, /sample-rate,
+#### &nbsp;&nbsp;-r, /r:
 Sample rate to use (*default: 48000*)
 
 &nbsp;&nbsp;&nbsp;<sub>(It might be slow with bigger numbers for players like mpv)</sub>
 
 &nbsp;&nbsp;&nbsp;<sub>(Some players might downsize it to a smaller frequency)</sub>
 
-### --format, /format, -f, /f:
+### --format, /format,
+#### &nbsp;&nbsp;-f, /f:
 Format to use for stdout (*default: wav*)
 
 Available formats:
@@ -45,16 +53,37 @@ Available formats:
 - **flac**;
 - **pcm (s32le)**;
 
-### --verbose, /verbose, -v, /v:
+### --ask, /ask, --confirm, /confirm,
+#### &nbsp;&nbsp;-a, /a, -c, /c:
+Asks for confirmation before proceeding
+
+### --no-table, /no-table,
+#### &nbsp;&nbsp;-nt, /nt:
+When asking for confirmation,
+it'll show the information in a JSON-like format instead of a table
+
+### --dry-run, /dry-run, --test, /test, --null, /null,
+#### &nbsp;&nbsp;-dr, /dr, -t, /t, -0, /0:
+Runs the program as normal but
+it'll write to /dev/null on unix and \\.\nul on windows.
+
+Mainly used for testing purposes but
+can be useful when trying to debug with log options
+
+### --verbose, /verbose,
+#### &nbsp;&nbsp;-v, /v:
 Sets the verbosity (*default: 2*)
 
-### --log-file, /log-file, -lf, /lf:
+### --log-file, /log-file,
+#### &nbsp;&nbsp;-lf, /lf:
 Sets path to the log file (*default: ./spesso.log*)
 &nbsp;&nbsp;&nbsp;<sub>(Meanwhile it writes to file, it also prints to stderr)</sub>
 
-### --help, /help, -h, /h, /?:
+### --help, /help,
+#### &nbsp;&nbsp;-h, /h, /?:
 Shows this help message
 
-### --version, /version:
+### --version, /version
+#### &nbsp;&nbsp;-V, /V:
 Shows the installed version
 

package/audioBuffer.mjs

@@ -25,16 +25,11 @@ import {
 } from "spessasynth_core"
 // This section is identical to what's inside spessasynth_core but not being exported, that's why it's here
 function fillWithDefaults(obj, defObj) {
-  return {
-    ...defObj,
-    ...obj ?? {}
-  };
+  return { ...defObj, ...obj ?? {} };
 }
 function writeBinaryStringIndexed(outArray, string, padLength = 0) {
   if (padLength > 0) {
-    if (string.length > padLength) {
-      string = string.slice(0, padLength);
-    }
+    if (string.length > padLength) string = string.slice(0, padLength)
   }
   for (let i = 0; i < string.length; i++) {
     outArray[outArray.currentIndex++] = string.charCodeAt(i);
@@ -52,7 +47,7 @@ function writeLittleEndianIndexed(dataArray, number, byteTarget) {
   }
 }
 function writeDword(dataArray, dword) {
-  writeLittleEndianIndexed(dataArray, dword, 4);
+  writeLittleEndianIndexed(dataArray, dword, 4)
 }
 function writeRIFFChunkParts(header, chunks, isList = false) {
   let dataOffset = 8;
@@ -65,31 +60,26 @@ function writeRIFFChunkParts(header, chunks, isList = false) {
     headerWritten = "LIST";
   }
   let finalSize = dataOffset + dataLength;
-  if (finalSize % 2 !== 0) {
-    finalSize++;
-  }
+  if (finalSize % 2 !== 0) finalSize++
+
   const outArray = new IndexedByteArray(finalSize);
   writeBinaryStringIndexed(outArray, headerWritten);
   writeDword(outArray, writtenSize);
-  if (isList) {
-    writeBinaryStringIndexed(outArray, header);
-  }
-  chunks.forEach((c) => {
-    outArray.set(c, dataOffset);
+  if (isList) writeBinaryStringIndexed(outArray, header);
+
+  chunks.forEach(c => {
+    outArray.set(c, dataOffset)
     dataOffset += c.length;
-  });
+  })
   return outArray;
 }
 function writeRIFFChunkRaw(header, data, addZeroByte = false, isList = false) {
-  if (header.length !== 4) {
-    throw new Error(`Invalid header length: ${header}`);
-  }
+  if (header.length !== 4) throw new Error(`Invalid header length: ${header}`)
   let dataStartOffset = 8;
   let headerWritten = header;
   let dataLength = data.length;
-  if (addZeroByte) {
-    dataLength++;
-  }
+
+  if (addZeroByte) dataLength++
   let writtenSize = dataLength;
   if (isList) {
     dataStartOffset += 4;
@@ -97,29 +87,27 @@ function writeRIFFChunkRaw(header, data, addZeroByte = false, isList = false) {
     headerWritten = "LIST";
   }
   let finalSize = dataStartOffset + dataLength;
-  if (finalSize % 2 !== 0) {
-    finalSize++;
-  }
+  if (finalSize % 2 !== 0) finalSize++
+
   const outArray = new IndexedByteArray(finalSize);
   writeBinaryStringIndexed(outArray, headerWritten);
   writeDword(outArray, writtenSize);
-  if (isList) {
-    writeBinaryStringIndexed(outArray, header);
-  }
+
+  if (isList) writeBinaryStringIndexed(outArray, header);
   outArray.set(data, dataStartOffset);
   return outArray;
 }
 
 /**
  * WAV Header Generator
- * @param {Object} audioData - An object that contains infos about the audio
- * @param {Number} audioData.length - Audio length in samples, essentially the sample count
- * @param {Number} audioData.numChannels - How many channels the audio has
- * @param {Number} sampleRate - Sample rate of the audio
+ * @param {module:typeDefinitions~getWavHeaderObjectParameters} audioData - An object that contains infos about the audio
+ * @param {Number} [sampleRate=48000] - Sample rate of the audio
  * @param {Object} [options=DEFAULT_WAV_WRITE_OPTIONS] - Optional, adds loop timestamps and more
  * @returns {Uint8Array} the wav header
  */
-function getWavHeader({ length, numChannels }, sampleRate, options = DEFAULT_WAV_WRITE_OPTIONS) {
+function getWavHeader({ length, numChannels },
+  sampleRate = 48000, options = DEFAULT_WAV_WRITE_OPTIONS
+) {
   const bytesPerSample = 2;
   const fullOptions = fillWithDefaults(options, DEFAULT_WAV_WRITE_OPTIONS);
   const loop = fullOptions.loop;
@@ -162,6 +150,7 @@ function getWavHeader({ length, numChannels }, sampleRate, options = DEFAULT_WAV
   if (cueOn) {
     const loopStartSamples = Math.floor(loop.start * sampleRate);
     const loopEndSamples = Math.floor(loop.end * sampleRate);
+
     const cueStart = new IndexedByteArray(24);
     writeLittleEndianIndexed(cueStart, 0, 4);
     writeLittleEndianIndexed(cueStart, 0, 4);
@@ -169,6 +158,7 @@ function getWavHeader({ length, numChannels }, sampleRate, options = DEFAULT_WAV
     writeLittleEndianIndexed(cueStart, 0, 4);
     writeLittleEndianIndexed(cueStart, 0, 4);
     writeLittleEndianIndexed(cueStart, loopStartSamples, 4);
+
     const cueEnd = new IndexedByteArray(24);
     writeLittleEndianIndexed(cueEnd, 1, 4);
     writeLittleEndianIndexed(cueEnd, 0, 4);
@@ -176,6 +166,7 @@ function getWavHeader({ length, numChannels }, sampleRate, options = DEFAULT_WAV
     writeLittleEndianIndexed(cueEnd, 0, 4);
     writeLittleEndianIndexed(cueEnd, 0, 4);
     writeLittleEndianIndexed(cueEnd, loopEndSamples, 4);
+
     cueChunk = writeRIFFChunkParts("cue ", [
       new IndexedByteArray([2, 0, 0, 0]),
       // Cue points count
@@ -196,7 +187,7 @@ function getWavHeader({ length, numChannels }, sampleRate, options = DEFAULT_WAV
       fileSize >> 24 & 255
     ]),
     4
-  );
+  )
   header.set([87, 65, 86, 69], 8);     // "WAVE"
   header.set([102, 109, 116, 32], 12); // "fmt "
   header.set([16, 0, 0, 0], 16);       // BlocSize
@@ -210,7 +201,7 @@ function getWavHeader({ length, numChannels }, sampleRate, options = DEFAULT_WAV
       sampleRate >> 24 & 255
     ]),
     24
-  );
+  )
   const byteRate = sampleRate * numChannels * bytesPerSample;
   header.set(
     new Uint8Array([
@@ -220,7 +211,7 @@ function getWavHeader({ length, numChannels }, sampleRate, options = DEFAULT_WAV
       byteRate >> 24 & 255
     ]),
     28
-  );
+  )
   header.set([numChannels * bytesPerSample, 0], 32); // BytePerBloc
   header.set([16, 0], 34);                           // BitsPerSample
   header.set([100, 97, 116, 97], 36);                // "data"
@@ -232,37 +223,34 @@ function getWavHeader({ length, numChannels }, sampleRate, options = DEFAULT_WAV
       dataSize >> 24 & 255
     ]),
     40
-  );
+  )
   return header;
 }
 
 /**
- * Translates to PCM data
+ * Translates to audible PCM data
  * @param {Array} audioData - An array that contains the audio buffers
- * @param {Number} sampleRate - Sample rate of the audio
  * @param {Object} options - Optional, adds loop timestamps and more
  * @returns {Uint8Array} the translated data
  */
-function getData(audioData, sampleRate, options = DEFAULT_WAV_WRITE_OPTIONS) {
-  const length = audioData[0].length;
-  const numChannels = audioData.length;
-  const fullOptions = fillWithDefaults(options, DEFAULT_WAV_WRITE_OPTIONS);
-  const headerSize = 44;
-  const bytesPerSample = 2;
+function getData(audioData, options = DEFAULT_WAV_WRITE_OPTIONS) {
+  const length = audioData[0].length,
+        numChannels = audioData.length,
+        fullOptions = fillWithDefaults(options, DEFAULT_WAV_WRITE_OPTIONS),
+        bytesPerSample = 2;
 
-  const dataSize = length * numChannels * bytesPerSample;
-  const fileSize = dataSize;
-  
-  const Data = new Uint8Array(fileSize);
-  let offset = 0;
+  const fileSize = length * numChannels * bytesPerSample,
+        Data = new Uint8Array(fileSize);
+
+  let offset = 0,
+      multiplier = 32767;
   // Volume
-  let multiplier = 32767;
   /*if (fullOptions.normalizeAudio) {
     const numSamples = audioData[0].length;
     let maxAbsValue = 0;
     for (let ch = 0; ch < numChannels; ch++) {
       const data = audioData[ch];
-      
+
       for (let i = 0; i < numSamples; i++) {
         const sample = Math.abs(data[i]);
         if (sample > maxAbsValue) {
@@ -270,22 +258,22 @@ function getData(audioData, sampleRate, options = DEFAULT_WAV_WRITE_OPTIONS) {
         }
       }
     }
-    multiplier = maxAbsValue > 0 
-      ? 32767 / maxAbsValue 
+    multiplier = maxAbsValue > 0
+      ? 32767 / maxAbsValue
       : 1;
   }*/
   for (let i = 0; i < length; i++) {
-    audioData.forEach((d) => {
+    for (const d of audioData) {
       const sample = Math.min(32767, Math.max(-32768, d[i] * multiplier));
       Data[offset++] = sample & 255;
       Data[offset++] = sample >> 8 & 255;
-    });
+    }
   }
   return Data;
 }
 
 
-export { 
+export {
   getWavHeader,
   getData
 }