teek-sdl2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3d084a6f681a0b04a3b68ad4bc0b905ff12a50e8cf08060982752601f1d33cad
+  data.tar.gz: 1ecc0e2befda331f9f427e9885d86f2a0261d609ca2cb6600c7a8f6ab3d92add
+SHA512:
+  metadata.gz: 7f847401b7b73c85de8d153ca1275d5756b6d5fa258b1dfd7f7a3d4ff451775fa2d47fc541e0234e405c1b01cf49ee49f7cfa7bb32c042b7a1934aad8fcab246
+  data.tar.gz: 819be6909a74692e4de3a6e0c00b79305c7f899ba7175e0fe01ae815b9c549dfe5360a827af04988317e3a77806e953021cffa452285f506664b3d298167dd1c

data/ext/teek_sdl2/extconf.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+
+def find_sdl2
+  # 1. Try SDL2_DIR env var first (explicit override)
+  if ENV['SDL2_DIR']
+    dir = ENV['SDL2_DIR']
+    $INCFLAGS << " -I#{dir}/include"
+    $LDFLAGS << " -L#{dir}/lib"
+    if have_header('SDL2/SDL.h') && have_library('SDL2')
+      return true
+    end
+    # Also try flat include layout (SDL.h directly in include/)
+    if have_header('SDL.h') && have_library('SDL2')
+      return true
+    end
+    abort "SDL2_DIR=#{dir} set but SDL2 not found there"
+  end
+
+  # 2. Try pkg-config
+  if pkg_config('sdl2')
+    return true
+  end
+
+  # 3. Try Homebrew paths (macOS)
+  homebrew_dirs = [
+    '/opt/homebrew/opt/sdl2',   # Apple Silicon
+    '/usr/local/opt/sdl2'       # Intel
+  ]
+
+  homebrew_dirs.each do |dir|
+    next unless File.directory?(dir)
+    inc = "#{dir}/include"
+    lib = "#{dir}/lib"
+
+    # Homebrew SDL2 puts headers in include/SDL2/
+    if File.exist?("#{inc}/SDL2/SDL.h")
+      $INCFLAGS << " -I#{inc}"
+      $LDFLAGS << " -L#{lib}"
+      if have_header('SDL2/SDL.h') && have_library('SDL2')
+        return true
+      end
+    end
+  end
+
+  # 4. Try standard system paths
+  system_dirs = ['/usr/local', '/usr']
+  system_dirs.each do |dir|
+    inc = "#{dir}/include"
+    lib = "#{dir}/lib"
+    if File.exist?("#{inc}/SDL2/SDL.h")
+      $INCFLAGS << " -I#{inc}"
+      $LDFLAGS << " -L#{lib}"
+      if have_header('SDL2/SDL.h') && have_library('SDL2')
+        return true
+      end
+    end
+  end
+
+  # 5. MSYS2/MinGW (Windows)
+  if RbConfig::CONFIG['host_os'] =~ /mingw|mswin/
+    # MSYS2 installs to the mingw prefix
+    mingw_prefix = RbConfig::CONFIG['prefix']  # e.g. C:/msys64/mingw64
+    inc = "#{mingw_prefix}/include"
+    lib = "#{mingw_prefix}/lib"
+    if File.exist?("#{inc}/SDL2/SDL.h")
+      $INCFLAGS << " -I#{inc}"
+      $LDFLAGS << " -L#{lib}"
+      # MinGW uses -lSDL2 (same name)
+      if have_header('SDL2/SDL.h') && have_library('SDL2')
+        return true
+      end
+    end
+  end
+
+  false
+end
+
+unless find_sdl2
+  abort <<~MSG
+    SDL2 not found. Install it:
+      macOS:   brew install sdl2
+      Debian:  sudo apt-get install libsdl2-dev
+      Windows: pacman -S mingw-w64-x86_64-SDL2  (MSYS2)
+    Or set SDL2_DIR=/path/to/sdl2
+  MSG
+end
+
+# SDL2_ttf for text rendering
+unless pkg_config('SDL2_ttf') || have_library('SDL2_ttf', 'TTF_Init', 'SDL2/SDL_ttf.h')
+  abort <<~MSG
+    SDL2_ttf not found. Install it:
+      macOS:   brew install sdl2_ttf
+      Debian:  sudo apt-get install libsdl2-ttf-dev
+      Windows: pacman -S mingw-w64-x86_64-SDL2_ttf  (MSYS2)
+  MSG
+end
+
+# SDL2_image for loading PNG, JPG, WebP, etc.
+unless pkg_config('SDL2_image') || have_library('SDL2_image', 'IMG_Init', 'SDL2/SDL_image.h')
+  abort <<~MSG
+    SDL2_image not found. Install it:
+      macOS:   brew install sdl2_image
+      Debian:  sudo apt-get install libsdl2-image-dev
+      Windows: pacman -S mingw-w64-x86_64-SDL2_image  (MSYS2)
+  MSG
+end
+
+$srcs = ['teek_sdl2.c', 'sdl2surface.c', 'sdl2bridge.c', 'sdl2text.c', 'sdl2pixels.c', 'sdl2image.c']
+
+create_makefile('teek_sdl2')

data/ext/teek_sdl2/sdl2bridge.c

@@ -0,0 +1,142 @@
+#include "teek_sdl2.h"
+
+/* ---------------------------------------------------------
+ * Layer 2: Tk bridge
+ *
+ * Embeds an SDL2 window into a Tk frame using
+ * SDL_CreateWindowFrom(). This is the only file that knows
+ * about Tk's winfo id. It produces a Layer 1 Renderer.
+ * --------------------------------------------------------- */
+
+/*
+ * Teek::SDL2.create_renderer_from_handle(native_handle) -> Renderer
+ *
+ * Creates an SDL2 window embedded in the native window identified by
+ * native_handle (from Tk's 'winfo id'), then creates a GPU-accelerated
+ * renderer on it.
+ *
+ * The Ruby Viewport class is responsible for getting the handle and
+ * calling this. This C function just does the SDL2 work.
+ */
+static VALUE
+bridge_create_renderer_from_handle(VALUE self, VALUE handle_val)
+{
+    ensure_sdl2_init();
+
+    /*
+     * Handle comes from Teek::Interp#native_window_handle as an Integer:
+     *   macOS: NSWindow* pointer
+     *   X11:   X Window ID
+     *   Win:   HWND
+     */
+    void *native_handle = (void *)(uintptr_t)NUM2ULL(handle_val);
+
+    if (!native_handle) {
+        rb_raise(rb_eArgError, "invalid native handle (NULL)");
+    }
+
+    SDL_Window *window = SDL_CreateWindowFrom(native_handle);
+    if (!window) {
+        rb_raise(rb_eRuntimeError, "SDL_CreateWindowFrom failed: %s", SDL_GetError());
+    }
+
+    SDL_Renderer *sdl_ren = SDL_CreateRenderer(window, -1,
+        SDL_RENDERER_ACCELERATED | SDL_RENDERER_PRESENTVSYNC);
+    if (!sdl_ren) {
+        /* Fall back to software if GPU not available */
+        sdl_ren = SDL_CreateRenderer(window, -1, SDL_RENDERER_SOFTWARE);
+    }
+    if (!sdl_ren) {
+        SDL_DestroyWindow(window);
+        rb_raise(rb_eRuntimeError, "SDL_CreateRenderer failed: %s", SDL_GetError());
+    }
+
+    /* Wrap in a Renderer object (Layer 1) */
+    VALUE klass = rb_const_get(mTeekSDL2, rb_intern("Renderer"));
+    VALUE obj = rb_obj_alloc(klass);
+
+    struct sdl2_renderer *r;
+    TypedData_Get_Struct(obj, struct sdl2_renderer, &renderer_type, r);
+    r->window = window;
+    r->renderer = sdl_ren;
+    r->owned_window = 0; /* Tk owns the parent window */
+    r->destroyed = 0;
+
+    return obj;
+}
+
+/*
+ * C-level poll function — called directly from teek's event source
+ * check proc via function pointer. No Ruby overhead.
+ *
+ * Signature: void (*)(void *client_data)
+ */
+static void
+sdl2_event_check(void *client_data)
+{
+    (void)client_data;
+
+    /*
+     * Intentionally a no-op for now. SDL_PollEvent() on macOS pumps
+     * the Cocoa run loop, which steals events from Tk and can freeze
+     * other windows (e.g. the debug inspector).
+     *
+     * When we need SDL events (mouse/kb in the viewport), this will
+     * be wired up carefully to avoid Cocoa event conflicts.
+     */
+}
+
+/*
+ * Teek::SDL2.poll_events -> Integer
+ *
+ * Manual pump for use outside the event source (e.g. testing).
+ */
+static VALUE
+bridge_poll_events(VALUE self)
+{
+    SDL_Event event;
+    int count = 0;
+
+    while (SDL_PollEvent(&event)) {
+        count++;
+    }
+    return INT2NUM(count);
+}
+
+/*
+ * Teek::SDL2._event_check_fn_ptr -> Integer
+ *
+ * Returns the address of the C-level SDL2 event check function.
+ * Passed to Teek._register_event_source for hot-path polling.
+ */
+static VALUE
+bridge_event_check_fn_ptr(VALUE self)
+{
+    return ULL2NUM((uintptr_t)sdl2_event_check);
+}
+
+/*
+ * Teek::SDL2.sdl_quit
+ *
+ * Shuts down SDL2 subsystems. Called at process exit.
+ */
+static VALUE
+bridge_sdl_quit(VALUE self)
+{
+    SDL_Quit();
+    return Qnil;
+}
+
+/* ---------------------------------------------------------
+ * Init
+ * --------------------------------------------------------- */
+
+void
+Init_sdl2bridge(VALUE mTeekSDL2)
+{
+    rb_define_module_function(mTeekSDL2, "create_renderer_from_handle",
+                             bridge_create_renderer_from_handle, 1);
+    rb_define_module_function(mTeekSDL2, "poll_events", bridge_poll_events, 0);
+    rb_define_module_function(mTeekSDL2, "_event_check_fn_ptr", bridge_event_check_fn_ptr, 0);
+    rb_define_module_function(mTeekSDL2, "sdl_quit", bridge_sdl_quit, 0);
+}

data/ext/teek_sdl2/sdl2image.c

@@ -0,0 +1,83 @@
+#include "teek_sdl2.h"
+#include <SDL2/SDL_image.h>
+
+/* ---------------------------------------------------------
+ * SDL2_image wrapper
+ *
+ * Loads image files (PNG, JPG, WebP, BMP, etc.) directly
+ * into SDL2 textures via IMG_LoadTexture.
+ * --------------------------------------------------------- */
+
+static int img_initialized = 0;
+
+static void
+ensure_img_init(void)
+{
+    if (img_initialized) return;
+
+    int flags = IMG_INIT_PNG | IMG_INIT_JPG;
+    int initted = IMG_Init(flags);
+
+    /* Not fatal if a specific codec is missing — IMG_LoadTexture
+     * will fail at load time with a clear error message. We just
+     * want to preload the common ones. */
+    (void)initted;
+    img_initialized = 1;
+}
+
+/*
+ * Teek::SDL2::Renderer#load_image(path) -> Texture
+ *
+ * Load an image file into a GPU texture. Supports PNG, JPG, BMP,
+ * GIF, WebP, TGA, and other formats via SDL2_image.
+ *
+ * The returned texture has alpha blending enabled and its width/height
+ * set from the image dimensions.
+ */
+static VALUE
+renderer_load_image(VALUE self, VALUE path)
+{
+    struct sdl2_renderer *ren = get_renderer(self);
+
+    ensure_sdl2_init();
+    ensure_img_init();
+
+    StringValue(path);
+    const char *cpath = StringValueCStr(path);
+
+    SDL_Texture *texture = IMG_LoadTexture(ren->renderer, cpath);
+    if (!texture) {
+        rb_raise(rb_eRuntimeError, "IMG_LoadTexture failed: %s", IMG_GetError());
+    }
+
+    /* Query dimensions */
+    int w, h;
+    SDL_QueryTexture(texture, NULL, NULL, &w, &h);
+
+    /* Enable alpha blending (common for PNGs with transparency) */
+    SDL_SetTextureBlendMode(texture, SDL_BLENDMODE_BLEND);
+
+    /* Wrap as a Texture object */
+    VALUE klass = rb_const_get(mTeekSDL2, rb_intern("Texture"));
+    VALUE obj = rb_obj_alloc(klass);
+
+    struct sdl2_texture *t;
+    TypedData_Get_Struct(obj, struct sdl2_texture, &texture_type, t);
+    t->texture = texture;
+    t->w = w;
+    t->h = h;
+    t->renderer_obj = self;
+
+    return obj;
+}
+
+/* ---------------------------------------------------------
+ * Init
+ * --------------------------------------------------------- */
+
+void
+Init_sdl2image(VALUE mTeekSDL2)
+{
+    VALUE cRenderer = rb_const_get(mTeekSDL2, rb_intern("Renderer"));
+    rb_define_method(cRenderer, "load_image", renderer_load_image, 1);
+}

data/ext/teek_sdl2/sdl2pixels.c

@@ -0,0 +1,166 @@
+#include "teek_sdl2.h"
+
+/* ---------------------------------------------------------
+ * Pixel format conversion helpers
+ *
+ * Fast C-level conversion from various pixel formats to
+ * ARGB8888 (our native SDL2 texture format). Designed for
+ * emulators and games that output pixels in different formats.
+ * --------------------------------------------------------- */
+
+/*
+ * Teek::SDL2::Pixels.pack_uint32(array, width, height) -> String
+ *
+ * Packs an Array of uint32 integers into an ARGB8888 byte string
+ * suitable for Texture#update. Each integer is treated as a
+ * native-endian 32-bit pixel value.
+ *
+ * This is the fast path for optcarrot and similar emulators that
+ * output pre-palette-mapped uint32 pixel arrays.
+ */
+static VALUE
+pixels_pack_uint32(VALUE self, VALUE ary, VALUE vw, VALUE vh)
+{
+    int w = NUM2INT(vw);
+    int h = NUM2INT(vh);
+    long expected = (long)w * h;
+    long len;
+    VALUE result;
+    uint32_t *dst;
+    long i;
+
+    Check_Type(ary, T_ARRAY);
+    len = RARRAY_LEN(ary);
+
+    if (len < expected) {
+        rb_raise(rb_eArgError,
+                 "array too short: need %ld pixels, got %ld", expected, len);
+    }
+
+    result = rb_str_new(NULL, expected * 4);
+    dst = (uint32_t *)RSTRING_PTR(result);
+
+    for (i = 0; i < expected; i++) {
+        dst[i] = (uint32_t)NUM2UINT(rb_ary_entry(ary, i));
+    }
+
+    return result;
+}
+
+/*
+ * Teek::SDL2::Pixels.convert(source, width, height, from_format) -> String
+ *
+ * Converts a pixel byte string from one format to ARGB8888.
+ *
+ * Supported from_format values:
+ *   :argb8888 - passthrough (no conversion)
+ *   :rgba8888 - RGBA -> ARGB byte shuffle
+ *   :bgra8888 - BGRA -> ARGB byte shuffle
+ *   :abgr8888 - ABGR -> ARGB byte shuffle
+ *   :rgb888   - 3-byte RGB -> 4-byte ARGB (adds 0xFF alpha)
+ */
+static VALUE
+pixels_convert(VALUE self, VALUE source, VALUE vw, VALUE vh, VALUE format)
+{
+    int w = NUM2INT(vw);
+    int h = NUM2INT(vh);
+    long npixels = (long)w * h;
+    const uint8_t *src;
+    uint8_t *dst;
+    VALUE result;
+    ID fmt;
+    long i;
+
+    Check_Type(source, T_STRING);
+    fmt = SYM2ID(format);
+    src = (const uint8_t *)RSTRING_PTR(source);
+
+    /* :argb8888 — passthrough */
+    if (fmt == rb_intern("argb8888")) {
+        if (RSTRING_LEN(source) < npixels * 4) {
+            rb_raise(rb_eArgError, "source too short for %ldx%d ARGB8888", (long)w, h);
+        }
+        return rb_str_dup(source);
+    }
+
+    /* :rgba8888 — RGBA -> ARGB */
+    if (fmt == rb_intern("rgba8888")) {
+        if (RSTRING_LEN(source) < npixels * 4) {
+            rb_raise(rb_eArgError, "source too short for %ldx%d RGBA8888", (long)w, h);
+        }
+        result = rb_str_new(NULL, npixels * 4);
+        dst = (uint8_t *)RSTRING_PTR(result);
+        for (i = 0; i < npixels; i++) {
+            long off = i * 4;
+            dst[off + 0] = src[off + 3]; /* A */
+            dst[off + 1] = src[off + 0]; /* R */
+            dst[off + 2] = src[off + 1]; /* G */
+            dst[off + 3] = src[off + 2]; /* B */
+        }
+        return result;
+    }
+
+    /* :bgra8888 — BGRA -> ARGB */
+    if (fmt == rb_intern("bgra8888")) {
+        if (RSTRING_LEN(source) < npixels * 4) {
+            rb_raise(rb_eArgError, "source too short for %ldx%d BGRA8888", (long)w, h);
+        }
+        result = rb_str_new(NULL, npixels * 4);
+        dst = (uint8_t *)RSTRING_PTR(result);
+        for (i = 0; i < npixels; i++) {
+            long off = i * 4;
+            dst[off + 0] = src[off + 3]; /* A */
+            dst[off + 1] = src[off + 2]; /* R */
+            dst[off + 2] = src[off + 1]; /* G */
+            dst[off + 3] = src[off + 0]; /* B */
+        }
+        return result;
+    }
+
+    /* :abgr8888 — ABGR -> ARGB */
+    if (fmt == rb_intern("abgr8888")) {
+        if (RSTRING_LEN(source) < npixels * 4) {
+            rb_raise(rb_eArgError, "source too short for %ldx%d ABGR8888", (long)w, h);
+        }
+        result = rb_str_new(NULL, npixels * 4);
+        dst = (uint8_t *)RSTRING_PTR(result);
+        for (i = 0; i < npixels; i++) {
+            long off = i * 4;
+            dst[off + 0] = src[off + 0]; /* A */
+            dst[off + 1] = src[off + 3]; /* R */
+            dst[off + 2] = src[off + 2]; /* G */
+            dst[off + 3] = src[off + 1]; /* B */
+        }
+        return result;
+    }
+
+    /* :rgb888 — 3-byte RGB -> 4-byte ARGB */
+    if (fmt == rb_intern("rgb888")) {
+        if (RSTRING_LEN(source) < npixels * 3) {
+            rb_raise(rb_eArgError, "source too short for %ldx%d RGB888", (long)w, h);
+        }
+        result = rb_str_new(NULL, npixels * 4);
+        dst = (uint8_t *)RSTRING_PTR(result);
+        for (i = 0; i < npixels; i++) {
+            long src_off = i * 3;
+            long dst_off = i * 4;
+            dst[dst_off + 0] = 0xFF;           /* A */
+            dst[dst_off + 1] = src[src_off + 0]; /* R */
+            dst[dst_off + 2] = src[src_off + 1]; /* G */
+            dst[dst_off + 3] = src[src_off + 2]; /* B */
+        }
+        return result;
+    }
+
+    rb_raise(rb_eArgError, "unknown pixel format: %"PRIsVALUE, format);
+    return Qnil; /* unreachable */
+}
+
+void
+Init_sdl2pixels(VALUE mTeekSDL2)
+{
+    VALUE cPixels = rb_define_module_under(mTeekSDL2, "Pixels");
+
+    rb_define_module_function(cPixels, "pack_uint32", pixels_pack_uint32, 3);
+    rb_define_module_function(cPixels, "convert", pixels_convert, 4);
+}