rgbx_v2.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
#define RGBX_V2_ABI_VERSION 2u
#define RGBX_V2_WIDTH 40u
#define RGBX_V2_HEIGHT 12u
#define RGBX_V2_PIXEL_COUNT (RGBX_V2_WIDTH * RGBX_V2_HEIGHT)
#define RGBX_V2_PIXELS_PER_SPAN 8u
#define RGBX_V2_MAX_PARAMS 16u
#define RGBX_V2_MAX_STRING_PARAMS 4u
#define RGBX_V2_STRING_PARAM_SIZE 32u
#define RGBX_V2_AUDIO_BAND_COUNT 4u
#define RGBX_V2_AUDIO_DISPLAY_BUCKET_COUNT 20u
#define RGBX_V2_IMU_AXIS_COUNT 3u
#define RGBX_V2_DIAGNOSTIC_COUNT 4u
#define RGBX_V2_MODULE_MAX_BYTES 2048u
 
/*
 * Admission profile.
 *
 * Every structural limit the host applies to a memoryless RGBX v2 module is
 * declared once, here. The firmware admission path static_asserts its own
 * constants against these macros, the SDK packager copies them verbatim into
 * sdk-manifest.json, and the SDK's post-link gate reads them back out of that
 * manifest, so the three cannot describe different profiles without a build
 * failure or a gate failure.
 */
 
#define RGBX_V2_MAX_FUNCTIONS 8u
#define RGBX_V2_MAX_GLOBALS 8u
#define RGBX_V2_MAX_LOCALS_PER_FUNCTION 32u
#define RGBX_V2_MIN_IMPORTS 2u
#define RGBX_V2_MAX_IMPORTS 5u
#define RGBX_V2_MAX_PARAM_CALLS_PER_TICK 16u
#define RGBX_V2_MAX_INPUT_CALLS_PER_TICK 64u
#define RGBX_V2_SPAN_CALLS_PER_TICK (RGBX_V2_PIXEL_COUNT / RGBX_V2_PIXELS_PER_SPAN)
 
/*
 * Section-id bitmasks: bit N is set when standard WebAssembly section id N
 * belongs to the set. Admitted ids are type(1), import(2), function(3),
 * global(6), export(7) and code(10); every other id, including custom(0),
 * table(4), memory(5), start(8), element(9) and data(11), is refused. The
 * required set is the same list without the optional global section.
 */
#define RGBX_V2_SECTION_ALLOWED_MASK 0x04ceu
#define RGBX_V2_SECTION_REQUIRED_MASK 0x048eu
 
#define RGBX_V2_CAPABILITY_BUTTONS (1u << 0)
#define RGBX_V2_CAPABILITY_IMU (1u << 1)
#define RGBX_V2_CAPABILITY_AUDIO (1u << 2)
#define RGBX_V2_CAPABILITY_ALL \
    (RGBX_V2_CAPABILITY_BUTTONS | RGBX_V2_CAPABILITY_IMU | RGBX_V2_CAPABILITY_AUDIO)
 
enum rgbx_v2_input_kind {
    RGBX_V2_INPUT_AUDIO_BAND_Q16 = 0,       
    RGBX_V2_INPUT_AUDIO_DISPLAY_Q16 = 1,    
    RGBX_V2_INPUT_AUDIO_BEAT_MASK = 2,      
    RGBX_V2_INPUT_BUTTONS_PRESSED = 3,      
    RGBX_V2_INPUT_ACCEL_MILLI = 4,          
    RGBX_V2_INPUT_GYRO_MILLI = 5,           
    RGBX_V2_INPUT_STRING_LENGTH = 6,        
    RGBX_V2_INPUT_STRING_BYTE_SUM = 7,      
};
 
#if defined(__cplusplus)
#define RGBX_V2_EXTERN_C extern "C"
#else
#define RGBX_V2_EXTERN_C extern
#endif
 
#if defined(__wasm__)
#define RGBX_V2_IMPORT(name) __attribute__((import_module("rgbx_v2"), import_name(name)))
#define RGBX_V2_EXPORT(name) __attribute__((export_name(name)))
#else
#define RGBX_V2_IMPORT(name)
#define RGBX_V2_EXPORT(name)
#endif
 
RGBX_V2_EXTERN_C uint32_t rgbx_v2_param_u32(uint32_t id) RGBX_V2_IMPORT("param_u32");
RGBX_V2_EXTERN_C uint32_t rgbx_v2_input_u32(uint32_t kind, uint32_t index)
    RGBX_V2_IMPORT("input_u32");
RGBX_V2_EXTERN_C void rgbx_v2_set_good_moment(uint32_t value)
    RGBX_V2_IMPORT("set_good_moment");
RGBX_V2_EXTERN_C void rgbx_v2_debug_u32(uint32_t tag, uint32_t value)
    RGBX_V2_IMPORT("debug_u32");
 
RGBX_V2_EXTERN_C void rgbx_v2_set_span8(uint32_t first_pixel, uint32_t color0, uint32_t color1,
                                        uint32_t color2, uint32_t color3, uint32_t color4,
                                        uint32_t color5, uint32_t color6, uint32_t color7)
    RGBX_V2_IMPORT("set_span8");
 
RGBX_V2_EXTERN_C void rgbx_v2_set_luma_span8(uint32_t first_pixel, uint32_t foreground,
                                             uint32_t background, uint32_t luma0, uint32_t luma1,
                                             uint32_t luma2, uint32_t luma3, uint32_t luma4,
                                             uint32_t luma5, uint32_t luma6, uint32_t luma7)
    RGBX_V2_IMPORT("set_luma_span8");
 
/* Every guest exports exactly these signatures:
 *
 *   RGBX_V2_EXPORT("rgbx_init") void rgbx_init(void);
 *   RGBX_V2_EXPORT("rgbx_tick") void rgbx_tick(uint32_t dt_ms);
 *
 * A complete frame is 60 ordered calls to exactly one span function at
 * first_pixel offsets 0, 8, ..., 472. A guest that imports
 * set_good_moment must call it exactly once per successfully committed frame.
 */
 
#undef RGBX_V2_EXTERN_C