emoemu 0.1.0

package/src/cores/libretro/coreOptions/consts.ts

@@ -0,0 +1,36 @@
+/**
+ * Default core options for emoemu compatibility.
+ *
+ * Since emoemu is terminal-based and doesn't have GPU support, some cores
+ * need specific options to work (e.g., software rendering for N64).
+ * These defaults are applied automatically when creating a core.
+ *
+ * Keys are matched against the core's library name (case-insensitive).
+ */
+export const DEFAULT_CORE_OPTIONS: Record<string, Record<string, string>> = {
+  // N64: Use Angrylion software renderer (no GPU required)
+  // Also enable auto-crop to remove black borders many N64 games add
+  'mupen64plus': {
+    'mupen64plus-rdp-plugin': 'angrylion',
+    'mupen64plus-rsp-plugin': 'cxd4',  // Required for Angrylion (HLE RSP won't work)
+    'mupen64plus-cpucore': 'cached_interpreter',  // ARM64 doesn't have dynarec
+    'mupen64plus-angrylion-multithread': 'all threads',
+    'mupen64plus-aspect': '4:3',
+    'mupen64plus-43screensize': '640x480',
+    'mupen64plus-CropMode': 'Auto',
+    // Angrylion VI settings (VI filter can cause black screen)
+    'mupen64plus-angrylion-vioverlay': 'Filtered',
+    'mupen64plus-angrylion-sync': 'Low',
+    'mupen64plus-virefresh': 'Auto',
+    // Disable frame duping to ensure we always get frames
+    'mupen64plus-FrameDuping': 'False',
+    // Controller pak (memory pak enables save support)
+    'mupen64plus-pak1': 'memory',
+    'mupen64plus-pak2': 'none',
+    'mupen64plus-pak3': 'none',
+    'mupen64plus-pak4': 'none',
+    // Analog stick settings (deadzone 0 for full sensitivity)
+    'mupen64plus-astick-deadzone': '0',
+    'mupen64plus-astick-sensitivity': '100',
+  },
+};

package/src/cores/libretro/coreOptions/index.ts

@@ -0,0 +1,222 @@
+/**
+ * Core Options Configuration
+ *
+ * Handles loading and saving libretro core options in RetroArch-compatible format.
+ * Options are stored in INI format with keys matching RetroArch conventions.
+ *
+ * Example format:
+ *   mupen64plus-rdp-plugin = "angrylion"
+ *   mupen64plus-rsp-plugin = "parallel"
+ *   genesis_plus_gx-region_detect = "auto"
+ */
+
+import { existsSync, readFileSync, writeFileSync } from "fs";
+import { ensureDirectory } from '@/utils/ensureDirectory';
+import { dirname, join } from "path";
+import { pipe, filter, map, isNonNull, fromEntries } from "remeda";
+import { getConfigDirectory } from "@/utils/paths";
+import { parseIniLine, formatIniValue } from "@/utils/ini";
+import { logger } from "@/utils/logger";
+
+export * from './consts';
+
+import { DEFAULT_CORE_OPTIONS } from './consts';
+
+/** Normalize a core name to lowercase with underscores (e.g., "Mupen64Plus-Next" → "mupen64plus_next") */
+const normalizeCoreName = (coreName: string): string =>
+  coreName.toLowerCase().replace(/[^a-z0-9]+/g, '_');
+
+/**
+ * Get the default path for the core options config file.
+ * Follows RetroArch convention: config_dir/retroarch-core-options.cfg
+ */
+export const getDefaultCoreOptionsPath = (): string =>
+  join(getConfigDirectory(), "retroarch-core-options.cfg");
+
+/**
+ * Get the path for a core-specific options file.
+ * Format: config_dir/config/core_name/core_name.opt
+ */
+export const getCoreSpecificOptionsPath = (coreName: string): string =>
+  join(getConfigDirectory(), "config", coreName, `${coreName}.opt`);
+
+/**
+ * Get the path for a game-specific options file.
+ * Format: config_dir/config/core_name/game_name.opt
+ */
+export const getGameSpecificOptionsPath = (coreName: string, gameName: string): string =>
+  join(getConfigDirectory(), "config", coreName, `${gameName}.opt`);
+
+/**
+ * Parse core options from a config file content.
+ * Only includes lines that look like core options (contain hyphens, typical of libretro options).
+ *
+ * @param content File content to parse
+ * @param corePrefix Optional prefix to filter options (e.g., "mupen64plus")
+ * @returns Record of option key-value pairs
+ */
+export const parseCoreOptionsContent = (
+  content: string,
+  corePrefix?: string
+): Record<string, string> => {
+  const entries = pipe(
+    content.split('\n'),
+    map(parseIniLine),
+    filter(isNonNull),
+    // Core options typically have hyphens in their keys (e.g., "core-name-option")
+    filter(({ key }) => key.includes('-') || key.includes('_')),
+    // Optionally filter by core prefix
+    filter(({ key }) => !corePrefix || key.startsWith(corePrefix)),
+    map(({ key, value }) => [key, value] as const),
+  );
+  return fromEntries(entries) as Record<string, string>;
+};
+
+/**
+ * Load core options from a config file.
+ *
+ * @param filePath Path to the config file
+ * @param corePrefix Optional prefix to filter options
+ * @returns Record of option key-value pairs, or empty object if file doesn't exist
+ */
+export const loadCoreOptionsFile = (
+  filePath: string,
+  corePrefix?: string
+): Record<string, string> => {
+  if (!existsSync(filePath)) {
+    return {};
+  }
+
+  try {
+    const content = readFileSync(filePath, "utf-8");
+    const options = parseCoreOptionsContent(content, corePrefix);
+
+    if (Object.keys(options).length > 0) {
+      logger.debug(`Loaded ${Object.keys(options).length} core options from ${filePath}`, 'CoreOptions');
+    }
+
+    return options;
+  } catch (err) {
+    logger.warn(`Failed to load core options from ${filePath}: ${err}`, 'CoreOptions');
+    return {};
+  }
+};
+
+/**
+ * Load core options with RetroArch-compatible precedence:
+ * 1. Game-specific options (highest priority)
+ * 2. Core-specific options
+ * 3. Global core options (lowest priority)
+ *
+ * @param coreName The core name (e.g., "mupen64plus_next")
+ * @param gameName Optional game name for game-specific options
+ * @returns Merged options with higher precedence overriding lower
+ */
+export const loadCoreOptions = (
+  coreName: string,
+  gameName?: string
+): Record<string, string> => {
+  // Normalize core name (convert spaces/special chars to underscores)
+  const normalizedCoreName = normalizeCoreName(coreName);
+
+  // Extract core prefix from the core name (e.g., "mupen64plus" from "mupen64plus_next")
+  // This is used to filter options that belong to this core
+  const corePrefix = normalizedCoreName.split('_')[0];
+
+  // Load options in order of precedence (lowest to highest)
+  const globalOptions = loadCoreOptionsFile(getDefaultCoreOptionsPath(), corePrefix);
+  const coreOptions = loadCoreOptionsFile(getCoreSpecificOptionsPath(normalizedCoreName));
+
+  let gameOptions: Record<string, string> = {};
+  if (gameName) {
+    const normalizedGameName = gameName.replace(/\.[^.]+$/, ''); // Remove extension
+    gameOptions = loadCoreOptionsFile(getGameSpecificOptionsPath(normalizedCoreName, normalizedGameName));
+  }
+
+  // Merge with higher precedence overriding lower
+  return {
+    ...globalOptions,
+    ...coreOptions,
+    ...gameOptions,
+  };
+};
+
+/**
+ * Save core options to the global core options file.
+ *
+ * @param options Options to save
+ * @param append If true, merge with existing options; if false, replace entirely
+ */
+export const saveCoreOptions = (
+  options: Record<string, string>,
+  append = true
+): void => {
+  const filePath = getDefaultCoreOptionsPath();
+  const dir = dirname(filePath);
+
+  ensureDirectory(dir);
+
+  // Load existing options if appending
+  let mergedOptions = options;
+  if (append && existsSync(filePath)) {
+    const existing = loadCoreOptionsFile(filePath);
+    mergedOptions = { ...existing, ...options };
+  }
+
+  // Format as INI content
+  const lines = Object.entries(mergedOptions)
+    .sort(([a], [b]) => a.localeCompare(b)) // Sort by key for consistency
+    .map(([key, value]) => `${key} = ${formatIniValue(value)}`);
+
+  const content = `# emoemu Core Options\n# RetroArch-compatible format\n\n${lines.join('\n')}\n`;
+
+  writeFileSync(filePath, content, "utf-8");
+  logger.info(`Saved ${Object.keys(mergedOptions).length} core options to ${filePath}`, 'CoreOptions');
+};
+
+/**
+ * Save core-specific options to the core's config directory.
+ *
+ * @param coreName The core name
+ * @param options Options to save
+ */
+export const saveCoreSpecificOptions = (
+  coreName: string,
+  options: Record<string, string>
+): void => {
+  const normalizedCoreName = normalizeCoreName(coreName);
+  const filePath = getCoreSpecificOptionsPath(normalizedCoreName);
+  const dir = dirname(filePath);
+
+  ensureDirectory(dir);
+
+  // Format as INI content
+  const lines = Object.entries(options)
+    .sort(([a], [b]) => a.localeCompare(b))
+    .map(([key, value]) => `${key} = ${formatIniValue(value)}`);
+
+  const content = `# Core options for ${coreName}\n\n${lines.join('\n')}\n`;
+
+  writeFileSync(filePath, content, "utf-8");
+  logger.info(`Saved core-specific options to ${filePath}`, 'CoreOptions');
+};
+
+
+/**
+ * Get default core options for a given core name.
+ * Returns options needed for emoemu compatibility (e.g., software rendering).
+ *
+ * @param coreName The core's library name (e.g., "Mupen64Plus-Next")
+ * @returns Default options for the core, or undefined if none needed
+ */
+export const getDefaultCoreOptions = (coreName: string): Record<string, string> | undefined => {
+  const lowerName = coreName.toLowerCase();
+
+  for (const [pattern, options] of Object.entries(DEFAULT_CORE_OPTIONS)) {
+    if (lowerName.includes(pattern.toLowerCase())) {
+      return { ...options };
+    }
+  }
+
+  return undefined;
+};

package/src/cores/libretro/environment/consts.ts

@@ -0,0 +1,118 @@
+// =============================================================================
+// Environment Handler Constants
+// =============================================================================
+
+/** Maximum number of input players supported */
+export const MAX_INPUT_USERS = 2;
+
+/** Core options API version supported */
+export const CORE_OPTIONS_VERSION = 2;
+
+/** Message interface version supported */
+export const MESSAGE_INTERFACE_VERSION = 1;
+
+/** Audio enable bit (bit 1) */
+export const AUDIO_ENABLE_BIT = 0b10;
+
+/** Video enable bit (bit 0) */
+export const VIDEO_ENABLE_BIT = 0b01;
+
+// =============================================================================
+// Memory Map Constants (64-bit system layout)
+// =============================================================================
+
+/** Size of retro_memory_map struct header (pointer + uint32) on 64-bit */
+export const MEMORY_MAP_HEADER_SIZE = 16;
+
+/** Byte offset of num_descriptors in retro_memory_map struct */
+export const MEMORY_MAP_NUM_DESC_OFFSET = 8;
+
+/** Size of retro_memory_descriptor struct on 64-bit system */
+export const MEMORY_DESCRIPTOR_SIZE = 64;
+
+/** Byte offset of 'len' field (size_t) in memory descriptor struct */
+export const MEMORY_DESC_LEN_OFFSET = 48;
+
+/** High word offset for 64-bit len field */
+export const MEMORY_DESC_LEN_HIGH_OFFSET = 52;
+
+/** Byte offset of 'ptr' field (void*) in memory descriptor struct */
+export const MEMORY_DESC_PTR_OFFSET = 8;
+
+/** Multiplier for combining high 32-bit word in 64-bit value */
+export const UINT32_MULTIPLIER = 0x100000000;
+
+/** Maximum descriptors to scan when looking for SRAM */
+export const MAX_DESCRIPTORS_TO_SCAN = 10;
+
+/** Pointer size on 64-bit system */
+export const POINTER_SIZE_64BIT = 8;
+
+// =============================================================================
+// Message Struct Constants (64-bit system layout)
+// =============================================================================
+
+/** Size of retro_message struct on 64-bit system (pointer + uint32 + padding) */
+export const MESSAGE_STRUCT_SIZE = 16;
+
+/** Byte offset of 'frames' field in retro_message struct */
+export const MESSAGE_FRAMES_OFFSET = 8;
+
+/** Size of retro_message_ext struct on 64-bit system */
+export const MESSAGE_EXT_STRUCT_SIZE = 32;
+
+/** Byte offset of 'duration' field in retro_message_ext struct */
+export const MESSAGE_EXT_DURATION_OFFSET = 8;
+
+/** Byte offset of 'priority' field in retro_message_ext struct */
+export const MESSAGE_EXT_PRIORITY_OFFSET = 12;
+
+/** Byte offset of 'level' field in retro_message_ext struct */
+export const MESSAGE_EXT_LEVEL_OFFSET = 16;
+
+/** Byte offset of 'target' field in retro_message_ext struct */
+export const MESSAGE_EXT_TARGET_OFFSET = 20;
+
+/** Byte offset of 'type' field in retro_message_ext struct */
+export const MESSAGE_EXT_TYPE_OFFSET = 24;
+
+/** Byte offset of 'progress' field in retro_message_ext struct */
+export const MESSAGE_EXT_PROGRESS_OFFSET = 28;
+
+// =============================================================================
+// Memory Descriptor Flag Bit Positions
+// =============================================================================
+
+/** Bit position for RETRO_MEMDESC_SAVE_RAM flag */
+export const MEMDESC_SAVE_RAM_BIT = 3;
+
+/** Bit position for RETRO_MEMDESC_VIDEO_RAM flag */
+export const MEMDESC_VIDEO_RAM_BIT = 4;
+
+/** Bit position for alignment hints in memory descriptor flags */
+export const MEMDESC_ALIGN_BIT = 16;
+
+/** Bit position for minimum size hints in memory descriptor flags */
+export const MEMDESC_MINSIZE_BIT = 24;
+
+/** Alignment/size multiplier for 8-byte alignment */
+export const MEMDESC_SIZE_8 = 3;
+
+// =============================================================================
+// Struct Size Constants
+// =============================================================================
+
+/** Size of a uint32 in bytes */
+export const UINT32_SIZE = 4;
+
+/** Number of uint32 fields before aspect_ratio in retro_game_geometry struct */
+export const GEOMETRY_UINT_COUNT = 4;
+
+/** Struct padding for alignment in retro_controller_info (4 bytes) */
+export const STRUCT_PADDING_4 = 4;
+
+/** Maximum controller types to read per port (safety limit) */
+export const MAX_CONTROLLER_TYPES = 20;
+
+/** Decimal places for aspect ratio formatting */
+export const ASPECT_RATIO_DECIMALS = 3;