loukai-app 0.3.0

package/package.json

@@ -0,0 +1,243 @@
+{
+  "name": "loukai-app",
+  "version": "0.3.0",
+  "type": "module",
+  "description": "Loukai Karaoke - Free and open source karaoke system for playing and creating stem-based karaoke files",
+  "main": "src/main/main.js",
+  "homepage": "./",
+  "scripts": {
+    "start": "electron . --no-sandbox",
+    "dev": "npm run build:all && electron . --dev --no-sandbox",
+    "build": "npm run build:all && electron-builder && node scripts/rename-artifacts.js",
+    "build:all": "npm run build:renderer && npm run build:web",
+    "build:renderer": "vite build --config src/renderer/vite.config.js",
+    "build:web": "vite build --config src/web/vite.config.js",
+    "build:linux": "npm run build:all && electron-builder --linux && node scripts/rename-artifacts.js",
+    "build:win": "npm run build:all && electron-builder --win && node scripts/rename-artifacts.js",
+    "build:mac": "npm run build:all && electron-builder --mac && node scripts/rename-artifacts.js",
+    "rebuild": "electron-rebuild",
+    "postinstall": "electron-builder install-app-deps",
+    "test": "vitest",
+    "test:ui": "vitest --ui",
+    "test:run": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint src/",
+    "lint:fix": "eslint src/ --fix",
+    "format": "prettier --write \"src/**/*.{js,jsx,json,css,md}\"",
+    "format:check": "prettier --check \"src/**/*.{js,jsx,json,css,md}\"",
+    "prepare": "husky",
+    "prepublishOnly": "npm run build:all"
+  },
+  "keywords": [
+    "karaoke",
+    "audio",
+    "electron",
+    "music",
+    "coaching",
+    "autotune"
+  ],
+  "author": "Luis Montes",
+  "license": "AGPL-3.0",
+  "devDependencies": {
+    "@eslint/js": "^9.37.0",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.0",
+    "@testing-library/user-event": "^14.6.1",
+    "@vitejs/plugin-react": "^5.0.4",
+    "@vitest/coverage-v8": "^3.2.4",
+    "@vitest/ui": "^3.2.4",
+    "autoprefixer": "^10.4.21",
+    "electron-builder": "^26.0.12",
+    "electron-rebuild": "^3.2.9",
+    "eslint": "^9.37.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.0.0",
+    "globals": "^16.4.0",
+    "happy-dom": "^20.0.0",
+    "husky": "^9.1.7",
+    "jsdom": "^27.0.0",
+    "lint-staged": "^16.2.4",
+    "postcss": "^8.5.6",
+    "prettier": "^3.6.2",
+    "tailwindcss": "^3.4.18",
+    "vite": "^7.1.9",
+    "vitest": "^3.2.4"
+  },
+  "dependencies": {
+    "@anthropic-ai/sdk": "^0.71.1",
+    "@google/generative-ai": "^0.24.1",
+    "@soundtouchjs/audio-worklet": "^0.2.1",
+    "aubiojs": "^0.2.1",
+    "bcryptjs": "^3.0.2",
+    "butterchurn": "^2.6.7",
+    "butterchurn-presets": "^2.4.7",
+    "cdgraphics": "^7.0.0",
+    "cookie-session": "^2.1.1",
+    "cors": "^2.8.5",
+    "electron": "^40.6.0",
+    "express": "^5.1.0",
+    "express-rate-limit": "^8.1.0",
+    "fuse.js": "^7.1.0",
+    "m4a-stems": "^0.3.0",
+    "music-metadata": "^11.9.0",
+    "node-id3": "^0.2.9",
+    "openai": "^6.10.0",
+    "qrcode": "^1.5.4",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
+    "socket.io": "^4.8.1",
+    "socket.io-client": "^4.8.1",
+    "tar": "^7.5.9",
+    "ws": "^8.13.0",
+    "yauzl": "^3.0.0",
+    "yazl": "^3.3.1"
+  },
+  "build": {
+    "appId": "com.loukai.app",
+    "productName": "Loukai Karaoke",
+    "publish": {
+      "provider": "github",
+      "releaseType": "release"
+    },
+    "directories": {
+      "output": "dist"
+    },
+    "files": [
+      "src/**/*",
+      "static/**/*",
+      "node_modules/**/*",
+      "com.loukai.app.desktop",
+      "com.loukai.app.metainfo.xml",
+      "!src/web/node_modules",
+      "!src/web/src"
+    ],
+    "asarUnpack": [
+      "src/main/creator/python/**/*"
+    ],
+    "icon": "static/images/logo.png",
+    "linux": {
+      "target": [
+        {
+          "target": "AppImage",
+          "arch": [
+            "x64",
+            "arm64"
+          ]
+        },
+        {
+          "target": "flatpak",
+          "arch": [
+            "x64",
+            "arm64"
+          ]
+        }
+      ],
+      "icon": "static/images/logo.png",
+      "category": "AudioVideo",
+      "desktop": {
+        "entry": {
+          "Name": "Loukai Karaoke",
+          "Comment": "Free and open source karaoke system for playing and creating stem-based karaoke files",
+          "Categories": "AudioVideo;Audio;Player;"
+        }
+      },
+      "artifactName": "${productName}-${version}-linux-${arch}.${ext}"
+    },
+    "flatpak": {
+      "runtime": "org.freedesktop.Platform",
+      "runtimeVersion": "24.08",
+      "sdk": "org.freedesktop.Sdk",
+      "base": "org.electronjs.Electron2.BaseApp",
+      "baseVersion": "24.08",
+      "files": [
+        [
+          "com.loukai.app.metainfo.xml",
+          "/share/metainfo/com.loukai.app.metainfo.xml"
+        ],
+        [
+          "static/images/logo-512.png",
+          "/share/icons/hicolor/512x512/apps/com.loukai.app.png"
+        ],
+        [
+          "Loukai_app.png",
+          "/share/app-info/media/com.loukai.app.png"
+        ]
+      ],
+      "finishArgs": [
+        "--socket=wayland",
+        "--socket=x11",
+        "--share=ipc",
+        "--device=dri",
+        "--socket=pulseaudio",
+        "--filesystem=home",
+        "--share=network",
+        "--talk-name=org.freedesktop.Notifications"
+      ]
+    },
+    "win": {
+      "target": [
+        {
+          "target": "nsis",
+          "arch": [
+            "x64"
+          ]
+        },
+        {
+          "target": "portable",
+          "arch": [
+            "x64"
+          ]
+        }
+      ],
+      "icon": "static/images/logo.png",
+      "artifactName": "${productName}-${version}-windows-${arch}.${ext}"
+    },
+    "nsis": {
+      "differentialPackage": false,
+      "artifactName": "${productName}-${version}-windows-${arch}-installer.${ext}"
+    },
+    "portable": {
+      "artifactName": "${productName}-${version}-windows-${arch}-portable.${ext}"
+    },
+    "mac": {
+      "target": [
+        {
+          "target": "dmg",
+          "arch": [
+            "x64",
+            "arm64"
+          ]
+        }
+      ],
+      "icon": "static/images/logo.png",
+      "artifactName": "${productName}-${version}-macos-${arch}.${ext}",
+      "identity": null
+    },
+    "dmg": {
+      "writeUpdateInfo": false
+    }
+  },
+  "lint-staged": {
+    "src/**/*.{js,jsx}": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "src/**/*.test.{js,jsx}": [
+      "vitest related --run"
+    ],
+    "src/**/*.{json,css,md}": [
+      "prettier --write"
+    ]
+  },
+  "bin": {
+    "loukai": "bin/loukai.js"
+  },
+  "files": [
+    "src/",
+    "public/",
+    "bin/",
+    "static/"
+  ]
+}

package/src/main/appState.js

@@ -0,0 +1,250 @@
+import StateManager from '../shared/state/StateManager.js';
+import {
+  MIXER_DEFAULTS,
+  EFFECTS_DEFAULTS,
+  AUTOTUNE_DEFAULTS,
+  MICROPHONE_DEFAULTS,
+  AUDIO_DEVICE_DEFAULTS,
+} from '../shared/defaults.js';
+
+/**
+ * AppState - Canonical application state model
+ *
+ * This is the single source of truth for all application state.
+ * Renderer reports changes via IPC, web clients query this state.
+ *
+ * Now extends the universal StateManager with app-specific methods
+ * and maintains backward compatibility with existing code.
+ */
+class AppState extends StateManager {
+  constructor() {
+    // Initialize StateManager with app-specific initial state
+    // Uses imported defaults from shared/defaults.js
+    super({
+      // Playback state (updated frequently from renderer)
+      playback: {
+        isPlaying: false,
+        position: 0, // seconds
+        duration: 0, // seconds
+        songPath: null,
+        lastUpdate: Date.now(),
+      },
+
+      // Current song metadata
+      currentSong: null, // { path, title, artist, duration, requester }
+
+      // Queue
+      queue: [],
+
+      // Mixer state (synced from renderer) - uses MIXER_DEFAULTS
+      mixer: {
+        ...MIXER_DEFAULTS,
+        stems: [], // For reference only: [{ id, name, gain, index }]
+      },
+
+      // Effects state (synced from renderer) - uses EFFECTS_DEFAULTS
+      effects: { ...EFFECTS_DEFAULTS },
+
+      // User preferences (broadcasted to all clients)
+      preferences: {
+        autoTune: { ...AUTOTUNE_DEFAULTS },
+        microphone: { ...MICROPHONE_DEFAULTS },
+        iemMonoVocals: true,
+        audio: {
+          devices: { ...AUDIO_DEVICE_DEFAULTS },
+        },
+      },
+    });
+
+    // Set up event forwarding for backward compatibility
+    // StateManager emits domain-specific events (e.g., 'playbackChanged')
+    // But old code expects 'playbackStateChanged', so we forward playback events
+    this.on('playbackChanged', (state) => this.emit('playbackStateChanged', state, {}));
+
+    // Note: currentSongChanged, queueChanged, mixerChanged, effectsChanged, preferencesChanged
+    // are already emitted by the AppState methods directly for backward compatibility
+  }
+
+  /**
+   * Update playback state from renderer
+   * Called frequently (10x/sec) with position updates
+   */
+  updatePlaybackState(updates) {
+    // Use StateManager's update method
+    const updatesWithTimestamp = {
+      ...updates,
+      lastUpdate: Date.now(),
+    };
+
+    this.update('playback', updatesWithTimestamp);
+  }
+
+  /**
+   * Set current song (called when song is loaded)
+   */
+  setCurrentSong(songData) {
+    const newSong = songData
+      ? {
+          path: songData.path || songData.filePath,
+          title: songData.title,
+          artist: songData.artist,
+          duration: songData.duration || 0,
+          requester: songData.requester || 'KJ',
+          isLoading: songData.isLoading || false, // Preserve loading state
+          format: songData.format, // Preserve format (kai/cdg)
+          queueItemId: songData.queueItemId || null, // Track which queue item is loaded (for duplicate songs)
+        }
+      : null;
+
+    // Update currentSong domain
+    this.state.currentSong = newSong;
+    this.emit('currentSongChanged', newSong);
+
+    // Update playback state with new song
+    const playbackUpdates = songData
+      ? {
+          songPath: songData.path || songData.filePath,
+          duration: songData.duration || 0,
+          position: 0,
+        }
+      : {
+          songPath: null,
+          duration: 0,
+          position: 0,
+        };
+
+    this.update('playback', playbackUpdates);
+  }
+
+  /**
+   * Queue operations
+   */
+  addToQueue(item) {
+    const queueItem = {
+      id: item.id || Date.now() + Math.random(),
+      path: item.path,
+      title: item.title,
+      artist: item.artist,
+      duration: item.duration || 0,
+      requester: item.requester || 'KJ',
+      addedVia: item.addedVia || 'unknown',
+      addedAt: item.addedAt || new Date(),
+    };
+
+    this.state.queue.push(queueItem);
+    this.emit('queueChanged', this.state.queue);
+
+    return queueItem;
+  }
+
+  removeFromQueue(id) {
+    const index = this.state.queue.findIndex((item) => item.id === id);
+    if (index !== -1) {
+      const removed = this.state.queue.splice(index, 1)[0];
+      this.emit('queueChanged', this.state.queue);
+      return removed;
+    }
+    return null;
+  }
+
+  clearQueue() {
+    this.state.queue = [];
+    this.emit('queueChanged', this.state.queue);
+  }
+
+  getQueue() {
+    return [...this.state.queue];
+  }
+
+  /**
+   * Mixer state operations
+   */
+  updateMixerState(mixerState) {
+    this.update('mixer', mixerState);
+  }
+
+  /**
+   * Effects state operations
+   */
+  updateEffectsState(effectsState) {
+    this.update('effects', effectsState);
+  }
+
+  /**
+   * Preferences operations
+   */
+  updatePreferences(preferences) {
+    this.update('preferences', preferences);
+  }
+
+  setAutoTunePreferences(autoTunePrefs) {
+    this.update('preferences', (current) => ({
+      ...current,
+      autoTune: { ...current.autoTune, ...autoTunePrefs },
+    }));
+  }
+
+  setMicrophonePreferences(micPrefs) {
+    this.update('preferences', (current) => ({
+      ...current,
+      microphone: { ...current.microphone, ...micPrefs },
+    }));
+  }
+
+  setAudioDevices(devices) {
+    this.update('preferences', (current) => ({
+      ...current,
+      audio: {
+        ...current.audio,
+        devices: { ...current.audio.devices, ...devices },
+      },
+    }));
+  }
+
+  /**
+   * Get a deep clone of current state for external consumers
+   */
+  getSnapshot() {
+    return JSON.parse(JSON.stringify(this.state));
+  }
+
+  /**
+   * Get current playback position (with interpolation for smooth updates)
+   */
+  getCurrentPosition() {
+    if (this.state.playback.isPlaying && this.state.playback.lastUpdate) {
+      const elapsedMs = Date.now() - this.state.playback.lastUpdate;
+      const estimatedPosition = this.state.playback.position + elapsedMs / 1000;
+
+      // Don't exceed duration
+      if (this.state.playback.duration > 0) {
+        return Math.min(estimatedPosition, this.state.playback.duration);
+      }
+
+      return estimatedPosition;
+    }
+
+    return this.state.playback.position;
+  }
+
+  /**
+   * Check if a song is currently in queue by path
+   */
+  findSongInQueue(songPath) {
+    return this.state.queue.find((item) => item.path === songPath);
+  }
+
+  /**
+   * Get queue statistics
+   */
+  getQueueStats() {
+    const totalDuration = this.state.queue.reduce((sum, item) => sum + (item.duration || 0), 0);
+    return {
+      count: this.state.queue.length,
+      totalDuration,
+      currentSongPath: this.state.playback.songPath,
+    };
+  }
+}
+
+export default AppState;