Merge pull request #202 from laamaa/feature/message_console

Feature/message console

Author: laamaa

README.md

@@ -156,6 +156,7 @@ Additional controls:
 * Esc = toggle keyjazz on/off
 * r / select+start+opt+edit = reset display (if glitches appear on the screen, use this)
 * F12 = toggle audio routing on / off
+* ` (grave) = toggle in-app log overlay
 
 ### Keyjazz
 
@@ -210,6 +211,14 @@ m8c --config alternate_config.ini
 This looks for a config file with the given name in the same directory as the default config. If you specify a config
 file that does not exist, a new default config file with the specified name will be created, which you can then edit.
 
+### Log overlay
+
+An in-app log overlay is available for platforms where reading console output is inconvenient.
+
+- Default toggle key: \` (grave). You can change it in `config.ini` under `[keyboard]` using `key_toggle_log=<SDL_SCANCODE>`.
+- The overlay shows recent `SDL_Log*` messages.
+- Long lines are wrapped to fit; the view tails the most recent output.
+
 Enjoy making some nice music!
 
 -----------

src/config.c

@@ -33,8 +33,8 @@ config_params_s config_initialize(char *filename) {
   c.idle_ms = 10;        // default to high performance
   c.wait_for_device = 1; // default to exit if device disconnected
   c.wait_packets = 256;  // amount of empty command queue reads before assuming device disconnected
-  c.audio_enabled = 0;        // route M8 audio to default output
-  c.audio_buffer_size = 0; // requested audio buffer size in samples: 0 = let SDL decide
+  c.audio_enabled = 0;   // route M8 audio to default output
+  c.audio_buffer_size = 0;    // requested audio buffer size in samples: 0 = let SDL decide
   c.audio_device_name = NULL; // Use this device, leave NULL to use the default output device
 
   c.key_up = SDL_SCANCODE_UP;
@@ -56,6 +56,7 @@ config_params_s config_initialize(char *filename) {
   c.key_jazz_inc_velocity = SDL_SCANCODE_KP_MINUS;
   c.key_jazz_dec_velocity = SDL_SCANCODE_KP_PLUS;
   c.key_toggle_audio = SDL_SCANCODE_F12;
+  c.key_toggle_log = SDL_SCANCODE_GRAVE; // default to ` key
 
   c.gamepad_up = SDL_GAMEPAD_BUTTON_DPAD_UP;
   c.gamepad_left = SDL_GAMEPAD_BUTTON_DPAD_LEFT;
@@ -90,8 +91,8 @@ void write_config(const config_params_s *conf) {
 
   SDL_Log("Writing config file to %s", config_path);
 
-  #define INI_LINE_COUNT 50
-  #define INI_LINE_LENGTH 50
+#define INI_LINE_COUNT 51
+#define INI_LINE_LENGTH 50
 
   // Entries for the config file
   char ini_values[INI_LINE_COUNT][INI_LINE_LENGTH];
@@ -108,11 +109,13 @@ void write_config(const config_params_s *conf) {
   snprintf(ini_values[initPointer++], INI_LINE_LENGTH, "[audio]\n");
   snprintf(ini_values[initPointer++], INI_LINE_LENGTH, "audio_enabled=%s\n",
            conf->audio_enabled ? "true" : "false");
-  snprintf(ini_values[initPointer++], INI_LINE_LENGTH, "audio_buffer_size=%d\n", conf->audio_buffer_size);
+  snprintf(ini_values[initPointer++], INI_LINE_LENGTH, "audio_buffer_size=%d\n",
+           conf->audio_buffer_size);
   snprintf(ini_values[initPointer++], INI_LINE_LENGTH, "audio_device_name=%s\n",
            conf->audio_device_name ? conf->audio_device_name : "Default");
   snprintf(ini_values[initPointer++], INI_LINE_LENGTH, "[keyboard]\n");
-  snprintf(ini_values[initPointer++], INI_LINE_LENGTH, ";Ref: https://wiki.libsdl.org/SDL2/SDL_Scancode\n");
+  snprintf(ini_values[initPointer++], INI_LINE_LENGTH,
+           ";Ref: https://wiki.libsdl.org/SDL2/SDL_Scancode\n");
   snprintf(ini_values[initPointer++], INI_LINE_LENGTH, "key_up=%d\n", conf->key_up);
   snprintf(ini_values[initPointer++], INI_LINE_LENGTH, "key_left=%d\n", conf->key_left);
   snprintf(ini_values[initPointer++], INI_LINE_LENGTH, "key_down=%d\n", conf->key_down);
@@ -135,7 +138,9 @@ void write_config(const config_params_s *conf) {
            conf->key_jazz_inc_velocity);
   snprintf(ini_values[initPointer++], INI_LINE_LENGTH, "key_jazz_dec_velocity=%d\n",
            conf->key_jazz_dec_velocity);
-  snprintf(ini_values[initPointer++], INI_LINE_LENGTH, "key_toggle_audio=%d\n", conf->key_toggle_audio);
+  snprintf(ini_values[initPointer++], INI_LINE_LENGTH, "key_toggle_audio=%d\n",
+           conf->key_toggle_audio);
+  snprintf(ini_values[initPointer++], INI_LINE_LENGTH, "key_toggle_log=%d\n", conf->key_toggle_log);
   snprintf(ini_values[initPointer++], INI_LINE_LENGTH, "[gamepad]\n");
   snprintf(ini_values[initPointer++], INI_LINE_LENGTH, "gamepad_up=%d\n", conf->gamepad_up);
   snprintf(ini_values[initPointer++], INI_LINE_LENGTH, "gamepad_left=%d\n", conf->gamepad_left);
@@ -285,6 +290,7 @@ void read_key_config(const ini_t *ini, config_params_s *conf) {
   const char *key_jazz_inc_velocity = ini_get(ini, "keyboard", "key_jazz_inc_velocity");
   const char *key_jazz_dec_velocity = ini_get(ini, "keyboard", "key_jazz_dec_velocity");
   const char *key_toggle_audio = ini_get(ini, "keyboard", "key_toggle_audio");
+  const char *key_toggle_log = ini_get(ini, "keyboard", "key_toggle_log");
 
   if (key_up)
     conf->key_up = SDL_atoi(key_up);
@@ -324,6 +330,8 @@ void read_key_config(const ini_t *ini, config_params_s *conf) {
     conf->key_jazz_dec_velocity = SDL_atoi(key_jazz_dec_velocity);
   if (key_toggle_audio)
     conf->key_toggle_audio = SDL_atoi(key_toggle_audio);
+  if (key_toggle_log)
+    conf->key_toggle_log = SDL_atoi(key_toggle_log);
 }
 
 void read_gamepad_config(const ini_t *ini, config_params_s *conf) {

src/config.h

@@ -36,6 +36,7 @@ typedef struct config_params_s {
   unsigned int key_jazz_inc_velocity;
   unsigned int key_jazz_dec_velocity;
   unsigned int key_toggle_audio;
+  unsigned int key_toggle_log;
 
   int gamepad_up;
   int gamepad_left;

src/inprint2.c

@@ -19,15 +19,14 @@ static Uint16 selected_font_w, selected_font_h;
 
 void inline_font_initialize(struct inline_font *font) {
 
-  selected_font_w = font->width;
-  selected_font_h = font->height;
-  selected_inline_font = font;
-
   if (inline_font != NULL) {
-    selected_font = inline_font;
     return;
   }
 
+  selected_font_w = font->width;
+  selected_font_h = font->height;
+  selected_inline_font = font;
+
   SDL_IOStream *font_bmp =
       SDL_IOFromConstMem(selected_inline_font->image_data, selected_inline_font->image_size);
 
@@ -119,8 +118,7 @@ void inprint(SDL_Renderer *dst, const char *str, Uint32 x, Uint32 y, const Uint3
 
     if (bgcolor != fgcolor) {
       SDL_SetRenderDrawColor(selected_renderer, (bgcolor & 0x00FF0000) >> 16,
-                             (bgcolor & 0x0000FF00) >> 8, bgcolor & 0x000000FF,
-                             0xFF);
+                             (bgcolor & 0x0000FF00) >> 8, bgcolor & 0x000000FF, 0xFF);
       bg_rect = d_rect;
       bg_rect.w = (float)selected_inline_font->glyph_x;
       bg_rect.h = (float)selected_inline_font->glyph_y;

src/input.c

@@ -188,6 +188,12 @@ void input_handle_key_down_event(struct app_context *ctx, const SDL_Event *event
     return;
   }
 
+  // Toggle in-app log overlay using config-defined key
+  if (event->key.scancode == ctx->conf.key_toggle_log) {
+    renderer_toggle_log_overlay();
+    return;
+  }
+
   if (event->key.scancode == ctx->conf.key_toggle_audio && ctx->device_connected) {
     ctx->conf.audio_enabled = !ctx->conf.audio_enabled;
     audio_toggle(ctx->conf.audio_device_name, ctx->conf.audio_buffer_size);
@@ -280,8 +286,8 @@ void input_handle_gamepad_button(struct app_context *ctx, const SDL_GamepadButto
  * @param negative_key   The key to activate when the axis value is below a negative threshold
  * @param positive_key   The key to activate when the axis value is above a positive threshold
  */
-static void update_button_state_from_axis(Sint16 axis_value, int threshold,
-                                         int negative_key, int positive_key) {
+static void update_button_state_from_axis(Sint16 axis_value, int threshold, int negative_key,
+                                          int positive_key) {
   if (axis_value < -threshold) {
     gamepad_state.current_buttons |= negative_key;
   } else if (axis_value > threshold) {
@@ -301,7 +307,7 @@ static void update_button_state_from_axis(Sint16 axis_value, int threshold,
  * @param value The analog value of the axis, typically ranging from -32768 to 32767.
  */
 void input_handle_gamepad_axis(const struct app_context *ctx, const SDL_GamepadAxis axis,
-                             const Sint16 value) {
+                               const Sint16 value) {
   const config_params_s *conf = &ctx->conf;
   gamepad_state.analog_values[axis] = value;
 

src/main.c

@@ -18,7 +18,8 @@
 #include "gamepads.h"
 #include "render.h"
 
-// On MacOS TARGET_OS_IOS is defined as 0, so make sure that it's consistent on other platforms as well
+// On MacOS TARGET_OS_IOS is defined as 0, so make sure that it's consistent on other platforms as
+// well
 #ifndef TARGET_OS_IOS
 #define TARGET_OS_IOS 0
 #endif
@@ -95,7 +96,7 @@ static config_params_s initialize_config(int argc, char *argv[], char **preferre
 
   if (TARGET_OS_IOS == 1) {
     // Predefined settings for iOS
-    conf.init_fullscreen=1;
+    conf.init_fullscreen = 1;
   } else {
     // On other platforms, read config normally
     config_read(&conf);
@@ -166,6 +167,9 @@ SDL_AppResult SDL_AppIterate(void *appstate) {
 SDL_AppResult SDL_AppInit(void **appstate, int argc, char **argv) {
   char *config_filename = NULL;
 
+  // Initialize in-app log capture/overlay
+  renderer_log_init();
+
   // Process the application's main callback roughly at 120 Hz
   SDL_SetHint(SDL_HINT_MAIN_CALLBACK_RATE, "120");