@karaplay/file-coder 1.1.0

package/libs/emk/server-decode.ts

@@ -0,0 +1,133 @@
+
+/**
+ * @fileoverview Main decoding logic for .emk (Extreme Karaoke) files.
+ * This is the SERVER-SIDE implementation using Node.js's 'zlib'.
+ * It is used by the GET /api/emk/import endpoint for playback.
+ */
+
+import { inflateSync } from 'zlib';
+
+const XOR_KEY = Buffer.from([0xAF, 0xF2, 0x4C, 0x9C, 0xE9, 0xEA, 0x99, 0x43]);
+const MAGIC_SIGNATURE = '.SFDS';
+
+export interface DecodedEmkParts {
+  header?: Buffer;
+  songInfo?: Buffer;
+  midi?: Buffer;
+  lyric?: Buffer;
+  cursor?: Buffer;
+}
+
+const ZLIB_SECOND_BYTES = new Set<number>([0x01, 0x5E, 0x9C, 0xDA, 0x7D, 0x20, 0xBB]);
+
+function xorDecrypt(data: Buffer): Buffer {
+  const decrypted = Buffer.alloc(data.length);
+  for (let i = 0; i < data.length; i++) {
+    decrypted[i] = data[i] ^ XOR_KEY[i % XOR_KEY.length];
+  }
+  return decrypted;
+}
+
+function looksLikeText(buf: Buffer): boolean {
+  const sample = buf.subarray(0, Math.min(64, buf.length));
+  for (let i = 0; i < sample.length; i++) {
+    const c = sample[i];
+    if (c === 0x0a || c === 0x0d || c === 0x09 || (c >= 0x20 && c <= 0x7e) || c >= 0x80) {
+      continue;
+    }
+    return false;
+  }
+  return true;
+}
+
+export function decodeEmk(fileBuffer: Buffer): DecodedEmkParts {
+  const decryptedBuffer = xorDecrypt(fileBuffer);
+
+  const magic = decryptedBuffer.subarray(0, MAGIC_SIGNATURE.length).toString('utf-8');
+  if (magic !== MAGIC_SIGNATURE) {
+    throw new Error(`Invalid EMK file signature. Expected '${MAGIC_SIGNATURE}' but got '${magic}'.`);
+  }
+
+  const result: DecodedEmkParts = {};
+  const inflatedParts: Buffer[] = [];
+
+  for (let i = 0; i < decryptedBuffer.length - 2; i++) {
+    const b0 = decryptedBuffer[i];
+    const b1 = decryptedBuffer[i + 1];
+
+    if (b0 !== 0x78 || !ZLIB_SECOND_BYTES.has(b1)) continue;
+
+    try {
+      const inflated = inflateSync(decryptedBuffer.subarray(i));
+      inflatedParts.push(inflated);
+    } catch {
+      continue;
+    }
+  }
+
+  if (inflatedParts.length < 3) {
+    throw new Error(`Invalid EMK structure: expected at least 3 zlib blocks, found ${inflatedParts.length}.`);
+  }
+
+  for (const inflated of inflatedParts) {
+    const asciiPrefix = inflated.subarray(0, 16).toString('ascii');
+
+    if (asciiPrefix.startsWith('SIGNATURE=')) {
+      result.header = inflated;
+    } else if (asciiPrefix.startsWith('CODE=')) {
+      result.songInfo = inflated;
+    } else if (inflated.subarray(0, 4).toString('ascii') === 'MThd') {
+      result.midi = inflated;
+    } else if (looksLikeText(inflated)) {
+      if (!result.lyric) {
+        result.lyric = inflated;
+      } else {
+        result.cursor = inflated;
+      }
+    } else {
+      if (!result.cursor) {
+        result.cursor = inflated;
+      }
+    }
+  }
+  
+  if (!result.midi) throw new Error('MIDI data block not found in EMK file.');
+  if (!result.lyric) throw new Error('Lyric data block not found in EMK file.');
+  if (!result.cursor) throw new Error('Cursor data block not found in EMK file.');
+
+  if (!result.songInfo) {
+    result.songInfo = Buffer.from('CODE=\nTITLE=Unknown Title\nARTIST=Unknown Artist');
+  }
+
+  return result;
+}
+
+
+/**
+ * Parses the "song info" block from a Buffer.
+ * @param songInfoBuffer The buffer containing the song info data.
+ * @returns A record containing TITLE, ARTIST, and CODE.
+ */
+export function parseSongInfo(songInfoBuffer: Buffer | undefined): Record<string, string> {
+  if (!songInfoBuffer) return {};
+  try {
+    const text = new TextDecoder('windows-874', { fatal: false }).decode(songInfoBuffer);
+    const lines = text.split(/\r?\n/);
+    const info: Record<string, string> = {};
+    for (const line of lines) {
+      const parts = line.split('=');
+      if (parts.length >= 2) {
+        const key = parts[0].trim().toUpperCase();
+        const value = parts.slice(1).join('=').trim();
+        // Only store relevant keys to keep it focused
+        if (key === 'TITLE' || key === 'ARTIST' || key === 'CODE' || key === 'title' || key === 'artist' || key === 'code') {
+           info[key.toUpperCase()] = value;
+        }
+      }
+    }
+    return info;
+  } catch (e) {
+    console.error("Failed to parse song info", e);
+    return {};
+  }
+}

package/libs/ncntokar.js

@@ -0,0 +1,256 @@
+#!/usr/bin/env node
+/**
+ * NCN (.mid + .lyr + .cur) -> .kar (MIDI with embedded karaoke/lyric/title/artist tracks)
+ * - .lyr decoded as TIS-620 (Thai encoding)
+ * - hard-coded input/output paths
+ * - meta events use midi-file format: { deltaTime, type: <subtype>, text }
+ */
+
+const fs = require("fs");
+const path = require("path");
+const iconv = require("iconv-lite");
+const GraphemeSplitter = require("grapheme-splitter");
+const { parseMidi, writeMidi } = require("midi-file");
+
+// ===============================
+// ✅ HARD-CODED FILE PATHS HERE
+// ===============================
+const INPUT_MIDI = "songs/midi/Z2510006.mid";      // <-- change
+const INPUT_LYR  = "songs/lyr/Z2510006.lyr";      // <-- change (TIS-620)
+const INPUT_CUR  = "songs/cur/Z2510006.cur";      // <-- change
+const OUTPUT_KAR = "out/Z25100066.kar";       // <-- change (must NOT exist)
+// titles.txt will be created/appended in same folder as OUTPUT_KAR:
+const TITLES_TXT = path.join(path.dirname(OUTPUT_KAR), "titles.txt");
+
+// ===============================
+
+function die(msg) {
+  console.error(`[error] ${msg}`);
+  process.exit(1);
+}
+function warn(msg) {
+  console.warn(`[warn] ${msg}`);
+}
+
+function ensureReadableFile(p) {
+  try {
+    fs.accessSync(p, fs.constants.R_OK);
+    if (!fs.statSync(p).isFile()) die(`Not a file: ${p}`);
+  } catch {
+    die(`Cannot read file: ${p}`);
+  }
+}
+
+function ensureOutputDoesNotExist(p) {
+  if (fs.existsSync(p)) die(`Output already exists: ${p}`);
+  const dir = path.dirname(p);
+  if (dir && dir !== "." && !fs.existsSync(dir)) fs.mkdirSync(dir, { recursive: true });
+}
+
+function readFileTextTIS620(p) {
+  const buf = fs.readFileSync(p);
+  return iconv.decode(buf, "tis-620");
+}
+
+function splitLinesKeepEndings(text) {
+  return text.match(/[^\n]*\n|[^\n]+$/g) || [];
+}
+function trimLineEndings(s) {
+  return s.replace(/[\r\n]+$/g, "");
+}
+
+class CursorReader {
+  constructor(buf) {
+    this.buf = buf;
+    this.off = 0;
+  }
+  readU16LE() {
+    if (this.off + 2 > this.buf.length) return null;
+    const v = this.buf.readUInt16LE(this.off);
+    this.off += 2;
+    return v;
+  }
+  readU8() {
+    if (this.off + 1 > this.buf.length) return null;
+    const v = this.buf[this.off];
+    this.off += 1;
+    return v;
+  }
+  remaining() {
+    return this.buf.length - this.off;
+  }
+  eof() {
+    return this.off >= this.buf.length;
+  }
+}
+
+// ===== META EVENT BUILDERS (midi-file compatible) =====
+// midi-file expects: { deltaTime, type: <subtype>, text }
+// where subtype is "trackName", "text", "endOfTrack", etc.
+// For Thai text (originally TIS-620), we encode back to TIS-620 bytes
+// because the karaoke software expects TIS-620 encoding
+function metaEvent(subtype, deltaTime, text) {
+  // Encode text back to TIS-620 bytes (original encoding) to preserve Thai characters
+  // This is necessary because the original .lyr files are in TIS-620
+  // and karaoke software may expect TIS-620 encoding in MIDI files
+  const tis620Bytes = iconv.encode(text, 'tis-620');
+  
+  // Map subtype to metatypeByte
+  const metaTypeMap = {
+    'text': 0x01,
+    'trackName': 0x03,
+    'copyrightNotice': 0x02,
+    'instrumentName': 0x04,
+    'lyrics': 0x05,
+    'marker': 0x06,
+    'cuePoint': 0x07,
+  };
+  
+  const metatypeByte = metaTypeMap[subtype];
+  if (metatypeByte !== undefined) {
+    // Use unknownMeta with proper metatypeByte to write TIS-620 bytes correctly
+    // This bypasses the broken writeString function that doesn't handle multi-byte chars
+    return {
+      deltaTime,
+      type: 'unknownMeta',
+      metatypeByte: metatypeByte,
+      data: Array.from(tis620Bytes)
+    };
+  }
+  
+  // Fallback to standard format for other types
+  return { deltaTime, type: subtype, text };
+}
+
+function endOfTrack(deltaTime = 0) {
+  return { deltaTime, type: "endOfTrack" };
+}
+
+function main() {
+  ensureReadableFile(INPUT_MIDI);
+  ensureReadableFile(INPUT_LYR);
+  ensureReadableFile(INPUT_CUR);
+  ensureOutputDoesNotExist(OUTPUT_KAR);
+
+  const midi = parseMidi(fs.readFileSync(INPUT_MIDI));
+
+  const ticksPerBeat = midi.header && midi.header.ticksPerBeat;
+  if (!ticksPerBeat) {
+    die("Only ticks-per-beat MIDI timing is supported (SMPTE timing not supported).");
+  }
+
+  const lyricText = readFileTextTIS620(INPUT_LYR);
+  const linesWithEndings = splitLinesKeepEndings(lyricText);
+
+  if (linesWithEndings.length < 2) die("Lyric file has too few lines (need title and artist).");
+
+  const songTitle = trimLineEndings(linesWithEndings[0] ?? "");
+  const artistName = trimLineEndings(linesWithEndings[1] ?? "");
+
+  // Perl discards line 3 & 4; lyrics start from line 5 (index 4)
+  let fullLyric = "";
+  for (let i = 4; i < linesWithEndings.length; i++) fullLyric += linesWithEndings[i];
+
+  const cursor = new CursorReader(fs.readFileSync(INPUT_CUR));
+  const splitter = new GraphemeSplitter();
+
+  // Track: Words
+  const karaokeTrack = [];
+  karaokeTrack.push(metaEvent("trackName", 0, "Words"));
+  karaokeTrack.push(metaEvent("text", 0, "@T" + songTitle));
+  karaokeTrack.push(metaEvent("text", 0, "@T" + artistName));
+
+  let previousAbsoluteTimestamp = 0;
+
+  for (let i = 4; i < linesWithEndings.length; i++) {
+    const trimmed = trimLineEndings(linesWithEndings[i]);
+    if (!trimmed || trimmed.length === 0) continue;
+
+    const lineForTiming = "/" + trimmed;
+    const graphemes = splitter.splitGraphemes(lineForTiming);
+
+    for (const g of graphemes) {
+      let absoluteTimestamp = previousAbsoluteTimestamp;
+
+      // Read 2 bytes per codepoint inside grapheme (matches Perl logic)
+      for (const _cp of Array.from(g)) {
+        const v = cursor.readU16LE();
+        if (v === null) {
+          warn("ran out of timing info; reusing previous timestamp");
+          absoluteTimestamp = previousAbsoluteTimestamp;
+        } else {
+          absoluteTimestamp = v;
+        }
+      }
+
+      // Same conversion as Perl: * (ticksPerBeat / 24)
+      absoluteTimestamp = Math.floor(absoluteTimestamp * (ticksPerBeat / 24));
+
+      if (absoluteTimestamp < previousAbsoluteTimestamp) {
+        warn("timestamp out of order - clamping");
+        absoluteTimestamp = previousAbsoluteTimestamp;
+      }
+
+      const relativeTimestamp = absoluteTimestamp - previousAbsoluteTimestamp;
+      karaokeTrack.push(metaEvent("text", relativeTimestamp, g));
+      previousAbsoluteTimestamp = absoluteTimestamp;
+    }
+  }
+
+  // Terminator check (Perl warns if EOF / no 0xFF)
+  const terminator = cursor.readU8();
+  if (terminator === null) {
+    warn("EOF without terminator while reading timing info");
+  } else {
+    const leftover = cursor.remaining();
+    if (terminator !== 0xff || leftover > 0) {
+      warn(
+        `${leftover} bytes (${leftover / 2} values) of unused timing info, or timing info ended without 0xFF terminator`
+      );
+    }
+  }
+
+  karaokeTrack.push(endOfTrack(0));
+
+  // Track: Lyric (embed full lyric blob)
+  const lyricTrack = [
+    metaEvent("trackName", 0, "Lyric"),
+    metaEvent("text", 0, fullLyric),
+    endOfTrack(0),
+  ];
+
+  // Track: Artist
+  const artistTrack = [
+    metaEvent("trackName", 0, "Artist"),
+    metaEvent("text", 0, artistName),
+    endOfTrack(0),
+  ];
+
+  // Track: SongTitle
+  const titleTrack = [
+    metaEvent("trackName", 0, "SongTitle"),
+    metaEvent("text", 0, songTitle),
+    endOfTrack(0),
+  ];
+
+  // Insert as second track (index 1) like Perl
+  const originalTracks = midi.tracks || [];
+  const newTracks = originalTracks.slice();
+  newTracks.splice(1, 0, karaokeTrack, lyricTrack, artistTrack, titleTrack);
+  midi.tracks = newTracks;
+
+  const outBytes = writeMidi(midi);
+  fs.writeFileSync(OUTPUT_KAR, Buffer.from(outBytes));
+
+  fs.appendFileSync(
+    TITLES_TXT,
+    `${path.basename(OUTPUT_KAR)}\t${songTitle}\t${artistName}\n`,
+    "utf8"
+  );
+
+  console.log("✅ Done");
+  console.log(`- Output: ${OUTPUT_KAR}`);
+  console.log(`- Titles: ${TITLES_TXT}`);
+}
+
+main();

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@karaplay/file-coder",
+  "version": "1.1.0",
+  "description": "A comprehensive library for encoding/decoding karaoke files (.emk, .kar, MIDI) with Next.js support. Convert EMK to KAR, read/write karaoke files, full browser and server support.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "ncntokar": "./bin/ncntokar-cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./client": {
+      "types": "./dist/client.d.ts",
+      "default": "./dist/client.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "node_modules/.bin/jest",
+    "test:watch": "node_modules/.bin/jest --watch",
+    "test:coverage": "node_modules/.bin/jest --coverage",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "karaoke",
+    "midi",
+    "emk",
+    "kar",
+    "nextjs",
+    "decoder",
+    "encoder",
+    "thai",
+    "tis-620",
+    "karaoke-converter",
+    "midi-karaoke",
+    "browser",
+    "client-side",
+    "file-converter"
+  ],
+  "author": "karaplay",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/karaplay/file-coder.git"
+  },
+  "homepage": "https://github.com/karaplay/file-coder#readme",
+  "bugs": {
+    "url": "https://github.com/karaplay/file-coder/issues"
+  },
+  "dependencies": {
+    "grapheme-splitter": "^1.0.4",
+    "iconv-lite": "^0.6.3",
+    "midi-file": "^1.2.4",
+    "pako": "^2.1.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.10.6",
+    "@types/pako": "^2.0.3",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.3.3"
+  },
+  "peerDependencies": {
+    "next": ">=13.0.0",
+    "react": ">=18.0.0"
+  },
+  "peerDependenciesMeta": {
+    "next": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
+  }
+}

package/songs/.gitkeep

@@ -0,0 +1,3 @@
+# Place your .mid, .lyr, and .cur files here
+# Example: demo.mid, demo.lyr, demo.cur
+

package/songs/lyr/BPL3457.lyr

@@ -0,0 +1,57 @@
+����������ͻ���
+�Դ �Ե���
+E
+
+. E .
+�ŧ : ����������ͻ���
+��ŻԹ : �Դ �Ե���
+....�����....
+..�Һ����� ������..�觹�
+�����ջѭ�� �Ծ����� ����
+�����ٻ���� ŧ࿫�͡��
+�����ѹ���� ��ͨ�觼����� ����ͧ
+���ŧ�� �������� �����
+��ҹ..����� ��������¤�
+�ͧ..��ҧ ����ҹ�ѹ ����...
+������� �͡����..���...
+��..ʹ�...
+�Ф��Ժ� ��ʹ�...
+�����.. �ѡ伷ҧ��.. �����...
+�����������ͻ��� ���ҹ�ͧ����
+���ջѭ�� 仫��ͧ͢��ҧ
+���..�ش ����ǡ����� ��ҧ�ҧ
+��� �о����ҧ ��Ҵ�Ѵ�ѹ�����
+���¢��ö..��ҧ �ٹ���������
+�Ѻ���� ����վ���� ������
+��ҡ������ѧ
+��Шѧ�������ҧ ������
+������ҹ��..���
+�Ժ��ѡ �ѡ�����..��ҹ�...
+....�����....
+..��..ʹ�.. .
+�Ф��Ժ� ��ʹ�...
+�����.. �ѡ伷ҧ.!��.!. �����.!.
+......
+..�����������ͻ��� ���ҹ�ͧ����
+���ջѭ�� 仫��ͧ͢��ҧ
+���..�ش ����ǡ����� ��ҧ�ҧ
+��� �о����ҧ ��Ҵ�Ѵ�ѹ�����
+���¢��ö..��ҧ �ٹ���������
+�Ѻ���� ����վ���� ������
+��ҡ������ѧ
+��Шѧ�������ҧ ������
+������ҹ��..��� ����� �����������.. ������
+�����������ͻ��� ���ҹ�ͧ����
+���ջѭ�� 仫��ͧ͢��ҧ
+���..�ش ����ǡ����� ��ҧ�ҧ
+��� �о����ҧ ��Ҵ�Ѵ�ѹ�����
+���¢��ö..��ҧ �ٹ���������
+�Ѻ���.!� ����վ���� ������
+��ҡ������ѧ
+��Шѧ�������ҧ ������
+������ҹ��..���
+�Ժ��ѡ �ѡ�����..��ҹ��ҹ...
+��ҹ..��..���
+�Ժ��ѡ �ѡ�����..��ҹ�...
+...���ŧ...
+.

package/songs/lyr/Z2510006.lyr

@@ -0,0 +1,53 @@
+Move On Ẻ�
+���� �����ɰ�
+E
+
+...... Intro ......
+�ͨҡ�ѹ��Ũ��ش��µ�
+��駤����������¡Ѻ�����˧�
+�����Ӿѧ�褹����
+�Ѻ�����ҷ������������
+... ��������ѭ�� �����Ҩ�����駡ѹ
+�����ç�ӧ���� ��ѹ�������ѡ�ѹ
+���ҤԴ���������
+���������������������ѹ
+... �ѧ�ٿ�͹����ç������
+�͹����ҫ���Ѻ������ҧ����
+����ѹ���� ������ �����
+�ѧ���� ����� �����
+... ���¹�ѹ��駷ء � ���ҧ
+��ҡ��˹�˹�������ҧ
+���������������ѡ���ҧ
+������ѹź���仨ҡ�
+�ѡ�ѹ���ҹ
+��������Ҩ��µ�ͧ����ѹ���˹
+... ���¹�ѹ��駷ء � ���ҧ
+������վ����ͧ�ըҡ
+�������͹�պҧ���ҧ
+�ѹ������ź����ҡ����
+�ѡ��������ѹ
+���о���������ѹ�ѡ���˹
+����¨з���ѹ������
+...... Solo ......
+�ѧ�ٿ�͹����ç������
+�͹����ҫ���Ѻ������ҧ����
+����ѹ���� ������ �����
+�ѧ���� ������ �����
+... ���¹�ѹ��駷ء � ���ҧ
+��ҡ��˹�˹�������ҧ
+���������������ѡ���ҧ
+������ѹź���仨ҡ�
+�ѡ�ѹ���ҹ
+��������Ҩ��µ�ͧ����ѹ���˹
+... ���¹�ѹ��駷ء � ���ҧ
+������վ����ͧ�ըҡ
+�������͹�պҧ���ҧ
+�ѹ������ź����ҡ����
+�ѡ��������ѹ
+���о���������ѹ�ѡ���˹
+����¨з���ѹ������
+...... Music ......
+����ѹ������
+...... Music .......
+�ѧ�ٿ�͹����ç������
+......  Outtro ......