lukas/Nova64
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

scaffolding for framebuffer functions

Browse Source
This commit is contained in:
Lukas Höppner
2026-08-12 22:44:54 +02:00
parent 84ba0a609a
commit 7c87a38a6a
9 changed files with 384 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files
core/include/nova64_core.h
+4 -77
View File
@@ -1,6 +1,8 @@
#ifndef NOVA64_CORE_H
#define NOVA64_CORE_H
#include "nova64_io_interface.h"
#include "nova64_ppu_interface.h"
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
@@ -21,82 +23,6 @@
#endif
#endif
/* ========================================================================== */
/* I/O Callback Typedefs */
/* ========================================================================== */
/**
* @brief Callback to flush a frame buffer to the display.
* @param buffer Pointer to raw pixel data (e.g., RGB565 / RGBA8888).
* @param width Frame width in pixels.
* @param height Frame height in pixels.
*/
typedef void (*nova64_display_flush_cb_t)(const uint16_t *buffer,
uint16_t width, uint16_t height);
/**
* @brief Callback to output audio samples.
* @param samples Pointer to PCM audio sample buffer.
* @param count Number of samples in the buffer.
*/
typedef void (*nova64_audio_output_cb_t)(const int16_t *samples,
uint32_t count);
/**
* @brief Callback to read data from the SD card.
* @param slot_idx Zero-based cartridge slot index.
* @param file_path Null-terminated path to the file to read.
* @param destination_buffer Pointer to memory where file data should be copied.
* @param destination_length Maximum number of bytes available in the
* destination buffer.
* @return Number of bytes read on success, negative value on read error.
*/
typedef int32_t (*nova64_sd_read_file_cb_t)(uint32_t slot_idx,
const char *file_path,
uint8_t *destination_buffer,
uint32_t destination_length);
/**
* @brief Callback to retrieve the size of a file on the SD card.
* @param slot_idx Zero-based cartridge slot index.
* @param file_path Null-terminated path to the file.
* @return File size in bytes on success, negative value on error.
*/
typedef int32_t (*nova64_sd_get_file_size_cb_t)(uint32_t slot_idx,
const char *file_path);
/**
* @brief Callback triggered when a cartridge state change occurs (e.g.
* inserted/removed).
* @param slot_idx Zero-based cartridge slot index.
* @param is_inserted True if a cartridge is detected, false if ejected.
*/
typedef void (*nova64_cartridge_status_cb_t)(uint32_t slot_idx,
bool is_inserted);
/**
* @brief Callback for core log output.
* @param message Null-terminated UTF-8 log string.
*/
typedef void (*nova64_log_cb_t)(const char *message);
/* ========================================================================== */
/* I/O Interface Configuration Struct */
/* ========================================================================== */
/**
* @brief Struct containing all I/O hardware abstraction callbacks.
* Pass NULL for any unneeded callback.
*/
typedef struct {
nova64_display_flush_cb_t display_flush;
nova64_audio_output_cb_t audio_output;
nova64_sd_read_file_cb_t sd_read_file;
nova64_sd_get_file_size_cb_t sd_get_file_size;
nova64_cartridge_status_cb_t cartridge_status;
nova64_log_cb_t log_message;
} nova64_io_interface_t;
/* ========================================================================== */
/* Engine Core API */
/* ========================================================================== */
@@ -109,7 +35,8 @@ typedef struct {
* @return True if initialized successfully, false if already initialized or
* invalid.
*/
NOVA64_API bool nova64_init(const nova64_io_interface_t *io_interface);
NOVA64_API bool nova64_init(const nova64_io_interface_t *io_interface,
const nova64_ppu_interface_t *ppu_interface);
/**
* @brief Starts the main engine runtime and launches the FreeRTOS scheduler.
core/include/nova64_framebuffer.h
+1 -2
View File
@@ -2,6 +2,7 @@
#define NOVA64_FRAMEBUFFER_H
#include "nova64_core.h"
#include "nova64_ppu_interface.h"
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
@@ -11,8 +12,6 @@
#define NOVA64_DISPLAY_HEIGHT 800
#define NOVA64_DISPLAY_PIXELS (NOVA64_DISPLAY_WIDTH * NOVA64_DISPLAY_HEIGHT)
// Pixel format: RGB565 (uint16_t)
typedef uint16_t pixel_t;
// Framebuffer size in bytes (768,000 bytes)
#define NOVA64_FRAMEBUFFER_SIZE_BYTES (NOVA64_DISPLAY_PIXELS * sizeof(pixel_t))
core/include/nova64_internal.h
+1
View File
@@ -6,6 +6,7 @@
void nova64_log(const char *format, ...);
const nova64_io_interface_t *nova64_get_io_interface(void);
const nova64_ppu_interface_t *nova64_get_ppu_interface(void);
void nova64_log_scheduler_state(void);
core/include/nova64_io_interface.h
+73
View File
@@ -0,0 +1,73 @@
#ifndef NOVA64_IO_INTERFACE_H
#define NOVA64_IO_INTERFACE_H
#include <stdbool.h>
#include <stdint.h>
/* ========================================================================== */
/* I/O Callback Typedefs */
/* ========================================================================== */
/**
* @brief Callback to output audio samples.
* @param samples Pointer to PCM audio sample buffer.
* @param count Number of samples in the buffer.
*/
typedef void (*nova64_audio_output_cb_t)(const int16_t *samples,
uint32_t count);
/**
* @brief Callback to read data from the SD card.
* @param slot_idx Zero-based cartridge slot index.
* @param file_path Null-terminated path to the file to read.
* @param destination_buffer Pointer to memory where file data should be copied.
* @param destination_length Maximum number of bytes available in the
* destination buffer.
* @return Number of bytes read on success, negative value on read error.
*/
typedef int32_t (*nova64_sd_read_file_cb_t)(uint32_t slot_idx,
const char *file_path,
uint8_t *destination_buffer,
uint32_t destination_length);
/**
* @brief Callback to retrieve the size of a file on the SD card.
* @param slot_idx Zero-based cartridge slot index.
* @param file_path Null-terminated path to the file.
* @return File size in bytes on success, negative value on error.
*/
typedef int32_t (*nova64_sd_get_file_size_cb_t)(uint32_t slot_idx,
const char *file_path);
/**
* @brief Callback triggered when a cartridge state change occurs (e.g.
* inserted/removed).
* @param slot_idx Zero-based cartridge slot index.
* @param is_inserted True if a cartridge is detected, false if ejected.
*/
typedef void (*nova64_cartridge_status_cb_t)(uint32_t slot_idx,
bool is_inserted);
/**
* @brief Callback for core log output.
* @param message Null-terminated UTF-8 log string.
*/
typedef void (*nova64_log_cb_t)(const char *message);
/* ========================================================================== */
/* I/O Interface Configuration Struct */
/* ========================================================================== */
/**
* @brief Struct containing all I/O hardware abstraction callbacks.
* Pass NULL for any unneeded callback.
*/
typedef struct {
nova64_audio_output_cb_t audio_output;
nova64_sd_read_file_cb_t sd_read_file;
nova64_sd_get_file_size_cb_t sd_get_file_size;
nova64_cartridge_status_cb_t cartridge_status;
nova64_log_cb_t log_message;
} nova64_io_interface_t;
#endif // NOVA64_IO_INTERFACE_H
core/include/nova64_ppu_interface.h
+172
View File
@@ -0,0 +1,172 @@
#ifndef NOVA64_PPU_INTERFACE_H
#define NOVA64_PPU_INTERFACE_H
#include <stdbool.h>
#include <stdint.h>
// Pixel format: RGB565 (uint16_t)
typedef uint16_t pixel_t;
/* ========================================================================== */
/* PPU Callback Typedefs */
/* ========================================================================== */
/**
* @brief Transformation flags for hardware-accelerated sprite operations.
*/
typedef enum {
NOVA64_TRANSFORM_NONE = 0,
NOVA64_TRANSFORM_FLIP_H = 1 << 0,
NOVA64_TRANSFORM_FLIP_V = 1 << 1,
NOVA64_TRANSFORM_ROT_90 = 1 << 2,
NOVA64_TRANSFORM_ROT_180 = 1 << 3,
NOVA64_TRANSFORM_ROT_270 = 1 << 4
} nova64_transform_t;
/**
* @brief Callback to perform a solid color rectangle fill (e.g. clear/rects).
* @param dst Pointer to destination buffer memory.
* @param dst_stride Row stride (pitch) of destination buffer in pixels.
* @param x Top-left X position in destination buffer.
* @param y Top-left Y position in destination buffer.
* @param w Width of rectangle to fill.
* @param h Height of rectangle to fill.
* @param color 16-bit RGB565 pixel color value.
*/
typedef void (*nova64_ppu_fill_rect_cb_t)(pixel_t *dst, uint32_t dst_stride,
int32_t x, int32_t y, int32_t w,
int32_t h, pixel_t color);
/**
* @brief Callback for hardware-accelerated block image transfer (opaque Blit).
* @param src Pointer to source surface buffer.
* @param src_stride Row stride (pitch) of source surface in pixels.
* @param dst Pointer to destination buffer memory.
* @param dst_stride Row stride (pitch) of destination buffer in pixels.
* @param src_x X coordinate on source surface.
* @param src_y Y coordinate on source surface.
* @param dst_x X coordinate on destination buffer.
* @param dst_y Y coordinate on destination buffer.
* @param w Width of block to transfer.
* @param h Height of block to transfer.
*/
typedef void (*nova64_ppu_blit_cb_t)(const pixel_t *src, uint32_t src_stride,
pixel_t *dst, uint32_t dst_stride,
int32_t src_x, int32_t src_y,
int32_t dst_x, int32_t dst_y, int32_t w,
int32_t h);
/**
* @brief Callback for transparent sprite blitting using color keying.
* @param src Pointer to source surface buffer.
* @param src_stride Row stride of source surface in pixels.
* @param dst Pointer to destination buffer memory.
* @param dst_stride Row stride of destination buffer in pixels.
* @param src_x X coordinate on source surface.
* @param src_y Y coordinate on source surface.
* @param dst_x X coordinate on destination buffer.
* @param dst_y Y coordinate on destination buffer.
* @param w Width of block to transfer.
* @param h Height of block to transfer.
* @param key_color 16-bit color treated as fully transparent.
*/
typedef void (*nova64_ppu_blit_colorkey_cb_t)(
const pixel_t *src, uint32_t src_stride, pixel_t *dst, uint32_t dst_stride,
int32_t src_x, int32_t src_y, int32_t dst_x, int32_t dst_y, int32_t w,
int32_t h, pixel_t key_color);
/**
* @brief Callback for alpha-blended surface composition.
* @param src Pointer to source surface buffer.
* @param src_stride Row stride of source surface in pixels.
* @param dst Pointer to destination buffer memory.
* @param dst_stride Row stride of destination buffer in pixels.
* @param src_x X coordinate on source surface.
* @param src_y Y coordinate on source surface.
* @param dst_x X coordinate on destination buffer.
* @param dst_y Y coordinate on destination buffer.
* @param w Width of block to transfer.
* @param h Height of block to transfer.
* @param global_alpha Global opacity multiplier (0 = transparent, 255 =
* opaque).
*/
typedef void (*nova64_ppu_blend_cb_t)(const pixel_t *src, uint32_t src_stride,
pixel_t *dst, uint32_t dst_stride,
int32_t src_x, int32_t src_y,
int32_t dst_x, int32_t dst_y, int32_t w,
int32_t h, uint8_t global_alpha);
/**
* @brief Callback for transformed image transfer (rotation & flipping).
* @param src Pointer to source surface buffer.
* @param src_stride Row stride of source surface in pixels.
* @param dst Pointer to destination buffer memory.
* @param dst_stride Row stride of destination buffer in pixels.
* @param src_x X coordinate on source surface.
* @param src_y Y coordinate on source surface.
* @param dst_x X coordinate on destination buffer.
* @param dst_y Y coordinate on destination buffer.
* @param w Width of block to transfer.
* @param h Height of block to transfer.
* @param transform Rotation/Flip flags to apply during transfer.
*/
typedef void (*nova64_ppu_blit_transform_cb_t)(
const pixel_t *src, uint32_t src_stride, pixel_t *dst, uint32_t dst_stride,
int32_t src_x, int32_t src_y, int32_t dst_x, int32_t dst_y, int32_t w,
int32_t h, nova64_transform_t transform);
/**
* @brief Callback for hardware-accelerated image scaling/resizing.
* @param src Pointer to source surface buffer.
* @param src_stride Row stride of source surface in pixels.
* @param src_w Width of source rectangle.
* @param src_h Height of source rectangle.
* @param dst Pointer to destination buffer memory.
* @param dst_stride Row stride of destination buffer in pixels.
* @param dst_x Target X coordinate on destination buffer.
* @param dst_y Target Y coordinate on destination buffer.
* @param dst_w Target scaled width on destination buffer.
* @param dst_h Target scaled height on destination buffer.
*/
typedef void (*nova64_ppu_blit_scale_cb_t)(const pixel_t *src,
uint32_t src_stride, int32_t src_w,
int32_t src_h, pixel_t *dst,
uint32_t dst_stride, int32_t dst_x,
int32_t dst_y, int32_t dst_w,
int32_t dst_h);
/**
* @brief Callback to block CPU execution until all PPU/DMA2D hardware
* operations finish.
*/
typedef void (*nova64_ppu_wait_idle_cb_t)(void);
/**
* @brief Callback to check if the PPU/DMA2D engine is currently processing a
* job.
* @return True if hardware is busy, false if idle.
*/
typedef bool (*nova64_ppu_is_busy_cb_t)(void);
/* ========================================================================== */
/* PPU Interface Configuration Struct */
/* ========================================================================== */
/**
* @brief Struct containing all PPU hardware abstraction callbacks.
* Pass NULL for any unsupported or unneeded hardware acceleration
* feature.
*/
typedef struct {
nova64_ppu_fill_rect_cb_t fill_rect;
nova64_ppu_blit_cb_t blit;
nova64_ppu_blit_colorkey_cb_t blit_colorkey;
nova64_ppu_blend_cb_t blend;
nova64_ppu_blit_transform_cb_t blit_transform;
nova64_ppu_blit_scale_cb_t blit_scale;
nova64_ppu_wait_idle_cb_t wait_idle;
nova64_ppu_is_busy_cb_t is_busy;
} nova64_ppu_interface_t;
#endif // NOVA64_PPU_INTERFACE_H