loukai-app 0.3.0

package/src/shared/ipcContracts.js

@@ -0,0 +1,299 @@
+/**
+ * IPC Contracts - Central definition of all IPC channels
+ *
+ * This file defines all IPC communication channels between:
+ * - Main process (Node.js)
+ * - Renderer process (Electron UI)
+ *
+ * Benefits:
+ * - Single source of truth for all IPC channels
+ * - Easy to see all available APIs at a glance
+ * - Prevents typos in channel names
+ * - Makes refactoring safer
+ */
+
+// ============================================================================
+// APP CHANNELS
+// ============================================================================
+
+export const APP_CHANNELS = {
+  GET_VERSION: 'app:getVersion',
+  GET_STATE: 'app:getState',
+};
+
+// ============================================================================
+// FILE CHANNELS
+// ============================================================================
+
+export const FILE_CHANNELS = {
+  OPEN_KAI: 'file:openKai',
+  LOAD_KAI_FROM_PATH: 'file:loadKaiFromPath',
+};
+
+// ============================================================================
+// AUDIO CHANNELS
+// ============================================================================
+
+export const AUDIO_CHANNELS = {
+  GET_DEVICES: 'audio:getDevices',
+  ENUMERATE_DEVICES: 'audio:enumerateDevices',
+  SET_DEVICE: 'audio:setDevice',
+
+  // Events (main → renderer)
+  XRUN: 'audio:xrun',
+  LATENCY: 'audio:latency',
+};
+
+// ============================================================================
+// MIXER CHANNELS
+// ============================================================================
+
+export const MIXER_CHANNELS = {
+  SET_MASTER_GAIN: 'mixer:setMasterGain',
+  TOGGLE_MASTER_MUTE: 'mixer:toggleMasterMute',
+
+  // Events (main → renderer)
+  STATE_CHANGE: 'mixer:state',
+  SET_MASTER_MUTE: 'mixer:setMasterMute',
+};
+
+// ============================================================================
+// PLAYER CHANNELS
+// ============================================================================
+
+export const PLAYER_CHANNELS = {
+  PLAY: 'player:play',
+  PAUSE: 'player:pause',
+  SEEK: 'player:seek',
+  RESTART: 'player:restart',
+  NEXT: 'player:next',
+};
+
+// ============================================================================
+// AUTOTUNE CHANNELS
+// ============================================================================
+
+export const AUTOTUNE_CHANNELS = {
+  SET_ENABLED: 'autotune:setEnabled',
+  SET_SETTINGS: 'autotune:setSettings',
+};
+
+// ============================================================================
+// SONG CHANNELS
+// ============================================================================
+
+export const SONG_CHANNELS = {
+  GET_CURRENT_SONG: 'song:getCurrentSong',
+
+  // Events (main → renderer)
+  LOADED: 'song:loaded',
+  DATA: 'song:data',
+};
+
+// ============================================================================
+// EDITOR CHANNELS
+// ============================================================================
+
+export const EDITOR_CHANNELS = {
+  SAVE_KAI: 'editor:saveKai',
+  RELOAD_KAI: 'editor:reloadKai',
+};
+
+// ============================================================================
+// WINDOW CHANNELS
+// ============================================================================
+
+export const WINDOW_CHANNELS = {
+  OPEN_CANVAS: 'window:openCanvas',
+};
+
+// ============================================================================
+// CANVAS CHANNELS
+// ============================================================================
+
+export const CANVAS_CHANNELS = {
+  START_STREAMING: 'canvas:startStreaming',
+  STOP_STREAMING: 'canvas:stopStreaming',
+  SEND_IMAGE_DATA: 'canvas:sendImageData',
+  SEND_ICE_CANDIDATE: 'canvas:sendICECandidate',
+  TOGGLE_FULLSCREEN: 'canvas:toggleFullscreen',
+  SEND_FRAME: 'canvas:sendFrame',
+};
+
+// ============================================================================
+// LIBRARY CHANNELS
+// ============================================================================
+
+export const LIBRARY_CHANNELS = {
+  GET_SONGS_FOLDER: 'library:getSongsFolder',
+  SET_SONGS_FOLDER: 'library:setSongsFolder',
+  SCAN_FOLDER: 'library:scanFolder',
+  SYNC_LIBRARY: 'library:syncLibrary',
+  GET_CACHED_SONGS: 'library:getCachedSongs',
+  GET_SONG_INFO: 'library:getSongInfo',
+
+  // Events (main → renderer)
+  FOLDER_SET: 'library:folderSet',
+};
+
+// ============================================================================
+// WEB SERVER CHANNELS
+// ============================================================================
+
+export const WEB_SERVER_CHANNELS = {
+  GET_PORT: 'webServer:getPort',
+  GET_URL: 'webServer:getUrl',
+  GET_SETTINGS: 'webServer:getSettings',
+  UPDATE_SETTINGS: 'webServer:updateSettings',
+  GET_SONG_REQUESTS: 'webServer:getSongRequests',
+  APPROVE_REQUEST: 'webServer:approveRequest',
+  REJECT_REQUEST: 'webServer:rejectRequest',
+  REFRESH_CACHE: 'webServer:refreshCache',
+};
+
+// ============================================================================
+// SETTINGS CHANNELS
+// ============================================================================
+
+export const SETTINGS_CHANNELS = {
+  GET: 'settings:get',
+  SET: 'settings:set',
+  GET_ALL: 'settings:getAll',
+  UPDATE_BATCH: 'settings:updateBatch',
+
+  // Events (main → renderer)
+  UPDATE: 'settings:update',
+};
+
+// ============================================================================
+// QUEUE CHANNELS
+// ============================================================================
+
+export const QUEUE_CHANNELS = {
+  ADD_SONG: 'queue:addSong',
+  REMOVE_SONG: 'queue:removeSong',
+  GET: 'queue:get',
+  CLEAR: 'queue:clear',
+};
+
+// ============================================================================
+// EFFECT CHANNELS
+// ============================================================================
+
+export const EFFECT_CHANNELS = {
+  // Events (main → renderer)
+  NEXT: 'effect:next',
+  PREVIOUS: 'effect:previous',
+};
+
+// ============================================================================
+// ADMIN CHANNELS (web admin → renderer)
+// ============================================================================
+
+export const ADMIN_CHANNELS = {
+  PLAY: 'admin:play',
+  NEXT: 'admin:next',
+  RESTART: 'admin:restart',
+};
+
+// ============================================================================
+// RENDERER CHANNELS (renderer → main, one-way sends)
+// ============================================================================
+
+export const RENDERER_CHANNELS = {
+  PLAYBACK_STATE: 'renderer:playbackState',
+  UPDATE_PLAYBACK_STATE: 'renderer:updatePlaybackState',
+  SONG_LOADED: 'renderer:songLoaded',
+  UPDATE_MIXER_STATE: 'renderer:updateMixerState',
+  UPDATE_EFFECTS_STATE: 'renderer:updateEffectsState',
+};
+
+// ============================================================================
+// SHELL CHANNELS
+// ============================================================================
+
+export const SHELL_CHANNELS = {
+  OPEN_EXTERNAL: 'shell:openExternal',
+};
+
+// ============================================================================
+// CREATOR CHANNELS
+// ============================================================================
+
+export const CREATOR_CHANNELS = {
+  CHECK_COMPONENTS: 'creator:checkComponents',
+  INSTALL_COMPONENTS: 'creator:installComponents',
+  GET_STATUS: 'creator:getStatus',
+  CANCEL_INSTALL: 'creator:cancelInstall',
+  SEARCH_LYRICS: 'creator:searchLyrics',
+  PREPARE_WHISPER_CONTEXT: 'creator:prepareWhisperContext',
+  SELECT_FILE: 'creator:selectFile',
+  START_CONVERSION: 'creator:startConversion',
+  CANCEL_CONVERSION: 'creator:cancelConversion',
+
+  // LLM settings
+  GET_LLM_SETTINGS: 'creator:getLLMSettings',
+  SAVE_LLM_SETTINGS: 'creator:saveLLMSettings',
+  TEST_LLM_CONNECTION: 'creator:testLLMConnection',
+
+  // Events (main → renderer)
+  INSTALL_PROGRESS: 'creator:installProgress',
+  INSTALL_CONSOLE: 'creator:installConsole',
+  INSTALL_ERROR: 'creator:installError',
+  CONVERSION_PROGRESS: 'creator:conversionProgress',
+  CONVERSION_CONSOLE: 'creator:conversionConsole',
+  CONVERSION_COMPLETE: 'creator:conversionComplete',
+  CONVERSION_ERROR: 'creator:conversionError',
+};
+
+// ============================================================================
+// ALL CHANNELS (for validation)
+// ============================================================================
+
+export const ALL_CHANNELS = {
+  ...APP_CHANNELS,
+  ...FILE_CHANNELS,
+  ...AUDIO_CHANNELS,
+  ...MIXER_CHANNELS,
+  ...PLAYER_CHANNELS,
+  ...AUTOTUNE_CHANNELS,
+  ...SONG_CHANNELS,
+  ...EDITOR_CHANNELS,
+  ...WINDOW_CHANNELS,
+  ...CANVAS_CHANNELS,
+  ...LIBRARY_CHANNELS,
+  ...WEB_SERVER_CHANNELS,
+  ...SETTINGS_CHANNELS,
+  ...QUEUE_CHANNELS,
+  ...EFFECT_CHANNELS,
+  ...ADMIN_CHANNELS,
+  ...RENDERER_CHANNELS,
+  ...SHELL_CHANNELS,
+  ...CREATOR_CHANNELS,
+};
+
+// ============================================================================
+// CHANNEL GROUPS (for handler organization)
+// ============================================================================
+
+export const CHANNEL_GROUPS = {
+  APP: Object.values(APP_CHANNELS),
+  FILE: Object.values(FILE_CHANNELS),
+  AUDIO: Object.values(AUDIO_CHANNELS),
+  MIXER: Object.values(MIXER_CHANNELS),
+  PLAYER: Object.values(PLAYER_CHANNELS),
+  AUTOTUNE: Object.values(AUTOTUNE_CHANNELS),
+  SONG: Object.values(SONG_CHANNELS),
+  EDITOR: Object.values(EDITOR_CHANNELS),
+  WINDOW: Object.values(WINDOW_CHANNELS),
+  CANVAS: Object.values(CANVAS_CHANNELS),
+  LIBRARY: Object.values(LIBRARY_CHANNELS),
+  WEB_SERVER: Object.values(WEB_SERVER_CHANNELS),
+  SETTINGS: Object.values(SETTINGS_CHANNELS),
+  QUEUE: Object.values(QUEUE_CHANNELS),
+  EFFECT: Object.values(EFFECT_CHANNELS),
+  ADMIN: Object.values(ADMIN_CHANNELS),
+  RENDERER: Object.values(RENDERER_CHANNELS),
+  SHELL: Object.values(SHELL_CHANNELS),
+  CREATOR: Object.values(CREATOR_CHANNELS),
+};

package/src/shared/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/src/shared/services/creatorService.js

@@ -0,0 +1,373 @@
+/**
+ * Creator Service - Shared service for karaoke file creation
+ *
+ * Used by both:
+ * - IPC handlers (Electron renderer)
+ * - HTTP routes (Web admin)
+ *
+ * Progress callbacks support both IPC (mainApp.sendToRenderer) and
+ * Socket.IO (io.emit) for real-time updates.
+ */
+
+import {
+  checkAllComponents,
+  getCacheDir,
+  getPythonPath,
+} from '../../main/creator/systemChecker.js';
+import { installAllComponents } from '../../main/creator/downloadManager.js';
+import { searchLyrics, prepareWhisperContext } from '../../main/creator/lrclibService.js';
+import { getAudioInfo, isVideoFile } from '../../main/creator/ffmpegService.js';
+import {
+  runConversion,
+  cancelConversion,
+  isConversionInProgress,
+} from '../../main/creator/conversionService.js';
+import { repairStemFile, repairStemFiles } from '../../main/creator/stemBuilder.js';
+import { basename } from 'path';
+import { Atoms as M4AAtoms } from 'm4a-stems';
+
+// Track installation state
+let installationInProgress = false;
+let installationCancelled = false;
+
+/**
+ * Check all components status
+ * @returns {Promise<Object>} Component status
+ */
+export async function checkComponents() {
+  try {
+    const result = await checkAllComponents();
+    return {
+      success: true,
+      ...result,
+    };
+  } catch (error) {
+    console.error('Failed to check components:', error);
+    return {
+      success: false,
+      error: error.message,
+    };
+  }
+}
+
+/**
+ * Get installation status
+ * @returns {Object} Status info
+ */
+export function getStatus() {
+  return {
+    installing: installationInProgress,
+    cancelled: installationCancelled,
+    converting: isConversionInProgress(),
+    cacheDir: getCacheDir(),
+    pythonPath: getPythonPath(),
+  };
+}
+
+/**
+ * Install all components
+ * @param {Function} onProgress - Progress callback (progress, message)
+ * @returns {Promise<Object>} Installation result
+ */
+export async function installComponents(onProgress) {
+  if (installationInProgress) {
+    return { success: false, error: 'Installation already in progress' };
+  }
+
+  installationInProgress = true;
+  installationCancelled = false;
+
+  try {
+    onProgress?.({
+      step: 'starting',
+      message: 'Starting installation...',
+      progress: 0,
+    });
+
+    const result = await installAllComponents((progress, message) => {
+      if (installationCancelled) {
+        throw new Error('Installation cancelled');
+      }
+
+      onProgress?.({
+        step: 'installing',
+        message,
+        progress,
+      });
+    });
+
+    if (result.success) {
+      onProgress?.({
+        step: 'complete',
+        message: 'Installation complete',
+        progress: 100,
+      });
+    }
+
+    installationInProgress = false;
+    return result;
+  } catch (error) {
+    installationInProgress = false;
+    return { success: false, error: error.message };
+  }
+}
+
+/**
+ * Cancel installation
+ * @returns {Object} Result
+ */
+export function cancelInstall() {
+  if (!installationInProgress) {
+    return { success: false, error: 'No installation in progress' };
+  }
+
+  installationCancelled = true;
+  return { success: true };
+}
+
+/**
+ * Search for lyrics
+ * @param {string} title - Song title
+ * @param {string} artist - Artist name
+ * @returns {Promise<Object>} Lyrics result
+ */
+export async function findLyrics(title, artist) {
+  try {
+    const result = await searchLyrics(title, artist);
+    if (result) {
+      return { success: true, ...result };
+    }
+    return { success: false, error: 'No lyrics found' };
+  } catch (error) {
+    console.error('Lyrics search failed:', error);
+    return { success: false, error: error.message };
+  }
+}
+
+/**
+ * Prepare Whisper context with vocabulary hints
+ * @param {string} title - Song title
+ * @param {string} artist - Artist name
+ * @param {string} existingLyrics - Reference lyrics
+ * @returns {Promise<Object>} Context result
+ */
+export async function getWhisperContext(title, artist, existingLyrics) {
+  try {
+    const result = await prepareWhisperContext(title, artist, existingLyrics);
+    return { success: true, ...result };
+  } catch (error) {
+    console.error('Whisper context preparation failed:', error);
+    return { success: false, error: error.message };
+  }
+}
+
+/**
+ * Get file info for a path
+ * Reads ID3 tags if available, falls back to filename parsing.
+ * Auto-searches LRCLIB for lyrics if artist and title are found.
+ * Detects M4A files with existing stems but no karaoke lyrics.
+ *
+ * @param {string} filePath - Path to audio/video file
+ * @returns {Promise<Object>} File info with optional lyrics
+ */
+export async function getFileInfo(filePath) {
+  try {
+    const fileName = basename(filePath);
+    const audioInfo = await getAudioInfo(filePath);
+    const isVideo = await isVideoFile(filePath);
+    const lowerPath = filePath.toLowerCase();
+
+    // Prefer ID3 tags, fall back to filename parsing
+    let title = audioInfo.title || '';
+    let artist = audioInfo.artist || '';
+    const album = audioInfo.album || '';
+
+    // If no ID3 tags, try to parse from filename (Artist - Title format)
+    if (!title) {
+      title = fileName.replace(/\.[^.]+$/, '');
+      const dashMatch = title.match(/^(.+?)\s*-\s*(.+)$/);
+      if (dashMatch) {
+        artist = artist || dashMatch[1].trim();
+        title = dashMatch[2].trim();
+      }
+    }
+
+    // Check for M4A with existing stems (NI Stems format has 5 audio streams: master + 4 stems)
+    let hasStems = false;
+    let hasLyrics = false;
+    let stemNames = [];
+    let vocalsTrackIndex = null;
+
+    if (lowerPath.endsWith('.m4a') || lowerPath.endsWith('.mp4')) {
+      // Check for multiple audio streams (stems)
+      if (audioInfo.audioStreamCount >= 4) {
+        hasStems = true;
+        stemNames = audioInfo.audioStreams.map((s) => s.title);
+
+        // Find vocals track index
+        const vocalsStream = audioInfo.audioStreams.find((s) => s.title.toLowerCase() === 'vocals');
+        if (vocalsStream) {
+          vocalsTrackIndex = vocalsStream.index;
+        }
+
+        console.log(
+          `🎵 Detected stem file: ${audioInfo.audioStreamCount} tracks [${stemNames.join(', ')}]`
+        );
+      }
+
+      // Check for existing kara atom with lyrics
+      if (hasStems) {
+        try {
+          const karaData = await M4AAtoms.readKaraAtom(filePath);
+          if (karaData && karaData.lines && karaData.lines.length > 0) {
+            hasLyrics = true;
+            console.log(`📝 Found existing lyrics: ${karaData.lines.length} lines`);
+          }
+        } catch {
+          // No kara atom - that's fine, we'll add one
+        }
+      }
+    }
+
+    const result = {
+      success: true,
+      file: {
+        path: filePath,
+        name: fileName,
+        title,
+        artist,
+        album,
+        duration: audioInfo.duration,
+        sampleRate: audioInfo.sampleRate,
+        channels: audioInfo.channels,
+        codec: audioInfo.codec,
+        isVideo,
+        hasId3Tags: Boolean(audioInfo.title || audioInfo.artist),
+        // Preserve ALL original tags for inclusion in output file
+        tags: audioInfo.tags || {},
+        // Stem detection info
+        hasStems,
+        hasLyrics,
+        stemNames,
+        vocalsTrackIndex,
+        audioStreamCount: audioInfo.audioStreamCount,
+      },
+    };
+
+    // Auto-search LRCLIB if we have both artist and title
+    if (artist && title) {
+      try {
+        const lyricsResult = await searchLyrics(title, artist);
+        if (lyricsResult) {
+          result.lyrics = lyricsResult;
+        }
+      } catch (e) {
+        // Non-fatal - lyrics lookup failed
+        console.log('Auto lyrics lookup failed:', e.message);
+      }
+    }
+
+    return result;
+  } catch (error) {
+    console.error('Failed to get file info:', error);
+    return { success: false, error: error.message };
+  }
+}
+
+/**
+ * Start conversion
+ * @param {Object} options - Conversion options
+ * @param {Function} onProgress - Progress callback
+ * @param {Function} onConsoleOutput - Console output callback
+ * @param {Object} settingsManager - Settings manager for LLM settings
+ * @returns {Promise<Object>} Conversion result
+ */
+export async function startConversion(
+  options,
+  onProgress,
+  onConsoleOutput = null,
+  settingsManager = null
+) {
+  if (isConversionInProgress()) {
+    return { success: false, error: 'Conversion already in progress' };
+  }
+
+  try {
+    onProgress?.({
+      step: 'starting',
+      message: 'Starting conversion...',
+      progress: 0,
+    });
+
+    const result = await runConversion(
+      options,
+      (step, message, progress) => {
+        onProgress?.({
+          step,
+          message,
+          progress,
+        });
+      },
+      onConsoleOutput,
+      settingsManager
+    );
+
+    return result;
+  } catch (error) {
+    console.error('Conversion failed:', error);
+    return { success: false, error: error.message };
+  }
+}
+
+/**
+ * Cancel conversion
+ * @returns {Object} Result
+ */
+export function stopConversion() {
+  const cancelled = cancelConversion();
+  return { success: cancelled };
+}
+
+/**
+ * Repair a stem file to fix NI Stems metadata
+ * @param {string} filePath - Path to .stem.m4a file
+ * @returns {Promise<Object>} Repair result
+ */
+export async function repairStem(filePath) {
+  try {
+    const result = await repairStemFile(filePath);
+    return result;
+  } catch (error) {
+    console.error('Failed to repair stem file:', error);
+    return { success: false, error: error.message };
+  }
+}
+
+/**
+ * Batch repair multiple stem files
+ * @param {string[]} filePaths - Array of paths to .stem.m4a files
+ * @returns {Promise<Object>} Batch repair results
+ */
+export async function repairStems(filePaths) {
+  try {
+    const result = await repairStemFiles(filePaths);
+    return result;
+  } catch (error) {
+    console.error('Failed to batch repair stem files:', error);
+    return { success: false, error: error.message };
+  }
+}
+
+export default {
+  checkComponents,
+  getStatus,
+  installComponents,
+  cancelInstall,
+  findLyrics,
+  getWhisperContext,
+  getFileInfo,
+  startConversion,
+  stopConversion,
+  repairStem,
+  repairStems,
+};